# Copyright (C) 2011 Canonical Ltd. # Copyright (C) 2012 Hewlett-Packard Development Company, L.P. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Juerg Haefliger <juerg.haefliger@hp.com> # # This file is part of cloud-init. See LICENSE file for license information. """Update Etc Hosts: Update the hosts file (usually ``/etc/hosts``)""" from logging import Logger from textwrap import dedent from cloudinit import templater, util from cloudinit.cloud import Cloud from cloudinit.config import Config from cloudinit.config.schema import MetaSchema, get_meta_doc from cloudinit.settings import PER_ALWAYS MODULE_DESCRIPTION = """\ This module will update the contents of the local hosts database (hosts file; usually ``/etc/hosts``) based on the hostname/fqdn specified in config. Management of the hosts file is controlled using ``manage_etc_hosts``. If this is set to false, cloud-init will not manage the hosts file at all. This is the default behavior. If set to ``true``, cloud-init will generate the hosts file using the template located in ``/etc/cloud/templates/hosts.tmpl``. In the ``/etc/cloud/templates/hosts.tmpl`` template, the strings ``$hostname`` and ``$fqdn`` will be replaced with the hostname and fqdn respectively. If ``manage_etc_hosts`` is set to ``localhost``, then cloud-init will not rewrite the hosts file entirely, but rather will ensure that a entry for the fqdn with a distribution dependent ip is present (i.e. ``ping <hostname>`` will ping ``127.0.0.1`` or ``127.0.1.1`` or other ip). .. note:: if ``manage_etc_hosts`` is set ``true``, the contents of the hosts file will be updated every boot. To make any changes to the hosts file persistent they must be made in ``/etc/cloud/templates/hosts.tmpl`` .. note:: for instructions on specifying hostname and fqdn, see documentation for ``cc_set_hostname`` """ distros = ["all"] meta: MetaSchema = { "id": "cc_update_etc_hosts", "name": "Update Etc Hosts", "title": "Update the hosts file (usually ``/etc/hosts``)", "description": MODULE_DESCRIPTION, "distros": distros, "examples": [ dedent( """\ # Do not update or manage /etc/hosts at all. This is the default behavior. # # Whatever is present at instance boot time will be present after boot. # User changes will not be overwritten. manage_etc_hosts: false """ ), dedent( """\ # Manage /etc/hosts with cloud-init. # On every boot, /etc/hosts will be re-written from # ``/etc/cloud/templates/hosts.tmpl``. # # The strings '$hostname' and '$fqdn' are replaced in the template # with the appropriate values either from the config-config ``fqdn`` or # ``hostname`` if provided. When absent, the cloud metadata will be # checked for ``local-hostname` which can be split into <hostname>.<fqdn>. # # To make modifications persistent across a reboot, you must modify # ``/etc/cloud/templates/hosts.tmpl``. manage_etc_hosts: true """ ), dedent( """\ # Update /etc/hosts every boot providing a "localhost" 127.0.1.1 entry # with the latest hostname and fqdn as provided by either IMDS or # cloud-config. # All other entries will be left as is. # 'ping `hostname`' will ping 127.0.1.1 manage_etc_hosts: localhost """ ), ], "frequency": PER_ALWAYS, "activate_by_schema_keys": ["manage_etc_hosts"], } __doc__ = get_meta_doc(meta) def handle( name: str, cfg: Config, cloud: Cloud, log: Logger, args: list ) -> None: manage_hosts = util.get_cfg_option_str(cfg, "manage_etc_hosts", False) hosts_fn = cloud.distro.hosts_fn if util.translate_bool(manage_hosts, addons=["template"]): if manage_hosts == "template": log.warning( "DEPRECATED: please use manage_etc_hosts: true instead of" " 'template'" ) (hostname, fqdn, _) = util.get_hostname_fqdn(cfg, cloud) if not hostname: log.warning( "Option 'manage_etc_hosts' was set, but no hostname was found" ) return # Render from a template file tpl_fn_name = cloud.get_template_filename( "hosts.%s" % (cloud.distro.osfamily) ) if not tpl_fn_name: raise RuntimeError( "No hosts template could be found for distro %s" % (cloud.distro.osfamily) ) templater.render_to_file( tpl_fn_name, hosts_fn, {"hostname": hostname, "fqdn": fqdn} ) elif manage_hosts == "localhost": (hostname, fqdn, _) = util.get_hostname_fqdn(cfg, cloud) if not hostname: log.warning( "Option 'manage_etc_hosts' was set, but no hostname was found" ) return log.debug("Managing localhost in %s", hosts_fn) cloud.distro.update_etc_hosts(hostname, fqdn) else: log.debug( "Configuration option 'manage_etc_hosts' is not set," " not managing %s in module %s", hosts_fn, name, ) # vi: ts=4 expandtab
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
schemas | Folder | 0755 |
|
|
__init__.py | File | 14 B | 0644 |
|
cc_ansible.py | File | 8.37 KB | 0644 |
|
cc_apk_configure.py | File | 5.75 KB | 0644 |
|
cc_apt_configure.py | File | 32.46 KB | 0644 |
|
cc_apt_pipelining.py | File | 2.82 KB | 0644 |
|
cc_bootcmd.py | File | 2.87 KB | 0644 |
|
cc_byobu.py | File | 3.67 KB | 0644 |
|
cc_ca_certs.py | File | 8.06 KB | 0644 |
|
cc_chef.py | File | 13.79 KB | 0644 |
|
cc_disable_ec2_metadata.py | File | 2.04 KB | 0644 |
|
cc_disk_setup.py | File | 32.34 KB | 0644 |
|
cc_fan.py | File | 3.11 KB | 0644 |
|
cc_final_message.py | File | 3.41 KB | 0644 |
|
cc_growpart.py | File | 19.42 KB | 0644 |
|
cc_grub_dpkg.py | File | 5.49 KB | 0644 |
|
cc_install_hotplug.py | File | 3.81 KB | 0644 |
|
cc_keyboard.py | File | 2.08 KB | 0644 |
|
cc_keys_to_console.py | File | 3.63 KB | 0644 |
|
cc_landscape.py | File | 4.86 KB | 0644 |
|
cc_locale.py | File | 1.88 KB | 0644 |
|
cc_lxd.py | File | 17.96 KB | 0644 |
|
cc_mcollective.py | File | 6.2 KB | 0644 |
|
cc_migrator.py | File | 3.51 KB | 0644 |
|
cc_mounts.py | File | 19.03 KB | 0644 |
|
cc_ntp.py | File | 19.7 KB | 0644 |
|
cc_package_update_upgrade_install.py | File | 4.42 KB | 0644 |
|
cc_phone_home.py | File | 5.5 KB | 0644 |
|
cc_power_state_change.py | File | 7.65 KB | 0644 |
|
cc_puppet.py | File | 13.74 KB | 0644 |
|
cc_refresh_rmc_and_interface.py | File | 5.48 KB | 0644 |
|
cc_reset_rmc.py | File | 4.53 KB | 0644 |
|
cc_resizefs.py | File | 10.56 KB | 0644 |
|
cc_resolv_conf.py | File | 5.01 KB | 0644 |
|
cc_rh_subscription.py | File | 17.05 KB | 0644 |
|
cc_rightscale_userdata.py | File | 4.3 KB | 0644 |
|
cc_rsyslog.py | File | 9.77 KB | 0644 |
|
cc_runcmd.py | File | 2.92 KB | 0644 |
|
cc_salt_minion.py | File | 5.54 KB | 0644 |
|
cc_scripts_per_boot.py | File | 1.68 KB | 0644 |
|
cc_scripts_per_instance.py | File | 1.83 KB | 0644 |
|
cc_scripts_per_once.py | File | 1.78 KB | 0644 |
|
cc_scripts_user.py | File | 1.87 KB | 0644 |
|
cc_scripts_vendor.py | File | 2.31 KB | 0644 |
|
cc_seed_random.py | File | 4.81 KB | 0644 |
|
cc_set_hostname.py | File | 4.89 KB | 0644 |
|
cc_set_passwords.py | File | 11.05 KB | 0644 |
|
cc_snap.py | File | 6.39 KB | 0644 |
|
cc_spacewalk.py | File | 3.52 KB | 0644 |
|
cc_ssh.py | File | 14.03 KB | 0644 |
|
cc_ssh_authkey_fingerprints.py | File | 4.24 KB | 0644 |
|
cc_ssh_import_id.py | File | 5.82 KB | 0644 |
|
cc_timezone.py | File | 1.44 KB | 0644 |
|
cc_ubuntu_advantage.py | File | 16.88 KB | 0644 |
|
cc_ubuntu_autoinstall.py | File | 4.56 KB | 0644 |
|
cc_ubuntu_drivers.py | File | 4.63 KB | 0644 |
|
cc_update_etc_hosts.py | File | 5.11 KB | 0644 |
|
cc_update_hostname.py | File | 3.63 KB | 0644 |
|
cc_users_groups.py | File | 7.6 KB | 0644 |
|
cc_wireguard.py | File | 9.28 KB | 0644 |
|
cc_write_files.py | File | 6.75 KB | 0644 |
|
cc_write_files_deferred.py | File | 1.68 KB | 0644 |
|
cc_yum_add_repo.py | File | 7.47 KB | 0644 |
|
cc_zypper_add_repo.py | File | 6.68 KB | 0644 |
|
modules.py | File | 11.43 KB | 0644 |
|
schema.py | File | 43.14 KB | 0644 |
|