o w7eS@sUdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z ddl mZddlmZddlmZmZdd lmZeeZeZd Zd Zgd Zd ddgdddddedgdddddedgddddddgddddddgdddddZdd dd gddd d!did!d id"dd dd#idd$diid ddd%d&dgd dd'd(d)d*gd*d+d,d-d!d id.d/d0d1d*iid!d id ddd2did3d!d id ddd2d.id3d!d idd d#d.d/d0d3d!did!d id"d!d id ddd2d.id3dd$diid4 Zd5D]Zed6ee<qd7D] Zed8ee<q d9d:d;ed<eed=ed>gedgd?Z ee!d@<ee Ze"gdAZ#dBdCZ$dDdEZ%dWdFdGZ&dXdHdIZ'dJdKZ(        dYdLdMZ)dNdOZ*dPe+dQedRedSe,dTdf dUdVZ-dS)ZzNTP: enable and configure ntpN)dedent)log)subp temp_utils templater type_utilsutil)Cloud)Config) MetaSchema get_meta_doc) PER_INSTANCEz /etc/ntp.conf) almalinuxalpinecentos cloudlinuxcosdebian eurolinuxfedorafreebsdmariner miraclelinuxopenbsd openeuler OpenCloudOS openmandrivaopensuseopensuse-microosopensuse-tumbleweed opensuse-leapphotonrhelrockysle_hpc sle-microsles TencentOSubuntu virtuozzochronydz/etc/chrony.confchronyzchrony.conf.{distro}) check_execonfpathpackages service_name template_nametemplatentpdntpzntp.conf.{distro}ntpdatez/etc/ntpd.confzntpd.conf.{distro}z/lib/systemd/systemd-timesyncdz-/etc/systemd/timesyncd.conf.d/cloud-init.confsystemd-timesyncdztimesyncd.conf)r,r4r5openntpdr6z/etc/chrony/chrony.conf)r.r0)r.r/r0)r,r4r0)r4r,)r0r.r.)r.r0r1z/usr/local/etc/chrony.conf)r.r/r0r1z/usr/local/sbin/ntpdz/usr/local/etc/ntp.confr7zntpd.conf.openbsd)r-r.r/r0r1)r4r,r7z"/usr/lib/systemd/systemd-timesyncdz/etc/systemd/timesyncd.conf)r-r.)r,r6r-)r,r4r6) rrrrrrrrrr"r#r'r))rr r!r)r%r&r'cc_ntpNTPzenable 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)idnametitle descriptiondistrosexamples frequencyactivate_by_schema_keysmeta)r-r.r/r0cCs0t}tt}||vrtj|||gdd}|S)zConstruct 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. Treverse)DISTRO_CLIENT_CONFIGcopyNTP_CLIENT_CONFIGr mergemanydict)distrodcfgcfgrL9/usr/lib/python3/dist-packages/cloudinit/config/cc_ntp.pydistro_ntp_client_configs<s  rNcCst|j}|r|dkrtd|||iS|dd}i}|dkrT|jD]}||}t|dr?td||}nq&|sR|jd}td|||}|Std|||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 installedrzsz)generate_server_names..z pool.ntp.org)rangeNR_POOL_SERVERSappendjoinstr)rInames pool_distroxrLrLrMgenerate_server_namessrqc Cs$|sg}|sg}|s g}|sg}t|dkr"t|dkr"|dkr"dSt|dkr>|dkr>|dkr>t|}tdd|nt|dkrWt|dkrWt|}tdd||s]td |se|setd ||||d } |rtjd d d} | d}tj ||dt ||| |rt |dSdS)aRender 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. rrNrr3z%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)serverspoolsallowpeersztemplate_name-z.tmpl)prefixsuffix)content) lenrqrQrRrl ValueErrorrmkstempr write_filerrender_to_filedel_file) distro_namer0rsrtrurvr_ template_fnr2paramstfilerLrLrMwrite_ntp_config_templatesJ    rcCsBg}tt|}|rdt|}|dj|dnt| d| dgs/|dt| D]\\}}d|}|dkrUt |t |t gsT|d j||d q5|d krit |tsh|d j||d q5|d vr|durrq5t |t s|dj||d q5t |t s|dj||d q5|rtdjd|ddS)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})keysr2r1zJEither ntp:config:template or ntp:config:template_name values are requiredz ntp:config:r.z6Expected a config file path {keypath}. Found ({value}))keypathvaluer/zHExpected a list of required package names for {keypath}. Found ({value}))r2r1Nz5Expected a string type for {keypath}. Found ({value})z$Invalid ntp configuration:\n{errors} )errors)REQUIRED_NTP_CONFIG_KEYS differencesetrrlsortedrkformatanyrSitemsall isinstancermlistr|) ntp_configrmissingrkeyrrrLrLrMsupplemental_schema_validationsn     rr;rKcloudargsreturnc Csd|vr td|dS|d}|duri}t|ts&tdjt|d|dd}t |r9td|dSt |d |j }t j ||d igdd }t|t|d d d}|ds|dd|j j}||}|sd|d} t| td|dtd|dgtd|dgtd|dgtd|dgt|j j|d|dg|dg|dg|dg|d ||dd t|j j|d|ddt rH|dd kr&z |j d!d Wntjy td"Ynwz |j d#d Wntjy%td$Ynwz |j d%|dWntjyG} ztd&| d} ~ wwz |j d'|dWdStjyj} ztd(| d} ~ ww))zEnable and configure ntp.r4z8Skipping module named %s, not present or disabled by cfgNzL'ntp' key existed in config, but not a dictionary type, is a {_type} instead)_typeenabledTz)Skipping module named %s, disabled by cfgrPconfigrCr.rbr2r1z{distro}z#No template found, not rendering %szservice_name: %sr0z servers: %srsz pools: %srtz allow: %sruz peers: %srv)r0rsrtrurvr_rr2r/r-)r/r-r3stopz Failed to stop base ntpd servicedisablez#Failed to disable base ntpd serviceenablez Failed to enable ntp service: %sreloadz&Failed to reload/start ntp service: %s)rQrRrdict RuntimeErrorrrobj_namerSris_falser[rIrHrrcreplacer;get_template_filenamerr]install_packagesis_BSDmanage_servicerProcessExecutionErrorwarning exception) r;rKrrntp_cfgrntp_client_configrr1msgerLrLrMhandleBs                    r)Nr3)N)NNNNNNNN).__doc__rFr^textwrapr cloudinitrloggingrrrrrcloudinit.cloudr cloudinit.configr cloudinit.config.schemar r cloudinit.settingsr getLogger__name__rQr@NTP_CONFrjr>rGrErIrB__annotations__ frozensetrrNr[r]rcrqrrrmrrrLrLrLrMsf      !    /      |  5H 2   Q"=