summaryrefslogtreecommitdiff
path: root/doc/status.txt
blob: 609932160e04d2ae046d991b739d9ebb8978d419 (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
cloud-init will keep a 'status' file up to date for other applications
wishing to use it to determine cloud-init status.

It will manage 2 files:
 status.json
 result.json

The files will be written to /var/lib/cloud/data/ .
A symlink will be created in /run/cloud-init. The link from /run is to ensure
that if the file exists, it is not stale for this boot.

status.json's format is:
   {
    'v1': {
     'init': {
       errors: []      # list of strings for each error that occurred
       start: float # time.time() that this stage started or None
       end: float # time.time() that this stage finished or None
     },
     'init-local': {
       'errors': [], 'start': <float>, 'end' <float> # (same as 'init' above)
     },
     'modules-config': {
       'errors': [], 'start': <float>, 'end' <float> # (same as 'init' above)
     },
     'modules-final': {
       'errors': [], 'start': <float>, 'end' <float> # (same as 'init' above)
     },
     'datasource': string describing datasource found or None
     'stage': string representing stage that is currently running
              ('init', 'init-local', 'modules-final', 'modules-config', None)
              if None, then no stage is running.  Reader must read the start/end
              of each of the above stages to determine the state.
   }

result.json's format is:
   {
    'v1': {
     'datasource': string describing the datasource found
     'errors': [] # list of errors reported
    }
   }

Thus, to determine if cloud-init is finished:
 fin = "/run/cloud-init/result.json"
 if os.path.exists(fin):
   ret = json.load(open(fin, "r"))
   if len(ret['v1']['errors']):
     print "Finished with errors:" + "\n".join(ret['v1']['errors'])
   else:
     print "Finished no errors"
 else:
   print "Not Finished"