Update cdist beta docs.
This commit is contained in:
parent
bec13a88c0
commit
d0a54c8b0a
|
@ -12,6 +12,7 @@ The following global explorers are available:
|
||||||
- hostname
|
- hostname
|
||||||
- init
|
- init
|
||||||
- interfaces
|
- interfaces
|
||||||
|
- kernel_name
|
||||||
- lsb_codename
|
- lsb_codename
|
||||||
- lsb_description
|
- lsb_description
|
||||||
- lsb_id
|
- lsb_id
|
||||||
|
@ -160,18 +161,25 @@ The following types are available:
|
||||||
- __consul_watch_service (`cdist-type__consul_watch_service(7) <man7/cdist-type__consul_watch_service.html>`_)
|
- __consul_watch_service (`cdist-type__consul_watch_service(7) <man7/cdist-type__consul_watch_service.html>`_)
|
||||||
- __consul_watch_services (`cdist-type__consul_watch_services(7) <man7/cdist-type__consul_watch_services.html>`_)
|
- __consul_watch_services (`cdist-type__consul_watch_services(7) <man7/cdist-type__consul_watch_services.html>`_)
|
||||||
- __cron (`cdist-type__cron(7) <man7/cdist-type__cron.html>`_)
|
- __cron (`cdist-type__cron(7) <man7/cdist-type__cron.html>`_)
|
||||||
|
- __daemontools (`cdist-type__daemontools(7) <man7/cdist-type__daemontools.html>`_)
|
||||||
|
- __daemontools_service (`cdist-type__daemontools_service(7) <man7/cdist-type__daemontools_service.html>`_)
|
||||||
- __debconf_set_selections (`cdist-type__debconf_set_selections(7) <man7/cdist-type__debconf_set_selections.html>`_)
|
- __debconf_set_selections (`cdist-type__debconf_set_selections(7) <man7/cdist-type__debconf_set_selections.html>`_)
|
||||||
- __directory (`cdist-type__directory(7) <man7/cdist-type__directory.html>`_)
|
- __directory (`cdist-type__directory(7) <man7/cdist-type__directory.html>`_)
|
||||||
- __docker (`cdist-type__docker(7) <man7/cdist-type__docker.html>`_)
|
- __docker (`cdist-type__docker(7) <man7/cdist-type__docker.html>`_)
|
||||||
- __docker_compose (`cdist-type__docker_compose(7) <man7/cdist-type__docker_compose.html>`_)
|
- __docker_compose (`cdist-type__docker_compose(7) <man7/cdist-type__docker_compose.html>`_)
|
||||||
- __dog_vdi (`cdist-type__dog_vdi(7) <man7/cdist-type__dog_vdi.html>`_)
|
- __dog_vdi (`cdist-type__dog_vdi(7) <man7/cdist-type__dog_vdi.html>`_)
|
||||||
|
- __dot_file (`cdist-type__dot_file(7) <man7/cdist-type__dot_file.html>`_)
|
||||||
- __file (`cdist-type__file(7) <man7/cdist-type__file.html>`_)
|
- __file (`cdist-type__file(7) <man7/cdist-type__file.html>`_)
|
||||||
- __filesystem (`cdist-type__filesystem(7) <man7/cdist-type__filesystem.html>`_)
|
- __filesystem (`cdist-type__filesystem(7) <man7/cdist-type__filesystem.html>`_)
|
||||||
- __firewalld_rule (`cdist-type__firewalld_rule(7) <man7/cdist-type__firewalld_rule.html>`_)
|
- __firewalld_rule (`cdist-type__firewalld_rule(7) <man7/cdist-type__firewalld_rule.html>`_)
|
||||||
- __firewalld_start (`cdist-type__firewalld_start(7) <man7/cdist-type__firewalld_start.html>`_)
|
- __firewalld_start (`cdist-type__firewalld_start(7) <man7/cdist-type__firewalld_start.html>`_)
|
||||||
- __git (`cdist-type__git(7) <man7/cdist-type__git.html>`_)
|
- __git (`cdist-type__git(7) <man7/cdist-type__git.html>`_)
|
||||||
|
- __go_get (`cdist-type__go_get(7) <man7/cdist-type__go_get.html>`_)
|
||||||
|
- __golang_from_vendor (`cdist-type__golang_from_vendor(7) <man7/cdist-type__golang_from_vendor.html>`_)
|
||||||
|
- __grafana_dashboard (`cdist-type__grafana_dashboard(7) <man7/cdist-type__grafana_dashboard.html>`_)
|
||||||
- __group (`cdist-type__group(7) <man7/cdist-type__group.html>`_)
|
- __group (`cdist-type__group(7) <man7/cdist-type__group.html>`_)
|
||||||
- __hostname (`cdist-type__hostname(7) <man7/cdist-type__hostname.html>`_)
|
- __hostname (`cdist-type__hostname(7) <man7/cdist-type__hostname.html>`_)
|
||||||
|
- __hosts (`cdist-type__hosts(7) <man7/cdist-type__hosts.html>`_)
|
||||||
- __install_bootloader_grub (`cdist-type__install_bootloader_grub(7) <man7/cdist-type__install_bootloader_grub.html>`_)
|
- __install_bootloader_grub (`cdist-type__install_bootloader_grub(7) <man7/cdist-type__install_bootloader_grub.html>`_)
|
||||||
- __install_chroot_mount (`cdist-type__install_chroot_mount(7) <man7/cdist-type__install_chroot_mount.html>`_)
|
- __install_chroot_mount (`cdist-type__install_chroot_mount(7) <man7/cdist-type__install_chroot_mount.html>`_)
|
||||||
- __install_chroot_umount (`cdist-type__install_chroot_umount(7) <man7/cdist-type__install_chroot_umount.html>`_)
|
- __install_chroot_umount (`cdist-type__install_chroot_umount(7) <man7/cdist-type__install_chroot_umount.html>`_)
|
||||||
|
@ -232,6 +240,8 @@ The following types are available:
|
||||||
- __postgres_extension (`cdist-type__postgres_extension(7) <man7/cdist-type__postgres_extension.html>`_)
|
- __postgres_extension (`cdist-type__postgres_extension(7) <man7/cdist-type__postgres_extension.html>`_)
|
||||||
- __postgres_role (`cdist-type__postgres_role(7) <man7/cdist-type__postgres_role.html>`_)
|
- __postgres_role (`cdist-type__postgres_role(7) <man7/cdist-type__postgres_role.html>`_)
|
||||||
- __process (`cdist-type__process(7) <man7/cdist-type__process.html>`_)
|
- __process (`cdist-type__process(7) <man7/cdist-type__process.html>`_)
|
||||||
|
- __prometheus_alertmanager (`cdist-type__prometheus_alertmanager(7) <man7/cdist-type__prometheus_alertmanager.html>`_)
|
||||||
|
- __prometheus_server (`cdist-type__prometheus_server(7) <man7/cdist-type__prometheus_server.html>`_)
|
||||||
- __pyvenv (`cdist-type__pyvenv(7) <man7/cdist-type__pyvenv.html>`_)
|
- __pyvenv (`cdist-type__pyvenv(7) <man7/cdist-type__pyvenv.html>`_)
|
||||||
- __qemu_img (`cdist-type__qemu_img(7) <man7/cdist-type__qemu_img.html>`_)
|
- __qemu_img (`cdist-type__qemu_img(7) <man7/cdist-type__qemu_img.html>`_)
|
||||||
- __rbenv (`cdist-type__rbenv(7) <man7/cdist-type__rbenv.html>`_)
|
- __rbenv (`cdist-type__rbenv(7) <man7/cdist-type__rbenv.html>`_)
|
|
@ -53,17 +53,19 @@ SYNOPSIS
|
||||||
cdist preos [-h] preos
|
cdist preos [-h] preos
|
||||||
|
|
||||||
cdist preos debian [-h] [-d] [-v] [-b] [-a ARCH] [-B] [-C]
|
cdist preos debian [-h] [-d] [-v] [-b] [-a ARCH] [-B] [-C]
|
||||||
[-c CDIST_PARAMS] [-e REMOTE_EXEC] [-i MANIFEST]
|
[-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
|
||||||
[-k [KEYFILE [KEYFILE ...]]] [-m MIRROR]
|
[-i MANIFEST] [-k KEYFILE ] [-m MIRROR]
|
||||||
[-p PXE_BOOT_DIR] [-r] [-S SCRIPT] [-s SUITE]
|
[-P ROOT_PASSWORD] [-p PXE_BOOT_DIR] [-r]
|
||||||
[-t TRIGGER_COMMAND] [-y REMOTE_COPY]
|
[-S SCRIPT] [-s SUITE] [-t TRIGGER_COMMAND]
|
||||||
|
[-y REMOTE_COPY]
|
||||||
target_dir
|
target_dir
|
||||||
|
|
||||||
cdist preos ubuntu [-h] [-d] [-v] [-b] [-a ARCH] [-B] [-C]
|
cdist preos ubuntu [-h] [-d] [-v] [-b] [-a ARCH] [-B] [-C]
|
||||||
[-c CDIST_PARAMS] [-e REMOTE_EXEC] [-i MANIFEST]
|
[-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
|
||||||
[-k [KEYFILE [KEYFILE ...]]] [-m MIRROR]
|
[-i MANIFEST] [-k KEYFILE ] [-m MIRROR]
|
||||||
[-p PXE_BOOT_DIR] [-r] [-S SCRIPT] [-s SUITE]
|
[-P ROOT_PASSWORD] [-p PXE_BOOT_DIR] [-r]
|
||||||
[-t TRIGGER_COMMAND] [-y REMOTE_COPY]
|
[-S SCRIPT] [-s SUITE] [-t TRIGGER_COMMAND]
|
||||||
|
[-y REMOTE_COPY]
|
||||||
target_dir
|
target_dir
|
||||||
|
|
||||||
cdist shell [-h] [-d] [-v] [-s SHELL]
|
cdist shell [-h] [-d] [-v] [-s SHELL]
|
||||||
|
@ -96,9 +98,10 @@ All commands accept the following options:
|
||||||
|
|
||||||
.. option:: -v, --verbose
|
.. option:: -v, --verbose
|
||||||
|
|
||||||
Increase log level, be more verbose. Use it more than once to increase
|
Increase the verbosity level. Every instance of -v increments the verbosity
|
||||||
log level. The order of levels from the lowest to the highest are:
|
level by one. Its default value is 0. There are 4 levels of verbosity. The
|
||||||
ERROR, WARNING, INFO, DEBUG.
|
order of levels from the lowest to the highest are: ERROR (0), WARNING (1),
|
||||||
|
INFO (2) and DEBUG (3 or higher).
|
||||||
|
|
||||||
.. option:: -V, --version
|
.. option:: -V, --version
|
||||||
|
|
||||||
|
@ -512,6 +515,10 @@ PREOS DEBIAN
|
||||||
parameters that will be passed to cdist config, by
|
parameters that will be passed to cdist config, by
|
||||||
default '-v' is used
|
default '-v' is used
|
||||||
|
|
||||||
|
.. option:: -D DRIVE, --drive-boot DRIVE
|
||||||
|
|
||||||
|
create bootable PreOS on specified drive
|
||||||
|
|
||||||
.. option:: -d, --debug
|
.. option:: -d, --debug
|
||||||
|
|
||||||
Set log level to debug
|
Set log level to debug
|
||||||
|
@ -530,7 +537,7 @@ PREOS DEBIAN
|
||||||
init manifest that cdist config will use, by default
|
init manifest that cdist config will use, by default
|
||||||
internal init manifest is used
|
internal init manifest is used
|
||||||
|
|
||||||
.. option:: -k [KEYFILE [KEYFILE ...]], --keyfile [KEYFILE [KEYFILE ...]]
|
.. option:: -k KEYFILE, --keyfile KEYFILE
|
||||||
|
|
||||||
ssh key files that will be added to cdist config;
|
ssh key files that will be added to cdist config;
|
||||||
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
||||||
|
@ -539,6 +546,10 @@ PREOS DEBIAN
|
||||||
|
|
||||||
use specified mirror for debootstrap
|
use specified mirror for debootstrap
|
||||||
|
|
||||||
|
.. option:: -P ROOT_PASSWORD, --root-password ROOT_PASSWORD
|
||||||
|
|
||||||
|
Set specified password for root, generated by default
|
||||||
|
|
||||||
.. option:: -p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR
|
.. option:: -p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR
|
||||||
|
|
||||||
PXE boot directory
|
PXE boot directory
|
||||||
|
@ -600,6 +611,10 @@ PREOS UBUNTU
|
||||||
parameters that will be passed to cdist config, by
|
parameters that will be passed to cdist config, by
|
||||||
default '-v' is used
|
default '-v' is used
|
||||||
|
|
||||||
|
.. option:: -D DRIVE, --drive-boot DRIVE
|
||||||
|
|
||||||
|
create bootable PreOS on specified drive
|
||||||
|
|
||||||
.. option:: -d, --debug
|
.. option:: -d, --debug
|
||||||
|
|
||||||
Set log level to debug
|
Set log level to debug
|
||||||
|
@ -618,7 +633,7 @@ PREOS UBUNTU
|
||||||
init manifest that cdist config will use, by default
|
init manifest that cdist config will use, by default
|
||||||
internal init manifest is used
|
internal init manifest is used
|
||||||
|
|
||||||
.. option:: -k [KEYFILE [KEYFILE ...]], --keyfile [KEYFILE [KEYFILE ...]]
|
.. option:: -k KEYFILE, --keyfile KEYFILE
|
||||||
|
|
||||||
ssh key files that will be added to cdist config;
|
ssh key files that will be added to cdist config;
|
||||||
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
||||||
|
@ -627,6 +642,10 @@ PREOS UBUNTU
|
||||||
|
|
||||||
use specified mirror for debootstrap
|
use specified mirror for debootstrap
|
||||||
|
|
||||||
|
.. option:: -P ROOT_PASSWORD, --root-password ROOT_PASSWORD
|
||||||
|
|
||||||
|
Set specified password for root, generated by default
|
||||||
|
|
||||||
.. option:: -p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR
|
.. option:: -p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR
|
||||||
|
|
||||||
PXE boot directory
|
PXE boot directory
|
||||||
|
@ -859,6 +878,13 @@ EXAMPLES
|
||||||
-k ~/.ssh/id_rsa.pub -p /preos/pxe-ubuntu \
|
-k ~/.ssh/id_rsa.pub -p /preos/pxe-ubuntu \
|
||||||
-t "/usr/bin/curl 192.168.111.5:3000/install/"
|
-t "/usr/bin/curl 192.168.111.5:3000/install/"
|
||||||
|
|
||||||
|
# Create ubuntu PreOS on drive /dev/sdb with install trigger command
|
||||||
|
# and set root password to 'password'.
|
||||||
|
$ cdist preos ubuntu /mnt -b -B -C \
|
||||||
|
-k ~/.ssh/id_rsa.pub -D /dev/sdb \
|
||||||
|
-t "/usr/bin/curl 192.168.111.5:3000/install/" \
|
||||||
|
-P password
|
||||||
|
|
||||||
# Start trigger in verbose mode that will configure host using specified
|
# Start trigger in verbose mode that will configure host using specified
|
||||||
# init manifest
|
# init manifest
|
||||||
% cdist trigger -b -v -i ~/.cdist/manifest/init-for-triggered
|
% cdist trigger -b -v -i ~/.cdist/manifest/init-for-triggered
|
||||||
|
@ -930,12 +956,12 @@ This limit is controlled with sshd :strong:`MaxSessions` configuration
|
||||||
options. For more details refer to :strong:`sshd_config`\ (5).
|
options. For more details refer to :strong:`sshd_config`\ (5).
|
||||||
|
|
||||||
When requirements for the same object are defined in different manifests (see
|
When requirements for the same object are defined in different manifests (see
|
||||||
example below) in init manifest and in some other type manifest and they differs
|
example below), for example, in init manifest and in some other type manifest
|
||||||
then dependency resolver cannot detect dependencies right. This happens because
|
and those requirements differ then dependency resolver cannot detect
|
||||||
cdist cannot prepare all objects first and then run objects because some
|
dependencies right. This happens because cdist cannot prepare all objects first
|
||||||
object can depend on the result of type explorer(s) and explorers are executed
|
and run all objects afterwards. Some object can depend on the result of type
|
||||||
during object run. cdist will detect such case and write warning message.
|
explorer(s) and explorers are executed during object run. cdist will detect
|
||||||
Example for such a case:
|
such case and write warning message. Example for such a case:
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
|
@ -960,5 +986,5 @@ Example for such a case:
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011-2013 Nico Schottelius. Free use of this software is
|
Copyright \(C) 2011-2017 Nico Schottelius. Free use of this software is
|
||||||
granted under the terms of the GNU General Public License v3 or later (GPLv3+).
|
granted under the terms of the GNU General Public License v3 or later (GPLv3+).
|
|
@ -24,6 +24,9 @@ OPTIONAL PARAMETERS
|
||||||
check-interval
|
check-interval
|
||||||
the interval in which the script given with --check-script should be run
|
the interval in which the script given with --check-script should be run
|
||||||
|
|
||||||
|
check-http
|
||||||
|
the URL to check for HTTP 200-ish status every --check-interval
|
||||||
|
|
||||||
check-script
|
check-script
|
||||||
the shell command to run every --check-interval
|
the shell command to run every --check-interval
|
||||||
|
|
|
@ -0,0 +1,49 @@
|
||||||
|
cdist-type__daemontools(7)
|
||||||
|
==========================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__daemontools - Install daemontools
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
Install djb daemontools and (optionally) an init script.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
from-package
|
||||||
|
Package to install. Must be compatible with the original daemontools. Example: daemontools-encore. Default: daemontools.
|
||||||
|
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
------------------
|
||||||
|
install-init-script
|
||||||
|
Add an init script and set it to start on boot. Default yes.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__daemontools --from-package daemontools-encore # if you prefer
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
:strong:`cdist-type__daemontools_service`\ (7)
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Kamila Součková <kamila--@--ksp.sk>
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2017 Kamila Součková. 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.
|
|
@ -0,0 +1,72 @@
|
||||||
|
cdist-type__daemontools_service(7)
|
||||||
|
==================================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__daemontools_service - Create a daemontools-compatible service dir.
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
Create a directory structure compatible with daemontools-like service management.
|
||||||
|
|
||||||
|
Note that svc must be present on the target system.
|
||||||
|
|
||||||
|
The object ID will be used as the service name.
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
run
|
||||||
|
Command to run. exec-ing and stderr redirection will be added. One of run, run-file must be specified.
|
||||||
|
|
||||||
|
Example: `my-program`
|
||||||
|
|
||||||
|
run-file
|
||||||
|
File to save as <servicedir>/run. One of run, run-file must be specified.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
#!/bin/sh
|
||||||
|
exec 2>&1
|
||||||
|
exec my_program
|
||||||
|
|
||||||
|
|
||||||
|
log-run
|
||||||
|
Command to run for log consumption. Default: `multilog t ./main`
|
||||||
|
|
||||||
|
servicedir
|
||||||
|
Directory to install into. Default: `/service`
|
||||||
|
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
require="__daemontools" __daemontools_service prometheus --run "setuidgid prometheus $GOBIN/prometheus $FLAGS"
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
:strong:`cdist-type__daemontools`\ (7)
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Kamila Součková <kamila--@--ksp.sk>
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2017 Kamila Součková. 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.
|
|
@ -26,17 +26,24 @@ BOOLEAN PARAMETERS
|
||||||
experimental
|
experimental
|
||||||
Install the experimental docker-engine package instead of the latest stable release.
|
Install the experimental docker-engine package instead of the latest stable release.
|
||||||
|
|
||||||
|
state
|
||||||
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install docker
|
||||||
__docker
|
__docker
|
||||||
|
|
||||||
# experimental
|
# Install experimental
|
||||||
__docker --experimental
|
__docker --experimental
|
||||||
|
|
||||||
|
# Remove docker
|
||||||
|
__docker --state absent
|
||||||
|
|
||||||
|
|
||||||
AUTHORS
|
AUTHORS
|
||||||
-------
|
-------
|
|
@ -9,6 +9,8 @@ cdist-type__docker_compose - install docker-compose
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Installs docker-compose package.
|
Installs docker-compose package.
|
||||||
|
State 'absent' will not remove docker binary itself,
|
||||||
|
only docker-compose binary will be removed
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
|
@ -21,6 +23,9 @@ OPTIONAL PARAMETERS
|
||||||
version
|
version
|
||||||
Define docker_compose version, defaults to "1.9.0"
|
Define docker_compose version, defaults to "1.9.0"
|
||||||
|
|
||||||
|
state
|
||||||
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
|
@ -32,11 +37,15 @@ EXAMPLES
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install docker-compose
|
||||||
__docker_compose
|
__docker_compose
|
||||||
|
|
||||||
# Install version 1.9.0-rc4
|
# Install version 1.9.0-rc4
|
||||||
__docker_compose --version 1.9.0-rc4
|
__docker_compose --version 1.9.0-rc4
|
||||||
|
|
||||||
|
# Remove docker-compose
|
||||||
|
__docker_compose --state absent
|
||||||
|
|
||||||
|
|
||||||
AUTHORS
|
AUTHORS
|
||||||
-------
|
-------
|
|
@ -0,0 +1,71 @@
|
||||||
|
cdist-type__dot_file(7)
|
||||||
|
========================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
|
||||||
|
cdist-type__dot_file - install file under user's home directory
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
|
||||||
|
This type installs a file (=\ *__object_id*) under user's home directory,
|
||||||
|
providing a way to install per-user configuration files. File owner
|
||||||
|
and group is deduced from user, for who file is installed.
|
||||||
|
|
||||||
|
Unlike regular __file type, you do not need make any assumptions,
|
||||||
|
where user's home directory is.
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
user
|
||||||
|
User, for who file is installed
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
mode
|
||||||
|
forwarded to :strong:`__file` type
|
||||||
|
|
||||||
|
state
|
||||||
|
forwarded to :strong:`__file` type
|
||||||
|
|
||||||
|
source
|
||||||
|
forwarded to :strong:`__file` type
|
||||||
|
|
||||||
|
MESSAGES
|
||||||
|
--------
|
||||||
|
|
||||||
|
This type inherits all messages from :strong:`file` type, and do not add
|
||||||
|
any new.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install .forward file for user 'alice'. Since state is 'present',
|
||||||
|
# user is not meant to edit this file, all changes will be overridden.
|
||||||
|
# It is good idea to put warning about it in file itself.
|
||||||
|
__dot_file .forward --user alice --source "$__files/forward"
|
||||||
|
|
||||||
|
# Install .muttrc for user 'bob', if not already present. User can safely
|
||||||
|
# edit it, his changes will not be overwritten.
|
||||||
|
__dot_file .muttrc --user bob --source "$__files/recommended_mutt_config" --state exists
|
||||||
|
|
||||||
|
|
||||||
|
# Install default xmonad config for user 'eve'. Parent directory is created automatically.
|
||||||
|
__dot_file .xmonad/xmonad.hs --user eve --state exists --source "$__files/xmonad.hs"
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
|
||||||
|
**cdist-type__file**\ (7)
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
|
||||||
|
Copyright (C) 2015 Dmitry Bogatov. Free use of this software is granted
|
||||||
|
under the terms of the GNU General Public License version 3 or later
|
||||||
|
(GPLv3+).
|
|
@ -38,7 +38,7 @@ EXAMPLES
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
# Allow acces from entrance.place4.ungleich.ch
|
# Allow access from entrance.place4.ungleich.ch
|
||||||
__firewalld_rule entrance \
|
__firewalld_rule entrance \
|
||||||
--protocol ipv4 \
|
--protocol ipv4 \
|
||||||
--table filter \
|
--table filter \
|
|
@ -0,0 +1,48 @@
|
||||||
|
cdist-type__go_get(7)
|
||||||
|
=====================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__go_get - Install go packages with go get
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to install golang packages with go get.
|
||||||
|
A sufficiently recent version of go must be present on the system.
|
||||||
|
|
||||||
|
The object ID is the go package to be installed.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__go_get github.com/prometheus/prometheus/cmd/...
|
||||||
|
|
||||||
|
# usually you'd need to require golang from somewhere:
|
||||||
|
require="__golang_from_vendor" __go_get github.com/prometheus/prometheus/cmd/...
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Kamila Součková <kamila@ksp.sk>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2017 Kamila Součková. 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.
|
|
@ -0,0 +1,48 @@
|
||||||
|
cdist-type__golang_from_vendor(7)
|
||||||
|
=================================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__golang_from_vendor - Install any version of golang from golang.org
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to install golang from archives provided by https://golang.org/dl/.
|
||||||
|
|
||||||
|
See https://golang.org/dl/ for the list of supported versions, operating systems and architectures.
|
||||||
|
|
||||||
|
This is a singleton type.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
version
|
||||||
|
The golang version to install, defaults to 1.8.1
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__golang_from_vendor --version 1.8.1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Kamila Součková <kamila@ksp.sk>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2017 Kamila Součková. 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.
|
|
@ -0,0 +1,43 @@
|
||||||
|
cdist-type__grafana_dashboard(7)
|
||||||
|
================================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__grafana_dashboard - Install Grafana (https://grafana.com)
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type adds the Grafana repository, installs the grafana package, and sets the server to start on boot.
|
||||||
|
|
||||||
|
This is a singleton type.
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__grafana_dashboard
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Kamila Součková <kamila@ksp.sk>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2017 Kamila Součková. 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.
|
|
@ -0,0 +1,55 @@
|
||||||
|
cdist-type__hosts(7)
|
||||||
|
====================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
|
||||||
|
cdist-type__hosts - manage entries in /etc/hosts
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Add or remove entries from */etc/hosts* file.
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
state
|
||||||
|
If state is ``present``, make *object_id* resolve to *ip*. If
|
||||||
|
state is ``absent``, *object_id* will no longer resolve via
|
||||||
|
*/etc/hosts*, if it was previously configured with this type.
|
||||||
|
Manually inserted entries are unaffected.
|
||||||
|
|
||||||
|
ip
|
||||||
|
IP address, to which hostname (=\ *object_id*) must resolve. If
|
||||||
|
state is ``present``, this parameter is mandatory, if state is
|
||||||
|
``absent``, this parameter is silently ignored.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Now `funny' resolves to 192.168.1.76,
|
||||||
|
__hosts funny --ip 192.168.1.76
|
||||||
|
# and `happy' no longer resolve via /etc/hosts if it was
|
||||||
|
# previously configured via __hosts.
|
||||||
|
__hosts happy --state absent
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
|
||||||
|
:strong:`hosts`\ (5)
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
|
||||||
|
Dmitry Bogatov <KAction@gnu.org>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
|
||||||
|
Copyright (C) 2015,2016 Dmitry Bogatov. Free use of this software is granted
|
||||||
|
under the terms of the GNU General Public License version 3 or later
|
||||||
|
(GPLv3+).
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue