Skip to content

Commit 33df2a6

Browse files
wmudgewmudge
committed
Format YAML
Signed-off-by: Webster Mudge <[email protected]>
1 parent 7742928 commit 33df2a6

File tree

1 file changed

+120
-120
lines changed

1 file changed

+120
-120
lines changed

‎docs/api-design.md

Lines changed: 120 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -16,71 +16,71 @@ Within the *Cluster* module, the order of precedence for a Role assignment to a
1616
4. `name` or `type` assignment within `hosts.role_config_groups` (indirect)
1717
5. `host_template` assignment within `hosts.host_template` (indirect)
1818

19-
Note that Role Config Groups are _defined_ only within `service.role_config_groups`, and Host Templates are _defined_ only within `host_templates`; no assignment of services are within scope of these parameters.
19+
Note that Role Config Groups are _defined_ only within `service.role_config_groups`, and Host Templates are _defined_ only within `host_templates`; both are _assigned_ in other parameters.
2020

2121
```yaml
2222
cloudera.cluster.cluster:
23-
name: # str
24-
display_name: # str
25-
version: # str
26-
type: # enumeration
27-
state: # enumeration
28-
template: # json
29-
repos_appended: # bool
30-
parcels: # list[str]
31-
tags: # dict
32-
contexts: # list[str]
33-
tls_enabled: # bool
34-
auto_assignment_enabled: # bool
35-
maintenance_enabled: # bool
36-
purge: # bool
37-
control_plane:
38-
remote_repo_url: # str
39-
datalake_cluster_name: # str
40-
control_plane_config: # yaml
41-
services:
42-
- name: # str
43-
display_name: # str
44-
type: # enumeration
45-
version: # str
46-
state: # enumeration -- overridden by cluster.state
47-
maintenance_enabled: # bool -- ignored if service.maintenance_enabled is not None
48-
config: # dict
49-
tags: # dict
50-
roles: # Assignment -- see role module
51-
- type: # str
52-
hostnames: # list[str] -- allows for multiple assignment
53-
host_ids: # list[str] -- allows for mulitple assignment
54-
state: # enumeration -- overridden by service
55-
maintenance_enabled: # bool -- ignored if cluster.maintenance_enabled is not None
56-
config: # dict
57-
role_config_group: # str
58-
tags: # dict
59-
role_config_groups: # Definition only
60-
- name: # str
61-
display_name: # str
62-
type: # str
63-
config: # dict
64-
host_templates: # See host_template module
65-
- name: # str
66-
role_config_groups: # Reference-only
67-
- name: # str
68-
type: # str
69-
service: # str
70-
service_type: # str
71-
hosts: # See host module
72-
- hostnames: # list[str] -- allows for multiple assignment
73-
host_ids: # list[str] -- allows for multiple assignment
74-
config: # dict
75-
host_template: # str
76-
role_config_groups: # Reference-only
77-
- service: # str
78-
name: # str
79-
type: # str
80-
roles: # Assignment
81-
- service: # str
82-
type: # str
83-
config: # dict
23+
name: # str
24+
display_name: # str
25+
version: # str
26+
type: # enumeration
27+
state: # enumeration
28+
template: # json
29+
repos_appended: # bool
30+
parcels: # list[str]
31+
tags: # dict
32+
contexts: # list[str]
33+
tls_enabled: # bool
34+
auto_assignment_enabled: # bool
35+
maintenance_enabled: # bool
36+
purge: # bool
37+
control_plane:
38+
remote_repo_url: # str
39+
datalake_cluster_name: # str
40+
control_plane_config: # yaml
41+
services:
42+
- name: # str
43+
display_name: # str
44+
type: # enumeration
45+
version: # str
46+
state: # enumeration -- overridden by cluster.state
47+
maintenance_enabled: # bool -- ignored if service.maintenance_enabled is not None
48+
config: # dict
49+
tags: # dict
50+
roles: # Assignment -- see role module
51+
- type: # str
52+
hostnames: # list[str] -- allows for multiple assignment
53+
host_ids: # list[str] -- allows for mulitple assignment
54+
state: # enumeration -- overridden by service
55+
maintenance_enabled: # bool -- ignored if cluster.maintenance_enabled is not None
56+
config: # dict
57+
role_config_group: # str
58+
tags: # dict
59+
role_config_groups: # Definition only
60+
- name: # str
61+
display_name: # str
62+
type: # str
63+
config: # dict
64+
host_templates: # See host_template module
65+
- name: # str
66+
role_config_groups: # Reference-only
67+
- name: # str
68+
type: # str
69+
service: # str
70+
service_type: # str
71+
hosts: # See host module
72+
- hostnames: # list[str] -- allows for multiple assignment
73+
host_ids: # list[str] -- allows for multiple assignment
74+
config: # dict
75+
host_template: # str
76+
role_config_groups: # Reference-only
77+
- service: # str
78+
name: # str
79+
type: # str
80+
roles: # Assignment
81+
- service: # str
82+
type: # str
83+
config: # dict
8484
```
8585
8686
The `purge` flag will affect the following parameters:
@@ -109,33 +109,33 @@ The `purge` flag will affect the following parameters:
109109

110110
# Service
111111

112-
Within the *Service* module, Role assignments are handled directly in the `roles` option. Role Config Groups are simply a definition and not an assignment.
112+
Within the *Service* module, Role assignments are handled directly in the `roles` option. Role Config Groups are simply a definition and have no assignments.
113113

114114
```yaml
115115
cloudera.cluster.service:
116-
name: # str
117-
display_name: # str
118-
type: # enumeration
119-
version: # str
120-
state: # enumeration
121-
maintenance_enabled: # bool
122-
purge: # bool
123-
config: # dict
124-
tags: # dict
125-
roles: # Assignment -- see role module
126-
- type: # str
127-
hostnames: # list[str] -- allows for multiple assignment
128-
host_ids: # list[str] -- allows for mulitple assignment
129-
state: # enumeration -- overridden by service
130-
maintenance_enabled: # bool -- ignored if service.maintenance_enabled is not None
131-
config: # dict
132-
role_config_group: # str
133-
tags: # dict
134-
role_config_groups: # Definition only
135-
- name: # str
136-
display_name: # str
137-
type: # str
138-
config: # dict
116+
name: # str
117+
display_name: # str
118+
type: # enumeration
119+
version: # str
120+
state: # enumeration
121+
maintenance_enabled: # bool
122+
purge: # bool
123+
config: # dict
124+
tags: # dict
125+
roles: # Assignment -- see role module
126+
- type: # str
127+
hostnames: # list[str] -- allows for multiple assignment
128+
host_ids: # list[str] -- allows for mulitple assignment
129+
state: # enumeration -- overridden by service
130+
maintenance_enabled: # bool -- ignored if service.maintenance_enabled is not None
131+
config: # dict
132+
role_config_group: # str
133+
tags: # dict
134+
role_config_groups: # Definition only
135+
- name: # str
136+
display_name: # str
137+
type: # str
138+
config: # dict
139139
```
140140

141141
The `purge` flag will affect the following parameters:
@@ -156,16 +156,16 @@ Within the *Role* module, assignment is managed directly for a single Role on an
156156

157157
```yaml
158158
cloudera.cluster.role:
159-
name: # str -- Reference-only, as role names are auto-generated
160-
type: # str
161-
cluster_hostname: # str
162-
cluster_host_id: # str
163-
state: # enumeration
164-
maintenance_enabled: # bool
165-
purge: # bool
166-
config: # dict
167-
role_config_group: # str
168-
tags: # dict
159+
name: # str -- Reference-only, as role names are auto-generated
160+
type: # str
161+
cluster_hostname: # str
162+
cluster_host_id: # str
163+
state: # enumeration
164+
maintenance_enabled: # bool
165+
purge: # bool
166+
config: # dict
167+
role_config_group: # str
168+
tags: # dict
169169
```
170170

171171
The `purge` flag will affect the following parameters:
@@ -179,11 +179,11 @@ Within the *Role Config Group* module, there is no Role assignment. The module o
179179

180180
```yaml
181181
cloudera.cluster.role_config_group:
182-
name: # str
183-
display_name: # str
184-
type: # str
185-
purge: # bool
186-
config: # dict
182+
name: # str
183+
display_name: # str
184+
type: # str
185+
purge: # bool
186+
config: # dict
187187
```
188188

189189
The `purge` flag will affect the following parameters:
@@ -196,19 +196,19 @@ Within the *Host* module, assignments are both direct, via the `roles` option, a
196196

197197
```yaml
198198
cloudera.cluster.host:
199-
name: # str
200-
host_id: # str
201-
config: # dict
202-
host_template: # str
203-
purge: # bool
204-
role_config_groups: # Reference-only
205-
- service: # str
206-
name: # str
207-
type: # str
208-
roles: # Assignment
209-
- service: # str
210-
type: # str
211-
config: # dict
199+
name: # str
200+
host_id: # str
201+
config: # dict
202+
host_template: # str
203+
purge: # bool
204+
role_config_groups: # Reference-only
205+
- service: # str
206+
name: # str
207+
type: # str
208+
roles: # Assignment
209+
- service: # str
210+
type: # str
211+
config: # dict
212212
```
213213

214214
The `purge` flag will affect the following parameters:
@@ -224,12 +224,12 @@ Within the *Host Template* module, there is no Role assignment. The module only
224224

225225
```yaml
226226
cloudera.cluster.host_template:
227-
name: # str
228-
role_config_groups: # Reference-only
229-
- name: # str
230-
type: # str
231-
service: # str
232-
service_type: # str
227+
name: # str
228+
role_config_groups: # Reference-only
229+
- name: # str
230+
type: # str
231+
service: # str
232+
service_type: # str
233233
```
234234

235235
The `purge` flag will affect the following parameters:

0 commit comments

Comments
 (0)