Browse Source

Initial commit

merge-requests/1/head
Darko Poljak 3 years ago
commit
cdcab934fc
  1. 19
      .gitignore
  2. 74
      Makefile
  3. 4
      README
  4. 237
      src/Makefile
  5. BIN
      src/_static/cdist-logo.jpeg
  6. BIN
      src/_static/cdist-logo.png
  7. 72
      src/_static/custom.css
  8. 52
      src/_static/pgp-key-EFD2AE4EC36B6901.asc
  9. 24
      src/_templates/layout.html
  10. 9
      src/_templates/navigation.html
  11. 1158
      src/cdist-changelog.rst
  12. 10
      src/cdist-documentation.rst
  13. 48
      src/cdist-features.rst
  14. 150
      src/cdist-install.rst
  15. 110
      src/cdist-manual.rst
  16. 19
      src/cdist-os.rst
  17. 9
      src/cdist-speeches.rst
  18. 26
      src/cdist-support.rst
  19. 188
      src/cdist-upgrade.rst
  20. 72
      src/cdist-why.rst
  21. 315
      src/conf.py
  22. 2
      src/docutils.conf
  23. 72
      src/extra/manuals/2.0.10/man1/cdist.html
  24. 314
      src/extra/manuals/2.0.10/man1/docbook-xsl.css
  25. 126
      src/extra/manuals/2.0.10/man7/cdist-best-practice.html
  26. 77
      src/extra/manuals/2.0.10/man7/cdist-bootstrap.html
  27. 28
      src/extra/manuals/2.0.10/man7/cdist-explorer.html
  28. 43
      src/extra/manuals/2.0.10/man7/cdist-hacker.html
  29. 72
      src/extra/manuals/2.0.10/man7/cdist-manifest.html
  30. 51
      src/extra/manuals/2.0.10/man7/cdist-quickstart.html
  31. 177
      src/extra/manuals/2.0.10/man7/cdist-reference.html
  32. 29
      src/extra/manuals/2.0.10/man7/cdist-stages.html
  33. 54
      src/extra/manuals/2.0.10/man7/cdist-tutorial.html
  34. 106
      src/extra/manuals/2.0.10/man7/cdist-type.html
  35. 25
      src/extra/manuals/2.0.10/man7/cdist-type__addifnosuchline.html
  36. 14
      src/extra/manuals/2.0.10/man7/cdist-type__apt_ppa.html
  37. 6
      src/extra/manuals/2.0.10/man7/cdist-type__apt_update_index.html
  38. 29
      src/extra/manuals/2.0.10/man7/cdist-type__autofs_map.html
  39. 16
      src/extra/manuals/2.0.10/man7/cdist-type__autofs_master.html
  40. 23
      src/extra/manuals/2.0.10/man7/cdist-type__cdistmarker.html
  41. 57
      src/extra/manuals/2.0.10/man7/cdist-type__cron.html
  42. 15
      src/extra/manuals/2.0.10/man7/cdist-type__debconf_set_selections.html
  43. 48
      src/extra/manuals/2.0.10/man7/cdist-type__directory.html
  44. 50
      src/extra/manuals/2.0.10/man7/cdist-type__file.html
  45. 21
      src/extra/manuals/2.0.10/man7/cdist-type__group.html
  46. 13
      src/extra/manuals/2.0.10/man7/cdist-type__issue.html
  47. 40
      src/extra/manuals/2.0.10/man7/cdist-type__key_value.html
  48. 31
      src/extra/manuals/2.0.10/man7/cdist-type__link.html
  49. 30
      src/extra/manuals/2.0.10/man7/cdist-type__mkfs.html
  50. 15
      src/extra/manuals/2.0.10/man7/cdist-type__motd.html
  51. 19
      src/extra/manuals/2.0.10/man7/cdist-type__mysql_database.html
  52. 36
      src/extra/manuals/2.0.10/man7/cdist-type__package.html
  53. 25
      src/extra/manuals/2.0.10/man7/cdist-type__package_apt.html
  54. 21
      src/extra/manuals/2.0.10/man7/cdist-type__package_luarocks.html
  55. 20
      src/extra/manuals/2.0.10/man7/cdist-type__package_opkg.html
  56. 25
      src/extra/manuals/2.0.10/man7/cdist-type__package_pacman.html
  57. 25
      src/extra/manuals/2.0.10/man7/cdist-type__package_pip.html
  58. 38
      src/extra/manuals/2.0.10/man7/cdist-type__package_pkg_freebsd.html
  59. 31
      src/extra/manuals/2.0.10/man7/cdist-type__package_pkg_openbsd.html
  60. 21
      src/extra/manuals/2.0.10/man7/cdist-type__package_rubygem.html
  61. 26
      src/extra/manuals/2.0.10/man7/cdist-type__package_yum.html
  62. 36
      src/extra/manuals/2.0.10/man7/cdist-type__partition_msdos.html
  63. 8
      src/extra/manuals/2.0.10/man7/cdist-type__partition_msdos_apply.html
  64. 14
      src/extra/manuals/2.0.10/man7/cdist-type__postgres_database.html
  65. 27
      src/extra/manuals/2.0.10/man7/cdist-type__postgres_role.html
  66. 44
      src/extra/manuals/2.0.10/man7/cdist-type__process.html
  67. 20
      src/extra/manuals/2.0.10/man7/cdist-type__removeline.html
  68. 20
      src/extra/manuals/2.0.10/man7/cdist-type__rvm.html
  69. 36
      src/extra/manuals/2.0.10/man7/cdist-type__rvm_gem.html
  70. 31
      src/extra/manuals/2.0.10/man7/cdist-type__rvm_gemset.html
  71. 28
      src/extra/manuals/2.0.10/man7/cdist-type__rvm_ruby.html
  72. 17
      src/extra/manuals/2.0.10/man7/cdist-type__ssh_authorized_key.html
  73. 19
      src/extra/manuals/2.0.10/man7/cdist-type__start_on_boot.html
  74. 11
      src/extra/manuals/2.0.10/man7/cdist-type__timezone.html
  75. 41
      src/extra/manuals/2.0.10/man7/cdist-type__user.html
  76. 314
      src/extra/manuals/2.0.10/man7/docbook-xsl.css
  77. 72
      src/extra/manuals/2.0.11/man1/cdist.html
  78. 314
      src/extra/manuals/2.0.11/man1/docbook-xsl.css
  79. 126
      src/extra/manuals/2.0.11/man7/cdist-best-practice.html
  80. 77
      src/extra/manuals/2.0.11/man7/cdist-bootstrap.html
  81. 28
      src/extra/manuals/2.0.11/man7/cdist-explorer.html
  82. 43
      src/extra/manuals/2.0.11/man7/cdist-hacker.html
  83. 72
      src/extra/manuals/2.0.11/man7/cdist-manifest.html
  84. 51
      src/extra/manuals/2.0.11/man7/cdist-quickstart.html
  85. 177
      src/extra/manuals/2.0.11/man7/cdist-reference.html
  86. 29
      src/extra/manuals/2.0.11/man7/cdist-stages.html
  87. 54
      src/extra/manuals/2.0.11/man7/cdist-tutorial.html
  88. 106
      src/extra/manuals/2.0.11/man7/cdist-type.html
  89. 25
      src/extra/manuals/2.0.11/man7/cdist-type__addifnosuchline.html
  90. 14
      src/extra/manuals/2.0.11/man7/cdist-type__apt_ppa.html
  91. 6
      src/extra/manuals/2.0.11/man7/cdist-type__apt_update_index.html
  92. 29
      src/extra/manuals/2.0.11/man7/cdist-type__autofs_map.html
  93. 16
      src/extra/manuals/2.0.11/man7/cdist-type__autofs_master.html
  94. 23
      src/extra/manuals/2.0.11/man7/cdist-type__cdistmarker.html
  95. 57
      src/extra/manuals/2.0.11/man7/cdist-type__cron.html
  96. 15
      src/extra/manuals/2.0.11/man7/cdist-type__debconf_set_selections.html
  97. 48
      src/extra/manuals/2.0.11/man7/cdist-type__directory.html
  98. 50
      src/extra/manuals/2.0.11/man7/cdist-type__file.html
  99. 21
      src/extra/manuals/2.0.11/man7/cdist-type__group.html
  100. 13
      src/extra/manuals/2.0.11/man7/cdist-type__issue.html
  101. Some files were not shown because too many files have changed in this diff Show More

19
.gitignore vendored

@ -0,0 +1,19 @@
# -vim
# Swap
[._]*.s[a-v][a-z]
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]
# Session
Session.vim
# Temporary
*~
# Persistent undo
[._]*.un~
# sphinx build dirs, cache
_build/
dist/

74
Makefile

@ -0,0 +1,74 @@
WEBSITE_SRC_DIR=src
WEBSITE_MAN_PAGE="$(WEBSITE_SRC_DIR)/cdist-manual.rst"
WEBSITE_HTML_DIST_DIR=dist/html
WEBSITE_ARCHIVE=cdist-www.tar.gz
WEBSITE_REMOTE_HOST=staticweb.ungleich.ch
WEBSITE_REMOTE_DIR=/home/services/www/nico/www.cdi.st/www/
WEBSITE_MANUALS_DIR="$(WEBSITE_SRC_DIR)/extra/manuals"
CDIST_DIR=../cdist
CDIST_DOCS_DIR="$(CDIST_DIR)/docs"
CDIST_HELPER="$(CDIST_DIR)/bin/build-helper"
CDIST_CHANGELOG_VERSION=$(shell $(CDIST_HELPER) changelog-version)
CDIST_CHANGELOG_FILE="$(CDIST_DOCS_DIR)/changelog"
CDIST_DOCS_HTML_DIST_DIR="$(CDIST_DOCS_DIR)/dist/html"
CDIST_MAKE_VERSION=make -C "$(CDIST_DIR)" version
CDIST_MAKE_HTML=make -C "$(CDIST_DIR)" html
CDIST_CLEAN_HTML=make -C "$(CDIST_DOCS_DIR)/src" clean
SPHINXW=make -C $(WEBSITE_SRC_DIR) html
SPHINXWC=make -C $(WEBSITE_SRC_DIR) clean
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " website"
@echo " website-no-latest"
@echo " website-publish"
@echo " website-publish-no-latest"
@echo " website-publish-only"
@echo " clean"
################################################################################
# Website
#
# Make cdist html manual.
# Generate rst changelog.
# Create target version manual directory.
# Copy target version manual directory to website.
# Add latest manual page.
# Update latest manual link.
website-prepare:
$(CDIST_MAKE_VERSION)
$(CDIST_MAKE_HTML)
@awk '/^[0-9a-z.]+: [0-9-]+$$/ { print; for(i = 0; i < length; ++i) { printf "~"; }; printf "\n"; next; } { print; }' "$(CDIST_CHANGELOG_FILE)" > "$(WEBSITE_SRC_DIR)/cdist-changelog.rst"
@mkdir -p "$(WEBSITE_MANUALS_DIR)/$(CDIST_CHANGELOG_VERSION)/"
@rsync -a "$(CDIST_DOCS_HTML_DIST_DIR)/" "$(WEBSITE_MANUALS_DIR)/$(CDIST_CHANGELOG_VERSION)/"
website-prepare-latest: website-prepare
@grep '$(CDIST_CHANGELOG_VERSION)' "$(WEBSITE_MAN_PAGE)" || awk 'FNR == 11 { print "* `$(CDIST_CHANGELOG_VERSION) <manuals/$(CDIST_CHANGELOG_VERSION)>`_"; print; next; } /^\* `Latest manual/ { print "* `Latest manual <manuals/$(CDIST_CHANGELOG_VERSION)>`_"; next; } { print; }' "$(WEBSITE_MAN_PAGE)" > "$(WEBSITE_MAN_PAGE)-new" && mv "$(WEBSITE_MAN_PAGE)-new" "$(WEBSITE_MAN_PAGE)" || exit 0
# Build website.
website: website-prepare-latest
$(SPHINXW)
website-no-latest: website-prepare
$(SPHINXW)
website-publish-only:
@cd "$(WEBSITE_HTML_DIST_DIR)" \
&& tar -c -z -f "../$(WEBSITE_ARCHIVE)" . \
&& scp "../$(WEBSITE_ARCHIVE)" "$(WEBSITE_REMOTE_HOST):$(WEBSITE_REMOTE_DIR)" \
&& rm -f "../$(WEBSITE_ARCHIVE)"
@ssh "$(WEBSITE_REMOTE_HOST)" "cd $(WEBSITE_REMOTE_DIR) && tar -x -f $(WEBSITE_ARCHIVE) && rm -f $(WEBSITE_ARCHIVE)"
# Publish static website
website-publish: website website-publish-only
website-publish-no-latest: website-no-latest website-publish-only
clean:
$(CDIST_CLEAN_HTML)
$(SPHINXWC)

4
README

@ -0,0 +1,4 @@
cdist-web
---------
This is a cdist configuration management website.

237
src/Makefile

@ -0,0 +1,237 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = ../dist
# for cache, etc.
_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/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
rm -rf $(_BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cdist-docs.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cdist-docs.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/cdist-docs"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cdist-docs"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b cman $(ALLSPHINXOPTS) $(BUILDDIR)/man
mkdir -p $(BUILDDIR)/man/man1
mkdir -p $(BUILDDIR)/man/man7
mv -f $(BUILDDIR)/man/*.1 $(BUILDDIR)/man/man1/
mv -f $(BUILDDIR)/man/*.7 $(BUILDDIR)/man/man7/
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."

BIN
src/_static/cdist-logo.jpeg

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
src/_static/cdist-logo.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

72
src/_static/custom.css

@ -0,0 +1,72 @@
@import url("alabaster.css");
body {
font-size: 16px;
}
div.body {
min-width: unset;
}
div.body h1 {
font-size: 175%;
}
div.body h2 {
font-size: 150%;
}
div.body h3 {
font-size: 125%;
}
div.body h4 {
font-size: 115%;
}
div.body h5 {
font-size: 110%;
}
div.body h6 {
font-size: 100%;
}
div.document {
margin-top: 30px;
}
div.sphinxsidebar {
margin-left: unset;
}
div.documentwrapper {
float: unset;
}
@media screen and (max-width: 870px) {
div.sphinxsidebar p.logo {
display: block;
}
div.documentwrapper {
margin-top: 50px;
}
div.sphinxsidebar {
margin-left: -25px;
margin-top: -40px;
background: #fff;
}
div.sphinxsidebar a {
color: #444;
}
div.footer {
display: block;
margin: unset;
text-align: left;
font-size: 12px;
}
}

52
src/_static/pgp-key-EFD2AE4EC36B6901.asc

@ -0,0 +1,52 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v2
mQINBFeCnRQBEACoybnhBEubglOHJrZQ8PKcdeQaGZRoTc3cDs84lr6a9HiLeoBO
f8x9fpN4LJbaJOyFJLcvVHHcljvooCLqL5t8/pj7Lyvq1AYuMAeS2Wy19amy3tE5
aYYdN85idE/m81B+nD76URL4UjXm0T9ITNLbSE3cZTh/25fsFLub+CHauuP0zxJJ
4SlWnIvvcx1hg9n0la9M1DwcNSdI9A7bZLHIM3Ixuq8HTXcuuozXvJOxTgKZ6Yfs
UmTW7mMykbcxcNZx9bADj8kJOEf9FlJzalkW3XVGbBBYgwDrqoRGl+gtt5up71cE
N0NSL6+6mNJBW3ek9kI88z2qUlVe5UXZQxe5sgjrcnE2sPJkAjCiYUXhVzjV5Oo1
CZ8m1egZLM4IWwAVg8lTizSozYWm9Rs5BcHRVSbQenXoJffTYJY//UE7sAkAfKCf
vsHCdc1H1yK2OwC418nj/T2Zu8Yt0CWiQT3Sogtqz6R7HgVCmSqEdQl3+VL2hQkk
4s0lSOCtBpe0R700phJ67QsnCB8cGMqfUbYZ9cEppJwPA3X3tZd5BJ2OYFU/qhrM
SJ9konAWxnFkViBz0MCKhVjMh6DsH40xdQQsrXsF2aSwEv3MFw/sj+xt1KIuRE5i
IDrZpbaWVjshoJVH6l4eK01DfxRHRJdj8AyH/xJTQQRal2J4CNWjtl+NzwARAQAB
tDB1bmdsZWljaCBHbWJIICh1bmdsZWljaCBGT1NTKSA8Zm9zc0B1bmdsZWljaC5j
aD6JAjcEEwEIACEFAleCnRQCGwMFCwkIBwIGFQgJCgsCBBYCAwECHgECF4AACgkQ
79KuTsNraQGQ6w//dLuEsGzhqQ4FdYwpTOOfcWB6+i42PGb2TgXzwbx5kgzKv6oi
nGuMlXKfamaqbCQuPRyHxR34VRgJslDcvhIXDhB7ELdi5ib8vpA2bX082Es9cKUB
TSGPtp8y7n9aN9ebu/HWLQu88YdAHEcB8BhSuMmcxGvRM1H2a59lW5WizQ7KUPLt
5a8UeELmf/Xz0k4YLP39ApXHxfis0kbGYBni6f7WsyVw2SBEqiG6Z9XktRcSo0e/
RlZb8FlEQgkZtafmFh2qLS710sll8bcD4Xqktzy4ztUgp6ImtpUY8CwdO9H8VCZK
xCwEIX3W25qAXiV8aFSJ9T4M15dkZivq1vvAEmE0G1zEi8AwI3NGjMXDh61A1yH3
auHdSOPzdlICqZDBDlX70tmzL3MBOBy32DkVMwe5JHlj9RBjrpp/B3wch1La2NND
4tFEzYMYlkDxCjJKpNqGDZO+ZqHA7dOx3sx6XPlGtSyWnFfFPu2bBvrDhyORmMbO
20pLotDXIzJ8qNCsZ6XAiJ1PDeHintxbRwJxERScv3EcvcE/lcxrlS/TX9LbBJPE
0y/JMpXLx+9WdG5KpDCxpuZHVyKkcXP0TAPq/IG+VPo9wTGg6cy///Se2PKBbuMm
X90VVM/C5PYmDjJ+IxZckBm6oXLJSZd0rETrf0G4HQCznnA8oiQbZu1ac/O5Ag0E
V4KdFAEQALoVDmDKujONT1yDT+AFUc2a/IBBU7V5Ut86+ZdiXltKVpQA3Dc17bdt
GS5YqMVnIaKZ7MqRhfo0XeVzyTBzjGLr+2EZdWb51I7JNto/HVZgUOvon9BiMoTK
KUOD8gFlhblCcKd/aVOJXPDzKYfu2jgBmgtcHecbyXRbjlha6l0/jsFJj0VJySQv
pj2AftKtb7mltz5Wfm/FkUfpEYGl2NSucW3bYNe0j6BmQXqRqLupeoSdmWrPT+oa
RXxKfM0Ug43WnNYgXsAwU383pdfmYIzxsV7RRIXZZswNKuMj4XyDp1hvF4++6Nqb
ySsCGWRWYG1TK0yCQyzRYvaaY15W9ZX8q91Qx9R6RksXs8bjDmHKo55z4V3Dy5KG
dwanyatmEwkbcKjFECK84V8zNJDspsLS1BGiUF69qWdU/wREMs4kp0gUC+3Fbguf
u/v4yc87SO9QvIIv2lWp3nRpQC5661+SK4dB2SVYL88Yd+LFoe883qI5GQIFLad+
Q5Y/c305r44VOlACV/EsP01LoHHfSsTeneoBUW8ndoKyE3yJ5LKYUV9caROG4/Wh
hGWulkZTXSUXv8q6rUoCIkJiTPPnozwjtErlGyNGcnG1WR55sRV8SFr/SflnUDh9
tAo+I1xegS+B9W+I89jv3ujkpDVNoST8nb44EZrAq/R0WST48zDHABEBAAGJAh8E
GAEIAAkFAleCnRQCGwwACgkQ79KuTsNraQH7Iw//YclkUN193xbaOho/y4Dj4vk1
/Gl4bRgek5CkeMll2uxvsvaVEhL1fbBOR501kmYKzCynkESWft8FG7LNxLi7t3Y9
XrnvvIqPVGAwD8x1+fj+LWCAOZAcFQ3nPSXRY+aZ545G5Mu24EHKsaBEFiyGlDSY
6+XLJchQEpUwVn3MIk9RKCyYi9pAdofgvHuDbB8fFz2YGyjmBn+WbZCmvTm62AIP
WzaNBx507l9LBObY2teBTFLFOnUmNW0QLNpV8lGlWv/rVGfzqD3VVavRNGcXLkI9
spv4r5ci9tQWwW52Z8fAFMo4yWeeWnS0uk4vKtq3ANwFqFtxLuA8WBy9FYQ/5BR0
RdbI0a/iVN2rJcZxGqUbz22U+4N7g89EmHA40LFsWmIl5duAtXZ3XIlMFzCuXwYf
u9fpLUs6uIdRuVVg/qVJva608hn/7/fEqetbwoHmmSBVUSOQYdMZZ5SyR8zDUbBh
acGOOPRSN7tJG8ycoPSQKQci4fXEpqkBfojalqNKGgJUj+5IWApZWvZV0Z6fFLO7
Q2vd1jXYb4lKv04pfxqfOuOlSy9w6ElNewF4V7jSdGqfitw2lQNXlC1EaoajkiZJ
Evcb9b5HexuJPI3cxyJGZyUYyqk2FF0ztGigbhK986iyKILJB+OqiLbAs3KIgezD
vsomtv+pm41l0JK+Xps=
=/2wY
-----END PGP PUBLIC KEY BLOCK-----

24
src/_templates/layout.html

@ -0,0 +1,24 @@
{%- extends "alabaster/layout.html" %}
{%- block content %}
<div class="document">
{%- block sidebar1 %}{{ sidebar() }}{% endblock %}
{%- block document %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}
<div class="body" role="main">
{% block body %} {% endblock %}
</div>
{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
{%- block sidebar2 %}{% endblock %}
<div class="clearer"></div>
</div>
{%- endblock %}

9
src/_templates/navigation.html

@ -0,0 +1,9 @@
{{ toctree(includehidden=theme_sidebar_includehidden) }}
{% if theme_extra_nav_links %}
<hr />
<ul>
{% for text, uri in theme_extra_nav_links.items() %}
<li class="toctree-l1"><a href="{{ uri }}">{{ text }}</a></li>
{% endfor %}
</ul>
{% endif %}

1158
src/cdist-changelog.rst

File diff suppressed because it is too large Load Diff

10
src/cdist-documentation.rst

@ -0,0 +1,10 @@
Documentation
=============
.. toctree::
:maxdepth: 1
cdist-manual
cdist-os
cdist-speeches
cdist-changelog

48
src/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 separated
+ Sticks completely to the KISS (keep it simple and stupid) paradigm
+ 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 <http://www.openssh.com/>`_ as transport protocol
**Requirements, Simplicity**
Requires only shell and SSH server on the target
**UNIX**
Reuse of existing tools like cat, find, mv, ...
**UNIX, familiar environment, documentation**
Is available as manpages and HTML
**UNIX, simplicity, familiar environment**
cdist is configured in POSIX shell

150
src/cdist-install.rst

@ -0,0 +1,150 @@
How to install cdist
====================
Requirements
-------------
Source Host
~~~~~~~~~~~
This is the machine from which you will configure 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 man pages)
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
From version 4.2.0 cdist tags and github releases are signed.
You can get GPG public key used for signing `here <_static/pgp-key-EFD2AE4EC36B6901.asc>`_.
To install cdist with distutils from cloned repository, first you have to
create version.py:
.. code-block:: sh
make version
Then, as usual, you execute the following command:
.. code-block:: sh
python setup.py install
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 <localbranchname> origin/<branchname>
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 <https://github.com/telmich/cdist>`_
* git://git.code.sf.net/p/cdist/code `sourceforge <https://sourceforge.net/p/cdist/code>`_
Building and using documentation (man and html)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you want to build and use the documentation, run:
.. code-block:: sh
make docs
Documentation comes in two formats, man pages and full HTML
documentation. Documentation is built into distribution's
docs/dist directory. man pages are in docs/dist/man and
HTML documentation in docs/dist/html.
If you want to use man pages, run:
.. code-block:: sh
export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man
Or you can move man pages from docs/dist/man directory to some
other directory and add it to MANPATH.
Full HTML documentation can be accessed at docs/dist/html/index.html.
You can also build only man pages or only html documentation, for
only man pages run:
.. code-block:: sh
make man
for only html documentation run:
.. code-block:: sh
make html
You can also build man pages for types in your ~/.cdist directory:
.. code-block:: sh
make dotman
Built man pages are now in docs/dist/man directory. If you have
some other custom .cdist directory, e.g. /opt/cdist then use:
.. code-block:: sh
make DOT_CDIST_PATH=/opt/cdist dotman
Note that `dotman`-target has to be built before a `make docs`-run, otherwise
the custom man-pages are not picked up.
Python package
~~~~~~~~~~~~~~
Cdist is available as a python package at
`PyPi <http://pypi.python.org/pypi/cdist/>`_. You can install it using
.. code-block:: sh
pip install cdist

110
src/cdist-manual.rst

@ -0,0 +1,110 @@
cdist manual
============
* `Latest manual <manuals/4.11.1>`_
* Checking out **beta** branch, i.e. cdist **trigger** and **preos** functionality?
Find the manual `here <manuals/beta>`_.
**All versions**
* `4.11.1 <manuals/4.11.1>`_
* `4.11.0 <manuals/4.11.0>`_
* `4.10.11 <manuals/4.10.11>`_
* `4.10.10 <manuals/4.10.10>`_
* `4.10.9 <manuals/4.10.9>`_
* `4.10.8 <manuals/4.10.8>`_
* `4.10.7 <manuals/4.10.7>`_
* `4.10.6 <manuals/4.10.6>`_
* `4.10.5 <manuals/4.10.5>`_
* `4.10.4 <manuals/4.10.4>`_
* `4.10.3 <manuals/4.10.3>`_
* `4.10.2 <manuals/4.10.2>`_
* `4.10.1 <manuals/4.10.1>`_
* `4.10.0 <manuals/4.10.0>`_
* `4.9.1 <manuals/4.9.1>`_
* `4.9.0 <manuals/4.9.0>`_
* `4.8.4 <manuals/4.8.4>`_
* `4.8.3 <manuals/4.8.3>`_
* `4.8.2 <manuals/4.8.2>`_
* `4.8.1 <manuals/4.8.1>`_
* `4.8.0 <manuals/4.8.0>`_
* `4.7.3 <manuals/4.7.3>`_
* `4.7.2 <manuals/4.7.2>`_
* `4.7.1 <manuals/4.7.1>`_
* `4.7.0 <manuals/4.7.0>`_
* `4.6.1 <manuals/4.6.1>`_
* `4.6.0 <manuals/4.6.0>`_
* `4.5.0 <manuals/4.5.0>`_
* `4.4.4 <manuals/4.4.4>`_
* `4.4.3 <manuals/4.4.3>`_
* `4.4.2 <manuals/4.4.2>`_
* `4.4.1 <manuals/4.4.1>`_
* `4.4.0 <manuals/4.4.0>`_
* `4.3.2 <manuals/4.3.2>`_
* `4.3.1 <manuals/4.3.1>`_
* `4.3.0 <manuals/4.3.0>`_
* `4.2.2 <manuals/4.2.2>`_
* `4.2.1 <manuals/4.2.1>`_
* `4.2.0 <manuals/4.2.0>`_
* `4.1.0 <manuals/4.1.0>`_
* `4.0.0 <manuals/4.0.0>`_
* `4.0.0pre3 <manuals/4.0.0pre3>`_
* `4.0.0pre2 <manuals/4.0.0pre2>`_
* `4.0.0pre1 <manuals/4.0.0pre1>`_
* `3.1.13 <manuals/3.1.13>`_
* `3.1.12 <manuals/3.1.12>`_
* `3.1.11 <manuals/3.1.11>`_
* `3.1.10 <manuals/3.1.10>`_
* `3.1.9 <manuals/3.1.9>`_
* `3.1.8 <manuals/3.1.8>`_
* `3.1.7 <manuals/3.1.7>`_
* `3.1.6 <manuals/3.1.6>`_
* `3.1.5 <manuals/3.1.5>`_
* `3.1.4 <manuals/3.1.4>`_
* `3.1.3 <manuals/3.1.3>`_
* `3.1.2 <manuals/3.1.2>`_
* `3.1.1 <manuals/3.1.1>`_
* `3.1.0 <manuals/3.1.0>`_
* `3.0.9 <manuals/3.0.9>`_
* `3.0.8 <manuals/3.0.8>`_
* `3.0.7 <manuals/3.0.7>`_
* `3.0.6 <manuals/3.0.6>`_
* `3.0.5 <manuals/3.0.5>`_
* `3.0.4 <manuals/3.0.4>`_
* `3.0.3 <manuals/3.0.3>`_
* `3.0.2 <manuals/3.0.2>`_
* `3.0.1 <manuals/3.0.1>`_
* `3.0.0 <manuals/3.0.0>`_
* `2.3.7 <manuals/2.3.7>`_
* `2.3.6 <manuals/2.3.6>`_
* `2.3.5 <manuals/2.3.5>`_
* `2.3.4 <manuals/2.3.4>`_
* `2.3.3 <manuals/2.3.3>`_
* `2.3.2 <manuals/2.3.2>`_
* `2.3.1 <manuals/2.3.1>`_
* `2.3.0 <manuals/2.3.0>`_
* `2.2.0 <manuals/2.2.0>`_
* `2.1.2 <manuals/2.1.2>`_
* `2.1.1 <manuals/2.1.1>`_
* `2.1.0 <manuals/2.1.0>`_
* `2.1.0pre8 <manuals/2.1.0pre8>`_
* `2.1.0pre7 <manuals/2.1.0pre7>`_
* `2.1.0pre6 <manuals/2.1.0pre6>`_
* `2.1.0pre5 <manuals/2.1.0pre5>`_
* `2.1.0pre4 <manuals/2.1.0pre4>`_
* `2.1.0pre3 <manuals/2.1.0pre3>`_
* `2.1.0pre2 <manuals/2.1.0pre2>`_
* `2.1.0pre1 <manuals/2.1.0pre1>`_
* `2.0.15 <manuals/2.0.15>`_
* `2.0.14 <manuals/2.0.14>`_
* `2.0.13 <manuals/2.0.13>`_
* `2.0.12 <manuals/2.0.12>`_
* `2.0.11 <manuals/2.0.11>`_
* `2.0.10 <manuals/2.0.10>`_
* `2.0.9 <manuals/2.0.9>`_
* `2.0.8 <manuals/2.0.8>`_
* `2.0.7 <manuals/2.0.7>`_
* `2.0.6 <manuals/2.0.6>`_
* `2.0.5 <manuals/2.0.5>`_
* `2.0.4 <manuals/2.0.4>`_

19
src/cdist-os.rst

@ -0,0 +1,19 @@
Supported operating systems
===========================
cdist was tested or is know to run on at least
* `Alpine Linux <https://alpinelinux.org>`_
* `Archlinux <http://www.archlinux.org>`_
* `CentOS <http://www.centos.org>`_
* `Debian <http://www.debian.org>`_
* `Devuan <https://devuan.org>`_
* `Fedora <http://fedoraproject.org>`_
* `FreeBSD <http://www.freebsd.org>`_
* `Gentoo <http://www.gentoo.org>`_
* `Mac OS X <http://www.apple.com/macosx>`_
* `NetBSD <https://www.netbsd.org>`_
* `OpenBSD <http://www.openbsd.org>`_
* `Redhat <http://www.redhat.com>`_
* `Ubuntu <http://www.ubuntu.com>`_
* `XenServer <http://www.citrix.com/xenserver>`_

9
src/cdist-speeches.rst

@ -0,0 +1,9 @@
Speeches
========
* `2013-11-22_eth_linux_erfa <speeches/2013-11-22_eth_linux_erfa.pdf>`_
* `2014-05-08_linuxtag_berlin <speeches/2014-05-08_linuxtag_berlin.pdf>`_
* `2014-05-19_cdi.st-zkb_linux_erfa <speeches/2014-05-19_cdi.st-zkb_linux_erfa.pdf>`_
* `2014-06-10_openclouddays_teaser <speeches/2014-06-10_openclouddays_teaser.pdf>`_
* `2014-11-07_sfs_linux_erfa_cdist_web_prototype <speeches/2014-11-07_sfs_linux_erfa_cdist_web_prototype.pdf>`_
* `2014-11-07_sfs_linux_erfa_cdist4 <speeches/2014-11-07_sfs_linux_erfa_cdist4.pdf>`_

26
src/cdist-support.rst

@ -0,0 +1,26 @@
Support
-------
Chat
~~~~
Chat with us: `ungleich chat <https://chat.ungleich.ch/ungleich/channels/cdist>`_.
Mailing list
~~~~~~~~~~~~
Bug reports, questions, patches, etc. should be send to the
`cdist mailing list <https://groups.google.com/forum/#!forum/cdist-configuration-management>`_.
Linkedin
~~~~~~~~
If you have an account
at `Linked in <http://www.linkedin.com/>`_,
you can join the
`cdist group <http://www.linkedin.com/groups/cdist-configuration-management-3952797>`_.
Commercial support
~~~~~~~~~~~~~~~~~~
You can request commercial support for cdist from
`ungleich <http://www.ungleich.ch/>`_.

188
src/cdist-upgrade.rst

@ -0,0 +1,188 @@
How to upgrade 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 </software/cdist/man/3.0.0/man7/cdist-messaging.html>`_ instead.
Updating from 2.2 to 2.3
~~~~~~~~~~~~~~~~~~~~~~~~
No incompatibilities.
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 incompatibilities.
Updating from 1.2 to 1.3
~~~~~~~~~~~~~~~~~~~~~~~~
Rename **gencode** of every type to **gencode-remote**.
Updating from 1.1 to 1.2
~~~~~~~~~~~~~~~~~~~~~~~~
No incompatibilities.
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

72
src/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 <https://en.wikipedia.org/wiki/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 <https://en.wikipedia.org/wiki/Domain-specific_language>`_
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 <https://en.wikipedia.org/wiki/Idempotence>`_.
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 little on a target system. Even better,
in almost all cases all dependencies are usually fulfilled.
Cdist does not require an agent or 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 to 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.

315
src/conf.py

@ -0,0 +1,315 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# cdist-docs documentation build configuration file, created by
# sphinx-quickstart on Fri May 6 21:45:28 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
# sys.path.insert(0, os.path.abspath(os.path.join(
# os.path.dirname(os.path.realpath(__file__)), "..", "..")))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.extlinks',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst']
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'cdist'
copyright = 'ungleich GmbH 2019'
# author = 'Darko Poljak'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version =
# The full version, including alpha/beta/rc tags.
#release =
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {
'logo': 'cdist-logo.jpeg',
'description': 'usable configuration management',
'github_button': False,
'extra_nav_links': {
'github repo': 'https://github.com/ungleich/cdist',
'ungleich Home': 'https://ungleich.ch',
},
'show_powered_by': False,
'sidebar_width' : '300px',
'font_family': 'Raleway',
'head_font_family': 'Raleway',
}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
# html_title = 'cdist-docs v0.0.1'
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico)
# being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
html_static_path = ['_static']
html_style = 'custom.css'
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []
html_extra_path = ['extra', 'speeches', ]
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
# html_last_updated_fmt = None
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# html_file_suffix = ""
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
# htmlhelp_basename =
# -- Options for LaTeX output ---------------------------------------------
# latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
# 'figure_align': 'htbp',
# }
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
# latex_documents = []
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
# root_mandir = os.path.dirname(os.path.realpath(__file__))
# mandirs = []
# for mansubdir in ('man1', 'man7'):
# mandirs.append((os.path.join(root_mandir, mansubdir), mansubdir[-1]))
# man_pages = []
# for mandir, section in mandirs:
# for root, dirs, files in os.walk(mandir):
# for fname in files:
# froot, fext = os.path.splitext(fname)
# if fext == '.rst':
# man_page = (os.path.join('man' + str(section), froot),
# froot, '', [], section)
# man_pages.append(man_page)
# man_pages = [
# ('cdist-type', 'cdist-type', 'cdist-type documentation',
# [author], 1),
# ('man7/cdist-type__file', 'cdist-type__file',
# '', [], 1),
# ('cdist-type__directory', 'cdist-type__directory',
# 'cdist-type__directory documentation', [author], 1),
# ]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
# texinfo_documents = []
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False

2
src/docutils.conf

@ -0,0 +1,2 @@
[parsers]
smart_quotes: false

72
src/extra/manuals/2.0.10/man1/cdist.html

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist(1)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist(1)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25204032"></a>cdist(1)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email">&lt;<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>&gt;</code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_synopsis">2. SYNOPSIS</a></span></dt><dt><span class="section"><a href="#_description">3. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_banner">4. BANNER</a></span></dt><dt><span class="section"><a href="#_config">5. CONFIG</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_environment">7. ENVIRONMENT</a></span></dt><dt><span class="section"><a href="#_exit_status">8. EXIT STATUS</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist - Configuration management</p></div><div class="section" title="2. SYNOPSIS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_synopsis"></a>2. SYNOPSIS</h2></div></div></div><p>cdist [-h] [-V]</p><p>cdist banner</p><p>cdist config [-h] [-d] [-V] [-c CDIST_HOME] [-i MANIFEST] [-p] [-s] host [host …]</p></div><div class="section" title="3. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>3. DESCRIPTION</h2></div></div></div><p>cdist is the frontend executable to the cdist configuration management.
cdist supports different as explained below. The options to the main