REDROOM

Navigation

Breadcrumbs

/ / lib / python3.6 / site-packages / cloudinit / config

Create

Create File | Create Folder | Upload Files | Run Command

Preview: cc_install_hotplug.py Size: 3.81 KB

//lib/python3.6/site-packages/cloudinit/config/cc_install_hotplug.py

# This file is part of cloud-init. See LICENSE file for license information.
"""Install hotplug udev rules if supported and enabled"""
import logging
import os
from textwrap import dedent

from cloudinit import stages, subp, util
from cloudinit.cloud import Cloud
from cloudinit.config import Config
from cloudinit.config.schema import MetaSchema, get_meta_doc
from cloudinit.distros import ALL_DISTROS
from cloudinit.event import EventScope, EventType
from cloudinit.settings import PER_INSTANCE

meta: MetaSchema = {
    "id": "cc_install_hotplug",
    "name": "Install Hotplug",
    "title": "Install hotplug udev rules if supported and enabled",
    "description": dedent(
        """\
        This module will install the udev rules to enable hotplug if
        supported by the datasource and enabled in the userdata. The udev
        rules will be installed as
        ``/etc/udev/rules.d/10-cloud-init-hook-hotplug.rules``.

        When hotplug is enabled, newly added network devices will be added
        to the system by cloud-init. After udev detects the event,
        cloud-init will referesh the instance metadata from the datasource,
        detect the device in the updated metadata, then apply the updated
        network configuration.

        Currently supported datasources: Openstack, EC2
    """
    ),
    "distros": [ALL_DISTROS],
    "frequency": PER_INSTANCE,
    "examples": [
        dedent(
            """\
            # Enable hotplug of network devices
            updates:
              network:
                when: ["hotplug"]
        """
        ),
        dedent(
            """\
            # Enable network hotplug alongside boot event
            updates:
              network:
                when: ["boot", "hotplug"]
        """
        ),
    ],
    "activate_by_schema_keys": [],
}

__doc__ = get_meta_doc(meta)
LOG = logging.getLogger(__name__)


HOTPLUG_UDEV_PATH = "/etc/udev/rules.d/10-cloud-init-hook-hotplug.rules"
HOTPLUG_UDEV_RULES_TEMPLATE = """\
# Installed by cloud-init due to network hotplug userdata
ACTION!="add|remove", GOTO="cloudinit_end"
LABEL="cloudinit_hook"
SUBSYSTEM=="net", RUN+="{libexecdir}/hook-hotplug"
LABEL="cloudinit_end"
"""


def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None:
    network_hotplug_enabled = (
        "updates" in cfg
        and "network" in cfg["updates"]
        and "when" in cfg["updates"]["network"]
        and "hotplug" in cfg["updates"]["network"]["when"]
    )
    hotplug_supported = EventType.HOTPLUG in (
        cloud.datasource.get_supported_events([EventType.HOTPLUG]).get(
            EventScope.NETWORK, set()
        )
    )
    hotplug_enabled = stages.update_event_enabled(
        datasource=cloud.datasource,
        cfg=cfg,
        event_source_type=EventType.HOTPLUG,
        scope=EventScope.NETWORK,
    )
    if not (hotplug_supported and hotplug_enabled):
        if os.path.exists(HOTPLUG_UDEV_PATH):
            LOG.debug("Uninstalling hotplug, not enabled")
            util.del_file(HOTPLUG_UDEV_PATH)
            subp.subp(["udevadm", "control", "--reload-rules"])
        elif network_hotplug_enabled:
            LOG.warning(
                "Hotplug is unsupported by current datasource. "
                "Udev rules will NOT be installed."
            )
        else:
            LOG.debug("Skipping hotplug install, not enabled")
        return
    if not subp.which("udevadm"):
        LOG.debug("Skipping hotplug install, udevadm not found")
        return

    # This may need to turn into a distro property at some point
    libexecdir = "/usr/libexec/cloud-init"
    if not os.path.exists(libexecdir):
        libexecdir = "/usr/lib/cloud-init"
    util.write_file(
        filename=HOTPLUG_UDEV_PATH,
        content=HOTPLUG_UDEV_RULES_TEMPLATE.format(libexecdir=libexecdir),
    )
    subp.subp(["udevadm", "control", "--reload-rules"])

Directory Contents

Dirs: 2 × Files: 64

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
schemas DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
cc_ansible.py	8.69 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apk_configure.py	5.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_configure.py	41.99 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_pipelining.py	2.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_bootcmd.py	2.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_byobu.py	3.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ca_certs.py	9.13 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_chef.py	13.77 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disable_ec2_metadata.py	2.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disk_setup.py	32.36 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_fan.py	3.02 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_final_message.py	3.39 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_growpart.py	21.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_grub_dpkg.py	6.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_install_hotplug.py	3.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keyboard.py	2.38 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keys_to_console.py	3.61 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_landscape.py	5.31 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_locale.py	1.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_lxd.py	18.14 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mcollective.py	6.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_migrator.py	3.49 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mounts.py	19.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ntp.py	20.84 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_package_update_upgrade_install.py	4.54 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_phone_home.py	5.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_power_state_change.py	7.41 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_puppet.py	14.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_reset_rmc.py	4.47 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resizefs.py	10.73 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resolv_conf.py	4.98 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rh_subscription.py	16.97 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rightscale_userdata.py	4.28 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_rsyslog.py	13.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_runcmd.py	2.90 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_salt_minion.py	5.88 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_boot.py	1.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_instance.py	1.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_once.py	1.76 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_user.py	1.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_vendor.py	2.29 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_seed_random.py	4.72 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_hostname.py	5.13 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_passwords.py	10.97 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_snap.py	6.30 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_spacewalk.py	3.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh.py	14.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_authkey_fingerprints.py	4.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_import_id.py	6.12 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_timezone.py	1.46 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_advantage.py	17.00 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_autoinstall.py	4.50 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_drivers.py	4.56 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_etc_hosts.py	5.16 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_hostname.py	3.87 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_users_groups.py	8.57 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_wireguard.py	9.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files.py	6.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files_deferred.py	1.68 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_yum_add_repo.py	7.45 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_zypper_add_repo.py	6.59 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
modules.py	11.74 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
schema.py	54.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
__init__.py	14 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive