Current File : //lib/python3/dist-packages/cloudinit/config/cc_bootcmd.py
# 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
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:
iid = cloud.get_instance_id()
env = {"INSTANCE_ID": str(iid)} if iid else {}
subp.subp(["/bin/sh", tmpf.name], update_env=env, capture=False)
except Exception:
util.logexc(LOG, "Failed to run bootcmd module %s", name)
raise
Mini Shell