3
\�me�N � @ sz U d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z ddl
mZ ddlmZ ddlmZmZ dd lmZ d
Zed �Zd gZd
ddeeeed�geg d�Zeee�Z dZeje�Z dZ eje �Z ejde �Z dZ dZ!d0Z"d1Z#ej$e%�Z&dd� Z'd d � Z(d d � Z)d2d d!�Z*d3d"d#�Z+d4d$d%�Z,e-e-dd&�d'd(�Z.d5d)d*�Z/d+d,� Z0e-eee1dd-�d.d/�Z2dS )6z-Mounts: Configure mount points and swap files� N)�
whitespace)�dedent)�subp�
type_utils�util)�Cloud)�Config)�
MetaSchema� get_meta_doc)� PER_INSTANCEa� This module can add or remove mountpoints from ``/etc/fstab`` as well as
configure swap. The ``mounts`` config key takes a list of fstab entries to add.
Each entry is specified as a list of ``[ fs_spec, fs_file, fs_vfstype,
fs_mntops, fs-freq, fs_passno ]``. For more information on these options,
consult the manual for ``/etc/fstab``. When specifying the ``fs_spec``, if the
device name starts with one of ``xvd``, ``sd``, ``hd``, or ``vd``, the leading
``/dev`` may be omitted.
Any mounts that do not appear to either an attached block device or network
resource will be skipped with a log like "Ignoring nonexistent mount ...".
Cloud-init will attempt to add the following mount directives if available and
unconfigured in `/etc/fstab`::
mounts:
- ["ephemeral0", "/mnt", "auto","defaults,nofail,x-systemd.requires=cloud-init.service", "0", "2"]
- ["swap", "none", "swap", "sw", "0", "0"]
In order to remove a previously listed mount, an entry can be added to
the `mounts` list containing ``fs_spec`` for the device to be removed but no
mountpoint (i.e. ``[ swap ]`` or ``[ swap, null ]``).
The ``mount_default_fields`` config key allows default values to be specified
for the fields in a ``mounts`` entry that are not specified, aside from the
``fs_spec`` and the ``fs_file`` fields. If specified, this must be a list
containing 6 values. It defaults to::
mount_default_fields: [none, none, "auto","defaults,nofail,x-systemd.requires=cloud-init.service", "0", "2"]
Non-systemd init systems will vary in ``mount_default_fields``.
Swap files can be configured by setting the path to the swap file to create
with ``filename``, the size of the swap file with ``size`` maximum size of
the swap file if using an ``size: auto`` with ``maxsize``. By default no
swap file is created.
.. note::
If multiple mounts are specified where a subsequent mount's mountpoint is
inside of a previously declared mount's mountpoint (i.e. the 1st mount has
a mountpoint of ``/abc`` and the 2nd mount has a mountpoint of
``/abc/def``) then this will not work as expected - ``cc_mounts`` first
creates the directories for all the mountpoints **before** it starts to
perform any mounts and so the sub-mountpoint directory will not be created
correctly inside the parent mountpoint.
For systems using util-linux's ``mount`` program this issue can be
worked around by specifying ``X-mount.mkdir`` as part of a ``fs_mntops``
value for the subsequent mount entry.
a< # Mount ephemeral0 with "noexec" flag, /dev/sdc with mount_default_fields,
# and /dev/xvdh with custom fs_passno "0" to avoid fsck on the mount.
# Also provide an automatically sized swap with a max size of 10485760
# bytes.
mounts:
- [ /dev/ephemeral0, /mnt, auto, "defaults,noexec" ]
- [ sdc, /opt/data ]
- [ xvdh, /opt/data, auto, "defaults,nofail", "0", "0" ]
mount_default_fields: [None, None, auto, "defaults,nofail", "0", "2"]
swap:
filename: /my/swapfile
size: auto
maxsize: 10485760
�allZ cc_mountsZMountsz%Configure mount points and swap filesz� # Create a 2 GB swap file at /swapfile using human-readable values
swap:
filename: /swapfile
size: 2G
maxsize: 2G
)�id�name�title� description�distrosZexamplesZ frequencyZactivate_by_schema_keysz&^([x]{0,1}[shv]d[a-z][0-9]*|sr[0-9]+)$z^.+:.*z[%s]+z
/etc/fstabzcomment=cloudconfig� � � c C s: | d
kr dS x(d D ] }| j |�r| jd�d krdS qW d S )
N�ami�root�swapT� ephemeral�ebs�:� F)r r r )r r ���)�
startswith�find)r Zenumname� r � /usr/lib/python3.6/cc_mounts.py�is_meta_device_name� s
r! c C s t j| �rdS dS )NTF)�NETWORK_NAME_RE�match)r r r r �is_network_device� s
r$ c C sH t |�d|f d|f g}x(|D ] }d| |f }tjj|�r |S q W d S )Nzp%sz-part%sz%s%s)�str�os�path�exists)� device_path�partition_numberZpotential_suffixes�suffixZpotential_partition_devicer r r � _get_nth_partition_for_device� s
r, c C sX t jj| �jd�d }t jjd|�}|d k rLt jj|t jj|�jd�d �}t jj|�S )N�/r z /sys/block/r r )r& r' �realpath�split�joinr( )r) �partition_pathZ device_nameZsys_pathr r r �_is_block_device� s r2 c C s
t jd| � | }|dkr&d}t jd� t| �r2| S tj|�\}}|}|rj|j||�}||krjt jd||� t|�r�||�}|s�d S |jd�s�d|f }t jd||� ntj | �r�d|f }d }|d kr�t
|d �}nt
||�}|d kr�d S t ||��r|d k �r|S |S d S )
Nz+Attempting to determine the real name of %sr �
ephemeral0z2Adjusted mount option from ephemeral to ephemeral0z Mapped device alias %s to %sr- z/dev/%sz Mapped metadata name %s to %sr ) �LOG�debugr$ r Zexpand_dotted_devname�getr! r �DEVICE_NAME_REr# r, r2 )Z startnameZ transformer�aliasesZdevnamer) r* Zorigr1 r r r �sanitize_devname� sD
r9 c C sh | d krt j� d } | d }d|| d�}|d kr>|d kr>|}nd|r�tj|�}|j|j }||d< |d kr|tt|d �|�}q�||d kr�t|d �}n |d kr�|}||d< | dt k r�| }n,| d t k r�dt }nt t
j | t ��t }t||�}||d
< i } x<|j � D ]0\}
} t
| t��r.d | t | |
< n| | |
< �qW tjd | d
| d
| d | d | d � |S )N�totalr Zna)�avail�max_in�memr; � g�������?�max� �sizez%s MBzCsuggest %s swap for %s memory with '%s' disk given max=%s [max=%s]'r= r< )r � read_meminfor& �statvfs�f_frsize�f_bfree�min�int�GB�round�mathZsqrt�items�
isinstance�MBr4 r5 ) �memsize�maxsize�fsysZsugg_max�inforC r; ZminsizerA Zpinfo�k�vr r r �suggested_swapsize� sJ
rT )�fnamerA �returnc s d� � �fdd�}t jj| �}tj|� tj|�d ��dkr`tjddd| g� tjd d
| g� �d kr�tj� dk r�|| |d� n>y|| |d� W n, tjk
r� t j
d� || |d� Y nX t jj | �r�tj | d� ytjd| g� W n$ tjk
�r tj
| � � Y nX dS )zSize is in MiB.z6Failed to create swapfile '%s' of size %sMB via %s: %sc s� t jd| �|� |dkr*ddd| | g}n |dkrHddd| dd | g}ytj|d
d � W nB tjk
r� } z$t j� | |||� tj| � � W Y d d }~X nX d S ) Nz3Creating swapfile in '%s' on fstype '%s' using '%s'� fallocatez-lz%sM�ddz if=/dev/zerozof=%szbs=1Mzcount=%sT)Zcapture)r4 r5 r �ProcessExecutionErrorrQ r �del_file)rU rA �method�cmd�e)�errmsg�fstyper r � create_swap! s&
z$create_swapfile.<locals>.create_swapr Zbtrfs�truncatez-s�0Zchattrz+CZxfsr> � rX rW z4fallocate swap creation failed, will attempt with ddi� ZmkswapN)r> rc )r& r' �dirnamer �
ensure_dirZget_mount_infor Zkernel_versionrY r4 rQ r( �chmodrZ )rU rA r` �swap_dirr )r^ r_ r �create_swapfile s,
rh c C s� t jj| �}t|�j� dkrdytj� d }W n tk
rJ tj d� dS X tj
|� t |||d�}tt |d ��}|s�tj d� dS tj
tj d t| |gd
� | S ) z�
fname: full path string of filename to setup
size: the size to create. set to "auto" for recommended
maxsize: the maximum size
�autor: z)Not creating swap: failed to read meminfoN)rP rO rN r r z'Not creating swap: suggested size was 0zSetting up swap file)�msg�func�argsi )r& r' rd r% �lowerr rB �IOErrorr4 r5 re rT rG Zlog_timerh )rU rA rO rg rN Zmibsizer r r �setup_swapfileV s(
ro c C sZ t | t�stjd� dS | jdd�}| jdd�}| jdd�}|oB|sRtjd� dS tjj|�r�tjjd �sztjd
|� |S yFx4t j
d �j � D ]"}|j |d �r�tjd |� |S q�W tjd
|� W n t
k
r� tjd|� |S X yBt |t�o�|dk�rt j|�}t |t��rt j|�}t|||d�S t
k
�rT } ztjd|� W Y dd}~X nX dS )zahandle the swap config, calling setup_swap if necessary.
return None or (filename, size)
z%input for swap config was not a dict.N�filenamez /swap.imgrA r rO zno need to setup swapz /proc/swapsz:swap file %s exists, but no /proc/swaps exists, being safe� zswap file %s already in usez+swap file %s exists, but not in /proc/swapsz.swap file %s exists. Error reading /proc/swapsri )rU rA rO zfailed to setup swap: %s)rL �dictr4 �warningr6 r5 r& r' r( r � load_file�
splitlinesr � Exceptionr% Z human2bytesro )ZswapcfgrU rA rO �liner] r r r �handle_swapcfgx sD
rx )r �cfg�cloudrl rV c $
sX d}|j j� }|rd}d d d|ddg}|jd|�}ddd|d ddgd
d d
d ddgg}g }d
|krj|d
}tjd|� g } i }
g } tjjt�r�xdt j
t�j � D ]R} t | kr�| j
| � q�ytj| �}
W n tk
r� Y nX | |
|
d < | j
| � q�W |jdi �}�xtt|��D �]}t|| t��sFtjd|d tj|| �� �qt|| d �}t||j|d�}||k�r~tjd||� |d k�r�tjd|� �qn ||
k�r�tjd||
| � �q||| d< xJtt|| ��D ]6}|| | d k�r�q�nt|| | �|| |< �q�W �qW x�tt|��D ]�}x^tt|��D ]N}t|| �|k�rb|| j
|| � n"|| | d k�r8|| || |< �q8W || d d k�r&x8t|�D ],}|| d || d k�r�d || d< �q�W �q&W x�|D ]�}|d }t||j|d�}||k�rtjd||� |d k�r2tjd|� �q�n ||
k�rRtjd||
| � �q�||d< d}x&|D ] }|d |d k�rdd}P �qdW |�r�tjd|� �q�|j
|� �q�W g }x8|D ]0}|d d k�r�tjd |d � n
|j
|� �q�W t |jd
i ��}|�r|j
|d d
d ddg� t|�dk�r2tjd � d S g }d}d}g } xb|D ]Z} d | d t f | d < | d d
k�rrd}| d j d ��r�| j
| d � |j
d!j | �� �qHW d"d#� t j � j � D �} xX| D ]P} yt j!| � W n$ tk
�r� t j"td$| � Y nX | �r�| | k�r�d}�q�W d%d#� |D �� d&d#� | D ��� fd'd#��D ��fd(d#�� D � } | j#|� d)d*j | � } t j$t| � g }!|�r�|!j
d+d,g� t| �dk�r�tjd-� ntjd.| � d}|�r�|!j
d/d,g� |�r�|!j
d0d1g� d2}"xj|!D ]b}#d3d4j |#� }"yt%j%|#� tj|"d5� W n2 t%j&k
�rL tj|"d6� t j"t|"d6� Y nX �q�W d S )7Nzdefaults,nobootwaitz=defaults,nofail,x-systemd.requires=cloud-init.service,_netdevri rb �2Zmount_default_fieldsr3 z/mnt� r Znone�sw�mountszmounts configuration is %sr �device_aliasesz,Mount option %s not a list, got a %s insteadr )r8 zchanged %s => %sz#Ignoring nonexistent named mount %sz&Device %s already defined in fstab: %sz changed default device %s => %sz+Ignoring nonexistent default named mount %sFTz-Not including %s, already previously includedz$Skipping nonexistent device named %sz No modifications to fstab neededz%s,%sr r- � c S s g | ]\}}d |kr|d �qS )Z
mountpointr )�.0rR rS r r r �
<listcomp>J s zhandle.<locals>.<listcomp>z Failed to make '%s' config-mountc S s g | ]}t jd |��qS )rq )�WS�sub)r� �nr r r r� W s c S s g | ]}t jd |��qS )rq )r� r� )r� r� r r r r� X s c s g | ]}|� krd | �qS )z- r )r� Zdrop)�saddsr r r� Z s c s g | ]}|� krd | �qS )z+ r )r� �add)�sdropsr r r� [ s z%s
�
Zswaponz-az No changes to /etc/fstab made.zChanges to fstab: %sZmountZ systemctlz
daemon-reloadz#Activating swap and mounts with: %szActivate mounts: %s:rq ZPASSZFAIL)'Zdistro� uses_systemdr6 r4 r5 r& r' r( �
FSTAB_PATHr rt ru � MNT_COMMENT�appendr� r/ rv �range�lenrL �listrs r Zobj_namer% r9 Zdevice_name_to_devicerQ rx r r0 r~ rK re Zlogexc�extendZ
write_filer rY )$r ry rz rl Z def_mnt_optsr� ZdefvalsZdefmntsZcfgmntZ fstab_linesZ
fstab_devsZ
fstab_removedrw Ztoksr �i�startZ sanitized�jZdefmntZ
cfgmnt_hasZcfgmZactlist�xZswapretZcc_linesZneedswapZneed_mount_all�dirsZ mount_points�dZsops�contentsZ
activate_cmdsZfmtr\ r )r� r� r �handle� s"
$
r� i i @)N)N)NNN)NN)3�__doc__ZloggingrJ r& �re�stringr �textwrapr Z cloudinitr r r Zcloudinit.cloudr Zcloudinit.configr Zcloudinit.config.schemar r
Zcloudinit.settingsr ZMODULE_DESCRIPTIONZexampler �metaZDEVICE_NAME_FILTER�compiler7 ZNETWORK_NAME_FILTERr" r� r� r� rM rH Z getLogger�__name__r4 r! r$ r, r2 r9 rT r% rh ro rx r� r� r r r r �<module> s\ 5
1
9:
"0