diff --git a/.gitignore b/.gitignore index 2a193c2a..6152451b 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,7 @@ docs/man/man*/*.html docs/man/man*/*.xml docs/man/man*/docbook-xsl.css docs/man/man7/cdist-type__*.rst -docs/man/man7/cdist-reference.rst +docs/man/cdist-reference.rst # Ignore cdist cache for version control /cache/ diff --git a/Makefile b/Makefile index faa8e9d5..9f3535fd 100644 --- a/Makefile +++ b/Makefile @@ -63,10 +63,10 @@ $(MANREF): $(MANREFSH) $(MANREFSH) # Manpages #3: generic part -mansphinxman: $(MANTYPES) $(MANREF) +mansphinxman: $(MANTYPES) $(MANREF) $(PYTHON_VERSION) $(SPHINXM) -mansphinxhtml: $(MANTYPES) $(MANREF) +mansphinxhtml: $(MANTYPES) $(MANREF) $(PYTHON_VERSION) $(SPHINXH) man: mansphinxman mansphinxhtml diff --git a/bin/build-helper.freebsd b/bin/build-helper.freebsd new file mode 100755 index 00000000..01d86a10 --- /dev/null +++ b/bin/build-helper.freebsd @@ -0,0 +1,336 @@ +#!/bin/sh +# +# 2011-2013 Nico Schottelius (nico-cdist at schottelius.org) +# 2016 Darko Poljak (darko.poljak at gmail.com) +# +# This file is part of cdist. +# +# cdist is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# cdist is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with cdist. If not, see . +# +# +# This file contains the heavy lifting found usually in the Makefile +# + +# vars for make +helper=$0 + +basedir=${0%/*}/../ +# run_as is used to check how the script is called (by $0 value) +# currently supported sufixes for $0 are: +# .freebsd - run as freebsd +basename=${0##*/} +run_as=${basename#*.} +case "$run_as" in + freebsd) + to_a=cdist-configuration-management + to_d=googlegroups.com + from_a=darko.poljak + from_d=gmail.com + ml_name="Darko Poljak" + ml_sig_name="Darko" + + # vars for make + WEBDIR=../vcs/www.nico.schottelius.org + ;; + *) + to_a=cdist + to_d=l.schottelius.org + from_a=nico-cdist + from_d=schottelius.org + ml_name="Nico -telmich- Schottelius" + ml_sig_name="Nico" + + # vars for make + WEBDIR=$$HOME/vcs/www.nico.schottelius.org + ;; +esac + +# Change to checkout directory +cd "$basedir" + +version=$(git describe) + +option=$1; shift + +case "$option" in + print-make-vars) + printf "helper: ${helper}\n" + printf "WEBDIR: ${WEBDIR}\n" + ;; + print-runas) + printf "run_as: $run_as\n" + ;; + changelog-changes) + if [ "$#" -eq 1 ]; then + start=$1 + else + start="[[:digit:]]" + fi + + end="[[:digit:]]" + + awk -F: "BEGIN { start=0 } + { + if(start == 0) { + if (\$0 ~ /^$start/) { + start = 1 + } + } else { + if (\$0 ~ /^$end/) { + exit + } else { + print \$0 + } + } + }" "$basedir/docs/changelog" + ;; + + changelog-version) + # get version from changelog + grep '^[[:digit:]]' "$basedir/docs/changelog" | head -n1 | sed 's/:.*//' + ;; + + check-date) + # verify date in changelog is today + date_today="$(date +%Y-%m-%d)" + date_changelog=$(grep '^[[:digit:]]' "$basedir/docs/changelog" | head -n1 | sed 's/.*: //') + + if [ "$date_today" != "$date_changelog" ]; then + echo "Date in changelog is not today" + echo "Changelog: $date_changelog" + exit 1 + fi + ;; + + check-unittest) + "$0" test + ;; + + blog) + version=$1; shift + blogfile=$1; shift + dir=${blogfile%/*} + file=${blogfile##*/} + + + cat << eof > "$blogfile" +[[!meta title="Cdist $version released"]] + +Here's a short overview about the changes found in version ${version}: + +eof + + $0 changelog-changes "$version" >> "$blogfile" + + cat << eof >> "$blogfile" +For more information visit the [[cdist homepage|software/cdist]]. + +[[!tag cdist config unix]] +eof + cd "$dir" + git add "$file" + # Allow git commit to fail if there are no changes + git commit -m "cdist blog update: $version" "$blogfile" || true + ;; + + ml-release) + if [ $# -ne 1 ]; then + echo "$0 ml-release version" >&2 + exit 1 + fi + + version=$1; shift + + to=${to_a}@${to_d} + from=${from_a}@${from_d} + + ( + cat << eof +From: ${ml_name} <$from> +To: cdist mailing list <$to> +Subject: cdist $version released + +Hello .*, + +cdist $version has been released with the following changes: + +eof + + "$0" changelog-changes "$version" + cat << eof + +Cheers, + +${ml_sig_name} + +-- +Automatisation at its best level. With cdist. +eof + ) | /usr/sbin/sendmail -f "$from" "$to" + ;; + + release-git-tag) + target_version=$($0 changelog-version) + if git rev-parse --verify refs/tags/$target_version 2>/dev/null; then + echo "Tag for $target_version exists, aborting" + exit 1 + fi + printf "Enter tag description for ${target_version}: " + read tagmessage + git tag "$target_version" -m "$$tagmessage" + ;; + + release) + set -e + target_version=$($0 changelog-version) + target_branch=$($0 version-branch) + + echo "Beginning release process for $target_version" + + # First check everything is sane + "$0" check-date + "$0" check-unittest + + # Generate version file to be included in packaging + "$0" version + + # Ensure the git status is clean, else abort + if ! git diff-index --name-only --exit-code HEAD ; then + echo "Unclean tree, see files above, aborting" + exit 1 + fi + + # Ensure we are on the master branch + masterbranch=yes + if [ "$(git rev-parse --abbrev-ref HEAD)" != "master" ]; then + echo "Releases are happening from the master branch, aborting" + + echo "Enter the magic word to release anyway" + read magicword + + if [ "$magicword" = "iknowwhatido" ]; then + masterbranch=no + else + exit 1 + fi + fi + + if [ "$masterbranch" = yes ]; then + # Ensure version branch exists + if ! git rev-parse --verify refs/heads/$target_branch 2>/dev/null; then + git branch "$target_branch" + fi + + # Merge master branch into version branch + git checkout "$target_branch" + git merge master + fi + + # Verify that after the merge everything works + "$0" check-date + "$0" check-unittest + + # Generate man pages (indirect check if they build) + make helper=${helper} WEBDIR=${WEBDIR} man + + # Generate speeches (indirect check if they build) + make helper=${helper} WEBDIR=${WEBDIR} speeches + + ############################################################# + # Everything green, let's do the release + + # Tag the current commit + "$0" release-git-tag + + # Also merge back the version branch + if [ "$masterbranch" = yes ]; then + git checkout master + git merge "$target_branch" + fi + + # Publish git changes + make helper=${helper} WEBDIR=${WEBDIR} pub + + # publish man, speeches, website + if [ "$masterbranch" = yes ]; then + make helper=${helper} WEBDIR=${WEBDIR} web-release-all + else + make helper=${helper} WEBDIR=${WEBDIR} web-release-all-no-latest + fi + + # Ensure that pypi release has the right version + "$0" version + + # Create and publish package for pypi + make helper=${helper} WEBDIR=${WEBDIR} pypi-release + + case "$run_as" in + freebsd) + ;; + *) + # Archlinux release is based on pypi + make archlinux-release + ;; + esac + + # Announce change on ML + make helper=${helper} WEBDIR=${WEBDIR} ml-release + + cat << eof +Manual steps post release: + + - linkedin + - hackernews + - reddit + - twitter + +eof + + case "$run_as" in + freebsd) + cat < cdist/version.py + ;; + + *) + echo "Unknown helper target $@ - aborting" + exit 1 + ;; + +esac diff --git a/cdist/conf/type/__apt_key/man.rst b/cdist/conf/type/__apt_key/man.rst index cb4c4108..01d4eea4 100644 --- a/cdist/conf/type/__apt_key/man.rst +++ b/cdist/conf/type/__apt_key/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_key - Manage the list of keys used by apt -Steven Armstrong - DESCRIPTION ----------- @@ -52,7 +50,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__apt_key_uri/man.rst b/cdist/conf/type/__apt_key_uri/man.rst index ee8d1601..9c0042bb 100644 --- a/cdist/conf/type/__apt_key_uri/man.rst +++ b/cdist/conf/type/__apt_key_uri/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_key_uri - Add apt key from uri -Steven Armstrong - DESCRIPTION ----------- @@ -42,7 +40,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__apt_norecommends/man.rst b/cdist/conf/type/__apt_norecommends/man.rst index 09ea9d16..0198d7bd 100644 --- a/cdist/conf/type/__apt_norecommends/man.rst +++ b/cdist/conf/type/__apt_norecommends/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_norecommends - Configure apt to not install recommended packages -Steven Armstrong - DESCRIPTION ----------- @@ -33,7 +31,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__apt_ppa/man.rst b/cdist/conf/type/__apt_ppa/man.rst index 922b18d5..e91e82fe 100644 --- a/cdist/conf/type/__apt_ppa/man.rst +++ b/cdist/conf/type/__apt_ppa/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_ppa - Manage ppa repositories -Steven Armstrong - DESCRIPTION ----------- @@ -41,7 +39,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__apt_source/man.rst b/cdist/conf/type/__apt_source/man.rst index 2e09aee5..e4916515 100644 --- a/cdist/conf/type/__apt_source/man.rst +++ b/cdist/conf/type/__apt_source/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_source - Manage apt sources -Steven Armstrong - DESCRIPTION ----------- @@ -60,7 +58,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__apt_update_index/man.rst b/cdist/conf/type/__apt_update_index/man.rst index ce8610f3..e0672620 100644 --- a/cdist/conf/type/__apt_update_index/man.rst +++ b/cdist/conf/type/__apt_update_index/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__apt_update_index - Update apt's package index -Steven Armstrong - DESCRIPTION ----------- @@ -32,7 +30,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__block/man.rst b/cdist/conf/type/__block/man.rst index bd5304d8..3b7c3439 100644 --- a/cdist/conf/type/__block/man.rst +++ b/cdist/conf/type/__block/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__block - Manage blocks of text in files -Steven Armstrong - DESCRIPTION ----------- @@ -73,7 +71,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__ccollect_source/man.rst b/cdist/conf/type/__ccollect_source/man.rst index 29baa5c4..5d980bda 100644 --- a/cdist/conf/type/__ccollect_source/man.rst +++ b/cdist/conf/type/__ccollect_source/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__ccollect_source - Manage ccollect sources -Nico Schottelius - DESCRIPTION ----------- @@ -55,9 +53,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- ccollect(1) -- http://www.nico.schottelius.org/software/ccollect/ +ccollect(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +ccollect documentation at: +. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__cdist/man.rst b/cdist/conf/type/__cdist/man.rst index c0e8365e..ad544c5c 100644 --- a/cdist/conf/type/__cdist/man.rst +++ b/cdist/conf/type/__cdist/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__cdist - Manage cdist installations -Nico Schottelius - DESCRIPTION ----------- @@ -54,7 +52,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__cdistmarker/man.rst b/cdist/conf/type/__cdistmarker/man.rst index efd696ef..156aed62 100644 --- a/cdist/conf/type/__cdistmarker/man.rst +++ b/cdist/conf/type/__cdistmarker/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__cdistmarker - Add a timestamped cdist marker. -Daniel Maher - DESCRIPTION ----------- @@ -46,7 +44,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Daniel Maher COPYING diff --git a/cdist/conf/type/__config_file/man.rst b/cdist/conf/type/__config_file/man.rst index 8eec81b0..acb3c848 100644 --- a/cdist/conf/type/__config_file/man.rst +++ b/cdist/conf/type/__config_file/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__config_file - _Manages config files -Steven Armstrong - DESCRIPTION ----------- @@ -50,8 +48,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__file(7) `_ +`cdist-type__file(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul/man.rst b/cdist/conf/type/__consul/man.rst index e6a9d2d7..4096a233 100644 --- a/cdist/conf/type/__consul/man.rst +++ b/cdist/conf/type/__consul/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul - Install consul -Steven Armstrong - DESCRIPTION ----------- @@ -45,7 +43,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_agent/man.rst b/cdist/conf/type/__consul_agent/man.rst index 25ad4d5b..7a15a058 100644 --- a/cdist/conf/type/__consul_agent/man.rst +++ b/cdist/conf/type/__consul_agent/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_agent - Manage the consul agent -Steven Armstrong - DESCRIPTION ----------- @@ -167,8 +165,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- http://www.consul.io/docs/agent/options.html +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_check/man.rst b/cdist/conf/type/__consul_check/man.rst index f04645fd..87e2d7a9 100644 --- a/cdist/conf/type/__consul_check/man.rst +++ b/cdist/conf/type/__consul_check/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_check - Manages consul checks -Steven Armstrong - DESCRIPTION ----------- @@ -64,8 +62,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_reload/man.rst b/cdist/conf/type/__consul_reload/man.rst index 38618aba..62b08c7f 100644 --- a/cdist/conf/type/__consul_reload/man.rst +++ b/cdist/conf/type/__consul_reload/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_reload - Reload consul -Steven Armstrong - DESCRIPTION ----------- @@ -33,7 +31,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_service/man.rst b/cdist/conf/type/__consul_service/man.rst index f7d34f4a..560266a4 100644 --- a/cdist/conf/type/__consul_service/man.rst +++ b/cdist/conf/type/__consul_service/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_service - Manages consul services -Steven Armstrong - DESCRIPTION ----------- @@ -68,8 +66,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_template/man.rst b/cdist/conf/type/__consul_template/man.rst index 8e01ee04..d2d484e5 100644 --- a/cdist/conf/type/__consul_template/man.rst +++ b/cdist/conf/type/__consul_template/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_template - Manage the consul-template service -Steven Armstrong - DESCRIPTION ----------- @@ -127,8 +125,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- https://github.com/hashicorp/consul-template +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_template_template/man.rst b/cdist/conf/type/__consul_template_template/man.rst index 30832bc8..9932346b 100644 --- a/cdist/conf/type/__consul_template_template/man.rst +++ b/cdist/conf/type/__consul_template_template/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_template_template - Manage consul-template templates -Steven Armstrong - DESCRIPTION ----------- @@ -61,9 +59,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_template(7) `_ -- `cdist-type__consul_template_config(7) `_ +`cdist-type__consul_template(7) `_, +`cdist-type__consul_template_config(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_checks/man.rst b/cdist/conf/type/__consul_watch_checks/man.rst index cfb451d6..dc3c9669 100644 --- a/cdist/conf/type/__consul_watch_checks/man.rst +++ b/cdist/conf/type/__consul_watch_checks/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_checks - Manages consul checks watches -Steven Armstrong - DESCRIPTION ----------- @@ -57,9 +55,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_event/man.rst b/cdist/conf/type/__consul_watch_event/man.rst index 871c0704..73b16754 100644 --- a/cdist/conf/type/__consul_watch_event/man.rst +++ b/cdist/conf/type/__consul_watch_event/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_event - Manages consul event watches -Steven Armstrong - DESCRIPTION ----------- @@ -50,9 +48,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_key/man.rst b/cdist/conf/type/__consul_watch_key/man.rst index d7554df2..c258119c 100644 --- a/cdist/conf/type/__consul_watch_key/man.rst +++ b/cdist/conf/type/__consul_watch_key/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_key - Manages consul key watches -Steven Armstrong - DESCRIPTION ----------- @@ -47,9 +45,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_keyprefix/man.rst b/cdist/conf/type/__consul_watch_keyprefix/man.rst index 42f675a4..950c0a26 100644 --- a/cdist/conf/type/__consul_watch_keyprefix/man.rst +++ b/cdist/conf/type/__consul_watch_keyprefix/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_keyprefix - Manages consul keyprefix watches -Steven Armstrong - DESCRIPTION ----------- @@ -47,9 +45,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consule documentation at: . + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_nodes/man.rst b/cdist/conf/type/__consul_watch_nodes/man.rst index c92a8d01..a44dada4 100644 --- a/cdist/conf/type/__consul_watch_nodes/man.rst +++ b/cdist/conf/type/__consul_watch_nodes/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_nodes - Manages consul nodes watches -Steven Armstrong - DESCRIPTION ----------- @@ -43,9 +41,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_service/man.rst b/cdist/conf/type/__consul_watch_service/man.rst index f37a0dea..fa6450fe 100644 --- a/cdist/conf/type/__consul_watch_service/man.rst +++ b/cdist/conf/type/__consul_watch_service/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_service - Manages consul service watches -Steven Armstrong - DESCRIPTION ----------- @@ -67,9 +65,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consule documentation at: . + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__consul_watch_services/man.rst b/cdist/conf/type/__consul_watch_services/man.rst index 3d39da00..db561593 100644 --- a/cdist/conf/type/__consul_watch_services/man.rst +++ b/cdist/conf/type/__consul_watch_services/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__consul_watch_services - Manages consul services watches -Steven Armstrong - DESCRIPTION ----------- @@ -43,9 +41,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__consul_agent(7) `_ -- http://www.consul.io/docs/agent/watches.html +`cdist-type__consul_agent(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +consul documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__cron/man.rst b/cdist/conf/type/__cron/man.rst index 33f2b185..e8f32c52 100644 --- a/cdist/conf/type/__cron/man.rst +++ b/cdist/conf/type/__cron/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__cron - Installs and manages cron jobs -Steven Armstrong - DESCRIPTION ----------- @@ -70,8 +68,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- crontab(5) +crontab(5) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__debconf_set_selections/man.rst b/cdist/conf/type/__debconf_set_selections/man.rst index 60cdd5f0..27e037e7 100644 --- a/cdist/conf/type/__debconf_set_selections/man.rst +++ b/cdist/conf/type/__debconf_set_selections/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__debconf_set_selections - Setup debconf selections -Nico Schottelius - DESCRIPTION ----------- @@ -39,9 +37,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__update_alternatives(7) `_ -- debconf-set-selections(1) +debconf-set-selections(1), +`cdist-type__update_alternatives(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__directory/man.rst b/cdist/conf/type/__directory/man.rst index 8ca292ff..abb07eff 100644 --- a/cdist/conf/type/__directory/man.rst +++ b/cdist/conf/type/__directory/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__directory - Manage a directory -Nico Schottelius - DESCRIPTION ----------- @@ -92,7 +90,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__dog_vdi/man.rst b/cdist/conf/type/__dog_vdi/man.rst index 3e0c27c9..b0f700c6 100644 --- a/cdist/conf/type/__dog_vdi/man.rst +++ b/cdist/conf/type/__dog_vdi/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__dog_vdi - Manage Sheepdog VM images -Nico Schottelius - DESCRIPTION ----------- @@ -45,9 +43,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- dog(8) -- qemu(1) +qemu(1), dog(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__file/man.rst b/cdist/conf/type/__file/man.rst index 89efebdb..fa71e5ce 100644 --- a/cdist/conf/type/__file/man.rst +++ b/cdist/conf/type/__file/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__file - Manage files. -Nico Schottelius - DESCRIPTION ----------- @@ -103,7 +101,13 @@ EXAMPLES SEE ALSO -------- -* `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__firewalld_rule/man.rst b/cdist/conf/type/__firewalld_rule/man.rst index 4533e193..2d1f5589 100644 --- a/cdist/conf/type/__firewalld_rule/man.rst +++ b/cdist/conf/type/__firewalld_rule/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__firewalld_rule - Configure firewalld rules -Nico Schottelius - DESCRIPTION ----------- @@ -67,9 +65,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__iptables_rule(7) `_ -- firewalld(8) +`cdist-type__iptables_rule(7) `_, +firewalld(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__git/man.rst b/cdist/conf/type/__git/man.rst index 3ccc1e91..2f344a69 100644 --- a/cdist/conf/type/__git/man.rst +++ b/cdist/conf/type/__git/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__git - Get and or keep git repositories up-to-date -Nico Schottelius - DESCRIPTION ----------- @@ -51,7 +49,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__group/man.rst b/cdist/conf/type/__group/man.rst index 6a7d5a55..c6c9d226 100644 --- a/cdist/conf/type/__group/man.rst +++ b/cdist/conf/type/__group/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__group - Manage groups -Steven Armstrong - DESCRIPTION ----------- @@ -71,7 +69,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__hostname/man.rst b/cdist/conf/type/__hostname/man.rst index bd5d5a21..bfb9d457 100644 --- a/cdist/conf/type/__hostname/man.rst +++ b/cdist/conf/type/__hostname/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__hostname - Set the hostname -Steven Armstrong - DESCRIPTION ----------- @@ -43,7 +41,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__iptables_apply/man.rst b/cdist/conf/type/__iptables_apply/man.rst index 6a94b0af..5f4f4dc8 100644 --- a/cdist/conf/type/__iptables_apply/man.rst +++ b/cdist/conf/type/__iptables_apply/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__iptables_apply - Apply the rules -Nico Schottelius - DESCRIPTION ----------- @@ -31,9 +29,16 @@ None (__iptables_apply is used by __iptables_rule) SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__iptables_rule(7) `_ -- iptables(8) +`cdist-type__iptables_rule(7) `_, +iptables(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__iptables_rule/man.rst b/cdist/conf/type/__iptables_rule/man.rst index b6ff6a32..4d02e1d7 100644 --- a/cdist/conf/type/__iptables_rule/man.rst +++ b/cdist/conf/type/__iptables_rule/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__iptables_rule - Deploy iptable rulesets -Nico Schottelius - DESCRIPTION ----------- @@ -52,9 +50,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__iptables_apply(7) `_ -- iptables(8) +`cdist-type__iptables_apply(7) `_, +iptables(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__issue/man.rst b/cdist/conf/type/__issue/man.rst index 59fa6694..77f28da2 100644 --- a/cdist/conf/type/__issue/man.rst +++ b/cdist/conf/type/__issue/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__issue - Manage issue -Nico Schottelius - DESCRIPTION ----------- @@ -38,7 +36,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__jail/man.rst b/cdist/conf/type/__jail/man.rst index 6bbfbf47..ba175aa4 100644 --- a/cdist/conf/type/__jail/man.rst +++ b/cdist/conf/type/__jail/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__jail - Manage FreeBSD jails -Jake Guffey - DESCRIPTION ----------- @@ -110,7 +108,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__jail_freebsd10/man.rst b/cdist/conf/type/__jail_freebsd10/man.rst index 1a3515f0..9916afcb 100644 --- a/cdist/conf/type/__jail_freebsd10/man.rst +++ b/cdist/conf/type/__jail_freebsd10/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__jail_freeebsd10 - Manage FreeBSD jails -Jake Guffey - DESCRIPTION ----------- @@ -109,7 +107,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__jail_freebsd9/man.rst b/cdist/conf/type/__jail_freebsd9/man.rst index 1e442ac0..21266dd8 100644 --- a/cdist/conf/type/__jail_freebsd9/man.rst +++ b/cdist/conf/type/__jail_freebsd9/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__jail_freebsd9 - Manage FreeBSD jails -Jake Guffey - DESCRIPTION ----------- @@ -110,7 +108,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__key_value/man.rst b/cdist/conf/type/__key_value/man.rst index 467be78b..78e29276 100644 --- a/cdist/conf/type/__key_value/man.rst +++ b/cdist/conf/type/__key_value/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__key_value - Change property values in files -Steven Armstrong - DESCRIPTION ----------- @@ -85,7 +83,13 @@ So you need to exactly specify the key and delimiter. Delimiter can be of any le SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__line/man.rst b/cdist/conf/type/__line/man.rst index 81f57039..3a773f6a 100644 --- a/cdist/conf/type/__line/man.rst +++ b/cdist/conf/type/__line/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__line - Manage lines in files -Nico Schottelius - DESCRIPTION ----------- @@ -63,8 +61,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- grep(1) +grep(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__link/man.rst b/cdist/conf/type/__link/man.rst index 750874c1..0d0f2fad 100644 --- a/cdist/conf/type/__link/man.rst +++ b/cdist/conf/type/__link/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__link - Manage links (hard and symbolic) -Nico Schottelius - DESCRIPTION ----------- @@ -51,7 +49,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__locale/man.rst b/cdist/conf/type/__locale/man.rst index 2d947da8..c555bd00 100644 --- a/cdist/conf/type/__locale/man.rst +++ b/cdist/conf/type/__locale/man.rst @@ -5,8 +5,6 @@ NAME ---- cdit-type__locale - Configure locales -Nico Schottelius - DESCRIPTION ----------- @@ -36,9 +34,15 @@ EXAMPLES SEE ALSO -------- -- locale(1) -- localedef(1) -- `cdist-type(7) `_ +locale(1), localedef(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__motd/man.rst b/cdist/conf/type/__motd/man.rst index 1de8b258..e1530495 100644 --- a/cdist/conf/type/__motd/man.rst +++ b/cdist/conf/type/__motd/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__motd - Manage message of the day -Nico Schottelius - DESCRIPTION ----------- @@ -39,7 +37,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__mount/man.rst b/cdist/conf/type/__mount/man.rst index eab304db..c53457ac 100644 --- a/cdist/conf/type/__mount/man.rst +++ b/cdist/conf/type/__mount/man.rst @@ -5,8 +5,6 @@ NAME ---- cdit-type__mount - Manage filesystem mounts -Steven Armstrong - DESCRIPTION ----------- @@ -75,7 +73,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__mysql_database/man.rst b/cdist/conf/type/__mysql_database/man.rst index d8d2626d..921df7f3 100644 --- a/cdist/conf/type/__mysql_database/man.rst +++ b/cdist/conf/type/__mysql_database/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__mysql_database - Manage a MySQL database -Benedikt Koeppel - DESCRIPTION ----------- @@ -40,7 +38,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Benedikt Koeppel COPYING diff --git a/cdist/conf/type/__package/man.rst b/cdist/conf/type/__package/man.rst index b412af69..fe806a53 100644 --- a/cdist/conf/type/__package/man.rst +++ b/cdist/conf/type/__package/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package - Manage packages -Steven Armstrong - DESCRIPTION ----------- @@ -55,7 +53,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__package_apt/man.rst b/cdist/conf/type/__package_apt/man.rst index 65ebf6fa..39eb550b 100644 --- a/cdist/conf/type/__package_apt/man.rst +++ b/cdist/conf/type/__package_apt/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_apt - Manage packages with apt-get -Nico Schottelius - DESCRIPTION ----------- @@ -48,8 +46,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__package_emerge/man.rst b/cdist/conf/type/__package_emerge/man.rst index c9ac59b9..24f3546d 100644 --- a/cdist/conf/type/__package_emerge/man.rst +++ b/cdist/conf/type/__package_emerge/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_emerge - Manage packages with portage -Thomas Oettli - DESCRIPTION ----------- @@ -49,9 +47,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ -- `cdist-type__package_emerge_dependencies(7) `_ +`cdist-type__package(7) `_, +`cdist-type__package_emerge_dependencies(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Thomas Oettli COPYING diff --git a/cdist/conf/type/__package_emerge_dependencies/man.rst b/cdist/conf/type/__package_emerge_dependencies/man.rst index 1c4d291b..b07d2284 100644 --- a/cdist/conf/type/__package_emerge_dependencies/man.rst +++ b/cdist/conf/type/__package_emerge_dependencies/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_emerge_dependencies - Install dependencies for __package_emerge -Thomas Oettli - DESCRIPTION ----------- @@ -38,9 +36,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ -- `cdist-type__package_emerge(7) `_ +`cdist-type__package(7) `_, +`cdist-type__package_emerge(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Thomas Oettli COPYING diff --git a/cdist/conf/type/__package_luarocks/man.rst b/cdist/conf/type/__package_luarocks/man.rst index e097b4d6..e5279513 100644 --- a/cdist/conf/type/__package_luarocks/man.rst +++ b/cdist/conf/type/__package_luarocks/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_luarocks - Manage luarocks packages -Christian G. Warden - DESCRIPTION ----------- @@ -41,8 +39,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Christian G. Warden COPYING diff --git a/cdist/conf/type/__package_opkg/man.rst b/cdist/conf/type/__package_opkg/man.rst index 0104bbf2..9ad4d99f 100644 --- a/cdist/conf/type/__package_opkg/man.rst +++ b/cdist/conf/type/__package_opkg/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_opkg - Manage packages with opkg -Giel van Schijndel - DESCRIPTION ----------- @@ -41,8 +39,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Giel van Schijndel COPYING diff --git a/cdist/conf/type/__package_pacman/man.rst b/cdist/conf/type/__package_pacman/man.rst index 6f3fc5b3..b144422b 100644 --- a/cdist/conf/type/__package_pacman/man.rst +++ b/cdist/conf/type/__package_pacman/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_pacman - Manage packages with pacman -Nico Schottelius - DESCRIPTION ----------- @@ -44,8 +42,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__package_pip/man.rst b/cdist/conf/type/__package_pip/man.rst index 0630274a..026562c1 100644 --- a/cdist/conf/type/__package_pip/man.rst +++ b/cdist/conf/type/__package_pip/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_pip - Manage packages with pip -Nico Schottelius - DESCRIPTION ----------- @@ -51,8 +49,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__package_pkg_freebsd/man.rst b/cdist/conf/type/__package_pkg_freebsd/man.rst index 9246d09c..8249c8f5 100644 --- a/cdist/conf/type/__package_pkg_freebsd/man.rst +++ b/cdist/conf/type/__package_pkg_freebsd/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_pkg_freebsd - Manage FreeBSD packages -Jake Guffey - DESCRIPTION ----------- @@ -56,8 +54,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__package_pkg_openbsd/man.rst b/cdist/conf/type/__package_pkg_openbsd/man.rst index f584864b..9d253dce 100644 --- a/cdist/conf/type/__package_pkg_openbsd/man.rst +++ b/cdist/conf/type/__package_pkg_openbsd/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_pkg - Manage OpenBSD packages -Andi Brönnimann - DESCRIPTION ----------- @@ -56,8 +54,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Andi Brönnimann COPYING diff --git a/cdist/conf/type/__package_pkgng_freebsd/man.rst b/cdist/conf/type/__package_pkgng_freebsd/man.rst index b81ef75c..83fbf7bf 100644 --- a/cdist/conf/type/__package_pkgng_freebsd/man.rst +++ b/cdist/conf/type/__package_pkgng_freebsd/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_pkgng_freebsd - Manage FreeBSD packages with pkg-ng -Jake Guffey - DESCRIPTION ----------- @@ -87,8 +85,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__package_rubygem/man.rst b/cdist/conf/type/__package_rubygem/man.rst index d74149b0..0822bcf2 100644 --- a/cdist/conf/type/__package_rubygem/man.rst +++ b/cdist/conf/type/__package_rubygem/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_rubygem - Manage rubygem packages -Chase Allen James - DESCRIPTION ----------- @@ -41,8 +39,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Chase Allen James COPYING diff --git a/cdist/conf/type/__package_update_index/man.rst b/cdist/conf/type/__package_update_index/man.rst index ae05b3c5..a8f16d21 100644 --- a/cdist/conf/type/__package_update_index/man.rst +++ b/cdist/conf/type/__package_update_index/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__update_index - Update the package index -Ricardo Catalinas Jiménez - DESCRIPTION ----------- @@ -44,7 +42,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Ricardo Catalinas Jiménez COPYING diff --git a/cdist/conf/type/__package_upgrade_all/man.rst b/cdist/conf/type/__package_upgrade_all/man.rst index af6a2373..f6b216b4 100644 --- a/cdist/conf/type/__package_upgrade_all/man.rst +++ b/cdist/conf/type/__package_upgrade_all/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_upgrade_all - Upgrade all the installed packages -Ricardo Catalinas Jiménez - DESCRIPTION ----------- @@ -44,7 +42,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Ricardo Catalinas Jiménez COPYING diff --git a/cdist/conf/type/__package_yum/man.rst b/cdist/conf/type/__package_yum/man.rst index 440d0723..487150b9 100644 --- a/cdist/conf/type/__package_yum/man.rst +++ b/cdist/conf/type/__package_yum/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_yum - Manage packages with yum -Nico Schottelius - DESCRIPTION ----------- @@ -51,8 +49,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__package_zypper/man.rst b/cdist/conf/type/__package_zypper/man.rst index 74648c9e..754b5ddd 100644 --- a/cdist/conf/type/__package_zypper/man.rst +++ b/cdist/conf/type/__package_zypper/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__package_zypper - Manage packages with zypper -Daniel Heule - DESCRIPTION ----------- @@ -58,8 +56,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__package(7) `_ +`cdist-type__package(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Daniel Heule COPYING diff --git a/cdist/conf/type/__pacman_conf/man.rst b/cdist/conf/type/__pacman_conf/man.rst index 0a8eb62a..c0040664 100644 --- a/cdist/conf/type/__pacman_conf/man.rst +++ b/cdist/conf/type/__pacman_conf/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__pacman_conf - Manage pacman configuration -Dominique Roux - DESCRIPTION ----------- @@ -61,8 +59,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- grep(1) +grep(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Dominique Roux COPYING diff --git a/cdist/conf/type/__pacman_conf_integrate/man.rst b/cdist/conf/type/__pacman_conf_integrate/man.rst index 30ef6cd9..10ff0c8a 100644 --- a/cdist/conf/type/__pacman_conf_integrate/man.rst +++ b/cdist/conf/type/__pacman_conf_integrate/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__pacman_conf_integrate - Integrate default pacman.conf to cdist conform and vice versa -Dominique Roux - DESCRIPTION ----------- @@ -37,8 +35,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- grep(1) +grep(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Dominique Roux COPYING diff --git a/cdist/conf/type/__pf_apply/man.rst b/cdist/conf/type/__pf_apply/man.rst index acebcb96..20374699 100644 --- a/cdist/conf/type/__pf_apply/man.rst +++ b/cdist/conf/type/__pf_apply/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__pf_apply - Apply pf(4) ruleset on \*BSD -Jake Guffey - DESCRIPTION ----------- @@ -41,9 +39,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__pf_ruleset(7) `_ -- pf(4) +pf(4), +`cdist-type__pf_ruleset(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__pf_ruleset/man.rst b/cdist/conf/type/__pf_ruleset/man.rst index 7edc0f91..15d50408 100644 --- a/cdist/conf/type/__pf_ruleset/man.rst +++ b/cdist/conf/type/__pf_ruleset/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__pf_ruleset - Copy a pf(4) ruleset to $__target_host -Jake Guffey - DESCRIPTION ----------- @@ -41,8 +39,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- pf(4) +pf(4) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Jake Guffey COPYING diff --git a/cdist/conf/type/__postfix/man.rst b/cdist/conf/type/__postfix/man.rst index 73347e38..628356b2 100644 --- a/cdist/conf/type/__postfix/man.rst +++ b/cdist/conf/type/__postfix/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postfix - Install postfix -Steven Armstrong - DESCRIPTION ----------- @@ -33,7 +31,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postfix_master/man.rst b/cdist/conf/type/__postfix_master/man.rst index 86fa5f8c..7f100485 100644 --- a/cdist/conf/type/__postfix_master/man.rst +++ b/cdist/conf/type/__postfix_master/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postfix_master - Configure postfix master.cf -Steven Armstrong - DESCRIPTION ----------- @@ -70,8 +68,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- master(5) +master(5) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postfix_postconf/man.rst b/cdist/conf/type/__postfix_postconf/man.rst index ab0192b8..f1a4b0a6 100644 --- a/cdist/conf/type/__postfix_postconf/man.rst +++ b/cdist/conf/type/__postfix_postconf/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postfix_postconf - Configure postfix main.cf -Steven Armstrong - DESCRIPTION ----------- @@ -40,8 +38,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- postconf(5) +postconf(5) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postfix_postmap/man.rst b/cdist/conf/type/__postfix_postmap/man.rst index 5e9d3c2d..20aeb2df 100644 --- a/cdist/conf/type/__postfix_postmap/man.rst +++ b/cdist/conf/type/__postfix_postmap/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postfix_postmap - Run postmap on the given file -Steven Armstrong - DESCRIPTION ----------- @@ -33,7 +31,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postfix_reload/man.rst b/cdist/conf/type/__postfix_reload/man.rst index 330ed51c..ec9529e9 100644 --- a/cdist/conf/type/__postfix_reload/man.rst +++ b/cdist/conf/type/__postfix_reload/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postfix_reload - Tell postfix to reload its configuration -Steven Armstrong - DESCRIPTION ----------- @@ -33,7 +31,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postgres_database/man.rst b/cdist/conf/type/__postgres_database/man.rst index 34cd2f03..2a0ad8d0 100644 --- a/cdist/conf/type/__postgres_database/man.rst +++ b/cdist/conf/type/__postgres_database/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postgres_database - Create/drop postgres databases -Steven Armstrong - DESCRIPTION ----------- @@ -32,8 +30,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__postgres_role(7) `_ +`cdist-type__postgres_role(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__postgres_role/man.rst b/cdist/conf/type/__postgres_role/man.rst index 4b8d291f..9d0b68ab 100644 --- a/cdist/conf/type/__postgres_role/man.rst +++ b/cdist/conf/type/__postgres_role/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__postgres_role - Manage postgres roles -Steven Armstrong - DESCRIPTION ----------- @@ -50,9 +48,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__postgres_database(7) `_ -- http://www.postgresql.org/docs/current/static/sql-createrole.html +`cdist-type__postgres_database(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. +postgresql documentation at: +. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__process/man.rst b/cdist/conf/type/__process/man.rst index 3f17076d..076377e1 100644 --- a/cdist/conf/type/__process/man.rst +++ b/cdist/conf/type/__process/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__process - Start or stop process -Nico Schottelius - DESCRIPTION ----------- @@ -60,8 +58,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__start_on_boot(7) `_ +`cdist-type__start_on_boot(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__pyvenv/man.rst b/cdist/conf/type/__pyvenv/man.rst old mode 100755 new mode 100644 index ff7a922b..f43454a7 --- a/cdist/conf/type/__pyvenv/man.rst +++ b/cdist/conf/type/__pyvenv/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__pyvenv - Create or remove python virtual environment -Darko Poljak - DESCRIPTION ----------- @@ -71,7 +69,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Darko Poljak COPYING diff --git a/cdist/conf/type/__qemu_img/man.rst b/cdist/conf/type/__qemu_img/man.rst index 4492c260..3a137f4b 100644 --- a/cdist/conf/type/__qemu_img/man.rst +++ b/cdist/conf/type/__qemu_img/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__qemu_img - Manage VM disk images -Nico Schottelius - DESCRIPTION ----------- @@ -39,8 +37,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- qemu-img(1) +qemu-img(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__rbenv/man.rst b/cdist/conf/type/__rbenv/man.rst index d13f407c..fe965796 100644 --- a/cdist/conf/type/__rbenv/man.rst +++ b/cdist/conf/type/__rbenv/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rbenv - Manage rbenv installation -Nico Schottelius - DESCRIPTION ----------- @@ -40,7 +38,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__rsync/man.rst b/cdist/conf/type/__rsync/man.rst index afca11d5..bac144c2 100644 --- a/cdist/conf/type/__rsync/man.rst +++ b/cdist/conf/type/__rsync/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rsync - Mirror directories using rsync -Nico Schottelius - DESCRIPTION ----------- @@ -100,8 +98,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- rsync(1) +rsync(1) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__rvm/man.rst b/cdist/conf/type/__rvm/man.rst index 5aa264e0..bf84328c 100644 --- a/cdist/conf/type/__rvm/man.rst +++ b/cdist/conf/type/__rvm/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rvm - Install rvm for a given user -Evax Software - DESCRIPTION ----------- @@ -33,10 +31,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__rvm_ruby(7) `_ -- `cdist-type__rvm_gemset(7) `_ -- `cdist-type__rvm_gem(7) `_ +`cdist-type__rvm_gem(7) `_, +`cdist-type__rvm_gemset(7) `_, +`cdist-type__rvm_ruby(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Evax Software COPYING diff --git a/cdist/conf/type/__rvm_gem/man.rst b/cdist/conf/type/__rvm_gem/man.rst index c6011f45..5e65a712 100644 --- a/cdist/conf/type/__rvm_gem/man.rst +++ b/cdist/conf/type/__rvm_gem/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rvm_gemset - Manage Ruby gems through rvm -Evax Software - DESCRIPTION ----------- @@ -45,10 +43,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__rvm(7) `_ -- `cdist-type__rvm_ruby(7) `_ -- `cdist-type__rvm_gemset(7) `_ +`cdist-type__rvm(7) `_, +`cdist-type__rvm_gemset(7) `_, +`cdist-type__rvm_ruby(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Evax Software COPYING diff --git a/cdist/conf/type/__rvm_gemset/man.rst b/cdist/conf/type/__rvm_gemset/man.rst index 6792b14e..0d04ed94 100644 --- a/cdist/conf/type/__rvm_gemset/man.rst +++ b/cdist/conf/type/__rvm_gemset/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rvm_gemset - Manage gemsets through rvm -Evax Software - DESCRIPTION ----------- @@ -43,10 +41,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__rvm(7) `_ -- `cdist-type__rvm_ruby(7) `_ -- `cdist-type__rvm_gem(7) `_ +`cdist-type__rvm(7) `_, +`cdist-type__rvm_gem(7) `_, +`cdist-type__rvm_ruby(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Evax Software COPYING diff --git a/cdist/conf/type/__rvm_ruby/man.rst b/cdist/conf/type/__rvm_ruby/man.rst index 235731cd..d2bd4d08 100644 --- a/cdist/conf/type/__rvm_ruby/man.rst +++ b/cdist/conf/type/__rvm_ruby/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__rvm_ruby - Manage ruby installations through rvm -Evax Software - DESCRIPTION ----------- @@ -44,10 +42,17 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__rvm(7) `_ -- `cdist-type__rvm_gemset(7) `_ -- `cdist-type__rvm_gem(7) `_ +`cdist-type__rvm(7) `_, +`cdist-type__rvm_gem(7) `_, +`cdist-type__rvm_gemset(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Evax Software COPYING diff --git a/cdist/conf/type/__ssh_authorized_key/man.rst b/cdist/conf/type/__ssh_authorized_key/man.rst index 767fb1d2..a2f90574 100644 --- a/cdist/conf/type/__ssh_authorized_key/man.rst +++ b/cdist/conf/type/__ssh_authorized_key/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__ssh_authorized_key - Manage a single ssh authorized key entry -Steven Armstrong - DESCRIPTION ----------- @@ -57,9 +55,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist__ssh_authorized_keys(7) `_ -- sshd(8) +`cdist__ssh_authorized_keys(7) `_, +sshd(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + +AUTHORS +------- +Steven Armstrong + COPYING ------- diff --git a/cdist/conf/type/__ssh_authorized_keys/man.rst b/cdist/conf/type/__ssh_authorized_keys/man.rst index 54e294b3..cab844cc 100644 --- a/cdist/conf/type/__ssh_authorized_keys/man.rst +++ b/cdist/conf/type/__ssh_authorized_keys/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__ssh_authorized_keys - Manage ssh authorized_keys files -Steven Armstrong - DESCRIPTION ----------- @@ -107,8 +105,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- sshd(8) +sshd(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__ssh_dot_ssh/man.rst b/cdist/conf/type/__ssh_dot_ssh/man.rst index 12b4c2e7..6d449a4c 100644 --- a/cdist/conf/type/__ssh_dot_ssh/man.rst +++ b/cdist/conf/type/__ssh_dot_ssh/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__ssh_dot_ssh - Manage .ssh directory -Nico Schottelius - DESCRIPTION ----------- @@ -35,8 +33,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__ssh_authorized_keys(7) `_ +`cdist-type__ssh_authorized_keys(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__staged_file/man.rst b/cdist/conf/type/__staged_file/man.rst index aec11707..69ea3678 100644 --- a/cdist/conf/type/__staged_file/man.rst +++ b/cdist/conf/type/__staged_file/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__staged_file - Manage staged files -Steven Armstrong - DESCRIPTION ----------- @@ -101,8 +99,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__file(7) `_ +`cdist-type__file(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__start_on_boot/man.rst b/cdist/conf/type/__start_on_boot/man.rst index 2f07362b..7d009bf0 100644 --- a/cdist/conf/type/__start_on_boot/man.rst +++ b/cdist/conf/type/__start_on_boot/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__start_on_boot - Manage stuff to be started at boot -Nico Schottelius - DESCRIPTION ----------- @@ -47,8 +45,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__process(7) `_ +`cdist-type__process(7) `_ + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__timezone/man.rst b/cdist/conf/type/__timezone/man.rst index 838f4c46..6e18c759 100644 --- a/cdist/conf/type/__timezone/man.rst +++ b/cdist/conf/type/__timezone/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__timezone - Allows one to configure the desired localtime timezone. -Ramon Salvadó - DESCRIPTION ----------- @@ -38,7 +36,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Ramon Salvadó COPYING diff --git a/cdist/conf/type/__update_alternatives/man.rst b/cdist/conf/type/__update_alternatives/man.rst index f321b02f..bcedc1bf 100644 --- a/cdist/conf/type/__update_alternatives/man.rst +++ b/cdist/conf/type/__update_alternatives/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__update_alternatives - Configure alternatives -Nico Schottelius - DESCRIPTION ----------- @@ -32,9 +30,16 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- `cdist-type__debconf_set_selections(7) `_ -- update-alternatives(8) +`cdist-type__debconf_set_selections(7) `_, +update-alternatives(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Nico Schottelius COPYING diff --git a/cdist/conf/type/__user/man.rst b/cdist/conf/type/__user/man.rst index 6a055a4e..0dd91ddd 100644 --- a/cdist/conf/type/__user/man.rst +++ b/cdist/conf/type/__user/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__user - Manage users -Steven Armstrong - DESCRIPTION ----------- @@ -86,8 +84,15 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ -- usermod(8) or pw(8) +pw(8), usermod(8) + +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__user_groups/man.rst b/cdist/conf/type/__user_groups/man.rst index 8857feb1..216a31c8 100644 --- a/cdist/conf/type/__user_groups/man.rst +++ b/cdist/conf/type/__user_groups/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__user_groups - Manage user groups -Steven Armstrong - DESCRIPTION ----------- @@ -43,7 +41,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__yum_repo/man.rst b/cdist/conf/type/__yum_repo/man.rst index 3df9f1b9..b3866739 100644 --- a/cdist/conf/type/__yum_repo/man.rst +++ b/cdist/conf/type/__yum_repo/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__yum_repo - Manage yum repositories -Steven Armstrong - DESCRIPTION ----------- @@ -115,7 +113,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Steven Armstrong COPYING diff --git a/cdist/conf/type/__zypper_repo/man.rst b/cdist/conf/type/__zypper_repo/man.rst index d1b87a5b..bcf376de 100644 --- a/cdist/conf/type/__zypper_repo/man.rst +++ b/cdist/conf/type/__zypper_repo/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__zypper_repo - Repository management with zypper -Daniel Heule - DESCRIPTION ----------- @@ -64,7 +62,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Daniel Heule COPYING diff --git a/cdist/conf/type/__zypper_service/man.rst b/cdist/conf/type/__zypper_service/man.rst index 9d538208..f586742a 100644 --- a/cdist/conf/type/__zypper_service/man.rst +++ b/cdist/conf/type/__zypper_service/man.rst @@ -5,8 +5,6 @@ NAME ---- cdist-type__zypper_service - Service management with zypper -Daniel Heule - DESCRIPTION ----------- @@ -57,7 +55,13 @@ EXAMPLES SEE ALSO -------- -- `cdist-type(7) `_ +Full documentation at: <:cdist_docs:`index`>, +especially cdist type chapter: <:cdist_docs:`cdist-type`>. + + +AUTHORS +------- +Daniel Heule COPYING diff --git a/docs/changelog b/docs/changelog index 33fe54b6..2ffe7a66 100644 --- a/docs/changelog +++ b/docs/changelog @@ -2,6 +2,7 @@ Changelog --------- next: + * Documentation: Restructure and fix and improve docs and manpages (Darko Poljak) * Core: Add files directory for static files (Darko Poljak) * Core: Fix conflicting requirements (Darko Poljak) * Custom: Add bash and zsh completions (Darko Poljak) diff --git a/docs/man/Makefile b/docs/man/Makefile index 6d3ec6dc..2bab13ce 100644 --- a/docs/man/Makefile +++ b/docs/man/Makefile @@ -9,7 +9,7 @@ BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) - $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) + $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. diff --git a/docs/man/man7/cdist-best-practice.rst b/docs/man/cdist-best-practice.rst similarity index 90% rename from docs/man/man7/cdist-best-practice.rst rename to docs/man/cdist-best-practice.rst index 7c19c038..57ce5cc1 100644 --- a/docs/man/man7/cdist-best-practice.rst +++ b/docs/man/cdist-best-practice.rst @@ -1,14 +1,8 @@ -cdist-best-practice(7) -====================== +Best practice +============= +Practices used in real environments -NAME ----- -cdist-best-practice - Practices used in real environments - -Nico Schottelius - - -PASSWORDLESS CONNECTIONS +Passwordless connections ------------------------ It is recommended to run cdist with public key authentication. This requires a private/public key pair and the entry @@ -16,7 +10,7 @@ This requires a private/public key pair and the entry See sshd_config(5) and ssh-keygen(1). -SPEEDING UP SSH CONNECTIONS +Speeding up ssh connections --------------------------- When connecting to a new host, the initial delay with ssh connections is pretty big. You can work around this by @@ -30,7 +24,7 @@ inclusion into your ~/.ssh/config:: ControlPersist 10 -SPEEDING UP SHELL EXECUTION +Speeding up shell execution ---------------------------- On the source host, ensure that /bin/sh is *not* bash: bash is quite slow for script execution. Instead, you could use dash after installing it:: @@ -38,7 +32,7 @@ script execution. Instead, you could use dash after installing it:: ln -sf /bin/dash /bin/sh -MULTI MASTER OR ENVIRONMENT SETUPS +Multi master or environment setups ---------------------------------- If you plan to distribute cdist among servers or use different environments, you can do so easily with the included version @@ -64,7 +58,7 @@ you can clone it multiple times:: machine-b % git clone git://your-git-server/cdist -SEPERATING WORK BY GROUPS +Seperating work by groups ------------------------- If you are working with different groups on one cdist-configuration, you can delegate to other manifests and have the groups edit only @@ -77,7 +71,7 @@ their manifests. You can use the following snippet in sh -e "$__manifest/cbrg" -MAINTAINING MULTIPLE CONFIGURATIONS +Maintaining multiple configurations ----------------------------------- When you need to manage multiple sites with cdist, like company_a, company_b and private for instance, you can easily use git for this purpose. @@ -138,7 +132,7 @@ The following **.git/config** is taken from a a real world scenario:: Have a look at git-remote(1) to adjust the remote configuration, which allows -MULTIPLE DEVELOPERS WITH DIFFERENT TRUST +Multiple developers with different trust ---------------------------------------- If you are working in an environment that requires different people to work on the same configuration, but having different privileges, you can @@ -155,7 +149,7 @@ implement this scenario with a gateway host and sudo: For more details consult sudoers(5) -TEMPLATING +Templating ---------- * create directory files/ in your type (convention) * create the template as an executable file like files/basic.conf.sh, it will output text using shell variables for the values @@ -193,7 +187,7 @@ TEMPLATING --source "$__object/files/basic.conf" -TESTING A NEW TYPE +Testing a new type ------------------ If you want to test a new type on a node, you can tell cdist to only use an object of this type: Use the '--initial-manifest' parameter @@ -214,7 +208,7 @@ of cdist: cdist --initial-manifest - cdist-dev-01.ungleich.ch -OTHER CONTENT IN CDIST REPOSITORY +Other content in cdist repository --------------------------------- Usually the cdist repository contains all configuration items. Sometimes you may have additional resources that @@ -227,15 +221,3 @@ in the repository for such content: It allows you to easily distinguish what is used by cdist and what not and also to store all important files in one repository. - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-tutorial(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). diff --git a/docs/man/man7/cdist-bootstrap.rst b/docs/man/cdist-bootstrap.rst similarity index 86% rename from docs/man/man7/cdist-bootstrap.rst rename to docs/man/cdist-bootstrap.rst index 6a070afa..c9972a99 100644 --- a/docs/man/man7/cdist-bootstrap.rst +++ b/docs/man/cdist-bootstrap.rst @@ -1,21 +1,11 @@ -cdist-bootstrap(7) -================== - -NAME ----- -cdist-bootstrap - Setup cdist environment - -Nico Schottelius - - -INTRODUCTION ------------- +Bootstrap +========= This document describes the usual steps recommended for a new cdist setup. It is recommended that you have read and understood -cdist-quickstart(7) before digging into this. +`cdist quickstart `_ before digging into this. -LOCATION +Location --------- First of all, you should think about where to store your configuration database and who will be accessing or changing it. Secondly you have to @@ -29,13 +19,13 @@ relies on is recommended, for use as backup as well as to allow easy collaborati with others. For more sophisticated setups developing cdist configurations with multiple -people, have a look at cdist-best-practice(7). +people, have a look at `cdist best practice `_. -SETUP WORKING DIRECTORY AND BRANCH +Setup working directory and branch ---------------------------------- I assume you have a fresh copy of the cdist tree in ~/cdist, cloned from -one of the official urls (see cdist-quickstart(7) if you don't). +one of the official urls (see `cdist quickstart `_ if you don't). Entering the command "git branch" should show you "* master", which indicates you are on the **master** branch. @@ -85,7 +75,7 @@ In this tutorial I use the branch **mycompany**:: From now on, you can use git as usual to commit your changes in your own branch. -PUBLISHING THE CONFIGURATION +Publishing the configuration ---------------------------- Usually a development machine like a notebook should be considered temporary only. For this reason and to enable shareability, the configuration @@ -114,7 +104,7 @@ branch with the **master** branch on the host **loch**. Thus you can commit as usual in your branch and push out changes by entering **git push**. -UPDATING FROM ORIGIN +Updating from origin -------------------- Whenever you want to update your cdist installation, you can use git to do so:: @@ -126,15 +116,3 @@ Whenever you want to update your cdist installation, you can use git to do so:: # Alternative: Update current branch with 2.0 branch from origin cdist% git merge origin/2.0 - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-tutorial(7) `_ - - -COPYING -------- -Copyright \(C) 2012 Nico Schottelius. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/docs/man/man7/cdist-explorer.rst b/docs/man/cdist-explorer.rst similarity index 75% rename from docs/man/man7/cdist-explorer.rst rename to docs/man/cdist-explorer.rst index 66c20d67..4bb61d7a 100644 --- a/docs/man/man7/cdist-explorer.rst +++ b/docs/man/cdist-explorer.rst @@ -1,14 +1,7 @@ -cdist-explorer(7) -================= +Explorer +======== -NAME ----- -cdist-explorer - Explore the target systems - -Nico Schottelius - - -DESCRIPTION +Description ----------- Explorer are small shell scripts, which will be executed on the target host. The aim of the explorer is to give hints to types on how to act on the @@ -39,7 +32,7 @@ error message on stderr, which will cause cdist to abort. You can also use stderr for debugging purposes while developing a new explorer. -EXAMPLES +Examples -------- A very simple explorer may look like this:: @@ -59,16 +52,3 @@ A type explorer, which could check for the status of a package may look like thi # Expect dpkg failing, if package is not known / installed dpkg -s "$name" 2>/dev/null || exit 0 - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-reference(7) `_ -- `cdist-stages(7) `_ - - -COPYING -------- -Copyright \(C) 2010-2014 Nico Schottelius. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/docs/man/cdist-features.rst b/docs/man/cdist-features.rst new file mode 100644 index 00000000..8a147741 --- /dev/null +++ b/docs/man/cdist-features.rst @@ -0,0 +1,48 @@ +Features +======== + +But cdist ticks differently, here is the feature set that makes it unique: + +Simplicity + There is only one type to extend cdist called **type** + +Design + + Type and core cleanly seperated + + Sticks completly to the KISS (keep it simple and stupid) paradigma + + Meaningful error messages - do not lose time debugging error messages + + Consistency in behaviour, naming and documentation + + No surprise factor: Only do what is obviously clear, no magic + + Define target state, do not focus on methods or scripts + + Push architecture: Instantly apply your changes + +Small core + cdist's core is very small - less code, less bugs + +Fast development + Focus on straightforwardness of type creation is a main development objective + Batteries included: A lot of requirements can be solved using standard types + +Modern Programming Language + cdist is written in Python + +Requirements, Scalability + No central server needed, cdist operates in push mode and can be run from any computer + +Requirements, Scalability, Upgrade + cdist only needs to be updated on the master, not on the target hosts + +Requirements, Security + Uses well-know `SSH `_ as transport protocol + +Requirements, Simplicity + Requires only shell and SSH server on the target + +UNIX + Reuse of existing tools like cat, find, mv, ... + +UNIX, familar environment, documentation + Is available as manpages and HTML + +UNIX, simplicity, familar environment + cdist is configured in POSIX shell + diff --git a/docs/man/man7/cdist-hacker.rst b/docs/man/cdist-hacker.rst similarity index 86% rename from docs/man/man7/cdist-hacker.rst rename to docs/man/cdist-hacker.rst index 4e3a21b6..326d83ba 100644 --- a/docs/man/man7/cdist-hacker.rst +++ b/docs/man/cdist-hacker.rst @@ -1,14 +1,7 @@ -cdist-hacker(7) -=============== +Hacking +======= -NAME ----- -cdist-hacker - How to get (stuff) into cdist - -Nico Schottelius - - -WELCOME +Welcome ------- Welcome dear hacker! I invite you to a tour of pointers to get into the usable configuration mangament system, cdist. @@ -19,14 +12,14 @@ twice before merging or implementing a feature: Less features with good usability are far better than the opposite. -REPORTING BUGS +Reporting bugs -------------- If you believe you've found a bug and verified that it is in the latest version, drop a mail to the cdist mailing list, subject prefixed with "[BUG] " or create an issue on github. -CODING CONVENTIONS (EVERYWHERE) +Coding conventions (everywhere) ------------------------------- If something should be better done or needs to fixed, add the word FIXME nearby, so grepping for FIXME gives all positions that need to be fixed. @@ -34,7 +27,7 @@ nearby, so grepping for FIXME gives all positions that need to be fixed. Indention is 4 spaces (welcome to the python world). -HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST +How to submit stuff for inclusion into upstream cdist ----------------------------------------------------- If you did some cool changes to cdist, which you value as a benefit for everybody using cdist, you're welcome to propose inclusion into upstream. @@ -61,9 +54,9 @@ for inclusion to the mailinglist **cdist at cdist -- at -- l.schottelius.org** or open a pull request at http://github.com/telmich/cdist. -HOW TO SUBMIT A NEW TYPE +How to submit a new type ------------------------ -For detailled information about types, see cdist-type(7). +For detailled information about types, see `cdist type `_. Submitting a type works as described above, with the additional requirement that a corresponding manpage named man.text in asciidoc format with @@ -77,9 +70,11 @@ code and thus such a type introduces redundant functionality that is given by core cdist already. -EXAMPLE GIT WORKFLOW +Example git workflow --------------------- -The following workflow works fine for most developers:: +The following workflow works fine for most developers + +.. code-block:: sh # get latest upstream master branch git clone https://github.com/telmich/cdist.git @@ -125,6 +120,8 @@ The following workflow works fine for most developers:: If at any point you want to go back to the original master branch, you can use **git stash** to stash your changes away:: +.. code-block:: sh + # assume you are on documentation_cleanup git stash @@ -136,6 +133,8 @@ use **git stash** to stash your changes away:: Similar when you want to develop another new feature, you go back to the master branch and create another branch based on it:: +.. code-block:: sh + # change to master and update to most recent upstream version git checkout master git fetch -v origin @@ -145,17 +144,3 @@ to the master branch and create another branch based on it:: (you can repeat the code above for as many features as you want to develop in parallel) - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- git(1) -- git-checkout(1) -- git-stash(1) - - -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). diff --git a/docs/man/cdist-install.rst b/docs/man/cdist-install.rst new file mode 100644 index 00000000..7e8bba7a --- /dev/null +++ b/docs/man/cdist-install.rst @@ -0,0 +1,105 @@ +How to install cdist +==================== + +Requirements +------------- + +Source Host +~~~~~~~~~~~ + +This is the machine you use to configure the target hosts. + + * /bin/sh: A posix like shell (for instance bash, dash, zsh) + * Python >= 3.2 + * SSH client + * sphinx (for building html docs and/or the manpages) + +Target Hosts +~~~~~~~~~~~~ + + * /bin/sh: A posix like shell (for instance bash, dash, zsh) + * SSH server + +Install cdist +------------- + +You can install cdist either from git or as a python package. + +From git +~~~~~~~~ + +Cloning cdist from git gives you the advantage of having +a version control in place for development of your own stuff +immediately. + +To install cdist, execute the following commands: + +.. code-block:: sh + + git clone https://github.com/ungleich/cdist.git + cd cdist + export PATH=$PATH:$(pwd -P)/bin + +Available versions in git +^^^^^^^^^^^^^^^^^^^^^^^^^ + + * The active development takes place in the **master** branch + * The released versions can be found in the tags + +Other branches may be available for features or bugfixes, but they +may vanish at any point. To select a specific branch use + +.. code-block:: sh + + # Generic code + git checkout -b origin/ + +So for instance if you want to use and stay with version 4.1, you can use + +.. code-block:: sh + + git checkout -b 4.1 origin/4.1 + +Git mirrors +^^^^^^^^^^^ + +If the main site is down, you can acquire cdist from one of the following sites: + + * git://github.com/telmich/cdist.git `github `_ + * git://git.code.sf.net/p/cdist/code `sourceforge `_ + +Building and using manpages +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want to build and use the manpages, run: + +.. code-block:: sh + + make man + export MANPATH=$MANPATH:$(pwd -P)/docs/man/_build/man + +Or you can move manpages from docs/man/_build/man directory to some +other directory and add it to MANPATH. + +You can also build manpages for types in your ~/.cdist directory: + +.. code-block:: sh + + make dotman + +Built manpages are now in docs/man/_build/man directory. If you have +some other custom .cdist directory, e.g. /custom/.cdist then use: + +.. code-block:: sh + + DOT_CDIST_PATH=/custom/.cdist make dotman + +Python package +~~~~~~~~~~~~~~ + +Cdist is available as a python package at +`PyPi `_. You can install it using + +.. code-block:: sh + + pip install cdist diff --git a/docs/man/cdist-intro.rst b/docs/man/cdist-intro.rst new file mode 100644 index 00000000..fad40fe5 --- /dev/null +++ b/docs/man/cdist-intro.rst @@ -0,0 +1,15 @@ +cdist - usable configuration management +======================================= + +.. image:: cdist-logo.png + :alt: cdist-logo + +cdist is a usable configuration management system. +It adheres to the KISS principle and +is being used in small up to enterprise grade environments. +cdist is an alternative to other configuration management systems like + +* `bcfg2 `_ +* `chef `_ +* `cfengine `_ +* `puppet `_. diff --git a/docs/man/cdist-logo.png b/docs/man/cdist-logo.png new file mode 100644 index 00000000..13c27927 Binary files /dev/null and b/docs/man/cdist-logo.png differ diff --git a/docs/man/man7/cdist-manifest.rst b/docs/man/cdist-manifest.rst similarity index 92% rename from docs/man/man7/cdist-manifest.rst rename to docs/man/cdist-manifest.rst index 04609b73..5c35b6a5 100644 --- a/docs/man/man7/cdist-manifest.rst +++ b/docs/man/cdist-manifest.rst @@ -1,14 +1,7 @@ -cdist-manifest(7) -================= +Manifest +======== -NAME ----- -cdist-manifest - (Re-)Use types - -Nico Schottelius - - -DESCRIPTION +Description ----------- Manifests are used to define which objects to create. Objects are instances of **types**, like in object oriented programming languages. @@ -44,15 +37,15 @@ In general, manifests are used to define which types are used depending on given conditions. -INITIAL AND TYPE MANIFESTS +Initial and type manifests -------------------------- Cdist knows about two types of manifests: The initial manifest and type manifests. The initial manifest is used to define, which configurations to apply to which hosts. The type manifests are used to create objects -from types. More about manifests in types can be found in cdist-type(7). +from types. More about manifests in types can be found in `cdist type `_. -DEFINE STATE IN THE INITIAL MANIFEST +Define state in the initial manifest ------------------------------------ The **initial manifest** is the entry point for cdist to find out, which **objects** to configure on the selected host. @@ -82,12 +75,12 @@ utilises cdist types. Every available type can be executed like a normal command. -SPLITTING UP THE INITIAL MANIFEST +Splitting up the initial manifest --------------------------------- If you want to split up your initial manifest, you can create other shell scripts in **cdist/conf/manifest/** and include them in **cdist/conf/manifest/init**. Cdist provides the environment variable **__manifest** to reference -the directory containing the initial manifest (see cdist-reference(7)). +the directory containing the initial manifest (see `cdist reference `_). The following example would include every file with a **.sh** suffix:: @@ -98,7 +91,7 @@ The following example would include every file with a **.sh** suffix:: done -DEPENDENCIES +Dependencies ------------ If you want to describe that something requires something else, just setup the variable "require" to contain the requirements. Multiple @@ -157,10 +150,10 @@ from the type that is calling them. This is called "autorequirement" in cdist jargon. You can find an more in depth description of the flow execution of manifests -in cdist-stages(7) and of how types work in cdist-type(7). +in `cdist execution stages `_ and of how types work in `cdist type `_. -CREATE DEPENDENCIES FROM EXECUTION ORDER +Create dependencies from execution order ----------------------------------------- You can tell cdist to execute all types in the order in which they are created in the manifest by setting up the variable CDIST_ORDER_DEPENDENCY. @@ -171,7 +164,7 @@ It essentially helps you to build up blocks of code that build upon each other (like first creating the directory xyz than the file below the directory). -OVERRIDES +Overrides --------- In some special cases, you would like to create an already defined object with different parameters. In normal situations this leads to an error in cdist. @@ -187,7 +180,7 @@ CDIST_ORDER_DEPENDENCY will be ignored, because adding a dependency in case of overrides would result in circular dependencies, which is an error. -EXAMPLES +Examples -------- The initial manifest may for instance contain the following code: @@ -260,15 +253,3 @@ Dependencies defined by execution order work as following: require="__some_type_somewhere/id __sample_type/1" __sample_type 2 require="__sample_type/2" __example_type 23 __not_in_order_type 42 - - -SEE ALSO --------- -- `cdist-tutorial(7) `_ -- `cdist-type(7) `_ - - -COPYING -------- -Copyright \(C) 2010-2014 Nico Schottelius. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/docs/man/man7/cdist-messaging.rst b/docs/man/cdist-messaging.rst similarity index 79% rename from docs/man/man7/cdist-messaging.rst rename to docs/man/cdist-messaging.rst index b0d5e3b4..ea35c404 100644 --- a/docs/man/man7/cdist-messaging.rst +++ b/docs/man/cdist-messaging.rst @@ -1,13 +1,7 @@ -cdist-messaging(7) -================== +Messaging +========= -NAME ----- -cdist-messaging - How the initial manifest and types can communication - -Nico Schottelius - -DESCRIPTION +Description ----------- cdist has a simple but powerful way of allowing communication between the initial manifest and types as well as types and types. @@ -27,11 +21,11 @@ This way overwriting any of the two files by accident does not interfere with other types. The order of execution is not defined unless you create dependencies -between the different objects (see cdist-manifest(7)) and thus you +between the different objects (see `cdist manifest `_) and thus you can only react reliably on messages by objects that you depend on. -AVAILABILITY +Availability ------------ Messaging is possible between all **local** scripts: @@ -41,7 +35,7 @@ Messaging is possible between all **local** scripts: - type/gencode-remote -EXAMPLES +Examples -------- When you want to emit a message use: @@ -98,17 +92,3 @@ Restart sshd on changes if grep -q "^__key_value/PermitRootLogin" "$__messages_in"; then echo $restart fi - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-manifest(7) `_ -- `cdist-reference(7) `_ -- `cdist-type(7) `_ - - -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). diff --git a/docs/man/cdist-os.rst b/docs/man/cdist-os.rst new file mode 100644 index 00000000..4f6b4820 --- /dev/null +++ b/docs/man/cdist-os.rst @@ -0,0 +1,16 @@ +Supported Operating Systems +=========================== + +cdist was tested or is know to run on at least + +* `Archlinux `_ +* `Debian `_ +* `CentOS `_ +* `Fedora `_ +* `FreeBSD `_ +* `Gentoo `_ +* `Mac OS X `_ +* `OpenBSD `_ +* `Redhat `_ +* `Ubuntu `_ +* `XenServer `_ diff --git a/docs/man/man7/cdist-quickstart.rst b/docs/man/cdist-quickstart.rst similarity index 82% rename from docs/man/man7/cdist-quickstart.rst rename to docs/man/cdist-quickstart.rst index fd7d2cde..20c33cb8 100644 --- a/docs/man/man7/cdist-quickstart.rst +++ b/docs/man/cdist-quickstart.rst @@ -1,31 +1,18 @@ -cdist-quickstart(7) -=================== +Quickstart +========== -NAME ----- -cdist-quickstart - Jump in and enjoy cdist - -Nico Schottelius - - -INTRODUCTION ------------- This tutorial is aimed at people learning cdist and shows typical approaches as well as gives an easy start into the world of configuration management. -This tutorial assumes you are configuring **localhost**, because -it is always available. Just replace **localhost** with your target -host for real life usage. - - - -QUICK START - GET YOUR HANDS DIRTY NOW --------------------------------------- For those who just want to configure a system with the cdist configuration management and do not need (or want) to understand everything. +This tutorial assumes you are configuring **localhost**, because +it is always available. Just replace **localhost** with your target +host for real life usage. + Cdist uses **ssh** for communication and transportation and usually logs into the **target host** as the **root** user. So you need to configure the **ssh server** @@ -84,15 +71,3 @@ code into your shell to get started and configure localhost:: That's it, you've successfully used cdist to configure your first host! Continue reading the next sections, to understand what you did and how to create a more sophisticated configuration. - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-tutorial(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). diff --git a/docs/man/cdist-reference.rst.sh b/docs/man/cdist-reference.rst.sh index 687394d2..42eced05 100755 --- a/docs/man/cdist-reference.rst.sh +++ b/docs/man/cdist-reference.rst.sh @@ -29,23 +29,17 @@ __cdist_myname=${0##*/}; __cdist_abs_myname="$__cdist_abs_mydir/$__cdist_myname" filename="${__cdist_myname%.sh}" -dest="$__cdist_abs_mydir/man7/$filename" +dest="$__cdist_abs_mydir/$filename" cd "$__cdist_abs_mydir" exec > "$dest" cat << eof -cdist-reference(7) -================== +Reference +========= +Variable, path and type reference for cdist -NAME ----- -cdist-reference - Variable, path and type reference for cdist - -Nico Schottelius - - -EXPLORERS +Explorers --------- The following global explorers are available: @@ -59,7 +53,7 @@ eof cat << eof -PATHS +Paths ----- \$HOME/.cdist The standard cdist configuration directory relative to your home directory @@ -76,10 +70,6 @@ confdir By default it consists of everything in \$HOME/.cdist and cdist/conf/. For more details see cdist(1) -confdir/files/ - Cdist does not care about this directory besides providing access to it. - It is thought to be a general file storage area. - confdir/manifest/init This is the central entry point. It is an executable (+x bit set) shell script that can use @@ -94,11 +84,11 @@ confdir/manifest/* maintain different groups of hosts. confdir/explorer/ - Contains explorers to be run on the target hosts, see cdist-explorer(7). + Contains explorers to be run on the target hosts, see \`cdist explorer \`_. confdir/type/ Contains all available types, which are used to provide - some kind of functionality. See cdist-type(7). + some kind of functionality. See \`cdist type \`_. confdir/type// Home of the type . @@ -133,7 +123,7 @@ confdir/type//parameter/boolean confdir/type//explorer Location of the type specific explorers. This directory is referenced by the variable __type_explorer (see below). - See cdist-explorer(7). + See \`cdist explorer \`_. confdir/type//files This directory is reserved for user data and will not be used @@ -158,27 +148,28 @@ out/object/ out/object//explorers Output of type specific explorers, per object. -TYPES +Types ----- The following types are available: eof -for type in $(ls man7/cdist-type__*.rst | LC_ALL=C sort); do +# If there is no such file then ls prints error to stderr, +# so redirect stderr to /dev/null. +for type in $(ls man7/cdist-type__*.rst 2>/dev/null | LC_ALL=C sort); do no_dir="${type#man7/}"; no_type="${no_dir#cdist-type}"; name="${no_type%.rst}"; - name_no_underline="$(echo $name | sed 's/^__/\\__/g')" manref="${no_dir%.rst}" man="${manref}(7)" - echo "- $name_no_underline" "(\`${man} <${manref}.html>\`_)" + echo "- $name" "(\`${man} \`_)" done cat << eof -OBJECTS +Objects ------- For object to object communication and tests, the following paths are usable within a object directory: @@ -195,17 +186,13 @@ stdin when the type was called. -ENVIRONMENT VARIABLES (FOR READING) +Environment variables (for reading) ----------------------------------- The following environment variables are exported by cdist: __explorer Directory that contains all global explorers. Available for: initial manifest, explorer, type explorer, shell -__files - Directory that contains content from the "files" subdirectories - from the configuration directories. - Available for: initial manifest, type manifest, type gencode, shell __manifest Directory that contains the initial manifest. Available for: initial manifest, type manifest, shell @@ -240,12 +227,12 @@ __type_explorer Directory that contains the type explorers. Available for: type explorer -ENVIRONMENT VARIABLES (FOR WRITING) +Environment variables (for writing) ----------------------------------- The following environment variables influence the behaviour of cdist: require - Setup dependencies between objects (see cdist-manifest(7)) + Setup dependencies between objects (see \`cdist manifest \`_) CDIST_LOCAL_SHELL Use this shell locally instead of /bin/sh to execute scripts @@ -254,24 +241,14 @@ CDIST_REMOTE_SHELL Use this shell remotely instead of /bin/sh to execute scripts CDIST_OVERRIDE - Allow overwriting type parameters (see cdist-manifest(7)) + Allow overwriting type parameters (see \`cdist manifest \`_) CDIST_ORDER_DEPENDENCY - Create dependencies based on the execution order (see cdist-manifest(7)) + Create dependencies based on the execution order (see \`cdist manifest \`_) CDIST_REMOTE_EXEC Use this command for remote execution (should behave like ssh) CDIST_REMOTE_COPY Use this command for remote copy (should behave like scp) - -SEE ALSO --------- -- \`cdist(1) <../man1/cdist.html>\`_ - - -COPYING -------- -Copyright \(C) 2011-2014 Nico Schottelius. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3). eof diff --git a/docs/man/man7/cdist-remote-exec-copy.rst b/docs/man/cdist-remote-exec-copy.rst similarity index 61% rename from docs/man/man7/cdist-remote-exec-copy.rst rename to docs/man/cdist-remote-exec-copy.rst index b8d54f8f..10a370c7 100644 --- a/docs/man/man7/cdist-remote-exec-copy.rst +++ b/docs/man/cdist-remote-exec-copy.rst @@ -1,15 +1,6 @@ -cdist-remote-exec-copy(7) -========================= +Remote exec and copy commands +============================= -NAME ----- -cdist-remote-exec-copy - How to use remote exec and copy - -Nico Schottelius - - -INTRO ------ Cdist interacts with the target host in two ways: - it executes code (__remote_exec) @@ -30,19 +21,3 @@ For __remote_copy, it must behave like scp. With this simple interface the user can take total control of how cdist interacts with the target when required, while the default implementation remains as simple as possible. - - -EXAMPLES --------- -See cdist/other/examples/remote/ for some example implementations. - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.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). diff --git a/docs/man/man7/cdist-stages.rst b/docs/man/cdist-stages.rst similarity index 77% rename from docs/man/man7/cdist-stages.rst rename to docs/man/cdist-stages.rst index b58bb368..fd19ce0d 100644 --- a/docs/man/man7/cdist-stages.rst +++ b/docs/man/cdist-stages.rst @@ -1,19 +1,13 @@ -cdist-stages(7) -=============== +Execution stages +================ -NAME ----- -cdist-stages - Stages used during configuration deployment - -Nico Schottelius - -DESCRIPTION +Description ----------- Starting the execution of deployment with cdist, cdist passes through different stages. -STAGE 1: TARGET INFORMATION RETRIEVAL +Stage 1: target information retrieval ------------------------------------- In this stage information is collected about the target host using so called explorers. Every existing explorer is run on the target and the output of all @@ -21,7 +15,7 @@ explorers are copied back into the local cache. The results can be used by manifests and types. -STAGE 2: RUN THE INITIAL MANIFEST +Stage 2: run the initial manifest --------------------------------- The initial manifest, which should be used for mappings of hosts to types, is executed. This stage creates objects in a cconfig database that contains @@ -30,7 +24,7 @@ no conflicts may occur, i.e. no object of the same type with the same id may be created, if it has different parameters. -STAGE 3: OBJECT INFORMATION RETRIEVAL +Stage 3: object information retrieval ------------------------------------- Every object is checked whether its type has explorers and if so, these are executed on the target host. The results are transferred back @@ -38,7 +32,7 @@ and can be used in the following stages to decide what changes need to be made on the target to implement the desired state. -STAGE 4: RUN THE OBJECT MANIFEST +Stage 4: run the object manifest -------------------------------- Every object is checked whether its type has a executable manifest. The manifest script may generate and change the created objects. In other words, @@ -52,7 +46,7 @@ may occur during the merge. A conflict would mean that two different objects try to create the same object, which indicates a broken configuration. -STAGE 5: CODE GENERATION +Stage 5: code generation ------------------------ In this stage for every created object its type is checked for executable gencode scripts. The gencode scripts generate the code to be executed on the @@ -60,30 +54,18 @@ target on stdout. If the gencode executables fail, they must print diagnostic messages on stderr and exit non-zero. -STAGE 6: CODE EXECUTION +Stage 6: code execution ----------------------- For every object the resulting code from the previous stage is transferred to the target host and executed there to apply the configuration changes. -STAGE 7: CACHE +Stage 7: cache -------------- The cache stores the information from the current run for later use. -SUMMARY +Summary ------- If, and only if, all the stages complete without an errors, the configuration will be applied to the target. - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-reference(7) `_ - - -COPYING -------- -Copyright \(C) 2010-2012 Nico Schottelius, Steven Armstrong. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/docs/man/cdist-support.rst b/docs/man/cdist-support.rst new file mode 100644 index 00000000..2343500e --- /dev/null +++ b/docs/man/cdist-support.rst @@ -0,0 +1,28 @@ +Support +------- + +IRC +~~~ + +You can join the development ***IRC channel*** +`#cstar on irc.freenode.net `_. + +Mailing list +~~~~~~~~~~~~ + +Bug reports, questions, patches, etc. should be send to the +`cdist mailing list `_. + +Linkedin +~~~~~~~~ + +If you have an account +at `Linked in `_, +you can join the +`cdist group `_. + +Commercial support +~~~~~~~~~~~~~~~~~~ + +You can request commercial support for cdist from +`my company `_. diff --git a/docs/man/man7/cdist-troubleshooting.rst b/docs/man/cdist-troubleshooting.rst similarity index 73% rename from docs/man/man7/cdist-troubleshooting.rst rename to docs/man/cdist-troubleshooting.rst index edfadc34..b016e845 100644 --- a/docs/man/man7/cdist-troubleshooting.rst +++ b/docs/man/cdist-troubleshooting.rst @@ -1,14 +1,7 @@ -cdist-troubleshooting(7) -======================== +Troubleshooting +=============== -NAME ----- -cdist-troubleshooting - Common problems and their solutions - -Nico Schottelius - - -ERROR IN MANIFEST IS NOT CONSIDERED AN ERROR BY CDIST +Error in manifest is not considered an error by cdist ----------------------------------------------------- Situation: You are executing other scripts from a manifest. This script fails, but cdist does not recognise the error. @@ -50,15 +43,3 @@ you write to use the -e flag: % cat ~/.cdist/manifest/special #!/bin/sh -e ... - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-tutorial(7) `_ - - -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). diff --git a/docs/man/man7/cdist-type.rst b/docs/man/cdist-type.rst similarity index 88% rename from docs/man/man7/cdist-type.rst rename to docs/man/cdist-type.rst index 5500d9b3..c75d0a52 100644 --- a/docs/man/man7/cdist-type.rst +++ b/docs/man/cdist-type.rst @@ -1,31 +1,24 @@ -cdist-type(7) -============= +cdist type +========== -NAME ----- -cdist-type - Functionality bundled - -Nico Schottelius - - -SYNOPSIS --------- - -:: - - __TYPE ID --parameter value [--parameter value ...] - __TYPE --parameter value [--parameter value ...] (for singletons) - - -DESCRIPTION +Description ----------- Types are the main component of cdist and define functionality. If you use cdist, you'll write a type for every functionality you would like to use. +Synopsis +-------- -HOW TO USE A TYPE +.. code-block:: sh + + __TYPE ID --parameter value [--parameter value ...] + __TYPE --parameter value [--parameter value ...] (for singletons) + + +How to use a type ----------------- + You can use types from the initial manifest or the type manifest like a normal shell command: @@ -37,10 +30,10 @@ normal shell command: # Ensure tree is installed __package tree --state installed -A list of supported types can be found in the cdist-reference(7) manpage. +A list of supported types can be found in the `cdist reference `_ manpage. -SINGLETON TYPES +Singleton types --------------- If a type is flagged as a singleton, it may be used only once per host. This is useful for types which can be used only once on a @@ -58,7 +51,7 @@ Example: __myfancysingleton --colour green -HOW TO WRITE A NEW TYPE +How to write a new type ----------------------- A type consists of @@ -74,7 +67,7 @@ two underscores (__) to prevent collisions with other executables in $PATH. To implement a new type, create the directory **cdist/conf/type/__NAME**. -DEFINING PARAMETERS +Defining parameters ------------------- Every type consists of required, optional and boolean parameters, which must each be declared in a newline separated file in **parameter/required**, @@ -102,7 +95,7 @@ Example: echo use_ssl >> cdist/conf/type/__nginx_vhost/parameter/boolean -USING PARAMETERS +Using parameters ---------------- The parameters given to a type can be accessed and used in all type scripts (e.g manifest, gencode, explorer). Note that boolean parameters are @@ -138,7 +131,7 @@ Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest) fi -INPUT FROM STDIN +Input from stdin ---------------- Every type can access what has been written on stdin when it has been called. The result is saved into the **stdin** file in the object directory. @@ -168,7 +161,7 @@ In the __file type, stdin is used as source for the file, if - is used for sourc .... -WRITING THE MANIFEST +Writing the manifest -------------------- In the manifest of a type you can use other types, so your type extends their functionality. A good example is the __package type, which in @@ -190,13 +183,13 @@ a shortened version looks like this: __package_$type "$@" As you can see, the type can reference different environment variables, -which are documented in cdist-reference(7). +which are documented in `cdist reference `_. Always ensure the manifest is executable, otherwise cdist will not be able -to execute it. For more information about manifests see cdist-manifest(7). +to execute it. For more information about manifests see `cdist manifest `_. -SINGLETON - ONE INSTANCE ONLY +Singleton - one instance only ----------------------------- If you want to ensure that a type can only be used once per target, you can mark it as a singleton: Just create the (empty) file "singleton" in your type @@ -216,7 +209,7 @@ As you can see, the object ID is omitted, because it does not make any sense, if your type can be used only once. -THE TYPE EXPLORERS +The type explorers ------------------ If a type needs to explore specific details, it can provide type specific explorers, which will be executed on the target for every created object. @@ -238,7 +231,7 @@ client, like this (shortened version from the type __file): fi -WRITING THE GENCODE SCRIPT +Writing the gencode script -------------------------- There are two gencode scripts: **gencode-local** and **gencode-remote**. The output of gencode-local is executed locally, whereas @@ -259,7 +252,7 @@ script, you can write to stderr: echo "touch /etc/cdist-configured" -VARIABLE ACCESS FROM THE GENERATED SCRIPTS +Variable access from the generated scripts ------------------------------------------ In the generated scripts, you have access to the following cdist variables @@ -280,7 +273,7 @@ So when you generate a script with the following content, it will work: fi -HINTS FOR TYPEWRITERS +Hints for typewriters ---------------------- It must be assumed that the target is pretty dumb and thus does not have high level tools like ruby installed. If a type requires specific tools to be present @@ -297,21 +290,8 @@ a folder named "files" within the type (again, because cdist guarantees to never ever touch this folder). -HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST +How to include a type into upstream cdist ----------------------------------------- If you think your type may be useful for others, ensure it works with the -current master branch of cdist and have a look at cdist-hacker(7) on +current master branch of cdist and have a look at `cdist hacking `_ on how to submit it. - -SEE ALSO --------- -- `cdist-explorer(7) `_ -- `cdist-hacker(7) `_ -- `cdist-stages(7) `_ -- `cdist-tutorial(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). diff --git a/docs/man/cdist-types.rst b/docs/man/cdist-types.rst new file mode 100644 index 00000000..d5104667 --- /dev/null +++ b/docs/man/cdist-types.rst @@ -0,0 +1,8 @@ +cdist types +=========== + +.. toctree:: + :titlesonly: + :glob: + + man7/* diff --git a/docs/man/cdist-update.rst b/docs/man/cdist-update.rst new file mode 100644 index 00000000..0b445ba4 --- /dev/null +++ b/docs/man/cdist-update.rst @@ -0,0 +1,188 @@ +How to update cdist +=================== + +Update the git installation +--------------------------- + +To upgrade cdist in the current branch use + +.. code-block:: sh + + git pull + + # Also update the manpages + ./build man + export MANPATH=$MANPATH:$(pwd -P)/doc/man + +If you stay on a version branche (i.e. 1.0, 1.1., ...), nothing should break. +The master branch on the other hand is the development branch and may not be +working, break your setup or eat the tree in your garden. + +Safely upgrading to new versions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To upgrade to **any** further cdist version, you can take the +following procedure to do a safe upgrade: + +.. code-block:: sh + + # Create new branch to try out the update + git checkout -b upgrade_cdist + + # Get latest cdist version in git database + git fetch -v + + # see what will happen on merge - replace + # master with the branch you plan to merge + git diff upgrade_cdist..origin/master + + # Merge the new version + git merge origin/master + +Now you can ensure all custom types work with the new version. +Assume that you need to go back to an older version during +the migration/update, you can do so as follows: + +.. code-block:: sh + + # commit changes + git commit -m ... + + # go back to original branch + git checkout master + +After that, you can go back and continue the upgrade: + +.. code-block:: sh + + # git checkout upgrade_cdist + + +Update the python package +------------------------- + +To upgrade to the lastet version do + +.. code-block:: sh + + pip install --upgrade cdist + +General update instructions +--------------------------- + +Updating from 3.0 to 3.1 +~~~~~~~~~~~~~~~~~~~~~~~~ + +The type **\_\_ssh_authorized_keys** now also manages existing keys, +not only the ones added by cdist. + +Updating from 2.3 to 3.0 +~~~~~~~~~~~~~~~~~~~~~~~~ + +The **changed** attribute of objects has been removed. +Use `messaging `_ instead. + +Updating from 2.2 to 2.3 +~~~~~~~~~~~~~~~~~~~~~~~~ + +No incompatiblities. + +Updating from 2.1 to 2.2 +~~~~~~~~~~~~~~~~~~~~~~~~ + +Starting with 2.2, the syntax for requiring a singleton type changed: +Old format: + +.. code-block:: sh + + require="__singleton_type/singleton" ... + +New format: + +.. code-block:: sh + + require="__singleton_type" ... + +Internally the "singleton" object id was dropped to make life more easy. +You can probably fix your configuration by running the following code +snippet (currently untested, please report back if it works for you): + +.. code-block:: sh + + find ~/.cdist/* -type f -exec sed -i 's,/singleton,,' {} \; + +Updating from 2.0 to 2.1 +~~~~~~~~~~~~~~~~~~~~~~~~ + +Have a look at the update guide for [[2.0 to 2.1|2.0-to-2.1]]. + + * Type **\_\_package* and \_\_process** use --state **present** or **absent**. + The states **removed/installed** and **stopped/running** have been removed. + Support for the new states is already present in 2.0. + * Type **\_\_directory**: Parameter --parents and --recursive are now boolean + The old "yes/no" values need to be removed. + * Type **\_\_rvm_ruby**: Parameter --default is now boolean + The old "yes/no" values need to be removed. + * Type **\_\_rvm_gemset**: Parameter --default is now boolean + The old "yes/no" values need to be removed. + * Type **\_\_addifnosuchline** and **\_\_removeline** have been replaced by **\_\_line** + * The **conf** directory is now located at **cdist/conf**. + You need to migrate your types, explorers and manifests + manually to the new location. + * Replace the variable **\_\_self** by **\_\_object_name** + Support for the variable **\_\_object_name** is already present in 2.0. + * The types **\_\_autofs**, **\_\_autofs_map** and **\_\_autofs_reload** have been removed + (no maintainer, no users) + * Type **\_\_user**: Parameter --groups removed (use the new \_\_user_groups type) + * Type **\_\_ssh_authorized_key** has been replaced by more flexible type + **\_\_ssh_authorized_keys** + +Updating from 1.7 to 2.0 +~~~~~~~~~~~~~~~~~~~~~~~~ + +* Ensure python (>= 3.2) is installed on the source host +* Use "cdist config host" instead of "cdist-deploy-to host" +* Use "cdist config -p host1 host2" instead of "cdist-mass-deploy" +* Use "cdist banner" for fun +* Use **\_\_object_name** instead of **\_\_self** in manifests + +Updating from 1.6 to 1.7 +~~~~~~~~~~~~~~~~~~~~~~~~ + +* If you used the global explorer **hardware_type**, you need to change + your code to use **machine** instead. + +Updating from 1.5 to 1.6 +~~~~~~~~~~~~~~~~~~~~~~~~ + +* If you used **\_\_package_apt --preseed**, you need to use the new + type **\_\_debconf_set_selections** instead. +* The **\_\_package** types accepted either --state deinstalled or + --state uninstaaled. Starting with 1.6, it was made consistently + to --state removed. + +Updating from 1.3 to 1.5 +~~~~~~~~~~~~~~~~~~~~~~~~ + +No incompatiblities. + +Updating from 1.2 to 1.3 +~~~~~~~~~~~~~~~~~~~~~~~~ + +Rename **gencode** of every type to **gencode-remote**. + +Updating from 1.1 to 1.2 +~~~~~~~~~~~~~~~~~~~~~~~~ + +No incompatiblities. + +Updating from 1.0 to 1.1 +~~~~~~~~~~~~~~~~~~~~~~~~ + +In 1.1 the type **\_\_file** was split into **\_\_directory**, **\_\_file** and +**\_\_link**. The parameter **--type** was removed from **\_\_file**. Thus you +need to replace **\_\_file** calls in your manifests: + + * Remove --type from all \_\_file calls + * If type was symlink, use \_\_link and --type symbolic + * If type was directory, use \_\_directory diff --git a/docs/man/cdist-why.rst b/docs/man/cdist-why.rst new file mode 100644 index 00000000..e6aefefd --- /dev/null +++ b/docs/man/cdist-why.rst @@ -0,0 +1,72 @@ +Why should I use cdist? +======================= + +There are several motivations to use cdist, these +are probably the most popular ones. + +Known language +-------------- + +Cdist is being configured in +`shell script `_. +Shell script is used by UNIX system engineers for decades. +So when cdist is introduced, your staff does not need to learn a new +`DSL `_ +or programming language. + +Powerful language +----------------- + +Not only is shell scripting widely known by system engineers, +but it is also a very powerful language. Here are some features +which make daily work easy: + + * Configuration can react dynamicly on explored values + * High level string manipulation (using sed, awk, grep) + * Conditional support (**if, case**) + * Loop support (**for, while**) + * Support for dependencies between cdist types + +More than shell scripting +------------------------- + +If you compare regular shell scripting with cdist, there is one major +difference: When using cdist types, +the results are +`idempotent `_. +In practise that means it does not matter in which order you +call cdist types, the result is always the same. + +Zero dependency configuration management +---------------------------------------- + +Cdist requires very litte on a target system. Even better, +in almost all cases all dependencies are usually fulfilled. +Cdist does not require an agent or a high level programming +languages on the target host: it will run on any host that +has a **ssh server running** and a posix compatible shell +(**/bin/sh**). Compared to other configuration management systems, +it does not require to open up an additional port. + +Push based distribution +----------------------- + +Cdist uses the push based model for configuration. In this +scenario, one (or more) computers connect the target hosts +and apply the configuration. That way the source host has +very little requirements: Cdist can even run on a sysadmin +notebook that is loosely connected to the network and has +limited amount of resources. + +Furthermore, from a security point of view, only one machine +needs access to the target hosts. No target hosts will ever +need to connect back to the source host, which contains the +full configuration. + +Highly scalable +--------------- + +If at some point you manage more hosts than can be handled from +a single source host, you can simply add more resources: Either +add more cores to one host or add hosts. +Cdist will utilise the given resources in parallel. diff --git a/docs/man/conf.py b/docs/man/conf.py index ed43d6d4..24a040b2 100644 --- a/docs/man/conf.py +++ b/docs/man/conf.py @@ -32,6 +32,7 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(os.path.realpath # ones. extensions = [ 'cdist.sphinxext.manpage', + 'sphinx.ext.extlinks', ] # Add any paths that contain templates here, relative to this directory. @@ -309,3 +310,9 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +extlinks = { + 'cdist_docs': + ('http://www.nico.schottelius.org/software/cdist/man/{}/%s.html'.format( + release), None), +} diff --git a/docs/man/index.rst b/docs/man/index.rst index f0638779..a34231f8 100644 --- a/docs/man/index.rst +++ b/docs/man/index.rst @@ -4,9 +4,28 @@ Welcome to cdist documentation Contents: .. toctree:: - :titlesonly: + :maxdepth: 2 :glob: :numbered: - man1/* - man7/* + cdist-intro + cdist-why + cdist-os + cdist-install + cdist-update + cdist-support + cdist-features + cdist-quickstart + man1/cdist + cdist-bootstrap + cdist-manifest + cdist-type + cdist-types + cdist-explorer + cdist-messaging + cdist-reference + cdist-best-practice + cdist-stages + cdist-remote-exec-copy + cdist-hacker + cdist-troubleshooting diff --git a/docs/man/man1/cdist.rst b/docs/man/man1/cdist.rst index f2b4c5d4..2a056482 100644 --- a/docs/man/man1/cdist.rst +++ b/docs/man/man1/cdist.rst @@ -5,8 +5,6 @@ NAME ---- cdist - Usable Configuration Management -Nico Schottelius - SYNOPSIS -------- @@ -179,9 +177,11 @@ The following exit values shall be returned: SEE ALSO -------- -- `cdist-type(7) <../man7/cdist-type.html>`_ -- `cdist-reference(7) <../man7/cdist-reference.html>`_ +Full documentation at: <:cdist_docs:`index`>. +AUTHORS +------- +Nico Schottelius COPYING ------- diff --git a/docs/man/man7/cdist-tutorial.rst b/docs/man/man7/cdist-tutorial.rst deleted file mode 100644 index fece6f36..00000000 --- a/docs/man/man7/cdist-tutorial.rst +++ /dev/null @@ -1,58 +0,0 @@ -cdist-tutorial(7) -================= - -NAME ----- -cdist-tutorial - A guided introduction into cdist - -Nico Schottelius - - -INTRODUCTION ------------- -This document gives you a pointer on what to read in -which order and is thus a "guide to the right locations". -So in case you are just starting, just "begin at the beginning" -(Brave New World). You can see the target audience in [] brackets -after the description. - -cdist-quickstart - New to cdist? Want to get your hands dirty? Read this. [beginner] - -cdist-bootstrap - The comprehensive guide to your first cdist installation [beginner] - -cdist-manifest - Learn how to define which hosts get which configurations [beginner] - -cdist-type - Understand how types are working and created [intermediate] - -cdist-best-practice - Hints from real life experience to help you to organise cdist [intermediate] - -cdist-reference - The type, explorers and environment variables reference [intermediate] - -cdist-explorer - Interested in getting more information about the target system? [intermediate] - -cdist-stages - Understand the internal workflow of cdist. [advanced] - -cdist-hacker - README, if you want to extend or modify cdist. [hacker] - - -SEE ALSO --------- -- `cdist(1) <../man1/cdist.html>`_ -- `cdist-type(7) `_ -- `cdist-best-practice(7) `_ -- `cdist-stages(7) `_ -- Brave New World by Aldous Huxley - -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).