Skip to content

Minor Documentation Improvements #1259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheRealFalcon merged 1 commit into from
Feb 10, 2022
Merged

Minor Documentation Improvements #1259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/examples/cloud-config-user-groups.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ users:
# provided public-keys. An error will be raised if ssh_authorized_keys
# or ssh_import_id is provided for the same user.
#
# ssh_authorized_keys.
# sudo: Defaults to none. Accepts a sudo rule string, a list of sudo rule
# strings or False to explicitly deny sudo usage. Examples:
#
Expand Down Expand Up @@ -125,7 +124,7 @@ users:

# Default user creation:
#
# Unless you define users, you will get a 'ubuntu' user on ubuntu systems with the
# Unless you define users, you will get a 'ubuntu' user on Ubuntu systems with the
# legacy permission (no password sudo, locked user, etc). If however, you want
# to have the 'ubuntu' user in addition to other users, you need to instruct
# cloud-init that you also want the default user. To do this use the following
Expand Down
2 changes: 1 addition & 1 deletion doc/examples/cloud-config-write-files.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# vim: syntax=yaml
#
# This is the configuration syntax that the write_files module
# will know how to understand. encoding can be given b64 or gzip or (gz+b64).
# will know how to understand. Encoding can be given b64 or gzip or (gz+b64).
# The content will be decoded accordingly and then written to the path that is
# provided.
#
Expand Down
14 changes: 7 additions & 7 deletions doc/rtd/topics/boot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ If this is an instance's first boot, then the selected network configuration
is rendered. This includes clearing of all previous (stale) configuration
including persistent device naming with old mac addresses.

This stage must block network bring-up or any stale configuration might
already have been applied. That could have negative effects such as DHCP
hooks or broadcast of an old hostname. It would also put the system in
an odd state to recover from as it may then have to restart network
This stage must block network bring-up or any stale configuration that might
have already been applied. Otherwise, that could have negative effects such
as DHCP hooks or broadcast of an old hostname. It would also put the system
in an odd state to recover from, as it may then have to restart network
devices.

Cloud-init then exits and expects for the continued boot of the operating
Expand All @@ -93,7 +93,7 @@ Network
+---------+--------+----------------------------------------------------------+

This stage requires all configured networking to be online, as it will fully
process any user-data that is found. Here, processing means:
process any user-data that is found. Here processing means:

* retrieve any ``#include`` or ``#include-once`` (recursively) including http
* decompress any compressed content
Expand All @@ -106,7 +106,7 @@ from sources only available via network. For example, a user may have
provided user-data in a network resource that describes how local mounts
should be done.

On some clouds such as Azure, this stage will create filesystems to be
On some clouds, such as Azure, this stage will create filesystems to be
mounted, including ones that have stale (previous instance) references in
``/etc/fstab``. As such, entries ``/etc/fstab`` other than those necessary for
cloud-init to run should not be done until after this stage.
Expand Down Expand Up @@ -146,7 +146,7 @@ Final

This stage runs as late in boot as possible. Any scripts that a user is
accustomed to running after logging into a system should run correctly here.
Things that run here include
Things that run here include:

* package installations
* configuration management plugins (puppet, chef, salt-minion)
Expand Down
6 changes: 3 additions & 3 deletions doc/rtd/topics/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ option. This can be used against cloud-init itself or any of its subcommands.
-h, --help show this help message and exit
--version, -v show program's version number and exit
--file FILES, -f FILES
additional yaml configuration files to use
additional yaml configuration files to use
--debug, -d show additional pre-action logging (default: False)
--force force running even if no datasource is found (use at
your own risk)
your own risk)

Subcommands:
{init,modules,single,query,dhclient-hook,features,analyze,devel,collect-logs,clean,status}
Expand Down Expand Up @@ -115,7 +115,7 @@ Current subcommands:
containing the jinja template header ``## template: jinja`` and renders
that content with any instance-data.json variables present.
* ``schema``: a **#cloud-config** format and schema
validator. It accepts a cloud-config yaml file and annotates potential
validator. It accepts a cloud-config YAML file and annotates potential
schema errors locally without the need for deployment. Schema
validation is work in progress and supports a subset of cloud-config
modules.
Expand Down
2 changes: 1 addition & 1 deletion doc/rtd/topics/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.. include:: ../../../CONTRIBUTING.rst
.. vi: textwidth=78
.. vi: textwidth=79
12 changes: 6 additions & 6 deletions doc/rtd/topics/datasources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Datasources
***********

Datasources are sources of configuration data for cloud-init that typically
come from the user (e.g. userdata) or come from the cloud that created the
configuration drive (e.g. metadata). Typical userdata would include files,
yaml, and shell scripts while typical metadata would include server name,
come from the user (i.e. userdata) or come from the cloud that created the
configuration drive (i.e. metadata). Typical userdata would include files,
YAML, and shell scripts while typical metadata would include server name,
instance id, display name and other cloud specific details.

Since there are multiple ways to provide this data (each cloud solution seems
Expand All @@ -29,13 +29,13 @@ The following is a list of documents for each supported datasource:

datasources/aliyun.rst
datasources/altcloud.rst
datasources/ec2.rst
Copy link
Copy Markdown
Author

@eslerm eslerm Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes the rendered HTML list alphabetical (i.e., Amazon Ec2).

datasources/azure.rst
datasources/cloudsigma.rst
datasources/cloudstack.rst
datasources/configdrive.rst
datasources/digitalocean.rst
datasources/e24cloud.rst
datasources/ec2.rst
datasources/exoscale.rst
datasources/fallback.rst
datasources/gce.rst
Expand All @@ -49,9 +49,9 @@ The following is a list of documents for each supported datasource:
datasources/rbxcloud.rst
datasources/smartos.rst
datasources/upcloud.rst
datasources/zstack.rst
datasources/vultr.rst
datasources/vmware.rst
datasources/vultr.rst
datasources/zstack.rst

Creation
========
Expand Down
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/aliyun.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ If no user-data is provided, this will return a 404.
#!/bin/sh
echo "Hello World."

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/altcloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ For more information on Delta Cloud see: http://deltacloud.apache.org

.. _RHEVm: https://www.redhat.com/virtualization/rhev/desktop/rhevm/
.. _vSphere: https://www.vmware.com/products/datacenter-virtualization/vsphere/overview.html
.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/azure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ this by setting the hostname in the DataSource's 'get_data' method via
behavior can be configured or disabled in the datasource config. See
'Configuration' above.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/cloudsigma.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ value. If this field does not exist the default value is "net".
.. _server context: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html
.. _meta field: http://cloudsigma-docs.readthedocs.org/en/latest/meta.html
.. _config formats: http://cloudinit.readthedocs.org/en/latest/topics/format.html
.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/cloudstack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ An example configuration with the default values is provided below:
.. _Apache CloudStack: http://cloudstack.apache.org/
.. _CloudStack Administrator Guide: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/virtual_machines.html#user-data-and-meta-data

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/configdrive.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ what all can be present here.
.. _iso9660: https://en.wikipedia.org/wiki/ISO_9660
.. _vfat: https://en.wikipedia.org/wiki/File_Allocation_Table
.. _the config drive extension: https://docs.openstack.org/nova/latest/admin/config-drive.html
.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/digitalocean.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ DigitalOcean's datasource can be configured as follows:
.. _metadata service: https://developers.digitalocean.com/metadata/
.. _Full documentation: https://developers.digitalocean.com/metadata/

.. vi: textwidth=78
.. vi: textwidth=79
4 changes: 2 additions & 2 deletions doc/rtd/topics/datasources/e24cloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

E24Cloud
========
`E24Cloud <https://www.e24cloud.com/en/>` platform provides an AWS Ec2 metadata
`E24Cloud <https://www.e24cloud.com/en/>`_ platform provides an AWS Ec2 metadata
service clone. It identifies itself to guests using the dmi
system-manufacturer (/sys/class/dmi/id/sys_vendor).

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/ec2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ Notes
For example: the primary NIC will have a DHCP route-metric of 100,
the next NIC will be 200.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/fallback.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ will be so that the user is not left with an inaccessible instance.
**Note:** the instance id that this datasource provides is
``iid-datasource-none``.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/gce.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ An example configuration with the default values is provided below:

.. _GCE metadata docs: https://cloud.google.com/compute/docs/storing-retrieving-metadata#querying

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/lxd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ datasource for LXD instances with a more direct support for LXD APIs instead
of static NoCloud seed files.

.. _LXD socket device: https://linuxcontainers.org/lxd/docs/master/dev-lxd
.. vi: textwidth=78
.. vi: textwidth=79
6 changes: 3 additions & 3 deletions doc/rtd/topics/datasources/nocloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ These user-data and meta-data files are expected to be in the following format.

Both files are required to be present for it to be considered a valid seed ISO.

Basically, user-data is simply user-data and meta-data is a yaml formatted file
Basically, user-data is simply user-data and meta-data is a YAML formatted file
representing what you'd find in the EC2 metadata service.

You may also optionally provide a vendor-data file in the following format.
Expand Down Expand Up @@ -115,7 +115,7 @@ Example metadata:

Network configuration can also be provided to cloud-init in either
:ref:`network_config_v1` or :ref:`network_config_v2` by providing that
yaml formatted data in a file named ``network-config``. If found,
YAML formatted data in a file named ``network-config``. If found,
this file will override a ``network-interfaces`` file.

See an example below. Note specifically that this file does not
Expand Down Expand Up @@ -151,4 +151,4 @@ be network configuration based on the filename.

.. _iso9660: https://en.wikipedia.org/wiki/ISO_9660
.. _vfat: https://en.wikipedia.org/wiki/File_Allocation_Table
.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/opennebula.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ Example VM's context section
.. _contextualizing VMs: http://opennebula.org/documentation:documentation:cong
.. _network configuration: http://opennebula.org/documentation:documentation:cong#network_configuration
.. _iso9660: https://en.wikipedia.org/wiki/ISO_9660
.. vi: textwidth=78
.. vi: textwidth=79
8 changes: 4 additions & 4 deletions doc/rtd/topics/datasources/openstack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Discovery
To determine whether a platform looks like it may be OpenStack, cloud-init
checks the following environment attributes as a potential OpenStack platform:

* Maybe OpenStack if
* Maybe OpenStack if:

* **non-x86 cpu architecture**: because DMI data is buggy on some arches
* Is OpenStack **if x86 architecture and ANY** of the following
* Is OpenStack **if x86 architecture and ANY** of the following:

* **/proc/1/environ**: Nova-lxd contains *product_name=OpenStack Nova*
* **DMI product_name**: Either *Openstack Nova* or *OpenStack Compute*
Expand All @@ -32,7 +32,7 @@ The settings that may be configured are:

* **metadata_urls**: This list of urls will be searched for an OpenStack
metadata service. The first entry that successfully returns a 200 response
for <url>/openstack will be selected. (default: ['http://169.254.169.254']).
for <url>/openstack will be selected. (default: ['http://169.254.169.254'])
* **max_wait**: the maximum amount of clock time in seconds that should be
spent searching metadata_urls. A value less than zero will result in only
one request being made, to the first in the list. (default: -1)
Expand Down Expand Up @@ -90,4 +90,4 @@ Cloud-init will look for a ``cloud-init`` at the vendor_data2 path; if found,
settings are applied after (and, hence, overriding) the settings from static
vendor data. Both sets of vendor data can be overridden by user data.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/oracle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ An example configuration with the default values is provided below:
configure_secondary_nics: false

.. _Oracle Compute Infrastructure: https://cloud.oracle.com/
.. vi: textwidth=78
.. vi: textwidth=79
4 changes: 2 additions & 2 deletions doc/rtd/topics/datasources/ovf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ The following VMTools configuration options affect cloud-init's behavior on a bo

VMWare admin can refer to (https://github.com/canonical/cloud-init/blob/main/cloudinit/sources/helpers/vmware/imc/config.py) and set the customization specification settings.

For more information, see [VMware vSphere Product Documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-9A5093A5-C54F-4502-941B-3F9C0F573A39.html) and specific VMTools parameters consumed.
For more information, see `VMware vSphere Product Documentation <https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-9A5093A5-C54F-4502-941B-3F9C0F573A39.html>`_ and specific VMTools parameters consumed.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/rbxcloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ is restarted, if the partition exists. For more information see
.. _HyperOne Virtual Machine docs: http://www.hyperone.com/
.. _FAT: https://en.wikipedia.org/wiki/File_Allocation_Table

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/smartos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,4 @@ You can control the disk_setup then in 2 ways:

See doc/examples/cloud-config-disk-setup.txt for information on disk_setup.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/upcloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ immutable during server's lifetime and can be removed by deleting the server.
.. _UpCloud: https://upcloud.com/
.. _metadata service: https://upcloud.com/community/tutorials/upcloud-metadata-service/

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/vmware.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GuestInfo Keys
^^^^^^^^^^^^^^

One method of providing meta, user, and vendor data is by setting the following
key/value pairs on a VM's ``extraConfig`` `property <https://vdc-repo.vmware.com/vmwb-repository/dcr-public/723e7f8b-4f21-448b-a830-5f22fd931b01/5a8257bd-7f41-4423-9a73-03307535bd42/doc/vim.vm.ConfigInfo.html>`_ :
key/value pairs on a VM's ``extraConfig`` `property <https://vdc-repo.vmware.com/vmwb-repository/dcr-public/723e7f8b-4f21-448b-a830-5f22fd931b01/5a8257bd-7f41-4423-9a73-03307535bd42/doc/vim.vm.ConfigInfo.html>`_:

.. list-table::
:header-rows: 1
Expand Down
4 changes: 2 additions & 2 deletions doc/rtd/topics/datasources/vultr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Vultr

The `Vultr`_ datasource retrieves basic configuration values from the locally
accessible `metadata service`_. All data is served over HTTP from the address
169.254.169.254. The endpoints are documented in,
169.254.169.254. The endpoints are documented in
`https://www.vultr.com/metadata/
<https://www.vultr.com/metadata/>`_

Expand All @@ -32,4 +32,4 @@ Vultr's datasource can be configured as follows:
.. _Vultr: https://www.vultr.com/
.. _metadata service: https://www.vultr.com/metadata/

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/datasources/zstack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Same as EC2, instance userdata can be queried at
user_data
password

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/dir_layout.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ application::
semaphore `files` which are only supposed to run `per-once` (not tied to the
instance id).

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ On every boot, apply network configuration found in the datasource.

.. _Cloud-init: https://launchpad.net/cloud-init
.. _on Launchpad: https://bugs.launchpad.net/cloud-init/+bug/1936229
.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,4 @@ Grow partitions

.. _chef: http://www.chef.io/chef/
.. _puppet: http://puppetlabs.com/
.. vi: textwidth=78
.. vi: textwidth=79
6 changes: 3 additions & 3 deletions doc/rtd/topics/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Include File
This content is a ``include`` file.

The file contains a list of urls, one per line. Each of the URLs will be read,
and their content will be passed through this same set of rules. Ie, the
and their content will be passed through this same set of rules. I.e., the
content read from the URL can be gzipped, mime-multi-part, or plain text. If
an error occurs reading a file the remaining files will not be read.

Expand All @@ -112,7 +112,7 @@ These things include:
- *and many more...*

.. note::
This file must be valid yaml syntax.
This file must be valid YAML syntax.

See the :ref:`yaml_examples` section for a commented set of examples of
supported cloud config formats.
Expand Down Expand Up @@ -209,4 +209,4 @@ cloud-init from processing user-data.
.. [#] See your cloud provider for applicable user-data size limitations...
.. _blog: http://foss-boss.blogspot.com/2011/01/advanced-cloud-init-custom-handlers.html

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/instancedata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,4 +655,4 @@ see only redacted values.
instance booted on your favorite cloud. See :ref:`cli_devel` for more
information.

.. vi: textwidth=78
.. vi: textwidth=79
2 changes: 1 addition & 1 deletion doc/rtd/topics/integration_tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ tests against the image in question. If it's a RHEL8 image, then we
would expect Ubuntu-specific tests to fail (and vice versa).

To address this, a full image specification can be given. This is of
the form: ``<image_id>[::<os>[::<release]]`` where ``image_id`` is a
the form: ``<image_id>[::<os>[::<release>]]`` where ``image_id`` is a
cloud's image ID, ``os`` is the OS name, and ``release`` is the OS
release name. So, for example, Ubuntu 18.04 (Bionic Beaver) on LXD is
``ubuntu:bionic::ubuntu::bionic`` or RHEL 8 on Amazon is
Expand Down
Loading