diff --git a/software/cdist/man/cdist-best-practise.html b/software/cdist/man/cdist-best-practise.html new file mode 100644 index 00000000..6efe1ff1 --- /dev/null +++ b/software/cdist/man/cdist-best-practise.html @@ -0,0 +1,664 @@ + + + + + +cdist-best-practise(7) + + + + + +
+
+

NAME

+
+

cdist-best-practise - Practises used in real environments

+
+
+
+

PASSWORDLESS CONNECTIONS

+
+

It is recommended to run cdist with public key authentication. +This requires a private/public key pair and the entry +"PermitRootLogin without-password" in the sshd server. +See sshd_config(5) and ssh-keygen(1).

+
+
+
+

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 +"sharing of multiple sessions over a single network connection" +(quote from ssh_config(5)). The following code is suitable for +inclusion into your ~/.ssh/config:

+
+
+
Host *
+  ControlPath ~/.ssh/master-%l-%r@%h:%p
+  ControlMaster auto
+  ControlPersist 10
+
+
+
+
+

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 +control git. For instance if you plan to use the typical three +environments production, integration and development, you can +realise this with git branches:

+
+
+
# Go to cdist checkout
+cd /path/to/cdist
+
+# Create branches
+git branch development
+git branch integration
+git branch production
+
+# Make use of a branch, for instance production
+git checkout production
+
+

Similar if you want to have cdist checked out at multiple machines, +you can clone it multiple times:

+
+
+
machine-a % git clone git://your-git-server/cdist
+machine-b % git clone git://your-git-server/cdist
+
+
+
+
+

SEE ALSO

+
+
    +
  • +

    +cdist(7) +

    +
    • +
+
+
+
+

COPYING

+
+

Copyright (C) 2011 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3).

+
+
+
+
+ + + diff --git a/software/cdist/man/cdist-hacker.html b/software/cdist/man/cdist-hacker.html new file mode 100644 index 00000000..04ae55a8 --- /dev/null +++ b/software/cdist/man/cdist-hacker.html @@ -0,0 +1,676 @@ + + + + + +cdist-hacker(7) + + + + + +
+
+

NAME

+
+

cdist-hacker - How to get (stuff) into cdist

+
+
+
+

WELCOME

+
+

Welcome dear hacker! I invite you to a tour of pointers to +get into the usable configuration mangament system, cdist.

+

The first thing to know is probably that cdist is brought to +you by people who care about how code looks like and who think +twice before merging or implementing a feature: Less features +with good usability are far better than the opposite.

+
+
+
+

UNDERSTANDING CDIST INTERNALS

+
+

IF you are interested in how cdist internally works, you can open +bin/cdist-config and bin/cdist-deploy-to in your favorite editor and +read the scripts bin/cdist-deploy-to calls. The magnificent HACKERS_README +may be of great help as well.

+
+
+
+

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.

+

There are though some requirements to ensure your changes don’t break others +work nor kill the authors brain:

+
    +
  • +

    +Code submission must be done via git +

    +
    • +
  • +

    +Code to be included should be branched of the upstream "master" branch +

    +
    • +
  • +

    +Exception: Bugfixes to a version branch +

    +
    • +
  • +

    +Code submissions must be in your master branch +

    +
    • +
  • +

    +Exception: If you only want a comment on your code, but not an inclusion. +

    +
    • +
+

As soon as your work meets these requirements, you can contact me +(IRC, Mailinglist, Phone, RFC 1149) and I’ll check your code before +including it.

+
+
+
+

HOW TO SUBMIT A NEW TYPE

+
+

Submitting a type works as described above, with the additional requirement +that a corresponding manpage named man.text in asciidoc format with +the manpage-name "cdist-type__NAME" is included in the type directory +AND asciidoc is able to compile it.

+
+
+
+

SEE ALSO

+
+
    +
  • +

    +cdist(7) +

    +
    • +
+
+
+
+

COPYING

+
+

Copyright (C) 2011 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3).

+
+
+
+
+ + + diff --git a/software/cdist/man/cdist-type__apt_ppa.html b/software/cdist/man/cdist-type__apt_ppa.html new file mode 100644 index 00000000..d391ed42 --- /dev/null +++ b/software/cdist/man/cdist-type__apt_ppa.html @@ -0,0 +1,648 @@ + + + + + +cdist-type__apt_ppa(7) + + + + + +
+
+

NAME

+
+

cdist-type__apt_ppa - Manage ppa repositories

+
+
+
+

DESCRIPTION

+
+

This cdist type allows manage ubuntu ppa repositories.

+
+
+
+

REQUIRED PARAMETERS

+
+
+
+state +
+
+

+ The state the ppa should be in, either "enabled" or "disabled". +

+
+
+
+
+
+

OPTIONAL PARAMETERS

+
+

None.

+
+
+
+

EXAMPLES

+
+
+
+
# Enable a ppa repository
+__apt_ppa ppa:sans-intern/missing-bits --state enabled
+
+# Disable a ppa repository
+__apt_ppa ppa:sans-intern/missing-bits --state disabled
+
+
+
+
+

SEE ALSO

+
+
    +
  • +

    +cdist-type(7) +

    +
    • +
+
+
+
+

COPYING

+
+

Copyright (C) 2011 Steven Armstrong. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3).

+
+
+
+
+ + + diff --git a/software/cdist/man/cdist-type__apt_update_index.html b/software/cdist/man/cdist-type__apt_update_index.html new file mode 100644 index 00000000..ecf12129 --- /dev/null +++ b/software/cdist/man/cdist-type__apt_update_index.html @@ -0,0 +1,604 @@ + + + + + + + + + + + +
+

cdist-type__apt_update_index(7)

+
+
+

Steven Armstrong <steven-cdist--@--armstrong.cc>

+

cdist-type__apt_update_index - resynchronize the apt package index

+

This cdist type allows you to resynchronize the package index files from their +sources. In other words, it runs apt-get update.

+

FIXME: currently hard coded to work together with the __apt_ppa type

+

None.

+

None.

+
+
+
__apt_update_index
+
+
    +
  • +

    +cdist-type(7) +

    +
    • +
+

Copyright (C) 2011 Steven Armstrong. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3).

+
+
+
+ + +