Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
68 changes: 0 additions & 68 deletions doc/examples/cloud-config-datasources.txt

This file was deleted.

68 changes: 64 additions & 4 deletions doc/rtd/reference/base_config_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,74 @@ Datasource keys
Many datasources allow configuration of the datasource for use in
querying the datasource for meta-data using the ``datasource`` key.
This configuration is datasource dependent and can be found under
each datasource's respective :ref:`documentation<datasources>`. It will
generally take the form of:
each datasource's respective :ref:`documentation<datasources>`. Example:

.. code-block:: yaml

datasource:
<datasource_name>:
...
Ec2:
# timeout: the timeout value for a request at metadata service
timeout: 50
# The length in seconds to wait before giving up on the metadata
# service. The actual total wait could be up to
# len(resolvable_metadata_urls)*timeout
max_wait: 240

# metadata_url: a list of URLs to check for metadata services
metadata_urls:
- http://169.254.169.254:80
- http://instance-data:8773

MAAS:
timeout: 50
max_wait: 120

# there are no default values for metadata_url or oauth credentials
# If no credentials are present, non-authed attempts will be made.
metadata_url: http://mass-host.localdomain/source
consumer_key: Xh234sdkljf
token_key: kjfhgb3n
token_secret: 24uysdfx1w4

NoCloud:
# default seedfrom is None
# if found, then it should contain a url with:
# <url>/user-data and <url>/meta-data
# seedfrom: http://my.example.com/i-abcde/
seedfrom: None

# fs_label: the label on filesystems to be searched for NoCloud source
fs_label: cidata

# these are optional, but allow you to provide configuration
user-data: |
# This is the user-data verbatim
meta-data: |
instance-id: i-87018aed
local-hostname: myhost.internal

SmartOS:
# For KVM guests:
# Smart OS datasource works over a serial console interacting with
# a server on the other end. By default, the second serial console is the
# device. SmartOS also uses a serial timeout of 60 seconds.
serial_device: /dev/ttyS1
serial_timeout: 60

# For LX-Brand Zones guests:
# Smart OS datasource works over a socket interacting with
# the host on the other end. By default, the socket file is in
# the native .zoncontrol directory.
metadata_sockfile: /native/.zonecontrol/metadata.sock

# a list of keys that will not be base64 decoded even if base64_all
no_base64_decode: ['root_authorized_keys', 'motd_sys_info',
'iptables_disable']
# a plaintext, comma delimited list of keys whose values are b64 encoded
base64_keys: []
# a boolean indicating that all keys not in 'no_base64_decode' are encoded
base64_all: False


System info keys
----------------
Expand Down
7 changes: 0 additions & 7 deletions doc/rtd/reference/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,6 @@ Disk setup
:language: yaml
:linenos:

Configure data sources
======================

.. literalinclude:: ../../examples/cloud-config-datasources.txt
:language: yaml
:linenos:

Create partitions and filesystems
=================================

Expand Down