3
\me@+ @ s d Z ddlZddlZddlZddlZddlmZ ddlmZm Z ddl
m Z ddl m
Z
mZmZ ddlmZ dZejeZdd d
Zd d Zed
ddZeeeedddZ dd Z dd Z edkre dS )aT Query standardized instance metadata provided to machine, returning a JSON
structure.
Some instance-data values may be binary on some platforms, such as userdata and
vendordata. Attempt to decompress and decode UTF-8 any binary values.
Any binary values in the instance metadata will be base64-encoded and prefixed
with "ci-b64:" in the output. userdata and, where applicable, vendordata may
be provided to the machine gzip-compressed (and therefore as binary data).
query will attempt to decompress these to a string before emitting the JSON
output; if this fails, they are treated as binary.
N)EACCES)
atomic_helperutil)read_cfg_paths)convert_jinja_instance_dataget_jinja_variable_aliasrender_jinja_payload)REDACT_SENSITIVE_VALUEZqueryc C s | st jttd} | jdddddd | jdd td
t jd d | jd
ddddd | jddtdd | jddtdd | jdtddd | jddddd d d | jd d td!d"d# | S )$a# Build or extend an arg parser for query 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.
)prog descriptionz-dz--debug
store_trueFz+Add verbose messages during template render)actiondefaulthelpz-iz--instance-dataz,Path to instance-data.json file. Default is
instance_data)typer z-lz --list-keyszBList query keys available at the provided instance-data .z-uz --user-datazHPath to user-data file. Default is /var/lib/cloud/instance/user-data.txtz-vz
--vendor-datazLPath to vendor-data file. Default is /var/lib/cloud/instance/vendor-data.txtvarname?zA dot-delimited specific variable to query from instance-data. For example: v1.local_hostname. If the value is not JSON serializable, it will be base64-encoded and will contain the prefix "ci-b64:". )r nargsr z-az--alldump_allz Dump all available instance-data)r
r destr z-fz--formatformatzOptionally specify a custom output format string. Any instance-data variable can be specified between double-curly braces. For example -f "{{ v2.cloud_name }}")r r r )argparseArgumentParserNAME__doc__ add_argumentstrr get_runpath)parser r /usr/lib/python3.6/query.py
get_parser% s` r" c C s> t j| dd}y
|jdS tk
r8 t j|dddS X dS )zAttempt to return a string of user-data from ud_file_path
Attempt to decode or decompress if needed.
If unable to decode the content, raw bytes will be returned.
@returns: String of uncompressed userdata if possible, otherwise bytes.
F)decodezutf-8T)quietr# N)r load_filer# UnicodeDecodeErrorZ decomp_gzip)Z ud_file_pathZbdatar r r!
load_userdata} s
r' )returnc C s t j }t }| r| }nF|jd}|dkrZ|jd}t jj|rF|}q^tjd|| |}n|}|rh|}nt jj|j d}|r|} nt jj|j d} |jd}
yt
j |} W nL t t
fk
r } z,| jtkrtjd| n tjd | W Y d
d
} ~ X nX t
j| } yt
jt
j |
}
W n t t
fk
r4 d
}
Y nX |dkrrd t|f | d < d t| f | d
< d t|
f | d< n t|| d < t| | d
< |
| d< | S )a Return a dict of merged instance-data, vendordata and userdata.
The dict will contain supplemental userdata and vendordata keys sourced
from default user-data and vendor-data files.
Non-root users will have redacted INSTANCE_JSON_FILE content and redacted
vendordata and userdata values.
:raise: IOError/OSError on absence of instance-data.json file or invalid
access perms.
r r Zinstance_data_sensitivez4Missing root-readable %s. Using redacted %s instead.z
user-data.txtzvendor-data.txtcombined_cloud_configz$No read permission on '%s'. Try sudoz Missing instance-data file: %sNz <%s> file:%sZuserdataZ
vendordata)osgetuidr r pathexistsLOGZwarningjoinZ
instance_linkr r% IOErrorOSErrorerrnor errorZ load_jsonr r' )r user_data vendor_dataZuidpathsZinstance_data_fnZredacted_data_fnZsensitive_data_fnZ user_data_fnZvendor_data_fnZcombined_cloud_config_fnZ
instance_jsoner) r r r! _read_instance_data sb
r8 )jinja_vars_without_aliasesjinja_vars_with_aliasesr list_keysc
C s d}| }x|j dD ]}y || }W nJ tk
rn } z.|rJdj||d}n
dj|}t||W Y dd}~X nX ||kr|| }n$x"|D ]} t| |kr|| }P qW |r|d7 }||7 }qW |S )a Return the value of the dot-delimited varname path in instance-data
Split a dot-delimited jinja variable name path into components, walk the
path components into the instance_data and look up a matching jinja
variable name or cloud-init's underscore-delimited key aliases.
:raises: ValueError when varname represents an invalid key name or path or
if list-keys is provided by varname isn't a dict object.
.z*instance-data '{key_path}' has no '{leaf}')ZleafZkey_pathz Undefined instance-data key '{}'N)splitKeyErrorr
ValueErrorr )
r9 r: r r; Zwalked_key_pathresponseZ
key_path_partr7 msgkeyr r r! (_find_instance_data_leaf_by_varname_path s*
rD c C sb t |j|j|j|jgs0tjd t j dS yt |j
|j |j }W n t
tfk
r^ dS X |jrdj|jd}t|d||jrdndd}|rt| d S dS t|}|jrt|dd
}yt|||j|jd }W n0 ttfk
r } ztj| dS d }~X nX |jr@t|ts.tjd
|j dS djt|j }t|tsVt j |}t| d S )z3Handle calls to 'cloud-init query' as a subcommand.zDExpected one of the options: --all, --format, --list-keys or varname z## template: jinja
{fmt})Zfmtzquery commandlineTF)payloadZ
payload_fnr debugr )Zinclude_key_aliases)r9 r: r r; Nz+--list-keys provided but '%s' is not a dict
) anyr; r r r r. r3 r" Z
print_helpr8 r r4 r5 r0 r1 r rG printr rD r? r@
isinstancedictr/ sortedkeysr r Z
json_dumps)nameargsr rF Zrendered_payloadrA r: r7 r r r! handle_args sX
rQ c C s t } tjtt| j dS )z,Tool to query specific instance-data values.N)r" sysexitrQ r
parse_args)r r r r! mainC s rU __main__)N) r r Zloggingr* rR r2 r Z cloudinitr r Zcloudinit.cmd.develr Z!cloudinit.handlers.jinja_templater r r Zcloudinit.sourcesr r Z getLogger__name__r. r" r' rL r8 r boolrD rQ rU r r r r! s,
XQ'<