3
\meN @ sz U d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z ddl
mZ ddlmZ ddlmZmZ dd lmZ d
Zed Zd gZd
ddeeeedgeg dZeeeZ dZejeZ 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_utilsutil)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
)idnametitle descriptiondistrosZexamplesZ 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| jdd krdS qW d S )
NamirootswapT ephemeralebs: F)r r r )r r )
startswithfind)r Zenumname r /usr/lib/python3.6/cc_mounts.pyis_meta_device_name s
r! c C s t j| rdS dS )NTF)NETWORK_NAME_REmatch)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)strospathexists) device_pathpartition_numberZpotential_suffixessuffixZpotential_partition_devicer r r _get_nth_partition_for_device s
r, c C sX t jj| jdd }t jjd|}|d k rLt jj|t jj|jdd }t jj|S )N/r z /sys/block/r r )r& r' realpathsplitjoinr( )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||}|sd S |jdsd|f }t jd|| ntj | rd|f }d }|d krt
|d }nt
||}|d krd 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 ) LOGdebugr$ r Zexpand_dotted_devnamegetr! r DEVICE_NAME_REr# r, r2 )Z startnameZ transformeraliasesZdevnamer) r* Zorigr1 r r r sanitize_devname sD
r9 c C sh | d krt j d } | d }d|| d}|d kr>|d kr>|}nd|rtj|}|j|j }||d< |d kr|tt|d |}q||d krt|d }n |d kr|}||d< | dt k r| }n,| d t k rdt }nt t
j | t t }t||}||d
< i } x<|j D ]0\}
} t
| tr.d | t | |
< n| | |
< qW tjd | d
| d
| d | d | d |S )Ntotalr Zna)availmax_inmemr; g?max sizez%s MBzCsuggest %s swap for %s memory with '%s' disk given max=%s [max=%s]'r= r< )r read_meminfor& statvfsf_frsizef_bfreeminintGBroundmathZsqrtitems
isinstanceMBr4 r5 ) memsizemaxsizefsysZsugg_maxinforC r; ZminsizerA Zpinfokvr r r suggested_swapsize sJ
rT )fnamerA returnc s d fdd}t jj| }tj| tj|d dkr`tjddd| g tjd d
| g d krtj dk r|| |d n>y|| |d W n, tjk
r t j
d || |d Y nX t jj | rtj | 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%sMddz if=/dev/zerozof=%szbs=1Mzcount=%sT)Zcapture)r4 r5 r ProcessExecutionErrorrQ r del_file)rU rA methodcmde)errmsgfstyper r create_swap! s&
z$create_swapfile..create_swapr Zbtrfstruncatez-s0Zchattrz+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 }|stj 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)msgfuncargsi )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 | tstjd dS | jdd}| jdd}| jdd}|oB|sRtjd dS tjj|rtjjd sztjd
| |S yFx4t j
d j D ]"}|j |d rtjd | |S qW tjd
| W n t
k
r tjd| |S X yBt |to|dkrt j|}t |trt j|}t|||dS 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.Nfilenamez /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 cfgcloudrl 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 } tjjtrxdt j
tj D ]R} t | kr| j
| qytj| }
W n tk
r Y nX | |
|
d < | j
| qW |jdi }xtt|D ]}t|| tsFtjd|d tj|| qt|| d }t||j|d}||kr~tjd|| |d krtjd| qn ||
krtjd||
| q||| d< xJtt|| D ]6}|| | d krqnt|| | || |< qW qW xtt|D ]}x^tt|D ]N}t|| |krb|| j
|| n"|| | d kr8|| || |< q8W || d d kr&x8t|D ],}|| d || d krd || d< qW q&W x|D ]}|d }t||j|d}||krtjd|| |d kr2tjd| qn ||
krRtjd||
| q||d< d}x&|D ] }|d |d krdd}P qdW |rtjd| q|j
| qW g }x8|D ]0}|d d krtjd |d n
|j
| qW t |jd
i }|r|j
|d d
d ddg t|dkr2tjd d S g }d}d}g } xb|D ]Z} d | d t f | d < | d d
krrd}| 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| | krd}qW 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| dkrtjd- 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 qW d S )7Nzdefaults,nobootwaitz=defaults,nofail,x-systemd.requires=cloud-init.service,_netdevri rb 2Zmount_default_fieldsr3 z/mnt r Znoneswmountszmounts 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
J s zhandle..z Failed to make '%s' config-mountc S s g | ]}t jd |qS )rq )WSsub)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_COMMENTappendr r/ rv rangelenrL listrs r Zobj_namer% r9 Zdevice_name_to_devicerQ rx r r0 r~ rK re ZlogexcextendZ
write_filer rY )$r ry rz rl Z def_mnt_optsr ZdefvalsZdefmntsZcfgmntZ fstab_linesZ
fstab_devsZ
fstab_removedrw Ztoksr istartZ sanitizedjZdefmntZ
cfgmnt_hasZcfgmZactlistxZswapretZcc_linesZneedswapZneed_mount_alldirsZ mount_pointsdZsopscontentsZ
activate_cmdsZfmtr\ r )r r r handle s"
$
r i i @)N)N)NNN)NN)3__doc__ZloggingrJ r& restringr textwrapr Z cloudinitr r r Zcloudinit.cloudr Zcloudinit.configr Zcloudinit.config.schemar r
Zcloudinit.settingsr ZMODULE_DESCRIPTIONZexampler metaZDEVICE_NAME_FILTERcompiler7 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 s\ 5
1
9:
"0