summaryrefslogtreecommitdiff
path: root/doc/sources/smartos/README.rst
blob: 96310857b176baba886d00d8f31aa19062496a27 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
==================
SmartOS Datasource
==================

This datasource finds metadata and user-data from the SmartOS virtualization
platform (i.e. Joyent).

SmartOS Platform
----------------
The SmartOS virtualization platform meta-data to the instance via the second
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.

Userdata
--------

In SmartOS parlance, user-data is a actually meta-data. This userdata can be
provided a key-value pairs.

Cloud-init supports reading the traditional meta-data fields supported by the
SmartOS tools. These are:
 * root_authorized_keys
 * hostname
 * enable_motd_sys_info
 * iptables_disable

Note: At this time iptables_disable and enable_motd_sys_info are read but
    are not actioned.

user-script
-----------

SmartOS traditionally supports sending over a user-script for execution at the
rc.local level. Cloud-init supports running user-scripts as if they were
cloud-init user-data. In this sense, anything with a shell interpetter
directive will run

user-data and user-script
-------------------------

In the event that a user defines the meta-data key of "user-data" it will
always supercede any user-script data. This is for consistency.

base64
------

In order to provide a lossy format, all data except for:
 * 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:
  * 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
  * base_64_encoded: A comma deliminated list of which values are base64
        encoded.
  * no_base64_decode: This is a configuration setting (i.e. /etc/cloud/cloud.cfg.d)
        that sets which values should not be base64 decoded.