← Back to branch summary

~ubuntu-branches/ubuntu/saucy/cloud-init/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/sources/smartos/README.rst

  • Committer: Scott Moser
  • Date: 2013-09-21 00:42:27 UTC
  • mto: This revision was merged to the branch mainline in revision 306.
  • Revision ID: smoser@ubuntu.com-20130921004227-aew4tbz4rn2yhlov
Tags: upstream-0.7.3~bzr871
Import upstream version 0.7.3~bzr871

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/sources/smartos/README.rst
5
5
This datasource finds metadata and user-data from the SmartOS virtualization
6
6
platform (i.e. Joyent).
7
7
 
 
8
Please see http://smartos.org/ for information about SmartOS.
 
9
 
8
10
SmartOS Platform
9
11
----------------
10
 
The SmartOS virtualization platform meta-data to the instance via the second
11
 
serial console. On Linux, this is /dev/ttyS1. The data is a provided via a
12
 
simple protocol, where something queries for the userdata, where the console
 
12
The SmartOS virtualization platform uses meta-data to the instance via the
 
13
second serial console. On Linux, this is /dev/ttyS1. The data is a provided
 
14
via a simple protocol: something queries for the data, the console responds
13
15
responds with the status and if "SUCCESS" returns until a single ".\n".
14
16
 
15
17
New versions of the SmartOS tooling will include support for base64 encoded data.
18
20
--------
19
21
 
20
22
In SmartOS parlance, user-data is a actually meta-data. This userdata can be
21
 
provided a key-value pairs.
 
23
provided as key-value pairs.
22
24
 
23
25
Cloud-init supports reading the traditional meta-data fields supported by the
24
26
SmartOS tools. These are:
36
38
SmartOS traditionally supports sending over a user-script for execution at the
37
39
rc.local level. Cloud-init supports running user-scripts as if they were
38
40
cloud-init user-data. In this sense, anything with a shell interpreter
39
 
directive will run
 
41
directive will run.
40
42
 
41
43
user-data and user-script
42
44
-------------------------
43
45
 
44
46
In the event that a user defines the meta-data key of "user-data" it will
45
 
always supercede any user-script data. This is for consistency.
 
47
always supersede any user-script data. This is for consistency.
46
48
 
47
49
base64
48
50
------
70
72
  * no_base64_decode: This is a configuration setting
71
73
        (i.e. /etc/cloud/cloud.cfg.d) that sets which values should not be
72
74
        base64 decoded.
 
75
 
 
76
ephemeral_disk:
 
77
---------------
 
78
 
 
79
In order to instruct Cloud-init which disk to auto-mount. By default,
 
80
SmartOS only supports a single ephemeral disk.
 
81
 
 
82
The default SmartOS configuration will prepare the ephemeral disk and format
 
83
it for you. SmartOS does not, by default, prepare the ephemeral disk for you.
 
84
 
 
85
If you change ephemeral_disk, you should also consider changing
 
86
the default disk formatting parameters. See
 
87
doc/examples/cloud-config-disk-setup.txt for information on using this.