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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
#!/usr/bin/env python3
# This file is part of cloud-init. See LICENSE file for license information.
"""Commandline utility to list the canonical cloud-id for an instance."""
import argparse
import json
import sys
from cloudinit.cmd.status import UXAppStatus, get_status_details
from cloudinit.sources import (
INSTANCE_JSON_FILE,
METADATA_UNKNOWN,
canonical_cloud_id,
)
from cloudinit.util import error
DEFAULT_INSTANCE_JSON = "/run/cloud-init/%s" % INSTANCE_JSON_FILE
NAME = "cloud-id"
def get_parser(parser=None):
"""Build or extend an arg parser for the cloud-id utility.
@param parser: Optional existing ArgumentParser instance representing the
query subcommand which will be extended to support the args of
this utility.
@returns: ArgumentParser with proper argument configuration.
"""
if not parser:
parser = argparse.ArgumentParser(
prog=NAME,
description="Report the canonical cloud-id for this instance",
)
parser.add_argument(
"-j",
"--json",
action="store_true",
default=False,
help="Report all standardized cloud-id information as json.",
)
parser.add_argument(
"-l",
"--long",
action="store_true",
default=False,
help="Report extended cloud-id information as tab-delimited string.",
)
parser.add_argument(
"-i",
"--instance-data",
type=str,
default=DEFAULT_INSTANCE_JSON,
help="Path to instance-data.json file. Default is %s"
% DEFAULT_INSTANCE_JSON,
)
return parser
def handle_args(name, args):
"""Handle calls to 'cloud-id' cli.
Print the canonical cloud-id on which the instance is running.
@return: 0 on success, 1 on error, 2 on disabled, 3 on cloud-init not run.
"""
status, _status_details, _time = get_status_details()
if status == UXAppStatus.DISABLED:
sys.stdout.write("{0}\n".format(status.value))
return 2
elif status == UXAppStatus.NOT_RUN:
sys.stdout.write("{0}\n".format(status.value))
return 3
try:
with open(args.instance_data) as file:
instance_data = json.load(file)
except IOError:
return error(
"File not found '%s'. Provide a path to instance data json file"
" using --instance-data" % args.instance_data
)
except ValueError as e:
return error(
"File '%s' is not valid json. %s" % (args.instance_data, e)
)
v1 = instance_data.get("v1", {})
cloud_id = canonical_cloud_id(
v1.get("cloud_name", METADATA_UNKNOWN),
v1.get("region", METADATA_UNKNOWN),
v1.get("platform", METADATA_UNKNOWN),
)
if args.json:
v1["cloud_id"] = cloud_id
response = json.dumps( # Pretty, sorted json
v1, indent=1, sort_keys=True, separators=(",", ": ")
)
elif args.long:
response = "%s\t%s" % (cloud_id, v1.get("region", METADATA_UNKNOWN))
else:
response = cloud_id
sys.stdout.write("%s\n" % response)
return 0
def main():
"""Tool to query specific instance-data values."""
parser = get_parser()
sys.exit(handle_args(NAME, parser.parse_args()))
if __name__ == "__main__":
main()
|
