"·T`]Vã1@sdZddlZddlZddlmZddlmZddlmZddlm Z ddlm Z ddlm Z dd lm Z dd l mZmZdd lmZejeƒZeZd Zd ZddddddddgZdddddddgddddddid dd!dedd gdd dd"ddid#dd#dedd#gdd#dd"ddid$dd%dd&dgdd$dd'ddiiZdddd(ddid dd dgdd!iidddd(iidd dd!idddiiddddid dd dd!id$dd)iiddddid dd dd!id$dd)iidddd(iiiZd*d+d,d-d.d/d0ed1ƒd2ed3ed4ƒed5ƒgd6ed7d8d9d d7d8d:gd9d;d7d<d=d7d>d?d@idAdBd0edCƒidDd7d<d=d7d>d?d@idAdBd0edEƒidFd7d>dGdHd0edIƒidJd7dKdGdBd0edLƒidMd0edNƒd7d8gd9dd7d>d0edOƒidd7d>d0edPƒidd7d<d=d7d>idAdBd0edQƒidd7d>d0edRƒidd7d>d0edSƒiidTgdUdVdWdXiidTgdWdXiii ZeddddgƒZeeƒZdYdZ„Zd[d\„Zdd!d]d^„Z dd_d`„Z!dadb„Z"dddddddcdd„Z#dXdedf„Z$dgdh„Z%didj„Z&dS)kzNTP: enable and configure ntpéN)Údedent)Úlog)Ú temp_utils)Ú templater)Ú type_utils)Úsubp)Úutil)Úget_schema_docÚvalidate_cloudconfig_schema)Ú PER_INSTANCEz /etc/ntp.conféÚalpineZcentosZdebianZfedoraÚopensuseZrhelÚslesZubuntuZchronyÚ check_exeZchronydÚconfpathz/etc/chrony.confÚpackagesÚ service_nameÚ template_namezchrony.conf.{distro}ÚtemplateÚntpÚntpdzntp.conf.{distro}Zntpdatezsystemd-timesyncdz/lib/systemd/systemd-timesyncdz-/etc/systemd/timesyncd.conf.d/cloud-init.confztimesyncd.confz/etc/chrony/chrony.confz"/usr/lib/systemd/systemd-timesyncdÚidZcc_ntpÚnameZNTPÚtitlezenable and configure ntpZ descriptionaD 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``.ÚdistrosZexampleszµ # Override ntp with chrony configuration on Ubuntu ntp: enabled: true ntp_client: chrony # Uses cloud-init default chrony configuration a¼ # 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 %} 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Ú frequencyÚtypeÚobjectZ propertiesZnullÚpoolsZarrayÚitemsÚstringÚformatZhostnameZ uniqueItemsTa¨ List of ntp pools. If both pools and servers are empty, 4 default pool servers will be provided of the format ``{0-3}.{distro}.pool.ntp.org``. NOTE: for Alpine Linux when using the Busybox NTP client this setting will be ignored due to the limited functionality of Busybox's ntpd.ÚserverszÚ List of ntp servers. If both pools and servers are empty, 4 default pool servers will be provided with the format ``{0-3}.{distro}.pool.ntp.org``.Ú ntp_clientÚdefaultÚautoa¤ Name of an NTP client to use to configure system NTP. When unprovided or 'auto' the default client preferred by the distribution will be used. The following built-in client names can be used to override existing configuration defaults: chrony, ntp, ntpdate, systemd-timesyncd.ÚenabledZbooleanz¶ Attempt to enable ntp clients if set to True. If set to False, ntp client will not be configured or installedÚconfigzu Configuration settings or overrides for the ``ntp_client`` specified.z~ The path to where the ``ntp_client`` configuration is written.zÝ The executable name for the ``ntp_client``. For example, ntp service ``check_exe`` is 'ntpd' because it runs the ntpd binary.zˆ List of packages needed to be installed for the selected ``ntp_client``.z· The systemd or sysvinit service name used to start and stop the ``ntp_client`` service.aM Inline template allowing users to define their own ``ntp_client`` configuration template. The value must start with '## template:jinja' to enable use of templating support. ZrequiredZ minPropertieséZadditionalPropertiesFcCsDt}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. ÚreverseT)ÚDISTRO_CLIENT_CONFIGÚcopyÚNTP_CLIENT_CONFIGrÚ mergemanydict)ÚdistroZdcfgÚcfg©r1ú9/usr/lib/python3/dist-packages/cloudinit/config/cc_ntp.pyÚdistro_ntp_client_configs's  r3cCst|jƒ}|rA|dkrAtjd|ƒ|j|iƒS|jddƒ}i}|dkrìxO|jD]D}|j|ƒ}tj|jdƒƒrotjd|ƒ|}PqoW|s|jd}tjd|ƒ|j|ƒ}n"tjd|ƒ|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. r&z4Selected NTP client "%s" via user-data configurationr$rz+Selected NTP client "%s", already installedrzcCs‹g}|}|dkr!d}n|dkr3d}xQtdtƒD]@}|jdjdd„t|ƒg|gd gDƒƒƒqCW|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. rrr ÚrÚ.cSsg|]}|r|‘qSr1r1)Ú.0Únr1r1r2ú ’s z)generate_server_names..z pool.ntp.org)ÚrangeÚNR_POOL_SERVERSÚappendÚjoinÚstr)r/ÚnamesZ pool_distroÚxr1r1r2Úgenerate_server_names}s    2rKc CsV|s g}|sg}t|ƒdkrj|dkrj|dkrjt|ƒ}tjddj|ƒƒnIt|ƒdkr³t|ƒdkr³t|ƒ}tjddj|ƒƒ|sÅtdƒ‚| rß| rßtdƒ‚d |d |i}|r,tjd d d dƒ}|d}tj |d|ƒt j |||ƒ|rRtj |ƒ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 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. rr rz%Adding distro default ntp servers: %sú,z*Adding distro default ntp pool servers: %sz Invalid value for path parameterz$Not template_fn or template providedr#rÚprefixztemplate_name-Úsuffixz.tmplr)ZcontentN) ÚlenrKr4r5rGÚ ValueErrorrZmkstemprZ write_filerZrender_to_fileZdel_file) Z distro_namerr#rr;Ú template_fnrZparamsZtfiler1r1r2Úwrite_ntp_config_template—s2  $    rRcCs>|rdd|g}nd|dg}tj|ddƒdS)a%Restart or reload an ntp system service. @param service: A string specifying the name of the service to be affected. @param systemd: A boolean indicating if the distro uses systemd, defaults to False. @returns: A tuple of stdout, stderr results from executing the action. Z systemctlzreload-or-restartÚserviceZrestartZcaptureTN)r)rSÚsystemdÚcmdr1r1r2Ú reload_ntpÎsrVcCság}tjt|jƒƒƒ}|rXdjt|ƒƒ}|jdjd|ƒƒn1t|j dƒ|j dƒgƒs‰|jdƒx*t|j ƒƒD]\}}d|}|dkrût |t |t ƒgƒs²|jd jd |d |ƒƒqœ|d kr8t |tƒs²|jd jd |d |ƒƒqœ|dkr„|dkrSqœt |t ƒs²|jdjd |d |ƒƒqœt |t ƒsœ|jdjd |d |ƒƒqœW|rÝtdjddj|ƒƒƒ‚dS)aOValidate 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}ÚkeysrrzJEither ntp:config:template or ntp:config:template_name values are requiredz ntp:config:rz6Expected a config file path {keypath}. Found ({value})ÚkeypathÚvaluerzHExpected 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Ú )ztemplatez template_name)ÚREQUIRED_NTP_CONFIG_KEYSÚ differenceÚsetrWrGÚsortedrFr"Úanyr6r ÚallÚ isinstancerHÚlistrP)Z ntp_configrZZmissingrWÚkeyrYrXr1r1r2Úsupplemental_schema_validationÝsH           rec Cshd|kr tjd|ƒdS|d}|dkr<i}t|tƒsltdjdtj|ƒƒƒ‚t|t ƒ|j ddƒ}t j |ƒr®tjd|ƒdSt |j d ƒ|jƒ}t j||j d iƒgd dƒ}t|ƒtd |j d ƒƒd}|j d ƒsz|j dƒjd|jjƒ} |j| ƒ}|szd|j dƒ} t| ƒ‚t|jjd|j dƒd|j dgƒd|j dgƒd|j d ƒd|d |j d ƒƒt|jjd|dd|dƒy!t|dd|jjƒƒWn;tjk rc} ztjd| ƒ‚WYdd} ~ XnXdS)zEnable and configure ntp.rz8Skipping module named %s, not present or disabled by cfgNzL'ntp' key existed in config, but not a dictionary type, is a {_type} insteadZ_typer'Tz)Skipping module named %s, disabled by cfgr$r(r*rrrz{distro}z#No template found, not rendering %srr#rr;rQrrrTz&Failed to reload/start ntp service: %s)r4r5rbÚdictÚ RuntimeErrorr"rZobj_namer Úschemar6rZis_falser8r/r.rer>ÚreplacerZget_template_filenamerRr9Zinstall_packagesrVZ uses_systemdrZProcessExecutionErrorZ exception) rr0ZcloudrZ_argsZntp_cfgr'Zntp_client_configrQrÚmsgÚer1r1r2Úhandles`       !      rl)'Ú__doc__r,r:ÚtextwraprZ cloudinitrZloggingrrrrrZcloudinit.config.schemar r Zcloudinit.settingsr Z getLoggerÚ__name__r4rZNTP_CONFrErr-r+rhÚ frozensetr\r3r8r9r>rKrRrVrerlr1r1r1r2ÚsT                                        -  5 2