summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Bright <sean.bright@gmail.com>2016-11-18 17:15:08 -0500
committerScott Moser <smoser@brickies.net>2016-11-22 13:27:22 -0500
commit7e586f0d4f59a5051f8723e6bbdd06466d19729e (patch)
tree3dac3559f8934ff618b157009b171821b1768995
parentedd94ebff613fd99768d9287b12d72a9409ae6bc (diff)
downloadvyos-cloud-init-7e586f0d4f59a5051f8723e6bbdd06466d19729e.tar.gz
vyos-cloud-init-7e586f0d4f59a5051f8723e6bbdd06466d19729e.zip
Doc: various documentation fixes
Several various minor fixes for the readthedocs documentation.
-rw-r--r--cloudinit/config/cc_apt_configure.py6
-rw-r--r--cloudinit/config/cc_bootcmd.py2
-rw-r--r--doc/examples/cloud-config-boot-cmds.txt2
-rw-r--r--doc/rtd/topics/boot.rst4
-rw-r--r--doc/rtd/topics/format.rst2
-rw-r--r--doc/rtd/topics/logging.rst2
6 files changed, 10 insertions, 8 deletions
diff --git a/cloudinit/config/cc_apt_configure.py b/cloudinit/config/cc_apt_configure.py
index 6145fcd2..eb1db707 100644
--- a/cloudinit/config/cc_apt_configure.py
+++ b/cloudinit/config/cc_apt_configure.py
@@ -199,6 +199,8 @@ The ``source`` key supports variable replacements for the following strings:
deb-src $MIRROR $RELEASE main restricted
deb $PRIMARY $RELEASE universe restricted
deb $SECURITY $RELEASE-security multiverse
+ debconf_selections:
+ set1: the-package the-package/some-flag boolean true
conf: |
APT {
Get {
@@ -216,9 +218,9 @@ The ``source`` key supports variable replacements for the following strings:
keyserver: "keyserverurl"
source: "deb http://<url>/ xenial main"
source2:
- source "ppa:<ppa-name>"
+ source: "ppa:<ppa-name>"
source3:
- source "deb $MIRROR $RELEASE multiverse"
+ source: "deb $MIRROR $RELEASE multiverse"
key: |
------BEGIN PGP PUBLIC KEY BLOCK-------
<key data>
diff --git a/cloudinit/config/cc_bootcmd.py b/cloudinit/config/cc_bootcmd.py
index 22b23f28..291ac6e2 100644
--- a/cloudinit/config/cc_bootcmd.py
+++ b/cloudinit/config/cc_bootcmd.py
@@ -43,7 +43,7 @@ specified either as lists or strings. For invocation details, see ``runcmd``.
bootcmd:
- echo 192.168.1.130 us.archive.ubuntu.com > /etc/hosts
- - [ cloud-nit-per, once, mymkfs, mkfs, /dev/vdb ]
+ - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
"""
import os
diff --git a/doc/examples/cloud-config-boot-cmds.txt b/doc/examples/cloud-config-boot-cmds.txt
index 5c05bef7..84e487a5 100644
--- a/doc/examples/cloud-config-boot-cmds.txt
+++ b/doc/examples/cloud-config-boot-cmds.txt
@@ -9,7 +9,7 @@
# boothook, but possibly with more friendly.
# - bootcmd will run on every boot
# - the INSTANCE_ID variable will be set to the current instance id.
-# - you can use 'cloud-init-boot-per' command to help only run once
+# - you can use 'cloud-init-per' command to help only run once
bootcmd:
- echo 192.168.1.130 us.archive.ubuntu.com >> /etc/hosts
- [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
diff --git a/doc/rtd/topics/boot.rst b/doc/rtd/topics/boot.rst
index 9d42336c..859409a6 100644
--- a/doc/rtd/topics/boot.rst
+++ b/doc/rtd/topics/boot.rst
@@ -21,7 +21,7 @@ boot goals. By default, this generator will enable cloud-init. It will
not enable cloud-init if either:
* A file exists: ``/etc/cloud/cloud-init.disabled``
- * The kernel command line as fond in /proc/cmdline contains ``cloud-init=disabled``.
+ * The kernel command line as found in /proc/cmdline contains ``cloud-init=disabled``.
When running in a container, the kernel command line is not honored, but
cloud-init will read an environment variable named ``KERNEL_CMDLINE`` in
its place.
@@ -56,7 +56,7 @@ 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 DCHP
+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
devices.
diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst
index 5898d17a..ed87d3ed 100644
--- a/doc/rtd/topics/format.rst
+++ b/doc/rtd/topics/format.rst
@@ -9,7 +9,7 @@ Gzip Compressed Content
Content found to be gzip compressed will be uncompressed.
The uncompressed data will then be used as if it were not compressed.
-This is typically is useful because user-data is limited to ~16384 [#]_ bytes.
+This is typically useful because user-data is limited to ~16384 [#]_ bytes.
Mime Multi Part Archive
=======================
diff --git a/doc/rtd/topics/logging.rst b/doc/rtd/topics/logging.rst
index c6afca16..4fd7e28e 100644
--- a/doc/rtd/topics/logging.rst
+++ b/doc/rtd/topics/logging.rst
@@ -22,7 +22,7 @@ output to ``tee``, or ``logger``. If only a filename is provided, cloud-init
will append its output to the file as though ``>>`` was specified.
By default, cloud-init loads its output configuration from
-``/etc/cloud/coud.cfg.d/05_logging.cfg``. The default config directs both
+``/etc/cloud/cloud.cfg.d/05_logging.cfg``. The default config directs both
stdout and stderr from all cloud-init stages to
``/var/log/cloud-init-output.log``. The default config is given as ::