From dd12d925b6fa9fdde5d0772d5ba0aeb2f4f691b7 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Mon, 25 May 2020 11:25:40 +0200 Subject: [PATCH] Update cdist beta docs --- .../beta/_sources/cdist-support.rst.txt | 2 +- .../_sources/man7/cdist-type__cron.rst.txt | 5 +++ .../man7/cdist-type__file_old.rst.txt | 6 +-- .../_sources/man7/cdist-type__link.rst.txt | 2 +- .../_sources/man7/cdist-type__pyvenv.rst.txt | 5 +-- .../cdist-type__ssh_authorized_key.rst.txt | 16 ++++---- .../cdist-type__ssh_authorized_keys.rst.txt | 29 ++++++++------ .../manual/beta/cdist-best-practice.html | 6 +-- src/extra/manual/beta/cdist-bootstrap.html | 6 +-- src/extra/manual/beta/cdist-cache.html | 6 +-- .../manual/beta/cdist-configuration.html | 8 ++-- src/extra/manual/beta/cdist-explorer.html | 6 +-- src/extra/manual/beta/cdist-features.html | 6 +-- src/extra/manual/beta/cdist-hacker.html | 6 +-- src/extra/manual/beta/cdist-install.html | 6 +-- src/extra/manual/beta/cdist-integration.html | 6 +-- src/extra/manual/beta/cdist-inventory.html | 6 +-- src/extra/manual/beta/cdist-manifest.html | 6 +-- src/extra/manual/beta/cdist-messaging.html | 6 +-- src/extra/manual/beta/cdist-os.html | 6 +-- .../manual/beta/cdist-parallelization.html | 6 +-- src/extra/manual/beta/cdist-preos.html | 6 +-- src/extra/manual/beta/cdist-quickstart.html | 6 +-- src/extra/manual/beta/cdist-real-world.html | 6 +-- src/extra/manual/beta/cdist-reference.html | 6 +-- .../manual/beta/cdist-remote-exec-copy.html | 6 +-- .../beta/cdist-saving-output-streams.html | 6 +-- src/extra/manual/beta/cdist-stages.html | 6 +-- src/extra/manual/beta/cdist-support.html | 8 ++-- src/extra/manual/beta/cdist-trigger.html | 6 +-- .../manual/beta/cdist-troubleshooting.html | 6 +-- src/extra/manual/beta/cdist-type.html | 6 +-- src/extra/manual/beta/cdist-types.html | 6 +-- src/extra/manual/beta/cdist-upgrade.html | 6 +-- src/extra/manual/beta/cdist-why.html | 6 +-- src/extra/manual/beta/genindex.html | 6 +-- src/extra/manual/beta/index.html | 6 +-- src/extra/manual/beta/man1/cdist-dump.html | 6 +-- .../manual/beta/man1/cdist-new-type.html | 6 +-- src/extra/manual/beta/man1/cdist.html | 6 +-- .../manual/beta/man7/cdist-type__acl.html | 6 +-- .../man7/cdist-type__apt_default_release.html | 6 +-- .../manual/beta/man7/cdist-type__apt_key.html | 6 +-- .../beta/man7/cdist-type__apt_key_uri.html | 6 +-- .../beta/man7/cdist-type__apt_mark.html | 6 +-- .../man7/cdist-type__apt_norecommends.html | 6 +-- .../manual/beta/man7/cdist-type__apt_ppa.html | 6 +-- .../beta/man7/cdist-type__apt_source.html | 6 +-- .../cdist-type__apt_unattended_upgrades.html | 6 +-- .../man7/cdist-type__apt_update_index.html | 6 +-- .../manual/beta/man7/cdist-type__block.html | 6 +-- .../man7/cdist-type__ccollect_source.html | 6 +-- .../manual/beta/man7/cdist-type__cdist.html | 6 +-- .../man7/cdist-type__cdist_preos_trigger.html | 6 +-- .../beta/man7/cdist-type__cdistmarker.html | 6 +-- .../beta/man7/cdist-type__check_messages.html | 6 +-- .../beta/man7/cdist-type__chroot_mount.html | 6 +-- .../beta/man7/cdist-type__chroot_umount.html | 6 +-- .../beta/man7/cdist-type__clean_path.html | 6 +-- .../beta/man7/cdist-type__config_file.html | 6 +-- .../manual/beta/man7/cdist-type__consul.html | 6 +-- .../beta/man7/cdist-type__consul_agent.html | 6 +-- .../beta/man7/cdist-type__consul_check.html | 6 +-- .../beta/man7/cdist-type__consul_reload.html | 6 +-- .../beta/man7/cdist-type__consul_service.html | 6 +-- .../man7/cdist-type__consul_template.html | 6 +-- .../cdist-type__consul_template_template.html | 6 +-- .../man7/cdist-type__consul_watch_checks.html | 6 +-- .../man7/cdist-type__consul_watch_event.html | 6 +-- .../man7/cdist-type__consul_watch_key.html | 6 +-- .../cdist-type__consul_watch_keyprefix.html | 6 +-- .../man7/cdist-type__consul_watch_nodes.html | 6 +-- .../cdist-type__consul_watch_service.html | 6 +-- .../cdist-type__consul_watch_services.html | 6 +-- .../manual/beta/man7/cdist-type__cron.html | 10 +++-- .../beta/man7/cdist-type__daemontools.html | 6 +-- .../man7/cdist-type__daemontools_service.html | 6 +-- .../cdist-type__debconf_set_selections.html | 6 +-- .../beta/man7/cdist-type__directory.html | 6 +-- .../manual/beta/man7/cdist-type__docker.html | 6 +-- .../beta/man7/cdist-type__docker_compose.html | 6 +-- .../beta/man7/cdist-type__docker_config.html | 6 +-- .../beta/man7/cdist-type__docker_secret.html | 6 +-- .../beta/man7/cdist-type__docker_stack.html | 6 +-- .../beta/man7/cdist-type__docker_swarm.html | 6 +-- .../manual/beta/man7/cdist-type__dog_vdi.html | 6 +-- .../beta/man7/cdist-type__dot_file.html | 6 +-- .../beta/man7/cdist-type__file_old.html | 12 +++--- .../beta/man7/cdist-type__filesystem.html | 6 +-- .../beta/man7/cdist-type__firewalld_rule.html | 6 +-- .../man7/cdist-type__firewalld_start.html | 6 +-- .../manual/beta/man7/cdist-type__git.html | 6 +-- .../manual/beta/man7/cdist-type__go_get.html | 6 +-- .../man7/cdist-type__golang_from_vendor.html | 6 +-- .../man7/cdist-type__grafana_dashboard.html | 6 +-- .../manual/beta/man7/cdist-type__group.html | 6 +-- .../beta/man7/cdist-type__hostname.html | 6 +-- .../manual/beta/man7/cdist-type__hosts.html | 6 +-- .../cdist-type__install_bootloader_grub.html | 6 +-- .../cdist-type__install_chroot_mount.html | 6 +-- .../cdist-type__install_chroot_umount.html | 6 +-- .../beta/man7/cdist-type__install_config.html | 6 +-- .../beta/man7/cdist-type__install_coreos.html | 6 +-- .../man7/cdist-type__install_directory.html | 6 +-- .../beta/man7/cdist-type__install_file.html | 6 +-- .../beta/man7/cdist-type__install_fstab.html | 6 +-- .../cdist-type__install_generate_fstab.html | 6 +-- .../beta/man7/cdist-type__install_mkfs.html | 6 +-- .../beta/man7/cdist-type__install_mount.html | 6 +-- .../cdist-type__install_partition_msdos.html | 6 +-- ...t-type__install_partition_msdos_apply.html | 6 +-- .../beta/man7/cdist-type__install_reboot.html | 6 +-- .../man7/cdist-type__install_reset_disk.html | 6 +-- .../beta/man7/cdist-type__install_stage.html | 6 +-- .../beta/man7/cdist-type__install_umount.html | 6 +-- .../beta/man7/cdist-type__iptables_apply.html | 6 +-- .../beta/man7/cdist-type__iptables_rule.html | 6 +-- .../manual/beta/man7/cdist-type__issue.html | 6 +-- .../manual/beta/man7/cdist-type__jail.html | 6 +-- .../beta/man7/cdist-type__jail_freebsd10.html | 6 +-- .../beta/man7/cdist-type__jail_freebsd9.html | 6 +-- .../beta/man7/cdist-type__key_value.html | 6 +-- .../beta/man7/cdist-type__keyboard.html | 6 +-- .../man7/cdist-type__letsencrypt_cert.html | 6 +-- .../manual/beta/man7/cdist-type__line.html | 6 +-- .../manual/beta/man7/cdist-type__link.html | 8 ++-- .../manual/beta/man7/cdist-type__locale.html | 6 +-- .../beta/man7/cdist-type__locale_system.html | 6 +-- .../manual/beta/man7/cdist-type__motd.html | 6 +-- .../manual/beta/man7/cdist-type__mount.html | 6 +-- .../beta/man7/cdist-type__mysql_database.html | 6 +-- .../man7/cdist-type__mysql_privileges.html | 6 +-- .../beta/man7/cdist-type__mysql_user.html | 6 +-- .../man7/cdist-type__openldap_server.html | 6 +-- .../manual/beta/man7/cdist-type__package.html | 6 +-- .../beta/man7/cdist-type__package_apk.html | 6 +-- .../beta/man7/cdist-type__package_apt.html | 6 +-- .../beta/man7/cdist-type__package_dpkg.html | 6 +-- .../beta/man7/cdist-type__package_emerge.html | 6 +-- ...ist-type__package_emerge_dependencies.html | 6 +-- .../man7/cdist-type__package_luarocks.html | 6 +-- .../beta/man7/cdist-type__package_opkg.html | 6 +-- .../beta/man7/cdist-type__package_pacman.html | 6 +-- .../beta/man7/cdist-type__package_pip.html | 6 +-- .../man7/cdist-type__package_pkg_freebsd.html | 6 +-- .../man7/cdist-type__package_pkg_openbsd.html | 6 +-- .../cdist-type__package_pkgng_freebsd.html | 6 +-- .../man7/cdist-type__package_rubygem.html | 6 +-- .../cdist-type__package_update_index.html | 6 +-- .../man7/cdist-type__package_upgrade_all.html | 6 +-- .../beta/man7/cdist-type__package_yum.html | 6 +-- .../beta/man7/cdist-type__package_zypper.html | 6 +-- .../beta/man7/cdist-type__pacman_conf.html | 6 +-- .../cdist-type__pacman_conf_integrate.html | 6 +-- .../beta/man7/cdist-type__pf_apply.html | 6 +-- .../man7/cdist-type__pf_apply_anchor.html | 6 +-- .../beta/man7/cdist-type__pf_ruleset.html | 6 +-- .../manual/beta/man7/cdist-type__ping.html | 6 +-- .../manual/beta/man7/cdist-type__postfix.html | 6 +-- .../beta/man7/cdist-type__postfix_master.html | 6 +-- .../man7/cdist-type__postfix_postconf.html | 6 +-- .../man7/cdist-type__postfix_postmap.html | 6 +-- .../beta/man7/cdist-type__postfix_reload.html | 6 +-- .../man7/cdist-type__postgres_database.html | 6 +-- .../man7/cdist-type__postgres_extension.html | 6 +-- .../beta/man7/cdist-type__postgres_role.html | 6 +-- .../manual/beta/man7/cdist-type__process.html | 6 +-- .../cdist-type__prometheus_alertmanager.html | 6 +-- .../man7/cdist-type__prometheus_exporter.html | 6 +-- .../man7/cdist-type__prometheus_server.html | 6 +-- .../manual/beta/man7/cdist-type__pyvenv.html | 8 ++-- .../beta/man7/cdist-type__qemu_img.html | 6 +-- .../manual/beta/man7/cdist-type__rbenv.html | 6 +-- .../manual/beta/man7/cdist-type__rsync.html | 6 +-- .../manual/beta/man7/cdist-type__rvm.html | 6 +-- .../manual/beta/man7/cdist-type__rvm_gem.html | 6 +-- .../beta/man7/cdist-type__rvm_gemset.html | 6 +-- .../beta/man7/cdist-type__rvm_ruby.html | 6 +-- .../man7/cdist-type__sensible_editor.html | 6 +-- .../manual/beta/man7/cdist-type__service.html | 6 +-- .../man7/cdist-type__ssh_authorized_key.html | 22 ++++++----- .../man7/cdist-type__ssh_authorized_keys.html | 37 ++++++++++-------- .../beta/man7/cdist-type__ssh_dot_ssh.html | 6 +-- .../beta/man7/cdist-type__staged_file.html | 6 +-- .../beta/man7/cdist-type__start_on_boot.html | 6 +-- .../manual/beta/man7/cdist-type__sysctl.html | 6 +-- .../man7/cdist-type__systemd_service.html | 6 +-- .../beta/man7/cdist-type__systemd_unit.html | 6 +-- .../beta/man7/cdist-type__timezone.html | 6 +-- .../manual/beta/man7/cdist-type__ufw.html | 6 +-- .../beta/man7/cdist-type__ufw_rule.html | 6 +-- .../man7/cdist-type__update_alternatives.html | 6 +-- .../manual/beta/man7/cdist-type__user.html | 6 +-- .../beta/man7/cdist-type__user_groups.html | 6 +-- .../beta/man7/cdist-type__xymon_apache.html | 6 +-- .../beta/man7/cdist-type__xymon_client.html | 6 +-- .../beta/man7/cdist-type__xymon_config.html | 6 +-- .../beta/man7/cdist-type__xymon_server.html | 6 +-- .../beta/man7/cdist-type__yum_repo.html | 6 +-- .../beta/man7/cdist-type__zypper_repo.html | 6 +-- .../beta/man7/cdist-type__zypper_service.html | 6 +-- src/extra/manual/beta/objects.inv | Bin 2820 -> 2820 bytes src/extra/manual/beta/search.html | 6 +-- src/extra/manual/beta/searchindex.js | 2 +- 204 files changed, 660 insertions(+), 642 deletions(-) diff --git a/src/extra/manual/beta/_sources/cdist-support.rst.txt b/src/extra/manual/beta/_sources/cdist-support.rst.txt index 19afde2f..f9f61f01 100644 --- a/src/extra/manual/beta/_sources/cdist-support.rst.txt +++ b/src/extra/manual/beta/_sources/cdist-support.rst.txt @@ -3,7 +3,7 @@ Support Chat ~~~~ -Chat with us: `ungleich chat `_. +Chat with us on `#cdist:ungleich.ch `_. Mailing list ~~~~~~~~~~~~ diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__cron.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__cron.rst.txt index d0694738..e39bfb5c 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__cron.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__cron.rst.txt @@ -21,6 +21,11 @@ command OPTIONAL PARAMETERS ------------------- +**NOTE**: All time-related parameters (``--minute``, ``--hour``, ``--day_of_month`` +``--month`` and ``--day_of_week``) defaults to ``*``, which means to execute it +**always**. If you set ``--hour 0`` to execute the cronjob only at midnight, it +will execute **every** minute in the first hour of the morning all days. + state Either present or absent. Defaults to present. minute diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__file_old.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__file_old.rst.txt index 7a0603bb..2f3b9e69 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__file_old.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__file_old.rst.txt @@ -50,13 +50,13 @@ state create or modify it group - Group to chgrp to. + Group to chgrp to. Defaults to ``root``. mode - Unix permissions, suitable for chmod. + Unix permissions, suitable for chmod. Defaults to a very secure ``0600``. owner - User to chown to. + User to chown to. Defaults to ``root``. source If supplied, copy this file from the host running cdist to the target. diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__link.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__link.rst.txt index fe0ce425..2e81aea9 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__link.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__link.rst.txt @@ -18,7 +18,7 @@ source Specifies the link source. type - Specifies the link type: Either hard or symoblic. + Specifies the link type: Either hard or symbolic. OPTIONAL PARAMETERS diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__pyvenv.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__pyvenv.rst.txt index d7de92fa..8085ff12 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__pyvenv.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__pyvenv.rst.txt @@ -9,7 +9,7 @@ cdist-type__pyvenv - Create or remove python virtual environment DESCRIPTION ----------- This cdist type allows you to create or remove python virtual -environment using pyvenv. +environment using pyvenv on python3 -m venv. It assumes pyvenv is already installed. Concrete package depends on concrete OS and/or OS version/distribution. Ensure this for e.g. in your init manifest as in the following example: @@ -57,7 +57,7 @@ EXAMPLES __pyvenv /home/services/djangoenv - # Use specific pyvenv + # Use specific pyvenv __pyvenv /home/foo/fooenv --pyvenv /usr/local/bin/pyvenv-3.4 # Create python virtualenv for user foo. @@ -76,4 +76,3 @@ COPYING ------- Copyright \(C) 2016 Darko Poljak. Free use of this software is granted under the terms of the GNU General Public License v3 or later (GPLv3+). - diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_key.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_key.rst.txt index 087a3dae..5bae02aa 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_key.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_key.rst.txt @@ -15,25 +15,27 @@ This type was created to be used by the __ssh_authorized_keys type. REQUIRED PARAMETERS ------------------- file - the authorized_keys file to which the given key should be added + The authorized_keys file where the given key should be managed. key - a string containing the ssh keytype, base 64 encoded key and optional - trailing comment which shall be added to the given authorized_keys file. + The ssh key which shall be managed in this authorized_keys file. + Must be a string containing the ssh keytype, base 64 encoded key and + optional trailing comment which shall be added to the given + authorized_keys file. OPTIONAL PARAMETERS ------------------- comment - explicit comment instead of the one which may be trailing the given key + Use this comment instead of the one which may be trailing in the key. option - an option to set for this authorized_key entry. + An option to set for this authorized_key entry. Can be specified multiple times. See sshd(8) for available options. state - if the given keys should be 'present' or 'absent', defaults to 'present'. + If the managed key should be 'present' or 'absent', defaults to 'present'. MESSAGES @@ -64,7 +66,7 @@ EXAMPLES SEE ALSO -------- -:strong:`cdist__ssh_authorized_keys`\ (7), :strong:`sshd`\ (8) +:strong:`cdist-type__ssh_authorized_keys`\ (7), :strong:`sshd`\ (8) AUTHORS diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_keys.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_keys.rst.txt index ba310ff9..93357b1d 100644 --- a/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_keys.rst.txt +++ b/src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_keys.rst.txt @@ -20,42 +20,45 @@ then left to the user to ensure that the file exists and that ownership and permissions work with ssh. -REQUIRED PARAMETERS -------------------- +REQUIRED MULTIPLE PARAMETERS +---------------------------- key - the ssh key which shall be added to this authorized_keys file. - Must be a string and can be specified multiple times. + An ssh key which shall be managed in this authorized_keys file. + Must be a string containing the ssh keytype, base 64 encoded key and + optional trailing comment which shall be added to the given + authorized_keys file. + Can be specified multiple times. OPTIONAL PARAMETERS ------------------- comment - explicit comment instead of the one which may be trailing the given key + Use this comment instead of the one which may be trailing in each key. file - an alternative destination file, defaults to ~$owner/.ssh/authorized_keys + An alternative destination file, defaults to ~$owner/.ssh/authorized_keys. option - an option to set for all created authorized_key entries. + An option to set for all authorized_key entries in the key parameter. Can be specified multiple times. See sshd(8) for available options. owner - the user owning the authorized_keys file, defaults to object_id. + The user owning the authorized_keys file, defaults to object_id. state - if the given keys should be 'present' or 'absent', defaults to 'present'. + If the given keys should be 'present' or 'absent', defaults to 'present'. BOOLEAN PARAMETERS ------------------ noparent - don't create or change ownership and permissions of the directory containing - the authorized_keys file + Don't create or change ownership and permissions of the directory containing + the authorized_keys file. nofile - don't manage existence, ownership and permissions of the the authorized_keys - file + Don't manage existence, ownership and permissions of the the authorized_keys + file. EXAMPLES diff --git a/src/extra/manual/beta/cdist-best-practice.html b/src/extra/manual/beta/cdist-best-practice.html index d02f0ccc..7fd401eb 100644 --- a/src/extra/manual/beta/cdist-best-practice.html +++ b/src/extra/manual/beta/cdist-best-practice.html @@ -8,7 +8,7 @@ - 25. Best practice — cdist 6.5.5 documentation + 25. Best practice — cdist 6.5.6 documentation @@ -23,7 +23,7 @@