Merge ~smoser/cloud-init:doc/cleanup-doc-errors into cloud-init:master

Proposed by Scott Moser
Status: Merged
Approved by: Chad Smith
Approved revision: c634476b987b25bc5ba32ce759821cab3a1473ce
Merge reported by: Server Team CI bot
Merged at revision: not available
Proposed branch: ~smoser/cloud-init:doc/cleanup-doc-errors
Merge into: cloud-init:master
Diff against target: 117 lines (+22/-41)
2 files modified
doc/rtd/topics/datasources.rst (+1/-1)
doc/rtd/topics/datasources/azure.rst (+21/-40)
Reviewer Review Type Date Requested Status
Server Team CI bot continuous-integration Approve
cloud-init Commiters Pending
Review via email: mp+361467@code.launchpad.net

Commit message

doc: clean up some datasource documentation.

The change to datasources.rst here is obvious typo fix.
The change to azure is to reduce the two 'Customization' sections
to a single and clean up some other duplicate text.

Description of the change

see commit message

To post a comment you must log in.
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

PASSED: Continuous integration, rev:c634476b987b25bc5ba32ce759821cab3a1473ce
https://jenkins.ubuntu.com/server/job/cloud-init-ci/509/
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:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/509/rebuild

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst
index e34f145..5abbaef 100644
--- a/doc/rtd/topics/datasources.rst
+++ b/doc/rtd/topics/datasources.rst
@@ -18,7 +18,7 @@ single way to access the different cloud systems methods to provide this data
18through the typical usage of subclasses.18through the typical usage of subclasses.
1919
20Any metadata processed by cloud-init's datasources is persisted as20Any metadata processed by cloud-init's datasources is persisted as
21``/run/cloud0-init/instance-data.json``. Cloud-init provides tooling21``/run/cloud-init/instance-data.json``. Cloud-init provides tooling
22to quickly introspect some of that data. See :ref:`instance_metadata` for22to quickly introspect some of that data. See :ref:`instance_metadata` for
23more information.23more information.
2424
diff --git a/doc/rtd/topics/datasources/azure.rst b/doc/rtd/topics/datasources/azure.rst
index f73c369..720a475 100644
--- a/doc/rtd/topics/datasources/azure.rst
+++ b/doc/rtd/topics/datasources/azure.rst
@@ -23,18 +23,18 @@ information in json format to /run/cloud-init/dhclient.hook/<interface>.json.
23In order for cloud-init to leverage this method to find the endpoint, the23In order for cloud-init to leverage this method to find the endpoint, the
24cloud.cfg file must contain:24cloud.cfg file must contain:
2525
26datasource:26.. sourcecode:: yaml
27 Azure:27
28 set_hostname: False28 datasource:
29 agent_command: __builtin__29 Azure:
30 set_hostname: False
31 agent_command: __builtin__
3032
31If those files are not available, the fallback is to check the leases file33If those files are not available, the fallback is to check the leases file
32for the endpoint server (again option 245).34for the endpoint server (again option 245).
3335
34You can define the path to the lease file with the 'dhclient_lease_file'36You can define the path to the lease file with the 'dhclient_lease_file'
35configuration. The default value is /var/lib/dhcp/dhclient.eth0.leases.37configuration.
36
37 dhclient_lease_file: /var/lib/dhcp/dhclient.eth0.leases
3838
39walinuxagent39walinuxagent
40------------40------------
@@ -60,7 +60,7 @@ in order to use waagent.conf with cloud-init, the following settings are recomme
60Configuration60Configuration
61-------------61-------------
62The following configuration can be set for the datasource in system62The following configuration can be set for the datasource in system
63configuration (in `/etc/cloud/cloud.cfg` or `/etc/cloud/cloud.cfg.d/`).63configuration (in ``/etc/cloud/cloud.cfg`` or ``/etc/cloud/cloud.cfg.d/``).
6464
65The settings that may be configured are:65The settings that may be configured are:
6666
@@ -76,13 +76,25 @@ The settings that may be configured are:
76 * **disk_aliases**: A dictionary defining which device paths should be76 * **disk_aliases**: A dictionary defining which device paths should be
77 interpreted as ephemeral images. See cc_disk_setup module for more info.77 interpreted as ephemeral images. See cc_disk_setup module for more info.
78 * **hostname_bounce**: A dictionary Azure hostname bounce behavior to react to78 * **hostname_bounce**: A dictionary Azure hostname bounce behavior to react to
79 metadata changes.79 metadata changes. The '``hostname_bounce: command``' entry can be either
80 the literal string 'builtin' or a command to execute. The command will be
81 invoked after the hostname is set, and will have the 'interface' in its
82 environment. If ``set_hostname`` is not true, then ``hostname_bounce``
83 will be ignored. An example might be:
84
85 ``command: ["sh", "-c", "killall dhclient; dhclient $interface"]``
86
80 * **hostname_bounce**: A dictionary Azure hostname bounce behavior to react to87 * **hostname_bounce**: A dictionary Azure hostname bounce behavior to react to
81 metadata changes. Azure will throttle ifup/down in some cases after metadata88 metadata changes. Azure will throttle ifup/down in some cases after metadata
82 has been updated to inform dhcp server about updated hostnames.89 has been updated to inform dhcp server about updated hostnames.
83 * **set_hostname**: Boolean set to True when we want Azure to set the hostname90 * **set_hostname**: Boolean set to True when we want Azure to set the hostname
84 based on metadata.91 based on metadata.
8592
93Configuration for the datasource can also be read from a
94``dscfg`` entry in the ``LinuxProvisioningConfigurationSet``. Content in
95dscfg node is expected to be base64 encoded yaml content, and it will be
96merged into the 'datasource: Azure' entry.
97
86An example configuration with the default values is provided below:98An example configuration with the default values is provided below:
8799
88.. sourcecode:: yaml100.. sourcecode:: yaml
@@ -143,37 +155,6 @@ Example:
143 </LinuxProvisioningConfigurationSet>155 </LinuxProvisioningConfigurationSet>
144 </wa:ProvisioningSection>156 </wa:ProvisioningSection>
145157
146Configuration
147-------------
148Configuration for the datasource can be read from the system config's or set
149via the `dscfg` entry in the `LinuxProvisioningConfigurationSet`. Content in
150dscfg node is expected to be base64 encoded yaml content, and it will be
151merged into the 'datasource: Azure' entry.
152
153The '``hostname_bounce: command``' entry can be either the literal string
154'builtin' or a command to execute. The command will be invoked after the
155hostname is set, and will have the 'interface' in its environment. If
156``set_hostname`` is not true, then ``hostname_bounce`` will be ignored.
157
158An example might be:
159 command: ["sh", "-c", "killall dhclient; dhclient $interface"]
160
161.. code:: yaml
162
163 datasource:
164 agent_command
165 Azure:
166 agent_command: [service, walinuxagent, start]
167 set_hostname: True
168 hostname_bounce:
169 # the name of the interface to bounce
170 interface: eth0
171 # policy can be 'on', 'off' or 'force'
172 policy: on
173 # the method 'bounce' command.
174 command: "builtin"
175 hostname_command: "hostname"
176
177hostname158hostname
178--------159--------
179When the user launches an instance, they provide a hostname for that instance.160When the user launches an instance, they provide a hostname for that instance.

Subscribers

People subscribed via source and target branches