3
\�me#8 � @ s d Z ddlZddlZddlZddlZddlmZmZmZm Z ddl
m Z ej e
�ZdZG dd� d�ZejejfZG dd � d ej�Zd
d � Zd d
� Zd dd�Zdd� Zdd� Zdd� Zeej ffgZ dd� Z e
dk�rddl Z e j d d �Z!e!j"� Z#e� Z$e%ej&e$�� dS ) a, Datasource for IBMCloud.
IBMCloud is also know as SoftLayer or BlueMix.
IBMCloud hypervisor is xen (2018-03-10).
There are 2 different api exposed launch methods.
* template: This is the legacy method of launching instances.
When booting from an image template, the system boots first into
a "provisioning" mode. There, host <-> guest mechanisms are utilized
to execute code in the guest and configure it. The configuration
includes configuring the system network and possibly installing
packages and other software stack.
After the provisioning is finished, the system reboots.
* os_code: Essentially "launch by OS Code" (Operating System Code).
This is a more modern approach. There is no specific "provisioning" boot.
Instead, cloud-init does all the customization. With or without
user-data provided, an OpenStack ConfigDrive like disk is attached.
Only disks with label 'config-2' and UUID '9796-932E' are considered.
This is to avoid this datasource claiming ConfigDrive. This does
mean that 1 in 8^16 (~4 billion) Xen ConfigDrive systems will be
incorrectly identified as IBMCloud.
The combination of these 2 launch methods and with or without user-data
creates 6 boot scenarios.
A. os_code with user-data
B. os_code without user-data
Cloud-init is fully operational in this mode.
There is a block device attached with label 'config-2'.
As it differs from OpenStack's config-2, we have to differentiate.
We do so by requiring the UUID on the filesystem to be "9796-932E".
This disk will have the following files. Specifically note, there
is no versioned path to the meta-data, only 'latest':
openstack/latest/meta_data.json
openstack/latest/network_data.json
openstack/latest/user_data [optional]
openstack/latest/vendor_data.json
vendor_data.json as of 2018-04 looks like this:
{"cloud-init":"#!/bin/bash
echo 'root:$6$<snip>' | chpasswd -e"}
The only difference between A and B in this mode is the presence
of user_data on the config disk.
C. template, provisioning boot with user-data
D. template, provisioning boot without user-data.
With ds-identify cloud-init is fully disabled in this mode.
Without ds-identify, cloud-init None datasource will be used.
This is currently identified by the presence of
/root/provisioningConfiguration.cfg . That file is placed into the
system before it is booted.
The difference between C and D is the presence of the METADATA disk
as described in E below. There is no METADATA disk attached unless
user-data is provided.
E. template, post-provisioning boot with user-data.
Cloud-init is fully operational in this mode.
This is identified by a block device with filesystem label "METADATA".
The looks similar to a version-1 OpenStack config drive. It will
have the following files:
openstack/latest/user_data
openstack/latest/meta_data.json
openstack/content/interfaces
meta.js
meta.js contains something similar to user_data. cloud-init ignores it.
cloud-init ignores the 'interfaces' style file here.
In this mode, cloud-init has networking code disabled. It relies
on the provisioning boot to have configured networking.
F. template, post-provisioning boot without user-data.
With ds-identify, cloud-init will be fully disabled.
Without ds-identify, cloud-init None datasource will be used.
There is no information available to identify this scenario.
The user will be able to SSH in as as root with their public keys that
have been installed into /root/ssh/.authorized_keys
during the provisioning stage.
TODO:
* is uuid (/sys/hypervisor/uuid) stable for life of an instance?
it seems it is not the same as data's uuid in the os_code case
but is in the template case.
� N)�
atomic_helper�sources�subp�util)� openstackz 9796-932Ec @ s e Zd ZdZdZdZdZdZdS )� PlatformszTemplate/Live/MetadatazUNABLE TO BE IDENTIFIED.z Template/Provisioning/Metadataz!Template/Provisioning/No-Metadataz OS-Code/LiveN)�__name__�
__module__� __qualname__�TEMPLATE_LIVE_METADATAZTEMPLATE_LIVE_NODATA� TEMPLATE_PROVISIONING_METADATA� TEMPLATE_PROVISIONING_NODATA�OS_CODE� r r �(/usr/lib/python3.6/DataSourceIBMCloud.pyr l s
r c sT e Zd ZdZdZ� fdd�Z� fdd�Zdd� Zd d
� Zd d � Z e
d
d� �Z � Z S )�DataSourceIBMCloudZIBMCloudNc s0 t t| �j|||� d | _d | _d | _d | _d S )N)�superr �__init__�source�_network_config� network_json�platform)�self�sys_cfgZdistro�paths)� __class__r r r s
zDataSourceIBMCloud.__init__c s$ t t| �j� }d|| j| jf }|S )Nz
%s [%s %s])r r �__str__r r )r �rootZmstr)r r r r � s zDataSourceIBMCloud.__str__c C s� t � }|d krdS |d | _|d | _|d | _|jd�| _|jd�| _|jd�}|| _|d | _yt j
|�| _ W n4 t k
r� } zt
jd |� d | _ W Y d d }~X nX d
S ) NFr r �metadata�userdata� networkdata�
vendordataz system-uuidz"Invalid content in vendor-data: %sT)�read_mdr r r �getZ userdata_rawr Zvendordata_pure� system_uuidr Zconvert_vendordataZvendordata_raw�
ValueError�LOG�warning)r �resultsZvd�er r r � _get_data� s"
z DataSourceIBMCloud._get_datac C s d| j | jf S )z/Return the subplatform metadata source details.z%s (%s))r r )r r r r �_get_subplatform� s z#DataSourceIBMCloud._get_subplatformc C s | j dkrdS | j t� kS )a quickly (local check only) if self.instance_id is still valid
in Template mode, the system uuid (/sys/hypervisor/uuid) is the
same as found in the METADATA disk. But that is not true in OS_CODE
mode. So we read the system_uuid and keep that for later compare.NF)r$ �_read_system_uuid)r r r r r �check_instance_id� s
z$DataSourceIBMCloud.check_instance_idc C sX | j tjkrddd�S | jd krR| jd k rHtjd� tj| jd d�| _n
tjd� | jS )NZdisabled� )�config�versionz(network config provided via network_json)Z
known_macsz#no network configuration available.) r r r r r r& �debugr Zconvert_net_json)r r r r �network_config� s
z!DataSourceIBMCloud.network_config)
r r r
Zdsnamer$ r r r* r+ r- �propertyr2 �
__classcell__r r )r r r z s
r c C s& d} t jj| �sd S tj| �j� j� S )Nz/sys/hypervisor/uuid)�os�path�isfiler � load_file�strip�lower)Z uuid_pathr r r r, � s r, c C s t jjd�S )Nz /proc/xen)r5 r6 �existsr r r r �_is_xen� s r< �#/root/provisioningConfiguration.cfg�/root/swinstall.log�/proc/1/environc C s� t jj| �r�d| }d}t jj|�rxt jj|�rbt j|�jt j|�jk}|d||rVdndf 7 }q�|d||f 7 }d}q�|d| 7 }ndd | }}tjd
||� |S ) z@Return boolean indicating if this boot is ibm provisioning boot.zconfig '%s' exists.Tz log '%s' from %s boot.ZcurrentZpreviousz. log '%s' existed, but no reference file '%s'.Fz log '%s' did not exist.zconfig '%s' did not exist.zibm_provisioning=%s: %s)r5 r6 r; �stat�st_mtimer& r1 )Zprov_cfgZinst_logZboot_ref�msg�resultr r r �_is_ibm_provisioning� s"
rD c C sZ d} d}d }t � s|S i }y tj� }W n. tjk
rT } ztjd|� d S d}~X nX x�t|j� �D ]�}|| }|j dd�j
� }|j dd�j
� } || |fkr�qd||kr�tjd||| |� qd||kr�| t kr�tj d ||| |� qd|||< qdW |j | i �j d
�}
|j |i �j d
�} | �r t
j| fS |
�rDt� �r8t
j|
fS t
j|
fS nt� �rVt
jdfS |S )
z�Return a tuple (Platform, path)
If this is Not IBM cloud, then the return value is (None, None).
An instance in provisioning mode is considered running on IBM cloud.ZMETADATAzCONFIG-2NzFailed to run blkid: %sZLABEL� ZUUIDz.Duplicate fslabel '%s'. existing=%s current=%sz/Skipping %s with LABEL=%s due to uuid != %s: %sZDEVNAME)NN)NN)r< r Zblkidr ZProcessExecutionErrorr& r' �sorted�keysr# �upper�IBM_CONFIG_UUIDr1 r r rD r r r
) Z label_mdataZ
label_cfg2Z not_foundZfslabelsZdevsr) Zdev�dataZlabel�uuidZ
metadata_pathZ cfg2_pathr r r �get_ibm_platform� sX
rL c C s� t � \} }| dkr tjd� dS | tkr8tjd| � dS | |t� d�}y&tjj|�r^t|�}n t j
|t�}W n8 t j k
r� } zt
d| ||f �|�W Y dd}~X nX |j|� |S )a Read data from IBM Cloud.
@return: None if not running on IBM Cloud.
dictionary with guaranteed fields: metadata, version
and optional fields: userdata, vendordata, networkdata.
Also includes the system uuid from /sys/hypervisor/uuid.Nz!This is not an IBMCloud platform.z/Cloud-init is disabled during provisioning: %s.)r r z system-uuidz8Failed reading IBM config disk (platform=%s path=%s): %s)rL r& r1 � PROVISIONINGr, r5 r6 �isdir�metadata_from_dirr Zmount_cbr �BrokenMetadata� RuntimeError�update)r r6 �retr( r) r r r r" & s*
r" c C s� dd� }dd� }d|d�|fd|d�d fd
|d �|fd |d
�|fg}i }x�|D ]�\}}}t jj| |�}d } ytj|dd�} W n0 tk
r� }
ztjd||
� W Y d d }
~
X nX | d ks�|d kr�| } nDy || �} W n6 tk
�r }
zt j
d||
f ��W Y d d }
~
X nX | ||< qNW |j d�d k�r2t j
d| ��i |d< |d } |d }
d| k�r�yt j
| d �|
d< W n6 ttfk
�r� }
zt j
d|
��W Y d d }
~
X nX d }x(|D ] \}}|| k�r�| | |
|< �q�W |S ) a� Walk source_dir extracting standardized metadata.
Certain metadata keys are renamed to present a standardized set of metadata
keys.
This function has a lot in common with ConfigDriveReader.read_v2 but
there are a number of inconsistencies, such key renames and as only
presenting a 'latest' version which make it an unlikely candidate to share
code.
@return: Dict containing translated metadata, userdata, vendordata,
networkdata as present.
c S s t jjdd| �S )Nr Zlatest)r5 r6 �join)Zfnamer r r �opathY s z metadata_from_dir.<locals>.opathc S s t j| jd��S )Nzutf-8)�json�loads�decode)Zblobr r r �load_json_bytes\ s z*metadata_from_dir.<locals>.load_json_bytesZ metadata_rawzmeta_data.jsonr Z user_dataNr! zvendor_data.jsonr znetwork_data.jsonF)rX z Failed reading path '%s': %szFailed decoding %s: %sz)%s missing required file 'meta_data.json'r Z random_seedz.Badly formatted metadata random_seed entry: %s� public_keys� public-keys�hostname�local-hostnamerK � instance-id�rZ r[ �r\ r] �rK r^ )r_ r` ra )r5 r6 rT r r8 �IOErrorr& r1 � Exceptionr rP r# �base64Z b64decoder% � TypeError)Z
source_dirrU rY �filesr( �namer6 ZtranslZfpath�rawr) rJ Zmd_rawZmd�renamesZmdnameZnewnamer r r rO J sR
rO c C s t j| t�S )N)r Zlist_from_depends� datasources)Zdependsr r r �get_datasource_list� s rk �__main__zQuery IBM Cloud Metadata)� description)r= r> r? )'�__doc__rd rV Zloggingr5 Z cloudinitr r r r Zcloudinit.sources.helpersr Z getLoggerr r& rI r r r
rM Z
DataSourcer r, r< rD rL r" rO ZDEP_FILESYSTEMrj rk �argparse�ArgumentParser�parser�
parse_args�argsrJ �printZ
json_dumpsr r r r �<module>^ s8
E
<$Q