3
�~�f�R � @ s
U d Z ddlZddlZddlZddlmZ ddlmZmZm Z m
Z
m Z ddl m
Z
ddlmZ ddlmZmZ ddlmZ eje�ZeZd Zd
Zd d d
ddddddddddddddd d d d d d!d"d#d$d%d&g Zd'd(d)gd)d*dd+�d,ed-gd-d.dd+�d/ed/gd/d.dd+�d,d0g d,d1dd+�d2d3g d4d5dd+�d6�Z d7d'd8�d g d,d9�d:�d)d'd7d;�id)d<d7iid d,d.d=�d>d)gd'd*d?�d@dAdBgdBdCdD�dE�dFd'idGdHdI�dJ�dBi idFd'id d,d8�dKd2idL�dFd'id d,d8�dKdGidL�dFd'id,d d;�dGdHdI�dL�dFd,idFd'idM�dFd'id d,d8�dKdGidL�d)d<d7iidN� Z xdhD ]Z e d e e < �q W xdiD ]Z e d e e < �q<W xdjD ]Z e d# e e < �qXW dOdPdQedR�eedS�edT�ged-gdU�Z e ee �Z e dKd<dVdFg�Z!dWdX� Z"dYdZ� Z#dkd[d\�Z$dld]d^�Z%d_d`� Z&dmdadb�Z'dcdd� Z(e)ee
e*dde�dfdg�Z+dS )nz NTP: enable and configure ntp� N)�dedent)�subp�
temp_utils� templater�
type_utils�util)�Cloud)�Config)�
MetaSchema� get_meta_doc)� PER_INSTANCEz
/etc/ntp.conf� � almalinux�alpine�centos�
cloudlinux�cos�debian� eurolinuxZfedora�freebsd�marinerZ miraclelinux�openbsdZ openeulerZ OpenCloudOS� openmandriva�opensuse�opensuse-microos�opensuse-tumbleweed�
opensuse-leap�photon�rhelZrocky�sle_hpc� sle-micro�slesZ TencentOS�ubuntuZ virtuozzoZchronydz/etc/chrony.conf�chronyzchrony.conf.{distro})� check_exe�confpath�packages� service_name�
template_name�template�ntpd�ntpzntp.conf.{distro}�ntpdatez/etc/ntpd.confzntpd.conf.{distro}z /lib/systemd/systemd-timesyncdz-/etc/systemd/timesyncd.conf.d/cloud-init.confzsystemd-timesyncdztimesyncd.conf)r# r+ r, �openntpdzsystemd-timesyncdz/etc/chrony/chrony.conf)r% r' )r% r& r' )r# r+ )r' r% r% )r% r' r( z/usr/local/etc/chrony.conf)r% r& r' r( z/usr/local/sbin/ntpdz/usr/local/etc/ntp.confr- zntpd.conf.openbsd)r$ r% r& r' r( )r+ r# r- r' z"/usr/lib/systemd/systemd-timesyncdz/etc/systemd/timesyncd.conf)r$ r% )r# zsystemd-timesyncdr$ )r# r+ zsystemd-timesyncd)r+ r# ) r r r r r r r r r r r! r" Zcc_ntpZNTPzenable and configure ntpaD Handle ntp configuration. If ntp is not installed on the system and
ntp configuration is specified, ntp will be installed. If there is a
default ntp config file in the image or one is present in the
distro's ntp package, it will be copied to a file with ``.dist``
appended to the filename before any changes are made. A list of ntp
pools and ntp servers can be provided under the ``ntp`` config key.
If no ntp ``servers`` or ``pools`` are provided, 4 pools will be used
in the format ``{0-3}.{distro}.pool.ntp.org``.z� # Override ntp with chrony configuration on Ubuntu
ntp:
enabled: true
ntp_client: chrony # Uses cloud-init default chrony configuration
aY # Provide a custom ntp client configuration
ntp:
enabled: true
ntp_client: myntpclient
config:
confpath: /etc/myntpclient/myntpclient.conf
check_exe: myntpclientd
packages:
- myntpclient
service_name: myntpclient
template: |
## template:jinja
# My NTP Client config
{% if pools -%}# pools{% endif %}
{% for pool in pools -%}
pool {{pool}} iburst
{% endfor %}
{%- if servers %}# servers
{% endif %}
{% for server in servers -%}
server {{server}} iburst
{% endfor %}
{% if peers -%}# peers{% endif %}
{% for peer in peers -%}
peer {{peer}}
{% endfor %}
{% if allow -%}# allow{% endif %}
{% for cidr in allow -%}
allow {{cidr}}
{% endfor %}
pools: [0.int.pool.ntp.org, 1.int.pool.ntp.org, ntp.myorg.org]
servers:
- ntp.server.local
- ntp.ubuntu.com
- 192.168.23.2
allow:
- 192.168.23.0/32
peers:
- km001
- km002)�id�name�title� description�distrosZexamples� frequencyZactivate_by_schema_keysr& c C s0 t }tjt�}| |kr,tj||| gdd�}|S )z�Construct a distro-specific ntp client config dictionary by merging
distro specific changes into base config.
@param distro: String providing the distro class name.
@returns: Dict of distro configurations for ntp clients.
T)�reverse)�DISTRO_CLIENT_CONFIG�copy�NTP_CLIENT_CONFIGr �
mergemanydict)�distroZdcfg�cfg� r; � /usr/lib/python3.6/cc_ntp.py�distro_ntp_client_configs7 s
r= c C s� t |j�}| r.| dkr.tjd| � |j| i �S |jdd�}i }|dkr�x:|jD ]0}|j|�}tj|jd��rNtjd|� |}P qNW |s�|jd }tjd|� |j|�}ntjd|� |j|i �}|S ) a
Determine which ntp client is to be used, consulting the distro
for its preference.
@param ntp_client: String name of the ntp client to use.
@param distro: Distro class instance.
@returns: Dict of the selected ntp client or {} if none selected.
�autoz4Selected NTP client "%s" via user-data configuration�
ntp_clientr$ z+Selected NTP client "%s", already installedr z<Selected distro preferred NTP client "%s", not yet installedz1Selected NTP client "%s" via distro system config) r= r/ �LOG�debug�getZ
get_optionZpreferred_ntp_clientsr �which)r? r9 Z
distro_cfgZdistro_ntp_clientZ clientcfgZclientr: r; r; r< �select_ntp_clientE s4
rD c C s( t j|�rdS |dkr dg}| |� dS )ah Install ntp client package if not already installed.
@param install_func: function. This parameter is invoked with the contents
of the packages parameter.
@param packages: list. This parameter defaults to ['ntp'].
@param check_exe: string. The name of a binary that indicates the package
the specified package is already installed.
Nr+ )r rC )Z install_funcr& r$ r; r; r< �install_ntp_clientw s
rE c C s t jj| �r tj| | d � dS )z�Rename any existing ntp client config file
@param confpath: string. Specify a path to an existing ntp client
configuration file.
z.distN)�os�path�existsr �rename)r% r; r; r< �rename_ntp_conf� s rJ c C sn g }| }| dkrd}n| dks&| dkr*d}x>t dt�D ]0}|jdjdd � t|�g|g d
g D ��� q6W |S ) z�Generate a list of server names to populate an ntp client configuration
file.
@param distro: string. Specify the distro name
@returns: list: A list of strings representing ntp servers for this distro.
r! r r r � r �.c S s g | ] }|r|�qS r; r; )�.0�nr; r; r< �
<listcomp>� s z)generate_server_names.<locals>.<listcomp>z pool.ntp.org)�range�NR_POOL_SERVERS�append�join�str)r9 �namesZ pool_distro�xr; r; r< �generate_server_names� s (rW c C s( |sg }|sg }|sg }|s g }t |�dkrDt |�dkrD| dkrDdS t |�dkr|| dkr||dkr|t| �}tjddj|�� n2t |�dkr�t |�dkr�t| �}tjddj|�� |s�td ��| r�| r�td
��||||d �} |�rtjd d
d�}
|
d }tj ||d� t
j ||| � |�r$tj |� dS )a� Render a ntp client configuration for the specified client.
@param distro_name: string. The distro class name.
@param service_name: string. The name of the NTP client service.
@param servers: A list of strings specifying ntp servers. Defaults to empty
list.
@param pools: A list of strings specifying ntp pools. Defaults to empty
list.
@param allow: A list of strings specifying a network/CIDR. Defaults to
empty list.
@param peers: A list nodes that should peer with each other. Defaults to
empty list.
@param path: A string to specify where to write the rendered template.
@param template_fn: A string to specify the template source file.
@param template: A string specifying the contents of the template. This
content will be written to a temporary file before being used to render
the configuration file.
@raises: ValueError when path is None.
@raises: ValueError when template_fn is None and template is None.
r r Nr r* z%Adding distro default ntp servers: %s�,z*Adding distro default ntp pool servers: %sz Invalid value for path parameterz$Not template_fn or template provided)�servers�pools�allow�peersztemplate_name-z.tmpl)�prefix�suffix� )Zcontent)
�lenrW r@ rA rS �
ValueErrorr Zmkstempr Z
write_filer Zrender_to_fileZdel_file) Z distro_namer' rY rZ r[ r\ rG � template_fnr) ZparamsZtfiler; r; r< �write_ntp_config_template� sD rc c C sL g }t jt| j� ��}|r<djt|��}|jdj|d�� n"t| j d�| j d�g�s^|jd� x�t| j
� �D ]�\}}d| }|dkr�t |t |t
�g�s�|jd j||d
�� ql|d kr�t |t�s�|jd j||d
�� ql|dk�r
|d
kr�qlt |t
��s(|jdj||d
�� qlt |t
�sl|jdj||d
�� qlW |�rHtdjdj|�d���d
S )aO Validate user-provided ntp:config option values.
This function supplements flexible jsonschema validation with specific
value checks to aid in triage of invalid user-provided configuration.
@param ntp_config: Dictionary of configuration value under 'ntp'.
@raises: ValueError describing invalid values provided.
z, z(Missing required ntp:config keys: {keys})�keysr) r( zJEither ntp:config:template or ntp:config:template_name values are requiredz ntp:config:r% z6Expected a config file path {keypath}. Found ({value}))�keypath�valuer& zHExpected a list of required package names for {keypath}. Found ({value})Nz5Expected a string type for {keypath}. Found ({value})z$Invalid ntp configuration:\n{errors}�
)�errors)r) r( )�REQUIRED_NTP_CONFIG_KEYS�
difference�setrd rS �sortedrR �format�anyrB �items�all�
isinstancerT �listra )Z
ntp_configrh Zmissingrd �keyrf re r; r; r< � supplemental_schema_validation sJ
rt )r/ r: �cloud�args�returnc . C s� d|krt jd| � dS |d }|dkr,i }t|t�sLtdjtj|�d���|jdd�}t j
|�rrt jd| � dS t |jd �|j �}t j
||jd
i �gdd �}t|� t|jd �d
� d}|jd��s|jd�jd|j j�}|j|�}|�sd|jd� } t| ��t jd|jd�� t jd|jdg �� t jd|jdg �� t jd|jdg �� t jd|jdg �� t|j j|jd�|jdg �|jdg �|jdg �|jdg �|jd �||jd�d � t|j j|d |d d � t j� �r�|jd�d k�rTy|j jd!d � W n" tjk
�r t jd"� Y nX y|j jd#d � W n" tjk
�rR t jd$� Y nX y|j jd%|jd�� W n4 tjk
�r� }
zt jd&|
� � W Y dd}
~
X nX y|j jd'|jd�� W n4 tjk
�r� }
zt jd(|
� � W Y dd}
~
X nX dS ))zEnable and configure ntp.r+ z8Skipping module named %s, not present or disabled by cfgNzL'ntp' key existed in config, but not a dictionary type, is a {_type} instead)Z_type�enabledTz)Skipping module named %s, disabled by cfgr? �config)r4 r% )r% r) r( z{distro}z#No template found, not rendering %szservice_name: %sr' z servers: %srY z pools: %srZ z allow: %sr[ z peers: %sr\ )r' rY rZ r[ r\ rG rb r) r& r$ )r& r$ r* �stopz Failed to stop base ntpd service�disablez#Failed to disable base ntpd service�enablez Failed to enable ntp service: %s�reloadz&Failed to reload/start ntp service: %s) r@ rA rq �dict� RuntimeErrorrm r Zobj_namerB r Zis_falserD r9 r8 rt rJ �replacer/ Zget_template_filenamerc rE Zinstall_packagesZis_BSDZmanage_servicer ZProcessExecutionErrorZwarningZ exception) r/ r: ru rv Zntp_cfgrx Zntp_client_configrb r( �msg�er; r; r< �handle= s�
r� )r r r )r r r )r r )Nr* )N)NNNNNNNN),�__doc__r6 ZloggingrF �textwrapr Z cloudinitr r r r r Zcloudinit.cloudr Zcloudinit.configr Zcloudinit.config.schemar
r Zcloudinit.settingsr Z getLogger�__name__r@ r3 ZNTP_CONFrQ r2 r7 r5 r9 �meta� frozensetri r= rD rE rJ rW rc rt rT rr r� r; r; r; r< �<module> s2
)2
H=