`` keys and lists of ``=`` pairs within each section. The ``certname`` key supports string substitutions for ``%i`` and ``%f``, corresponding to the instance id and fqdn of the machine respectively.\n\n``ca_cert`` is a special case. It won't be added to puppet.conf. It holds the puppetserver certificate in pem format. It should be a multi-line string (using the | yaml notation for multi-line strings).", "additionalProperties": false, "properties": { "main": { "type": "object" }, "server": { "type": "object" }, "agent": { "type": "object" }, "user": { "type": "object" }, "ca_cert": { "type": "string" } } }, "csr_attributes": { "type": "object", "description": "create a ``csr_attributes.yaml`` file for CSR attributes and certificate extension requests. See https://puppet.com/docs/puppet/latest/config_file_csr_attributes.html", "additionalProperties": false, "properties": { "custom_attributes": { "type": "object" }, "extension_requests": { "type": "object" } } } } } } }, "cc_resizefs": { "type": "object", "properties": { "resize_rootfs": { "enum": [ true, false, "noblock" ], "description": "Whether to resize the root partition. ``noblock`` will resize in the background. Default: ``true``" } } }, "cc_resolv_conf": { "type": "object", "properties": { "manage_resolv_conf": { "type": "boolean", "default": false, "description": "Whether to manage the resolv.conf file. ``resolv_conf`` block will be ignored unless this is set to ``true``. Default: ``false``" }, "resolv_conf": { "type": "object", "additionalProperties": false, "properties": { "nameservers": { "type": "array", "description": "A list of nameservers to use to be added as ``nameserver`` lines" }, "searchdomains": { "type": "array", "description": "A list of domains to be added ``search`` line" }, "domain": { "type": "string", "description": "The domain to be added as ``domain`` line" }, "sortlist": { "type": "array", "description": "A list of IP addresses to be added to ``sortlist`` line" }, "options": { "type": "object", "description": "Key/value pairs of options to go under ``options`` heading. A unary option should be specified as ``true``" } } } } }, "cc_rh_subscription": { "type": "object", "properties": { "rh_subscription": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "The username to use. Must be used with password. Should not be used with ``activation-key`` or ``org``" }, "password": { "type": "string", "description": "The password to use. Must be used with username. Should not be used with ``activation-key`` or ``org``" }, "activation-key": { "type": "string", "description": "The activation key to use. Must be used with ``org``. Should not be used with ``username`` or ``password``" }, "org": { "description": "The organization to use. Must be used with ``activation-key``. Should not be used with ``username`` or ``password``", "oneOf": [ { "type": "string" }, { "type": "integer", "deprecated": true, "deprecated_version": "24.2", "deprecated_description": "Use of type integer for this value is deprecated. Use a string instead." } ] }, "auto-attach": { "type": "boolean", "description": "Whether to attach subscriptions automatically" }, "service-level": { "type": "string", "description": "The service level to use when subscribing to RH repositories. ``auto-attach`` must be true for this to be used" }, "add-pool": { "type": "array", "description": "A list of pools ids add to the subscription", "items": { "type": "string" } }, "enable-repo": { "type": "array", "description": "A list of repositories to enable", "items": { "type": "string" } }, "disable-repo": { "type": "array", "description": "A list of repositories to disable", "items": { "type": "string" } }, "rhsm-baseurl": { "type": "string", "description": "Sets the baseurl in ``/etc/rhsm/rhsm.conf``" }, "server-hostname": { "type": "string", "description": "Sets the serverurl in ``/etc/rhsm/rhsm.conf``" } } } } }, "cc_rsyslog": { "type": "object", "properties": { "rsyslog": { "type": "object", "additionalProperties": false, "properties": { "config_dir": { "type": "string", "description": "The directory where rsyslog configuration files will be written. Default: ``/etc/rsyslog.d``" }, "config_filename": { "type": "string", "description": "The name of the rsyslog configuration file. Default: ``20-cloud-config.conf``" }, "configs": { "type": "array", "description": "Each entry in ``configs`` is either a string or an object. Each config entry contains a configuration string and a file to write it to. For config entries that are an object, ``filename`` sets the target filename and ``content`` specifies the config string to write. For config entries that are only a string, the string is used as the config string to write. If the filename to write the config to is not specified, the value of the ``config_filename`` key is used. A file with the selected filename will be written inside the directory specified by ``config_dir``.", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "content" ], "additionalProperties": false, "properties": { "filename": { "type": "string" }, "content": { "type": "string" } } } ] } }, "remotes": { "type": "object", "description": "Each key is the name for an rsyslog remote entry. Each value holds the contents of the remote config for rsyslog. The config consists of the following parts:\n\n- filter for log messages (defaults to ``*.*``)\n\n- optional leading ``@`` or ``@@``, indicating udp and tcp respectively (defaults to ``@``, for udp)\n\n- ipv4 or ipv6 hostname or address. ipv6 addresses must be in ``[::1]`` format, (e.g. ``@[fd00::1]:514``)\n\n- optional port number (defaults to ``514``)\n\nThis module will provide sane defaults for any part of the remote entry that is not specified, so in most cases remote hosts can be specified just using ``:

``." }, "service_reload_command": { "description": "The command to use to reload the rsyslog service after the config has been updated. If this is set to ``auto``, then an appropriate command for the distro will be used. This is the default behavior. To manually set the command, use a list of command args (e.g. ``[systemctl, restart, rsyslog]``).", "oneOf": [ { "enum": [ "auto" ] }, { "type": "array", "items": { "type": "string" } } ] }, "install_rsyslog": { "default": false, "description": "Install rsyslog. Default: ``false``", "type": "boolean" }, "check_exe": { "type": "string", "description": "The executable name for the rsyslog daemon.\nFor example, ``rsyslogd``, or ``/opt/sbin/rsyslogd`` if the rsyslog binary is in an unusual path. This is only used if ``install_rsyslog`` is ``true``. Default: ``rsyslogd``" }, "packages": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of packages needed to be installed for rsyslog. This is only used if ``install_rsyslog`` is ``true``. Default: ``[rsyslog]``" } } } } }, "cc_runcmd": { "type": "object", "properties": { "runcmd": { "type": "array", "items": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "null" } ] }, "minItems": 1 } } }, "cc_salt_minion": { "type": "object", "properties": { "salt_minion": { "type": "object", "additionalProperties": false, "properties": { "pkg_name": { "type": "string", "description": "Package name to install. Default: ``salt-minion``" }, "service_name": { "type": "string", "description": "Service name to enable. Default: ``salt-minion``" }, "config_dir": { "type": "string", "description": "Directory to write config files to. Default: ``/etc/salt``" }, "conf": { "type": "object", "description": "Configuration to be written to `config_dir`/minion" }, "grains": { "type": "object", "description": "Configuration to be written to `config_dir`/grains" }, "public_key": { "type": "string", "description": "Public key to be used by the salt minion" }, "private_key": { "type": "string", "description": "Private key to be used by salt minion" }, "pki_dir": { "type": "string", "description": "Directory to write key files. Default: `config_dir`/pki/minion" } } } } }, "cc_scripts_vendor": { "type": "object", "properties": { "vendor_data": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "description": "Whether vendor data is enabled or not. Default: ``true``", "oneOf": [ { "type": "boolean", "default": true }, { "type": "string", "deprecated": true, "deprecated_version": "22.3", "deprecated_description": "Use of type string for this value is deprecated. Use a boolean instead." } ] }, "prefix": { "type": [ "array", "string" ], "items": { "type": [ "string", "integer" ] }, "description": "The command to run before any vendor scripts. Its primary use case is for profiling a script, not to prevent its run" } } } } }, "cc_seed_random": { "type": "object", "properties": { "random_seed": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "default": "/dev/urandom", "description": "File to write random data to. Default: ``/dev/urandom``" }, "data": { "type": "string", "description": "This data will be written to ``file`` before data from the datasource. When using a multiline value or specifying binary data, be sure to follow yaml syntax and use the ``|`` and ``!binary`` yaml format specifiers when appropriate" }, "encoding": { "type": "string", "default": "raw", "enum": [ "raw", "base64", "b64", "gzip", "gz" ], "description": "Used to decode ``data`` provided. Allowed values are ``raw``, ``base64``, ``b64``, ``gzip``, or ``gz``. Default: ``raw``" }, "command": { "type": "array", "items": { "type": "string" }, "description": "Execute this command to seed random. The command will have RANDOM_SEED_FILE in its environment set to the value of ``file`` above." }, "command_required": { "type": "boolean", "default": false, "description": "If true, and ``command`` is not available to be run then an exception is raised and cloud-init will record failure. Otherwise, only debug error is mentioned. Default: ``false``" } } } } }, "cc_set_hostname": { "type": "object", "properties": { "preserve_hostname": { "type": "boolean", "default": false, "description": "If true, the hostname will not be changed. Default: ``false``" }, "hostname": { "type": "string", "description": "The hostname to set" }, "fqdn": { "type": "string", "description": "The fully qualified domain name to set" }, "prefer_fqdn_over_hostname": { "type": "boolean", "description": "If true, the fqdn will be used if it is set. If false, the hostname will be used. If unset, the result is distro-dependent" }, "create_hostname_file": { "type": "boolean", "default": true, "description": "If ``false``, the hostname file (e.g. /etc/hostname) will not be created if it does not exist. On systems that use systemd, setting create_hostname_file to ``false`` will set the hostname transiently. If ``true``, the hostname file will always be created and the hostname will be set statically on systemd systems. Default: ``true``" } } }, "cc_set_passwords": { "type": "object", "properties": { "ssh_pwauth": { "oneOf": [ { "type": "boolean" }, { "type": "string", "changed": true, "changed_version": "22.3", "changed_description": "Use of non-boolean values for this field is deprecated." } ], "description": "Sets whether or not to accept password authentication. ``true`` will enable password auth. ``false`` will disable. Default is to leave the value unchanged. In order for this config to be applied, SSH may need to be restarted. On systemd systems, this restart will only happen if the SSH service has already been started. On non-systemd systems, a restart will be attempted regardless of the service state." }, "chpasswd": { "type": "object", "additionalProperties": false, "properties": { "expire": { "type": "boolean", "default": true, "description": "Whether to expire all user passwords such that a password will need to be reset on the user's next login. Default: ``true``" }, "users": { "description": "This key represents a list of existing users to set passwords for. Each item under users contains the following required keys: ``name`` and ``password`` or in the case of a randomly generated password, ``name`` and ``type``. The ``type`` key has a default value of ``hash``, and may alternatively be set to ``text`` or ``RANDOM``.", "type": "array", "items": { "minItems": 1, "type": "object", "anyOf": [ { "required": [ "name", "type" ], "additionalProperties": false, "properties": { "name": { "type": "string" }, "type": { "enum": [ "RANDOM" ], "type": "string" } } }, { "required": [ "name", "password" ], "additionalProperties": false, "properties": { "name": { "type": "string" }, "type": { "enum": [ "hash", "text" ], "default": "hash", "type": "string" }, "password": { "type": "string" } } } ] } }, "list": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "pattern": "^.+:.+$" } } ], "minItems": 1, "description": "List of ``username:password`` pairs. Each user will have the corresponding password set. A password can be randomly generated by specifying ``RANDOM`` or ``R`` as a user's password. A hashed password, created by a tool like ``mkpasswd``, can be specified. A regex (``r'\\$(1|2a|2y|5|6)(\\$.+){2}'``) is used to determine if a password value should be treated as a hash.", "deprecated": true, "deprecated_version": "22.2", "deprecated_description": "Use ``users`` instead." } } }, "password": { "type": "string", "description": "Set the default user's password. Ignored if ``chpasswd`` ``list`` is used" } } }, "cc_snap": { "type": "object", "properties": { "snap": { "type": "object", "minProperties": 1, "additionalProperties": false, "properties": { "assertions": { "description": "Properly-signed snap assertions which will run before and snap ``commands``.", "type": [ "object", "array" ], "items": { "type": "string" }, "additionalItems": false, "minItems": 1, "minProperties": 1, "uniqueItems": true, "additionalProperties": { "type": "string" } }, "commands": { "type": [ "object", "array" ], "description": "Snap commands to run on the target system", "items": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "additionalItems": false, "minItems": 1, "minProperties": 1, "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } } } } }, "cc_spacewalk": { "type": "object", "properties": { "spacewalk": { "type": "object", "additionalProperties": false, "properties": { "server": { "type": "string", "description": "The Spacewalk server to use" }, "proxy": { "type": "string", "description": "The proxy to use when connecting to Spacewalk" }, "activation_key": { "type": "string", "description": "The activation key to use when registering with Spacewalk" } } } } }, "cc_ssh_authkey_fingerprints": { "type": "object", "properties": { "no_ssh_fingerprints": { "type": "boolean", "default": false, "description": "If true, SSH fingerprints will not be written. Default: ``false``" }, "authkey_hash": { "type": "string", "default": "sha256", "description": "The hash type to use when generating SSH fingerprints. Default: ``sha256``" } } }, "cc_ssh_import_id": { "type": "object", "properties": { "ssh_import_id": { "type": "array", "items": { "type": "string", "description": "The SSH public key to import" } } } }, "cc_ssh": { "type": "object", "properties": { "ssh_keys": { "type": "object", "description": "A dictionary entries for the public and private host keys of each desired key type. Entries in the ``ssh_keys`` config dict should have keys in the format ``_private``, ``_public``, and, optionally, ``_certificate``, e.g. ``rsa_private: ``, ``rsa_public: ``, and ``rsa_certificate: ``. Not all key types have to be specified, ones left unspecified will not be used. If this config option is used, then separate keys will not be automatically generated. In order to specify multiline private host keys and certificates, use yaml multiline syntax.", "additionalProperties": false, "patternProperties": { "^(dsa|ecdsa|ed25519|rsa)_(public|private|certificate)$": { "label": "", "type": "string" } } }, "ssh_authorized_keys": { "type": "array", "minItems": 1, "description": "The SSH public keys to add ``.ssh/authorized_keys`` in the default user's home directory", "items": { "type": "string" } }, "ssh_deletekeys": { "type": "boolean", "default": true, "description": "Remove host SSH keys. This prevents re-use of a private host key from an image with default host SSH keys. Default: ``true``" }, "ssh_genkeytypes": { "type": "array", "description": "The SSH key types to generate. Default: ``[rsa, dsa, ecdsa, ed25519]``", "default": [ "dsa", "ecdsa", "ed25519", "rsa" ], "minItems": 1, "items": { "type": "string", "enum": [ "dsa", "ecdsa", "ed25519", "rsa" ] } }, "disable_root": { "type": "boolean", "default": true, "description": "Disable root login. Default: ``true``" }, "disable_root_opts": { "type": "string", "default": "``no-port-forwarding,no-agent-forwarding,no-X11-forwarding,command=\"echo 'Please login as the user \\\"$USER\\\" rather than the user \\\"$DISABLE_USER\\\".';echo;sleep 10;exit 142\"``", "description": "Disable root login options. If ``disable_root_opts`` is specified and contains the string ``$USER``, it will be replaced with the username of the default user. Default: ``no-port-forwarding,no-agent-forwarding,no-X11-forwarding,command=\"echo 'Please login as the user \\\"$USER\\\" rather than the user \\\"$DISABLE_USER\\\".';echo;sleep 10;exit 142\"``" }, "allow_public_ssh_keys": { "type": "boolean", "default": true, "description": "If ``true``, will import the public SSH keys from the datasource's metadata to the user's ``.ssh/authorized_keys`` file. Default: ``true``" }, "ssh_quiet_keygen": { "type": "boolean", "default": false, "description": "If ``true``, will suppress the output of key generation to the console. Default: ``false``" }, "ssh_publish_hostkeys": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": true, "description": "If true, will read host keys from ``/etc/ssh/*.pub`` and publish them to the datasource (if supported). Default: ``true``" }, "blacklist": { "type": "array", "description": "The SSH key types to ignore when publishing. Default: ``[dsa]``", "items": { "type": "string" } } } } } }, "cc_timezone": { "type": "object", "properties": { "timezone": { "type": "string", "description": "The timezone to use as represented in /usr/share/zoneinfo" } } }, "cc_ubuntu_advantage": { "type": "object", "properties": { "ubuntu_advantage": { "type": "object", "additionalProperties": false, "properties": { "enable": { "type": "array", "items": { "type": "string" }, "description": "Optional list of ubuntu-advantage services to enable. Any of: cc-eal, cis, esm-infra, fips, fips-updates, livepatch. By default, a given contract token will automatically enable a number of services, use this list to supplement which services should additionally be enabled. Any service unavailable on a given Ubuntu release or unentitled in a given contract will remain disabled. In Ubuntu Pro instances, if this list is given, then only those services will be enabled, ignoring contract defaults. Passing beta services here will cause an error." }, "enable_beta": { "type": "array", "items": { "type": "string" }, "description": "Optional list of ubuntu-advantage beta services to enable. By default, a given contract token will automatically enable a number of services, use this list to supplement which services should additionally be enabled. Any service unavailable on a given Ubuntu release or unentitled in a given contract will remain disabled. In Ubuntu Pro instances, if this list is given, then only those services will be enabled, ignoring contract defaults." }, "token": { "type": "string", "description": "Contract token obtained from https://ubuntu.com/advantage to attach. Required for non-Pro instances." }, "features": { "type": "object", "description": "Ubuntu Advantage features.", "additionalProperties": false, "properties": { "disable_auto_attach": { "type": "boolean", "description": "Optional boolean for controlling if ua-auto-attach.service (in Ubuntu Pro instances) will be attempted each boot. Default: ``false``", "default": false } } }, "config": { "type": "object", "description": "Configuration settings or override Ubuntu Advantage config.", "additionalProperties": true, "properties": { "http_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "Ubuntu Advantage HTTP Proxy URL or null to unset." }, "https_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "Ubuntu Advantage HTTPS Proxy URL or null to unset." }, "global_apt_http_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "HTTP Proxy URL used for all APT repositories on a system or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" }, "global_apt_https_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "HTTPS Proxy URL used for all APT repositories on a system or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" }, "ua_apt_http_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "HTTP Proxy URL used only for Ubuntu Advantage APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" }, "ua_apt_https_proxy": { "type": [ "string", "null" ], "format": "uri", "description": "HTTPS Proxy URL used only for Ubuntu Advantage APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" } } } } } } }, "cc_ubuntu_drivers": { "type": "object", "properties": { "drivers": { "type": "object", "additionalProperties": false, "properties": { "nvidia": { "type": "object", "required": [ "license-accepted" ], "additionalProperties": false, "properties": { "license-accepted": { "type": "boolean", "description": "Do you accept the NVIDIA driver license?" }, "version": { "type": "string", "description": "The version of the driver to install (e.g. \"390\", \"410\"). Defaults to the latest version." } } } } } } }, "cc_update_etc_hosts": { "type": "object", "properties": { "manage_etc_hosts": { "default": false, "description": "Whether to manage ``/etc/hosts`` on the system. If ``true``, render the hosts file using ``/etc/cloud/templates/hosts.tmpl`` replacing ``$hostname`` and ``$fdqn``. If ``localhost``, append a ``127.0.1.1`` entry that resolves from FQDN and hostname every boot. Default: ``false``.", "oneOf": [ { "enum": [ true, false, "localhost" ] }, { "enum": [ "template" ], "changed_description": "Use of ``template`` is deprecated, use ``true`` instead.", "changed": true, "changed_version": "22.3" } ] }, "fqdn": { "type": "string", "description": "Optional fully qualified domain name to use when updating ``/etc/hosts``. Preferred over ``hostname`` if both are provided. In absence of ``hostname`` and ``fqdn`` in cloud-config, the ``local-hostname`` value will be used from datasource metadata." }, "hostname": { "type": "string", "description": "Hostname to set when rendering ``/etc/hosts``. If ``fqdn`` is set, the hostname extracted from ``fqdn`` overrides ``hostname``." } } }, "cc_update_hostname": { "type": "object", "properties": { "preserve_hostname": { "type": "boolean", "default": false, "description": "Do not update system hostname when ``true``. Default: ``false``." }, "prefer_fqdn_over_hostname": { "type": "boolean", "default": null, "description": "By default, it is distro-dependent whether cloud-init uses the short hostname or fully qualified domain name when both ``local-hostname` and ``fqdn`` are both present in instance metadata. When set ``true``, use fully qualified domain name if present as hostname instead of short hostname. When set ``false``, use ``hostname`` config value if present, otherwise fallback to ``fqdn``." }, "create_hostname_file": { "type": "boolean", "default": true, "description": "If ``false``, the hostname file (e.g. /etc/hostname) will not be created if it does not exist. On systems that use systemd, setting create_hostname_file to ``false`` will set the hostname transiently. If ``true``, the hostname file will always be created and the hostname will be set statically on systemd systems. Default: ``true``" } } }, "cc_users_groups": { "type": "object", "properties": { "groups": { "type": [ "string", "object", "array" ], "hidden": [ "patternProperties" ], "$ref": "#/$defs/users_groups.groups_by_groupname", "items": { "type": [ "string", "object" ], "$ref": "#/$defs/users_groups.groups_by_groupname" }, "minItems": 1 }, "user": { "oneOf": [ { "type": "string" }, { "type": "object", "$ref": "#/$defs/users_groups.user" } ], "description": "The ``user`` dictionary values override the ``default_user`` configuration from ``/etc/cloud/cloud.cfg``. The `user` dictionary keys supported for the default_user are the same as the ``users`` schema." }, "users": { "type": [ "string", "array", "object" ], "items": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "$ref": "#/$defs/users_groups.user" } ] } } } }, "cc_wireguard": { "type": "object", "properties": { "wireguard": { "type": [ "null", "object" ], "properties": { "interfaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the interface. Typically wgx (example: wg0)" }, "config_path": { "type": "string", "description": "Path to configuration file of Wireguard interface" }, "content": { "type": "string", "description": "Wireguard interface configuration. Contains key, peer, ..." } }, "additionalProperties": false }, "minItems": 1 }, "readinessprobe": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of shell commands to be executed as probes." } }, "required": [ "interfaces" ], "minProperties": 1, "additionalProperties": false } } }, "cc_write_files": { "type": "object", "properties": { "write_files": { "type": "array", "items": { "type": "object", "required": [ "path" ], "additionalProperties": false, "properties": { "path": { "type": "string", "description": "Path of the file to which ``content`` is decoded and written" }, "content": { "type": "string", "default": "''", "description": "Optional content to write to the provided ``path``. When content is present and encoding is not 'text/plain', decode the content prior to writing. Default: ``''``" }, "owner": { "type": "string", "default": "root:root", "description": "Optional owner:group to chown on the file and new directories. Default: ``root:root``" }, "permissions": { "type": "string", "default": "'0o644'", "description": "Optional file permissions to set on ``path`` represented as an octal string '0###'. Default: ``0o644``" }, "encoding": { "type": "string", "default": "text/plain", "enum": [ "gz", "gzip", "gz+base64", "gzip+base64", "gz+b64", "gzip+b64", "b64", "base64", "text/plain" ], "description": "Optional encoding type of the content. Default is ``text/plain`` and no content decoding is performed. Supported encoding types are: gz, gzip, gz+base64, gzip+base64, gz+b64, gzip+b64, b64, base64" }, "append": { "type": "boolean", "default": false, "description": "Whether to append ``content`` to existing file if ``path`` exists. Default: ``false``." }, "defer": { "type": "boolean", "default": false, "description": "Defer writing the file until 'final' stage, after users were created, and packages were installed. Default: ``false``." } } }, "minItems": 1 } } }, "cc_yum_add_repo": { "type": "object", "properties": { "yum_repo_dir": { "type": "string", "default": "/etc/yum.repos.d", "description": "The repo parts directory where individual yum repo config files will be written. Default: ``/etc/yum.repos.d``" }, "yum_repos": { "type": "object", "minProperties": 1, "additionalProperties": false, "patternProperties": { "^[0-9a-zA-Z -_]+$": { "label": "", "type": "object", "description": "Object keyed on unique yum repo IDs. The key used will be used to write yum repo config files in ``yum_repo_dir``/.repo.", "additionalProperties": false, "properties": { "baseurl": { "type": "string", "format": "uri", "description": "URL to the directory where the yum repository's 'repodata' directory lives" }, "name": { "type": "string", "description": "Optional human-readable name of the yum repo." }, "enabled": { "type": "boolean", "default": true, "description": "Whether to enable the repo. Default: ``true``." } }, "patternProperties": { "^[0-9a-zA-Z_]+$": { "label": "", "oneOf": [ { "type": "integer" }, { "type": "boolean" }, { "type": "string" } ], "description": "Any supported yum repository configuration options will be written to the yum repo config file. See: man yum.conf" } }, "required": [ "baseurl" ] } } } } }, "cc_zypper_add_repo": { "type": "object", "properties": { "zypper": { "type": "object", "minProperties": 1, "additionalProperties": true, "properties": { "repos": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "The unique id of the repo, used when writing /etc/zypp/repos.d/.repo." }, "baseurl": { "type": "string", "format": "uri", "description": "The base repositoy URL" } }, "required": [ "id", "baseurl" ] }, "minItems": 1 }, "config": { "type": "object", "description": "Any supported zypo.conf key is written to ``/etc/zypp/zypp.conf``" } } } } }, "output_log_operator": { "oneOf": [ { "type": "string", "description": "A filepath operation configuration. This is a string containing a filepath and an optional leading operator: '>', '>>' or '|'. Operators '>' and '>>' indicate whether to overwrite or append to the file. The operator '|' redirects content to the command arguments specified." }, { "type": "array", "description": "A list specifying filepath operation configuration for stdout and stderror", "items": { "type": [ "string" ] }, "minItems": 2, "maxItems": 2 }, { "type": "object", "additionalProperties": false, "properties": { "output": { "type": "string", "description": "A filepath operation configuration. This is a string containing a filepath and an optional leading operator: '>', '>>' or '|'. Operators '>' and '>>' indicate whether to overwrite or append to the file. The operator '|' redirects content to the command arguments specified." }, "error": { "type": "string", "description": "A filepath operation configuration. A string containing a filepath and an optional leading operator: '>', '>>' or '|'. Operators '>' and '>>' indicate whether to overwrite or append to the file. The operator '|' redirects content to the command arguments specified." } } } ] }, "output_config": { "type": "object", "properties": { "output": { "type": "object", "additionalProperties": false, "properties": { "all": { "$ref": "#/$defs/output_log_operator" }, "init": { "$ref": "#/$defs/output_log_operator" }, "config": { "$ref": "#/$defs/output_log_operator" }, "final": { "$ref": "#/$defs/output_log_operator" } } } } }, "reporting_config": { "type": "object", "properties": { "reporting": { "type": "object", "additionalProperties": false, "patternProperties": { "^.+$": { "label": "", "type": "object", "oneOf": [ { "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "log" ] }, "level": { "type": "string", "enum": [ "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ], "default": "DEBUG" } } }, { "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "print" ] } } }, { "additionalProperties": false, "required": [ "type", "endpoint" ], "properties": { "type": { "type": "string", "enum": [ "webhook" ] }, "endpoint": { "type": "string", "format": "uri", "description": "The URL to send the event to." }, "consumer_key": { "type": "string", "description": "The consumer key to use for the webhook." }, "token_key": { "type": "string", "description": "The token key to use for the webhook." }, "token_secret": { "type": "string", "description": "The token secret to use for the webhook." }, "consumer_secret": { "type": "string", "description": "The consumer secret to use for the webhook." }, "timeout": { "type": "number", "minimum": 0, "description": "The timeout in seconds to wait for a response from the webhook." }, "retries": { "type": "integer", "minimum": 0, "description": "The number of times to retry sending the webhook." } } }, { "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "hyperv" ] }, "kvp_file_path": { "type": "string", "description": "The path to the KVP file to use for the hyperv reporter.", "default": "/var/lib/hyperv/.kvp_pool_1" }, "event_types": { "type": "array", "items": { "type": "string" } } } } ] } } } } } }, "allOf": [ { "$ref": "#/$defs/base_config" }, { "$ref": "#/$defs/cc_ansible" }, { "$ref": "#/$defs/cc_apk_configure" }, { "$ref": "#/$defs/cc_apt_configure" }, { "$ref": "#/$defs/cc_apt_pipelining" }, { "$ref": "#/$defs/cc_ubuntu_autoinstall" }, { "$ref": "#/$defs/cc_bootcmd" }, { "$ref": "#/$defs/cc_byobu" }, { "$ref": "#/$defs/cc_ca_certs" }, { "$ref": "#/$defs/cc_chef" }, { "$ref": "#/$defs/cc_disable_ec2_metadata" }, { "$ref": "#/$defs/cc_disk_setup" }, { "$ref": "#/$defs/cc_fan" }, { "$ref": "#/$defs/cc_final_message" }, { "$ref": "#/$defs/cc_growpart" }, { "$ref": "#/$defs/cc_grub_dpkg" }, { "$ref": "#/$defs/cc_install_hotplug" }, { "$ref": "#/$defs/cc_keyboard" }, { "$ref": "#/$defs/cc_keys_to_console" }, { "$ref": "#/$defs/cc_landscape" }, { "$ref": "#/$defs/cc_locale" }, { "$ref": "#/$defs/cc_lxd" }, { "$ref": "#/$defs/cc_mcollective" }, { "$ref": "#/$defs/cc_migrator" }, { "$ref": "#/$defs/cc_mounts" }, { "$ref": "#/$defs/cc_ntp" }, { "$ref": "#/$defs/cc_package_update_upgrade_install" }, { "$ref": "#/$defs/cc_phone_home" }, { "$ref": "#/$defs/cc_power_state_change" }, { "$ref": "#/$defs/cc_puppet" }, { "$ref": "#/$defs/cc_resizefs" }, { "$ref": "#/$defs/cc_resolv_conf" }, { "$ref": "#/$defs/cc_rh_subscription" }, { "$ref": "#/$defs/cc_rsyslog" }, { "$ref": "#/$defs/cc_runcmd" }, { "$ref": "#/$defs/cc_salt_minion" }, { "$ref": "#/$defs/cc_scripts_vendor" }, { "$ref": "#/$defs/cc_seed_random" }, { "$ref": "#/$defs/cc_set_hostname" }, { "$ref": "#/$defs/cc_set_passwords" }, { "$ref": "#/$defs/cc_snap" }, { "$ref": "#/$defs/cc_spacewalk" }, { "$ref": "#/$defs/cc_ssh_authkey_fingerprints" }, { "$ref": "#/$defs/cc_ssh_import_id" }, { "$ref": "#/$defs/cc_ssh" }, { "$ref": "#/$defs/cc_timezone" }, { "$ref": "#/$defs/cc_ubuntu_advantage" }, { "$ref": "#/$defs/cc_ubuntu_drivers" }, { "$ref": "#/$defs/cc_update_etc_hosts" }, { "$ref": "#/$defs/cc_update_hostname" }, { "$ref": "#/$defs/cc_users_groups" }, { "$ref": "#/$defs/cc_wireguard" }, { "$ref": "#/$defs/cc_write_files" }, { "$ref": "#/$defs/cc_yum_add_repo" }, { "$ref": "#/$defs/cc_zypper_add_repo" }, { "$ref": "#/$defs/reporting_config" }, { "$ref": "#/$defs/output_config" } ], "properties": { "allow_public_ssh_keys": {}, "ansible": {}, "apk_repos": {}, "apt": {}, "apt_pipelining": {}, "apt_reboot_if_required": {}, "apt_update": {}, "apt_upgrade": {}, "authkey_hash": {}, "autoinstall": {}, "bootcmd": {}, "byobu_by_default": {}, "ca-certs": {}, "ca_certs": {}, "chef": {}, "chpasswd": {}, "cloud_config_modules": {}, "cloud_final_modules": {}, "cloud_init_modules": {}, "create_hostname_file": {}, "device_aliases": {}, "disable_ec2_metadata": {}, "disable_root": {}, "disable_root_opts": {}, "disk_setup": {}, "drivers": {}, "fan": {}, "final_message": {}, "fqdn": {}, "fs_setup": {}, "groups": {}, "growpart": {}, "grub-dpkg": {}, "grub_dpkg": {}, "hostname": {}, "keyboard": {}, "landscape": {}, "launch-index": {}, "locale": {}, "locale_configfile": {}, "lxd": {}, "manage_etc_hosts": {}, "manage_resolv_conf": {}, "mcollective": {}, "merge_how": {}, "merge_type": {}, "migrate": {}, "mount_default_fields": {}, "mounts": {}, "no_ssh_fingerprints": {}, "ntp": {}, "output": {}, "package_reboot_if_required": {}, "package_update": {}, "package_upgrade": {}, "packages": {}, "password": {}, "phone_home": {}, "power_state": {}, "prefer_fqdn_over_hostname": {}, "preserve_hostname": {}, "puppet": {}, "random_seed": {}, "reporting": {}, "resize_rootfs": {}, "resolv_conf": {}, "rh_subscription": {}, "rsyslog": {}, "runcmd": {}, "salt_minion": {}, "snap": {}, "spacewalk": {}, "ssh": {}, "ssh_authorized_keys": {}, "ssh_deletekeys": {}, "ssh_fp_console_blacklist": {}, "ssh_genkeytypes": {}, "ssh_import_id": {}, "ssh_key_console_blacklist": {}, "ssh_keys": {}, "ssh_publish_hostkeys": {}, "ssh_pwauth": {}, "ssh_quiet_keygen": {}, "swap": {}, "timezone": {}, "ubuntu_advantage": {}, "updates": {}, "user": {}, "users": {}, "vendor_data": {}, "version": {}, "wireguard": {}, "write_files": {}, "yum_repo_dir": {}, "yum_repos": {}, "zypper": {} }, "additionalProperties": false }