Merge ~powersj/cloud-init:docs/whitespace_spelling into cloud-init:master
- Git
- lp:~powersj/cloud-init
- docs/whitespace_spelling
- Merge into master
Proposed by
Joshua Powers
Status: | Merged |
---|---|
Approved by: | Dan Watkins |
Approved revision: | b16a3abc6524904dd74613180b6d5e88e2332e68 |
Merge reported by: | Server Team CI bot |
Merged at revision: | not available |
Proposed branch: | ~powersj/cloud-init:docs/whitespace_spelling |
Merge into: | cloud-init:master |
Diff against target: |
857 lines (+175/-131) 17 files modified
doc/rtd/topics/datasources/altcloud.rst (+12/-11) doc/rtd/topics/datasources/azure.rst (+2/-1) doc/rtd/topics/datasources/cloudstack.rst (+1/-1) doc/rtd/topics/datasources/configdrive.rst (+8/-8) doc/rtd/topics/datasources/digitalocean.rst (+4/-2) doc/rtd/topics/datasources/ec2.rst (+6/-5) doc/rtd/topics/datasources/exoscale.rst (+6/-6) doc/rtd/topics/datasources/nocloud.rst (+8/-8) doc/rtd/topics/datasources/opennebula.rst (+15/-15) doc/rtd/topics/datasources/openstack.rst (+2/-1) doc/rtd/topics/datasources/smartos.rst (+7/-5) doc/rtd/topics/debugging.rst (+7/-7) doc/rtd/topics/dir_layout.rst (+22/-17) doc/rtd/topics/examples.rst (+1/-1) doc/rtd/topics/format.rst (+53/-28) doc/rtd/topics/merging.rst (+12/-6) doc/rtd/topics/network-config-format-v2.rst (+9/-9) |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Dan Watkins | Approve | ||
Server Team CI bot | continuous-integration | Approve | |
Review via email: mp+372104@code.launchpad.net |
Commit message
docs: fix whitespace, spelling, and line length
Description of the change
To post a comment you must log in.
Revision history for this message
Server Team CI bot (server-team-bot) wrote : | # |
review:
Approve
(continuous-integration)
Revision history for this message
Dan Watkins (oddbloke) : | # |
review:
Approve
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | diff --git a/doc/rtd/topics/datasources/altcloud.rst b/doc/rtd/topics/datasources/altcloud.rst |
2 | index eeb197f..9d7e3de 100644 |
3 | --- a/doc/rtd/topics/datasources/altcloud.rst |
4 | +++ b/doc/rtd/topics/datasources/altcloud.rst |
5 | @@ -3,24 +3,25 @@ |
6 | Alt Cloud |
7 | ========= |
8 | |
9 | -The datasource altcloud will be used to pick up user data on `RHEVm`_ and `vSphere`_. |
10 | +The datasource altcloud will be used to pick up user data on `RHEVm`_ and |
11 | +`vSphere`_. |
12 | |
13 | RHEVm |
14 | ----- |
15 | |
16 | For `RHEVm`_ v3.0 the userdata is injected into the VM using floppy |
17 | -injection via the `RHEVm`_ dashboard "Custom Properties". |
18 | +injection via the `RHEVm`_ dashboard "Custom Properties". |
19 | |
20 | The format of the Custom Properties entry must be: |
21 | |
22 | :: |
23 | - |
24 | + |
25 | floppyinject=user-data.txt:<base64 encoded data> |
26 | |
27 | For example to pass a simple bash script: |
28 | |
29 | .. sourcecode:: sh |
30 | - |
31 | + |
32 | % cat simple_script.bash |
33 | #!/bin/bash |
34 | echo "Hello Joe!" >> /tmp/JJV_Joe_out.txt |
35 | @@ -38,7 +39,7 @@ set the "Custom Properties" when creating the RHEMv v3.0 VM to: |
36 | **NOTE:** The prefix with file name must be: ``floppyinject=user-data.txt:`` |
37 | |
38 | It is also possible to launch a `RHEVm`_ v3.0 VM and pass optional user |
39 | -data to it using the Delta Cloud. |
40 | +data to it using the Delta Cloud. |
41 | |
42 | For more information on Delta Cloud see: http://deltacloud.apache.org |
43 | |
44 | @@ -46,12 +47,12 @@ vSphere |
45 | ------- |
46 | |
47 | For VMWare's `vSphere`_ the userdata is injected into the VM as an ISO |
48 | -via the cdrom. This can be done using the `vSphere`_ dashboard |
49 | +via the cdrom. This can be done using the `vSphere`_ dashboard |
50 | by connecting an ISO image to the CD/DVD drive. |
51 | |
52 | To pass this example script to cloud-init running in a `vSphere`_ VM |
53 | set the CD/DVD drive when creating the vSphere VM to point to an |
54 | -ISO on the data store. |
55 | +ISO on the data store. |
56 | |
57 | **Note:** The ISO must contain the user data. |
58 | |
59 | @@ -61,13 +62,13 @@ Create the ISO |
60 | ^^^^^^^^^^^^^^ |
61 | |
62 | .. sourcecode:: sh |
63 | - |
64 | + |
65 | % mkdir my-iso |
66 | |
67 | NOTE: The file name on the ISO must be: ``user-data.txt`` |
68 | |
69 | .. sourcecode:: sh |
70 | - |
71 | + |
72 | % cp simple_script.bash my-iso/user-data.txt |
73 | % genisoimage -o user-data.iso -r my-iso |
74 | |
75 | @@ -75,7 +76,7 @@ Verify the ISO |
76 | ^^^^^^^^^^^^^^ |
77 | |
78 | .. sourcecode:: sh |
79 | - |
80 | + |
81 | % sudo mkdir /media/vsphere_iso |
82 | % sudo mount -o loop user-data.iso /media/vsphere_iso |
83 | % cat /media/vsphere_iso/user-data.txt |
84 | @@ -84,7 +85,7 @@ Verify the ISO |
85 | Then, launch the `vSphere`_ VM the ISO user-data.iso attached as a CDROM. |
86 | |
87 | It is also possible to launch a `vSphere`_ VM and pass optional user |
88 | -data to it using the Delta Cloud. |
89 | +data to it using the Delta Cloud. |
90 | |
91 | For more information on Delta Cloud see: http://deltacloud.apache.org |
92 | |
93 | diff --git a/doc/rtd/topics/datasources/azure.rst b/doc/rtd/topics/datasources/azure.rst |
94 | index b41cddd..8328dfa 100644 |
95 | --- a/doc/rtd/topics/datasources/azure.rst |
96 | +++ b/doc/rtd/topics/datasources/azure.rst |
97 | @@ -82,7 +82,8 @@ The settings that may be configured are: |
98 | provided command to obtain metadata. |
99 | * **apply_network_config**: Boolean set to True to use network configuration |
100 | described by Azure's IMDS endpoint instead of fallback network config of |
101 | - dhcp on eth0. Default is True. For Ubuntu 16.04 or earlier, default is False. |
102 | + dhcp on eth0. Default is True. For Ubuntu 16.04 or earlier, default is |
103 | + False. |
104 | * **data_dir**: Path used to read metadata files and write crawled data. |
105 | * **dhclient_lease_file**: The fallback lease file to source when looking for |
106 | custom DHCP option 245 from Azure fabric. |
107 | diff --git a/doc/rtd/topics/datasources/cloudstack.rst b/doc/rtd/topics/datasources/cloudstack.rst |
108 | index a3101ed..95b9587 100644 |
109 | --- a/doc/rtd/topics/datasources/cloudstack.rst |
110 | +++ b/doc/rtd/topics/datasources/cloudstack.rst |
111 | @@ -7,7 +7,7 @@ CloudStack |
112 | sshkey thru the Virtual-Router. The datasource obtains the VR address via |
113 | dhcp lease information given to the instance. |
114 | For more details on meta-data and user-data, |
115 | -refer the `CloudStack Administrator Guide`_. |
116 | +refer the `CloudStack Administrator Guide`_. |
117 | |
118 | URLs to access user-data and meta-data from the Virtual Machine. Here 10.1.1.1 |
119 | is the Virtual Router IP: |
120 | diff --git a/doc/rtd/topics/datasources/configdrive.rst b/doc/rtd/topics/datasources/configdrive.rst |
121 | index f1a488a..f4c5a34 100644 |
122 | --- a/doc/rtd/topics/datasources/configdrive.rst |
123 | +++ b/doc/rtd/topics/datasources/configdrive.rst |
124 | @@ -64,7 +64,7 @@ The following criteria are required to as a config drive: |
125 | :: |
126 | |
127 | openstack/ |
128 | - - 2012-08-10/ or latest/ |
129 | + - 2012-08-10/ or latest/ |
130 | - meta_data.json |
131 | - user_data (not mandatory) |
132 | - content/ |
133 | @@ -83,7 +83,7 @@ only) file in the following ways. |
134 | |
135 | :: |
136 | |
137 | - dsmode: |
138 | + dsmode: |
139 | values: local, net, pass |
140 | default: pass |
141 | |
142 | @@ -97,10 +97,10 @@ The difference between 'local' and 'net' is that local will not require |
143 | networking to be up before user-data actions (or boothooks) are run. |
144 | |
145 | :: |
146 | - |
147 | + |
148 | instance-id: |
149 | default: iid-dsconfigdrive |
150 | - |
151 | + |
152 | This is utilized as the metadata's instance-id. It should generally |
153 | be unique, as it is what is used to determine "is this a new instance". |
154 | |
155 | @@ -108,18 +108,18 @@ be unique, as it is what is used to determine "is this a new instance". |
156 | |
157 | public-keys: |
158 | default: None |
159 | - |
160 | + |
161 | If present, these keys will be used as the public keys for the |
162 | instance. This value overrides the content in authorized_keys. |
163 | |
164 | Note: it is likely preferable to provide keys via user-data |
165 | |
166 | :: |
167 | - |
168 | + |
169 | user-data: |
170 | default: None |
171 | - |
172 | -This provides cloud-init user-data. See :ref:`examples <yaml_examples>` for |
173 | + |
174 | +This provides cloud-init user-data. See :ref:`examples <yaml_examples>` for |
175 | what all can be present here. |
176 | |
177 | .. _OpenStack: http://www.openstack.org/ |
178 | diff --git a/doc/rtd/topics/datasources/digitalocean.rst b/doc/rtd/topics/datasources/digitalocean.rst |
179 | index 938ede8..88f1e5f 100644 |
180 | --- a/doc/rtd/topics/datasources/digitalocean.rst |
181 | +++ b/doc/rtd/topics/datasources/digitalocean.rst |
182 | @@ -20,8 +20,10 @@ DigitalOcean's datasource can be configured as follows: |
183 | retries: 3 |
184 | timeout: 2 |
185 | |
186 | -- *retries*: Determines the number of times to attempt to connect to the metadata service |
187 | -- *timeout*: Determines the timeout in seconds to wait for a response from the metadata service |
188 | +- *retries*: Determines the number of times to attempt to connect to the |
189 | + metadata service |
190 | +- *timeout*: Determines the timeout in seconds to wait for a response from the |
191 | + metadata service |
192 | |
193 | .. _DigitalOcean: http://digitalocean.com/ |
194 | .. _metadata service: https://developers.digitalocean.com/metadata/ |
195 | diff --git a/doc/rtd/topics/datasources/ec2.rst b/doc/rtd/topics/datasources/ec2.rst |
196 | index 76beca9..a90f377 100644 |
197 | --- a/doc/rtd/topics/datasources/ec2.rst |
198 | +++ b/doc/rtd/topics/datasources/ec2.rst |
199 | @@ -13,7 +13,7 @@ instance metadata. |
200 | Metadata is accessible via the following URL: |
201 | |
202 | :: |
203 | - |
204 | + |
205 | GET http://169.254.169.254/2009-04-04/meta-data/ |
206 | ami-id |
207 | ami-launch-index |
208 | @@ -34,19 +34,20 @@ Metadata is accessible via the following URL: |
209 | Userdata is accessible via the following URL: |
210 | |
211 | :: |
212 | - |
213 | + |
214 | GET http://169.254.169.254/2009-04-04/user-data |
215 | 1234,fred,reboot,true | 4512,jimbo, | 173,,, |
216 | |
217 | Note that there are multiple versions of this data provided, cloud-init |
218 | by default uses **2009-04-04** but newer versions can be supported with |
219 | relative ease (newer versions have more data exposed, while maintaining |
220 | -backward compatibility with the previous versions). |
221 | +backward compatibility with the previous versions). |
222 | |
223 | -To see which versions are supported from your cloud provider use the following URL: |
224 | +To see which versions are supported from your cloud provider use the following |
225 | +URL: |
226 | |
227 | :: |
228 | - |
229 | + |
230 | GET http://169.254.169.254/ |
231 | 1.0 |
232 | 2007-01-19 |
233 | diff --git a/doc/rtd/topics/datasources/exoscale.rst b/doc/rtd/topics/datasources/exoscale.rst |
234 | index 27aec9c..9074edc 100644 |
235 | --- a/doc/rtd/topics/datasources/exoscale.rst |
236 | +++ b/doc/rtd/topics/datasources/exoscale.rst |
237 | @@ -26,8 +26,8 @@ In the password server case, the following rules apply in order to enable the |
238 | "restore instance password" functionality: |
239 | |
240 | * If a password is returned by the password server, it is then marked "saved" |
241 | - by the cloud-init datasource. Subsequent boots will skip setting the password |
242 | - (the password server will return "saved_password"). |
243 | + by the cloud-init datasource. Subsequent boots will skip setting the |
244 | + password (the password server will return "saved_password"). |
245 | * When the instance password is reset (via the Exoscale UI), the password |
246 | server will return the non-empty password at next boot, therefore causing |
247 | cloud-init to reset the instance's password. |
248 | @@ -38,15 +38,15 @@ Configuration |
249 | Users of this datasource are discouraged from changing the default settings |
250 | unless instructed to by Exoscale support. |
251 | |
252 | -The following settings are available and can be set for the datasource in system |
253 | -configuration (in `/etc/cloud/cloud.cfg.d/`). |
254 | +The following settings are available and can be set for the datasource in |
255 | +system configuration (in `/etc/cloud/cloud.cfg.d/`). |
256 | |
257 | The settings available are: |
258 | |
259 | * **metadata_url**: The URL for the metadata service (defaults to |
260 | ``http://169.254.169.254``) |
261 | - * **api_version**: The API version path on which to query the instance metadata |
262 | - (defaults to ``1.0``) |
263 | + * **api_version**: The API version path on which to query the instance |
264 | + metadata (defaults to ``1.0``) |
265 | * **password_server_port**: The port (on the metadata server) on which the |
266 | password server listens (defaults to ``8080``). |
267 | * **timeout**: the timeout value provided to urlopen for each individual http |
268 | diff --git a/doc/rtd/topics/datasources/nocloud.rst b/doc/rtd/topics/datasources/nocloud.rst |
269 | index 1c5cf96..bc96f7f 100644 |
270 | --- a/doc/rtd/topics/datasources/nocloud.rst |
271 | +++ b/doc/rtd/topics/datasources/nocloud.rst |
272 | @@ -57,24 +57,24 @@ Given a disk ubuntu 12.04 cloud image in 'disk.img', you can create a |
273 | sufficient disk by following the example below. |
274 | |
275 | :: |
276 | - |
277 | + |
278 | ## create user-data and meta-data files that will be used |
279 | ## to modify image on first boot |
280 | $ { echo instance-id: iid-local01; echo local-hostname: cloudimg; } > meta-data |
281 | - |
282 | + |
283 | $ printf "#cloud-config\npassword: passw0rd\nchpasswd: { expire: False }\nssh_pwauth: True\n" > user-data |
284 | - |
285 | + |
286 | ## create a disk to attach with some user-data and meta-data |
287 | $ genisoimage -output seed.iso -volid cidata -joliet -rock user-data meta-data |
288 | - |
289 | + |
290 | ## alternatively, create a vfat filesystem with same files |
291 | ## $ truncate --size 2M seed.img |
292 | ## $ mkfs.vfat -n cidata seed.img |
293 | ## $ mcopy -oi seed.img user-data meta-data :: |
294 | - |
295 | + |
296 | ## create a new qcow image to boot, backed by your original image |
297 | $ qemu-img create -f qcow2 -b disk.img boot-disk.img |
298 | - |
299 | + |
300 | ## boot the image and login as 'ubuntu' with password 'passw0rd' |
301 | ## note, passw0rd was set as password through the user-data above, |
302 | ## there is no password set on these images. |
303 | @@ -88,12 +88,12 @@ to determine if this is "first boot". So if you are making updates to |
304 | user-data you will also have to change that, or start the disk fresh. |
305 | |
306 | Also, you can inject an ``/etc/network/interfaces`` file by providing the |
307 | -content for that file in the ``network-interfaces`` field of metadata. |
308 | +content for that file in the ``network-interfaces`` field of metadata. |
309 | |
310 | Example metadata: |
311 | |
312 | :: |
313 | - |
314 | + |
315 | instance-id: iid-abcdefg |
316 | network-interfaces: | |
317 | iface eth0 inet static |
318 | diff --git a/doc/rtd/topics/datasources/opennebula.rst b/doc/rtd/topics/datasources/opennebula.rst |
319 | index 7c0367c..8e7c255 100644 |
320 | --- a/doc/rtd/topics/datasources/opennebula.rst |
321 | +++ b/doc/rtd/topics/datasources/opennebula.rst |
322 | @@ -21,7 +21,7 @@ Datasource configuration |
323 | Datasource accepts following configuration options. |
324 | |
325 | :: |
326 | - |
327 | + |
328 | dsmode: |
329 | values: local, net, disabled |
330 | default: net |
331 | @@ -30,7 +30,7 @@ Tells if this datasource will be processed in 'local' (pre-networking) or |
332 | 'net' (post-networking) stage or even completely 'disabled'. |
333 | |
334 | :: |
335 | - |
336 | + |
337 | parseuser: |
338 | default: nobody |
339 | |
340 | @@ -46,7 +46,7 @@ The following criteria are required: |
341 | or have a *filesystem* label of **CONTEXT** or **CDROM** |
342 | 2. Must contain file *context.sh* with contextualization variables. |
343 | File is generated by OpenNebula, it has a KEY='VALUE' format and |
344 | - can be easily read by bash |
345 | + can be easily read by bash |
346 | |
347 | Contextualization variables |
348 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
349 | @@ -57,7 +57,7 @@ the OpenNebula documentation. Where multiple similar variables are |
350 | specified, only first found is taken. |
351 | |
352 | :: |
353 | - |
354 | + |
355 | DSMODE |
356 | |
357 | Datasource mode configuration override. Values: local, net, disabled. |
358 | @@ -75,30 +75,30 @@ Datasource mode configuration override. Values: local, net, disabled. |
359 | Static `network configuration`_. |
360 | |
361 | :: |
362 | - |
363 | + |
364 | HOSTNAME |
365 | |
366 | Instance hostname. |
367 | |
368 | :: |
369 | - |
370 | + |
371 | PUBLIC_IP |
372 | IP_PUBLIC |
373 | ETH0_IP |
374 | |
375 | If no hostname has been specified, cloud-init will try to create hostname |
376 | -from instance's IP address in 'local' dsmode. In 'net' dsmode, cloud-init |
377 | +from instance's IP address in 'local' dsmode. In 'net' dsmode, cloud-init |
378 | tries to resolve one of its IP addresses to get hostname. |
379 | |
380 | :: |
381 | - |
382 | + |
383 | SSH_KEY |
384 | SSH_PUBLIC_KEY |
385 | |
386 | One or multiple SSH keys (separated by newlines) can be specified. |
387 | |
388 | :: |
389 | - |
390 | + |
391 | USER_DATA |
392 | USERDATA |
393 | |
394 | @@ -111,7 +111,7 @@ This example cloud-init configuration (*cloud.cfg*) enables |
395 | OpenNebula datasource only in 'net' mode. |
396 | |
397 | :: |
398 | - |
399 | + |
400 | disable_ec2_metadata: True |
401 | datasource_list: ['OpenNebula'] |
402 | datasource: |
403 | @@ -123,17 +123,17 @@ Example VM's context section |
404 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
405 | |
406 | :: |
407 | - |
408 | + |
409 | CONTEXT=[ |
410 | PUBLIC_IP="$NIC[IP]", |
411 | - SSH_KEY="$USER[SSH_KEY] |
412 | - $USER[SSH_KEY1] |
413 | + SSH_KEY="$USER[SSH_KEY] |
414 | + $USER[SSH_KEY1] |
415 | $USER[SSH_KEY2] ", |
416 | USER_DATA="#cloud-config |
417 | # see https://help.ubuntu.com/community/CloudInit |
418 | - |
419 | + |
420 | packages: [] |
421 | - |
422 | + |
423 | mounts: |
424 | - [vdc,none,swap,sw,0,0] |
425 | runcmd: |
426 | diff --git a/doc/rtd/topics/datasources/openstack.rst b/doc/rtd/topics/datasources/openstack.rst |
427 | index 421da08..8ce2a53 100644 |
428 | --- a/doc/rtd/topics/datasources/openstack.rst |
429 | +++ b/doc/rtd/topics/datasources/openstack.rst |
430 | @@ -78,6 +78,7 @@ upgrade packages and install ``htop`` on all instances: |
431 | {"cloud-init": "#cloud-config\npackage_upgrade: True\npackages:\n - htop"} |
432 | |
433 | For more general information about how cloud-init handles vendor data, |
434 | -including how it can be disabled by users on instances, see :doc:`/topics/vendordata`. |
435 | +including how it can be disabled by users on instances, see |
436 | +:doc:`/topics/vendordata`. |
437 | |
438 | .. vi: textwidth=78 |
439 | diff --git a/doc/rtd/topics/datasources/smartos.rst b/doc/rtd/topics/datasources/smartos.rst |
440 | index cb9a128..be11dfb 100644 |
441 | --- a/doc/rtd/topics/datasources/smartos.rst |
442 | +++ b/doc/rtd/topics/datasources/smartos.rst |
443 | @@ -15,7 +15,8 @@ second serial console. On Linux, this is /dev/ttyS1. The data is a provided |
444 | via a simple protocol: something queries for the data, the console responds |
445 | responds with the status and if "SUCCESS" returns until a single ".\n". |
446 | |
447 | -New versions of the SmartOS tooling will include support for base64 encoded data. |
448 | +New versions of the SmartOS tooling will include support for base64 encoded |
449 | +data. |
450 | |
451 | Meta-data channels |
452 | ------------------ |
453 | @@ -27,7 +28,7 @@ channels of SmartOS. |
454 | |
455 | - per the spec, user-data is for consumption by the end-user, not |
456 | provisioning tools |
457 | - - cloud-init entirely ignores this channel other than writting it to disk |
458 | + - cloud-init entirely ignores this channel other than writing it to disk |
459 | - removal of the meta-data key means that /var/db/user-data gets removed |
460 | - a backup of previous meta-data is maintained as |
461 | /var/db/user-data.<timestamp>. <timestamp> is the epoch time when |
462 | @@ -42,8 +43,9 @@ channels of SmartOS. |
463 | - <timestamp> is the epoch time when cloud-init ran. |
464 | - when the 'user-script' meta-data key goes missing, the user-script is |
465 | removed from the file system, although a backup is maintained. |
466 | - - if the script is not shebanged (i.e. starts with #!<executable>), then |
467 | - or is not an executable, cloud-init will add a shebang of "#!/bin/bash" |
468 | + - if the script does not start with a shebang (i.e. starts with |
469 | + #!<executable>), then or is not an executable, cloud-init will add a |
470 | + shebang of "#!/bin/bash" |
471 | |
472 | * cloud-init:user-data is treated like on other Clouds. |
473 | |
474 | @@ -133,7 +135,7 @@ or not to base64 decode something: |
475 | * base64_all: Except for excluded keys, attempt to base64 decode |
476 | the values. If the value fails to decode properly, it will be |
477 | returned in its text |
478 | - * base64_keys: A comma deliminated list of which keys are base64 encoded. |
479 | + * base64_keys: A comma delimited list of which keys are base64 encoded. |
480 | * b64-<key>: |
481 | for any key, if there exists an entry in the metadata for 'b64-<key>' |
482 | Then 'b64-<key>' is expected to be a plaintext boolean indicating whether |
483 | diff --git a/doc/rtd/topics/debugging.rst b/doc/rtd/topics/debugging.rst |
484 | index e13d915..afcf267 100644 |
485 | --- a/doc/rtd/topics/debugging.rst |
486 | +++ b/doc/rtd/topics/debugging.rst |
487 | @@ -68,18 +68,18 @@ subcommands default to reading /var/log/cloud-init.log. |
488 | 00.00100s (modules-final/config-rightscale_userdata) |
489 | ... |
490 | |
491 | -* ``analyze boot`` Make subprocess calls to the kernel in order to get relevant |
492 | +* ``analyze boot`` Make subprocess calls to the kernel in order to get relevant |
493 | pre-cloud-init timestamps, such as the kernel start, kernel finish boot, and cloud-init start. |
494 | |
495 | .. code-block:: shell-session |
496 | |
497 | - $ cloud-init analyze boot |
498 | + $ cloud-init analyze boot |
499 | -- Most Recent Boot Record -- |
500 | - Kernel Started at: 2019-06-13 15:59:55.809385 |
501 | - Kernel ended boot at: 2019-06-13 16:00:00.944740 |
502 | - Kernel time to boot (seconds): 5.135355 |
503 | - Cloud-init start: 2019-06-13 16:00:05.738396 |
504 | - Time between Kernel boot and Cloud-init start (seconds): 4.793656 |
505 | + Kernel Started at: 2019-06-13 15:59:55.809385 |
506 | + Kernel ended boot at: 2019-06-13 16:00:00.944740 |
507 | + Kernel time to boot (seconds): 5.135355 |
508 | + Cloud-init start: 2019-06-13 16:00:05.738396 |
509 | + Time between Kernel boot and Cloud-init start (seconds): 4.793656 |
510 | |
511 | |
512 | Analyze quickstart - LXC |
513 | diff --git a/doc/rtd/topics/dir_layout.rst b/doc/rtd/topics/dir_layout.rst |
514 | index 7a6265e..ebd63ae 100644 |
515 | --- a/doc/rtd/topics/dir_layout.rst |
516 | +++ b/doc/rtd/topics/dir_layout.rst |
517 | @@ -2,11 +2,12 @@ |
518 | Directory layout |
519 | **************** |
520 | |
521 | -Cloudinits's directory structure is somewhat different from a regular application:: |
522 | +Cloud-init's directory structure is somewhat different from a regular |
523 | +application:: |
524 | |
525 | /var/lib/cloud/ |
526 | - data/ |
527 | - - instance-id |
528 | + - instance-id |
529 | - previous-instance-id |
530 | - datasource |
531 | - previous-datasource |
532 | @@ -35,38 +36,41 @@ Cloudinits's directory structure is somewhat different from a regular applicatio |
533 | |
534 | The main directory containing the cloud-init specific subdirectories. |
535 | It is typically located at ``/var/lib`` but there are certain configuration |
536 | - scenarios where this can be altered. |
537 | + scenarios where this can be altered. |
538 | |
539 | TBD, describe this overriding more. |
540 | |
541 | ``data/`` |
542 | |
543 | - Contains information related to instance ids, datasources and hostnames of the previous |
544 | - and current instance if they are different. These can be examined as needed to |
545 | - determine any information related to a previous boot (if applicable). |
546 | + Contains information related to instance ids, datasources and hostnames of |
547 | + the previous and current instance if they are different. These can be |
548 | + examined as needed to determine any information related to a previous boot |
549 | + (if applicable). |
550 | |
551 | ``handlers/`` |
552 | |
553 | - Custom ``part-handlers`` code is written out here. Files that end up here are written |
554 | - out with in the scheme of ``part-handler-XYZ`` where ``XYZ`` is the handler number (the |
555 | - first handler found starts at 0). |
556 | + Custom ``part-handlers`` code is written out here. Files that end up here are |
557 | + written out with in the scheme of ``part-handler-XYZ`` where ``XYZ`` is the |
558 | + handler number (the first handler found starts at 0). |
559 | |
560 | |
561 | ``instance`` |
562 | |
563 | - A symlink to the current ``instances/`` subdirectory that points to the currently |
564 | - active instance (which is active is dependent on the datasource loaded). |
565 | + A symlink to the current ``instances/`` subdirectory that points to the |
566 | + currently active instance (which is active is dependent on the datasource |
567 | + loaded). |
568 | |
569 | ``instances/`` |
570 | |
571 | - All instances that were created using this image end up with instance identifier |
572 | - subdirectories (and corresponding data for each instance). The currently active |
573 | - instance will be symlinked the ``instance`` symlink file defined previously. |
574 | + All instances that were created using this image end up with instance |
575 | + identifier subdirectories (and corresponding data for each instance). The |
576 | + currently active instance will be symlinked the ``instance`` symlink file |
577 | + defined previously. |
578 | |
579 | ``scripts/`` |
580 | |
581 | - Scripts that are downloaded/created by the corresponding ``part-handler`` will end up |
582 | - in one of these subdirectories. |
583 | + Scripts that are downloaded/created by the corresponding ``part-handler`` |
584 | + will end up in one of these subdirectories. |
585 | |
586 | ``seed/`` |
587 | |
588 | @@ -77,6 +81,7 @@ Cloudinits's directory structure is somewhat different from a regular applicatio |
589 | Cloud-init has a concept of a module semaphore, which basically consists |
590 | of the module name and its frequency. These files are used to ensure a module |
591 | is only ran `per-once`, `per-instance`, `per-always`. This folder contains |
592 | - semaphore `files` which are only supposed to run `per-once` (not tied to the instance id). |
593 | + semaphore `files` which are only supposed to run `per-once` (not tied to the |
594 | + instance id). |
595 | |
596 | .. vi: textwidth=78 |
597 | diff --git a/doc/rtd/topics/examples.rst b/doc/rtd/topics/examples.rst |
598 | index c30d226..62b8ee4 100644 |
599 | --- a/doc/rtd/topics/examples.rst |
600 | +++ b/doc/rtd/topics/examples.rst |
601 | @@ -134,7 +134,7 @@ Configure instances ssh-keys |
602 | .. literalinclude:: ../../examples/cloud-config-ssh-keys.txt |
603 | :language: yaml |
604 | :linenos: |
605 | - |
606 | + |
607 | Additional apt configuration |
608 | ============================ |
609 | |
610 | diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst |
611 | index 74d1fee..7605040 100644 |
612 | --- a/doc/rtd/topics/format.rst |
613 | +++ b/doc/rtd/topics/format.rst |
614 | @@ -4,22 +4,24 @@ |
615 | User-Data Formats |
616 | ***************** |
617 | |
618 | -User data that will be acted upon by cloud-init must be in one of the following types. |
619 | +User data that will be acted upon by cloud-init must be in one of the following |
620 | +types. |
621 | |
622 | Gzip Compressed Content |
623 | ======================= |
624 | |
625 | Content found to be gzip compressed will be uncompressed. |
626 | -The uncompressed data will then be used as if it were not compressed. |
627 | +The uncompressed data will then be used as if it were not compressed. |
628 | This is typically useful because user-data is limited to ~16384 [#]_ bytes. |
629 | |
630 | Mime Multi Part Archive |
631 | ======================= |
632 | |
633 | -This list of rules is applied to each part of this multi-part file. |
634 | +This list of rules is applied to each part of this multi-part file. |
635 | Using a mime-multi part file, the user can specify more than one type of data. |
636 | |
637 | -For example, both a user data script and a cloud-config type could be specified. |
638 | +For example, both a user data script and a cloud-config type could be |
639 | +specified. |
640 | |
641 | Supported content-types: |
642 | |
643 | @@ -66,7 +68,8 @@ User-Data Script |
644 | |
645 | Typically used by those who just want to execute a shell script. |
646 | |
647 | -Begins with: ``#!`` or ``Content-Type: text/x-shellscript`` when using a MIME archive. |
648 | +Begins with: ``#!`` or ``Content-Type: text/x-shellscript`` when using a MIME |
649 | +archive. |
650 | |
651 | .. note:: |
652 | New in cloud-init v. 18.4: User-data scripts can also render cloud instance |
653 | @@ -83,25 +86,27 @@ Example |
654 | #!/bin/sh |
655 | echo "Hello World. The time is now $(date -R)!" | tee /root/output.txt |
656 | |
657 | - $ euca-run-instances --key mykey --user-data-file myscript.sh ami-a07d95c9 |
658 | + $ euca-run-instances --key mykey --user-data-file myscript.sh ami-a07d95c9 |
659 | |
660 | Include File |
661 | ============ |
662 | |
663 | This content is a ``include`` file. |
664 | |
665 | -The file contains a list of urls, one per line. |
666 | -Each of the URLs will be read, and their content will be passed through this same set of rules. |
667 | -Ie, the content read from the URL can be gzipped, mime-multi-part, or plain text. |
668 | -If an error occurs reading a file the remaining files will not be read. |
669 | +The file contains a list of urls, one per line. Each of the URLs will be read, |
670 | +and their content will be passed through this same set of rules. Ie, the |
671 | +content read from the URL can be gzipped, mime-multi-part, or plain text. If |
672 | +an error occurs reading a file the remaining files will not be read. |
673 | |
674 | -Begins with: ``#include`` or ``Content-Type: text/x-include-url`` when using a MIME archive. |
675 | +Begins with: ``#include`` or ``Content-Type: text/x-include-url`` when using |
676 | +a MIME archive. |
677 | |
678 | Cloud Config Data |
679 | ================= |
680 | |
681 | -Cloud-config is the simplest way to accomplish some things |
682 | -via user-data. Using cloud-config syntax, the user can specify certain things in a human friendly format. |
683 | +Cloud-config is the simplest way to accomplish some things via user-data. Using |
684 | +cloud-config syntax, the user can specify certain things in a human friendly |
685 | +format. |
686 | |
687 | These things include: |
688 | |
689 | @@ -114,9 +119,11 @@ These things include: |
690 | .. note:: |
691 | This file must be valid yaml syntax. |
692 | |
693 | -See the :ref:`yaml_examples` section for a commented set of examples of supported cloud config formats. |
694 | +See the :ref:`yaml_examples` section for a commented set of examples of |
695 | +supported cloud config formats. |
696 | |
697 | -Begins with: ``#cloud-config`` or ``Content-Type: text/cloud-config`` when using a MIME archive. |
698 | +Begins with: ``#cloud-config`` or ``Content-Type: text/cloud-config`` when |
699 | +using a MIME archive. |
700 | |
701 | .. note:: |
702 | New in cloud-init v. 18.4: Cloud config dta can also render cloud instance |
703 | @@ -126,25 +133,41 @@ Begins with: ``#cloud-config`` or ``Content-Type: text/cloud-config`` when using |
704 | Upstart Job |
705 | =========== |
706 | |
707 | -Content is placed into a file in ``/etc/init``, and will be consumed by upstart as any other upstart job. |
708 | +Content is placed into a file in ``/etc/init``, and will be consumed by upstart |
709 | +as any other upstart job. |
710 | |
711 | -Begins with: ``#upstart-job`` or ``Content-Type: text/upstart-job`` when using a MIME archive. |
712 | +Begins with: ``#upstart-job`` or ``Content-Type: text/upstart-job`` when using |
713 | +a MIME archive. |
714 | |
715 | Cloud Boothook |
716 | ============== |
717 | |
718 | -This content is ``boothook`` data. It is stored in a file under ``/var/lib/cloud`` and then executed immediately. |
719 | -This is the earliest ``hook`` available. Note, that there is no mechanism provided for running only once. The boothook must take care of this itself. |
720 | -It is provided with the instance id in the environment variable ``INSTANCE_ID``. This could be made use of to provide a 'once-per-instance' type of functionality. |
721 | +This content is ``boothook`` data. It is stored in a file under |
722 | +``/var/lib/cloud`` and then executed immediately. This is the earliest ``hook`` |
723 | +available. Note, that there is no mechanism provided for running only once. The |
724 | +boothook must take care of this itself. |
725 | |
726 | -Begins with: ``#cloud-boothook`` or ``Content-Type: text/cloud-boothook`` when using a MIME archive. |
727 | +It is provided with the instance id in the environment variable |
728 | +``INSTANCE_ID``. This could be made use of to provide a 'once-per-instance' |
729 | +type of functionality. |
730 | + |
731 | +Begins with: ``#cloud-boothook`` or ``Content-Type: text/cloud-boothook`` when |
732 | +using a MIME archive. |
733 | |
734 | Part Handler |
735 | ============ |
736 | |
737 | -This is a ``part-handler``: It contains custom code for either supporting new mime-types in multi-part user data, or overriding the existing handlers for supported mime-types. It will be written to a file in ``/var/lib/cloud/data`` based on its filename (which is generated). |
738 | -This must be python code that contains a ``list_types`` function and a ``handle_part`` function. |
739 | -Once the section is read the ``list_types`` method will be called. It must return a list of mime-types that this part-handler handles. Because mime parts are processed in order, a ``part-handler`` part must precede any parts with mime-types it is expected to handle in the same user data. |
740 | +This is a ``part-handler``: It contains custom code for either supporting new |
741 | +mime-types in multi-part user data, or overriding the existing handlers for |
742 | +supported mime-types. It will be written to a file in ``/var/lib/cloud/data`` |
743 | +based on its filename (which is generated). |
744 | + |
745 | +This must be python code that contains a ``list_types`` function and a |
746 | +``handle_part`` function. Once the section is read the ``list_types`` method |
747 | +will be called. It must return a list of mime-types that this part-handler |
748 | +handles. Because mime parts are processed in order, a ``part-handler`` part |
749 | +must precede any parts with mime-types it is expected to handle in the same |
750 | +user data. |
751 | |
752 | The ``handle_part`` function must be defined like: |
753 | |
754 | @@ -156,11 +179,13 @@ The ``handle_part`` function must be defined like: |
755 | # filename = the filename of the part (or a generated filename if none is present in mime data) |
756 | # payload = the parts' content |
757 | |
758 | -Cloud-init will then call the ``handle_part`` function once before it handles any parts, once per part received, and once after all parts have been handled. |
759 | -The ``'__begin__'`` and ``'__end__'`` sentinels allow the part handler to do initialization or teardown before or after |
760 | -receiving any parts. |
761 | +Cloud-init will then call the ``handle_part`` function once before it handles |
762 | +any parts, once per part received, and once after all parts have been handled. |
763 | +The ``'__begin__'`` and ``'__end__'`` sentinels allow the part handler to do |
764 | +initialization or teardown before or after receiving any parts. |
765 | |
766 | -Begins with: ``#part-handler`` or ``Content-Type: text/part-handler`` when using a MIME archive. |
767 | +Begins with: ``#part-handler`` or ``Content-Type: text/part-handler`` when |
768 | +using a MIME archive. |
769 | |
770 | Example |
771 | ------- |
772 | diff --git a/doc/rtd/topics/merging.rst b/doc/rtd/topics/merging.rst |
773 | index 5f7ca18..2b5e5da 100644 |
774 | --- a/doc/rtd/topics/merging.rst |
775 | +++ b/doc/rtd/topics/merging.rst |
776 | @@ -68,8 +68,10 @@ Cloud-init provides merging for the following built-in types: |
777 | The ``Dict`` merger has the following options which control what is done with |
778 | values contained within the config. |
779 | |
780 | -- ``allow_delete``: Existing values not present in the new value can be deleted, defaults to False |
781 | -- ``no_replace``: Do not replace an existing value if one is already present, enabled by default. |
782 | +- ``allow_delete``: Existing values not present in the new value can be |
783 | + deleted, defaults to False |
784 | +- ``no_replace``: Do not replace an existing value if one is already present, |
785 | + enabled by default. |
786 | - ``replace``: Overwrite existing values with new ones. |
787 | |
788 | The ``List`` merger has the following options which control what is done with |
789 | @@ -77,7 +79,8 @@ the values contained within the config. |
790 | |
791 | - ``append``: Add new value to the end of the list, defaults to False. |
792 | - ``prepend``: Add new values to the start of the list, defaults to False. |
793 | -- ``no_replace``: Do not replace an existing value if one is already present, enabled by default. |
794 | +- ``no_replace``: Do not replace an existing value if one is already present, |
795 | + enabled by default. |
796 | - ``replace``: Overwrite existing values with new ones. |
797 | |
798 | The ``Str`` merger has the following options which control what is done with |
799 | @@ -88,10 +91,13 @@ the values contained within the config. |
800 | Common options for all merge types which control how recursive merging is |
801 | done on other types. |
802 | |
803 | -- ``recurse_dict``: If True merge the new values of the dictionary, defaults to True. |
804 | -- ``recurse_list``: If True merge the new values of the list, defaults to False. |
805 | +- ``recurse_dict``: If True merge the new values of the dictionary, defaults to |
806 | + True. |
807 | +- ``recurse_list``: If True merge the new values of the list, defaults to |
808 | + False. |
809 | - ``recurse_array``: Alias for ``recurse_list``. |
810 | -- ``recurse_str``: If True merge the new values of the string, defaults to False. |
811 | +- ``recurse_str``: If True merge the new values of the string, defaults to |
812 | + False. |
813 | |
814 | |
815 | Customizability |
816 | diff --git a/doc/rtd/topics/network-config-format-v2.rst b/doc/rtd/topics/network-config-format-v2.rst |
817 | index 50f5fa6..7f85755 100644 |
818 | --- a/doc/rtd/topics/network-config-format-v2.rst |
819 | +++ b/doc/rtd/topics/network-config-format-v2.rst |
820 | @@ -54,11 +54,11 @@ Physical devices |
821 | |
822 | : (Examples: ethernet, wifi) These can dynamically come and go between |
823 | reboots and even during runtime (hotplugging). In the generic case, they |
824 | - can be selected by ``match:`` rules on desired properties, such as name/name |
825 | - pattern, MAC address, driver, or device paths. In general these will match |
826 | - any number of devices (unless they refer to properties which are unique |
827 | - such as the full path or MAC address), so without further knowledge about |
828 | - the hardware these will always be considered as a group. |
829 | + can be selected by ``match:`` rules on desired properties, such as |
830 | + name/name pattern, MAC address, driver, or device paths. In general these |
831 | + will match any number of devices (unless they refer to properties which are |
832 | + unique such as the full path or MAC address), so without further knowledge |
833 | + about the hardware these will always be considered as a group. |
834 | |
835 | It is valid to specify no match rules at all, in which case the ID field is |
836 | simply the interface name to be matched. This is mostly useful if you want |
837 | @@ -228,8 +228,8 @@ Example: :: |
838 | |
839 | **parameters**: *<(mapping)>* |
840 | |
841 | -Customization parameters for special bonding options. Time values are specified |
842 | -in seconds unless otherwise specified. |
843 | +Customization parameters for special bonding options. Time values are |
844 | +specified in seconds unless otherwise specified. |
845 | |
846 | **mode**: *<(scalar)>* |
847 | |
848 | @@ -367,8 +367,8 @@ Example: :: |
849 | |
850 | **parameters**: <*(mapping)>* |
851 | |
852 | -Customization parameters for special bridging options. Time values are specified |
853 | -in seconds unless otherwise specified. |
854 | +Customization parameters for special bridging options. Time values are |
855 | +specified in seconds unless otherwise specified. |
856 | |
857 | **ageing-time**: <*(scalar)>* |
858 |
PASSED: Continuous integration, rev:b16a3abc652 4904dd74613180b 6d5e88e2332e68 /jenkins. ubuntu. com/server/ job/cloud- init-ci/ 1100/
https:/
Executed test runs:
SUCCESS: Checkout
SUCCESS: Unit & Style Tests
SUCCESS: Ubuntu LTS: Build
SUCCESS: Ubuntu LTS: Integration
IN_PROGRESS: Declarative: Post Actions
Click here to trigger a rebuild: /jenkins. ubuntu. com/server/ job/cloud- init-ci/ 1100//rebuild
https:/