From 01aed71ac2d60eaaa29e718b34b253d98fc2fb8e Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Thu, 25 Jul 2024 11:45:54 -0600 Subject: [PATCH] doc(schema): schema descriptions should end with trailing stop (#5562) Also emphasize ''users''. --- .../schemas/schema-cloud-config-v1.json | 326 +++++++++--------- 1 file changed, 163 insertions(+), 163 deletions(-) diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json index c05bd9942126..8fbaa1d77333 100644 --- a/cloudinit/config/schemas/schema-cloud-config-v1.json +++ b/cloudinit/config/schemas/schema-cloud-config-v1.json @@ -131,7 +131,7 @@ "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``", + "description": "Optional boolean for controlling if ua-auto-attach.service (in Ubuntu Pro instances) will be attempted each boot. Default: ``false``.", "default": false } } @@ -163,7 +163,7 @@ "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``" + "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": [ @@ -171,7 +171,7 @@ "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``" + "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": [ @@ -179,7 +179,7 @@ "null" ], "format": "uri", - "description": "HTTP Proxy URL used only for Ubuntu Pro APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" + "description": "HTTP Proxy URL used only for Ubuntu Pro APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``." }, "ua_apt_https_proxy": { "type": [ @@ -187,7 +187,7 @@ "null" ], "format": "uri", - "description": "HTTPS Proxy URL used only for Ubuntu Pro APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``" + "description": "HTTPS Proxy URL used only for Ubuntu Pro APT repositories or null to unset. Stored at ``/etc/apt/apt.conf.d/90ubuntu-advantage-aptproxy``." } } } @@ -198,7 +198,7 @@ "patternProperties": { "^.+$": { "label": "", - "description": "Optional string of single username or a list of usernames to add to the group", + "description": "Optional string of single username or a list of usernames to add to the group.", "type": [ "string", "array" @@ -239,12 +239,12 @@ }, "expiredate": { "default": null, - "description": "Optional. Date on which the user's account will be disabled. Default: ``null``", + "description": "Optional. Date on which the user's account will be disabled. Default: ``null``.", "type": "string", "format": "date" }, "gecos": { - "description": "Optional comment about the user, usually a comma-separated string of real name and contact information", + "description": "Optional comment about the user, usually a comma-separated string of real name and contact information.", "type": "string" }, "groups": { @@ -283,12 +283,12 @@ ] }, "homedir": { - "description": "Optional home dir for user. Default: ``/home/``", + "description": "Optional home dir for user. Default: ``/home/``.", "default": "``/home/``", "type": "string" }, "inactive": { - "description": "Optional string representing the number of days until the user is disabled. ", + "description": "Optional string representing the number of days until the user is disabled.", "type": "string" }, "lock-passwd": { @@ -299,7 +299,7 @@ }, "lock_passwd": { "default": true, - "description": "Disable password login. Default: ``true``", + "description": "Disable password login. Default: ``true``.", "type": "boolean" }, "no-create-home": { @@ -310,7 +310,7 @@ }, "no_create_home": { "default": false, - "description": "Do not create home directory. Default: ``false``", + "description": "Do not create home directory. Default: ``false``.", "type": "boolean" }, "no-log-init": { @@ -321,7 +321,7 @@ }, "no_log_init": { "default": false, - "description": "Do not initialize lastlog and faillog for user. Default: ``false``", + "description": "Do not initialize lastlog and faillog for user. Default: ``false``.", "type": "boolean" }, "no-user-group": { @@ -332,7 +332,7 @@ }, "no_user_group": { "default": false, - "description": "Do not create group named after user. Default: ``false``", + "description": "Do not create group named after user. Default: ``false``.", "type": "boolean" }, "passwd": { @@ -378,7 +378,7 @@ }, "primary_group": { "default": "````", - "description": "Primary group for user. Default: ````", + "description": "Primary group for user. Default: ````.", "type": "string" }, "selinux-user": { @@ -400,7 +400,7 @@ "type": "string" }, "ssh_authorized_keys": { - "description": "List of SSH keys to add to user's authkeys file. Can not be combined with ``ssh_redirect_user``", + "description": "List of SSH keys to add to user's authkeys file. Can not be combined with ``ssh_redirect_user``.", "type": "array", "items": { "type": "string" @@ -428,7 +428,7 @@ "deprecated_description": "Use ``ssh_import_id`` instead." }, "ssh_import_id": { - "description": "List of ssh ids to import for user. Can not be combined with ``ssh_redirect_user``. See the man page[1] for more details. [1] https://manpages.ubuntu.com/manpages/noble/en/man1/ssh-import-id.1.html", + "description": "List of ssh ids to import for user. Can not be combined with ``ssh_redirect_user``. See the man page[1] for more details. [1] https://manpages.ubuntu.com/manpages/noble/en/man1/ssh-import-id.1.html.", "type": "array", "items": { "type": "string" @@ -478,7 +478,7 @@ ] }, "uid": { - "description": "The user's ID. Default value [system default]", + "description": "The user's ID. Default value [system default].", "oneOf": [ { "type": "integer" @@ -548,7 +548,7 @@ "deprecated_description": "Use ``remove_defaults`` instead." }, "remove_defaults": { - "description": "Remove default CA certificates if true. Default: ``false``", + "description": "Remove default CA certificates if true. Default: ``false``.", "type": "boolean", "default": false }, @@ -670,7 +670,7 @@ "type": "object", "properties": { "autoinstall": { - "description": "Opaque autoinstall schema definition for Ubuntu autoinstall. Full schema processed by live-installer. See: https://ubuntu.com/server/docs/install/autoinstall-reference", + "description": "Opaque autoinstall schema definition for Ubuntu autoinstall. Full schema processed by live-installer. See: https://ubuntu.com/server/docs/install/autoinstall-reference.", "type": "object", "properties": { "version": { @@ -713,7 +713,7 @@ "distro", "pip" ], - "description": "The type of installation for ansible. It can be one of the following values:\n- ``distro``\n- ``pip``" + "description": "The type of installation for ansible. It can be one of the following values:\n- ``distro``\n- ``pip``." }, "run_user": { "type": "string", @@ -973,7 +973,7 @@ "base_url": { "type": "string", "default": "https://alpine.global.ssl.fastly.net/alpine", - "description": "The base URL of an Alpine repository, or mirror, to download official packages from. If not specified then it defaults to ``https://alpine.global.ssl.fastly.net/alpine``" + "description": "The base URL of an Alpine repository, or mirror, to download official packages from. If not specified then it defaults to ``https://alpine.global.ssl.fastly.net/alpine``." }, "community_enabled": { "type": "boolean", @@ -987,7 +987,7 @@ }, "version": { "type": "string", - "description": "The Alpine version to use (e.g. ``v3.12`` or ``edge``)" + "description": "The Alpine version to use (e.g. ``v3.12`` or ``edge``)." } }, "required": [ @@ -997,7 +997,7 @@ }, "local_repo_base_url": { "type": "string", - "description": "The base URL of an Alpine repository containing unofficial packages" + "description": "The base URL of an Alpine repository containing unofficial packages." } } } @@ -1026,16 +1026,16 @@ }, "primary": { "$ref": "#/$defs/apt_configure.mirror", - "description": "The primary and security archive mirrors can be specified using the ``primary`` and ``security`` keys, respectively. Both the ``primary`` and ``security`` keys take a list of configs, allowing mirrors to be specified on a per-architecture basis. Each config is a dictionary which must have an entry for ``arches``, specifying which architectures that config entry is for. The keyword ``default`` applies to any architecture not explicitly listed. The mirror url can be specified with the ``uri`` key, or a list of mirrors to check can be provided in order, with the first mirror that can be resolved being selected. This allows the same configuration to be used in different environment, with different hosts used for a local APT mirror. If no mirror is provided by ``uri`` or ``search``, ``search_dns`` may be used to search for dns names in the format ``-mirror`` in each of the following:\n- fqdn of this host per cloud metadata,\n- localdomain,\n- domains listed in ``/etc/resolv.conf``.\n\nIf there is a dns entry for ``-mirror``, then it is assumed that there is a distro mirror at ``http://-mirror./``. If the ``primary`` key is defined, but not the ``security`` key, then then configuration for ``primary`` is also used for ``security``. If ``search_dns`` is used for the ``security`` key, the search pattern will be ``-security-mirror``.\n\nEach mirror may also specify a key to import via any of the following optional keys:\n- ``keyid``: a key to import via shortid or fingerprint.\n- ``key``: a raw PGP key.\n- ``keyserver``: alternate keyserver to pull ``keyid`` key from.\n\nIf no mirrors are specified, or all lookups fail, then default mirrors defined in the datasource are used. If none are present in the datasource either the following defaults are used:\n- ``primary`` => ``http://archive.ubuntu.com/ubuntu``.\n- ``security`` => ``http://security.ubuntu.com/ubuntu``" + "description": "The primary and security archive mirrors can be specified using the ``primary`` and ``security`` keys, respectively. Both the ``primary`` and ``security`` keys take a list of configs, allowing mirrors to be specified on a per-architecture basis. Each config is a dictionary which must have an entry for ``arches``, specifying which architectures that config entry is for. The keyword ``default`` applies to any architecture not explicitly listed. The mirror url can be specified with the ``uri`` key, or a list of mirrors to check can be provided in order, with the first mirror that can be resolved being selected. This allows the same configuration to be used in different environment, with different hosts used for a local APT mirror. If no mirror is provided by ``uri`` or ``search``, ``search_dns`` may be used to search for dns names in the format ``-mirror`` in each of the following:\n- fqdn of this host per cloud metadata,\n- localdomain,\n- domains listed in ``/etc/resolv.conf``.\n\nIf there is a dns entry for ``-mirror``, then it is assumed that there is a distro mirror at ``http://-mirror./``. If the ``primary`` key is defined, but not the ``security`` key, then then configuration for ``primary`` is also used for ``security``. If ``search_dns`` is used for the ``security`` key, the search pattern will be ``-security-mirror``.\n\nEach mirror may also specify a key to import via any of the following optional keys:\n- ``keyid``: a key to import via shortid or fingerprint.\n- ``key``: a raw PGP key.\n- ``keyserver``: alternate keyserver to pull ``keyid`` key from.\n\nIf no mirrors are specified, or all lookups fail, then default mirrors defined in the datasource are used. If none are present in the datasource either the following defaults are used:\n- ``primary`` => ``http://archive.ubuntu.com/ubuntu``.\n- ``security`` => ``http://security.ubuntu.com/ubuntu``." }, "security": { "$ref": "#/$defs/apt_configure.mirror", - "description": "Please refer to the primary config documentation" + "description": "Please refer to the primary config documentation." }, "add_apt_repo_match": { "type": "string", "default": "^[\\w-]+:\\w", - "description": "All source entries in ``apt-sources`` that match regex in ``add_apt_repo_match`` will be added to the system using ``add-apt-repository``. If ``add_apt_repo_match`` is not specified, it defaults to ``^[\\w-]+:\\w``" + "description": "All source entries in ``apt-sources`` that match regex in ``add_apt_repo_match`` will be added to the system using ``add-apt-repository``. If ``add_apt_repo_match`` is not specified, it defaults to ``^[\\w-]+:\\w``." }, "debconf_selections": { "type": "object", @@ -1046,7 +1046,7 @@ "type": "string" } }, - "description": "Debconf additional configurations can be specified as a dictionary under the ``debconf_selections`` config key, with each key in the dict representing a different set of configurations. The value of each key must be a string containing all the debconf configurations that must be applied. We will bundle all of the values and pass them to ``debconf-set-selections``. Therefore, each value line must be a valid entry for ``debconf-set-selections``, meaning that they must possess for distinct fields:\n\n``pkgname question type answer``\n\nWhere:\n- ``pkgname`` is the name of the package.\n- ``question`` the name of the questions.\n- ``type`` is the type of question.\n- ``answer`` is the value used to answer the question.\n\nFor example: ``ippackage ippackage/ip string 127.0.01``" + "description": "Debconf additional configurations can be specified as a dictionary under the ``debconf_selections`` config key, with each key in the dict representing a different set of configurations. The value of each key must be a string containing all the debconf configurations that must be applied. We will bundle all of the values and pass them to ``debconf-set-selections``. Therefore, each value line must be a valid entry for ``debconf-set-selections``, meaning that they must possess for distinct fields:\n\n``pkgname question type answer``\n\nWhere:\n- ``pkgname`` is the name of the package.\n- ``question`` the name of the questions.\n- ``type`` is the type of question.\n- ``answer`` is the value used to answer the question.\n\nFor example: ``ippackage ippackage/ip string 127.0.01``." }, "sources_list": { "type": "string", @@ -1228,12 +1228,12 @@ "validation_key": { "type": "string", "default": "/etc/chef/validation.pem", - "description": "Optional path for validation_cert. default to ``/etc/chef/validation.pem``" + "description": "Optional path for validation_cert. Default: ``/etc/chef/validation.pem``." }, "firstboot_path": { "type": "string", "default": "/etc/chef/firstboot.json", - "description": "Path to write run_list and initial_attributes keys that should also be present in this configuration, defaults to ``/etc/chef/firstboot.json``" + "description": "Path to write run_list and initial_attributes keys that should also be present in this configuration. Default: ``/etc/chef/firstboot.json``." }, "exec": { "type": "boolean", @@ -1305,12 +1305,12 @@ }, "server_url": { "type": "string", - "description": "The URL for the chef server" + "description": "The URL for the chef server." }, "show_time": { "type": "boolean", "default": true, - "description": "Show time in chef logs" + "description": "Show time in chef logs." }, "ssl_verify_mode": { "type": "string", @@ -1352,7 +1352,7 @@ }, "chef_license": { "type": "string", - "description": "string that indicates if user accepts or not license related to some of chef products. See https://docs.chef.io/licensing/accept/", + "description": "string that indicates if user accepts or not license related to some of chef products. See https://docs.chef.io/licensing/accept/.", "enum": [ "accept", "accept-silent", @@ -1368,7 +1368,7 @@ "properties": { "disable_ec2_metadata": { "default": false, - "description": "Set true to disable IPv4 routes to EC2 metadata. Default: ``false``", + "description": "Set true to disable IPv4 routes to EC2 metadata. Default: ``false``.", "type": "boolean" } } @@ -1448,7 +1448,7 @@ "overwrite": { "type": "boolean", "default": false, - "description": "Controls whether this module tries to be safe about writing partition tables or not. If ``overwrite: false`` is set, the device will be checked for a partition table and for a file system and if either is found, the operation will be skipped. If ``overwrite: true`` is set, no checks will be performed. Using ``overwrite: true`` is **dangerous** and can lead to data loss, so double check that the correct device has been specified if using this option. Default: ``false``" + "description": "Controls whether this module tries to be safe about writing partition tables or not. If ``overwrite: false`` is set, the device will be checked for a partition table and for a file system and if either is found, the operation will be skipped. If ``overwrite: true`` is set, no checks will be performed. Using ``overwrite: true`` is **dangerous** and can lead to data loss, so double check that the correct device has been specified if using this option. Default: ``false``." } } } @@ -1466,7 +1466,7 @@ }, "filesystem": { "type": "string", - "description": "Filesystem type to create. E.g., ``ext4`` or ``btrfs``" + "description": "Filesystem type to create. E.g., ``ext4`` or ``btrfs``." }, "device": { "type": "string", @@ -1491,7 +1491,7 @@ }, "overwrite": { "type": "boolean", - "description": "If ``true``, overwrite any existing filesystem. Using ``overwrite: true`` for filesystems is **dangerous** and can lead to data loss, so double check the entry in ``fs_setup``. Default: ``false``" + "description": "If ``true``, overwrite any existing filesystem. Using ``overwrite: true`` for filesystems is **dangerous** and can lead to data loss, so double check the entry in ``fs_setup``. Default: ``false``." }, "replace_fs": { "type": "string", @@ -1534,12 +1534,12 @@ "properties": { "config": { "type": "string", - "description": "The fan configuration to use as a single multi-line string" + "description": "The fan configuration to use as a single multi-line string." }, "config_path": { "type": "string", "default": "/etc/network/fan", - "description": "The path to write the fan configuration to. Default: ``/etc/network/fan``" + "description": "The path to write the fan configuration to. Default: ``/etc/network/fan``." } } } @@ -1550,7 +1550,7 @@ "properties": { "final_message": { "type": "string", - "description": "The message to display at the end of the run" + "description": "The message to display at the end of the run." } } }, @@ -1563,7 +1563,7 @@ "properties": { "mode": { "default": "auto", - "description": "The utility to use for resizing. Default: ``auto``\n\nPossible options:\n\n* ``auto`` - Use any available utility\n\n* ``growpart`` - Use growpart utility\n\n* ``gpart`` - Use BSD gpart utility\n\n* ``'off'`` - Take no action", + "description": "The utility to use for resizing. Default: ``auto``\n\nPossible options:\n\n* ``auto`` - Use any available utility\n\n* ``growpart`` - Use growpart utility\n\n* ``gpart`` - Use BSD gpart utility\n\n* ``'off'`` - Take no action.", "oneOf": [ { "enum": [ @@ -1591,12 +1591,12 @@ "items": { "type": "string" }, - "description": "The devices to resize. Each entry can either be the path to the device's mountpoint in the filesystem or a path to the block device in '/dev'. Default: ``[/]``" + "description": "The devices to resize. Each entry can either be the path to the device's mountpoint in the filesystem or a path to the block device in '/dev'. Default: ``[/]``." }, "ignore_growroot_disabled": { "type": "boolean", "default": false, - "description": "If ``true``, ignore the presence of ``/etc/growroot-disabled``. If ``false`` and the file exists, then don't resize. Default: ``false``" + "description": "If ``true``, ignore the presence of ``/etc/growroot-disabled``. If ``false`` and the file exists, then don't resize. Default: ``false``." } } } @@ -1612,14 +1612,14 @@ "enabled": { "type": "boolean", "default": true, - "description": "Whether to configure which device is used as the target for grub installation. Default: ``true``" + "description": "Whether to configure which device is used as the target for grub installation. Default: ``true``." }, "grub-pc/install_devices": { "type": "string", - "description": "Device to use as target for grub installation. If unspecified, ``grub-probe`` of ``/boot`` will be used to find the device" + "description": "Device to use as target for grub installation. If unspecified, ``grub-probe`` of ``/boot`` will be used to find the device." }, "grub-pc/install_devices_empty": { - "description": "Sets values for ``grub-pc/install_devices_empty``. If unspecified, will be set to ``true`` if ``grub-pc/install_devices`` is empty, otherwise ``false``", + "description": "Sets values for ``grub-pc/install_devices_empty``. If unspecified, will be set to ``true`` if ``grub-pc/install_devices`` is empty, otherwise ``false``.", "oneOf": [ { "type": "boolean" @@ -1634,7 +1634,7 @@ }, "grub-efi/install_devices": { "type": "string", - "description": "Partition to use as target for grub installation. If unspecified, ``grub-probe`` of ``/boot/efi`` will be used to find the partition" + "description": "Partition to use as target for grub installation. If unspecified, ``grub-probe`` of ``/boot/efi`` will be used to find the partition." } } }, @@ -1825,11 +1825,11 @@ "properties": { "locale": { "type": "string", - "description": "The locale to set as the system's locale (e.g. ar_PS)" + "description": "The locale to set as the system's locale (e.g. ar_PS)." }, "locale_configfile": { "type": "string", - "description": "The file in which to write the locale configuration (defaults to the distro's default location)" + "description": "The file in which to write the locale configuration (defaults to the distro's default location)." } } }, @@ -1848,7 +1848,7 @@ "properties": { "network_address": { "type": "string", - "description": "IP address for LXD to listen on" + "description": "IP address for LXD to listen on." }, "network_port": { "type": "integer", @@ -1867,19 +1867,19 @@ }, "storage_create_device": { "type": "string", - "description": "Setup device based storage using DEVICE" + "description": "Setup device based storage using DEVICE." }, "storage_create_loop": { "type": "integer", - "description": "Setup loop based storage with SIZE in GB" + "description": "Setup loop based storage with SIZE in GB." }, "storage_pool": { "type": "string", - "description": "Name of storage pool to use or create" + "description": "Name of storage pool to use or create." }, "trust_password": { "type": "string", - "description": "The password required to add new clients" + "description": "The password required to add new clients." } } }, @@ -1907,7 +1907,7 @@ }, "mtu": { "type": "integer", - "description": "Bridge MTU, defaults to LXD's default value", + "description": "Bridge MTU, defaults to LXD's default value.", "default": -1, "minimum": -1 }, @@ -1976,11 +1976,11 @@ "properties": { "public-cert": { "type": "string", - "description": "Optional value of server public certificate which will be written to ``/etc/mcollective/ssl/server-public.pem``" + "description": "Optional value of server public certificate which will be written to ``/etc/mcollective/ssl/server-public.pem``." }, "private-cert": { "type": "string", - "description": "Optional value of server private certificate which will be written to ``/etc/mcollective/ssl/server-private.pem``" + "description": "Optional value of server private certificate which will be written to ``/etc/mcollective/ssl/server-private.pem``." } }, "patternProperties": { @@ -2022,7 +2022,7 @@ }, "mount_default_fields": { "type": "array", - "description": "Default mount configuration for any mount entry with less than 6 options provided. When specified, 6 items are required and represent ``/etc/fstab`` entries. Default: ``defaults,nofail,x-systemd.after=cloud-init.service,_netdev``", + "description": "Default mount configuration for any mount entry with less than 6 options provided. When specified, 6 items are required and represent ``/etc/fstab`` entries. Default: ``defaults,nofail,x-systemd.after=cloud-init.service,_netdev``.", "default": [ null, null, @@ -2050,10 +2050,10 @@ "properties": { "filename": { "type": "string", - "description": "Path to the swap file to create" + "description": "Path to the swap file to create." }, "size": { - "description": "The size in bytes of the swap file, 'auto' or a human-readable size abbreviation of the format where units are one of B, K, M, G or T. **WARNING: Attempts to use IEC prefixes in your configuration prior to cloud-init version 23.1 will result in unexpected behavior. SI prefixes names (KB, MB) are required on pre-23.1 cloud-init, however IEC values are used. In summary, assume 1KB == 1024B, not 1000B**", + "description": "The size in bytes of the swap file, 'auto' or a human-readable size abbreviation of the format where units are one of B, K, M, G or T. **WARNING: Attempts to use IEC prefixes in your configuration prior to cloud-init version 23.1 will result in unexpected behavior. SI prefixes names (KB, MB) are required on pre-23.1 cloud-init, however IEC values are used. In summary, assume 1KB == 1024B, not 1000B**.", "oneOf": [ { "enum": [ @@ -2079,7 +2079,7 @@ "pattern": "^([0-9]+)?\\.?[0-9]+[BKMGT]$" } ], - "description": "The maxsize in bytes of the swap file" + "description": "The maxsize in bytes of the swap file." } } } @@ -2128,7 +2128,7 @@ "type": "string" }, "uniqueItems": true, - "description": "List of CIDRs to allow" + "description": "List of CIDRs to allow." }, "ntp_client": { "type": "string", @@ -2138,7 +2138,7 @@ "enabled": { "type": "boolean", "default": true, - "description": "Attempt to enable ntp clients if set to True. If set to ``false``, ntp client will not be configured or installed" + "description": "Attempt to enable ntp clients if set to True. If set to ``false``, ntp client will not be configured or installed." }, "config": { "description": "Configuration settings or overrides for the ``ntp_client`` specified.", @@ -2212,17 +2212,17 @@ "package_update": { "type": "boolean", "default": false, - "description": "Set ``true`` to update packages. Happens before upgrade or install. Default: ``false``" + "description": "Set ``true`` to update packages. Happens before upgrade or install. Default: ``false``." }, "package_upgrade": { "type": "boolean", "default": false, - "description": "Set ``true`` to upgrade packages. Happens before install. Default: ``false``" + "description": "Set ``true`` to upgrade packages. Happens before install. Default: ``false``." }, "package_reboot_if_required": { "type": "boolean", "default": false, - "description": "Set ``true`` to reboot the system if required by presence of `/var/run/reboot-required`. Default: ``false``" + "description": "Set ``true`` to reboot the system if required by presence of `/var/run/reboot-required`. Default: ``false``." }, "apt_update": { "type": "boolean", @@ -2260,7 +2260,7 @@ "description": "The URL to send the phone home data to." }, "post": { - "description": "A list of keys to post or ``all``. Default: ``all``", + "description": "A list of keys to post or ``all``. Default: ``all``.", "oneOf": [ { "enum": [ @@ -2285,7 +2285,7 @@ }, "tries": { "type": "integer", - "description": "The number of times to try sending the phone home data. Default: ``10``", + "description": "The number of times to try sending the phone home data. Default: ``10``.", "default": 10 } } @@ -2303,7 +2303,7 @@ "additionalProperties": false, "properties": { "delay": { - "description": "Time in minutes to delay after cloud-init has finished. Can be ``now`` or an integer specifying the number of minutes to delay. Default: ``now``", + "description": "Time in minutes to delay after cloud-init has finished. Can be ``now`` or an integer specifying the number of minutes to delay. Default: ``now``.", "default": "now", "oneOf": [ { @@ -2338,12 +2338,12 @@ "type": "string" }, "timeout": { - "description": "Time in seconds to wait for the cloud-init process to finish before executing shutdown. Default: ``30``", + "description": "Time in seconds to wait for the cloud-init process to finish before executing shutdown. Default: ``30``.", "type": "integer", "default": 30 }, "condition": { - "description": "Apply state change only if condition is met. May be boolean true (always met), false (never met), or a command string or list to be executed. For command formatting, see the documentation for ``cc_runcmd``. If exit code is 0, condition is met, otherwise not. Default: ``true``", + "description": "Apply state change only if condition is met. May be boolean true (always met), false (never met), or a command string or list to be executed. For command formatting, see the documentation for ``cc_runcmd``. If exit code is 0, condition is met, otherwise not. Default: ``true``.", "default": true, "oneOf": [ { @@ -2371,7 +2371,7 @@ "install": { "type": "boolean", "default": true, - "description": "Whether or not to install puppet. Setting to ``false`` will result in an error if puppet is not already present on the system. Default: ``true``" + "description": "Whether or not to install puppet. Setting to ``false`` will result in an error if puppet is not already present on the system. Default: ``true``." }, "version": { "type": "string", @@ -2379,7 +2379,7 @@ }, "install_type": { "type": "string", - "description": "Valid values are ``packages`` and ``aio``. Agent packages from the puppetlabs repositories can be installed by setting ``aio``. Based on this setting, the default config/SSL/CSR paths will be adjusted accordingly. Default: ``packages``", + "description": "Valid values are ``packages`` and ``aio``. Agent packages from the puppetlabs repositories can be installed by setting ``aio``. Based on this setting, the default config/SSL/CSR paths will be adjusted accordingly. Default: ``packages``.", "enum": [ "packages", "aio" @@ -2397,32 +2397,32 @@ "cleanup": { "type": "boolean", "default": true, - "description": "Whether to remove the puppetlabs repo after installation if ``install_type`` is ``aio`` Default: ``true``" + "description": "Whether to remove the puppetlabs repo after installation if ``install_type`` is ``aio`` Default: ``true``." }, "conf_file": { "type": "string", - "description": "The path to the puppet config file. Default depends on ``install_type``" + "description": "The path to the puppet config file. Default depends on ``install_type``." }, "ssl_dir": { "type": "string", - "description": "The path to the puppet SSL directory. Default depends on ``install_type``" + "description": "The path to the puppet SSL directory. Default depends on ``install_type``." }, "csr_attributes_path": { "type": "string", - "description": "The path to the puppet csr attributes file. Default depends on ``install_type``" + "description": "The path to the puppet csr attributes file. Default depends on ``install_type``." }, "package_name": { "type": "string", - "description": "Name of the package to install if ``install_type`` is ``packages``. Default: ``puppet``" + "description": "Name of the package to install if ``install_type`` is ``packages``. Default: ``puppet``." }, "exec": { "type": "boolean", "default": false, - "description": "Whether or not to run puppet after configuration finishes. A single manual run can be triggered by setting ``exec`` to ``true``, and additional arguments can be passed to ``puppet agent`` via the ``exec_args`` key (by default the agent will execute with the ``--test`` flag). Default: ``false``" + "description": "Whether or not to run puppet after configuration finishes. A single manual run can be triggered by setting ``exec`` to ``true``, and additional arguments can be passed to ``puppet agent`` via the ``exec_args`` key (by default the agent will execute with the ``--test`` flag). Default: ``false``." }, "exec_args": { "type": "array", - "description": "A list of arguments to pass to 'puppet agent' if 'exec' is true Default: ``['--test']``", + "description": "A list of arguments to pass to 'puppet agent' if 'exec' is true Default: ``['--test']``.", "items": { "type": "string" } @@ -2430,7 +2430,7 @@ "start_service": { "type": "boolean", "default": true, - "description": "By default, the puppet service will be automatically enabled after installation and set to automatically start on boot. To override this in favor of manual puppet execution set ``start_service`` to ``false``" + "description": "By default, the puppet service will be automatically enabled after installation and set to automatically start on boot. To override this in favor of manual puppet execution set ``start_service`` to ``false``." }, "conf": { "type": "object", @@ -2456,7 +2456,7 @@ }, "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", + "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": { @@ -2480,7 +2480,7 @@ false, "noblock" ], - "description": "Whether to resize the root partition. ``noblock`` will resize in the background. Default: ``true``" + "description": "Whether to resize the root partition. ``noblock`` will resize in the background. Default: ``true``." } } }, @@ -2490,7 +2490,7 @@ "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``" + "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", @@ -2498,23 +2498,23 @@ "properties": { "nameservers": { "type": "array", - "description": "A list of nameservers to use to be added as ``nameserver`` lines" + "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" + "description": "A list of domains to be added ``search`` line." }, "domain": { "type": "string", - "description": "The domain to be added as ``domain`` line" + "description": "The domain to be added as ``domain`` line." }, "sortlist": { "type": "array", - "description": "A list of IP addresses to be added to ``sortlist`` line" + "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``" + "description": "Key/value pairs of options to go under ``options`` heading. A unary option should be specified as ``true``." } } } @@ -2529,18 +2529,18 @@ "properties": { "username": { "type": "string", - "description": "The username to use. Must be used with password. Should not be used with ``activation-key`` or ``org``" + "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``" + "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``" + "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``", + "description": "The organization to use. Must be used with ``activation-key``. Should not be used with ``username`` or ``password``.", "oneOf": [ { "type": "string" @@ -2555,40 +2555,40 @@ }, "auto-attach": { "type": "boolean", - "description": "Whether to attach subscriptions automatically" + "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" + "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", + "description": "A list of pools ids add to the subscription.", "items": { "type": "string" } }, "enable-repo": { "type": "array", - "description": "A list of repositories to enable", + "description": "A list of repositories to enable.", "items": { "type": "string" } }, "disable-repo": { "type": "array", - "description": "A list of repositories to disable", + "description": "A list of repositories to disable.", "items": { "type": "string" } }, "rhsm-baseurl": { "type": "string", - "description": "Sets the baseurl in ``/etc/rhsm/rhsm.conf``" + "description": "Sets the baseurl in ``/etc/rhsm/rhsm.conf``." }, "server-hostname": { "type": "string", - "description": "Sets the serverurl in ``/etc/rhsm/rhsm.conf``" + "description": "Sets the serverurl in ``/etc/rhsm/rhsm.conf``." } } } @@ -2603,11 +2603,11 @@ "properties": { "config_dir": { "type": "string", - "description": "The directory where rsyslog configuration files will be written. Default: ``/etc/rsyslog.d``" + "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``" + "description": "The name of the rsyslog configuration file. Default: ``20-cloud-config.conf``." }, "configs": { "type": "array", @@ -2657,12 +2657,12 @@ }, "install_rsyslog": { "default": false, - "description": "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``" + "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", @@ -2670,7 +2670,7 @@ "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]``" + "description": "List of packages needed to be installed for rsyslog. This is only used if ``install_rsyslog`` is ``true``. Default: ``[rsyslog]``." } } } @@ -2710,35 +2710,35 @@ "properties": { "pkg_name": { "type": "string", - "description": "Package name to install. Default: ``salt-minion``" + "description": "Package name to install. Default: ``salt-minion``." }, "service_name": { "type": "string", - "description": "Service name to enable. Default: ``salt-minion``" + "description": "Service name to enable. Default: ``salt-minion``." }, "config_dir": { "type": "string", - "description": "Directory to write config files to. Default: ``/etc/salt``" + "description": "Directory to write config files to. Default: ``/etc/salt``." }, "conf": { "type": "object", - "description": "Configuration to be written to `config_dir`/minion" + "description": "Configuration to be written to `config_dir`/minion." }, "grains": { "type": "object", - "description": "Configuration to be written to `config_dir`/grains" + "description": "Configuration to be written to `config_dir`/grains." }, "public_key": { "type": "string", - "description": "Public key to be used by the salt minion" + "description": "Public key to be used by the salt minion." }, "private_key": { "type": "string", - "description": "Private key to be used by salt minion" + "description": "Private key to be used by salt minion." }, "pki_dir": { "type": "string", - "description": "Directory to write key files. Default: `config_dir`/pki/minion" + "description": "Directory to write key files. Default: `config_dir`/pki/minion." } } } @@ -2752,7 +2752,7 @@ "additionalProperties": false, "properties": { "enabled": { - "description": "Whether vendor data is enabled or not. Default: ``true``", + "description": "Whether vendor data is enabled or not. Default: ``true``.", "oneOf": [ { "type": "boolean", @@ -2777,7 +2777,7 @@ "integer" ] }, - "description": "The command to run before any vendor scripts. Its primary use case is for profiling a script, not to prevent its run" + "description": "The command to run before any vendor scripts. Its primary use case is for profiling a script, not to prevent its run." } } } @@ -2793,11 +2793,11 @@ "file": { "type": "string", "default": "/dev/urandom", - "description": "File to write random data to. 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 multi-line value or specifying binary data, be sure to follow YAML syntax and use the ``|`` and ``!binary`` YAML format specifiers when appropriate" + "description": "This data will be written to ``file`` before data from the datasource. When using a multi-line value or specifying binary data, be sure to follow YAML syntax and use the ``|`` and ``!binary`` YAML format specifiers when appropriate." }, "encoding": { "type": "string", @@ -2809,7 +2809,7 @@ "gzip", "gz" ], - "description": "Used to decode ``data`` provided. Allowed values are ``raw``, ``base64``, ``b64``, ``gzip``, or ``gz``. Default: ``raw``" + "description": "Used to decode ``data`` provided. Allowed values are ``raw``, ``base64``, ``b64``, ``gzip``, or ``gz``. Default: ``raw``." }, "command": { "type": "array", @@ -2821,7 +2821,7 @@ "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``" + "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``." } } } @@ -2833,24 +2833,24 @@ "preserve_hostname": { "type": "boolean", "default": false, - "description": "If true, the hostname will not be changed. Default: ``false``" + "description": "If true, the hostname will not be changed. Default: ``false``." }, "hostname": { "type": "string", - "description": "The hostname to set" + "description": "The hostname to set." }, "fqdn": { "type": "string", - "description": "The fully qualified domain name to set" + "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" + "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``" + "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``." } } }, @@ -2878,7 +2878,7 @@ "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``" + "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``. Randomly generated passwords may be insecure, use at your own risk.", @@ -2953,7 +2953,7 @@ }, "password": { "type": "string", - "description": "Set the default user's password. Ignored if ``chpasswd`` ``list`` is used" + "description": "Set the default user's password. Ignored if ``chpasswd`` ``list`` is used." } } }, @@ -2987,7 +2987,7 @@ "object", "array" ], - "description": "Snap commands to run on the target system", + "description": "Snap commands to run on the target system.", "items": { "oneOf": [ { @@ -3031,15 +3031,15 @@ "properties": { "server": { "type": "string", - "description": "The Spacewalk server to use" + "description": "The Spacewalk server to use." }, "proxy": { "type": "string", - "description": "The proxy to use when connecting to Spacewalk" + "description": "The proxy to use when connecting to Spacewalk." }, "activation_key": { "type": "string", - "description": "The activation key to use when registering with Spacewalk" + "description": "The activation key to use when registering with Spacewalk." } } } @@ -3051,12 +3051,12 @@ "no_ssh_fingerprints": { "type": "boolean", "default": false, - "description": "If true, SSH fingerprints will not be written. 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``" + "description": "The hash type to use when generating SSH fingerprints. Default: ``sha256``." } } }, @@ -3067,7 +3067,7 @@ "type": "array", "items": { "type": "string", - "description": "The SSH public key to import" + "description": "The SSH public key to import." } } } @@ -3089,7 +3089,7 @@ "ssh_authorized_keys": { "type": "array", "minItems": 1, - "description": "The SSH public keys to add ``.ssh/authorized_keys`` in the default user's home directory", + "description": "The SSH public keys to add ``.ssh/authorized_keys`` in the default user's home directory.", "items": { "type": "string" } @@ -3097,11 +3097,11 @@ "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``" + "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, ecdsa, ed25519]``", + "description": "The SSH key types to generate. Default: ``[rsa, ecdsa, ed25519]``.", "default": [ "ecdsa", "ed25519", @@ -3120,22 +3120,22 @@ "disable_root": { "type": "boolean", "default": true, - "description": "Disable root login. 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\"``" + "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``" + "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``" + "description": "If ``true``, will suppress the output of key generation to the console. Default: ``false``." }, "ssh_publish_hostkeys": { "type": "object", @@ -3144,11 +3144,11 @@ "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``" + "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: ``[]`` to publish all SSH key types", + "description": "The SSH key types to ignore when publishing. Default: ``[]`` to publish all SSH key types.", "items": { "type": "string" } @@ -3162,7 +3162,7 @@ "properties": { "timezone": { "type": "string", - "description": "The timezone to use as represented in /usr/share/zoneinfo" + "description": "The timezone to use as represented in /usr/share/zoneinfo." } } }, @@ -3213,7 +3213,7 @@ "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``", + "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": [ @@ -3258,7 +3258,7 @@ "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``" + "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``." } } }, @@ -3294,7 +3294,7 @@ "$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." + "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": [ @@ -3338,11 +3338,11 @@ "properties": { "name": { "type": "string", - "description": "Name of the interface. Typically wgx (example: wg0)" + "description": "Name of the interface. Typically wgx (example: wg0)." }, "config_path": { "type": "string", - "description": "Path to configuration file of Wireguard interface" + "description": "Path to configuration file of Wireguard interface." }, "content": { "type": "string", @@ -3384,16 +3384,16 @@ "properties": { "path": { "type": "string", - "description": "Path of the file to which ``content`` is decoded and written" + "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: ``''``" + "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: ``''``." }, "source": { "type": "object", - "description": "Optional specification for content loading from an arbitrary URI", + "description": "Optional specification for content loading from an arbitrary URI.", "additionalProperties": false, "properties": { "uri": { @@ -3403,7 +3403,7 @@ }, "headers": { "type": "object", - "description": "Optional HTTP headers to accompany load request, if applicable", + "description": "Optional HTTP headers to accompany load request, if applicable.", "additionalProperties": { "type": "string" } @@ -3416,12 +3416,12 @@ "owner": { "type": "string", "default": "root:root", - "description": "Optional owner:group to chown on the file and new directories. 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``" + "description": "Optional file permissions to set on ``path`` represented as an octal string '0###'. Default: ``0o644``." }, "encoding": { "type": "string", @@ -3437,7 +3437,7 @@ "base64", "text/plain" ], - "description": "Optional encoding type of the content. Default: ``text/plain``. No decoding is performed by default. Supported encoding types are: gz, gzip, gz+base64, gzip+base64, gz+b64, gzip+b64, b64, base64" + "description": "Optional encoding type of the content. Default: ``text/plain``. No decoding is performed by default. Supported encoding types are: gz, gzip, gz+base64, gzip+base64, gz+b64, gzip+b64, b64, base64." }, "append": { "type": "boolean", @@ -3461,7 +3461,7 @@ "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``" + "description": "The repo parts directory where individual yum repo config files will be written. Default: ``/etc/yum.repos.d``." }, "yum_repos": { "type": "object", @@ -3477,17 +3477,17 @@ "baseurl": { "type": "string", "format": "uri", - "description": "URL to the directory where the yum repository's 'repodata' directory lives" + "description": "URL to the directory where the yum repository's 'repodata' directory lives." }, "metalink": { "type": "string", "format": "uri", - "description": "Specifies a URL to a metalink file for the repomd.xml" + "description": "Specifies a URL to a metalink file for the repomd.xml." }, "mirrorlist": { "type": "string", "format": "uri", - "description": "Specifies a URL to a file containing a baseurls list" + "description": "Specifies a URL to a file containing a baseurls list." }, "name": { "type": "string", @@ -3513,7 +3513,7 @@ "type": "string" } ], - "description": "Any supported yum repository configuration options will be written to the yum repo config file. See: man yum.conf" + "description": "Any supported yum repository configuration options will be written to the yum repo config file. See: man yum.conf." } }, "anyOf": [ @@ -3559,7 +3559,7 @@ "baseurl": { "type": "string", "format": "uri", - "description": "The base repositoy URL" + "description": "The base repositoy URL." } }, "required": [ @@ -3571,7 +3571,7 @@ }, "config": { "type": "object", - "description": "Any supported zypo.conf key is written to ``/etc/zypp/zypp.conf``" + "description": "Any supported zypo.conf key is written to ``/etc/zypp/zypp.conf``." } } } @@ -3585,7 +3585,7 @@ }, { "type": "array", - "description": "A list specifying filepath operation configuration for stdout and stderror", + "description": "A list specifying filepath operation configuration for stdout and stderror.", "items": { "type": [ "string"