summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/capabilities.rst
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@yahoo-inc.com>2013-01-24 18:41:26 -0800
committerJoshua Harlow <harlowja@yahoo-inc.com>2013-01-24 18:41:26 -0800
commit6fb6fe24d5ba185d42f2d7a82c3c54d26fea3392 (patch)
tree44154d0e09b265078bda33e85f171de55b11b48e /doc/rtd/topics/capabilities.rst
parent6f0756e5501ae660b2173ff558867941ab963a42 (diff)
downloadvyos-cloud-init-6fb6fe24d5ba185d42f2d7a82c3c54d26fea3392.tar.gz
vyos-cloud-init-6fb6fe24d5ba185d42f2d7a82c3c54d26fea3392.zip
Add docs which can be used on readthedocs.org
Include a new set of docs that can be used to create a readthedocs.org site, which includes examples, directory layout, capabilities and such. This in-code documentation then allows for readthedocs.org to create a website directly from the cloud-init codebase.
Diffstat (limited to 'doc/rtd/topics/capabilities.rst')
-rw-r--r--doc/rtd/topics/capabilities.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/rtd/topics/capabilities.rst b/doc/rtd/topics/capabilities.rst
new file mode 100644
index 00000000..63b34270
--- /dev/null
+++ b/doc/rtd/topics/capabilities.rst
@@ -0,0 +1,24 @@
+=====================
+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 up ephemeral mount points
+
+User configurability
+--------------------
+
+`Cloud-init`_ 's behavior can be configured via user-data.
+
+ User-data can be given by the user at instance launch time.
+
+This is done via the ``--user-data`` or ``--user-data-file`` argument to ec2-run-instances for example.
+
+* Check your local clients documentation for how to provide a `user-data` string
+ or `user-data` file for usage by cloud-init on instance creation.
+
+
+.. _Cloud-init: https://launchpad.net/cloud-init