diff options
| -rw-r--r-- | doc/rtd/topics/datasources/ec2.rst | 3 | ||||
| -rw-r--r-- | doc/rtd/topics/datasources/gce.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/datasources/vmware.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/module_creation.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/network-config.rst | 2 | ||||
| -rw-r--r-- | tox.ini | 13 |
6 files changed, 19 insertions, 5 deletions
diff --git a/doc/rtd/topics/datasources/ec2.rst b/doc/rtd/topics/datasources/ec2.rst index 77232269..d30e1bb6 100644 --- a/doc/rtd/topics/datasources/ec2.rst +++ b/doc/rtd/topics/datasources/ec2.rst @@ -89,7 +89,8 @@ The settings that may be configured are: * **metadata_urls**: This list of urls will be searched for an EC2 metadata service. The first entry that successfully returns a 200 response for <url>/<version>/meta-data/instance-id will be selected. - (default: ['http://169.254.169.254', 'http://instance-data:8773']). + (default: ['http://169.254.169.254', 'http://[fd00:ec2::254]', + 'http://instance-data:8773']). * **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: 120) diff --git a/doc/rtd/topics/datasources/gce.rst b/doc/rtd/topics/datasources/gce.rst index 70aefea2..3aeb9afc 100644 --- a/doc/rtd/topics/datasources/gce.rst +++ b/doc/rtd/topics/datasources/gce.rst @@ -37,6 +37,6 @@ An example configuration with the default values is provided below: retries: 5 sec_between_retries: 1 -.. _GCE metadata docs: https://cloud.google.com/compute/docs/storing-retrieving-metadata#querying +.. _GCE metadata docs: https://cloud.google.com/compute/docs/storing-retrieving-metadata .. vi: textwidth=79 diff --git a/doc/rtd/topics/datasources/vmware.rst b/doc/rtd/topics/datasources/vmware.rst index f1f48117..59cfc2f8 100644 --- a/doc/rtd/topics/datasources/vmware.rst +++ b/doc/rtd/topics/datasources/vmware.rst @@ -7,7 +7,7 @@ This datasource is for use with systems running on a VMware platform such as vSphere and currently supports the following data transports: -* `GuestInfo <https://github.com/vmware/govmomi/blob/master/govc/USAGE.md#vmchange>`_ keys +* `GuestInfo <https://github.com/vmware/govmomi/blob/master/govc/USAGE.md>`_ keys Configuration ------------- diff --git a/doc/rtd/topics/module_creation.rst b/doc/rtd/topics/module_creation.rst index b09cd2cc..070d411f 100644 --- a/doc/rtd/topics/module_creation.rst +++ b/doc/rtd/topics/module_creation.rst @@ -111,7 +111,7 @@ in the ``cloud_final_modules`` section before the ``final-message`` module. .. _MetaSchema: https://github.com/canonical/cloud-init/blob/3bcffacb216d683241cf955e4f7f3e89431c1491/cloudinit/config/schema.py#L58 .. _OSFAMILIES: https://github.com/canonical/cloud-init/blob/3bcffacb216d683241cf955e4f7f3e89431c1491/cloudinit/distros/__init__.py#L35 .. _settings.py: https://github.com/canonical/cloud-init/blob/3bcffacb216d683241cf955e4f7f3e89431c1491/cloudinit/settings.py#L66 -.. _cloud-init-schema.json: https://github.com/canonical/cloud-init/blob/main/cloudinit/config/cloud-init-schema.json +.. _cloud-init-schema.json: https://github.com/canonical/cloud-init/blob/main/cloudinit/config/schemas/versions.schema.cloud-config.json .. _cloud.cfg.tmpl: https://github.com/canonical/cloud-init/blob/main/config/cloud.cfg.tmpl .. _cloud_init_modules: https://github.com/canonical/cloud-init/blob/b4746b6aed7660510071395e70b2d6233fbdc3ab/config/cloud.cfg.tmpl#L70 .. _cloud_config_modules: https://github.com/canonical/cloud-init/blob/b4746b6aed7660510071395e70b2d6233fbdc3ab/config/cloud.cfg.tmpl#L101 diff --git a/doc/rtd/topics/network-config.rst b/doc/rtd/topics/network-config.rst index f503caab..682637c4 100644 --- a/doc/rtd/topics/network-config.rst +++ b/doc/rtd/topics/network-config.rst @@ -290,7 +290,7 @@ Example output converting V2 to sysconfig: .. _Cloud-init: https://launchpad.net/cloud-init -.. _DigitalOcean JSON metadata: https://developers.digitalocean.com/documentation/metadata/#network-interfaces-index +.. _DigitalOcean JSON metadata: https://developers.digitalocean.com/documentation/metadata/ .. _OpenStack Metadata Service Network: https://specs.openstack.org/openstack/nova-specs/specs/liberty/implemented/metadata-service-network-info.html .. _SmartOS JSON Metadata: https://eng.joyent.com/mdata/datadict.html .. _UpCloud JSON metadata: https://developers.upcloud.com/1.3/8-servers/#metadata-service @@ -149,6 +149,19 @@ commands = {envpython} -m sphinx {posargs:-W doc/rtd doc/rtd_html} doc8 doc/rtd +# linkcheck shows false positives and has noisy output. +# Despite these limitations, it is better than a manual search of the docs. +# suggested workflow is: +# +# tox -e linkcheck | grep broken # takes some time +# +# followed by manual verification of the links reported +[testenv:linkcheck] +deps = + -r{toxinidir}/doc-requirements.txt +commands = + {envpython} -m sphinx {posargs:-b linkcheck doc/rtd doc/rtd_html} + [testenv:tip-flake8] commands = {envpython} -m flake8 {posargs:cloudinit/ tests/ tools/ conftest.py setup.py} deps = flake8 |