summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Howard <ben.howard@canonical.com>2013-08-20 09:56:25 -0600
committerBen Howard <ben.howard@canonical.com>2013-08-20 09:56:25 -0600
commite683ab2baa3e67614edcd409122bd1aec99737e0 (patch)
tree845e6d5f7537c2627f2fe1043c944c64f7dbd994 /doc
parent8c4d88a630025b6fe9f90957343a94105768533f (diff)
downloadvyos-cloud-init-e683ab2baa3e67614edcd409122bd1aec99737e0.tar.gz
vyos-cloud-init-e683ab2baa3e67614edcd409122bd1aec99737e0.zip
Fixed no_base64_decode settings
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/cloud-config-datasources.txt2
-rw-r--r--doc/sources/smartos/README.rst12
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/examples/cloud-config-datasources.txt b/doc/examples/cloud-config-datasources.txt
index 6544448e..6ec0d57e 100644
--- a/doc/examples/cloud-config-datasources.txt
+++ b/doc/examples/cloud-config-datasources.txt
@@ -55,5 +55,5 @@ datasource:
# 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_device: /dev/ttyS1
serial timeout: 60
diff --git a/doc/sources/smartos/README.rst b/doc/sources/smartos/README.rst
index 96310857..ba90e7af 100644
--- a/doc/sources/smartos/README.rst
+++ b/doc/sources/smartos/README.rst
@@ -12,8 +12,7 @@ serial console. On Linux, this is /dev/ttyS1. The data is a provided via a
simple protocol, where something queries for the userdata, where the console
responds with the status and if "SUCCESS" returns until a single ".\n".
-The format is lossy. As such, new versions of the SmartOS tooling will include
-support for base64 encoded data.
+New versions of the SmartOS tooling will include support for base64 encoded data.
Userdata
--------
@@ -48,15 +47,16 @@ always supercede any user-script data. This is for consistency.
base64
------
-In order to provide a lossy format, all data except for:
+The following are excempt from base64 encoding, owing to the fact that they
+are provided by SmartOS:
* root_authorized_keys
* enable_motd_sys_info
* iptables_disable
This means that user-script and user-data as well as other values can be
-base64 encoded to provide a lossy format. Since Cloud-init can only guess
-as to whether or not something is truly base64 encoded, the following
-meta-data keys are hints as to whether or not to base64 decode something:
+base64 encoded. Since Cloud-init can only guess as to whether or not something
+is truly base64 encoded, the following meta-data keys are hints as to whether
+or not to base64 decode something:
* decode_base64: Except for excluded keys, attempt to base64 decode
the values. If the value fails to decode properly, it will be
returned in its text