Merge pull request #436 from darko-poljak/new-docs-format
New docs format - reStructuredText (sphinx)
This commit is contained in:
Darko Poljak
commit
69ffab3174
139 changed files with 4029 additions and 3699 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -20,6 +20,9 @@ MANIFEST
|
||||||
dist/
|
dist/
|
||||||
cdist/version.py
|
cdist/version.py
|
||||||
|
|
||||||
|
#sphinx build dir
|
||||||
|
_build/
|
||||||
|
|
||||||
# Packaging: Archlinux
|
# Packaging: Archlinux
|
||||||
/PKGBUILD
|
/PKGBUILD
|
||||||
/cdist-*.pkg.tar.xz
|
/cdist-*.pkg.tar.xz
|
||||||
|
|
|
||||||
76
Makefile
76
Makefile
|
|
@ -18,15 +18,6 @@
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
|
|
||||||
A2XM=a2x -f manpage --no-xmllint -a encoding=UTF-8
|
|
||||||
A2XH=a2x -f xhtml --no-xmllint -a encoding=UTF-8
|
|
||||||
# Create cross-links in html man pages
|
|
||||||
# We look for something like "cdist-type(7)" and make a href out of it
|
|
||||||
# The first matching group is the man page name and the second group
|
|
||||||
# is the man page section (1 or 7). The first three lines of the input
|
|
||||||
# (xml, DOCTYPE, head tags) are ignored, since the head tags contains
|
|
||||||
# the title of the page and should not contain a href.
|
|
||||||
CROSSLINK=sed -i '' '1,3!s/\([[:alnum:]_-]*\)(\([17]\))/<a href="..\/man\2\/\1.html">&<\/a>/g'
|
|
||||||
helper=./bin/build-helper
|
helper=./bin/build-helper
|
||||||
|
|
||||||
MANDIR=docs/man
|
MANDIR=docs/man
|
||||||
|
|
@ -45,6 +36,8 @@ CHANGELOG_FILE=docs/changelog
|
||||||
|
|
||||||
PYTHON_VERSION=cdist/version.py
|
PYTHON_VERSION=cdist/version.py
|
||||||
|
|
||||||
|
SPHINXM=make -C $(MANDIR) man
|
||||||
|
SPHINXH=make -C $(MANDIR) html
|
||||||
################################################################################
|
################################################################################
|
||||||
# Manpages
|
# Manpages
|
||||||
#
|
#
|
||||||
|
|
@ -52,59 +45,42 @@ MAN1DSTDIR=$(MANDIR)/man1
|
||||||
MAN7DSTDIR=$(MANDIR)/man7
|
MAN7DSTDIR=$(MANDIR)/man7
|
||||||
|
|
||||||
# Manpages #1: Types
|
# Manpages #1: Types
|
||||||
# Use shell / ls to get complete list - $(TYPEDIR)/*/man.text does not work
|
# Use shell / ls to get complete list - $(TYPEDIR)/*/man.rst does not work
|
||||||
MANTYPESRC=$(shell ls $(TYPEDIR)/*/man.text)
|
MANTYPESRC=$(shell ls $(TYPEDIR)/*/man.rst)
|
||||||
|
|
||||||
# replace first path component
|
|
||||||
MANTYPEPREFIX=$(subst $(TYPEDIR)/,$(MAN7DSTDIR)/cdist-type,$(MANTYPESRC))
|
MANTYPEPREFIX=$(subst $(TYPEDIR)/,$(MAN7DSTDIR)/cdist-type,$(MANTYPESRC))
|
||||||
|
MANTYPES=$(subst /man.rst,.rst,$(MANTYPEPREFIX))
|
||||||
|
|
||||||
# replace man.text with .7 or .html
|
# Link manpage: do not create man.html but correct named file
|
||||||
MANTYPEMAN=$(subst /man.text,.7,$(MANTYPEPREFIX))
|
$(MAN7DSTDIR)/cdist-type%.rst: $(TYPEDIR)/%/man.rst
|
||||||
MANTYPEHTML=$(subst /man.text,.html,$(MANTYPEPREFIX))
|
|
||||||
MANTYPEALL=$(MANTYPEMAN) $(MANTYPEHTML)
|
|
||||||
|
|
||||||
# Link manpage so A2XH does not create man.html but correct named file
|
|
||||||
$(MAN7DSTDIR)/cdist-type%.text: $(TYPEDIR)/%/man.text
|
|
||||||
ln -sf "../../../$^" $@
|
ln -sf "../../../$^" $@
|
||||||
|
|
||||||
# Manpages #2: reference
|
# Manpages #2: reference
|
||||||
MANREF=$(MAN7DSTDIR)/cdist-reference.text
|
MANREF=$(MAN7DSTDIR)/cdist-reference.rst
|
||||||
MANREFSH=$(MANDIR)/cdist-reference.text.sh
|
MANREFSH=$(MANDIR)/cdist-reference.rst.sh
|
||||||
MANREFMAN=$(MANREF:.text=.7)
|
|
||||||
MANREFHTML=$(MANREF:.text=.html)
|
|
||||||
MANREFALL=$(MANREFMAN) $(MANREFHTML)
|
|
||||||
|
|
||||||
$(MANREF): $(MANREFSH)
|
$(MANREF): $(MANREFSH)
|
||||||
$(MANREFSH)
|
$(MANREFSH)
|
||||||
|
|
||||||
# Manpages #3: static pages
|
# Manpages #3: generic part
|
||||||
MAN1STATIC=$(shell ls $(MAN1DSTDIR)/*.text)
|
mansphinxman: $(MANTYPES) $(MANREF)
|
||||||
MAN7STATIC=$(shell ls $(MAN7DSTDIR)/*.text)
|
$(SPHINXM)
|
||||||
MANSTATICMAN=$(MAN1STATIC:.text=.1) $(MAN7STATIC:.text=.7)
|
|
||||||
MANSTATICHTML=$(MAN1STATIC:.text=.html) $(MAN7STATIC:.text=.html)
|
|
||||||
MANSTATICALL=$(MANSTATICMAN) $(MANSTATICHTML)
|
|
||||||
|
|
||||||
# Manpages #4: generic part
|
mansphinxhtml: $(MANTYPES) $(MANREF)
|
||||||
|
$(SPHINXH)
|
||||||
|
|
||||||
# Creating the type manpage
|
man: mansphinxman mansphinxhtml
|
||||||
%.1 %.7: %.text
|
|
||||||
$(A2XM) $^
|
|
||||||
|
|
||||||
# Creating the type html page
|
|
||||||
%.html: %.text
|
|
||||||
$(A2XH) $^
|
|
||||||
$(CROSSLINK) $@
|
|
||||||
|
|
||||||
man: $(MANTYPEALL) $(MANREFALL) $(MANSTATICALL)
|
|
||||||
|
|
||||||
# Manpages #5: release part
|
# Manpages #5: release part
|
||||||
MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
|
MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
|
||||||
|
MANBUILDDIR=$(MANDIR)/_build/html
|
||||||
|
|
||||||
man-dist: man check-date
|
man-dist: man
|
||||||
rm -rf "${MANWEBDIR}"
|
rm -rf "${MANWEBDIR}"
|
||||||
mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7"
|
mkdir -p "${MANWEBDIR}"
|
||||||
cp ${MAN1DSTDIR}/*.html ${MAN1DSTDIR}/*.css ${MANWEBDIR}/man1
|
# mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7"
|
||||||
cp ${MAN7DSTDIR}/*.html ${MAN7DSTDIR}/*.css ${MANWEBDIR}/man7
|
# cp ${MAN1DSTDIR}/*.html ${MAN1DSTDIR}/*.css ${MANWEBDIR}/man1
|
||||||
|
# cp ${MAN7DSTDIR}/*.html ${MAN7DSTDIR}/*.css ${MANWEBDIR}/man7
|
||||||
|
cp -R ${MANBUILDDIR}/* ${MANWEBDIR}
|
||||||
cd ${MANWEBDIR} && git add . && git commit -m "cdist manpages update: $(CHANGELOG_VERSION)" || true
|
cd ${MANWEBDIR} && git add . && git commit -m "cdist manpages update: $(CHANGELOG_VERSION)" || true
|
||||||
|
|
||||||
man-latest-link: web-pub
|
man-latest-link: web-pub
|
||||||
|
|
@ -216,15 +192,13 @@ release:
|
||||||
#
|
#
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f $(MAN7DSTDIR)/cdist-reference.text
|
rm -f $(MAN7DSTDIR)/cdist-reference.rst
|
||||||
|
|
||||||
find "$(MANDIR)" -mindepth 2 -type l \
|
find "$(MANDIR)" -mindepth 2 -type l \
|
||||||
-o -name "*.1" \
|
|
||||||
-o -name "*.7" \
|
|
||||||
-o -name "*.html" \
|
|
||||||
-o -name "*.xml" \
|
|
||||||
| xargs rm -f
|
| xargs rm -f
|
||||||
|
|
||||||
|
make -C $(MANDIR) clean
|
||||||
|
|
||||||
find * -name __pycache__ | xargs rm -rf
|
find * -name __pycache__ | xargs rm -rf
|
||||||
|
|
||||||
# Archlinux
|
# Archlinux
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_key(7)
|
cdist-type__apt_key(7)
|
||||||
======================
|
======================
|
||||||
|
Manage the list of keys used by apt
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_key - manage the list of keys used by apt
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Manages the list of keys used by apt to authenticate packages.
|
Manages the list of keys used by apt to authenticate packages.
|
||||||
|
|
@ -20,13 +17,13 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent'. Defaults to 'present'
|
'present' or 'absent'. Defaults to 'present'
|
||||||
|
|
||||||
keyid::
|
keyid
|
||||||
the id of the key to add. Defaults to __object_id
|
the id of the key to add. Defaults to __object_id
|
||||||
|
|
||||||
keyserver::
|
keyserver
|
||||||
the keyserver from which to fetch the key. If omitted the default set in
|
the keyserver from which to fetch the key. If omitted the default set in
|
||||||
./parameter/default/keyserver is used.
|
./parameter/default/keyserver is used.
|
||||||
|
|
||||||
|
|
@ -34,25 +31,25 @@ keyserver::
|
||||||
EXAMPLES
|
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
|
|
||||||
|
|
||||||
# same thing with human readable name and explicit keyid
|
# Add Ubuntu Archive Automatic Signing Key
|
||||||
__apt_key UbuntuArchiveKey --keyid 437D05B5
|
__apt_key 437D05B5
|
||||||
|
# Same thing
|
||||||
|
__apt_key 437D05B5 --state present
|
||||||
|
# Get rid of it
|
||||||
|
__apt_key 437D05B5 --state absent
|
||||||
|
|
||||||
# same thing with other keyserver
|
# same thing with human readable name and explicit keyid
|
||||||
__apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com
|
__apt_key UbuntuArchiveKey --keyid 437D05B5
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# same thing with other keyserver
|
||||||
|
__apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_key_uri(7)
|
cdist-type__apt_key_uri(7)
|
||||||
==========================
|
==========================
|
||||||
|
Add apt key from uri
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_key_uri - add apt key from uri
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Download a key from an uri and add it to the apt keyring.
|
Download a key from an uri and add it to the apt keyring.
|
||||||
|
|
@ -15,16 +12,16 @@ Download a key from an uri and add it to the apt keyring.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
uri::
|
uri
|
||||||
the uri from which to download the key
|
the uri from which to download the key
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
name::
|
name
|
||||||
a name for this key, used when testing if it is already installed.
|
a name for this key, used when testing if it is already installed.
|
||||||
Defaults to __object_id
|
Defaults to __object_id
|
||||||
|
|
||||||
|
|
@ -32,17 +29,17 @@ name::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__apt_key_uri rabbitmq \
|
|
||||||
|
__apt_key_uri rabbitmq \
|
||||||
--name 'RabbitMQ Release Signing Key <info@rabbitmq.com>' \
|
--name 'RabbitMQ Release Signing Key <info@rabbitmq.com>' \
|
||||||
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc \
|
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc \
|
||||||
--state present
|
--state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_norecommends(7)
|
cdist-type__apt_norecommends(7)
|
||||||
===============================
|
===============================
|
||||||
|
Configure apt to not install recommended packages
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_norecommends - configure apt to not install recommended packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Configure apt to not install any recommended or suggested packages.
|
Configure apt to not install any recommended or suggested packages.
|
||||||
|
|
@ -26,14 +23,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__apt_norecommends
|
|
||||||
--------------------------------------------------------------------------------
|
__apt_norecommends
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_ppa(7)
|
cdist-type__apt_ppa(7)
|
||||||
======================
|
======================
|
||||||
|
Manage ppa repositories
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_ppa - Manage ppa repositories
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows manage ubuntu ppa repositories.
|
This cdist type allows manage ubuntu ppa repositories.
|
||||||
|
|
@ -15,7 +12,7 @@ This cdist type allows manage ubuntu ppa repositories.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
The state the ppa should be in, either 'present' or 'absent'.
|
The state the ppa should be in, either 'present' or 'absent'.
|
||||||
Defaults to 'present'
|
Defaults to 'present'
|
||||||
|
|
||||||
|
|
@ -28,20 +25,20 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Enable a ppa repository
|
|
||||||
__apt_ppa ppa:sans-intern/missing-bits
|
|
||||||
# same as
|
|
||||||
__apt_ppa ppa:sans-intern/missing-bits --state present
|
|
||||||
|
|
||||||
# Disable a ppa repository
|
# Enable a ppa repository
|
||||||
__apt_ppa ppa:sans-intern/missing-bits --state absent
|
__apt_ppa ppa:sans-intern/missing-bits
|
||||||
--------------------------------------------------------------------------------
|
# same as
|
||||||
|
__apt_ppa ppa:sans-intern/missing-bits --state present
|
||||||
|
|
||||||
|
# Disable a ppa repository
|
||||||
|
__apt_ppa ppa:sans-intern/missing-bits --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_source(7)
|
cdist-type__apt_source(7)
|
||||||
=========================
|
=========================
|
||||||
|
Manage apt sources
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_source - manage apt sources
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to manage apt sources.
|
This cdist type allows you to manage apt sources.
|
||||||
|
|
@ -15,52 +12,52 @@ This cdist type allows you to manage apt sources.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
uri::
|
uri
|
||||||
the uri to the apt repository
|
the uri to the apt repository
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
arch::
|
arch
|
||||||
set this if you need to force and specific arch (ubuntu specific)
|
set this if you need to force and specific arch (ubuntu specific)
|
||||||
|
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
distribution::
|
distribution
|
||||||
the distribution codename to use. Defaults to DISTRIB_CODENAME from
|
the distribution codename to use. Defaults to DISTRIB_CODENAME from
|
||||||
the targets /etc/lsb-release
|
the targets /etc/lsb-release
|
||||||
|
|
||||||
component::
|
component
|
||||||
space delimited list of components to enable. Defaults to an empty string.
|
space delimited list of components to enable. Defaults to an empty string.
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
include-src::
|
include-src
|
||||||
include deb-src entries
|
include deb-src entries
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__apt_source rabbitmq \
|
|
||||||
|
__apt_source rabbitmq \
|
||||||
--uri http://www.rabbitmq.com/debian/ \
|
--uri http://www.rabbitmq.com/debian/ \
|
||||||
--distribution testing \
|
--distribution testing \
|
||||||
--component main \
|
--component main \
|
||||||
--include-src \
|
--include-src \
|
||||||
--state present
|
--state present
|
||||||
|
|
||||||
__apt_source canonical_partner \
|
__apt_source canonical_partner \
|
||||||
--uri http://archive.canonical.com/ \
|
--uri http://archive.canonical.com/ \
|
||||||
--component partner --state present
|
--component partner --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__apt_update_index(7)
|
cdist-type__apt_update_index(7)
|
||||||
===============================
|
===============================
|
||||||
|
Update apt's package index
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__apt_update_index - Update apt's package index
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type runs apt-get update whenever any apt sources have changed.
|
This cdist type runs apt-get update whenever any apt sources have changed.
|
||||||
|
|
@ -25,14 +22,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__apt_update_index
|
|
||||||
--------------------------------------------------------------------------------
|
__apt_update_index
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__block(7)
|
cdist-type__block(7)
|
||||||
====================
|
====================
|
||||||
|
Manage blocks of text in files
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__block - Manage blocks of text in files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Manage a block of text in an existing file.
|
Manage a block of text in an existing file.
|
||||||
|
|
@ -18,62 +15,62 @@ of text.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
text::
|
text
|
||||||
the text to manage.
|
the text to manage.
|
||||||
If text is '-' (dash), take what was written to stdin as the text.
|
If text is '-' (dash), take what was written to stdin as the text.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
file::
|
file
|
||||||
the file in which to manage the text block.
|
the file in which to manage the text block.
|
||||||
Defaults to object_id.
|
Defaults to object_id.
|
||||||
|
|
||||||
prefix::
|
prefix
|
||||||
the prefix to add before the text.
|
the prefix to add before the text.
|
||||||
Defaults to #cdist:__block/$__object_id
|
Defaults to #cdist:__block/$__object_id
|
||||||
|
|
||||||
suffix::
|
suffix
|
||||||
the suffix to add after the text.
|
the suffix to add after the text.
|
||||||
Defaults to #/cdist:__block/$__object_id
|
Defaults to #/cdist:__block/$__object_id
|
||||||
|
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
add::
|
add
|
||||||
block was added
|
block was added
|
||||||
update::
|
update
|
||||||
block was updated/changed
|
block was updated/changed
|
||||||
remove::
|
remove
|
||||||
block was removed
|
block was removed
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# text from argument
|
|
||||||
__block /path/to/file \
|
# text from argument
|
||||||
|
__block /path/to/file \
|
||||||
--prefix '#start' \
|
--prefix '#start' \
|
||||||
--suffix '#end' \
|
--suffix '#end' \
|
||||||
--text 'some\nblock of\ntext'
|
--text 'some\nblock of\ntext'
|
||||||
|
|
||||||
# text from stdin
|
# text from stdin
|
||||||
__block some-id \
|
__block some-id \
|
||||||
--file /path/to/file \
|
--file /path/to/file \
|
||||||
--text - << DONE
|
--text - << DONE
|
||||||
here some block
|
here some block
|
||||||
of text
|
of text
|
||||||
DONE
|
DONE
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,59 +1,58 @@
|
||||||
cdist-type__ccollect_source(7)
|
cdist-type__ccollect_source(7)
|
||||||
==============================
|
==============================
|
||||||
|
Manage ccollect sources
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__ccollect_source - Manage ccollect sources
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to create or delete ccollect sources.
|
This cdist type allows you to create or delete ccollect sources.
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
The source from which to backup
|
The source from which to backup
|
||||||
destination::
|
destination
|
||||||
The destination directory
|
The destination directory
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
ccollectconf::
|
ccollectconf
|
||||||
The CCOLLECT_CONF directory. Defaults to /etc/ccollect.
|
The CCOLLECT_CONF directory. Defaults to /etc/ccollect.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL MULTIPLE PARAMETERS
|
OPTIONAL MULTIPLE PARAMETERS
|
||||||
----------------------------
|
----------------------------
|
||||||
exclude::
|
exclude
|
||||||
Paths to exclude of backup
|
Paths to exclude of backup
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
verbose::
|
verbose
|
||||||
Whether to report backup verbosely
|
Whether to report backup verbosely
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__ccollect_source doc.ungleich.ch \
|
|
||||||
|
__ccollect_source doc.ungleich.ch \
|
||||||
--source doc.ungleich.ch:/ \
|
--source doc.ungleich.ch:/ \
|
||||||
--destination /backup/doc.ungleich.ch \
|
--destination /backup/doc.ungleich.ch \
|
||||||
--exclude '/proc/*' --exclude '/sys/*' \
|
--exclude '/proc/*' --exclude '/sys/*' \
|
||||||
--verbose
|
--verbose
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- ccollect(1)
|
- ccollect(1)
|
||||||
- http://www.nico.schottelius.org/software/ccollect/
|
- http://www.nico.schottelius.org/software/ccollect/
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__cdist(7)
|
cdist-type__cdist(7)
|
||||||
====================
|
====================
|
||||||
|
Manage cdist installations
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__cdist - Manage cdist installations
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to easily setup cdist
|
This cdist type allows you to easily setup cdist
|
||||||
|
|
@ -26,16 +23,16 @@ REQUIRED PARAMETERS
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
username::
|
username
|
||||||
Select the user to create for the cdist installation.
|
Select the user to create for the cdist installation.
|
||||||
Defaults to "cdist".
|
Defaults to "cdist".
|
||||||
|
|
||||||
source::
|
source
|
||||||
Select the source from which to clone cdist from.
|
Select the source from which to clone cdist from.
|
||||||
Defaults to "git://github.com/telmich/cdist.git".
|
Defaults to "git://github.com/telmich/cdist.git".
|
||||||
|
|
||||||
|
|
||||||
branch::
|
branch
|
||||||
Select the branch to checkout from.
|
Select the branch to checkout from.
|
||||||
Defaults to "master".
|
Defaults to "master".
|
||||||
|
|
||||||
|
|
@ -43,18 +40,18 @@ branch::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Install cdist for user cdist in her home as subfolder cdist
|
|
||||||
__cdist /home/cdist/cdist
|
|
||||||
|
|
||||||
# Use alternative source
|
# Install cdist for user cdist in her home as subfolder cdist
|
||||||
__cdist --source "git://git.schottelius.org/cdist" /home/cdist/cdist
|
__cdist /home/cdist/cdist
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Use alternative source
|
||||||
|
__cdist --source "git://git.schottelius.org/cdist" /home/cdist/cdist
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__cdistmarker(7)
|
cdist-type__cdistmarker(7)
|
||||||
==========================
|
==========================
|
||||||
|
Add a timestamped cdist marker.
|
||||||
|
|
||||||
Daniel Maher <phrawzty+cdist--@--gmail.com>
|
Daniel Maher <phrawzty+cdist--@--gmail.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__cdistmarker - Add a timestamped cdist marker.
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type is used to add a common marker file which indicates that a given
|
This type is used to add a common marker file which indicates that a given
|
||||||
|
|
@ -23,11 +20,11 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
destination::
|
destination
|
||||||
The path and filename of the marker.
|
The path and filename of the marker.
|
||||||
Default: /etc/cdist-configured
|
Default: /etc/cdist-configured
|
||||||
|
|
||||||
format::
|
format
|
||||||
The format of the timestamp. This is passed directly to system 'date'.
|
The format of the timestamp. This is passed directly to system 'date'.
|
||||||
Default: -u
|
Default: -u
|
||||||
|
|
||||||
|
|
@ -35,18 +32,18 @@ format::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Creates the marker as normal.
|
|
||||||
__cdistmarker
|
|
||||||
|
|
||||||
# Creates the marker differently.
|
# Creates the marker as normal.
|
||||||
__cdistmarker --destination /tmp/cdist_marker --format '+%s'
|
__cdistmarker
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Creates the marker differently.
|
||||||
|
__cdistmarker --destination /tmp/cdist_marker --format '+%s'
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdisty-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__config_file(7)
|
cdist-type__config_file(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manages config files
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__config_file - manages config files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Deploy config files using the file type.
|
Deploy config files using the file type.
|
||||||
|
|
@ -21,37 +18,37 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
group::
|
group
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
mode::
|
mode
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
onchange::
|
onchange
|
||||||
the code to run if the file changes
|
the code to run if the file changes
|
||||||
owner::
|
owner
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
source::
|
source
|
||||||
Path to the config file.
|
Path to the config file.
|
||||||
If source is '-' (dash), take what was written to stdin as the config file content.
|
If source is '-' (dash), take what was written to stdin as the config file content.
|
||||||
state::
|
state
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__config_file /etc/consul/conf.d/watch_foo.json \
|
|
||||||
|
__config_file /etc/consul/conf.d/watch_foo.json \
|
||||||
--owner root --group consul --mode 640 \
|
--owner root --group consul --mode 640 \
|
||||||
--source "$__type/files/watch_foo.json" \
|
--source "$__type/files/watch_foo.json" \
|
||||||
--state present \
|
--state present \
|
||||||
--onchange 'service consul status >/dev/null && service consul reload || true'
|
--onchange 'service consul status >/dev/null && service consul reload || true'
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__file(7)
|
- `cdist-type__file(7) <cdist-type__file.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul(7)
|
cdist-type__consul(7)
|
||||||
=====================
|
=====================
|
||||||
|
Install consul
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul - install consul
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Downloads and installs the consul binary from https://dl.bintray.com/mitchellh/consul.
|
Downloads and installs the consul binary from https://dl.bintray.com/mitchellh/consul.
|
||||||
|
|
@ -22,10 +19,10 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
either 'present' or 'absent'. Defaults to 'present'
|
either 'present' or 'absent'. Defaults to 'present'
|
||||||
|
|
||||||
version::
|
version
|
||||||
which version of consul to install. See ./files/versions for a list of
|
which version of consul to install. See ./files/versions for a list of
|
||||||
supported versions. Defaults to the latest known version.
|
supported versions. Defaults to the latest known version.
|
||||||
|
|
||||||
|
|
@ -33,19 +30,19 @@ version::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# just install using defaults
|
|
||||||
__consul
|
|
||||||
|
|
||||||
# specific version
|
# just install using defaults
|
||||||
__consul \
|
__consul
|
||||||
|
|
||||||
|
# specific version
|
||||||
|
__consul \
|
||||||
--version 0.4.1
|
--version 0.4.1
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_agent(7)
|
cdist-type__consul_agent(7)
|
||||||
===========================
|
===========================
|
||||||
|
Manage the consul agent
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_agent - manage the consul agent
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Configure and manage the consul agent.
|
Configure and manage the consul agent.
|
||||||
|
|
@ -20,86 +17,113 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
acl-datacenter::
|
acl-datacenter
|
||||||
only used by servers. This designates the datacenter which is authoritative
|
only used by servers. This designates the datacenter which is authoritative
|
||||||
for ACL information.
|
for ACL information.
|
||||||
acl-default-policy::
|
|
||||||
|
acl-default-policy
|
||||||
either "allow" or "deny"; defaults to "allow". The default policy controls the
|
either "allow" or "deny"; defaults to "allow". The default policy controls the
|
||||||
behavior of a token when there is no matching rule.
|
behavior of a token when there is no matching rule.
|
||||||
acl-down-policy::
|
|
||||||
|
acl-down-policy
|
||||||
either "allow", "deny" or "extend-cache"; "extend-cache" is the default.
|
either "allow", "deny" or "extend-cache"; "extend-cache" is the default.
|
||||||
acl-master-token::
|
|
||||||
|
acl-master-token
|
||||||
only used for servers in the acl_datacenter. This token will be created with
|
only used for servers in the acl_datacenter. This token will be created with
|
||||||
management-level permissions if it does not exist. It allows operators to
|
management-level permissions if it does not exist. It allows operators to
|
||||||
bootstrap the ACL system with a token ID that is well-known.
|
bootstrap the ACL system with a token ID that is well-known.
|
||||||
acl-token::
|
|
||||||
|
acl-token
|
||||||
when provided, the agent will use this token when making requests to the
|
when provided, the agent will use this token when making requests to the
|
||||||
Consul servers.
|
Consul servers.
|
||||||
acl-ttl::
|
|
||||||
|
acl-ttl
|
||||||
used to control Time-To-Live caching of ACLs.
|
used to control Time-To-Live caching of ACLs.
|
||||||
bind-addr::
|
|
||||||
|
bind-addr
|
||||||
sets the bind address for cluster communication
|
sets the bind address for cluster communication
|
||||||
bootstrap-expect::
|
|
||||||
|
bootstrap-expect
|
||||||
sets server to expect bootstrap mode
|
sets server to expect bootstrap mode
|
||||||
ca-file-source::
|
|
||||||
|
ca-file-source
|
||||||
path to a PEM encoded certificate authority file which will be uploaded and
|
path to a PEM encoded certificate authority file which will be uploaded and
|
||||||
configure using the ca_file config option.
|
configure using the ca_file config option.
|
||||||
cert-file-source::
|
|
||||||
|
cert-file-source
|
||||||
path to a PEM encoded certificate file which will be uploaded and
|
path to a PEM encoded certificate file which will be uploaded and
|
||||||
configure using the cert_file config option.
|
configure using the cert_file config option.
|
||||||
client-addr::
|
|
||||||
|
client-addr
|
||||||
sets the address to bind for client access
|
sets the address to bind for client access
|
||||||
datacenter::
|
|
||||||
|
datacenter
|
||||||
datacenter of the agent
|
datacenter of the agent
|
||||||
encrypt::
|
|
||||||
|
encrypt
|
||||||
provides the gossip encryption key
|
provides the gossip encryption key
|
||||||
group::
|
|
||||||
|
group
|
||||||
the primary group for the agent
|
the primary group for the agent
|
||||||
json-config::
|
|
||||||
|
json-config
|
||||||
path to a partial json config file without leading { and trailing }.
|
path to a partial json config file without leading { and trailing }.
|
||||||
If json-config is '-' (dash), take what was written to stdin as the file content.
|
If json-config is '-' (dash), take what was written to stdin as the file content.
|
||||||
key-file-source::
|
|
||||||
|
key-file-source
|
||||||
path to a PEM encoded private key file which will be uploaded and
|
path to a PEM encoded private key file which will be uploaded and
|
||||||
configure using the key_file config option.
|
configure using the key_file config option.
|
||||||
node-name::
|
|
||||||
|
node-name
|
||||||
name of this node. Must be unique in the cluster
|
name of this node. Must be unique in the cluster
|
||||||
retry-join::
|
|
||||||
|
retry-join
|
||||||
address to attempt joining every retry_interval until at least one join works.
|
address to attempt joining every retry_interval until at least one join works.
|
||||||
Can be specified multiple times.
|
Can be specified multiple times.
|
||||||
user::
|
|
||||||
|
user
|
||||||
the user to run the agent as
|
the user to run the agent as
|
||||||
state::
|
|
||||||
|
state
|
||||||
if the agent is 'present' or 'absent'. Defaults to 'present'.
|
if the agent is 'present' or 'absent'. Defaults to 'present'.
|
||||||
Currently state=absent is not working due to some dependency issues.
|
Currently state=absent is not working due to some dependency issues.
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
disable-remote-exec::
|
disable-remote-exec
|
||||||
disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.
|
disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.
|
||||||
disable-update-check::
|
|
||||||
|
disable-update-check
|
||||||
disables automatic checking for security bulletins and new version releases
|
disables automatic checking for security bulletins and new version releases
|
||||||
leave-on-terminate::
|
|
||||||
|
leave-on-terminate
|
||||||
gracefully leave cluster on SIGTERM
|
gracefully leave cluster on SIGTERM
|
||||||
rejoin-after-leave::
|
|
||||||
|
rejoin-after-leave
|
||||||
rejoin the cluster using the previous state after leaving
|
rejoin the cluster using the previous state after leaving
|
||||||
server::
|
|
||||||
|
server
|
||||||
used to control if an agent is in server or client mode
|
used to control if an agent is in server or client mode
|
||||||
syslog::
|
|
||||||
|
syslog
|
||||||
enables logging to syslog
|
enables logging to syslog
|
||||||
verify-incoming::
|
|
||||||
|
verify-incoming
|
||||||
enforce the use of TLS and verify a client's authenticity on incomming connections
|
enforce the use of TLS and verify a client's authenticity on incomming connections
|
||||||
verify-outgoing::
|
|
||||||
|
verify-outgoing
|
||||||
enforce the use of TLS and verify the peers authenticity on outgoing connections
|
enforce the use of TLS and verify the peers authenticity on outgoing connections
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# configure as server, bootstrap and rejoin
|
|
||||||
hostname="$(cat "$__global/explorer/hostname")"
|
# configure as server, bootstrap and rejoin
|
||||||
__consul_agent \
|
hostname="$(cat "$__global/explorer/hostname")"
|
||||||
|
__consul_agent \
|
||||||
--datacenter dc1 \
|
--datacenter dc1 \
|
||||||
--node-name "${hostname%%.*}" \
|
--node-name "${hostname%%.*}" \
|
||||||
--disable-update-check \
|
--disable-update-check \
|
||||||
|
|
@ -110,9 +134,9 @@ __consul_agent \
|
||||||
--retry-join consul-02 \
|
--retry-join consul-02 \
|
||||||
--retry-join consul-03
|
--retry-join consul-03
|
||||||
|
|
||||||
# configure as server, bootstrap and rejoin with ssl support
|
# configure as server, bootstrap and rejoin with ssl support
|
||||||
hostname="$(cat "$__global/explorer/hostname")"
|
hostname="$(cat "$__global/explorer/hostname")"
|
||||||
__consul_agent \
|
__consul_agent \
|
||||||
--datacenter dc1 \
|
--datacenter dc1 \
|
||||||
--node-name "${hostname%%.*}" \
|
--node-name "${hostname%%.*}" \
|
||||||
--disable-update-check \
|
--disable-update-check \
|
||||||
|
|
@ -128,8 +152,8 @@ __consul_agent \
|
||||||
--verify-incoming \
|
--verify-incoming \
|
||||||
--verify-outgoing
|
--verify-outgoing
|
||||||
|
|
||||||
# configure as client and try joining existing cluster
|
# configure as client and try joining existing cluster
|
||||||
__consul_agent \
|
__consul_agent \
|
||||||
--datacenter dc1 \
|
--datacenter dc1 \
|
||||||
--node-name "${hostname%%.*}" \
|
--node-name "${hostname%%.*}" \
|
||||||
--disable-update-check \
|
--disable-update-check \
|
||||||
|
|
@ -137,12 +161,10 @@ __consul_agent \
|
||||||
--retry-join consul-02 \
|
--retry-join consul-02 \
|
||||||
--retry-join consul-03
|
--retry-join consul-03
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- http://www.consul.io/docs/agent/options.html
|
- http://www.consul.io/docs/agent/options.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_check(7)
|
cdist-type__consul_check(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manages consul checks
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_check - manages consul checks
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy check definitions for a consul agent.
|
Generate and deploy check definitions for a consul agent.
|
||||||
|
|
@ -23,43 +20,49 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
interval::
|
interval
|
||||||
the interval in which the script given with --script should be run
|
the interval in which the script given with --script should be run
|
||||||
script::
|
|
||||||
|
script
|
||||||
the shell command to run every --interval
|
the shell command to run every --interval
|
||||||
ttl::
|
|
||||||
|
ttl
|
||||||
how long a check is considered healthy without being updated through the
|
how long a check is considered healthy without being updated through the
|
||||||
HTTP interfave
|
HTTP interfave
|
||||||
id::
|
|
||||||
|
id
|
||||||
Defaults to --name
|
Defaults to --name
|
||||||
name::
|
|
||||||
|
name
|
||||||
The name of this check. Defaults to __object_id
|
The name of this check. Defaults to __object_id
|
||||||
notes::
|
|
||||||
|
notes
|
||||||
human readable description
|
human readable description
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this check is 'present' or 'absent'. Defaults to 'present'.
|
if this check is 'present' or 'absent'. Defaults to 'present'.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_check redis \
|
|
||||||
|
__consul_check redis \
|
||||||
--script /usr/local/bin/check_redis.py \
|
--script /usr/local/bin/check_redis.py \
|
||||||
--interval 10s
|
--interval 10s
|
||||||
|
|
||||||
__consul_check some-object-id \
|
__consul_check some-object-id \
|
||||||
--id web-app \
|
--id web-app \
|
||||||
--name "Web App Status" \
|
--name "Web App Status" \
|
||||||
--notes "Web app does a curl internally every 10 seconds" \
|
--notes "Web app does a curl internally every 10 seconds" \
|
||||||
--ttl 30s
|
--ttl 30s
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_reload(7)
|
cdist-type__consul_reload(7)
|
||||||
============================
|
============================
|
||||||
|
Reload consul
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_reload - reload consul
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Reload consul after configuration changes.
|
Reload consul after configuration changes.
|
||||||
|
|
@ -26,14 +23,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_reload
|
|
||||||
--------------------------------------------------------------------------------
|
__consul_reload
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_service(7)
|
cdist-type__consul_service(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manages consul services
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_service - manages consul services
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy service definitions for a consul agent.
|
Generate and deploy service definitions for a consul agent.
|
||||||
|
|
@ -23,46 +20,53 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
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-script::
|
|
||||||
|
check-script
|
||||||
the shell command to run every --check-interval
|
the shell command to run every --check-interval
|
||||||
check-ttl::
|
|
||||||
|
check-ttl
|
||||||
how long a service is considered healthy without being updated through the
|
how long a service is considered healthy without being updated through the
|
||||||
HTTP interfave
|
HTTP interfave
|
||||||
id::
|
|
||||||
|
id
|
||||||
Defaults to --name
|
Defaults to --name
|
||||||
name::
|
|
||||||
|
name
|
||||||
The name of this service. Defaults to __object_id
|
The name of this service. Defaults to __object_id
|
||||||
port::
|
|
||||||
|
port
|
||||||
the port at which this service can be reached
|
the port at which this service can be reached
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this service is 'present' or 'absent'. Defaults to 'present'.
|
if this service is 'present' or 'absent'. Defaults to 'present'.
|
||||||
tag::
|
|
||||||
|
tag
|
||||||
a tag to add to this service. Can be specified multiple times.
|
a tag to add to this service. Can be specified multiple times.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_service redis \
|
|
||||||
|
__consul_service redis \
|
||||||
--tag master \
|
--tag master \
|
||||||
--tag production \
|
--tag production \
|
||||||
--port 8000 \
|
--port 8000 \
|
||||||
--check-script /usr/local/bin/check_redis.py \
|
--check-script /usr/local/bin/check_redis.py \
|
||||||
--check-interval 10s
|
--check-interval 10s
|
||||||
|
|
||||||
__consul_service webapp \
|
__consul_service webapp \
|
||||||
--port 80 \
|
--port 80 \
|
||||||
--check-ttl 10s
|
--check-ttl 10s
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_template(7)
|
cdist-type__consul_template(7)
|
||||||
==============================
|
==============================
|
||||||
|
Manage the consul-template service
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_template - manage the consul-template service
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Downloads and installs the consul-template binary from
|
Downloads and installs the consul-template binary from
|
||||||
|
|
@ -24,52 +21,69 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
auth-username::
|
auth-username
|
||||||
specify a username for basic authentication.
|
specify a username for basic authentication.
|
||||||
auth-password::
|
|
||||||
|
auth-password
|
||||||
specify a password for basic authentication.
|
specify a password for basic authentication.
|
||||||
batch-size::
|
|
||||||
|
batch-size
|
||||||
the size of the batch when polling multiple dependencies.
|
the size of the batch when polling multiple dependencies.
|
||||||
consul::
|
|
||||||
|
consul
|
||||||
the location of the Consul instance to query (may be an IP address or FQDN) with port.
|
the location of the Consul instance to query (may be an IP address or FQDN) with port.
|
||||||
Defaults to 'localhost:8500'.
|
Defaults to 'localhost:8500'.
|
||||||
log-level::
|
|
||||||
|
log-level
|
||||||
The log level for output. This applies to the stdout/stderr logging as well
|
The log level for output. This applies to the stdout/stderr logging as well
|
||||||
as syslog logging (if enabled). Valid values are "debug", "info", "warn",
|
as syslog logging (if enabled). Valid values are "debug", "info", "warn",
|
||||||
and "err". The default value is "warn".
|
and "err". The default value is "warn".
|
||||||
max-stale::
|
|
||||||
|
max-stale
|
||||||
the maximum staleness of a query. If specified, Consul will distribute work among all
|
the maximum staleness of a query. If specified, Consul will distribute work among all
|
||||||
servers instead of just the leader.
|
servers instead of just the leader.
|
||||||
retry::
|
|
||||||
|
retry
|
||||||
the amount of time to wait if Consul returns an error when communicating
|
the amount of time to wait if Consul returns an error when communicating
|
||||||
with the API.
|
with the API.
|
||||||
state::
|
|
||||||
|
state
|
||||||
either 'present' or 'absent'. Defaults to 'present'
|
either 'present' or 'absent'. Defaults to 'present'
|
||||||
ssl-cert::
|
|
||||||
|
ssl-cert
|
||||||
Path to an SSL client certificate to use to authenticate to the consul server.
|
Path to an SSL client certificate to use to authenticate to the consul server.
|
||||||
Useful if the consul server "verify_incoming" option is set.
|
Useful if the consul server "verify_incoming" option is set.
|
||||||
ssl-ca-cert::
|
|
||||||
|
ssl-ca-cert
|
||||||
Path to a CA certificate file, containing one or more CA certificates to
|
Path to a CA certificate file, containing one or more CA certificates to
|
||||||
use to validate the certificate sent by the consul server to us. This is a
|
use to validate the certificate sent by the consul server to us. This is a
|
||||||
handy alternative to setting --ssl-no-verify if you are using your own CA.
|
handy alternative to setting --ssl-no-verify if you are using your own CA.
|
||||||
syslog-facility::
|
|
||||||
|
syslog-facility
|
||||||
The facility to use when sending to syslog. This requires the use of --syslog.
|
The facility to use when sending to syslog. This requires the use of --syslog.
|
||||||
The default value is LOCAL0.
|
The default value is LOCAL0.
|
||||||
token::
|
|
||||||
|
token
|
||||||
the Consul API token.
|
the Consul API token.
|
||||||
vault-address::
|
|
||||||
|
vault-address
|
||||||
the location of the Vault instance to query (may be an IP address or FQDN) with port.
|
the location of the Vault instance to query (may be an IP address or FQDN) with port.
|
||||||
vault-token::
|
|
||||||
|
vault-token
|
||||||
the Vault API token.
|
the Vault API token.
|
||||||
vault-ssl-cert::
|
|
||||||
|
vault-ssl-cert
|
||||||
Path to an SSL client certificate to use to authenticate to the vault server.
|
Path to an SSL client certificate to use to authenticate to the vault server.
|
||||||
vault-ssl-ca-cert::
|
|
||||||
|
vault-ssl-ca-cert
|
||||||
Path to a CA certificate file, containing one or more CA certificates to
|
Path to a CA certificate file, containing one or more CA certificates to
|
||||||
use to validate the certificate sent by the vault server to us.
|
use to validate the certificate sent by the vault server to us.
|
||||||
version::
|
|
||||||
|
version
|
||||||
which version of consul-template to install. See ./files/versions for a list of
|
which version of consul-template to install. See ./files/versions for a list of
|
||||||
supported versions. Defaults to the latest known version.
|
supported versions. Defaults to the latest known version.
|
||||||
wait::
|
|
||||||
|
wait
|
||||||
the minimum(:maximum) to wait before rendering a new template to disk and
|
the minimum(:maximum) to wait before rendering a new template to disk and
|
||||||
triggering a command, separated by a colon (:). If the optional maximum
|
triggering a command, separated by a colon (:). If the optional maximum
|
||||||
value is omitted, it is assumed to be 4x the required minimum value.
|
value is omitted, it is assumed to be 4x the required minimum value.
|
||||||
|
|
@ -77,36 +91,40 @@ wait::
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
ssl::
|
ssl
|
||||||
use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.
|
use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.
|
||||||
ssl-no-verify::
|
|
||||||
|
ssl-no-verify
|
||||||
ignore certificate warnings. Only used if ssl is enabled.
|
ignore certificate warnings. Only used if ssl is enabled.
|
||||||
syslog::
|
|
||||||
|
syslog
|
||||||
Send log output to syslog (in addition to stdout and stderr).
|
Send log output to syslog (in addition to stdout and stderr).
|
||||||
vault-ssl::
|
|
||||||
|
vault-ssl
|
||||||
use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.
|
use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.
|
||||||
vault-ssl-no-verify::
|
|
||||||
|
vault-ssl-no-verify
|
||||||
ignore certificate warnings. Only used if vault is enabled.
|
ignore certificate warnings. Only used if vault is enabled.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_template \
|
|
||||||
|
__consul_template \
|
||||||
--consul consul.service.consul:8500 \
|
--consul consul.service.consul:8500 \
|
||||||
--retry 30s
|
--retry 30s
|
||||||
|
|
||||||
# specific version
|
# specific version
|
||||||
__consul_template \
|
__consul_template \
|
||||||
--version 0.6.5 \
|
--version 0.6.5 \
|
||||||
--retry 30s
|
--retry 30s
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- https://github.com/hashicorp/consul-template
|
- https://github.com/hashicorp/consul-template
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_template_template(7)
|
cdist-type__consul_template_template(7)
|
||||||
=======================================
|
=======================================
|
||||||
|
Manage consul-template templates
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_template_template - manage consul-template templates
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy template definitions for a consul-template.
|
Generate and deploy template definitions for a consul-template.
|
||||||
|
|
@ -18,49 +15,52 @@ Either the --source or the --source-file parameter must be given.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
destination::
|
destination
|
||||||
the destination where the generated file should go.
|
the destination where the generated file should go.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
command::
|
command
|
||||||
an optional command to run after rendering the template to its destination.
|
an optional command to run after rendering the template to its destination.
|
||||||
source::
|
|
||||||
|
source
|
||||||
path to the template source. Conflicts --source-file.
|
path to the template source. Conflicts --source-file.
|
||||||
source-file::
|
|
||||||
|
source-file
|
||||||
path to a local file which is uploaded using the __file type and configured
|
path to a local file which is uploaded using the __file type and configured
|
||||||
as the source.
|
as the source.
|
||||||
If source is '-' (dash), take what was written to stdin as the file content.
|
If source is '-' (dash), take what was written to stdin as the file content.
|
||||||
Conflicts --source.
|
Conflicts --source.
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this template is 'present' or 'absent'. Defaults to 'present'.
|
if this template is 'present' or 'absent'. Defaults to 'present'.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# configure template on the target
|
|
||||||
__consul_template_template nginx \
|
# configure template on the target
|
||||||
|
__consul_template_template nginx \
|
||||||
--source /etc/my-consul-templates/nginx.ctmpl \
|
--source /etc/my-consul-templates/nginx.ctmpl \
|
||||||
--destination /etc/nginx/nginx.conf \
|
--destination /etc/nginx/nginx.conf \
|
||||||
--command 'service nginx restart'
|
--command 'service nginx restart'
|
||||||
|
|
||||||
|
|
||||||
# upload a local file to the target and configure it
|
# upload a local file to the target and configure it
|
||||||
__consul_template_template nginx \
|
__consul_template_template nginx \
|
||||||
--source-file "$__manifest/files/nginx.ctmpl" \
|
--source-file "$__manifest/files/nginx.ctmpl" \
|
||||||
--destination /etc/nginx/nginx.conf \
|
--destination /etc/nginx/nginx.conf \
|
||||||
--command 'service nginx restart'
|
--command 'service nginx restart'
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_template(7)
|
- `cdist-type__consul_template(7) <cdist-type__consul_template.html>`_
|
||||||
- cdist-type__consul_template_config(7)
|
- `cdist-type__consul_template_config(7) <cdist-type__consul_template_config.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_checks(7)
|
cdist-type__consul_watch_checks(7)
|
||||||
==================================
|
==================================
|
||||||
|
Manages consul checks watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_checks - manages consul checks watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'checks' for a consul agent.
|
Generate and deploy watch definitions of type 'checks' for a consul agent.
|
||||||
|
|
@ -16,45 +13,49 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
filter-service::
|
|
||||||
|
filter-service
|
||||||
filter to a specific service. Conflicts with --filter-state.
|
filter to a specific service. Conflicts with --filter-state.
|
||||||
filter-state::
|
|
||||||
|
filter-state
|
||||||
filter to a specific state. Conflicts with --filter-service.
|
filter to a specific state. Conflicts with --filter-service.
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_checks some-id \
|
|
||||||
|
__consul_watch_checks some-id \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
__consul_watch_checks some-id \
|
__consul_watch_checks some-id \
|
||||||
--filter-service consul \
|
--filter-service consul \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
__consul_watch_checks some-id \
|
__consul_watch_checks some-id \
|
||||||
--filter-state passing \
|
--filter-state passing \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_event(7)
|
cdist-type__consul_watch_event(7)
|
||||||
=================================
|
=================================
|
||||||
|
Manages consul event watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_event - manages consul event watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'event' for a consul agent.
|
Generate and deploy watch definitions of type 'event' for a consul agent.
|
||||||
|
|
@ -16,39 +13,42 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
name::
|
|
||||||
|
name
|
||||||
restrict the watch to only events with the given name
|
restrict the watch to only events with the given name
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_event some-id \
|
|
||||||
|
__consul_watch_event some-id \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
__consul_watch_event some-id \
|
__consul_watch_event some-id \
|
||||||
--name web-deploy \
|
--name web-deploy \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_key(7)
|
cdist-type__consul_watch_key(7)
|
||||||
===============================
|
===============================
|
||||||
|
Manages consul key watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_key - manages consul key watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'key' for a consul agent.
|
Generate and deploy watch definitions of type 'key' for a consul agent.
|
||||||
|
|
@ -16,36 +13,39 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
key::
|
|
||||||
|
key
|
||||||
the key to watch for changes
|
the key to watch for changes
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_key some-id \
|
|
||||||
|
__consul_watch_key some-id \
|
||||||
--key foo/bar/baz \
|
--key foo/bar/baz \
|
||||||
--handler /usr/bin/my-key-handler.sh
|
--handler /usr/bin/my-key-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_keyprefix(7)
|
cdist-type__consul_watch_keyprefix(7)
|
||||||
=====================================
|
=====================================
|
||||||
|
Manages consul keyprefix watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_keyprefix - manages consul keyprefix watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'keyprefix' for a consul agent.
|
Generate and deploy watch definitions of type 'keyprefix' for a consul agent.
|
||||||
|
|
@ -16,36 +13,39 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
prefix::
|
|
||||||
|
prefix
|
||||||
the prefix of keys to watch for changes
|
the prefix of keys to watch for changes
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_keyprefix some-id \
|
|
||||||
|
__consul_watch_keyprefix some-id \
|
||||||
--prefix foo/ \
|
--prefix foo/ \
|
||||||
--handler /usr/bin/my-prefix-handler.sh
|
--handler /usr/bin/my-prefix-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_nodes(7)
|
cdist-type__consul_watch_nodes(7)
|
||||||
=================================
|
=================================
|
||||||
|
Manages consul nodes watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_nodes - manages consul nodes watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'nodes' for a consul agent.
|
Generate and deploy watch definitions of type 'nodes' for a consul agent.
|
||||||
|
|
@ -16,33 +13,35 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_nodes some-id \
|
|
||||||
|
__consul_watch_nodes some-id \
|
||||||
--handler /usr/bin/my-key-handler.sh
|
--handler /usr/bin/my-key-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_service(7)
|
cdist-type__consul_watch_service(7)
|
||||||
===================================
|
===================================
|
||||||
|
Manages consul service watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_service - manages consul service watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'service' for a consul agent.
|
Generate and deploy watch definitions of type 'service' for a consul agent.
|
||||||
|
|
@ -16,55 +13,59 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
service::
|
|
||||||
|
service
|
||||||
the service to watch for changes
|
the service to watch for changes
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
tag::
|
|
||||||
|
tag
|
||||||
filter by tag
|
filter by tag
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
passingonly::
|
passingonly
|
||||||
specifies if only hosts passing all checks are displayed
|
specifies if only hosts passing all checks are displayed
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_service some-id \
|
|
||||||
|
__consul_watch_service some-id \
|
||||||
--service consul \
|
--service consul \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
__consul_watch_service some-id \
|
__consul_watch_service some-id \
|
||||||
--service redis \
|
--service redis \
|
||||||
--tag production \
|
--tag production \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
__consul_watch_service some-id \
|
__consul_watch_service some-id \
|
||||||
--service redis \
|
--service redis \
|
||||||
--tag production \
|
--tag production \
|
||||||
--passingonly \
|
--passingonly \
|
||||||
--handler /usr/bin/my-handler.sh
|
--handler /usr/bin/my-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__consul_watch_services(7)
|
cdist-type__consul_watch_services(7)
|
||||||
====================================
|
====================================
|
||||||
|
Manages consul services watches
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__consul_watch_services - manages consul services watches
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Generate and deploy watch definitions of type 'services' for a consul agent.
|
Generate and deploy watch definitions of type 'services' for a consul agent.
|
||||||
|
|
@ -16,33 +13,35 @@ See http://www.consul.io/docs/agent/watches.html for parameter documentation.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
handler::
|
handler
|
||||||
the handler to invoke when the data view updates
|
the handler to invoke when the data view updates
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
datacenter::
|
datacenter
|
||||||
can be provided to override the agent's default datacenter
|
can be provided to override the agent's default datacenter
|
||||||
state::
|
|
||||||
|
state
|
||||||
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
if this watch is 'present' or 'absent'. Defaults to 'present'.
|
||||||
token::
|
|
||||||
|
token
|
||||||
can be provided to override the agent's default ACL token
|
can be provided to override the agent's default ACL token
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__consul_watch_services some-id \
|
|
||||||
|
__consul_watch_services some-id \
|
||||||
--handler /usr/bin/my-key-handler.sh
|
--handler /usr/bin/my-key-handler.sh
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__consul_agent(7)
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
||||||
- http://www.consul.io/docs/agent/watches.html
|
- http://www.consul.io/docs/agent/watches.html
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__cron(7)
|
cdist-type__cron(7)
|
||||||
===================
|
===================
|
||||||
|
Installs and manages cron jobs
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__cron - installs and manages cron jobs
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to manage entries in a users crontab.
|
This cdist type allows you to manage entries in a users crontab.
|
||||||
|
|
@ -15,33 +12,33 @@ This cdist type allows you to manage entries in a users crontab.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
user::
|
user
|
||||||
The user who's crontab is edited
|
The user who's crontab is edited
|
||||||
command::
|
command
|
||||||
The command to run.
|
The command to run.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either present or absent. Defaults to present.
|
Either present or absent. Defaults to present.
|
||||||
minute::
|
minute
|
||||||
See crontab(5). Defaults to *
|
See crontab(5). Defaults to *
|
||||||
hour::
|
hour
|
||||||
See crontab(5). Defaults to *
|
See crontab(5). Defaults to *
|
||||||
day_of_month::
|
day_of_month
|
||||||
See crontab(5). Defaults to *
|
See crontab(5). Defaults to *
|
||||||
month::
|
month
|
||||||
See crontab(5). Defaults to *
|
See crontab(5). Defaults to *
|
||||||
day_of_week::
|
day_of_week
|
||||||
See crontab(5). Defaults to *
|
See crontab(5). Defaults to *
|
||||||
raw::
|
raw
|
||||||
Take whatever the user has given instead of time and date fields.
|
Take whatever the user has given instead of time and date fields.
|
||||||
If given, all other time and date fields are ignored.
|
If given, all other time and date fields are ignored.
|
||||||
Can for example be used to specify cron EXTENSIONS like reboot, yearly etc.
|
Can for example be used to specify cron EXTENSIONS like reboot, yearly etc.
|
||||||
See crontab(5) for the extensions if any that your cron implementation
|
See crontab(5) for the extensions if any that your cron implementation
|
||||||
implements.
|
implements.
|
||||||
raw_command::
|
raw_command
|
||||||
Take whatever the user has given in the command and ignore everything else.
|
Take whatever the user has given in the command and ignore everything else.
|
||||||
If given, the command will be added to crontab.
|
If given, the command will be added to crontab.
|
||||||
Can for example be used to define variables like SHELL or MAILTO.
|
Can for example be used to define variables like SHELL or MAILTO.
|
||||||
|
|
@ -50,27 +47,27 @@ raw_command::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# run Monday to Saturday at 23:15
|
|
||||||
__cron some-id --user root --command "/path/to/script" \
|
# run Monday to Saturday at 23:15
|
||||||
|
__cron some-id --user root --command "/path/to/script" \
|
||||||
--hour 23 --minute 15 --day_of_week 1-6
|
--hour 23 --minute 15 --day_of_week 1-6
|
||||||
|
|
||||||
# run on reboot
|
# run on reboot
|
||||||
__cron some-id --user root --command "/path/to/script" \
|
__cron some-id --user root --command "/path/to/script" \
|
||||||
--raw @reboot
|
--raw @reboot
|
||||||
|
|
||||||
# remove cronjob
|
# remove cronjob
|
||||||
__cron some-id --user root --command "/path/to/script" --state absent
|
__cron some-id --user root --command "/path/to/script" --state absent
|
||||||
|
|
||||||
# define default shell
|
# define default shell
|
||||||
__cron some-id --user root --raw_command --command "SHELL=/bin/bash" \
|
__cron some-id --user root --raw_command --command "SHELL=/bin/bash" \
|
||||||
--state present
|
--state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- crontab(5)
|
- crontab(5)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__debconf_set_selections(7)
|
cdist-type__debconf_set_selections(7)
|
||||||
=====================================
|
=====================================
|
||||||
|
Setup debconf selections
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__debconf_set_selections - Setup debconf selections
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
On Debian and alike systems debconf-set-selections(1) can be used
|
On Debian and alike systems debconf-set-selections(1) can be used
|
||||||
|
|
@ -16,7 +13,7 @@ to setup configuration parameters.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
file::
|
file
|
||||||
Use the given filename as input for debconf-set-selections(1)
|
Use the given filename as input for debconf-set-selections(1)
|
||||||
If filename is "-", read from stdin.
|
If filename is "-", read from stdin.
|
||||||
|
|
||||||
|
|
@ -24,23 +21,23 @@ file::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Setup configuration for nslcd
|
|
||||||
__debconf_set_selections nslcd --file /path/to/file
|
|
||||||
|
|
||||||
# Setup configuration for nslcd from another type
|
# Setup configuration for nslcd
|
||||||
__debconf_set_selections nslcd --file "$__type/files/preseed/nslcd"
|
__debconf_set_selections nslcd --file /path/to/file
|
||||||
|
|
||||||
__debconf_set_selections nslcd --file - << eof
|
# Setup configuration for nslcd from another type
|
||||||
gitolite gitolite/gituser string git
|
__debconf_set_selections nslcd --file "$__type/files/preseed/nslcd"
|
||||||
eof
|
|
||||||
--------------------------------------------------------------------------------
|
__debconf_set_selections nslcd --file - << eof
|
||||||
|
gitolite gitolite/gituser string git
|
||||||
|
eof
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__update_alternatives(7)
|
- `cdist-type__update_alternatives(7) <cdist-type__update_alternatives.html>`_
|
||||||
- debconf-set-selections(1)
|
- debconf-set-selections(1)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__directory(7)
|
cdist-type__directory(7)
|
||||||
========================
|
========================
|
||||||
|
Manage a directory
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__directory - Manage a directory
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to create or remove directories on the target.
|
This cdist type allows you to create or remove directories on the target.
|
||||||
|
|
@ -20,80 +17,79 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
group::
|
group
|
||||||
Group to chgrp to.
|
Group to chgrp to.
|
||||||
|
|
||||||
mode::
|
mode
|
||||||
Unix permissions, suitable for chmod.
|
Unix permissions, suitable for chmod.
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
User to chown to.
|
User to chown to.
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
parents::
|
parents
|
||||||
Whether to create parents as well (mkdir -p behaviour).
|
Whether to create parents as well (mkdir -p behaviour).
|
||||||
Warning: all intermediate directory permissions default
|
Warning: all intermediate directory permissions default
|
||||||
to whatever mkdir -p does.
|
to whatever mkdir -p does.
|
||||||
|
|
||||||
Usually this means root:root, 0700.
|
Usually this means root:root, 0700.
|
||||||
|
|
||||||
recursive::
|
recursive
|
||||||
If supplied the chgrp and chown call will run recursively.
|
If supplied the chgrp and chown call will run recursively.
|
||||||
This does *not* influence the behaviour of chmod.
|
This does *not* influence the behaviour of chmod.
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
chgrp <group>::
|
chgrp <group>
|
||||||
Changed group membership
|
Changed group membership
|
||||||
chown <owner>::
|
chown <owner>
|
||||||
Changed owner
|
Changed owner
|
||||||
chmod <mode>::
|
chmod <mode>
|
||||||
Changed mode
|
Changed mode
|
||||||
create::
|
create
|
||||||
Empty directory was created
|
Empty directory was created
|
||||||
remove::
|
remove
|
||||||
Directory exists, but state is absent, directory will be removed by generated code.
|
Directory exists, but state is absent, directory will be removed by generated code.
|
||||||
remove non directory::
|
remove non directory
|
||||||
Something other than a directory with the same name exists and was removed prior to create.
|
Something other than a directory with the same name exists and was removed prior to create.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# A silly example
|
|
||||||
__directory /tmp/foobar
|
|
||||||
|
|
||||||
# Remove a directory
|
# A silly example
|
||||||
__directory /tmp/foobar --state absent
|
__directory /tmp/foobar
|
||||||
|
|
||||||
# Ensure /etc exists correctly
|
# Remove a directory
|
||||||
__directory /etc --owner root --group root --mode 0755
|
__directory /tmp/foobar --state absent
|
||||||
|
|
||||||
# Create nfs service directory, including parents
|
# Ensure /etc exists correctly
|
||||||
__directory /home/services/nfs --parents
|
__directory /etc --owner root --group root --mode 0755
|
||||||
|
|
||||||
# Change permissions recursively
|
# Create nfs service directory, including parents
|
||||||
__directory /home/services --recursive --owner root --group root
|
__directory /home/services/nfs --parents
|
||||||
|
|
||||||
# Setup a temp directory
|
# Change permissions recursively
|
||||||
__directory /local --mode 1777
|
__directory /home/services --recursive --owner root --group root
|
||||||
|
|
||||||
# Take it all
|
# Setup a temp directory
|
||||||
__directory /home/services/kvm --recursive --parents \
|
__directory /local --mode 1777
|
||||||
|
|
||||||
|
# Take it all
|
||||||
|
__directory /home/services/kvm --recursive --parents \
|
||||||
--owner root --group root --mode 0755 --state present
|
--owner root --group root --mode 0755 --state present
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__dog_vdi(7)
|
cdist-type__dog_vdi(7)
|
||||||
======================
|
======================
|
||||||
|
Manage Sheepdog VM images
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__dog_vdi - Manage Sheepdog VM images
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
The dog program is used to create images for sheepdog
|
The dog program is used to create images for sheepdog
|
||||||
|
|
@ -16,9 +13,9 @@ to be used in qemu.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
size::
|
size
|
||||||
Size of the image in "dog vdi" compatible units.
|
Size of the image in "dog vdi" compatible units.
|
||||||
|
|
||||||
Required if state is "present".
|
Required if state is "present".
|
||||||
|
|
@ -28,24 +25,24 @@ size::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Create a 50G size image
|
|
||||||
__dog_vdi nico-privat.sky.ungleich.ch --size 50G
|
|
||||||
|
|
||||||
# Create a 50G size image (more explicit)
|
# Create a 50G size image
|
||||||
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state present
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G
|
||||||
|
|
||||||
# Remove image
|
# Create a 50G size image (more explicit)
|
||||||
__dog_vdi nico-privat.sky.ungleich.ch --state absent
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state present
|
||||||
|
|
||||||
# Remove image - keeping --size is ok
|
# Remove image
|
||||||
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state absent
|
__dog_vdi nico-privat.sky.ungleich.ch --state absent
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove image - keeping --size is ok
|
||||||
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- dog(8)
|
- dog(8)
|
||||||
- qemu(1)
|
- qemu(1)
|
||||||
|
|
||||||
109
cdist/conf/type/__file/man.rst
Normal file
109
cdist/conf/type/__file/man.rst
Normal file
|
|
@ -0,0 +1,109 @@
|
||||||
|
cdist-type__file(7)
|
||||||
|
===================
|
||||||
|
Manage files.
|
||||||
|
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to create files, remove files and set file
|
||||||
|
attributes on the target.
|
||||||
|
|
||||||
|
If the file already exists on the target, then if it is a:
|
||||||
|
|
||||||
|
regular file, and state is:
|
||||||
|
present
|
||||||
|
replace it with the source file if they are not equal
|
||||||
|
exists
|
||||||
|
do nothing
|
||||||
|
symlink
|
||||||
|
replace it with the source file
|
||||||
|
directory
|
||||||
|
replace it with the source file
|
||||||
|
|
||||||
|
In any case, make sure that the file attributes are as specified.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None.
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
state
|
||||||
|
'present', 'absent' or 'exists', defaults to 'present' where:
|
||||||
|
|
||||||
|
present
|
||||||
|
the file is exactly the one from source
|
||||||
|
absent
|
||||||
|
the file does not exist
|
||||||
|
exists
|
||||||
|
the file from source but only if it doesn't already exist
|
||||||
|
|
||||||
|
group
|
||||||
|
Group to chgrp to.
|
||||||
|
|
||||||
|
mode
|
||||||
|
Unix permissions, suitable for chmod.
|
||||||
|
|
||||||
|
owner
|
||||||
|
User to chown to.
|
||||||
|
|
||||||
|
source
|
||||||
|
If supplied, copy this file from the host running cdist to the target.
|
||||||
|
If not supplied, an empty file or directory will be created.
|
||||||
|
If source is '-' (dash), take what was written to stdin as the file content.
|
||||||
|
|
||||||
|
MESSAGES
|
||||||
|
--------
|
||||||
|
chgrp <group>
|
||||||
|
Changed group membership
|
||||||
|
chown <owner>
|
||||||
|
Changed owner
|
||||||
|
chmod <mode>
|
||||||
|
Changed mode
|
||||||
|
create
|
||||||
|
Empty file was created (no --source specified)
|
||||||
|
remove
|
||||||
|
File exists, but state is absent, file will be removed by generated code.
|
||||||
|
upload
|
||||||
|
File was uploaded
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Create /etc/cdist-configured as an empty file
|
||||||
|
__file /etc/cdist-configured
|
||||||
|
# The same thing
|
||||||
|
__file /etc/cdist-configured --state present
|
||||||
|
# Use __file from another type
|
||||||
|
__file /etc/issue --source "$__type/files/archlinux" --state present
|
||||||
|
# Delete existing file
|
||||||
|
__file /etc/cdist-configured --state absent
|
||||||
|
# Supply some more settings
|
||||||
|
__file /etc/shadow --source "$__type/files/shadow" \
|
||||||
|
--owner root --group shadow --mode 0640 \
|
||||||
|
--state present
|
||||||
|
# Provide a default file, but let the user change it
|
||||||
|
__file /home/frodo/.bashrc --source "/etc/skel/.bashrc" \
|
||||||
|
--state exists \
|
||||||
|
--owner frodo --mode 0600
|
||||||
|
# Take file content from stdin
|
||||||
|
__file /tmp/whatever --owner root --group root --mode 644 --source - << DONE
|
||||||
|
Here goes the content for /tmp/whatever
|
||||||
|
DONE
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
* `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,109 +0,0 @@
|
||||||
cdist-type__file(7)
|
|
||||||
===================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__file - Manage files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to create files, remove files and set file
|
|
||||||
attributes on the target.
|
|
||||||
|
|
||||||
If the file already exists on the target, then if it is a:
|
|
||||||
- regular file, and state is:
|
|
||||||
present: replace it with the source file if they are not equal
|
|
||||||
exists: do nothing
|
|
||||||
- symlink: replace it with the source file
|
|
||||||
- directory: replace it with the source file
|
|
||||||
|
|
||||||
In any case, make sure that the file attributes are as specified.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
None.
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
state::
|
|
||||||
'present', 'absent' or 'exists', defaults to 'present'
|
|
||||||
where:
|
|
||||||
present: the file is exactly the one from source
|
|
||||||
absent: the file does not exist
|
|
||||||
exists: the file from source but only if it doesn't already exist
|
|
||||||
|
|
||||||
group::
|
|
||||||
Group to chgrp to.
|
|
||||||
|
|
||||||
mode::
|
|
||||||
Unix permissions, suitable for chmod.
|
|
||||||
|
|
||||||
owner::
|
|
||||||
User to chown to.
|
|
||||||
|
|
||||||
source::
|
|
||||||
If supplied, copy this file from the host running cdist to the target.
|
|
||||||
If not supplied, an empty file or directory will be created.
|
|
||||||
If source is '-' (dash), take what was written to stdin as the file content.
|
|
||||||
|
|
||||||
MESSAGES
|
|
||||||
--------
|
|
||||||
chgrp <group>::
|
|
||||||
Changed group membership
|
|
||||||
chown <owner>::
|
|
||||||
Changed owner
|
|
||||||
chmod <mode>::
|
|
||||||
Changed mode
|
|
||||||
create::
|
|
||||||
Empty file was created (no --source specified)
|
|
||||||
remove::
|
|
||||||
File exists, but state is absent, file will be removed by generated code.
|
|
||||||
upload::
|
|
||||||
File was uploaded
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Create /etc/cdist-configured as an empty file
|
|
||||||
__file /etc/cdist-configured
|
|
||||||
# The same thing
|
|
||||||
__file /etc/cdist-configured --state present
|
|
||||||
# Delete existing file
|
|
||||||
__file /etc/cdist-configured --state absent
|
|
||||||
|
|
||||||
# Use __file from another type
|
|
||||||
__file /etc/issue --source "$__type/files/archlinux" --state present
|
|
||||||
|
|
||||||
# Supply some more settings
|
|
||||||
__file /etc/shadow --source "$__type/files/shadow" \
|
|
||||||
--owner root --group shadow --mode 0640 \
|
|
||||||
--state present
|
|
||||||
|
|
||||||
# Provide a default file, but let the user change it
|
|
||||||
__file /home/frodo/.bashrc --source "/etc/skel/.bashrc" \
|
|
||||||
--state exists \
|
|
||||||
--owner frodo --mode 0600
|
|
||||||
|
|
||||||
# Take file content from stdin
|
|
||||||
__file /tmp/whatever --owner root --group root --mode 644 --source - << DONE
|
|
||||||
Here goes the content for /tmp/whatever
|
|
||||||
DONE
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011-2013 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
75
cdist/conf/type/__firewalld_rule/man.rst
Normal file
75
cdist/conf/type/__firewalld_rule/man.rst
Normal file
|
|
@ -0,0 +1,75 @@
|
||||||
|
cdist-type__firewalld_rule(7)
|
||||||
|
=============================
|
||||||
|
Configure firewalld rules
|
||||||
|
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to manage rules in firewalld
|
||||||
|
using the *direct* way (i.e. no zone support).
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
rule
|
||||||
|
The rule to apply. Essentially an firewalld command
|
||||||
|
line without firewalld in front of it.
|
||||||
|
protocol
|
||||||
|
Either ipv4, ipv4 or eb. See firewall-cmd(1)
|
||||||
|
table
|
||||||
|
The table to use (like filter or nat). See firewall-cmd(1).
|
||||||
|
chain
|
||||||
|
The chain to use (like INPUT_direct or FORWARD_direct). See firewall-cmd(1).
|
||||||
|
priority
|
||||||
|
The priority to use (0 is topmost). See firewall-cmd(1).
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
state
|
||||||
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Allow acces from entrance.place4.ungleich.ch
|
||||||
|
__firewalld_rule entrance \
|
||||||
|
--protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain INPUT_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-s entrance.place4.ungleich.ch -j ACCEPT'
|
||||||
|
|
||||||
|
# Allow forwarding of traffic from br0
|
||||||
|
__firewalld_rule vm-forward --protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain FORWARD_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-i br0 -j ACCEPT'
|
||||||
|
|
||||||
|
# Ensure old rule is absent - warning, the rule part must stay the same!
|
||||||
|
__firewalld_rule vm-forward
|
||||||
|
--protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain FORWARD_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-i br0 -j ACCEPT' \
|
||||||
|
--state absent
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__iptables_rule(7) <cdist-type__iptables_rule.html>`_
|
||||||
|
- firewalld(8)
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2015 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,78 +0,0 @@
|
||||||
cdist-type__firewalld_rule(7)
|
|
||||||
=============================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__firewalld_rule - Configure firewalld rules
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to manage rules in firewalld
|
|
||||||
using the *direct* way (i.e. no zone support).
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
rule::
|
|
||||||
The rule to apply. Essentially an firewalld command
|
|
||||||
line without firewalld in front of it.
|
|
||||||
protocol::
|
|
||||||
Either ipv4, ipv4 or eb. See firewall-cmd(1)
|
|
||||||
table::
|
|
||||||
The table to use (like filter or nat). See firewall-cmd(1).
|
|
||||||
chain::
|
|
||||||
The chain to use (like INPUT_direct or FORWARD_direct). See firewall-cmd(1).
|
|
||||||
priority::
|
|
||||||
The priority to use (0 is topmost). See firewall-cmd(1).
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
state::
|
|
||||||
'present' or 'absent', defaults to 'present'
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Allow acces from entrance.place4.ungleich.ch
|
|
||||||
__firewalld_rule entrance \
|
|
||||||
--protocol ipv4 \
|
|
||||||
--table filter \
|
|
||||||
--chain INPUT_direct \
|
|
||||||
--priority 0 \
|
|
||||||
--rule '-s entrance.place4.ungleich.ch -j ACCEPT'
|
|
||||||
|
|
||||||
# Allow forwarding of traffic from br0
|
|
||||||
__firewalld_rule vm-forward --protocol ipv4 \
|
|
||||||
--table filter \
|
|
||||||
--chain FORWARD_direct \
|
|
||||||
--priority 0 \
|
|
||||||
--rule '-i br0 -j ACCEPT'
|
|
||||||
|
|
||||||
# Ensure old rule is absent - warning, the rule part must stay the same!
|
|
||||||
__firewalld_rule vm-forward
|
|
||||||
--protocol ipv4 \
|
|
||||||
--table filter \
|
|
||||||
--chain FORWARD_direct \
|
|
||||||
--priority 0 \
|
|
||||||
--rule '-i br0 -j ACCEPT' \
|
|
||||||
--state absent
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__iptables_rule(7)
|
|
||||||
- firewalld(8)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2015 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__git(7)
|
cdist-type__git(7)
|
||||||
==================
|
==================
|
||||||
|
Get and or keep git repositories up-to-date
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__git - Get and or keep git repositories up-to-date
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to clone git repositories
|
This cdist type allows you to clone git repositories
|
||||||
|
|
@ -15,43 +12,43 @@ This cdist type allows you to clone git repositories
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
Specifies the git remote to clone from
|
Specifies the git remote to clone from
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
branch::
|
branch
|
||||||
Create this branch by checking out the remote branch of this name
|
Create this branch by checking out the remote branch of this name
|
||||||
Default branch is "master"
|
Default branch is "master"
|
||||||
|
|
||||||
group::
|
group
|
||||||
Group to chgrp to.
|
Group to chgrp to.
|
||||||
|
|
||||||
mode::
|
mode
|
||||||
Unix permissions, suitable for chmod.
|
Unix permissions, suitable for chmod.
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
User to chown to.
|
User to chown to.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__git /home/services/dokuwiki --source git://github.com/splitbrain/dokuwiki.git
|
|
||||||
|
|
||||||
# Checkout cdist, stay on branch 2.1
|
__git /home/services/dokuwiki --source git://github.com/splitbrain/dokuwiki.git
|
||||||
__git /home/nico/cdist --source git://github.com/telmich/cdist.git --branch 2.1
|
|
||||||
--------------------------------------------------------------------------------
|
# Checkout cdist, stay on branch 2.1
|
||||||
|
__git /home/nico/cdist --source git://github.com/telmich/cdist.git --branch 2.1
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__group(7)
|
cdist-type__group(7)
|
||||||
====================
|
====================
|
||||||
|
Manage groups
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__group - Manage groups
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to create or modify groups on the target.
|
This cdist type allows you to create or modify groups on the target.
|
||||||
|
|
@ -20,58 +17,58 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
absent or present, defaults to present
|
absent or present, defaults to present
|
||||||
gid::
|
gid
|
||||||
see groupmod(8)
|
see groupmod(8)
|
||||||
password::
|
password
|
||||||
see above
|
see above
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
system::
|
system
|
||||||
see groupadd(8), apply only on group creation
|
see groupadd(8), apply only on group creation
|
||||||
|
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
mod::
|
mod
|
||||||
group is modified
|
group is modified
|
||||||
add::
|
add
|
||||||
New group added
|
New group added
|
||||||
remove::
|
remove
|
||||||
group is removed
|
group is removed
|
||||||
change <property> <new_value> <current_value>::
|
change <property> <new_value> <current_value>
|
||||||
Changed group property from current_value to new_value
|
Changed group property from current_value to new_value
|
||||||
set <property> <new_value>::
|
set <property> <new_value>
|
||||||
set property to new value, property was not set before
|
set property to new value, property was not set before
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Create a group 'foobar' with operating system default settings
|
|
||||||
__group foobar
|
|
||||||
|
|
||||||
# Remove the 'foobar' group
|
# Create a group 'foobar' with operating system default settings
|
||||||
__group foobar --state absent
|
__group foobar
|
||||||
|
|
||||||
# Create a system group 'myservice' with operating system default settings
|
# Remove the 'foobar' group
|
||||||
__group myservice --system
|
__group foobar --state absent
|
||||||
|
|
||||||
# Same but with a specific gid
|
# Create a system group 'myservice' with operating system default settings
|
||||||
__group foobar --gid 1234
|
__group myservice --system
|
||||||
|
|
||||||
# Same but with a gid and password
|
# Same but with a specific gid
|
||||||
__group foobar --gid 1234 --password 'crypted-password-string'
|
__group foobar --gid 1234
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Same but with a gid and password
|
||||||
|
__group foobar --gid 1234 --password 'crypted-password-string'
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__hostname(7)
|
cdist-type__hostname(7)
|
||||||
=======================
|
=======================
|
||||||
|
Set the hostname
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__hostname - set the hostname
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Set's the hostname on various operating systems.
|
Set's the hostname on various operating systems.
|
||||||
|
|
@ -19,31 +16,31 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
The hostname to set. Defaults to the first segment of __target_host
|
The hostname to set. Defaults to the first segment of __target_host
|
||||||
(${__target_host%%.*})
|
(${__target_host%%.*})
|
||||||
|
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
changed::
|
changed
|
||||||
Changed the hostname
|
Changed the hostname
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# take hostname from __target_host
|
|
||||||
__hostname
|
|
||||||
|
|
||||||
# set hostname explicitly
|
# take hostname from __target_host
|
||||||
__hostname --name some-static-hostname
|
__hostname
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# set hostname explicitly
|
||||||
|
__hostname --name some-static-hostname
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__iptables_apply(7)
|
cdist-type__iptables_apply(7)
|
||||||
=============================
|
=============================
|
||||||
|
Apply the rules
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__iptables_apply - Apply the rules
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type deploys an init script that triggers
|
This cdist type deploys an init script that triggers
|
||||||
|
|
@ -31,8 +28,8 @@ None (__iptables_apply is used by __iptables_rule)
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__iptables_rule(7)
|
- `cdist-type__iptables_rule(7) <cdist-type__iptables_rule.html>`_
|
||||||
- iptables(8)
|
- iptables(8)
|
||||||
|
|
||||||
|
|
||||||
60
cdist/conf/type/__iptables_rule/man.rst
Normal file
60
cdist/conf/type/__iptables_rule/man.rst
Normal file
|
|
@ -0,0 +1,60 @@
|
||||||
|
cdist-type__iptables_rule(7)
|
||||||
|
============================
|
||||||
|
Deploy iptable rulesets
|
||||||
|
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to manage iptable rules
|
||||||
|
in a distribution independent manner.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
rule
|
||||||
|
The rule to apply. Essentially an iptables command
|
||||||
|
line without iptables in front of it.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
state
|
||||||
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Deploy some policies
|
||||||
|
__iptables_rule policy-in --rule "-P INPUT DROP"
|
||||||
|
__iptables_rule policy-out --rule "-P OUTPUT ACCEPT"
|
||||||
|
__iptables_rule policy-fwd --rule "-P FORWARD DROP"
|
||||||
|
|
||||||
|
# The usual established rule
|
||||||
|
__iptables_rule established --rule "-A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT"
|
||||||
|
|
||||||
|
# Some service rules
|
||||||
|
__iptables_rule http --rule "-A INPUT -p tcp --dport 80 -j ACCEPT"
|
||||||
|
__iptables_rule ssh --rule "-A INPUT -p tcp --dport 22 -j ACCEPT"
|
||||||
|
__iptables_rule https --rule "-A INPUT -p tcp --dport 443 -j ACCEPT"
|
||||||
|
|
||||||
|
# Ensure some rules are not present anymore
|
||||||
|
__iptables_rule munin --rule "-A INPUT -p tcp --dport 4949 -j ACCEPT" \
|
||||||
|
--state absent
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__iptables_apply(7) <cdist-type__iptables_apply.html>`_
|
||||||
|
- iptables(8)
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,64 +0,0 @@
|
||||||
cdist-type__iptables_rule(7)
|
|
||||||
============================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__iptables_rule - Deploy iptable rulesets
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to manage iptable rules
|
|
||||||
in a distribution independent manner.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
rule::
|
|
||||||
The rule to apply. Essentially an iptables command
|
|
||||||
line without iptables in front of it.
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
state::
|
|
||||||
'present' or 'absent', defaults to 'present'
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Deploy some policies
|
|
||||||
__iptables_rule policy-in --rule "-P INPUT DROP"
|
|
||||||
__iptables_rule policy-out --rule "-P OUTPUT ACCEPT"
|
|
||||||
__iptables_rule policy-fwd --rule "-P FORWARD DROP"
|
|
||||||
|
|
||||||
# The usual established rule
|
|
||||||
__iptables_rule established --rule "-A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT"
|
|
||||||
|
|
||||||
# Some service rules
|
|
||||||
__iptables_rule http --rule "-A INPUT -p tcp --dport 80 -j ACCEPT"
|
|
||||||
__iptables_rule ssh --rule "-A INPUT -p tcp --dport 22 -j ACCEPT"
|
|
||||||
__iptables_rule https --rule "-A INPUT -p tcp --dport 443 -j ACCEPT"
|
|
||||||
|
|
||||||
# Ensure some rules are not present anymore
|
|
||||||
__iptables_rule munin --rule "-A INPUT -p tcp --dport 4949 -j ACCEPT" \
|
|
||||||
--state absent
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__iptables_apply(7)
|
|
||||||
- iptables(8)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2013 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__issue(7)
|
cdist-type__issue(7)
|
||||||
====================
|
====================
|
||||||
|
Manage issue
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__issue - Manage issue
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to easily setup /etc/issue.
|
This cdist type allows you to easily setup /etc/issue.
|
||||||
|
|
@ -20,7 +17,7 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
If supplied, use this file as /etc/issue instead of default.
|
If supplied, use this file as /etc/issue instead of default.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -28,17 +25,17 @@ source::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__issue
|
|
||||||
|
|
||||||
# When called from another type
|
__issue
|
||||||
__issue --source "$__type/files/myfancyissue"
|
|
||||||
--------------------------------------------------------------------------------
|
# When called from another type
|
||||||
|
__issue --source "$__type/files/myfancyissue"
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__jail(7)
|
cdist-type__jail(7)
|
||||||
===================
|
===================
|
||||||
|
Manage FreeBSD jails
|
||||||
|
|
||||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__jail - Manage FreeBSD jails
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type is used on FreeBSD to manage jails.
|
This type is used on FreeBSD to manage jails.
|
||||||
|
|
@ -15,47 +12,47 @@ This type is used on FreeBSD to manage jails.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present".
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
jailbase::
|
jailbase
|
||||||
The location of the .tgz archive containing the base fs for your jails.
|
The location of the .tgz archive containing the base fs for your jails.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
The name of the jail. Default is to use the object_id as the jail name.
|
The name of the jail. Default is to use the object_id as the jail name.
|
||||||
|
|
||||||
ip::
|
ip
|
||||||
The ifconfig style IP/netmask combination to use for the jail guest. If
|
The ifconfig style IP/netmask combination to use for the jail guest. If
|
||||||
the state parameter is "present," this parameter is required.
|
the state parameter is "present," this parameter is required.
|
||||||
|
|
||||||
hostname::
|
hostname
|
||||||
The FQDN to use for the jail guest. Defaults to the name parameter.
|
The FQDN to use for the jail guest. Defaults to the name parameter.
|
||||||
|
|
||||||
interface::
|
interface
|
||||||
The name of the physical interface on the jail server to bind the jail to.
|
The name of the physical interface on the jail server to bind the jail to.
|
||||||
Defaults to the first interface found in the output of ifconfig -l.
|
Defaults to the first interface found in the output of ifconfig -l.
|
||||||
|
|
||||||
devfs-ruleset::
|
devfs-ruleset
|
||||||
The name of the devfs ruleset to associate with the jail. Defaults to
|
The name of the devfs ruleset to associate with the jail. Defaults to
|
||||||
"jailrules." This ruleset must be copied to the server via another type.
|
"jailrules." This ruleset must be copied to the server via another type.
|
||||||
To use this option, devfs-enable must be "true."
|
To use this option, devfs-enable must be "true."
|
||||||
|
|
||||||
jaildir::
|
jaildir
|
||||||
The location on the remote server to use for hosting jail filesystems.
|
The location on the remote server to use for hosting jail filesystems.
|
||||||
Defaults to /usr/jail.
|
Defaults to /usr/jail.
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
stopped::
|
stopped
|
||||||
Do not start the jail
|
Do not start the jail
|
||||||
|
|
||||||
devfs-disable::
|
devfs-disable
|
||||||
Whether to disallow devfs mounting within the jail
|
Whether to disallow devfs mounting within the jail
|
||||||
|
|
||||||
onboot::
|
onboot
|
||||||
Whether to add the jail to rc.conf's jail_list variable.
|
Whether to add the jail to rc.conf's jail_list variable.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -69,48 +66,48 @@ means.
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
start::
|
start
|
||||||
The jail was started
|
The jail was started
|
||||||
stop::
|
stop
|
||||||
The jail was stopped
|
The jail was stopped
|
||||||
create:
|
create:
|
||||||
The jail was created
|
The jail was created
|
||||||
delete::
|
delete
|
||||||
The jail was deleted
|
The jail was deleted
|
||||||
onboot::
|
onboot
|
||||||
The jail was configured to start on boot
|
The jail was configured to start on boot
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Create a jail called www
|
|
||||||
__jail www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
|
||||||
|
|
||||||
# Remove the jail called www
|
# Create a jail called www
|
||||||
__jail www --state absent --jailbase /my/jail/base.tgz
|
__jail www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
# The jail www should not be started
|
# Remove the jail called www
|
||||||
__jail www --state present --stopped \
|
__jail www --state absent --jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
|
# The jail www should not be started
|
||||||
|
__jail www --state present --stopped \
|
||||||
--ip "192.168.1.2 netmask 255.255.255.0" \
|
--ip "192.168.1.2 netmask 255.255.255.0" \
|
||||||
--jailbase /my/jail/base.tgz
|
--jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
# Use the name variable explicitly
|
# Use the name variable explicitly
|
||||||
__jail thisjail --state present --name www \
|
__jail thisjail --state present --name www \
|
||||||
--ip "192.168.1.2" \
|
--ip "192.168.1.2" \
|
||||||
--jailbase /my/jail/base.tgz
|
--jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
# Go nuts
|
# Go nuts
|
||||||
__jail lotsofoptions --state present --name testjail \
|
__jail lotsofoptions --state present --name testjail \
|
||||||
--ip "192.168.1.100 netmask 255.255.255.0" \
|
--ip "192.168.1.100 netmask 255.255.255.0" \
|
||||||
--hostname "testjail.example.com" --interface "em0" \
|
--hostname "testjail.example.com" --interface "em0" \
|
||||||
--onboot --jailbase /my/jail/base.tgz --jaildir /jails
|
--onboot --jailbase /my/jail/base.tgz --jaildir /jails
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__key_value(7)
|
cdist-type__key_value(7)
|
||||||
========================
|
========================
|
||||||
|
Change property values in files
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__key_value - Change property values in files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to change values in a key value based config
|
This cdist type allows you to change values in a key value based config
|
||||||
|
|
@ -16,22 +13,22 @@ file.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
file::
|
file
|
||||||
The file to operate on.
|
The file to operate on.
|
||||||
delimiter::
|
delimiter
|
||||||
The delimiter which separates the key from the value.
|
The delimiter which separates the key from the value.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
present or absent, defaults to present. If present, sets the key to value,
|
present or absent, defaults to present. If present, sets the key to value,
|
||||||
if absent, removes the key from the file.
|
if absent, removes the key from the file.
|
||||||
key::
|
key
|
||||||
The key to change. Defaults to object_id.
|
The key to change. Defaults to object_id.
|
||||||
value::
|
value
|
||||||
The value for the key. Optional if state=absent, required otherwise.
|
The value for the key. Optional if state=absent, required otherwise.
|
||||||
comment::
|
comment
|
||||||
If supplied, the value will be inserted before the line with the key,
|
If supplied, the value will be inserted before the line with the key,
|
||||||
but only if the key or value must be changed.
|
but only if the key or value must be changed.
|
||||||
You need to ensure yourself that the line is prefixed with the correct
|
You need to ensure yourself that the line is prefixed with the correct
|
||||||
|
|
@ -40,41 +37,41 @@ comment::
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
exact_delimiter::
|
exact_delimiter
|
||||||
If supplied, treat additional whitespaces between key, delimiter and value
|
If supplied, treat additional whitespaces between key, delimiter and value
|
||||||
as wrong value.
|
as wrong value.
|
||||||
|
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
remove::
|
remove
|
||||||
Removed existing key and value
|
Removed existing key and value
|
||||||
insert::
|
insert
|
||||||
Added key and value
|
Added key and value
|
||||||
change::
|
change
|
||||||
Changed value of existing key
|
Changed value of existing key
|
||||||
create::
|
create
|
||||||
A new line was inserted in a new file
|
A new line was inserted in a new file
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Set the maximum system user id
|
|
||||||
__key_value SYS_UID_MAX --file /etc/login.defs --value 666 --delimiter ' '
|
|
||||||
|
|
||||||
# Same with fancy id
|
# Set the maximum system user id
|
||||||
__key_value my-fancy-id --file /etc/login.defs --key SYS_UID_MAX --value 666 \
|
__key_value SYS_UID_MAX --file /etc/login.defs --value 666 --delimiter ' '
|
||||||
|
|
||||||
|
# Same with fancy id
|
||||||
|
__key_value my-fancy-id --file /etc/login.defs --key SYS_UID_MAX --value 666 \
|
||||||
--delimiter ' '
|
--delimiter ' '
|
||||||
|
|
||||||
# Enable packet forwarding
|
# Enable packet forwarding
|
||||||
__key_value net.ipv4.ip_forward --file /etc/sysctl.conf --value 1 \
|
__key_value net.ipv4.ip_forward --file /etc/sysctl.conf --value 1 \
|
||||||
--delimiter ' = ' --comment '# my linux kernel should act as a router'
|
--delimiter ' = ' --comment '# my linux kernel should act as a router'
|
||||||
|
|
||||||
# Remove existing key/value
|
# Remove existing key/value
|
||||||
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter '='
|
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter '='
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
MORE INFORMATION
|
MORE INFORMATION
|
||||||
|
|
@ -85,7 +82,7 @@ So you need to exactly specify the key and delimiter. Delimiter can be of any le
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__line(7)
|
cdist-type__line(7)
|
||||||
===================
|
===================
|
||||||
|
Manage lines in files
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__line - Manage lines in files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to add lines and remove lines from files.
|
This cdist type allows you to add lines and remove lines from files.
|
||||||
|
|
@ -18,16 +15,16 @@ REQUIRED PARAMETERS
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
line::
|
line
|
||||||
Specifies the line which should be absent or present
|
Specifies the line which should be absent or present
|
||||||
|
|
||||||
Must be present, if state is present.
|
Must be present, if state is present.
|
||||||
Must not be combined with regex, if state is absent.
|
Must not be combined with regex, if state is absent.
|
||||||
|
|
||||||
regex::
|
regex
|
||||||
If state is present, search for this pattern and add
|
If state is present, search for this pattern and add
|
||||||
given line, if the given regular expression does not match.
|
given line, if the given regular expression does not match.
|
||||||
|
|
||||||
|
|
@ -38,7 +35,7 @@ regex::
|
||||||
|
|
||||||
Must not be combined with line, if state is absent.
|
Must not be combined with line, if state is absent.
|
||||||
|
|
||||||
file::
|
file
|
||||||
If supplied, use this as the destination file.
|
If supplied, use this as the destination file.
|
||||||
Otherwise the object_id is used.
|
Otherwise the object_id is used.
|
||||||
|
|
||||||
|
|
@ -46,24 +43,24 @@ file::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Manage the DAEMONS line in rc.conf
|
|
||||||
__line daemons --file /etc/rc.conf --line 'DAEMONS=(hwclock !network sshd crond postfix)'
|
|
||||||
|
|
||||||
# Ensure the home mount is present in /etc/fstab - explicitly make it present
|
# Manage the DAEMONS line in rc.conf
|
||||||
__line home-fstab \
|
__line daemons --file /etc/rc.conf --line 'DAEMONS=(hwclock !network sshd crond postfix)'
|
||||||
|
|
||||||
|
# Ensure the home mount is present in /etc/fstab - explicitly make it present
|
||||||
|
__line home-fstab \
|
||||||
--file /etc/fstab \
|
--file /etc/fstab \
|
||||||
--line 'filer.fs:/vol/home /home nfs defaults 0 0' \
|
--line 'filer.fs:/vol/home /home nfs defaults 0 0' \
|
||||||
--state present
|
--state present
|
||||||
|
|
||||||
# Removes the line specifiend in "include_www" from the file "lighttpd.conf"
|
# Removes the line specifiend in "include_www" from the file "lighttpd.conf"
|
||||||
__line legacy_timezone --file /etc/rc.conf --regex 'TIMEZONE=.*' --state absent
|
__line legacy_timezone --file /etc/rc.conf --regex 'TIMEZONE=.*' --state absent
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- grep(1)
|
- grep(1)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__link(7)
|
cdist-type__link(7)
|
||||||
===================
|
===================
|
||||||
|
Manage links (hard and symbolic)
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__link - Manage links (hard and symbolic)
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to manage hard and symbolic links.
|
This cdist type allows you to manage hard and symbolic links.
|
||||||
|
|
@ -16,42 +13,42 @@ The given object id is the destination for the link.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
Specifies the link source.
|
Specifies the link source.
|
||||||
|
|
||||||
type::
|
type
|
||||||
Specifies the link type: Either hard or symoblic.
|
Specifies the link type: Either hard or symoblic.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Create hard link of /etc/shadow
|
|
||||||
__link /root/shadow --source /etc/shadow --type hard
|
|
||||||
|
|
||||||
# Relative symbolic link
|
# Create hard link of /etc/shadow
|
||||||
__link /etc/apache2/sites-enabled/www.test.ch \
|
__link /root/shadow --source /etc/shadow --type hard
|
||||||
|
|
||||||
|
# Relative symbolic link
|
||||||
|
__link /etc/apache2/sites-enabled/www.test.ch \
|
||||||
--source ../sites-available/www.test.ch \
|
--source ../sites-available/www.test.ch \
|
||||||
--type symbolic
|
--type symbolic
|
||||||
|
|
||||||
# Absolute symbolic link
|
# Absolute symbolic link
|
||||||
__link /opt/plone --source /home/services/plone --type symbolic
|
__link /opt/plone --source /home/services/plone --type symbolic
|
||||||
|
|
||||||
# Remove link
|
# Remove link
|
||||||
__link /opt/plone --state absent
|
__link /opt/plone --state absent
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__locale(7)
|
cdist-type__locale(7)
|
||||||
=====================
|
=====================
|
||||||
|
Configure locales
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__locale - Configure locales
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to setup locales.
|
This cdist type allows you to setup locales.
|
||||||
|
|
@ -15,30 +12,30 @@ This cdist type allows you to setup locales.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to present
|
'present' or 'absent', defaults to present
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Add locale de_CH.UTF-8
|
|
||||||
__locale de_CH.UTF-8
|
|
||||||
|
|
||||||
# Same as above, but more explicit
|
# Add locale de_CH.UTF-8
|
||||||
__locale de_CH.UTF-8 --state present
|
__locale de_CH.UTF-8
|
||||||
|
|
||||||
# Remove colourful British English
|
# Same as above, but more explicit
|
||||||
__locale en_GB.UTF-8 --state absent
|
__locale de_CH.UTF-8 --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove colourful British English
|
||||||
|
__locale en_GB.UTF-8 --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- locale(1)
|
- locale(1)
|
||||||
- localedef(1)
|
- localedef(1)
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__motd(7)
|
cdist-type__motd(7)
|
||||||
===================
|
===================
|
||||||
|
Manage message of the day
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__motd - Manage message of the day
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to easily setup /etc/motd.
|
This cdist type allows you to easily setup /etc/motd.
|
||||||
|
|
@ -20,7 +17,7 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
If supplied, copy this file from the host running cdist to the target.
|
If supplied, copy this file from the host running cdist to the target.
|
||||||
If not supplied, a default message will be placed onto the target.
|
If not supplied, a default message will be placed onto the target.
|
||||||
|
|
||||||
|
|
@ -28,18 +25,18 @@ source::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Use cdist defaults
|
|
||||||
__motd
|
|
||||||
|
|
||||||
# Supply source file from a different type
|
# Use cdist defaults
|
||||||
__motd --source "$__type/files/my-motd"
|
__motd
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Supply source file from a different type
|
||||||
|
__motd --source "$__type/files/my-motd"
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__mount(7)
|
cdist-type__mount(7)
|
||||||
====================
|
====================
|
||||||
|
Manage filesystem mounts
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__mount - manage filesystem mounts
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Manage filesystem mounts either via /etc/fstab or manually.
|
Manage filesystem mounts either via /etc/fstab or manually.
|
||||||
|
|
@ -20,62 +17,62 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
device::
|
device
|
||||||
device to mount at path, defaults to 'none'. see mount(8)
|
device to mount at path, defaults to 'none'. see mount(8)
|
||||||
|
|
||||||
dump::
|
dump
|
||||||
value for the dump field in fstab. see fstab(5)
|
value for the dump field in fstab. see fstab(5)
|
||||||
defaults to 0.
|
defaults to 0.
|
||||||
|
|
||||||
This parameter is ignored, if the nofstab parameter is given.
|
This parameter is ignored, if the nofstab parameter is given.
|
||||||
|
|
||||||
options::
|
options
|
||||||
comma separated string of options, see mount(8)
|
comma separated string of options, see mount(8)
|
||||||
|
|
||||||
pass::
|
pass
|
||||||
value for the pass field in fstab. see fstab(5)
|
value for the pass field in fstab. see fstab(5)
|
||||||
defaults to 0.
|
defaults to 0.
|
||||||
|
|
||||||
This parameter is ignored, if the nofstab parameter is given.
|
This parameter is ignored, if the nofstab parameter is given.
|
||||||
|
|
||||||
path::
|
path
|
||||||
mount point where to mount the device, see mount(8).
|
mount point where to mount the device, see mount(8).
|
||||||
Defaults to __object_id
|
Defaults to __object_id
|
||||||
|
|
||||||
state::
|
state
|
||||||
either present or absent. Defaults to present.
|
either present or absent. Defaults to present.
|
||||||
|
|
||||||
type::
|
type
|
||||||
vfstype, see mount(8)
|
vfstype, see mount(8)
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
nofstab::
|
nofstab
|
||||||
do not manage an entry in /etc/fstab
|
do not manage an entry in /etc/fstab
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__mount /some/dir \
|
|
||||||
|
__mount /some/dir \
|
||||||
--device /dev/sdc3 \
|
--device /dev/sdc3 \
|
||||||
--type xfs \
|
--type xfs \
|
||||||
--options "defaults,ro"
|
--options "defaults,ro"
|
||||||
--dump 0 \
|
--dump 0 \
|
||||||
--pass 1
|
--pass 1
|
||||||
|
|
||||||
__mount /var/lib/one \
|
__mount /var/lib/one \
|
||||||
--device mfsmount \
|
--device mfsmount \
|
||||||
--type fuse \
|
--type fuse \
|
||||||
--options "mfsmaster=mfsmaster.domain.tld,mfssubfolder=/one,nonempty,_netdev"
|
--options "mfsmaster=mfsmaster.domain.tld,mfssubfolder=/one,nonempty,_netdev"
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__mysql_database(7)
|
cdist-type__mysql_database(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manage a MySQL database
|
||||||
|
|
||||||
Benedikt Koeppel <code@benediktkoeppel.ch>
|
Benedikt Koeppel <code@benediktkoeppel.ch>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__mysql_database - Manage a MySQL database
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to install a MySQL database.
|
This cdist type allows you to install a MySQL database.
|
||||||
|
|
@ -19,28 +16,28 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
The name of the database to install
|
The name of the database to install
|
||||||
defaults to the object id
|
defaults to the object id
|
||||||
|
|
||||||
user::
|
user
|
||||||
A user that should have access to the database
|
A user that should have access to the database
|
||||||
|
|
||||||
password::
|
password
|
||||||
The password for the user who manages the database
|
The password for the user who manages the database
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__mysql_database "cdist" --name "cdist" --user "myuser" --password "mypwd"
|
|
||||||
--------------------------------------------------------------------------------
|
__mysql_database "cdist" --name "cdist" --user "myuser" --password "mypwd"
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package(7)
|
cdist-type__package(7)
|
||||||
======================
|
======================
|
||||||
|
Manage packages
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package - Manage packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to install or uninstall packages on the target.
|
This cdist type allows you to install or uninstall packages on the target.
|
||||||
|
|
@ -21,40 +18,41 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
The name of the package to install. Default is to use the object_id as the
|
The name of the package to install. Default is to use the object_id as the
|
||||||
package name.
|
package name.
|
||||||
version::
|
version
|
||||||
The version of the package to install. Default is to install the version
|
The version of the package to install. Default is to install the version
|
||||||
chosen by the local package manager.
|
chosen by the local package manager.
|
||||||
type::
|
type
|
||||||
The package type to use. Default is determined based on the $os explorer
|
The package type to use. Default is determined based on the $os explorer
|
||||||
variable.
|
variable.
|
||||||
e.g. __package_apt for Debian
|
e.g.
|
||||||
__package_emerge for Gentoo
|
* __package_apt for Debian
|
||||||
|
* __package_emerge for Gentoo
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Install the package vim on the target
|
|
||||||
__package vim --state present
|
|
||||||
|
|
||||||
# Same but install specific version
|
# Install the package vim on the target
|
||||||
__package vim --state present --version 7.3.50
|
__package vim --state present
|
||||||
|
|
||||||
# Force use of a specific package type
|
# Same but install specific version
|
||||||
__package vim --state present --type __package_apt
|
__package vim --state present --version 7.3.50
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Force use of a specific package type
|
||||||
|
__package vim --state present --type __package_apt
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_apt(7)
|
cdist-type__package_apt(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage packages with apt-get
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_apt - Manage packages with apt-get
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
apt-get is usually used on Debian and variants (like Ubuntu) to
|
apt-get is usually used on Debian and variants (like Ubuntu) to
|
||||||
|
|
@ -21,35 +18,35 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
target-release::
|
target-release
|
||||||
Passed on to apt-get install, see apt-get(8).
|
Passed on to apt-get install, see apt-get(8).
|
||||||
Essentially allows you to retrieve packages from a different release
|
Essentially allows you to retrieve packages from a different release
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh in installed
|
|
||||||
__package_apt zsh --state present
|
|
||||||
|
|
||||||
# In case you only want *a* webserver, but don't care which one
|
# Ensure zsh in installed
|
||||||
__package_apt webserver --state present --name nginx
|
__package_apt zsh --state present
|
||||||
|
|
||||||
# Remove obsolete package
|
# In case you only want *a* webserver, but don't care which one
|
||||||
__package_apt puppet --state absent
|
__package_apt webserver --state present --name nginx
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_apt puppet --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_emerge(7)
|
cdist-type__package_emerge(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manage packages with portage
|
||||||
|
|
||||||
Thomas Oettli <otho--@--sfs.biz>
|
Thomas Oettli <otho--@--sfs.biz>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_emerge - Manage packages with portage
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Portage is usually used on the gentoo distribution to manage packages.
|
Portage is usually used on the gentoo distribution to manage packages.
|
||||||
|
|
@ -23,35 +20,35 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present".
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
version::
|
version
|
||||||
If supplied, use to install or uninstall a specific version of the package named.
|
If supplied, use to install or uninstall a specific version of the package named.
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure sys-devel/gcc is installed
|
|
||||||
__package_emerge sys-devel/gcc --state present
|
|
||||||
|
|
||||||
# If you want a specific version of a package
|
# Ensure sys-devel/gcc is installed
|
||||||
__package_emerge app-portage/gentoolkit --state present --version 0.3.0.8-r2
|
__package_emerge sys-devel/gcc --state present
|
||||||
|
|
||||||
# Remove package
|
# If you want a specific version of a package
|
||||||
__package_emerge sys-devel/gcc --state absent
|
__package_emerge app-portage/gentoolkit --state present --version 0.3.0.8-r2
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove package
|
||||||
|
__package_emerge sys-devel/gcc --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
- cdist-type__package_emerge_dependencies(7)
|
- `cdist-type__package_emerge_dependencies(7) <cdist-type__package_emerge_dependencies.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,19 +1,17 @@
|
||||||
cdist-type__package_emerge_dependencies(7)
|
cdist-type__package_emerge_dependencies(7)
|
||||||
==========================================
|
==========================================
|
||||||
|
Install dependencies for __package_emerge
|
||||||
|
|
||||||
Thomas Oettli <otho--@--sfs.biz>
|
Thomas Oettli <otho--@--sfs.biz>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_emerge_dependencies - Install dependencies for __package_emerge
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Portage is usually used on the gentoo distribution to manage packages.
|
Portage is usually used on the gentoo distribution to manage packages.
|
||||||
This type installs the following tools which are required by __package_emerge to work:
|
This type installs the following tools which are required by __package_emerge to work:
|
||||||
app-portage/flaggie
|
|
||||||
app-portage/gentoolkit
|
* app-portage/flaggie
|
||||||
|
* app-portage/gentoolkit
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
|
|
@ -29,17 +27,17 @@ None
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure app-portage/flaggie and app-portage/gentoolkit are installed
|
|
||||||
__package_emerge_dependencies
|
# Ensure app-portage/flaggie and app-portage/gentoolkit are installed
|
||||||
--------------------------------------------------------------------------------
|
__package_emerge_dependencies
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
- cdist-type__package_emerge(7)
|
- `cdist-type__package_emerge(7) <cdist-type__package_emerge.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_luarocks(7)
|
cdist-type__package_luarocks(7)
|
||||||
===============================
|
===============================
|
||||||
|
Manage luarocks packages
|
||||||
|
|
||||||
Christian G. Warden <cwarden@xerus.org>
|
Christian G. Warden <cwarden@xerus.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_luarocks - Manage luarocks packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
LuaRocks is a deployment and management system for Lua modules.
|
LuaRocks is a deployment and management system for Lua modules.
|
||||||
|
|
@ -20,29 +17,29 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure luasocket is installed
|
|
||||||
__package_luarocks luasocket --state present
|
|
||||||
|
|
||||||
# Remove package
|
# Ensure luasocket is installed
|
||||||
__package_luarocks luasocket --state absent
|
__package_luarocks luasocket --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove package
|
||||||
|
__package_luarocks luasocket --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_opkg(7)
|
cdist-type__package_opkg(7)
|
||||||
==========================
|
===========================
|
||||||
|
Manage packages with opkg
|
||||||
|
|
||||||
Giel van Schijndel <giel+cdist--@--mortis.eu>
|
Giel van Schijndel <giel+cdist--@--mortis.eu>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_opkg - Manage packages with opkg
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
opkg is usually used on OpenWRT to manage packages.
|
opkg is usually used on OpenWRT to manage packages.
|
||||||
|
|
@ -20,29 +17,29 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure lsof is installed
|
|
||||||
__package_opkg lsof --state present
|
|
||||||
|
|
||||||
# Remove obsolete package
|
# Ensure lsof is installed
|
||||||
__package_opkg dnsmasq --state absent
|
__package_opkg lsof --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_opkg dnsmasq --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_pacman(7)
|
cdist-type__package_pacman(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manage packages with pacman
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_pacman - Manage packages with pacman
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Pacman is usually used on the Archlinux distribution to manage packages.
|
Pacman is usually used on the Archlinux distribution to manage packages.
|
||||||
|
|
@ -20,32 +17,32 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh in installed
|
|
||||||
__package_pacman zsh --state present
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
# Ensure zsh in installed
|
||||||
__package_pacman python --state present --name python2
|
__package_pacman zsh --state present
|
||||||
|
|
||||||
# Remove obsolete package
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
__package_pacman puppet --state absent
|
__package_pacman python --state present --name python2
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pacman puppet --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_pip(7)
|
cdist-type__package_pip(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage packages with pip
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_pip - Manage packages with pip
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Pip is used in Python environments to install packages.
|
Pip is used in Python environments to install packages.
|
||||||
|
|
@ -21,38 +18,38 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
pip::
|
pip
|
||||||
Instead of using pip from PATH, use the specific pip path.
|
Instead of using pip from PATH, use the specific pip path.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
runas::
|
runas
|
||||||
Run pip as specified user. By default it runs as root.
|
Run pip as specified user. By default it runs as root.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Install a package
|
|
||||||
__package_pip pyro --state present
|
|
||||||
|
|
||||||
# Use pip in a virtualenv located at /root/shinken_virtualenv
|
# Install a package
|
||||||
__package_pip pyro --state present --pip /root/shinken_virtualenv/bin/pip
|
__package_pip pyro --state present
|
||||||
|
|
||||||
# Use pip in a virtualenv located at /foo/shinken_virtualenv as user foo
|
# Use pip in a virtualenv located at /root/shinken_virtualenv
|
||||||
__package_pip pyro --state present --pip /foo/shinken_virtualenv/bin/pip --runas foo
|
__package_pip pyro --state present --pip /root/shinken_virtualenv/bin/pip
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Use pip in a virtualenv located at /foo/shinken_virtualenv as user foo
|
||||||
|
__package_pip pyro --state present --pip /foo/shinken_virtualenv/bin/pip --runas foo
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_pkg_freebsd(7)
|
cdist-type__package_pkg_freebsd(7)
|
||||||
==================================
|
==================================
|
||||||
|
Manage FreeBSD packages
|
||||||
|
|
||||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_pkg_freebsd - Manage FreeBSD packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type is usually used on FreeBSD to manage packages.
|
This type is usually used on FreeBSD to manage packages.
|
||||||
|
|
@ -20,44 +17,44 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
flavor::
|
flavor
|
||||||
If supplied, use to avoid ambiguity.
|
If supplied, use to avoid ambiguity.
|
||||||
|
|
||||||
version::
|
version
|
||||||
If supplied, use to install a specific version of the package named.
|
If supplied, use to install a specific version of the package named.
|
||||||
|
|
||||||
pkgsite::
|
pkgsite
|
||||||
If supplied, use to install from a specific package repository.
|
If supplied, use to install from a specific package repository.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh is installed
|
|
||||||
__package_pkg_freebsd zsh --state present
|
|
||||||
|
|
||||||
# Ensure vim is installed, use flavor no_x11
|
# Ensure zsh is installed
|
||||||
__package_pkg_freebsd vim --state present --flavor no_x11
|
__package_pkg_freebsd zsh --state present
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
# Ensure vim is installed, use flavor no_x11
|
||||||
__package_pkg_freebsd python --state present --name python2
|
__package_pkg_freebsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
# Remove obsolete package
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
__package_pkg_freebsd puppet --state absent
|
__package_pkg_freebsd python --state present --name python2
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkg_freebsd puppet --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
63
cdist/conf/type/__package_pkg_openbsd/man.rst
Normal file
63
cdist/conf/type/__package_pkg_openbsd/man.rst
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
cdist-type__package_pkg(7)
|
||||||
|
==========================
|
||||||
|
Manage OpenBSD packages
|
||||||
|
|
||||||
|
Andi Brönnimann <andi-cdist--@--v-net.ch>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This type is usually used on OpenBSD to manage packages.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
name
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
|
flavor
|
||||||
|
If supplied, use to avoid ambiguity.
|
||||||
|
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
pkg_path
|
||||||
|
Manually specify a PKG_PATH to add packages from.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Ensure zsh is installed
|
||||||
|
__package_pkg_openbsd zsh --state present
|
||||||
|
|
||||||
|
# Ensure vim is installed, use flavor no_x11
|
||||||
|
__package_pkg_openbsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_pkg_openbsd python --state present --name python2
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkg_openbsd puppet --state absent
|
||||||
|
|
||||||
|
# Add a package using a particular mirror
|
||||||
|
__package_pkg_openbsd bash \
|
||||||
|
--pkg_path http://openbsd.mirrorcatalogs.com/snapshots/packages/amd64
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011 Andi Brönnimann. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,66 +0,0 @@
|
||||||
cdist-type__package_pkg(7)
|
|
||||||
==========================
|
|
||||||
Andi Brönnimann <andi-cdist--@--v-net.ch>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_pkg_openbsd - Manage OpenBSD packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This type is usually used on OpenBSD to manage packages.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
None
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
name::
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
|
|
||||||
flavor::
|
|
||||||
If supplied, use to avoid ambiguity.
|
|
||||||
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present"
|
|
||||||
|
|
||||||
pkg_path::
|
|
||||||
Manually specify a PKG_PATH to add packages from.
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Ensure zsh is installed
|
|
||||||
__package_pkg_openbsd zsh --state present
|
|
||||||
|
|
||||||
# Ensure vim is installed, use flavor no_x11
|
|
||||||
__package_pkg_openbsd vim --state present --flavor no_x11
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
|
||||||
__package_pkg_openbsd python --state present --name python2
|
|
||||||
|
|
||||||
# Remove obsolete package
|
|
||||||
__package_pkg_openbsd puppet --state absent
|
|
||||||
|
|
||||||
# Add a package using a particular mirror
|
|
||||||
__package_pkg_openbsd bash \
|
|
||||||
--pkg_path http://openbsd.mirrorcatalogs.com/snapshots/packages/amd64
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__package(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011 Andi Brönnimann. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_pkgng_freebsd(7)
|
cdist-type__package_pkgng_freebsd(7)
|
||||||
==================================
|
====================================
|
||||||
|
Manage FreeBSD packages with pkg-ng
|
||||||
|
|
||||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_pkgng_freebsd - Manage FreeBSD packages with pkg-ng
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type is usually used on FreeBSD to manage packages.
|
This type is usually used on FreeBSD to manage packages.
|
||||||
|
|
@ -20,31 +17,31 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
flavor::
|
flavor
|
||||||
If supplied, use to avoid ambiguity.
|
If supplied, use to avoid ambiguity.
|
||||||
|
|
||||||
version::
|
version
|
||||||
If supplied, use to install a specific version of the package named.
|
If supplied, use to install a specific version of the package named.
|
||||||
|
|
||||||
repo::
|
repo
|
||||||
If supplied, use to install the package named from a particular repo.
|
If supplied, use to install the package named from a particular repo.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
upgrade::
|
upgrade
|
||||||
If supplied, allow upgrading to the latest version of a package.
|
If supplied, allow upgrading to the latest version of a package.
|
||||||
|
|
||||||
|
|
||||||
CAVEATS
|
CAVEATS
|
||||||
-------
|
-------
|
||||||
This type requires that repository definitions already exist in /etc/pkg/*.conf.
|
This type requires that repository definitions already exist in /etc/pkg/\*.conf.
|
||||||
Ensure that they exist prior to use of this type with __file.
|
Ensure that they exist prior to use of this type with __file.
|
||||||
|
|
||||||
pkg-ng can't upgrade a package to a specific version. If this type needs to
|
pkg-ng can't upgrade a package to a specific version. If this type needs to
|
||||||
|
|
@ -54,41 +51,41 @@ upgrade a package, it can only ugprade to the latest available version. If the
|
||||||
|
|
||||||
MESSAGES
|
MESSAGES
|
||||||
--------
|
--------
|
||||||
install::
|
install
|
||||||
The package was installed
|
The package was installed
|
||||||
remove::
|
remove
|
||||||
The package was removed
|
The package was removed
|
||||||
upgrade::
|
upgrade
|
||||||
The package was upgraded
|
The package was upgraded
|
||||||
exist::
|
exist
|
||||||
The package was already present and thus not installed
|
The package was already present and thus not installed
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh is installed
|
|
||||||
__package_pkgng_freebsd zsh --state present
|
|
||||||
|
|
||||||
# Ensure vim is installed, use flavor no_x11
|
# Ensure zsh is installed
|
||||||
__package_pkgng_freebsd vim --state present --flavor no_x11
|
__package_pkgng_freebsd zsh --state present
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
# Ensure vim is installed, use flavor no_x11
|
||||||
__package_pkgng_freebsd python --state present --name python2
|
__package_pkgng_freebsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
# Install a package from a particular repository when multiples exist
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
__package_pkgng_freebsd bash --state present --repo myrepo
|
__package_pkgng_freebsd python --state present --name python2
|
||||||
|
|
||||||
# Remove obsolete package
|
# Install a package from a particular repository when multiples exist
|
||||||
__package_pkgng_freebsd puppet --state absent
|
__package_pkgng_freebsd bash --state present --repo myrepo
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkgng_freebsd puppet --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_rubygem(7)
|
cdist-type__package_rubygem(7)
|
||||||
==============================
|
==============================
|
||||||
|
Manage rubygem packages
|
||||||
|
|
||||||
Chase Allen James <nx-cdist@nu-ex.com>
|
Chase Allen James <nx-cdist@nu-ex.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_rubygem - Manage rubygem packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Rubygems is the default package management system for the Ruby programming language.
|
Rubygems is the default package management system for the Ruby programming language.
|
||||||
|
|
@ -20,29 +17,29 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure sinatra is installed
|
|
||||||
__package_rubygem sinatra --state present
|
|
||||||
|
|
||||||
# Remove package
|
# Ensure sinatra is installed
|
||||||
__package_rubygem rails --state absent
|
__package_rubygem sinatra --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove package
|
||||||
|
__package_rubygem rails --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_update_index(7)
|
cdist-type__package_update_index(7)
|
||||||
===================================
|
===================================
|
||||||
|
Update the package index
|
||||||
|
|
||||||
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_update_index - Update the package index
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to update the package index on the target.
|
This cdist type allows you to update the package index on the target.
|
||||||
|
|
@ -21,29 +18,30 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
type::
|
type
|
||||||
The package manager to use. Default is determined based on the $os
|
The package manager to use. Default is determined based on the $os
|
||||||
explorer variable.
|
explorer variable.
|
||||||
e.g. apt for Debian
|
e.g.
|
||||||
yum for Red Hat
|
* apt for Debian
|
||||||
pacman for Arch Linux
|
* yum for Red Hat
|
||||||
|
* pacman for Arch Linux
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Update the package index on the target
|
|
||||||
__package_update_index
|
|
||||||
|
|
||||||
# Force use of a specific package manager
|
# Update the package index on the target
|
||||||
__package_update_index --type apt
|
__package_update_index
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Force use of a specific package manager
|
||||||
|
__package_update_index --type apt
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_upgrade_all(7)
|
cdist-type__package_upgrade_all(7)
|
||||||
==================================
|
==================================
|
||||||
|
Upgrade all the installed packages
|
||||||
|
|
||||||
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_upgrade_all - Upgrade all the installed packages
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to upgrade all the installed packages on the
|
This cdist type allows you to upgrade all the installed packages on the
|
||||||
|
|
@ -21,29 +18,30 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
type::
|
type
|
||||||
The package manager to use. Default is determined based on the $os
|
The package manager to use. Default is determined based on the $os
|
||||||
explorer variable.
|
explorer variable.
|
||||||
e.g. apt for Debian
|
e.g.
|
||||||
yum for Red Hat
|
* apt for Debian
|
||||||
pacman for Arch Linux
|
* yum for Red Hat
|
||||||
|
* pacman for Arch Linux
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Upgrade all the installed packages on the target
|
|
||||||
__package_upgrade_all
|
|
||||||
|
|
||||||
# Force use of a specific package manager
|
# Upgrade all the installed packages on the target
|
||||||
__package_upgrade_all --type apt
|
__package_upgrade_all
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Force use of a specific package manager
|
||||||
|
__package_upgrade_all --type apt
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_yum(7)
|
cdist-type__package_yum(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage packages with yum
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_yum - Manage packages with yum
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Yum is usually used on the Fedora distribution to manage packages.
|
Yum is usually used on the Fedora distribution to manage packages.
|
||||||
|
|
@ -22,37 +19,37 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
url::
|
url
|
||||||
URL to use for the package
|
URL to use for the package
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh in installed
|
|
||||||
__package_yum zsh --state present
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
# Ensure zsh in installed
|
||||||
__package_yum python --state present --name python2
|
__package_yum zsh --state present
|
||||||
|
|
||||||
# Remove obsolete package
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
__package_yum puppet --state absent
|
__package_yum python --state present --name python2
|
||||||
|
|
||||||
__package epel-release-6-8 \
|
# Remove obsolete package
|
||||||
|
__package_yum puppet --state absent
|
||||||
|
|
||||||
|
__package epel-release-6-8 \
|
||||||
--url http://mirror.switch.ch/ftp/mirror/epel/6/i386/epel-release-6-8.noarch.rpm
|
--url http://mirror.switch.ch/ftp/mirror/epel/6/i386/epel-release-6-8.noarch.rpm
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__package_zypper(7)
|
cdist-type__package_zypper(7)
|
||||||
=============================
|
=============================
|
||||||
|
Manage packages with zypper
|
||||||
|
|
||||||
Daniel Heule <hda--@--sfs.biz>
|
Daniel Heule <hda--@--sfs.biz>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__package_zypper - Manage packages with zypper
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Zypper is usually used on the SuSE distribution to manage packages.
|
Zypper is usually used on the SuSE distribution to manage packages.
|
||||||
|
|
@ -20,46 +17,46 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
name::
|
name
|
||||||
If supplied, use the name and not the object id as the package name.
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
version::
|
version
|
||||||
The version of the package to install. Default is to install the version
|
The version of the package to install. Default is to install the version
|
||||||
chosen by the local package manager. For a list of available versions,
|
chosen by the local package manager. For a list of available versions,
|
||||||
have a look at the output of "zypper se -s packagename"
|
have a look at the output of "zypper se -s packagename"
|
||||||
|
|
||||||
ptype::
|
ptype
|
||||||
Either "package", "patch", "pattern", "product" or "srcpackage", defaults to "package". For a description see man zypper.
|
Either "package", "patch", "pattern", "product" or "srcpackage", defaults to "package". For a description see man zypper.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure zsh is installed
|
|
||||||
__package_zypper zsh --state present
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
# Ensure zsh is installed
|
||||||
__package_zypper python --state present --name python2
|
__package_zypper zsh --state present
|
||||||
|
|
||||||
# Ensure binutils is installed and the version is forced to be 2.23.1-0.19.2
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
__package_zypper binutils --state present --version 2.23.1-0.19.2
|
__package_zypper python --state present --name python2
|
||||||
|
|
||||||
# Remove package
|
# Ensure binutils is installed and the version is forced to be 2.23.1-0.19.2
|
||||||
__package_zypper cfengine --state absent
|
__package_zypper binutils --state present --version 2.23.1-0.19.2
|
||||||
|
|
||||||
# install all packages which belongs to pattern x11
|
# Remove package
|
||||||
__package_zypper x11 --ptype pattern --state present
|
__package_zypper cfengine --state absent
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# install all packages which belongs to pattern x11
|
||||||
|
__package_zypper x11 --ptype pattern --state present
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__package(7)
|
- `cdist-type__package(7) <cdist-type__package.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__pacman_conf(7)
|
cdist-type__pacman_conf(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage pacman configuration
|
||||||
|
|
||||||
Dominique Roux <dominique.roux4@gmail.com>
|
Dominique Roux <dominique.roux4@gmail.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__pacman_conf - Manage pacman configuration
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
The type allows you to configure options section, add or delete repositories and manage mirrorlists
|
The type allows you to configure options section, add or delete repositories and manage mirrorlists
|
||||||
|
|
@ -15,27 +12,27 @@ The type allows you to configure options section, add or delete repositories and
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
section::
|
section
|
||||||
'options' for configure options section
|
'options' for configure options section
|
||||||
|
|
||||||
Otherwise it specifies a repository or a plain file
|
Otherwise it specifies a repository or a plain file
|
||||||
|
|
||||||
key::
|
key
|
||||||
Specifies the key which will be set
|
Specifies the key which will be set
|
||||||
|
|
||||||
If section = 'options' or file is not set the key will
|
If section = 'options' or file is not set the key will
|
||||||
be checked against available keys from pacman.conf
|
be checked against available keys from pacman.conf
|
||||||
|
|
||||||
value::
|
value
|
||||||
Specifies the value which will be set against the key
|
Specifies the value which will be set against the key
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
file::
|
file
|
||||||
Specifies the filename.
|
Specifies the filename.
|
||||||
|
|
||||||
The managed file will be named like 'plain_file_filename'
|
The managed file will be named like 'plain_file_filename'
|
||||||
|
|
@ -46,23 +43,22 @@ file::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Manage options section in pacman.conf
|
|
||||||
__pacman_conf options_Architecture --section options --key Architecture --value auto
|
|
||||||
|
|
||||||
# Add new repository
|
# Manage options section in pacman.conf
|
||||||
__pacman_conf localrepo_Server --section localrepo --key Server --value "file:///var/cache/pacman/pkg"
|
__pacman_conf options_Architecture --section options --key Architecture --value auto
|
||||||
|
|
||||||
# Add mirror to a mirrorlist
|
# Add new repository
|
||||||
__pacman_conf customlist_Server --file customlist --section customlist --key Server\
|
__pacman_conf localrepo_Server --section localrepo --key Server --value "file:///var/cache/pacman/pkg"
|
||||||
|
|
||||||
|
# Add mirror to a mirrorlist
|
||||||
|
__pacman_conf customlist_Server --file customlist --section customlist --key Server\
|
||||||
--value "file:///var/cache/pacman/pkg"
|
--value "file:///var/cache/pacman/pkg"
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- grep(1)
|
- grep(1)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__pacman_conf_integrate(7)
|
cdist-type__pacman_conf_integrate(7)
|
||||||
====================================
|
====================================
|
||||||
|
Integrate default pacman.conf to cdist conform and vice versa
|
||||||
|
|
||||||
Dominique Roux <dominique.roux4@gmail.com>
|
Dominique Roux <dominique.roux4@gmail.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__pacman_conf_integrate - Integrate default pacman.conf to cdist conform and vice versa
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
The type allows you to convert the default pacman.conf to a cdist conform one and vice versa
|
The type allows you to convert the default pacman.conf to a cdist conform one and vice versa
|
||||||
|
|
@ -19,26 +16,25 @@ None.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
'present' or 'absent', defaults to 'present'
|
'present' or 'absent', defaults to 'present'
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Convert normal to cdist conform
|
|
||||||
__pacman_conf_integrate convert
|
|
||||||
|
|
||||||
# Convert cdist conform to normal
|
# Convert normal to cdist conform
|
||||||
__pacman_conf_integrate convert --state absent
|
__pacman_conf_integrate convert
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
# Convert cdist conform to normal
|
||||||
|
__pacman_conf_integrate convert --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- grep(1)
|
- grep(1)
|
||||||
|
|
||||||
|
|
||||||
53
cdist/conf/type/__pf_apply/man.rst
Normal file
53
cdist/conf/type/__pf_apply/man.rst
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
cdist-type__pf_apply(7)
|
||||||
|
=======================
|
||||||
|
Apply pf(4) ruleset on \*BSD
|
||||||
|
|
||||||
|
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||||
|
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This type is used on \*BSD systems to manage the pf firewall's active ruleset.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
NONE
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
NONE
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Modify the ruleset on $__target_host:
|
||||||
|
__pf_ruleset --state present --source /my/pf/ruleset.conf
|
||||||
|
require="__pf_ruleset" \
|
||||||
|
__pf_apply
|
||||||
|
|
||||||
|
# Remove the ruleset on $__target_host (implies disabling pf(4):
|
||||||
|
__pf_ruleset --state absent
|
||||||
|
require="__pf_ruleset" \
|
||||||
|
__pf_apply
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__pf_ruleset(7) <cdist-type__pf_ruleset.html>`_
|
||||||
|
- pf(4)
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2012 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
cdist-type__pf_apply(7)
|
|
||||||
=======================
|
|
||||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__pf_apply - Apply pf(4) ruleset on *BSD
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This type is used on *BSD systems to manage the pf firewall's active ruleset.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
NONE
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
NONE
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Modify the ruleset on $__target_host:
|
|
||||||
__pf_ruleset --state present --source /my/pf/ruleset.conf
|
|
||||||
require="__pf_ruleset" \
|
|
||||||
__pf_apply
|
|
||||||
|
|
||||||
# Remove the ruleset on $__target_host (implies disabling pf(4):
|
|
||||||
__pf_ruleset --state absent
|
|
||||||
require="__pf_ruleset" \
|
|
||||||
__pf_apply
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__pf_ruleset(7)
|
|
||||||
- pf(4)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2012 Jake Guffey. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
@ -1,27 +1,24 @@
|
||||||
cdist-type__pf_ruleset(7)
|
cdist-type__pf_ruleset(7)
|
||||||
=========================
|
=========================
|
||||||
|
Copy a pf(4) ruleset to $__target_host
|
||||||
|
|
||||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__pf_ruleset - Copy a pf(4) ruleset to $__target_host
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type is used on *BSD systems to manage the pf firewall's ruleset.
|
This type is used on \*BSD systems to manage the pf firewall's ruleset.
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "absent" (no ruleset at all) or "present", defaults to "present".
|
Either "absent" (no ruleset at all) or "present", defaults to "present".
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
If supplied, use to define the ruleset to load onto the $__target_host for pf(4).
|
If supplied, use to define the ruleset to load onto the $__target_host for pf(4).
|
||||||
Note that this type is almost useless without a ruleset defined, but it's technically not
|
Note that this type is almost useless without a ruleset defined, but it's technically not
|
||||||
needed, e.g. for the case of disabling the firewall temporarily.
|
needed, e.g. for the case of disabling the firewall temporarily.
|
||||||
|
|
@ -30,19 +27,18 @@ source::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Remove the current ruleset in place
|
|
||||||
__pf_ruleset --state absent
|
|
||||||
|
|
||||||
# Enable the firewall with the ruleset defined in $__manifest/files/pf.conf
|
# Remove the current ruleset in place
|
||||||
__pf_ruleset --state present --source $__manifest/files/pf.conf
|
__pf_ruleset --state absent
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
# Enable the firewall with the ruleset defined in $__manifest/files/pf.conf
|
||||||
|
__pf_ruleset --state present --source $__manifest/files/pf.conf
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- pf(4)
|
- pf(4)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postfix(7)
|
cdist-type__postfix(7)
|
||||||
======================
|
======================
|
||||||
|
Install postfix
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postfix - install postfix
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This space intentionally left blank.
|
This space intentionally left blank.
|
||||||
|
|
@ -26,14 +23,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postfix
|
|
||||||
--------------------------------------------------------------------------------
|
__postfix
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postfix_master(7)
|
cdist-type__postfix_master(7)
|
||||||
=============================
|
=============================
|
||||||
|
Configure postfix master.cf
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postfix_master - configure postfix master.cf
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
See master(5) for more information.
|
See master(5) for more information.
|
||||||
|
|
@ -15,54 +12,62 @@ See master(5) for more information.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
type::
|
type
|
||||||
See master(5)
|
See master(5)
|
||||||
command::
|
command
|
||||||
See master(5)
|
See master(5)
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
noreload::
|
noreload
|
||||||
don't reload postfix after changes
|
don't reload postfix after changes
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
present or absent, defaults to present
|
present or absent, defaults to present
|
||||||
service::
|
|
||||||
private::
|
service
|
||||||
unpriv::
|
|
||||||
chroot::
|
private
|
||||||
wakeup::
|
|
||||||
maxproc::
|
unpriv
|
||||||
option::
|
|
||||||
|
chroot
|
||||||
|
|
||||||
|
wakeup
|
||||||
|
|
||||||
|
maxproc
|
||||||
|
|
||||||
|
option
|
||||||
Pass an option to a service. Same as using -o in master.cf.
|
Pass an option to a service. Same as using -o in master.cf.
|
||||||
Can be specified multiple times.
|
Can be specified multiple times.
|
||||||
comment::
|
|
||||||
|
comment
|
||||||
a textual comment to add with the master.cf entry
|
a textual comment to add with the master.cf entry
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postfix_master smtp --type inet --command smtpd
|
|
||||||
|
|
||||||
__postfix_master smtp --type inet --chroot y --command smtpd \
|
__postfix_master smtp --type inet --command smtpd
|
||||||
|
|
||||||
|
__postfix_master smtp --type inet --chroot y --command smtpd \
|
||||||
--option smtpd_enforce_tls=yes \
|
--option smtpd_enforce_tls=yes \
|
||||||
--option smtpd_sasl_auth_enable=yes \
|
--option smtpd_sasl_auth_enable=yes \
|
||||||
--option smtpd_client_restrictions=permit_sasl_authenticated,reject
|
--option smtpd_client_restrictions=permit_sasl_authenticated,reject
|
||||||
|
|
||||||
__postfix_master submission --type inet --command smtpd \
|
__postfix_master submission --type inet --command smtpd \
|
||||||
--comment "Run alternative smtp on submission port"
|
--comment "Run alternative smtp on submission port"
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- master(5)
|
- master(5)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postfix_postconf(7)
|
cdist-type__postfix_postconf(7)
|
||||||
===============================
|
===============================
|
||||||
|
Configure postfix main.cf
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postfix_postconf - configure postfix main.cf
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
See postconf(5) for possible keys and values.
|
See postconf(5) for possible keys and values.
|
||||||
|
|
@ -18,30 +15,29 @@ It does not make changes to /etc/postfix/main.cf itself.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
value::
|
value
|
||||||
the value for the postfix parameter
|
the value for the postfix parameter
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
key::
|
key
|
||||||
the name of the parameter. Defaults to __object_id
|
the name of the parameter. Defaults to __object_id
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postfix_postconf mydomain --value somedomain.com
|
|
||||||
|
|
||||||
__postfix_postconf bind-to-special-ip --key smtp_bind_address --value 127.0.0.5
|
__postfix_postconf mydomain --value somedomain.com
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
__postfix_postconf bind-to-special-ip --key smtp_bind_address --value 127.0.0.5
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- postconf(5)
|
- postconf(5)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postfix_postmap(7)
|
cdist-type__postfix_postmap(7)
|
||||||
==============================
|
==============================
|
||||||
|
Run postmap on the given file
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postfix_postmap - run postmap on the given file
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This space intentionally left blank.
|
This space intentionally left blank.
|
||||||
|
|
@ -26,14 +23,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postfix_postmap /etc/postfix/generic
|
|
||||||
--------------------------------------------------------------------------------
|
__postfix_postmap /etc/postfix/generic
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postfix_reload(7)
|
cdist-type__postfix_reload(7)
|
||||||
=============================
|
=============================
|
||||||
|
Tell postfix to reload its configuration
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postfix_reload - tell postfix to reload its configuration
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This space intentionally left blank.
|
This space intentionally left blank.
|
||||||
|
|
@ -26,14 +23,14 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postfix_reload
|
|
||||||
--------------------------------------------------------------------------------
|
__postfix_reload
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postgres_database(7)
|
cdist-type__postgres_database(7)
|
||||||
================================
|
================================
|
||||||
|
Create/drop postgres databases
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postgres_database - create/drop postgres databases
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to create or drop postgres databases.
|
This cdist type allows you to create or drop postgres databases.
|
||||||
|
|
@ -15,25 +12,25 @@ This cdist type allows you to create or drop postgres databases.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
either 'present' or 'absent', defaults to 'present'.
|
either 'present' or 'absent', defaults to 'present'.
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
the role owning this database
|
the role owning this database
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postgres_database mydbname --owner mydbusername
|
|
||||||
--------------------------------------------------------------------------------
|
__postgres_database mydbname --owner mydbusername
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__postgres_role(7)
|
- `cdist-type__postgres_role(7) <cdist-type__postgres_role.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__postgres_role(7)
|
cdist-type__postgres_role(7)
|
||||||
============================
|
============================
|
||||||
|
Manage postgres roles
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__postgres_role - manage postgres roles
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to create or drop postgres roles.
|
This cdist type allows you to create or drop postgres roles.
|
||||||
|
|
@ -15,43 +12,43 @@ This cdist type allows you to create or drop postgres roles.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
All other parameters map directly to the corresponding postgres createrole
|
All other parameters map directly to the corresponding postgres createrole
|
||||||
parameters.
|
parameters.
|
||||||
|
|
||||||
password::
|
password
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
All parameter map directly to the corresponding postgres createrole
|
All parameter map directly to the corresponding postgres createrole
|
||||||
parameters.
|
parameters.
|
||||||
|
|
||||||
login::
|
login
|
||||||
createdb::
|
createdb
|
||||||
createrole::
|
createrole
|
||||||
superuser::
|
superuser
|
||||||
inherit::
|
inherit
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__postgres_role myrole
|
|
||||||
|
|
||||||
__postgres_role myrole --password 'secret'
|
__postgres_role myrole
|
||||||
|
|
||||||
__postgres_role admin --password 'very-secret' --superuser
|
__postgres_role myrole --password 'secret'
|
||||||
|
|
||||||
__postgres_role dbcustomer --password 'bla' --createdb
|
__postgres_role admin --password 'very-secret' --superuser
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
__postgres_role dbcustomer --password 'bla' --createdb
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__postgres_database(7)
|
- `cdist-type__postgres_database(7) <cdist-type__postgres_database.html>`_
|
||||||
- http://www.postgresql.org/docs/current/static/sql-createrole.html
|
- http://www.postgresql.org/docs/current/static/sql-createrole.html
|
||||||
|
|
||||||
|
|
||||||
67
cdist/conf/type/__process/man.rst
Normal file
67
cdist/conf/type/__process/man.rst
Normal file
|
|
@ -0,0 +1,67 @@
|
||||||
|
cdist-type__process(7)
|
||||||
|
======================
|
||||||
|
Start or stop process
|
||||||
|
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to define the state of a process.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
name
|
||||||
|
Process name to match on when using pgrep -f -x.
|
||||||
|
|
||||||
|
This is useful, if the name starts with a "/",
|
||||||
|
because the leading slash is stripped away from
|
||||||
|
the object id by cdist.
|
||||||
|
|
||||||
|
stop
|
||||||
|
Executable to use for stopping the process.
|
||||||
|
|
||||||
|
start
|
||||||
|
Executable to use for starting the process.
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Start if not running
|
||||||
|
__process /usr/sbin/syslog-ng --state present
|
||||||
|
|
||||||
|
# Start if not running with a different binary
|
||||||
|
__process /usr/sbin/nginx --state present --start "/etc/rc.d/nginx start"
|
||||||
|
|
||||||
|
# Stop the process using kill (the type default) - DO NOT USE THIS
|
||||||
|
__process /usr/sbin/sshd --state absent
|
||||||
|
|
||||||
|
# Stop the process using /etc/rc.d/sshd stop - THIS ONE NOT AS WELL
|
||||||
|
__process /usr/sbin/sshd --state absent --stop "/etc/rc.d/sshd stop"
|
||||||
|
|
||||||
|
# Ensure cups is running, which runs with -C ...:
|
||||||
|
__process cups --start "/etc/rc.d/cups start" --state present \
|
||||||
|
--name "/usr/sbin/cupsd -C /etc/cups/cupsd.conf"
|
||||||
|
|
||||||
|
# Ensure rpc.statd is running (which usually runs with -L) using a regexp
|
||||||
|
__process rpcstatd --state present --start "/etc/init.d/statd start" \
|
||||||
|
--name "rpc.statd.*"
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__start_on_boot(7) <cdist-type__start_on_boot.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,70 +0,0 @@
|
||||||
cdist-type__process(7)
|
|
||||||
======================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__process - Start or stop process
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to define the state of a process.
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present"
|
|
||||||
|
|
||||||
name::
|
|
||||||
Process name to match on when using pgrep -f -x.
|
|
||||||
|
|
||||||
This is useful, if the name starts with a "/",
|
|
||||||
because the leading slash is stripped away from
|
|
||||||
the object id by cdist.
|
|
||||||
|
|
||||||
stop::
|
|
||||||
Executable to use for stopping the process.
|
|
||||||
|
|
||||||
start::
|
|
||||||
Executable to use for starting the process.
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Start if not running
|
|
||||||
__process /usr/sbin/syslog-ng --state present
|
|
||||||
|
|
||||||
# Start if not running with a different binary
|
|
||||||
__process /usr/sbin/nginx --state present --start "/etc/rc.d/nginx start"
|
|
||||||
|
|
||||||
# Stop the process using kill (the type default) - DO NOT USE THIS
|
|
||||||
__process /usr/sbin/sshd --state absent
|
|
||||||
|
|
||||||
# Stop the process using /etc/rc.d/sshd stop - THIS ONE NOT AS WELL
|
|
||||||
__process /usr/sbin/sshd --state absent --stop "/etc/rc.d/sshd stop"
|
|
||||||
|
|
||||||
# Ensure cups is running, which runs with -C ...:
|
|
||||||
__process cups --start "/etc/rc.d/cups start" --state present \
|
|
||||||
--name "/usr/sbin/cupsd -C /etc/cups/cupsd.conf"
|
|
||||||
|
|
||||||
# Ensure rpc.statd is running (which usually runs with -L) using a regexp
|
|
||||||
__process rpcstatd --state present --start "/etc/init.d/statd start" \
|
|
||||||
--name "rpc.statd.*"
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__start_on_boot(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
78
cdist/conf/type/__pyvenv/man.rst
Executable file
78
cdist/conf/type/__pyvenv/man.rst
Executable file
|
|
@ -0,0 +1,78 @@
|
||||||
|
cdist-type__pyvenv(7)
|
||||||
|
=====================
|
||||||
|
Create or remove python virtual environment
|
||||||
|
|
||||||
|
Darko Poljak <darko.poljak--@--gmail.com>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to create or remove python virtual
|
||||||
|
environment using pyvenv.
|
||||||
|
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:
|
||||||
|
|
||||||
|
.. code-block sh
|
||||||
|
|
||||||
|
case "$__target_host" in
|
||||||
|
localhost)
|
||||||
|
__package python3-venv --state present
|
||||||
|
require="__package/python3-venv" __pyvenv /home/darko/testenv --pyvenv "pyvenv-3.4" --owner darko --group darko --mode 740 --state present
|
||||||
|
require="__pyvenv/home/darko/testenv" __package_pip docopt --pip /home/darko/testenv/bin/pip --runas darko --state present
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
None
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
|
group
|
||||||
|
Group to chgrp to
|
||||||
|
|
||||||
|
mode
|
||||||
|
Unix permissions, suitable for chmod
|
||||||
|
|
||||||
|
owner
|
||||||
|
User to chown to
|
||||||
|
|
||||||
|
pyvenv
|
||||||
|
Use this specific pyvenv
|
||||||
|
|
||||||
|
venvparams
|
||||||
|
Specific parameters to pass to pyvenv invocation
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__pyvenv /home/services/djangoenv
|
||||||
|
|
||||||
|
# Use specific pyvenv
|
||||||
|
__pyvenv /home/foo/fooenv --pyvenv /usr/local/bin/pyvenv-3.4
|
||||||
|
|
||||||
|
# Create python virtualenv for user foo.
|
||||||
|
__pyvenv /home/foo/fooenv --group foo --user foo
|
||||||
|
|
||||||
|
# Create python virtualenv with specific parameters.
|
||||||
|
__pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages"
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2016 Darko Poljak. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
||||||
|
|
@ -1,80 +0,0 @@
|
||||||
cdist-type__pyvenv(7)
|
|
||||||
=====================
|
|
||||||
Darko Poljak <darko.poljak--@--gmail.com>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__pyvenv - Create or remove python virtual environment
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to create or remove python virtual
|
|
||||||
environment using pyvenv.
|
|
||||||
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:
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
case "$__target_host" in
|
|
||||||
localhost)
|
|
||||||
__package python3-venv --state present
|
|
||||||
require="__package/python3-venv" __pyvenv /home/darko/testenv --pyvenv "pyvenv-3.4" --owner darko --group darko --mode 740 --state present
|
|
||||||
require="__pyvenv/home/darko/testenv" __package_pip docopt --pip /home/darko/testenv/bin/pip --runas darko --state present
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
None
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present"
|
|
||||||
|
|
||||||
group::
|
|
||||||
Group to chgrp to
|
|
||||||
|
|
||||||
mode::
|
|
||||||
Unix permissions, suitable for chmod
|
|
||||||
|
|
||||||
owner::
|
|
||||||
User to chown to
|
|
||||||
|
|
||||||
pyvenv::
|
|
||||||
Use this specific pyvenv
|
|
||||||
|
|
||||||
venvparams::
|
|
||||||
Specific parameters to pass to pyvenv invocation
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
__pyvenv /home/services/djangoenv
|
|
||||||
|
|
||||||
# Use specific pyvenv
|
|
||||||
__pyvenv /home/foo/fooenv --pyvenv /usr/local/bin/pyvenv-3.4
|
|
||||||
|
|
||||||
# Create python virtualenv for user foo.
|
|
||||||
__pyvenv /home/foo/fooenv --group foo --user foo
|
|
||||||
|
|
||||||
# Create python virtualenv with specific parameters.
|
|
||||||
__pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages"
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2016 Darko Poljak. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__qemu_img(7)
|
cdist-type__qemu_img(7)
|
||||||
=======================
|
=======================
|
||||||
|
Manage VM disk images
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__qemu_img - Manage VM disk images
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
The qemu-img program is used to create qemu images for
|
The qemu-img program is used to create qemu images for
|
||||||
|
|
@ -17,9 +14,9 @@ qemu and (qemu-)kvm.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
size::
|
size
|
||||||
Size of the image in qemu-img compatible units.
|
Size of the image in qemu-img compatible units.
|
||||||
|
|
||||||
Required if state is "present".
|
Required if state is "present".
|
||||||
|
|
@ -28,18 +25,18 @@ size::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Create a 50G size image
|
|
||||||
__qemu_img /home/services/kvm/vm/myvmname/system-disk --size 50G
|
|
||||||
|
|
||||||
# Remove image
|
# Create a 50G size image
|
||||||
__qemu_img /home/services/kvm/vm/myoldvm/system-disk --state absent
|
__qemu_img /home/services/kvm/vm/myvmname/system-disk --size 50G
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove image
|
||||||
|
__qemu_img /home/services/kvm/vm/myoldvm/system-disk --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- qemu-img(1)
|
- qemu-img(1)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__rbenv(7)
|
cdist-type__rbenv(7)
|
||||||
====================
|
====================
|
||||||
|
Manage rbenv installation
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rbenv - Manage rbenv installation
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to manage rbenv installations.
|
This cdist type allows you to manage rbenv installations.
|
||||||
|
|
@ -16,31 +13,31 @@ It also installs ruby-build.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
Which user should own the rbenv installation, defaults to root
|
Which user should own the rbenv installation, defaults to root
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Install rbenv including ruby-build for nico
|
|
||||||
__rbenv /home/nico
|
|
||||||
|
|
||||||
# Install rbenv including ruby-build for nico
|
# Install rbenv including ruby-build for nico
|
||||||
__rbenv /home/nico --owner nico
|
__rbenv /home/nico
|
||||||
|
|
||||||
# Bastian does not need rbenv anymore, he began to code C99
|
# Install rbenv including ruby-build for nico
|
||||||
__rbenv /home/bastian --state absent
|
__rbenv /home/nico --owner nico
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Bastian does not need rbenv anymore, he began to code C99
|
||||||
|
__rbenv /home/bastian --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__rsync(7)
|
cdist-type__rsync(7)
|
||||||
====================
|
====================
|
||||||
|
Mirror directories using rsync
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rsync - Mirror directories using rsync
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
WARNING: This type is of BETA quality:
|
WARNING: This type is of BETA quality:
|
||||||
|
|
@ -27,30 +24,31 @@ target host.
|
||||||
A slash will be appended to the source directory so that only the contents
|
A slash will be appended to the source directory so that only the contents
|
||||||
of the directory are taken and not the directory name itself.
|
of the directory are taken and not the directory name itself.
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
Where to take files from
|
Where to take files from
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
group::
|
group
|
||||||
Group to chgrp to.
|
Group to chgrp to.
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
User to chown to.
|
User to chown to.
|
||||||
|
|
||||||
destination::
|
destination
|
||||||
Use this as the base destination instead of the object id
|
Use this as the base destination instead of the object id
|
||||||
|
|
||||||
remote-user::
|
remote-user
|
||||||
Use this user instead of the default "root" for rsync operations.
|
Use this user instead of the default "root" for rsync operations.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL MULTIPLE PARAMETERS
|
OPTIONAL MULTIPLE PARAMETERS
|
||||||
----------------------------
|
----------------------------
|
||||||
rsync-opts::
|
rsync-opts
|
||||||
Use this option to give rsync options with.
|
Use this option to give rsync options with.
|
||||||
See rsync(1) for available options.
|
See rsync(1) for available options.
|
||||||
Only "--" options are supported.
|
Only "--" options are supported.
|
||||||
|
|
@ -66,41 +64,40 @@ NONE
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# You can use any source directory
|
|
||||||
__rsync /tmp/testdir \
|
# You can use any source directory
|
||||||
|
__rsync /tmp/testdir \
|
||||||
--source /etc
|
--source /etc
|
||||||
|
|
||||||
# Use source from type
|
# Use source from type
|
||||||
__rsync /etc \
|
__rsync /etc \
|
||||||
--source "$__type/files/package"
|
--source "$__type/files/package"
|
||||||
|
|
||||||
# Allow multiple __rsync objects to write to the same dir
|
# Allow multiple __rsync objects to write to the same dir
|
||||||
__rsync mystuff \
|
__rsync mystuff \
|
||||||
--destination /usr/local/bin \
|
--destination /usr/local/bin \
|
||||||
--source "$__type/files/package"
|
--source "$__type/files/package"
|
||||||
|
|
||||||
__rsync otherstuff \
|
__rsync otherstuff \
|
||||||
--destination /usr/local/bin \
|
--destination /usr/local/bin \
|
||||||
--source "$__type/files/package2"
|
--source "$__type/files/package2"
|
||||||
|
|
||||||
# Use rsync option --exclude
|
# Use rsync option --exclude
|
||||||
__rsync /tmp/testdir \
|
__rsync /tmp/testdir \
|
||||||
--source /etc \
|
--source /etc \
|
||||||
--rsync-opts exclude=sshd_conf
|
--rsync-opts exclude=sshd_conf
|
||||||
|
|
||||||
# Use rsync with multiple options --exclude --dry-run
|
# Use rsync with multiple options --exclude --dry-run
|
||||||
__rsync /tmp/testing \
|
__rsync /tmp/testing \
|
||||||
--source /home/tester \
|
--source /home/tester \
|
||||||
--rsync-opts exclude=id_rsa \
|
--rsync-opts exclude=id_rsa \
|
||||||
--rsync-opts dry-run
|
--rsync-opts dry-run
|
||||||
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- rsync(1)
|
- rsync(1)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__rvm(7)
|
cdist-type__rvm(7)
|
||||||
==================
|
==================
|
||||||
|
Install rvm for a given user
|
||||||
|
|
||||||
Evax Software <contact@evax.fr>
|
Evax Software <contact@evax.fr>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rvm - Install rvm for a given user
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
||||||
|
|
@ -15,28 +12,28 @@ RVM is the Ruby enVironment Manager for the Ruby programming language.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present".
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Install rvm for user billie
|
|
||||||
__rvm billie --state present
|
|
||||||
|
|
||||||
# Remove rvm
|
# Install rvm for user billie
|
||||||
__rvm billie --state absent
|
__rvm billie --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Remove rvm
|
||||||
|
__rvm billie --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__rvm_ruby(7)
|
- `cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
|
||||||
- cdist-type__rvm_gemset(7)
|
- `cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_
|
||||||
- cdist-type__rvm_gem(7)
|
- `cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
54
cdist/conf/type/__rvm_gem/man.rst
Normal file
54
cdist/conf/type/__rvm_gem/man.rst
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
cdist-type__rvm_gemset(7)
|
||||||
|
==========================
|
||||||
|
Manage Ruby gems through rvm
|
||||||
|
|
||||||
|
Evax Software <contact@evax.fr>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
user
|
||||||
|
The remote user account to use
|
||||||
|
gemset
|
||||||
|
The gemset to use
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
default
|
||||||
|
Make the selected gemset the default
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install the rails gem in gemset ruby-1.9.3-p0@myset for user bill
|
||||||
|
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill --state present
|
||||||
|
|
||||||
|
# Do the same and also make ruby-1.9.3-p0@myset the default gemset
|
||||||
|
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill \
|
||||||
|
--state present --default
|
||||||
|
|
||||||
|
# Remove it
|
||||||
|
__rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state absent
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__rvm(7) <cdist-type__rvm.html>`_
|
||||||
|
- `cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
|
||||||
|
- `cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
cdist-type__rvm_gemset(7)
|
|
||||||
==========================
|
|
||||||
Evax Software <contact@evax.fr>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rvm_gem - Manage Ruby gems through rvm
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
user::
|
|
||||||
The remote user account to use
|
|
||||||
gemset::
|
|
||||||
The gemset to use
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present".
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
default::
|
|
||||||
Make the selected gemset the default
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Install the rails gem in gemset ruby-1.9.3-p0@myset for user bill
|
|
||||||
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill --state present
|
|
||||||
|
|
||||||
# Do the same and also make ruby-1.9.3-p0@myset the default gemset
|
|
||||||
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill \
|
|
||||||
--state present --default
|
|
||||||
|
|
||||||
# Remove it
|
|
||||||
__rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state absent
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__rvm(7)
|
|
||||||
- cdist-type__rvm_ruby(7)
|
|
||||||
- cdist-type__rvm_gemset(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
|
||||||
the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
52
cdist/conf/type/__rvm_gemset/man.rst
Normal file
52
cdist/conf/type/__rvm_gemset/man.rst
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
cdist-type__rvm_gemset(7)
|
||||||
|
==========================
|
||||||
|
Manage gemsets through rvm
|
||||||
|
|
||||||
|
Evax Software <contact@evax.fr>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
user
|
||||||
|
The remote user account to use
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
-------------------
|
||||||
|
default
|
||||||
|
If present, set the given gemset as default.
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install the gemset @myset for user charles on based on ruby-1.9.3-0
|
||||||
|
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present
|
||||||
|
|
||||||
|
# Do the same and make ruby-1.9.3-p0@myset the default gemset
|
||||||
|
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present --default
|
||||||
|
|
||||||
|
# Remove the gemset @myset for user john
|
||||||
|
__rvm_ruby ruby-1.9.3-p0@myset --user john --state absent
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__rvm(7) <cdist-type__rvm.html>`_
|
||||||
|
- `cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
|
||||||
|
- `cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
cdist-type__rvm_gemset(7)
|
|
||||||
==========================
|
|
||||||
Evax Software <contact@evax.fr>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rvm_gemset - Manage gemsets through rvm
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
user::
|
|
||||||
The remote user account to use
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present".
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
|
||||||
-------------------
|
|
||||||
default::
|
|
||||||
If present, set the given gemset as default.
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Install the gemset @myset for user charles on based on ruby-1.9.3-0
|
|
||||||
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present
|
|
||||||
|
|
||||||
# Do the same and make ruby-1.9.3-p0@myset the default gemset
|
|
||||||
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present --default
|
|
||||||
|
|
||||||
# Remove the gemset @myset for user john
|
|
||||||
__rvm_ruby ruby-1.9.3-p0@myset --user john --state absent
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__rvm(7)
|
|
||||||
- cdist-type__rvm_ruby(7)
|
|
||||||
- cdist-type__rvm_gem(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
|
||||||
the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
53
cdist/conf/type/__rvm_ruby/man.rst
Normal file
53
cdist/conf/type/__rvm_ruby/man.rst
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
cdist-type__rvm_ruby(7)
|
||||||
|
=======================
|
||||||
|
Manage ruby installations through rvm
|
||||||
|
|
||||||
|
Evax Software <contact@evax.fr>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
user
|
||||||
|
The remote user account to use
|
||||||
|
state
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
|
||||||
|
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
------------------
|
||||||
|
default
|
||||||
|
Set the given version as default
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# Install ruby 1.9.3 through rvm for user thelonious
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user thelonious --state present
|
||||||
|
|
||||||
|
# Install ruby 1.9.3 through rvm for user ornette and make it the default
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user ornette --state present --default
|
||||||
|
|
||||||
|
# Remove ruby 1.9.3 for user john
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user john --state absent
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
- `cdist-type__rvm(7) <cdist-type__rvm.html>`_
|
||||||
|
- `cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_
|
||||||
|
- `cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
cdist-type__rvm_ruby(7)
|
|
||||||
=======================
|
|
||||||
Evax Software <contact@evax.fr>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__rvm_ruby - Manage ruby installations through rvm
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
RVM is the Ruby enVironment Manager for the Ruby programming language.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
user::
|
|
||||||
The remote user account to use
|
|
||||||
state::
|
|
||||||
Either "present" or "absent", defaults to "present".
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
|
||||||
------------------
|
|
||||||
default:
|
|
||||||
Set the given version as default
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# Install ruby 1.9.3 through rvm for user thelonious
|
|
||||||
__rvm_ruby ruby-1.9.3-p0 --user thelonious --state present
|
|
||||||
|
|
||||||
# Install ruby 1.9.3 through rvm for user ornette and make it the default
|
|
||||||
__rvm_ruby ruby-1.9.3-p0 --user ornette --state present --default
|
|
||||||
|
|
||||||
# Remove ruby 1.9.3 for user john
|
|
||||||
__rvm_ruby ruby-1.9.3-p0 --user john --state absent
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- cdist-type__rvm(7)
|
|
||||||
- cdist-type__rvm_gemset(7)
|
|
||||||
- cdist-type__rvm_gem(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2012 Evax Software. Free use of this software is granted under
|
|
||||||
the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__ssh_authorized_key(7)
|
cdist-type__ssh_authorized_key(7)
|
||||||
=================================
|
=================================
|
||||||
|
Manage a single ssh authorized key entry
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__ssh_authorized_key - manage a single ssh authorized key entry
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Manage a single authorized key entry in an authorized_key file.
|
Manage a single authorized key entry in an authorized_key file.
|
||||||
|
|
@ -16,49 +13,49 @@ This type was created to be used by the __ssh_authorized_keys type.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
file::
|
file
|
||||||
the authorized_keys file to which the given key should be added
|
the authorized_keys file to which the given key should be added
|
||||||
|
|
||||||
key::
|
key
|
||||||
a string containing the ssh keytype, base 64 encoded key and optional
|
a string containing the ssh keytype, base 64 encoded key and optional
|
||||||
trailing comment which shall be added to the given authorized_keys file.
|
trailing comment which shall be added to the given authorized_keys file.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
comment::
|
comment
|
||||||
explicit comment instead of the one which may be trailing the given key
|
explicit comment instead of the one which may be trailing the given key
|
||||||
|
|
||||||
option::
|
option
|
||||||
an option to set for this authorized_key entry.
|
an option to set for this authorized_key entry.
|
||||||
Can be specified multiple times.
|
Can be specified multiple times.
|
||||||
See sshd(8) for available options.
|
See sshd(8) for available options.
|
||||||
|
|
||||||
state::
|
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'.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__ssh_authorized_key some-id \
|
|
||||||
|
__ssh_authorized_key some-id \
|
||||||
--file "/home/user/.ssh/autorized_keys" \
|
--file "/home/user/.ssh/autorized_keys" \
|
||||||
--key "$(cat ~/.ssh/id_rsa.pub)"
|
--key "$(cat ~/.ssh/id_rsa.pub)"
|
||||||
|
|
||||||
__ssh_authorized_key some-id \
|
__ssh_authorized_key some-id \
|
||||||
--file "/home/user/.ssh/autorized_keys" \
|
--file "/home/user/.ssh/autorized_keys" \
|
||||||
--key "$(cat ~/.ssh/id_rsa.pub)" \
|
--key "$(cat ~/.ssh/id_rsa.pub)" \
|
||||||
--option 'command="/path/to/script"' \
|
--option 'command="/path/to/script"' \
|
||||||
--option 'environment="FOO=bar"' \
|
--option 'environment="FOO=bar"' \
|
||||||
--comment 'one to rule them all'
|
--comment 'one to rule them all'
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist__ssh_authorized_keys(7)
|
- `cdist__ssh_authorized_keys(7) <cdist__ssh_authorized_keys.html>`_
|
||||||
- sshd(8)
|
- sshd(8)
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__ssh_authorized_keys(7)
|
cdist-type__ssh_authorized_keys(7)
|
||||||
==================================
|
==================================
|
||||||
|
Manage ssh authorized_keys files
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__ssh_authorized_keys - manage ssh authorized_keys files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Adds or removes ssh keys from a authorized_keys file.
|
Adds or removes ssh keys from a authorized_keys file.
|
||||||
|
|
@ -24,38 +21,38 @@ permissions work with ssh.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
key::
|
key
|
||||||
the ssh key which shall be added to this authorized_keys file.
|
the ssh key which shall be added to this authorized_keys file.
|
||||||
Must be a string and can be specified multiple times.
|
Must be a string and can be specified multiple times.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
comment::
|
comment
|
||||||
explicit comment instead of the one which may be trailing the given key
|
explicit comment instead of the one which may be trailing the given key
|
||||||
|
|
||||||
file::
|
file
|
||||||
an alternative destination file, defaults to ~$owner/.ssh/authorized_keys
|
an alternative destination file, defaults to ~$owner/.ssh/authorized_keys
|
||||||
|
|
||||||
option::
|
option
|
||||||
an option to set for all created authorized_key entries.
|
an option to set for all created authorized_key entries.
|
||||||
Can be specified multiple times.
|
Can be specified multiple times.
|
||||||
See sshd(8) for available options.
|
See sshd(8) for available options.
|
||||||
|
|
||||||
owner::
|
owner
|
||||||
the user owning the authorized_keys file, defaults to object_id.
|
the user owning the authorized_keys file, defaults to object_id.
|
||||||
|
|
||||||
state::
|
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
|
BOOLEAN PARAMETERS
|
||||||
------------------
|
------------------
|
||||||
noparent::
|
noparent
|
||||||
don't create or change ownership and permissions of the directory containing
|
don't create or change ownership and permissions of the directory containing
|
||||||
the authorized_keys file
|
the authorized_keys file
|
||||||
|
|
||||||
nofile::
|
nofile
|
||||||
don't manage existence, ownership and permissions of the the authorized_keys
|
don't manage existence, ownership and permissions of the the authorized_keys
|
||||||
file
|
file
|
||||||
|
|
||||||
|
|
@ -63,25 +60,26 @@ nofile::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# add your ssh key to remote root's authorized_keys file
|
|
||||||
__ssh_authorized_keys root \
|
# add your ssh key to remote root's authorized_keys file
|
||||||
|
__ssh_authorized_keys root \
|
||||||
--key "$(cat ~/.ssh/id_rsa.pub)"
|
--key "$(cat ~/.ssh/id_rsa.pub)"
|
||||||
|
|
||||||
# allow key to login as user-name
|
# allow key to login as user-name
|
||||||
__ssh_authorized_keys user-name \
|
__ssh_authorized_keys user-name \
|
||||||
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
||||||
|
|
||||||
# allow key to login as user-name with options and expicit comment
|
# allow key to login as user-name with options and expicit comment
|
||||||
__ssh_authorized_keys user-name \
|
__ssh_authorized_keys user-name \
|
||||||
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
||||||
--option no-agent-forwarding \
|
--option no-agent-forwarding \
|
||||||
--option 'from="*.example.com"' \
|
--option 'from="*.example.com"' \
|
||||||
--comment 'backup server'
|
--comment 'backup server'
|
||||||
|
|
||||||
# same as above, but with explicit owner and two keys
|
# same as above, but with explicit owner and two keys
|
||||||
# note that the options are set for all given keys
|
# note that the options are set for all given keys
|
||||||
__ssh_authorized_keys some-fancy-id \
|
__ssh_authorized_keys some-fancy-id \
|
||||||
--owner user-name \
|
--owner user-name \
|
||||||
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
||||||
--key "ssh-rsa AZXYAAB3NzaC1yc2..." \
|
--key "ssh-rsa AZXYAAB3NzaC1yc2..." \
|
||||||
|
|
@ -89,25 +87,24 @@ __ssh_authorized_keys some-fancy-id \
|
||||||
--option 'from="*.example.com"' \
|
--option 'from="*.example.com"' \
|
||||||
--comment 'backup server'
|
--comment 'backup server'
|
||||||
|
|
||||||
# authorized_keys file in non standard location
|
# authorized_keys file in non standard location
|
||||||
__ssh_authorized_keys some-fancy-id \
|
__ssh_authorized_keys some-fancy-id \
|
||||||
--file /etc/ssh/keys/user-name/authorized_keys \
|
--file /etc/ssh/keys/user-name/authorized_keys \
|
||||||
--owner user-name \
|
--owner user-name \
|
||||||
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
||||||
|
|
||||||
# same as above, but directory and authorized_keys file is created elswhere
|
# same as above, but directory and authorized_keys file is created elswhere
|
||||||
__ssh_authorized_keys some-fancy-id \
|
__ssh_authorized_keys some-fancy-id \
|
||||||
--file /etc/ssh/keys/user-name/authorized_keys \
|
--file /etc/ssh/keys/user-name/authorized_keys \
|
||||||
--owner user-name \
|
--owner user-name \
|
||||||
--noparent \
|
--noparent \
|
||||||
--nofile \
|
--nofile \
|
||||||
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- sshd(8)
|
- sshd(8)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,11 +1,12 @@
|
||||||
cdist-type__ssh_dot_ssh(7)
|
cdist-type__ssh_dot_ssh(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage .ssh directory
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
cdist-type__ssh_dot_ssh - Manage .ssh directory
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
|
|
@ -14,28 +15,29 @@ Adds or removes .ssh directory to a user home.
|
||||||
|
|
||||||
This type is being used by __ssh_authorized_keys.
|
This type is being used by __ssh_authorized_keys.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
if the directory should be 'present' or 'absent', defaults to 'present'.
|
if the directory should be 'present' or 'absent', defaults to 'present'.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure root has ~/.ssh with the right permissions
|
|
||||||
__ssh_dot_ssh root
|
|
||||||
|
|
||||||
# Nico does not need ~/.ssh anymore
|
# Ensure root has ~/.ssh with the right permissions
|
||||||
__ssh_dot_ssh nico --state absent
|
__ssh_dot_ssh root
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Nico does not need ~/.ssh anymore
|
||||||
|
__ssh_dot_ssh nico --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__ssh_authorized_keys(7)
|
- `cdist-type__ssh_authorized_keys(7) <cdist-type__ssh_authorized_keys.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__staged_file(7)
|
cdist-type__staged_file(7)
|
||||||
==========================
|
==========================
|
||||||
|
Manage staged files
|
||||||
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__staged_file - manage staged files
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Manages a staged file that is downloaded on the server (the machine running
|
Manages a staged file that is downloaded on the server (the machine running
|
||||||
|
|
@ -16,17 +13,21 @@ cdist) and then deployed to the target host using the __file type.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
source::
|
source
|
||||||
the URL from which to retreive the source file.
|
the URL from which to retreive the source file.
|
||||||
e.g.
|
e.g.
|
||||||
https://dl.bintray.com/mitchellh/consul/0.4.1_linux_amd64.zip
|
|
||||||
file:///path/to/local/file
|
* https://dl.bintray.com/mitchellh/consul/0.4.1_linux_amd64.zip
|
||||||
cksum::
|
* file:///path/to/local/file
|
||||||
|
|
||||||
|
cksum
|
||||||
the output of running the command: `cksum $source-file`
|
the output of running the command: `cksum $source-file`
|
||||||
e.g.
|
e.g.::
|
||||||
|
|
||||||
$ echo foobar > /tmp/foobar
|
$ echo foobar > /tmp/foobar
|
||||||
$ cksum /tmp/foobar
|
$ cksum /tmp/foobar
|
||||||
857691210 7 /tmp/foobar
|
857691210 7 /tmp/foobar
|
||||||
|
|
||||||
If either checksum or file size has changed the file will be
|
If either checksum or file size has changed the file will be
|
||||||
(re)fetched from the --source. The file name can be omitted and is
|
(re)fetched from the --source. The file name can be omitted and is
|
||||||
ignored if given.
|
ignored if given.
|
||||||
|
|
@ -34,19 +35,23 @@ cksum::
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
fetch-command::
|
fetch-command
|
||||||
the command used to fetch the staged file using printf formatting.
|
the command used to fetch the staged file using printf formatting.
|
||||||
Where a single %s will be replaced with the value of the given --source
|
Where a single %s will be replaced with the value of the given --source
|
||||||
parameter. The --fetch-command is expected to output the fetched file to
|
parameter. The --fetch-command is expected to output the fetched file to
|
||||||
stdout.
|
stdout.
|
||||||
Defaults to 'curl -s -L "%s"'.
|
Defaults to 'curl -s -L "%s"'.
|
||||||
group::
|
|
||||||
|
group
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
owner::
|
|
||||||
|
owner
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
mode::
|
|
||||||
|
mode
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
prepare-command::
|
|
||||||
|
prepare-command
|
||||||
the optional command used to prepare or preprocess the staged file for later
|
the optional command used to prepare or preprocess the staged file for later
|
||||||
use by the file type.
|
use by the file type.
|
||||||
If given, it must be a string in printf formatting where a single %s will
|
If given, it must be a string in printf formatting where a single %s will
|
||||||
|
|
@ -59,18 +64,20 @@ prepare-command::
|
||||||
--prepare-command of 'unzip -p "%s"', the code `unzip -p "my-zip.zip"` will
|
--prepare-command of 'unzip -p "%s"', the code `unzip -p "my-zip.zip"` will
|
||||||
be executed in the folder containing the downloaded file my-zip.zip.
|
be executed in the folder containing the downloaded file my-zip.zip.
|
||||||
A more complex example might be --prepare-command 'tar -xz "%s"; cat path/from/archive'
|
A more complex example might be --prepare-command 'tar -xz "%s"; cat path/from/archive'
|
||||||
stage-dir::
|
stage-dir
|
||||||
the directory in which to store downloaded and prepared files.
|
the directory in which to store downloaded and prepared files.
|
||||||
Defaults to '/var/tmp/cdist/__staged_file'
|
Defaults to '/var/tmp/cdist/__staged_file'
|
||||||
state::
|
|
||||||
|
state
|
||||||
see cdist-type__file
|
see cdist-type__file
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__staged_file /usr/local/bin/consul \
|
|
||||||
|
__staged_file /usr/local/bin/consul \
|
||||||
--source file:///path/to/local/copy/consul \
|
--source file:///path/to/local/copy/consul \
|
||||||
--cksum '428915666 15738724' \
|
--cksum '428915666 15738724' \
|
||||||
--state present \
|
--state present \
|
||||||
|
|
@ -78,7 +85,7 @@ __staged_file /usr/local/bin/consul \
|
||||||
--owner root \
|
--owner root \
|
||||||
--mode 755
|
--mode 755
|
||||||
|
|
||||||
__staged_file /usr/local/bin/consul \
|
__staged_file /usr/local/bin/consul \
|
||||||
--source https://dl.bintray.com/mitchellh/consul/0.4.1_linux_amd64.zip \
|
--source https://dl.bintray.com/mitchellh/consul/0.4.1_linux_amd64.zip \
|
||||||
--cksum '428915666 15738724' \
|
--cksum '428915666 15738724' \
|
||||||
--fetch-command 'curl -s -L "%s"' \
|
--fetch-command 'curl -s -L "%s"' \
|
||||||
|
|
@ -88,13 +95,11 @@ __staged_file /usr/local/bin/consul \
|
||||||
--owner root \
|
--owner root \
|
||||||
--mode 755
|
--mode 755
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__file(7)
|
- `cdist-type__file(7) <cdist-type__file.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,53 +1,51 @@
|
||||||
cdist-type__start_on_boot(7)
|
cdist-type__start_on_boot(7)
|
||||||
============================
|
============================
|
||||||
|
Manage stuff to be started at boot
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__start_on_boot - Manage stuff to be started at boot
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This cdist type allows you to enable or disable stuff to be started
|
This cdist type allows you to enable or disable stuff to be started
|
||||||
at boot of your operating system.
|
at boot of your operating system.
|
||||||
|
|
||||||
Warning: This type has not been tested intensively and is not fully
|
Warning: This type has not been tested intensively and is not fully
|
||||||
supported (i.e. *bsd are not implemented).
|
supported (i.e. \*BSD are not implemented).
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state::
|
state
|
||||||
Either "present" or "absent", defaults to "present"
|
Either "present" or "absent", defaults to "present"
|
||||||
target_runlevel::
|
target_runlevel
|
||||||
Runlevel which should be modified, defaults to "default" (only used on gentoo systems).
|
Runlevel which should be modified, defaults to "default" (only used on gentoo systems).
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Ensure snmpd is started at boot
|
|
||||||
__start_on_boot snmpd
|
|
||||||
|
|
||||||
# Same, but more explicit
|
# Ensure snmpd is started at boot
|
||||||
__start_on_boot snmpd --state present
|
__start_on_boot snmpd
|
||||||
|
|
||||||
# Ensure legacy configuration management will not be started
|
# Same, but more explicit
|
||||||
__start_on_boot puppet --state absent
|
__start_on_boot snmpd --state present
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
# Ensure legacy configuration management will not be started
|
||||||
|
__start_on_boot puppet --state absent
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__process(7)
|
- `cdist-type__process(7) <cdist-type__process.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__timezone(7)
|
cdist-type__timezone(7)
|
||||||
=======================
|
=======================
|
||||||
|
Allows one to configure the desired localtime timezone.
|
||||||
|
|
||||||
Ramon Salvadó <rsalvado--@--gnuine--dot--com>
|
Ramon Salvadó <rsalvado--@--gnuine--dot--com>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__timezone - Allows one to configure the desired localtime timezone.
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This type creates a symlink (/etc/localtime) to the selected timezone
|
This type creates a symlink (/etc/localtime) to the selected timezone
|
||||||
|
|
@ -27,18 +24,18 @@ None.
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
#Set up Europe/Andorra as our timezone.
|
|
||||||
__timezone Europe/Andorra
|
|
||||||
|
|
||||||
#Set up US/Central as our timezone.
|
#Set up Europe/Andorra as our timezone.
|
||||||
__timezone US/Central
|
__timezone Europe/Andorra
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
#Set up US/Central as our timezone.
|
||||||
|
__timezone US/Central
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
|
|
@ -1,13 +1,10 @@
|
||||||
cdist-type__update_alternatives(7)
|
cdist-type__update_alternatives(7)
|
||||||
==================================
|
==================================
|
||||||
|
Configure alternatives
|
||||||
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__update_alternatives - Configure alternatives
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
On Debian and alike systems update-alternatives(1) can be used
|
On Debian and alike systems update-alternatives(1) can be used
|
||||||
|
|
@ -17,23 +14,23 @@ One of the most common used targets is the "editor".
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
path::
|
path
|
||||||
Use this path for the given alternative
|
Use this path for the given alternative
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
# Setup vim as the default editor
|
|
||||||
__update_alternatives editor --path /usr/bin/vim.basic
|
# Setup vim as the default editor
|
||||||
--------------------------------------------------------------------------------
|
__update_alternatives editor --path /usr/bin/vim.basic
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
- `cdist-type(7) <cdist-type.html>`_
|
||||||
- cdist-type__debconf_set_selections(7)
|
- `cdist-type__debconf_set_selections(7) <cdist-type__debconf_set_selections.html>`_
|
||||||
- update-alternatives(8)
|
- update-alternatives(8)
|
||||||
|
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue