From 486d2f153fe947887b799126b64592b71ec94155 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Sat, 10 Jul 2021 20:59:18 +0200 Subject: [PATCH] Update cdist beta docs --- .../beta/_sources/cdist-reference.rst.txt | 2 + .../manual/beta/_sources/cdist-scan.rst.txt | 82 +++ .../manual/beta/_sources/cdist-types.rst.txt | 2 + src/extra/manual/beta/_sources/index.rst.txt | 1 + .../manual/beta/_sources/man1/cdist.rst.txt | 27 + .../_sources/man7/cdist-type__apt_key.rst.txt | 84 ++- ...cdist-type__debconf_set_selections.rst.txt | 51 +- .../man7/cdist-type__download.rst.txt | 31 +- .../man7/cdist-type__postgres_conf.rst.txt | 60 +++ .../cdist-type__postgres_extension.rst.txt | 55 +- .../man7/cdist-type__snakeoil_cert.rst.txt | 60 +++ .../beta/_static/documentation_options.js | 2 +- .../manual/beta/cdist-best-practice.html | 83 +-- src/extra/manual/beta/cdist-bootstrap.html | 23 +- src/extra/manual/beta/cdist-cache.html | 47 +- .../manual/beta/cdist-configuration.html | 23 +- src/extra/manual/beta/cdist-explorer.html | 27 +- src/extra/manual/beta/cdist-features.html | 23 +- src/extra/manual/beta/cdist-hacker.html | 59 +-- src/extra/manual/beta/cdist-install.html | 23 +- src/extra/manual/beta/cdist-integration.html | 43 +- src/extra/manual/beta/cdist-inventory.html | 23 +- src/extra/manual/beta/cdist-manifest.html | 23 +- src/extra/manual/beta/cdist-messaging.html | 23 +- src/extra/manual/beta/cdist-os.html | 23 +- .../manual/beta/cdist-parallelization.html | 23 +- src/extra/manual/beta/cdist-preos.html | 27 +- src/extra/manual/beta/cdist-quickstart.html | 23 +- src/extra/manual/beta/cdist-real-world.html | 23 +- src/extra/manual/beta/cdist-reference.html | 61 +-- .../manual/beta/cdist-remote-exec-copy.html | 67 +-- .../beta/cdist-saving-output-streams.html | 39 +- src/extra/manual/beta/cdist-scan.html | 292 +++++++++++ src/extra/manual/beta/cdist-stages.html | 71 +-- src/extra/manual/beta/cdist-support.html | 23 +- src/extra/manual/beta/cdist-trigger.html | 23 +- .../manual/beta/cdist-troubleshooting.html | 39 +- src/extra/manual/beta/cdist-type.html | 23 +- src/extra/manual/beta/cdist-types.html | 195 +++---- src/extra/manual/beta/cdist-upgrade.html | 23 +- src/extra/manual/beta/cdist-why.html | 23 +- src/extra/manual/beta/genindex.html | 23 +- src/extra/manual/beta/index.html | 23 +- src/extra/manual/beta/man1/cdist-dump.html | 23 +- .../manual/beta/man1/cdist-new-type.html | 23 +- src/extra/manual/beta/man1/cdist.html | 87 ++-- .../manual/beta/man7/cdist-type__acl.html | 109 ++-- .../beta/man7/cdist-type__apt_backports.html | 109 ++-- .../man7/cdist-type__apt_default_release.html | 109 ++-- .../manual/beta/man7/cdist-type__apt_key.html | 204 +++++--- .../beta/man7/cdist-type__apt_key_uri.html | 109 ++-- .../beta/man7/cdist-type__apt_mark.html | 109 ++-- .../man7/cdist-type__apt_norecommends.html | 109 ++-- .../manual/beta/man7/cdist-type__apt_ppa.html | 109 ++-- .../beta/man7/cdist-type__apt_source.html | 109 ++-- .../cdist-type__apt_unattended_upgrades.html | 109 ++-- .../man7/cdist-type__apt_update_index.html | 109 ++-- .../manual/beta/man7/cdist-type__block.html | 109 ++-- .../man7/cdist-type__ccollect_source.html | 109 ++-- .../manual/beta/man7/cdist-type__cdist.html | 109 ++-- .../man7/cdist-type__cdist_preos_trigger.html | 109 ++-- .../beta/man7/cdist-type__cdistmarker.html | 109 ++-- .../beta/man7/cdist-type__check_messages.html | 109 ++-- .../beta/man7/cdist-type__chroot_mount.html | 109 ++-- .../beta/man7/cdist-type__chroot_umount.html | 109 ++-- .../beta/man7/cdist-type__clean_path.html | 109 ++-- .../beta/man7/cdist-type__config_file.html | 109 ++-- .../manual/beta/man7/cdist-type__consul.html | 109 ++-- .../beta/man7/cdist-type__consul_agent.html | 109 ++-- .../beta/man7/cdist-type__consul_check.html | 109 ++-- .../beta/man7/cdist-type__consul_reload.html | 109 ++-- .../beta/man7/cdist-type__consul_service.html | 109 ++-- .../man7/cdist-type__consul_template.html | 109 ++-- .../cdist-type__consul_template_template.html | 109 ++-- .../man7/cdist-type__consul_watch_checks.html | 109 ++-- .../man7/cdist-type__consul_watch_event.html | 109 ++-- .../man7/cdist-type__consul_watch_key.html | 109 ++-- .../cdist-type__consul_watch_keyprefix.html | 109 ++-- .../man7/cdist-type__consul_watch_nodes.html | 109 ++-- .../cdist-type__consul_watch_service.html | 109 ++-- .../cdist-type__consul_watch_services.html | 109 ++-- .../manual/beta/man7/cdist-type__cron.html | 109 ++-- .../beta/man7/cdist-type__daemontools.html | 109 ++-- .../man7/cdist-type__daemontools_service.html | 109 ++-- .../cdist-type__debconf_set_selections.html | 180 ++++--- .../beta/man7/cdist-type__directory.html | 109 ++-- .../manual/beta/man7/cdist-type__docker.html | 109 ++-- .../beta/man7/cdist-type__docker_compose.html | 109 ++-- .../beta/man7/cdist-type__docker_config.html | 109 ++-- .../beta/man7/cdist-type__docker_secret.html | 109 ++-- .../beta/man7/cdist-type__docker_stack.html | 109 ++-- .../beta/man7/cdist-type__docker_swarm.html | 109 ++-- .../manual/beta/man7/cdist-type__dog_vdi.html | 109 ++-- .../beta/man7/cdist-type__dot_file.html | 109 ++-- .../beta/man7/cdist-type__download.html | 136 ++--- .../man7/cdist-type__dpkg_architecture.html | 109 ++-- .../beta/man7/cdist-type__file_old.html | 109 ++-- .../beta/man7/cdist-type__filesystem.html | 109 ++-- .../beta/man7/cdist-type__firewalld_rule.html | 109 ++-- .../man7/cdist-type__firewalld_start.html | 109 ++-- .../manual/beta/man7/cdist-type__git.html | 109 ++-- .../manual/beta/man7/cdist-type__go_get.html | 109 ++-- .../man7/cdist-type__golang_from_vendor.html | 109 ++-- .../man7/cdist-type__grafana_dashboard.html | 109 ++-- .../manual/beta/man7/cdist-type__group.html | 109 ++-- .../beta/man7/cdist-type__hostname.html | 109 ++-- .../manual/beta/man7/cdist-type__hosts.html | 109 ++-- .../manual/beta/man7/cdist-type__hwclock.html | 109 ++-- .../cdist-type__install_bootloader_grub.html | 109 ++-- .../cdist-type__install_chroot_mount.html | 109 ++-- .../cdist-type__install_chroot_umount.html | 109 ++-- .../beta/man7/cdist-type__install_config.html | 109 ++-- .../beta/man7/cdist-type__install_coreos.html | 109 ++-- .../man7/cdist-type__install_directory.html | 109 ++-- .../beta/man7/cdist-type__install_file.html | 109 ++-- .../beta/man7/cdist-type__install_fstab.html | 109 ++-- .../cdist-type__install_generate_fstab.html | 109 ++-- .../beta/man7/cdist-type__install_mkfs.html | 109 ++-- .../beta/man7/cdist-type__install_mount.html | 109 ++-- .../cdist-type__install_partition_msdos.html | 109 ++-- ...t-type__install_partition_msdos_apply.html | 109 ++-- .../beta/man7/cdist-type__install_reboot.html | 109 ++-- .../man7/cdist-type__install_reset_disk.html | 109 ++-- .../beta/man7/cdist-type__install_stage.html | 109 ++-- .../beta/man7/cdist-type__install_umount.html | 109 ++-- .../beta/man7/cdist-type__iptables_apply.html | 109 ++-- .../beta/man7/cdist-type__iptables_rule.html | 109 ++-- .../manual/beta/man7/cdist-type__issue.html | 109 ++-- .../manual/beta/man7/cdist-type__jail.html | 109 ++-- .../beta/man7/cdist-type__jail_freebsd10.html | 109 ++-- .../beta/man7/cdist-type__jail_freebsd9.html | 109 ++-- .../beta/man7/cdist-type__key_value.html | 109 ++-- .../beta/man7/cdist-type__keyboard.html | 109 ++-- .../man7/cdist-type__letsencrypt_cert.html | 109 ++-- .../manual/beta/man7/cdist-type__line.html | 109 ++-- .../manual/beta/man7/cdist-type__link.html | 109 ++-- .../manual/beta/man7/cdist-type__locale.html | 109 ++-- .../beta/man7/cdist-type__locale_system.html | 109 ++-- .../beta/man7/cdist-type__localedef.html | 109 ++-- .../manual/beta/man7/cdist-type__motd.html | 109 ++-- .../manual/beta/man7/cdist-type__mount.html | 109 ++-- .../beta/man7/cdist-type__mysql_database.html | 109 ++-- .../man7/cdist-type__mysql_privileges.html | 109 ++-- .../beta/man7/cdist-type__mysql_user.html | 109 ++-- .../man7/cdist-type__openldap_server.html | 109 ++-- .../manual/beta/man7/cdist-type__package.html | 109 ++-- .../beta/man7/cdist-type__package_apk.html | 109 ++-- .../beta/man7/cdist-type__package_apt.html | 109 ++-- .../beta/man7/cdist-type__package_dpkg.html | 109 ++-- .../beta/man7/cdist-type__package_emerge.html | 109 ++-- ...ist-type__package_emerge_dependencies.html | 109 ++-- .../man7/cdist-type__package_luarocks.html | 109 ++-- .../beta/man7/cdist-type__package_opkg.html | 109 ++-- .../beta/man7/cdist-type__package_pacman.html | 109 ++-- .../beta/man7/cdist-type__package_pip.html | 109 ++-- .../man7/cdist-type__package_pkg_freebsd.html | 109 ++-- .../man7/cdist-type__package_pkg_openbsd.html | 109 ++-- .../cdist-type__package_pkgng_freebsd.html | 109 ++-- .../man7/cdist-type__package_rubygem.html | 109 ++-- .../cdist-type__package_update_index.html | 109 ++-- .../man7/cdist-type__package_upgrade_all.html | 109 ++-- .../beta/man7/cdist-type__package_yum.html | 109 ++-- .../beta/man7/cdist-type__package_zypper.html | 109 ++-- .../beta/man7/cdist-type__pacman_conf.html | 109 ++-- .../cdist-type__pacman_conf_integrate.html | 109 ++-- .../man7/cdist-type__pf_apply_anchor.html | 109 ++-- .../beta/man7/cdist-type__pf_ruleset.html | 109 ++-- .../manual/beta/man7/cdist-type__ping.html | 109 ++-- .../manual/beta/man7/cdist-type__postfix.html | 109 ++-- .../beta/man7/cdist-type__postfix_master.html | 109 ++-- .../man7/cdist-type__postfix_postconf.html | 109 ++-- .../man7/cdist-type__postfix_postmap.html | 109 ++-- .../beta/man7/cdist-type__postfix_reload.html | 113 +++-- .../beta/man7/cdist-type__postgres_conf.html | 479 ++++++++++++++++++ .../man7/cdist-type__postgres_database.html | 149 +++--- .../man7/cdist-type__postgres_extension.html | 206 ++++---- .../beta/man7/cdist-type__postgres_role.html | 153 +++--- .../manual/beta/man7/cdist-type__process.html | 153 +++--- .../cdist-type__prometheus_alertmanager.html | 157 +++--- .../man7/cdist-type__prometheus_exporter.html | 157 +++--- .../man7/cdist-type__prometheus_server.html | 157 +++--- .../manual/beta/man7/cdist-type__pyvenv.html | 149 +++--- .../beta/man7/cdist-type__qemu_img.html | 149 +++--- .../manual/beta/man7/cdist-type__rbenv.html | 145 +++--- .../manual/beta/man7/cdist-type__rsync.html | 161 +++--- .../manual/beta/man7/cdist-type__rvm.html | 149 +++--- .../manual/beta/man7/cdist-type__rvm_gem.html | 153 +++--- .../beta/man7/cdist-type__rvm_gemset.html | 153 +++--- .../beta/man7/cdist-type__rvm_ruby.html | 153 +++--- .../man7/cdist-type__sensible_editor.html | 157 +++--- .../manual/beta/man7/cdist-type__service.html | 153 +++--- .../beta/man7/cdist-type__snakeoil_cert.html | 466 +++++++++++++++++ .../man7/cdist-type__ssh_authorized_key.html | 157 +++--- .../man7/cdist-type__ssh_authorized_keys.html | 157 +++--- .../beta/man7/cdist-type__ssh_dot_ssh.html | 149 +++--- .../beta/man7/cdist-type__sshd_config.html | 161 +++--- .../beta/man7/cdist-type__staged_file.html | 153 +++--- .../beta/man7/cdist-type__start_on_boot.html | 153 +++--- .../manual/beta/man7/cdist-type__sysctl.html | 145 +++--- .../man7/cdist-type__systemd_service.html | 161 +++--- .../beta/man7/cdist-type__systemd_unit.html | 157 +++--- .../beta/man7/cdist-type__timezone.html | 149 +++--- .../manual/beta/man7/cdist-type__uci.html | 157 +++--- .../beta/man7/cdist-type__uci_section.html | 157 +++--- .../manual/beta/man7/cdist-type__ufw.html | 149 +++--- .../beta/man7/cdist-type__ufw_rule.html | 149 +++--- .../manual/beta/man7/cdist-type__unpack.html | 153 +++--- .../man7/cdist-type__update_alternatives.html | 153 +++--- .../manual/beta/man7/cdist-type__user.html | 161 +++--- .../beta/man7/cdist-type__user_groups.html | 149 +++--- .../beta/man7/cdist-type__xymon_apache.html | 161 +++--- .../beta/man7/cdist-type__xymon_client.html | 157 +++--- .../beta/man7/cdist-type__xymon_config.html | 161 +++--- .../beta/man7/cdist-type__xymon_server.html | 157 +++--- .../beta/man7/cdist-type__yum_repo.html | 153 +++--- .../beta/man7/cdist-type__zypper_repo.html | 149 +++--- .../beta/man7/cdist-type__zypper_service.html | 149 +++--- src/extra/manual/beta/objects.inv | Bin 2946 -> 2983 bytes src/extra/manual/beta/search.html | 23 +- src/extra/manual/beta/searchindex.js | 2 +- 220 files changed, 12895 insertions(+), 10680 deletions(-) create mode 100644 src/extra/manual/beta/_sources/cdist-scan.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__postgres_conf.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__snakeoil_cert.rst.txt create mode 100644 src/extra/manual/beta/cdist-scan.html create mode 100644 src/extra/manual/beta/man7/cdist-type__postgres_conf.html create mode 100644 src/extra/manual/beta/man7/cdist-type__snakeoil_cert.html diff --git a/src/extra/manual/beta/_sources/cdist-reference.rst.txt b/src/extra/manual/beta/_sources/cdist-reference.rst.txt index 0035a082..51a50a29 100644 --- a/src/extra/manual/beta/_sources/cdist-reference.rst.txt +++ b/src/extra/manual/beta/_sources/cdist-reference.rst.txt @@ -263,6 +263,7 @@ The following types are available: - __postfix_postconf (`cdist-type__postfix_postconf(7) `_) - __postfix_postmap (`cdist-type__postfix_postmap(7) `_) - __postfix_reload (`cdist-type__postfix_reload(7) `_) +- __postgres_conf (`cdist-type__postgres_conf(7) `_) - __postgres_database (`cdist-type__postgres_database(7) `_) - __postgres_extension (`cdist-type__postgres_extension(7) `_) - __postgres_role (`cdist-type__postgres_role(7) `_) @@ -280,6 +281,7 @@ The following types are available: - __rvm_ruby (`cdist-type__rvm_ruby(7) `_) - __sensible_editor (`cdist-type__sensible_editor(7) `_) - __service (`cdist-type__service(7) `_) +- __snakeoil_cert (`cdist-type__snakeoil_cert(7) `_) - __ssh_authorized_key (`cdist-type__ssh_authorized_key(7) `_) - __ssh_authorized_keys (`cdist-type__ssh_authorized_keys(7) `_) - __ssh_dot_ssh (`cdist-type__ssh_dot_ssh(7) `_) diff --git a/src/extra/manual/beta/_sources/cdist-scan.rst.txt b/src/extra/manual/beta/_sources/cdist-scan.rst.txt new file mode 100644 index 00000000..064e65ff --- /dev/null +++ b/src/extra/manual/beta/_sources/cdist-scan.rst.txt @@ -0,0 +1,82 @@ +Scan +===== + +Description +----------- +Runs cdist as a daemon that discover/watch on hosts and reconfigure them +periodically. It is especially useful in netboot-based environment where hosts +boot unconfigured, and to ensure your infrastructure stays in sync with your +configuration. + +This feature is still consider to be in **beta** stage, and only operate on +IPv6 (including link-local). + +Usage (Examples) +---------------- + +Discover hosts on local network and configure those whose name is resolved by +the name mapper script. + +.. code-block:: sh + + $ cdist scan --beta --interface eth0 \ + --mode scan --name-mapper path/to/script \ + --mode trigger --mode config + +List known hosts and exit. + +.. code-block:: sh + + $ cdist scan --beta --list --name-mapper path/to/script + +Please refer to `cdist(1)` for a detailed list of parameters. + +Modes +----- + +The scanner has 3 modes that can be independently toggled. If the `--mode` +parameter is not specified, only `tigger` and `scan` are enabled (= hosts are +not configured). + +trigger + Send ICMPv6 requests to specific hosts or broadcast over IPv6 link-local to + trigger detection by the `scan` module. + +scan + Watch for incoming ICMPv6 replies and optionally configure detected hosts. + +config + Enable configuration of hosts detected by `scan`. + +Name Mapper Script +------------------ + +The name mapper script takes an IPv6 address as first argument and writes the +resolved name to stdout - if any. The script must be executable. + +Simplest script: + +.. code-block:: sh + #!/bin/sh + + case "$1" in + "fe80::20d:b9ff:fe57:3524") + printf "my-host-01" + ;; + "fe80::7603:bdff:fe05:89bb") + printf "my-host-02" + ;; + esac + +Resolving name from `PTR` DNS record: + +.. code-block:: sh + #!/bin/sh + + for cmd in dig sed; do + if ! command -v $cmd > /dev/null; then + exit 1 + fi + done + + dig +short -x "$1" | sed -e 's/.$//' diff --git a/src/extra/manual/beta/_sources/cdist-types.rst.txt b/src/extra/manual/beta/_sources/cdist-types.rst.txt index b439fcdc..9cd8ffdb 100644 --- a/src/extra/manual/beta/_sources/cdist-types.rst.txt +++ b/src/extra/manual/beta/_sources/cdist-types.rst.txt @@ -131,6 +131,7 @@ cdist types __postfix_postconf __postfix_postmap __postfix_reload + __postgres_conf __postgres_database __postgres_extension __postgres_role @@ -148,6 +149,7 @@ cdist types __rvm_ruby __sensible_editor __service + __snakeoil_cert __ssh_authorized_key __ssh_authorized_keys __ssh_dot_ssh diff --git a/src/extra/manual/beta/_sources/index.rst.txt b/src/extra/manual/beta/_sources/index.rst.txt index 652a018a..831eab1d 100644 --- a/src/extra/manual/beta/_sources/index.rst.txt +++ b/src/extra/manual/beta/_sources/index.rst.txt @@ -35,6 +35,7 @@ It natively supports IPv6 since the first release. cdist-inventory cdist-trigger cdist-preos + cdist-scan cdist-integration cdist-reference cdist-best-practice diff --git a/src/extra/manual/beta/_sources/man1/cdist.rst.txt b/src/extra/manual/beta/_sources/man1/cdist.rst.txt index bda4740e..89a74078 100644 --- a/src/extra/manual/beta/_sources/man1/cdist.rst.txt +++ b/src/extra/manual/beta/_sources/man1/cdist.rst.txt @@ -97,6 +97,8 @@ SYNOPSIS [-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH] [--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC] [-S] [-D DIRECTORY] [-H HTTP_PORT] [--ipv6] [-O SOURCE] + cdist scan -I INTERFACE [--m MODE] [--name-mapper PATH_TO_SCRIPT] [--list] + [-d CONFIG_DELAY] [-t TRIGGER_DELAY] DESCRIPTION @@ -748,6 +750,31 @@ This command returns the following response codes to client requests: **-S, --disable-saving-output-streams** Disable saving output streams. +SCAN +---- + +Runs cdist as a daemon that discover/watch on hosts and reconfigure them +periodically. + +**-I INTERFACE, --interfaces INTERFACE** + Interface to listen on. Can be specified multiple times. + +**-m MODE, --mode MODE** + Scanner components to enable. Can be specified multiple time to enable more + than one component. Supported modes are: scan, trigger and config. Defaults + to tiggger and scan. + +**--name-mapper PATH_TO_SCRIPT** + Path to script used to resolve a remote host name from an IPv6 address. + +**--list** + List known hosts and exit. + +**-d CONFIG_DELAY, --config-delay CONFIG_DELAY** + How long (seconds) to wait before reconfiguring after last try (config mode only). + +**-t TRIGGER_DELAY, --tigger-delay TRIGGER_DELAY** + How long (seconds) to wait between ICMPv6 echo requests (trigger mode only). CONFIGURATION ------------- diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__apt_key.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__apt_key.rst.txt index 234bc715..e35eaa0f 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__apt_key.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__apt_key.rst.txt @@ -10,6 +10,14 @@ DESCRIPTION ----------- Manages the list of keys used by apt to authenticate packages. +This is done by placing the requested key in a file named +``$__object_id.gpg`` in the ``keydir`` directory. + +This is supported by modern releases of Debian-based distributions. + +In order of preference, exactly one of: ``source``, ``uri`` or ``keyid`` +must be specified. + REQUIRED PARAMETERS ------------------- @@ -18,21 +26,49 @@ None. OPTIONAL PARAMETERS ------------------- +keydir + keyring directory, defaults to ``/etc/apt/trusted.pgp.d``, which is + enabled system-wide by default. + +source + path to a file containing the GPG key of the repository. + Using this is recommended as it ensures that the manifest/type manintainer + has validated the key. + If ``-``, the GPG key is read from the type's stdin. + state 'present' or 'absent'. Defaults to 'present' +uri + the URI from which to download the key. + It is highly recommended that you only use protocols with TLS like HTTPS. + This uses ``__download`` but does not use checksums, if you want to ensure + that the key doesn't change, you are better off downloading it and using + ``--source``. + + +DEPRECATED OPTIONAL PARAMETERS +------------------------------ keyid - the id of the key to add. Defaults to __object_id + the id of the key to download from the ``keyserver``. + This is to be used in absence of ``--source`` and ``--uri`` or together + with ``--use-deprecated-apt-key`` for key removal. + Defaults to ``$__object_id``. keyserver - the keyserver from which to fetch the key. If omitted the default set - in ./parameter/default/keyserver is used. + the keyserver from which to fetch the key. + Defaults to ``pool.sks-keyservers.net``. -keydir - key save location, defaults to ``/etc/apt/trusted.pgp.d`` -uri - the URI from which to download the key +DEPRECATED BOOLEAN PARAMETERS +----------------------------- +use-deprecated-apt-key + ``apt-key(8)`` will last be available in Debian 11 and Ubuntu 22.04. + You can use this parameter to force usage of ``apt-key(8)``. + Please only use this parameter to *remove* keys from the keyring, + in order to prepare for removal of ``apt-key``. + Adding keys should be done without this parameter. + This parameter will be removed when Debian 11 stops being supported. EXAMPLES @@ -40,33 +76,39 @@ EXAMPLES .. code-block:: sh - # Add Ubuntu Archive Automatic Signing Key - __apt_key 437D05B5 - # Same thing - __apt_key 437D05B5 --state present - # Get rid of it - __apt_key 437D05B5 --state absent + # add a key that has been verified by a type maintainer + __apt_key jitsi_meet_2021 \ + --source cdist-contrib/type/__jitsi_meet/files/apt_2021.gpg - # same thing with human readable name and explicit keyid - __apt_key UbuntuArchiveKey --keyid 437D05B5 + # remove an old, deprecated or expired key + __apt_key jitsi_meet_2016 --state absent - # same thing with other keyserver - __apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com + # Get rid of a key that might have been added to + # /etc/apt/trusted.gpg with apt-key + __apt_key 0x40976EAF437D05B5 --use-deprecated-apt-key --state absent - # download key from the internet - __apt_key rabbitmq \ - --uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc + # add a key that we define in-line + __apt_key jitsi_meet_2021 --source '-' < Ander Punnar +Evilham COPYING ------- -Copyright \(C) 2011-2019 Steven Armstrong and Ander Punnar. You can +Copyright \(C) 2011-2021 Steven Armstrong, Ander Punnar and Evilham. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__debconf_set_selections.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__debconf_set_selections.rst.txt index 58c25b81..fd0040ae 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__debconf_set_selections.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__debconf_set_selections.rst.txt @@ -8,15 +8,33 @@ cdist-type__debconf_set_selections - Setup debconf selections DESCRIPTION ----------- -On Debian and alike systems debconf-set-selections(1) can be used +On Debian and alike systems :strong:`debconf-set-selections`\ (1) can be used to setup configuration parameters. REQUIRED PARAMETERS ------------------- +cf. ``--line``. + + +OPTIONAL PARAMETERS +------------------- file - Use the given filename as input for debconf-set-selections(1) - If filename is "-", read from stdin. + Use the given filename as input for :strong:`debconf-set-selections`\ (1) + If filename is ``-``, read from stdin. + + **This parameter is deprecated, because it doesn't work with state detection.** +line + A line in :strong:`debconf-set-selections`\ (1) compatible format. + This parameter can be used multiple times to set multiple options. + + (This parameter is actually required, but marked optional because the + deprecated ``--file`` is still accepted.) + + +BOOLEAN PARAMETERS +------------------ +None. EXAMPLES @@ -24,30 +42,29 @@ EXAMPLES .. code-block:: sh - # Setup configuration for nslcd - __debconf_set_selections nslcd --file /path/to/file + # Setup gitolite's gituser + __debconf_set_selections nslcd --line 'gitolite gitolite/gituser string git' - # Setup configuration for nslcd from another type - __debconf_set_selections nslcd --file "$__type/files/preseed/nslcd" - - __debconf_set_selections nslcd --file - << eof - gitolite gitolite/gituser string git - eof + # Setup configuration for nslcd from a file. + # NB: Multiple lines can be passed to --line, although this can be considered a hack. + __debconf_set_selections nslcd --line "$(cat "${__files:?}/preseed/nslcd.debconf")" SEE ALSO -------- -:strong:`debconf-set-selections`\ (1), :strong:`cdist-type__update_alternatives`\ (7) +- :strong:`cdist-type__update_alternatives`\ (7) +- :strong:`debconf-set-selections`\ (1) AUTHORS ------- -Nico Schottelius +| Nico Schottelius +| Dennis Camera COPYING ------- -Copyright \(C) 2011-2014 Nico Schottelius. You can redistribute it -and/or modify it under the terms of the GNU General Public License as -published by the Free Software Foundation, either version 3 of the -License, or (at your option) any later version. +Copyright \(C) 2011-2014 Nico Schottelius, 2021 Dennis Camera. +You can redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either version 3 of +the License, or (at your option) any later version. diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__download.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__download.rst.txt index a1278cfb..c16510a9 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__download.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__download.rst.txt @@ -8,7 +8,7 @@ cdist-type__download - Download a file DESCRIPTION ----------- -By default type will try to use ``wget``, ``curl`` or ``fetch``. +By default type will try to use ``curl``, ``fetch`` or ``wget``. If download happens in target (see ``--download``) then type will fallback to (and install) ``wget``. @@ -16,6 +16,8 @@ If download happens in local machine, then environment variables like ``{http,https,ftp}_proxy`` etc can be used on cdist execution (``http_proxy=foo cdist config ...``). +To change downloaded file's owner, group or permissions, use ``require='__download/path/to/file' __file ...``. + REQUIRED PARAMETERS ------------------- @@ -25,14 +27,29 @@ url OPTIONAL PARAMETERS ------------------- +destination + Downloaded file's destination in target. If unset, ``$__object_id`` is used. + sum - Checksum is used to decide if existing destination file must be redownloaded. - By default output of ``cksum`` without filename is expected. - Other hash formats supported with prefixes: ``md5:``, ``sha1:`` and ``sha256:``. + Supported formats: ``cksum`` output without file name, MD5, SHA1 and SHA256. + + Type tries to detect hash format with regexes, but prefixes + ``cksum:``, ``md5:``, ``sha1:`` and ``sha256:`` are also supported. + + Checksum have two purposes - state check and post-download verification. + In state check, if destination checksum mismatches, then content of URL + will be downloaded to temporary file. If downloaded temporary file's + checksum matches, then it will be moved to destination (overwritten). + + For local downloads it is expected that usable utilities for checksum + calculation exist in the system. download - If ``local`` (default), then download file to local storage and copy - it to target host. If ``remote``, then download happens in target. + If ``local`` (default), then file is downloaded to local storage and copied + to target host. If ``remote``, then download happens in target. + + For local downloads it is expected that usable utilities for downloading + exist in the system. Type will try to use ``curl``, ``fetch`` or ``wget``. cmd-get Command used for downloading. @@ -62,7 +79,7 @@ EXAMPLES require='__directory/opt/cpma' \ __download /opt/cpma/cnq3.zip \ --url https://cdn.playmorepromode.com/files/cnq3/cnq3-1.51.zip \ - --sum md5:46da3021ca9eace277115ec9106c5b46 + --sum 46da3021ca9eace277115ec9106c5b46 require='__download/opt/cpma/cnq3.zip' \ __unpack /opt/cpma/cnq3.zip \ diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__postgres_conf.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__postgres_conf.rst.txt new file mode 100644 index 00000000..e035f080 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__postgres_conf.rst.txt @@ -0,0 +1,60 @@ +cdist-type__postgres_conf(7) +============================ + +NAME +---- +cdist-type__postgres_conf - Alter PostgreSQL configuration + + +DESCRIPTION +----------- +Configure a running PostgreSQL server using ``ALTER SYSTEM``. + + +REQUIRED PARAMETERS +------------------- +value + The value to set (can be omitted if ``--state`` is set to ``absent``). + + +OPTIONAL PARAMETERS +------------------- +state + ``present`` or ``absent``. + Defaults to ``present``. + + +BOOLEAN PARAMETERS +------------------ +None. + + +EXAMPLES +-------- + +.. code-block:: sh + + # set timezone + __postgres_conf timezone --value Europe/Zurich + + # reset maximum number of concurrent connections to default (normally 100) + __postgres_conf max_connections --state absent + + +SEE ALSO +-------- +None. + + +AUTHORS +------- +Beni Ruef (bernhard.ruef--@--ssrq-sds-fds.ch) +Dennis Camera (dennis.camera--@--ssrq-sds-fds.ch) + + +COPYING +------- +Copyright \(C) 2019-2021 SSRQ (www.ssrq-sds-fds.ch). +You can redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either version 3 of +the License, or (at your option) any later version. diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__postgres_extension.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__postgres_extension.rst.txt index 79645b2b..442239f6 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__postgres_extension.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__postgres_extension.rst.txt @@ -3,32 +3,36 @@ cdist-type__postgres_extension(7) NAME ---- -cdist-type__postgres_extension - manage postgres extensions +cdist-type__postgres_extension - Manage PostgreSQL extensions DESCRIPTION ----------- -This cdist type allows you to create or drop postgres extensions. +This cdist type allows you to manage PostgreSQL extensions. -The object you need to pass to __postgres_extension consists of -the database name and the extension name joined by a colon in the -following form: - -.. code-block:: sh - - dbname:extension - -f.ex. +The ``__object_id`` to pass to ``__postgres_extension`` is of the form +``dbname:extension``, e.g.: .. code-block:: sh rails_test:unaccent +**CAUTION!** Be careful when installing extensions from (untrusted) third-party +sources: + + | Installing an extension as superuser requires trusting that the extension's + author wrote the extension installation script in a secure fashion. It is + not terribly difficult for a malicious user to create trojan-horse objects + that will compromise later execution of a carelessly-written extension + script, allowing that user to acquire superuser privileges. + | – ``_ + + OPTIONAL PARAMETERS ------------------- state - either "present" or "absent", defaults to "present" + either ``present`` or ``absent``, defaults to ``present``. EXAMPLES @@ -36,24 +40,29 @@ EXAMPLES .. code-block:: sh - __postgres_extension rails_test:unaccent - __postgres_extension --present rails_test:unaccent - __postgres_extension --absent rails_test:unaccent + # Install extension unaccent into database rails_test + __postgres_extension rails_test:unaccent + + # Drop extension unaccent from database fails_test + __postgres_extension rails_test:unaccent --state absent SEE ALSO -------- -:strong:`cdist-type__postgre_database`\ (7) +- :strong:`cdist-type__postgres_database`\ (7) +- PostgreSQL "CREATE EXTENSION" documentation at: + ``_. -Postgres "Create Extension" documentation at: . -AUTHOR +AUTHORS ------- -Tomas Pospisek +| Tomas Pospisek +| Dennis Camera + COPYING ------- -Copyright \(C) 2014 Tomas Pospisek. You can redistribute it -and/or modify it under the terms of the GNU General Public License as -published by the Free Software Foundation, either version 3 of the -License, or (at your option) any later version. +Copyright \(C) 2014 Tomas Pospisek, 2021 Dennis Camera. +You can redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either version 3 of +the License, or (at your option) any later version. diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__snakeoil_cert.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__snakeoil_cert.rst.txt new file mode 100644 index 00000000..0b547804 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__snakeoil_cert.rst.txt @@ -0,0 +1,60 @@ +cdist-type__snakeoil_cert(7) +============================ + +NAME +---- +cdist-type__snakeoil_cert - Generate self-signed certificate + + +DESCRIPTION +----------- +The purpose of this type is to generate **self-signed** certificate and private key +for **testing purposes**. Certificate will expire in 3650 days. + +Certificate's and key's access bits will be ``644`` and ``640`` respectively. +If target system has ``ssl-cert`` group, then it will be used as key's group. +Use ``require='__snakeoil_cert/...' __file ...`` to override. + + +OPTIONAL PARAMETERS +------------------- +common-name + Defaults to ``$__object_id``. + +key-path + ``%s`` in path will be replaced with ``$__object_id``. + Defaults to ``/etc/ssl/private/%s.pem``. + +key-type + Possible values are ``rsa:$bits`` and ``ec:$name``. + For possible EC names see ``openssl ecparam -list_curves``. + Defaults to ``rsa:2048``. + +cert-path + ``%s`` in path will be replaced with ``$__object_id``. + Defaults to ``/etc/ssl/certs/%s.pem``. + + +EXAMPLES +-------- +.. code-block:: sh + __snakeoil_cert localhost-rsa \ + --common-name localhost \ + --key-type rsa:4096 + + __snakeoil_cert localhost-ec \ + --common-name localhost \ + --key-type ec:prime256v1 + + +AUTHORS +------- +Ander Punnar + + +COPYING +------- +Copyright \(C) 2021 Ander Punnar. You can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) +any later version. diff --git a/src/extra/manual/beta/_static/documentation_options.js b/src/extra/manual/beta/_static/documentation_options.js index df7d5695..b658c023 100644 --- a/src/extra/manual/beta/_static/documentation_options.js +++ b/src/extra/manual/beta/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '6.9.6', + VERSION: '6.9.7', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/src/extra/manual/beta/cdist-best-practice.html b/src/extra/manual/beta/cdist-best-practice.html index cf756158..4ca115cb 100644 --- a/src/extra/manual/beta/cdist-best-practice.html +++ b/src/extra/manual/beta/cdist-best-practice.html @@ -9,7 +9,7 @@ - 25. Best practice — cdist 6.9.6 documentation + 26. Best practice — cdist 6.9.7 documentation @@ -35,8 +35,8 @@ - - + + @@ -63,7 +63,7 @@
- 6.9.6 + 6.9.7
@@ -110,31 +110,32 @@
  • 20. Inventory
  • 21. Trigger
  • 22. PreOS
    • -
  • 23. cdist integration / using cdist as library
    • -
  • 24. Reference
    • -
  • 25. Best practice diff --git a/src/extra/manual/beta/cdist-cache.html b/src/extra/manual/beta/cdist-cache.html index 50265e8e..83b096d1 100644 --- a/src/extra/manual/beta/cdist-cache.html +++ b/src/extra/manual/beta/cdist-cache.html @@ -9,7 +9,7 @@ - 27. Local cache overview — cdist 6.9.6 documentation + 28. Local cache overview — cdist 6.9.7 documentation @@ -35,8 +35,8 @@ - - + + @@ -63,7 +63,7 @@
    - 6.9.6 + 6.9.7
    @@ -110,22 +110,23 @@
  • 20. Inventory
  • 21. Trigger
  • 22. PreOS
    • -
  • 23. cdist integration / using cdist as library
    • -
  • 24. Reference
    • -
  • 25. Best practice
    • -
  • 26. Execution stages
    • -
  • 27. Local cache overview diff --git a/src/extra/manual/beta/cdist-explorer.html b/src/extra/manual/beta/cdist-explorer.html index 8a5e53e5..11831dd2 100644 --- a/src/extra/manual/beta/cdist-explorer.html +++ b/src/extra/manual/beta/cdist-explorer.html @@ -9,7 +9,7 @@ - 17. Explorer — cdist 6.9.6 documentation + 17. Explorer — cdist 6.9.7 documentation @@ -36,7 +36,7 @@ - + @@ -63,7 +63,7 @@
    - 6.9.6 + 6.9.7
    @@ -114,15 +114,16 @@
  • 20. Inventory
  • 21. Trigger
  • 22. PreOS
    • -
  • 23. cdist integration / using cdist as library
    • -
  • 24. Reference
    • -
  • 25. Best practice
    • -
  • 26. Execution stages
    • -
  • 27. Local cache overview
    • -
  • 28. Saving output streams
    • -
  • 29. Remote exec and copy commands
    • -
  • 30. Hacking
    • -
  • 31. Troubleshooting
    • +
  • 23. Scan
    • +
  • 24. cdist integration / using cdist as library
    • +
  • 25. Reference
    • +
  • 26. Best practice
    • +
  • 27. Execution stages
    • +
  • 28. Local cache overview
    • +
  • 29. Saving output streams
    • +
  • 30. Remote exec and copy commands
    • +
  • 31. Hacking
    • +
  • 32. Troubleshooting
    • @@ -245,7 +246,7 @@ dpkg -s "$name