# Copyright (C) 2009-2011 Canonical Ltd. # Copyright (C) 2012, 2013 Hewlett-Packard Development Company, L.P. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Juerg Haefliger <juerg.haefliger@hp.com> # Author: Chad Smith <chad.smith@canonical.com> # # This file is part of cloud-init. See LICENSE file for license information. """Bootcmd: run arbitrary commands early in the boot process.""" import logging import os from textwrap import dedent from cloudinit import subp, temp_utils, 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 LOG = logging.getLogger(__name__) frequency = PER_ALWAYS distros = ["all"] meta: MetaSchema = { "id": "cc_bootcmd", "name": "Bootcmd", "title": "Run arbitrary commands early in the boot process", "description": dedent( """\ This module runs arbitrary commands very early in the boot process, only slightly after a boothook would run. This is very similar to a boothook, but more user friendly. The environment variable ``INSTANCE_ID`` will be set to the current instance id for all run commands. Commands can be specified either as lists or strings. For invocation details, see ``runcmd``. .. note:: bootcmd should only be used for things that could not be done later in the boot process. .. note:: when writing files, do not use /tmp dir as it races with systemd-tmpfiles-clean LP: #1707222. Use /run/somedir instead. """ ), "distros": distros, "examples": [ dedent( """\ bootcmd: - echo 192.168.1.130 us.archive.ubuntu.com > /etc/hosts - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ] """ ) ], "frequency": PER_ALWAYS, "activate_by_schema_keys": ["bootcmd"], } __doc__ = get_meta_doc(meta) def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None: if "bootcmd" not in cfg: LOG.debug( "Skipping module named %s, no 'bootcmd' key in configuration", name ) return with temp_utils.ExtendedTemporaryFile(suffix=".sh") as tmpf: try: content = util.shellify(cfg["bootcmd"]) tmpf.write(util.encode_text(content)) tmpf.flush() except Exception as e: util.logexc(LOG, "Failed to shellify bootcmd: %s", str(e)) raise try: env = os.environ.copy() iid = cloud.get_instance_id() if iid: env["INSTANCE_ID"] = str(iid) cmd = ["/bin/sh", tmpf.name] subp.subp(cmd, env=env, capture=False) except Exception: util.logexc(LOG, "Failed to run bootcmd module %s", name) raise
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
schemas | Folder | 0755 |
|
|
__init__.py | File | 14 B | 0644 |
|
cc_ansible.py | File | 8.69 KB | 0644 |
|
cc_apk_configure.py | File | 5.66 KB | 0644 |
|
cc_apt_configure.py | File | 41.99 KB | 0644 |
|
cc_apt_pipelining.py | File | 2.71 KB | 0644 |
|
cc_bootcmd.py | File | 2.85 KB | 0644 |
|
cc_byobu.py | File | 3.65 KB | 0644 |
|
cc_ca_certs.py | File | 9.13 KB | 0644 |
|
cc_chef.py | File | 13.77 KB | 0644 |
|
cc_disable_ec2_metadata.py | File | 2.03 KB | 0644 |
|
cc_disk_setup.py | File | 32.36 KB | 0644 |
|
cc_fan.py | File | 3.02 KB | 0644 |
|
cc_final_message.py | File | 3.39 KB | 0644 |
|
cc_growpart.py | File | 21.03 KB | 0644 |
|
cc_grub_dpkg.py | File | 6.65 KB | 0644 |
|
cc_install_hotplug.py | File | 3.81 KB | 0644 |
|
cc_keyboard.py | File | 2.38 KB | 0644 |
|
cc_keys_to_console.py | File | 3.61 KB | 0644 |
|
cc_landscape.py | File | 5.31 KB | 0644 |
|
cc_locale.py | File | 1.86 KB | 0644 |
|
cc_lxd.py | File | 18.14 KB | 0644 |
|
cc_mcollective.py | File | 6.1 KB | 0644 |
|
cc_migrator.py | File | 3.49 KB | 0644 |
|
cc_mounts.py | File | 19.71 KB | 0644 |
|
cc_ntp.py | File | 20.69 KB | 0644 |
|
cc_package_update_upgrade_install.py | File | 4.54 KB | 0644 |
|
cc_phone_home.py | File | 5.48 KB | 0644 |
|
cc_power_state_change.py | File | 7.41 KB | 0644 |
|
cc_puppet.py | File | 14.1 KB | 0644 |
|
cc_reset_rmc.py | File | 4.47 KB | 0644 |
|
cc_resizefs.py | File | 10.73 KB | 0644 |
|
cc_resolv_conf.py | File | 4.98 KB | 0644 |
|
cc_rh_subscription.py | File | 16.97 KB | 0644 |
|
cc_rightscale_userdata.py | File | 4.28 KB | 0644 |
|
cc_rsyslog.py | File | 13.48 KB | 0644 |
|
cc_runcmd.py | File | 2.9 KB | 0644 |
|
cc_salt_minion.py | File | 5.88 KB | 0644 |
|
cc_scripts_per_boot.py | File | 1.66 KB | 0644 |
|
cc_scripts_per_instance.py | File | 1.81 KB | 0644 |
|
cc_scripts_per_once.py | File | 1.76 KB | 0644 |
|
cc_scripts_user.py | File | 1.85 KB | 0644 |
|
cc_scripts_vendor.py | File | 2.29 KB | 0644 |
|
cc_seed_random.py | File | 4.72 KB | 0644 |
|
cc_set_hostname.py | File | 5.13 KB | 0644 |
|
cc_set_passwords.py | File | 10.97 KB | 0644 |
|
cc_snap.py | File | 6.3 KB | 0644 |
|
cc_spacewalk.py | File | 3.43 KB | 0644 |
|
cc_ssh.py | File | 14.86 KB | 0644 |
|
cc_ssh_authkey_fingerprints.py | File | 4.22 KB | 0644 |
|
cc_ssh_import_id.py | File | 6.12 KB | 0644 |
|
cc_timezone.py | File | 1.46 KB | 0644 |
|
cc_ubuntu_advantage.py | File | 17 KB | 0644 |
|
cc_ubuntu_autoinstall.py | File | 4.5 KB | 0644 |
|
cc_ubuntu_drivers.py | File | 4.56 KB | 0644 |
|
cc_update_etc_hosts.py | File | 5.16 KB | 0644 |
|
cc_update_hostname.py | File | 3.87 KB | 0644 |
|
cc_users_groups.py | File | 8.57 KB | 0644 |
|
cc_wireguard.py | File | 9.22 KB | 0644 |
|
cc_write_files.py | File | 6.66 KB | 0644 |
|
cc_write_files_deferred.py | File | 1.68 KB | 0644 |
|
cc_yum_add_repo.py | File | 7.45 KB | 0644 |
|
cc_zypper_add_repo.py | File | 6.59 KB | 0644 |
|
modules.py | File | 11.74 KB | 0644 |
|
schema.py | File | 54.85 KB | 0644 |
|