summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorScott Moser <smoser@brickies.net>2017-04-03 11:52:06 -0400
committerScott Moser <smoser@brickies.net>2017-04-03 11:52:06 -0400
commit3b2e493b51153cd5bc1fa91e6ac52f59d41fe3fb (patch)
tree678b118605245e5bb1b218565728270702aba5b4 /doc
parente018fa910fdf0dbf3aa22e59e935461babd205c4 (diff)
parent61eb03fef92f435434d974fb46439189ef0b5f97 (diff)
downloadvyos-cloud-init-3b2e493b51153cd5bc1fa91e6ac52f59d41fe3fb.tar.gz
vyos-cloud-init-3b2e493b51153cd5bc1fa91e6ac52f59d41fe3fb.zip
merge from master at 0.7.9-90-g61eb03fe
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/cloud-config.txt9
-rw-r--r--doc/rtd/topics/capabilities.rst29
-rw-r--r--doc/rtd/topics/datasources/configdrive.rst8
-rw-r--r--doc/rtd/topics/tests.rst14
4 files changed, 52 insertions, 8 deletions
diff --git a/doc/examples/cloud-config.txt b/doc/examples/cloud-config.txt
index c03f1026..bd84c641 100644
--- a/doc/examples/cloud-config.txt
+++ b/doc/examples/cloud-config.txt
@@ -426,14 +426,21 @@ syslog_fix_perms: syslog:root
#
# there is also an option to set multiple users passwords, using 'chpasswd'
# That looks like the following, with 'expire' set to 'True' by default.
-# to not expire users passwords, set 'expire' to 'False':
+# to not expire users passwords, set 'expire' to 'False'. Also possible
+# to set hashed password, here account 'user3' has a password it set to
+# 'cloud-init', hashed with SHA-256:
# chpasswd:
# list: |
# user1:password1
# user2:RANDOM
+# user3:$5$eriogqzq$Dg7PxHsKGzziuEGkZgkLvacjuEFeljJ.rLf.hZqKQLA
# expire: True
# ssh_pwauth: [ True, False, "" or "unchanged" ]
#
+# Hashed passwords can be generated in multiple ways, example with python3:
+# python3 -c 'import crypt,getpass; print(crypt.crypt(getpass.getpass(), crypt.mksalt(crypt.METHOD_SHA512)))'
+# Newer versions of 'mkpasswd' will also work: mkpasswd -m sha-512 password
+#
# So, a simple working example to allow login via ssh, and not expire
# for the default user would look like:
password: passw0rd
diff --git a/doc/rtd/topics/capabilities.rst b/doc/rtd/topics/capabilities.rst
index be0802c5..2c8770bd 100644
--- a/doc/rtd/topics/capabilities.rst
+++ b/doc/rtd/topics/capabilities.rst
@@ -3,10 +3,11 @@ Capabilities
************
- Setting a default locale
-- Setting a instance hostname
-- Generating instance ssh private keys
-- Adding ssh keys to a users ``.ssh/authorized_keys`` so they can log in
+- Setting an instance hostname
+- Generating instance SSH private keys
+- Adding SSH keys to a user's ``.ssh/authorized_keys`` so they can log in
- Setting up ephemeral mount points
+- Configuring network devices
User configurability
====================
@@ -22,5 +23,27 @@ ec2-run-instances for example.
string or `user-data` file for usage by cloud-init on instance creation.
+Feature detection
+=================
+
+Newer versions of cloud-init may have a list of additional features that they
+support. This allows other applications to detect what features the installed
+cloud-init supports without having to parse its version number. If present,
+this list of features will be located at ``cloudinit.version.FEATURES``.
+
+When checking if cloud-init supports a feature, in order to not break the
+detection script on older versions of cloud-init without the features list, a
+script similar to the following should be used. Note that this will exit 0 if
+the feature is supported and 1 otherwise::
+
+ import sys
+ from cloudinit import version
+ sys.exit('<FEATURE_NAME>' not in getattr(version, 'FEATURES', []))
+
+Currently defined feature names include:
+
+ - ``NETWORK_CONFIG_V1`` support for v1 networking configuration, see curtin
+ documentation for examples.
+
.. _Cloud-init: https://launchpad.net/cloud-init
.. vi: textwidth=78
diff --git a/doc/rtd/topics/datasources/configdrive.rst b/doc/rtd/topics/datasources/configdrive.rst
index acdab6a2..11dd52ab 100644
--- a/doc/rtd/topics/datasources/configdrive.rst
+++ b/doc/rtd/topics/datasources/configdrive.rst
@@ -18,12 +18,13 @@ support listed below)
Version 1
---------
+**Note:** Version 1 is legacy and should be considered deprecated. Version 2
+has been supported in OpenStack since 2012.2 (Folsom).
The following criteria are required to as a config drive:
1. Must be formatted with `vfat`_ filesystem
-2. Must be a un-partitioned block device (/dev/vdb, not /dev/vdb1)
-3. Must contain *one* of the following files
+2. Must contain *one* of the following files
::
@@ -56,8 +57,7 @@ The following criteria are required to as a config drive:
1. Must be formatted with `vfat`_ or `iso9660`_ filesystem
or have a *filesystem* label of **config-2**
-2. Must be a un-partitioned block device (/dev/vdb, not /dev/vdb1)
-3. The files that will typically be present in the config drive are:
+2. The files that will typically be present in the config drive are:
::
diff --git a/doc/rtd/topics/tests.rst b/doc/rtd/topics/tests.rst
index 00c63c63..0663811e 100644
--- a/doc/rtd/topics/tests.rst
+++ b/doc/rtd/topics/tests.rst
@@ -238,6 +238,20 @@ without the more lengthy collect process. This can be done by running:
The above command will run the verify scripts on the data discovered in
`/tmp/collection`.
+Run via tox
+-----------
+In order to avoid the need for dependencies and ease the setup and
+configuration users can run the integration tests via tox:
+
+.. code-block:: bash
+
+ $ tox -e citest -- run [integration test arguments]
+ $ tox -e citest -- run -v -n zesty --deb=cloud-init_all.deb
+ $ tox -e citest -- run -t module/user_groups.yaml
+
+Users need to invoke the citest enviornment and then pass any additional
+arguments.
+
Architecture
============