1
diff --git a/cloudinit/sources/DataSourceIBMCloud.py b/cloudinit/sources/DataSourceIBMCloud.py
2
index 02b3d56..cfa724b 100644
3
--- a/cloudinit/sources/DataSourceIBMCloud.py
4
+++ b/cloudinit/sources/DataSourceIBMCloud.py
5
@@ -30,11 +30,73 @@ There are 2 different api exposed launch methods.
6
30
   mean that 1 in 8^16 (~4 billion) Xen ConfigDrive systems will be
30
   mean that 1 in 8^16 (~4 billion) Xen ConfigDrive systems will be
7
31
   incorrectly identified as IBMCloud.
31
   incorrectly identified as IBMCloud.
8
32
32
9
33
The combination of these 2 launch methods and with or without user-data
10
34
creates 6 boot scenarios.
11
35
 A. os_code with user-data
12
36
 B. os_code without user-data
13
37
    Cloud-init is fully operational in this mode.
14
38
15
39
    There is a block device attached with label 'config-2'.
16
40
    As it differs from OpenStack's config-2, we have to differentiate.
17
41
    We do so by requiring the UUID on the filesystem to be "9796-932E".
18
42
19
43
    This disk will have the following files. Specifically note, there
20
44
    is no versioned path to the meta-data, only 'latest':
21
45
      openstack/latest/meta_data.json
22
46
      openstack/latest/network_data.json
23
47
      openstack/latest/user_data [optional]
24
48
      openstack/latest/vendor_data.json
25
49
26
50
    vendor_data.json as of 2018-04 looks like this:
27
51
      {"cloud-init":"#!/bin/bash\necho 'root:$6$<snip>' | chpasswd -e"}
28
52
29
53
    The only difference between A and B in this mode is the presence
30
54
    of user_data on the config disk.
31
55
32
56
 C. template, provisioning boot with user-data
33
57
 D. template, provisioning boot without user-data.
34
58
    With ds-identify cloud-init is fully disabled in this mode.
35
59
    Without ds-identify, cloud-init None datasource will be used.
36
60
37
61
    This is currently identified by the presence of
38
62
    /root/provisioningConfiguration.cfg . That file is placed into the
39
63
    system before it is booted.
40
64
41
65
    The difference between C and D is the presence of the METADATA disk
42
66
    as described in E below.  There is no METADATA disk attached unless
43
67
    user-data is provided.
44
68
45
69
 E. template, post-provisioning boot with user-data.
46
70
    Cloud-init is fully operational in this mode.
47
71
48
72
    This is identified by a block device with filesystem label "METADATA".
49
73
    The looks similar to a version-1 OpenStack config drive.  It will
50
74
    have the following files:
51
75
52
76
       openstack/latest/user_data
53
77
       openstack/latest/meta_data.json
54
78
       openstack/content/interfaces
55
79
       meta.js
56
80
57
81
    meta.js contains something similar to user_data.  cloud-init ignores it.
58
82
    cloud-init ignores the 'interfaces' style file here.
59
83
    In this mode, cloud-init has networking code disabled.  It relies
60
84
    on the provisioning boot to have configured networking.
61
85
62
86
 F. template, post-provisioning boot without user-data.
63
87
    With ds-identify, cloud-init will be fully disabled.
64
88
    Without ds-identify, cloud-init None datasource will be used.
65
89
66
90
    There is no information available to identify this scenario.
67
91
68
92
    The user will be able to ssh in as as root with their public keys that
69
93
    have been installed into /root/ssh/.authorized_keys
70
94
    during the provisioning stage.
71
95
72
33
TODO:
96
TODO:
73
34
 * is uuid (/sys/hypervisor/uuid) stable for life of an instance?
97
 * is uuid (/sys/hypervisor/uuid) stable for life of an instance?
74
35
   it seems it is not the same as data's uuid in the os_code case
98
   it seems it is not the same as data's uuid in the os_code case
75
36
   but is in the template case.
99
   but is in the template case.
76
37
77
38
"""
100
"""
78
39
import base64
101
import base64
79
40
import json
102
import json
Status:	Merged
Approved by:	Scott Moser on 2018-04-25
Approved revision:	6ab0f10fade0f5e6e830245bfe60600c84e532d8
Merge reported by:	Scott Moser
Merged at revision:	b73559e2f98025e08fdb42544bb1d2e0f92a7a8d
Proposed branch:	~smoser/cloud-init:doc/softlayer-improve-doc-in-datasource
Merge into:	cloud-init:master
Diff against target:	79 lines (+63/-1) 1 file modified cloudinit/sources/DataSourceIBMCloud.py (+63/-1)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Server Team CI bot	continuous-integration		Approve on 2018-04-25
Chad Smith		2018-04-25	Approve on 2018-04-25
Philip Roche (community)		2018-04-25	Approve on 2018-04-25
Review via email: mp+344255@code.launchpad.net