From a65e58b22dfd5fbc52ec945d9d8b607b32c71db2 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 17 Oct 2019 11:27:20 +0200 Subject: [PATCH] Update beta docs --- .../beta/_sources/cdist-reference.rst.txt | 5 + .../man7/cdist-type__sensible_editor.rst.txt | 78 +++ .../man7/cdist-type__xymon_apache.rst.txt | 79 +++ .../man7/cdist-type__xymon_client.rst.txt | 57 ++ .../man7/cdist-type__xymon_config.rst.txt | 57 ++ .../man7/cdist-type__xymon_server.rst.txt | 87 +++ .../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 | 6 +- src/extra/manual/beta/cdist-explorer.html | 10 +- 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 | 11 +- .../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 | 6 +- 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 | 80 +-- 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 | 43 +- .../man7/cdist-type__apt_default_release.html | 43 +- .../manual/beta/man7/cdist-type__apt_key.html | 43 +- .../beta/man7/cdist-type__apt_key_uri.html | 43 +- .../beta/man7/cdist-type__apt_mark.html | 43 +- .../man7/cdist-type__apt_norecommends.html | 43 +- .../manual/beta/man7/cdist-type__apt_ppa.html | 43 +- .../beta/man7/cdist-type__apt_source.html | 43 +- .../man7/cdist-type__apt_update_index.html | 43 +- .../manual/beta/man7/cdist-type__block.html | 43 +- .../man7/cdist-type__ccollect_source.html | 43 +- .../manual/beta/man7/cdist-type__cdist.html | 43 +- .../man7/cdist-type__cdist_preos_trigger.html | 43 +- .../beta/man7/cdist-type__cdistmarker.html | 43 +- .../beta/man7/cdist-type__check_messages.html | 43 +- .../beta/man7/cdist-type__chroot_mount.html | 43 +- .../beta/man7/cdist-type__chroot_umount.html | 43 +- .../beta/man7/cdist-type__clean_path.html | 43 +- .../beta/man7/cdist-type__config_file.html | 43 +- .../manual/beta/man7/cdist-type__consul.html | 43 +- .../beta/man7/cdist-type__consul_agent.html | 43 +- .../beta/man7/cdist-type__consul_check.html | 43 +- .../beta/man7/cdist-type__consul_reload.html | 43 +- .../beta/man7/cdist-type__consul_service.html | 43 +- .../man7/cdist-type__consul_template.html | 43 +- .../cdist-type__consul_template_template.html | 43 +- .../man7/cdist-type__consul_watch_checks.html | 43 +- .../man7/cdist-type__consul_watch_event.html | 43 +- .../man7/cdist-type__consul_watch_key.html | 43 +- .../cdist-type__consul_watch_keyprefix.html | 43 +- .../man7/cdist-type__consul_watch_nodes.html | 43 +- .../cdist-type__consul_watch_service.html | 43 +- .../cdist-type__consul_watch_services.html | 43 +- .../manual/beta/man7/cdist-type__cron.html | 43 +- .../beta/man7/cdist-type__daemontools.html | 43 +- .../man7/cdist-type__daemontools_service.html | 43 +- .../cdist-type__debconf_set_selections.html | 43 +- .../beta/man7/cdist-type__directory.html | 43 +- .../manual/beta/man7/cdist-type__docker.html | 43 +- .../beta/man7/cdist-type__docker_compose.html | 43 +- .../beta/man7/cdist-type__docker_config.html | 43 +- .../beta/man7/cdist-type__docker_secret.html | 43 +- .../beta/man7/cdist-type__docker_stack.html | 43 +- .../beta/man7/cdist-type__docker_swarm.html | 43 +- .../manual/beta/man7/cdist-type__dog_vdi.html | 43 +- .../beta/man7/cdist-type__dot_file.html | 43 +- .../beta/man7/cdist-type__file_old.html | 43 +- .../beta/man7/cdist-type__filesystem.html | 43 +- .../beta/man7/cdist-type__firewalld_rule.html | 43 +- .../man7/cdist-type__firewalld_start.html | 43 +- .../manual/beta/man7/cdist-type__git.html | 43 +- .../manual/beta/man7/cdist-type__go_get.html | 43 +- .../man7/cdist-type__golang_from_vendor.html | 43 +- .../man7/cdist-type__grafana_dashboard.html | 43 +- .../manual/beta/man7/cdist-type__group.html | 43 +- .../beta/man7/cdist-type__hostname.html | 43 +- .../manual/beta/man7/cdist-type__hosts.html | 43 +- .../cdist-type__install_bootloader_grub.html | 43 +- .../cdist-type__install_chroot_mount.html | 43 +- .../cdist-type__install_chroot_umount.html | 43 +- .../beta/man7/cdist-type__install_config.html | 43 +- .../beta/man7/cdist-type__install_coreos.html | 43 +- .../man7/cdist-type__install_directory.html | 43 +- .../beta/man7/cdist-type__install_file.html | 43 +- .../beta/man7/cdist-type__install_fstab.html | 43 +- .../cdist-type__install_generate_fstab.html | 43 +- .../beta/man7/cdist-type__install_mkfs.html | 43 +- .../beta/man7/cdist-type__install_mount.html | 43 +- .../cdist-type__install_partition_msdos.html | 43 +- ...t-type__install_partition_msdos_apply.html | 43 +- .../beta/man7/cdist-type__install_reboot.html | 43 +- .../man7/cdist-type__install_reset_disk.html | 43 +- .../beta/man7/cdist-type__install_stage.html | 43 +- .../beta/man7/cdist-type__install_umount.html | 43 +- .../beta/man7/cdist-type__iptables_apply.html | 43 +- .../beta/man7/cdist-type__iptables_rule.html | 43 +- .../manual/beta/man7/cdist-type__issue.html | 43 +- .../manual/beta/man7/cdist-type__jail.html | 43 +- .../beta/man7/cdist-type__jail_freebsd10.html | 43 +- .../beta/man7/cdist-type__jail_freebsd9.html | 43 +- .../beta/man7/cdist-type__key_value.html | 43 +- .../beta/man7/cdist-type__keyboard.html | 43 +- .../man7/cdist-type__letsencrypt_cert.html | 43 +- .../manual/beta/man7/cdist-type__line.html | 43 +- .../manual/beta/man7/cdist-type__link.html | 43 +- .../manual/beta/man7/cdist-type__locale.html | 43 +- .../beta/man7/cdist-type__locale_system.html | 43 +- .../manual/beta/man7/cdist-type__motd.html | 43 +- .../manual/beta/man7/cdist-type__mount.html | 43 +- .../beta/man7/cdist-type__mysql_database.html | 43 +- .../manual/beta/man7/cdist-type__package.html | 43 +- .../beta/man7/cdist-type__package_apk.html | 43 +- .../beta/man7/cdist-type__package_apt.html | 43 +- .../beta/man7/cdist-type__package_dpkg.html | 43 +- .../beta/man7/cdist-type__package_emerge.html | 43 +- ...ist-type__package_emerge_dependencies.html | 43 +- .../man7/cdist-type__package_luarocks.html | 43 +- .../beta/man7/cdist-type__package_opkg.html | 43 +- .../beta/man7/cdist-type__package_pacman.html | 43 +- .../beta/man7/cdist-type__package_pip.html | 43 +- .../man7/cdist-type__package_pkg_freebsd.html | 43 +- .../man7/cdist-type__package_pkg_openbsd.html | 43 +- .../cdist-type__package_pkgng_freebsd.html | 43 +- .../man7/cdist-type__package_rubygem.html | 43 +- .../cdist-type__package_update_index.html | 43 +- .../man7/cdist-type__package_upgrade_all.html | 43 +- .../beta/man7/cdist-type__package_yum.html | 43 +- .../beta/man7/cdist-type__package_zypper.html | 43 +- .../beta/man7/cdist-type__pacman_conf.html | 43 +- .../cdist-type__pacman_conf_integrate.html | 43 +- .../beta/man7/cdist-type__pf_apply.html | 43 +- .../beta/man7/cdist-type__pf_ruleset.html | 43 +- .../manual/beta/man7/cdist-type__ping.html | 43 +- .../manual/beta/man7/cdist-type__postfix.html | 43 +- .../beta/man7/cdist-type__postfix_master.html | 43 +- .../man7/cdist-type__postfix_postconf.html | 43 +- .../man7/cdist-type__postfix_postmap.html | 43 +- .../beta/man7/cdist-type__postfix_reload.html | 43 +- .../man7/cdist-type__postgres_database.html | 43 +- .../man7/cdist-type__postgres_extension.html | 43 +- .../beta/man7/cdist-type__postgres_role.html | 43 +- .../manual/beta/man7/cdist-type__process.html | 43 +- .../cdist-type__prometheus_alertmanager.html | 43 +- .../man7/cdist-type__prometheus_exporter.html | 43 +- .../man7/cdist-type__prometheus_server.html | 43 +- .../manual/beta/man7/cdist-type__pyvenv.html | 43 +- .../beta/man7/cdist-type__qemu_img.html | 43 +- .../manual/beta/man7/cdist-type__rbenv.html | 43 +- .../manual/beta/man7/cdist-type__rsync.html | 43 +- .../manual/beta/man7/cdist-type__rvm.html | 43 +- .../manual/beta/man7/cdist-type__rvm_gem.html | 43 +- .../beta/man7/cdist-type__rvm_gemset.html | 43 +- .../beta/man7/cdist-type__rvm_ruby.html | 47 +- .../man7/cdist-type__sensible_editor.html | 494 ++++++++++++++++++ .../man7/cdist-type__ssh_authorized_key.html | 91 ++-- .../man7/cdist-type__ssh_authorized_keys.html | 91 ++-- .../beta/man7/cdist-type__ssh_dot_ssh.html | 83 +-- .../beta/man7/cdist-type__staged_file.html | 87 +-- .../beta/man7/cdist-type__start_on_boot.html | 87 +-- .../manual/beta/man7/cdist-type__sysctl.html | 79 +-- .../beta/man7/cdist-type__systemd_unit.html | 91 ++-- .../beta/man7/cdist-type__timezone.html | 83 +-- .../manual/beta/man7/cdist-type__ufw.html | 83 +-- .../beta/man7/cdist-type__ufw_rule.html | 83 +-- .../man7/cdist-type__update_alternatives.html | 83 +-- .../manual/beta/man7/cdist-type__user.html | 95 ++-- .../beta/man7/cdist-type__user_groups.html | 83 +-- .../beta/man7/cdist-type__xymon_apache.html | 489 +++++++++++++++++ .../beta/man7/cdist-type__xymon_client.html | 464 ++++++++++++++++ .../beta/man7/cdist-type__xymon_config.html | 465 +++++++++++++++++ .../beta/man7/cdist-type__xymon_server.html | 493 +++++++++++++++++ .../beta/man7/cdist-type__yum_repo.html | 87 +-- .../beta/man7/cdist-type__zypper_repo.html | 83 +-- .../beta/man7/cdist-type__zypper_service.html | 83 +-- src/extra/manual/beta/objects.inv | Bin 2664 -> 2731 bytes src/extra/manual/beta/search.html | 6 +- src/extra/manual/beta/searchindex.js | 2 +- 196 files changed, 6840 insertions(+), 3312 deletions(-) create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__sensible_editor.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__xymon_apache.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__xymon_client.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__xymon_config.rst.txt create mode 100644 src/extra/manual/beta/_sources/man7/cdist-type__xymon_server.rst.txt create mode 100644 src/extra/manual/beta/man7/cdist-type__sensible_editor.html create mode 100644 src/extra/manual/beta/man7/cdist-type__xymon_apache.html create mode 100644 src/extra/manual/beta/man7/cdist-type__xymon_client.html create mode 100644 src/extra/manual/beta/man7/cdist-type__xymon_config.html create mode 100644 src/extra/manual/beta/man7/cdist-type__xymon_server.html diff --git a/src/extra/manual/beta/_sources/cdist-reference.rst.txt b/src/extra/manual/beta/_sources/cdist-reference.rst.txt index da9d0f05..46749893 100644 --- a/src/extra/manual/beta/_sources/cdist-reference.rst.txt +++ b/src/extra/manual/beta/_sources/cdist-reference.rst.txt @@ -269,6 +269,7 @@ The following types are available: - __rvm_gem (`cdist-type__rvm_gem(7) `_) - __rvm_gemset (`cdist-type__rvm_gemset(7) `_) - __rvm_ruby (`cdist-type__rvm_ruby(7) `_) +- __sensible_editor (`cdist-type__sensible_editor(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) `_) @@ -282,6 +283,10 @@ The following types are available: - __update_alternatives (`cdist-type__update_alternatives(7) `_) - __user (`cdist-type__user(7) `_) - __user_groups (`cdist-type__user_groups(7) `_) +- __xymon_apache (`cdist-type__xymon_apache(7) `_) +- __xymon_client (`cdist-type__xymon_client(7) `_) +- __xymon_config (`cdist-type__xymon_config(7) `_) +- __xymon_server (`cdist-type__xymon_server(7) `_) - __yum_repo (`cdist-type__yum_repo(7) `_) - __zypper_repo (`cdist-type__zypper_repo(7) `_) - __zypper_service (`cdist-type__zypper_service(7) `_) diff --git a/src/extra/manual/beta/_sources/man7/cdist-type__sensible_editor.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__sensible_editor.rst.txt new file mode 100644 index 00000000..9b805e06 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__sensible_editor.rst.txt @@ -0,0 +1,78 @@ +cdist-type__sensible_editor(7) +============================== + +NAME +---- +cdist-type__sensible_editor - Select the sensible-editor + + +DESCRIPTION +----------- +This cdist type allows you to select the :strong:`sensible-editor` for +a given user. + + +REQUIRED PARAMETERS +------------------- +editor + Name or path of the editor to be selected. + On systems other than Debian derivatives an absolute path is required. + + It is permissible to omit this parameter if --state is absent. + + +OPTIONAL PARAMETERS +------------------- +state + 'present', 'absent', or 'exists'. Defaults to 'present', where: + + present + the sensible-editor is exactly what is specified in --editor. + absent + no sensible-editor configuration is present. + exists + the sensible-editor will be set to what is specified in --editor, + unless there already is a configuration on the target system. + + +EXAMPLES +-------- + +.. code-block:: sh + + __sensible_editor root --editor /bin/ed # ed(1) is the standard + __sensible_editor noob --editor nano + + +LIMITATIONS +----------- + +This type depends upon the :strong:`sensible-editor`\ (1) script which +is part of the sensible-utils package. + +Therefore, the following operating systems are supported: + * Debian 8 (jessie) or later + * Devuan + * Ubuntu 8.10 (intrepid) or later + * RHEL/CentOS 7 or later (EPEL repo required) + * Fedora 21 or later + +Note: on old versions of Ubuntu the sensible-* utils are part of the +debianutils package. + +SEE ALSO +-------- +:strong:`select-editor`\ (1), :strong:`sensible-editor`\ (1). + + +AUTHOR +------- +Dennis Camera + + +COPYING +------- +Copyright \(C) 2019 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__xymon_apache.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_apache.rst.txt new file mode 100644 index 00000000..8358c821 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_apache.rst.txt @@ -0,0 +1,79 @@ +cdist-type__xymon_apache(7) +=========================== + +NAME +---- +cdist-type__xymon_apache - Configure apache2-webserver for Xymon + + +DESCRIPTION +----------- +This cdist type installs and configures apache2 to be used "exclusively" (in +the sense that no other use is taken care of) with Xymon (the systems and +network monitor). + +It depends on `__xymon_server`. + + +REQUIRED PARAMETERS +------------------- +None. + + +OPTIONAL PARAMETERS +------------------- +state + 'present', 'absent', defaults to 'present'. + +ipacl + IP(-ranges) that have access to the Xymon webpages and CGIs. Apache2-style + syntax suitable for `Require ip ...`. Example: `192.168.1.0/24 10.0.0.0/8` + + +MESSAGES +-------- +mod:rewrite enabled + apache module enabled +conf:xymon enabled + apache config for xymon enabled +apache restarted + apache2.service was reloaded +apache reloaded + apache2.service was restarted + + +EXPLORERS +--------- +active-conf + lists apache2 `conf-enabled` +active-modules + lists active apache2-modules + + +EXAMPLES +-------- + +.. code-block:: sh + + # minmal, only localhost-access: + __xymon_apache + # allow more IPs to access the Xymon-webinterface: + __xymon_apache --ipacl "192.168.0.0/16 10.0.0.0/8" --state "present" + + +SEE ALSO +-------- +:strong:`cdist__xymon_server`\ (7) + + +AUTHORS +------- +Thomas Eckert + + +COPYING +------- +Copyright \(C) 2018-2019 Thomas Eckert. 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__xymon_client.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_client.rst.txt new file mode 100644 index 00000000..6f90c15b --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_client.rst.txt @@ -0,0 +1,57 @@ +cdist-type__xymon_client(7) +=========================== + +NAME +---- +cdist-type__xymon_client - Install the Xymon client + + +DESCRIPTION +----------- +This cdist type installs the Xymon client and configures it to report with +FQDN. + + +REQUIRED PARAMETERS +------------------- +None. + + +OPTIONAL PARAMETERS +------------------- +state + 'present', 'absent', defaults to 'present'. + +servers + One or more IP adresses (space separated) of the Xymon server(s) to report + to. While DNS-names are ok it is discouraged, defaults to 127.0.0.1. + + +EXAMPLES +-------- + +.. code-block:: sh + + # minmal, report to 127.0.0.1 + __xymon_client + + # specify server: + __xymon_client --servers "192.168.1.1" + + +SEE ALSO +-------- +:strong:`cdist__xymon_server`\ (7), :strong:`xymon`\ (7) + + +AUTHORS +------- +Thomas Eckert + + +COPYING +------- +Copyright \(C) 2018-2019 Thomas Eckert. 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__xymon_config.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_config.rst.txt new file mode 100644 index 00000000..8b427ca0 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_config.rst.txt @@ -0,0 +1,57 @@ +cdist-type__xymon_config(7) +=========================== + +NAME +---- +cdist-type__xymon_config - Deploy a Xymon configuration-directory + + +DESCRIPTION +----------- +This cdist type deploys a full Xymon configuration directory from the files-dir +to the host. This type requires an installed Xymon server, e.g. deployed by +`__xymon_server`. + +WARNING: This type _replaces_ the `/etc/xymon/`-directory! The previous +contents is replaced/deleted! + + +REQUIRED PARAMETERS +------------------- +confdir + The directory in `./files/` that contains the `/etc/xymon/`-content to be + deployed. + + +REQUIRED FILES +-------------- +The directory specified by `confdir` has to contain a valid xymon-configuration +(`/etc/xymon/`) _plus_ the `ext/`-directory that normally resides in +`/usr/lib/xymon/server/`. + + +EXAMPLES +-------- + +.. code-block:: sh + + __xymon_config --confdir=xymon.example.com + # this will replace /etc/xymon/ on the target host with + # the contents from __xymon_config/files/xymon.example.com/ + + +SEE ALSO +-------- +:strong:`cdist__xymon_server`\ (7), :strong:`xymon`\ (7) + +AUTHORS +------- +Thomas Eckert + + +COPYING +------- +Copyright \(C) 2018-2019 Thomas Eckert. 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__xymon_server.rst.txt b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_server.rst.txt new file mode 100644 index 00000000..a9a180e1 --- /dev/null +++ b/src/extra/manual/beta/_sources/man7/cdist-type__xymon_server.rst.txt @@ -0,0 +1,87 @@ +cdist-type__xymon_server(7) +=========================== + +NAME +---- +cdist-type__xymon_server - Install a Xymon server + + +DESCRIPTION +----------- +This cdist type installs a Xymon (https://www.xymon.com/) server and (optional) +required helper packages. + +This includes the Xymon client as a dependency, so NO NEED to install +`__xymon_client` separately. + +To access the webinterface a webserver is required. The cdist-type +`__xymon_apache` can be used to install and configure the apache webserver for +the use with Xymon. + +Further and day-to-day configuration of Xymon can either be done manually in +`/etc/xymon/` or the directory can be deployed and managed by `__xymon_config`. + + +REQUIRED PARAMETERS +------------------- +None. + + +OPTIONAL PARAMETERS +------------------- +state + 'present', 'absent', defaults to 'present'. If '--install_helpers' is + specified for 'absent' the helper packages will be un-installed. + + +BOOLEAN PARAMETERS +------------------ +install_helpers + Install helper packages used by Xymon (fping, heirloom-mailx, traceroute, + ntpdate). + + +EXAMPLES +-------- + +.. code-block:: sh + + # minmal + __xymon_server + + # the same + __xymon_server --state present + + # also install helper packages: + __xymon_server --install_helpers + + # examples to give a more complete picture: __xymon_server installed on + # `xymon.example.com` w/ IP 192.168.1.1: + # + # install webserver and grant 2 private subnets access to the webinterface: + __xymon_apache --ipacl "192.168.0.0/16 10.0.0.0/8" + # deploy server-configuration with __xymon_config: + __xymon_config --confdir=xymon.example.com + + # install xymon-client on other machines (not needed on the server): + __xymon_client --servers "192.168.1.1" + + + +SEE ALSO +-------- +:strong:`cdist__xymon_apache`\ (7), :strong:`cdist__xymon_config`\ (7), +:strong:`cdist__xymon_client`\ (7), :strong:`xymon`\ (7) + + +AUTHORS +------- +Thomas Eckert + + +COPYING +------- +Copyright \(C) 2018-2019 Thomas Eckert. 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/cdist-best-practice.html b/src/extra/manual/beta/cdist-best-practice.html index 2e3eee1e..942d552e 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.0.1 documentation + 25. Best practice — cdist 6.0.2 documentation @@ -23,7 +23,7 @@ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

16.134. cdist-type__sensible_editor(7)

+
+

16.134.1. NAME

+

cdist-type__sensible_editor - Select the sensible-editor

+
+
+

16.134.2. DESCRIPTION

+

This cdist type allows you to select the sensible-editor for +a given user.

+
+
+

16.134.3. REQUIRED PARAMETERS

+
+
editor
+

Name or path of the editor to be selected. +On systems other than Debian derivatives an absolute path is required.

+
+
It is permissible to omit this parameter if --state is absent.
+
+
+
+
+

16.134.4. OPTIONAL PARAMETERS

+
+
state
+

'present', 'absent', or 'exists'. Defaults to 'present', where:

+
+
present
+
the sensible-editor is exactly what is specified in --editor.
+
absent
+
no sensible-editor configuration is present.
+
exists
+
the sensible-editor will be set to what is specified in --editor, +unless there already is a configuration on the target system.
+
+
+
+
+
+

16.134.5. EXAMPLES

+
__sensible_editor root --editor /bin/ed  # ed(1) is the standard
+__sensible_editor noob --editor nano
+
+
+
+
+

16.134.6. LIMITATIONS

+

This type depends upon the sensible-editor(1) script which +is part of the sensible-utils package.

+
+
Therefore, the following operating systems are supported:
+
    +
  • Debian 8 (jessie) or later
  • +
  • Devuan
  • +
  • Ubuntu 8.10 (intrepid) or later
  • +
  • RHEL/CentOS 7 or later (EPEL repo required)
  • +
  • Fedora 21 or later
  • +
+
+
+

Note: on old versions of Ubuntu the sensible-* utils are part of the +debianutils package.

+
+
+

16.134.7. SEE ALSO

+

select-editor(1), sensible-editor(1).

+
+
+

16.134.8. AUTHOR

+

Dennis Camera <dennis.camera--@--ssrq-sds-fds.ch>

+
+
+

16.134.9. COPYING

+

Copyright (C) 2019 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.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/src/extra/manual/beta/man7/cdist-type__ssh_authorized_key.html b/src/extra/manual/beta/man7/cdist-type__ssh_authorized_key.html index 0c8e9e8d..be2ebdab 100644 --- a/src/extra/manual/beta/man7/cdist-type__ssh_authorized_key.html +++ b/src/extra/manual/beta/man7/cdist-type__ssh_authorized_key.html @@ -8,7 +8,7 @@ - 16.134. cdist-type__ssh_authorized_key(7) — cdist 6.0.1 documentation + 16.135. cdist-type__ssh_authorized_key(7) — cdist 6.0.2 documentation @@ -23,7 +23,7 @@ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

16.148. cdist-type__xymon_apache(7)

+
+

16.148.1. NAME

+

cdist-type__xymon_apache - Configure apache2-webserver for Xymon

+
+
+

16.148.2. DESCRIPTION

+

This cdist type installs and configures apache2 to be used "exclusively" (in +the sense that no other use is taken care of) with Xymon (the systems and +network monitor).

+

It depends on __xymon_server.

+
+
+

16.148.3. REQUIRED PARAMETERS

+

None.

+
+
+

16.148.4. OPTIONAL PARAMETERS

+
+
state
+
'present', 'absent', defaults to 'present'.
+
ipacl
+
IP(-ranges) that have access to the Xymon webpages and CGIs. Apache2-style +syntax suitable for Require ip .... Example: 192.168.1.0/24 10.0.0.0/8
+
+
+
+

16.148.5. MESSAGES

+
+
mod:rewrite enabled
+
apache module enabled
+
conf:xymon enabled
+
apache config for xymon enabled
+
apache restarted
+
apache2.service was reloaded
+
apache reloaded
+
apache2.service was restarted
+
+
+
+

16.148.6. EXPLORERS

+
+
active-conf
+
lists apache2 conf-enabled
+
active-modules
+
lists active apache2-modules
+
+
+
+

16.148.7. EXAMPLES

+
# minmal, only localhost-access:
+__xymon_apache
+# allow more IPs to access the Xymon-webinterface:
+__xymon_apache --ipacl "192.168.0.0/16 10.0.0.0/8" --state "present"
+
+
+
+
+

16.148.8. SEE ALSO

+

cdist__xymon_server(7)

+
+
+

16.148.9. AUTHORS

+

Thomas Eckert <tom--@--it-eckert.de>

+
+
+

16.148.10. COPYING

+

Copyright (C) 2018-2019 Thomas Eckert. 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.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/src/extra/manual/beta/man7/cdist-type__xymon_client.html b/src/extra/manual/beta/man7/cdist-type__xymon_client.html new file mode 100644 index 00000000..8e38309d --- /dev/null +++ b/src/extra/manual/beta/man7/cdist-type__xymon_client.html @@ -0,0 +1,464 @@ + + + + + + + + + + + 16.149. cdist-type__xymon_client(7) — cdist 6.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

16.149. cdist-type__xymon_client(7)

+
+

16.149.1. NAME

+

cdist-type__xymon_client - Install the Xymon client

+
+
+

16.149.2. DESCRIPTION

+

This cdist type installs the Xymon client and configures it to report with +FQDN.

+
+
+

16.149.3. REQUIRED PARAMETERS

+

None.

+
+
+

16.149.4. OPTIONAL PARAMETERS

+
+
state
+
'present', 'absent', defaults to 'present'.
+
servers
+
One or more IP adresses (space separated) of the Xymon server(s) to report +to. While DNS-names are ok it is discouraged, defaults to 127.0.0.1.
+
+
+
+

16.149.5. EXAMPLES

+
# minmal, report to 127.0.0.1
+__xymon_client
+
+# specify server:
+__xymon_client --servers "192.168.1.1"
+
+
+
+
+

16.149.6. SEE ALSO

+

cdist__xymon_server(7), xymon(7)

+
+
+

16.149.7. AUTHORS

+

Thomas Eckert <tom--@--it-eckert.de>

+
+
+

16.149.8. COPYING

+

Copyright (C) 2018-2019 Thomas Eckert. 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.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/src/extra/manual/beta/man7/cdist-type__xymon_config.html b/src/extra/manual/beta/man7/cdist-type__xymon_config.html new file mode 100644 index 00000000..f4575450 --- /dev/null +++ b/src/extra/manual/beta/man7/cdist-type__xymon_config.html @@ -0,0 +1,465 @@ + + + + + + + + + + + 16.150. cdist-type__xymon_config(7) — cdist 6.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

16.150. cdist-type__xymon_config(7)

+
+

16.150.1. NAME

+

cdist-type__xymon_config - Deploy a Xymon configuration-directory

+
+
+

16.150.2. DESCRIPTION

+

This cdist type deploys a full Xymon configuration directory from the files-dir +to the host. This type requires an installed Xymon server, e.g. deployed by +__xymon_server.

+

WARNING: This type _replaces_ the /etc/xymon/-directory! The previous +contents is replaced/deleted!

+
+
+

16.150.3. REQUIRED PARAMETERS

+
+
confdir
+
The directory in ./files/ that contains the /etc/xymon/-content to be +deployed.
+
+
+
+

16.150.4. REQUIRED FILES

+

The directory specified by confdir has to contain a valid xymon-configuration +(/etc/xymon/) _plus_ the ext/-directory that normally resides in +/usr/lib/xymon/server/.

+
+
+

16.150.5. EXAMPLES

+
__xymon_config --confdir=xymon.example.com
+# this will replace /etc/xymon/ on the target host with
+# the contents from __xymon_config/files/xymon.example.com/
+
+
+
+
+

16.150.6. SEE ALSO

+

cdist__xymon_server(7), xymon(7)

+
+
+

16.150.7. AUTHORS

+

Thomas Eckert <tom--@--it-eckert.de>

+
+
+

16.150.8. COPYING

+

Copyright (C) 2018-2019 Thomas Eckert. 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.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/src/extra/manual/beta/man7/cdist-type__xymon_server.html b/src/extra/manual/beta/man7/cdist-type__xymon_server.html new file mode 100644 index 00000000..33a1bdff --- /dev/null +++ b/src/extra/manual/beta/man7/cdist-type__xymon_server.html @@ -0,0 +1,493 @@ + + + + + + + + + + + 16.151. cdist-type__xymon_server(7) — cdist 6.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

16.151. cdist-type__xymon_server(7)

+
+

16.151.1. NAME

+

cdist-type__xymon_server - Install a Xymon server

+
+
+

16.151.2. DESCRIPTION

+

This cdist type installs a Xymon (https://www.xymon.com/) server and (optional) +required helper packages.

+

This includes the Xymon client as a dependency, so NO NEED to install +__xymon_client separately.

+

To access the webinterface a webserver is required. The cdist-type +__xymon_apache can be used to install and configure the apache webserver for +the use with Xymon.

+

Further and day-to-day configuration of Xymon can either be done manually in +/etc/xymon/ or the directory can be deployed and managed by __xymon_config.

+
+
+

16.151.3. REQUIRED PARAMETERS

+

None.

+
+
+

16.151.4. OPTIONAL PARAMETERS

+
+
state
+
'present', 'absent', defaults to 'present'. If '--install_helpers' is +specified for 'absent' the helper packages will be un-installed.
+
+
+
+

16.151.5. BOOLEAN PARAMETERS

+
+
install_helpers
+
Install helper packages used by Xymon (fping, heirloom-mailx, traceroute, +ntpdate).
+
+
+
+

16.151.6. EXAMPLES

+
# minmal
+__xymon_server
+
+# the same
+__xymon_server --state present
+
+# also install helper packages:
+__xymon_server --install_helpers
+
+# examples to give a more complete picture: __xymon_server installed on
+# `xymon.example.com` w/ IP 192.168.1.1:
+#
+# install webserver and grant 2 private subnets access to the webinterface:
+__xymon_apache --ipacl "192.168.0.0/16 10.0.0.0/8"
+# deploy server-configuration with __xymon_config:
+__xymon_config --confdir=xymon.example.com
+
+# install xymon-client on other machines (not needed on the server):
+__xymon_client --servers "192.168.1.1"
+
+
+
+
+

16.151.7. SEE ALSO

+

cdist__xymon_apache(7), cdist__xymon_config(7), +cdist__xymon_client(7), xymon(7)

+
+
+

16.151.8. AUTHORS

+

Thomas Eckert <tom--@--it-eckert.de>

+
+
+

16.151.9. COPYING

+

Copyright (C) 2018-2019 Thomas Eckert. 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.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/src/extra/manual/beta/man7/cdist-type__yum_repo.html b/src/extra/manual/beta/man7/cdist-type__yum_repo.html index 64e5e387..7e9fa81f 100644 --- a/src/extra/manual/beta/man7/cdist-type__yum_repo.html +++ b/src/extra/manual/beta/man7/cdist-type__yum_repo.html @@ -8,7 +8,7 @@ - 16.147. cdist-type__yum_repo(7) — cdist 6.0.1 documentation + 16.152. cdist-type__yum_repo(7) — cdist 6.0.2 documentation @@ -23,7 +23,7 @@