diff --git a/software/cdist.mdwn b/software/cdist.mdwn index aba67707..52471068 100644 --- a/software/cdist.mdwn +++ b/software/cdist.mdwn @@ -106,14 +106,15 @@ how to use cdist. There are at least the following branches available: * master: the development branch - * 1.5: Focus on object orientation instead of global stage orientation + * 1.6: New types, cleaned up \_\_package* types, internal cleanup Old versions: + * 1.5: Focus on object orientation instead of global stage orientation * 1.4: Support for redefiniton of objects (if equal) * 1.3: Support for local and remote code execution (current stable) * 1.2: Dependencies supported - * 1.1: __file to __file, __directory, __link migration + * 1.1: \_\_file to \_\_file, \_\_directory, \_\_link migration * 1.0: First official release Other branches may be available for features or bugfixes, but they @@ -123,7 +124,7 @@ may vanish at any point. To select a specific branch use git checkout -b origin/ # Stay on a specific version - version=1.5 + version=1.6 git checkout -b $version origin/$version ### Mirrors @@ -145,6 +146,14 @@ 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. +### Upgrading 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. + ### Upgrading from 1.3 to 1.5 No incompatiblities. diff --git a/software/cdist/man/cdist-best-practice.html b/software/cdist/man/cdist-best-practice.html index f7f3b1f8..a526813c 100644 --- a/software/cdist/man/cdist-best-practice.html +++ b/software/cdist/man/cdist-best-practice.html @@ -1,6 +1,6 @@ -cdist-best-practice(7)

cdist-best-practice(7)


1. NAME

cdist-best-practice - Practices used in real environments

2. PASSWORDLESS CONNECTIONS

It is recommended to run cdist with public key authentication. +cdist-best-practice(7)

cdist-best-practice(7)


1. NAME

cdist-best-practice - Practices used in real environments

2. 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).

3. SPEEDING UP SSH CONNECTIONS

When connecting to a new host, the initial delay with ssh connections diff --git a/software/cdist/man/cdist-cache.html b/software/cdist/man/cdist-cache.html index 34d0dd07..2a7541f5 100644 --- a/software/cdist/man/cdist-cache.html +++ b/software/cdist/man/cdist-cache.html @@ -1,6 +1,6 @@ -cdist-cache(1)

cdist-cache(1)


1. NAME

cdist-cache - Cache output of last run

2. SYNOPSIS

cdist-cache TARGET_HOST

3. DESCRIPTION

cdist-cache moves away the objects created during last run so the +cdist-cache(1)

cdist-cache(1)


1. NAME

cdist-cache - Cache output of last run

2. SYNOPSIS

cdist-cache TARGET_HOST

3. DESCRIPTION

cdist-cache moves away the objects created during last run so the next run can use the previous information and compare them with the current status.

4. SEE ALSO

cdist(7)

5. 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-code-run.html b/software/cdist/man/cdist-code-run.html index c0388e0c..34d47856 100644 --- a/software/cdist/man/cdist-code-run.html +++ b/software/cdist/man/cdist-code-run.html @@ -1,6 +1,6 @@ -cdist-code-run(1)

cdist-code-run(1)


1. NAME

cdist-code-run - Run explorer remotely

2. SYNOPSIS

cdist-code-run OBJECT_DIR OBJECT TYPE

3. DESCRIPTION

cdist-code-run executes generated code from a given OBJECT. +cdist-code-run(1)

cdist-code-run(1)


1. NAME

cdist-code-run - Run explorer remotely

2. SYNOPSIS

cdist-code-run OBJECT_DIR OBJECT TYPE

3. DESCRIPTION

cdist-code-run executes generated code from a given OBJECT. The OBJECT must be located below OBJECT_DIR. TYPE must be either local or remote and determines which code part is to be executed.

4. SEE ALSO

  • diff --git a/software/cdist/man/cdist-config.html b/software/cdist/man/cdist-config.html index d1d9034f..328e1eef 100644 --- a/software/cdist/man/cdist-config.html +++ b/software/cdist/man/cdist-config.html @@ -1,6 +1,6 @@ -cdist-config(1)

    cdist-config(1)


    1. NAME

    cdist-config - Read basic cdist configuration

    2. DESCRIPTION

    Cdist-config is sourced by cdist programs and provides hints on where to find +cdist-config(1)

    cdist-config(1)


    1. NAME

    cdist-config - Read basic cdist configuration

    2. DESCRIPTION

    Cdist-config is sourced by cdist programs and provides hints on where to find types, manifests, etc. Generally speaking, it’s just usable from within the core and is only of interest for cdist-developers.

    3. SEE ALSO

    cdist(7)

    4. COPYING

    Copyright (C) 2010-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-deploy-to.html b/software/cdist/man/cdist-deploy-to.html index e9c7d555..764d156e 100644 --- a/software/cdist/man/cdist-deploy-to.html +++ b/software/cdist/man/cdist-deploy-to.html @@ -1,9 +1,9 @@ -cdist-deploy-to(1)

    cdist-deploy-to(1)


    1. NAME

    cdist-deploy-to - Deploy configuration to host

    2. SYNOPSIS

    cdist-deploy-to HOSTNAME

    3. DESCRIPTION

    Deploy configurations to the specified host, as configured in the initial +cdist-deploy-to(1)

    cdist-deploy-to(1)


    1. NAME

    cdist-deploy-to - Deploy configuration to host

    2. SYNOPSIS

    cdist-deploy-to HOSTNAME

    3. DESCRIPTION

    Deploy configurations to the specified host, as configured in the initial manifest. This script triggers the execution of several other scripts, in so called stages. It is intented to run either from the command line or from cron.

    4. ENVIRONMENT

    If the environment variable cdist_conf_dir is not set, the -configuration is read from /etc/cdist. The local output directory can +configuration is read from <git-checkout>/conf. The local output directory can be changed by the variable cdist_local_base_dir. All environment variables are handled by cdist-config.

    5. SEE ALSO

    • cdist(7) diff --git a/software/cdist/man/cdist-dir.html b/software/cdist/man/cdist-dir.html index 22e5960a..3284c684 100644 --- a/software/cdist/man/cdist-dir.html +++ b/software/cdist/man/cdist-dir.html @@ -1,6 +1,6 @@ -cdist-dir(1)

      cdist-dir(1)


      1. NAME

      cdist-dir - Poor man’s directory synchronisation

      2. SYNOPSIS

      cdist-dir <push|pull> TARGET_HOST SRC_DIR DST_DIR

      3. DESCRIPTION

      cdist-dir either pushes a local directory to the target host +cdist-dir(1)

      cdist-dir(1)


      1. NAME

      cdist-dir - Poor man’s directory synchronisation

      2. SYNOPSIS

      cdist-dir <push|pull> TARGET_HOST SRC_DIR DST_DIR

      3. DESCRIPTION

      cdist-dir either pushes a local directory to the target host or pulls a remote directory from a target host to the local host.

      In the push case SRC_DIR is local, in the pull case remote. In the push case DST_DIR is remote, in the pull case local.

      cdist-dir does not cleanup DST_DIR and thus it may contain old stuff if used multiple times.

      cdist-dir does not rely on rsync or other high level tools, because diff --git a/software/cdist/man/cdist-env.html b/software/cdist/man/cdist-env.html index 81bc87b9..e5a1e169 100644 --- a/software/cdist/man/cdist-env.html +++ b/software/cdist/man/cdist-env.html @@ -1,6 +1,6 @@ -cdist-env(1)

      cdist-env(1)


      1. NAME

      cdist-env - Setup environment for using cdist

      2. SYNOPSIS

      cdist-env

      3. DESCRIPTION

      cdist-env outputs two strings suitable for usage in your current shell, +cdist-env(1)

      cdist-env(1)


      1. NAME

      cdist-env - Setup environment for using cdist

      2. SYNOPSIS

      cdist-env

      3. DESCRIPTION

      cdist-env outputs two strings suitable for usage in your current shell, so you can use cdist from the checkout. cdist-env essentially helps you to easily setup PATH and MANPATH.

      If you’ve multiple checkouts of cdist and run cdist-env from the various checkouts, a new run will prepend the last directory, thus ensures you diff --git a/software/cdist/man/cdist-explorer-run-global.html b/software/cdist/man/cdist-explorer-run-global.html index 73ba7c3d..2a387850 100644 --- a/software/cdist/man/cdist-explorer-run-global.html +++ b/software/cdist/man/cdist-explorer-run-global.html @@ -1,6 +1,6 @@ -cdist-explorer-run-global(1)

      cdist-explorer-run-global(1)


      1. NAME

      cdist-explorer-run-global - Run the global explorers

      2. SYNOPSIS

      cdist-explorer-run-global HOSTNAME

      3. DESCRIPTION

      Transfer the global explorers to HOSTNAME, execute them and transfer +cdist-explorer-run-global(1)

      cdist-explorer-run-global(1)


      1. NAME

      cdist-explorer-run-global - Run the global explorers

      2. SYNOPSIS

      cdist-explorer-run-global HOSTNAME

      3. DESCRIPTION

      Transfer the global explorers to HOSTNAME, execute them and transfer back the results.

      4. SEE ALSO

      • cdist(7)
      • diff --git a/software/cdist/man/cdist-explorer.html b/software/cdist/man/cdist-explorer.html index 811c3636..abf45edf 100644 --- a/software/cdist/man/cdist-explorer.html +++ b/software/cdist/man/cdist-explorer.html @@ -1,6 +1,6 @@ -cdist-explorer(7)

        cdist-explorer(7)


        1. NAME

        cdist-explorer - Explore the target systems

        2. DESCRIPTION

        Explorer are small shell scripts, which will be executed on the target +cdist-explorer(7)

        cdist-explorer(7)


        1. NAME

        cdist-explorer - Explore the target systems

        2. 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 target system. An explorer outputs the result to stdout, which is usually a one liner, but may be empty or multi line especially in the case of diff --git a/software/cdist/man/cdist-hacker.html b/software/cdist/man/cdist-hacker.html index 45854d77..7c594ce3 100644 --- a/software/cdist/man/cdist-hacker.html +++ b/software/cdist/man/cdist-hacker.html @@ -1,6 +1,6 @@ -cdist-hacker(7)

        cdist-hacker(7)


        1. NAME

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

        2. WELCOME

        Welcome dear hacker! I invite you to a tour of pointers to +cdist-hacker(7)

        cdist-hacker(7)


        1. NAME

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

        2. 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 @@ -31,7 +31,8 @@ Do not add conf/manifest/init - This file should only be touched in your including it.

        6. 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.

        7. SEE ALSO

        • +AND asciidoc is able to compile it (i.e. do NOT have to many "=" in the second +line).

        7. SEE ALSO

        • cdist(7)

        8. 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-manifest-run-init.html b/software/cdist/man/cdist-manifest-run-init.html index 28c38725..f7092afd 100644 --- a/software/cdist/man/cdist-manifest-run-init.html +++ b/software/cdist/man/cdist-manifest-run-init.html @@ -1,6 +1,6 @@ -cdist-manifest-run-init(1)

        cdist-manifest-run-init(1)


        1. NAME

        cdist-manifest-run-init - Run the initial manifest

        2. SYNOPSIS

        cdist-manifest-run-init HOSTNAME

        3. DESCRIPTION

        cdist-manifest-run-init executes the initial manifest, which creates +cdist-manifest-run-init(1)

        cdist-manifest-run-init(1)


        1. NAME

        cdist-manifest-run-init - Run the initial manifest

        2. SYNOPSIS

        cdist-manifest-run-init HOSTNAME

        3. DESCRIPTION

        cdist-manifest-run-init executes the initial manifest, which creates the first objects.

        4. SEE ALSO

        • cdist(7)
        • diff --git a/software/cdist/man/cdist-manifest-run.html b/software/cdist/man/cdist-manifest-run.html index 749c4629..8920c3f1 100644 --- a/software/cdist/man/cdist-manifest-run.html +++ b/software/cdist/man/cdist-manifest-run.html @@ -1,6 +1,6 @@ -cdist-manifest-run(1)

          cdist-manifest-run(1)


          1. NAME

          cdist-manifest-run - Run a given manifest

          2. SYNOPSIS

          cdist-manifest-run HOSTNAME MANIFEST OUTPUT_DIR

          3. DESCRIPTION

          cdist-manifest-run executes the given MANIFEST and saves the output into +cdist-manifest-run(1)

          cdist-manifest-run(1)


          1. NAME

          cdist-manifest-run - Run a given manifest

          2. SYNOPSIS

          cdist-manifest-run HOSTNAME MANIFEST OUTPUT_DIR

          3. DESCRIPTION

          cdist-manifest-run executes the given MANIFEST and saves the output into OUTPUT_DIR.

          4. SEE ALSO

          • cdist(7)
          • diff --git a/software/cdist/man/cdist-manifest.html b/software/cdist/man/cdist-manifest.html index b01d38aa..ca08f5c3 100644 --- a/software/cdist/man/cdist-manifest.html +++ b/software/cdist/man/cdist-manifest.html @@ -1,6 +1,6 @@ -cdist-manifest(7)

            cdist-manifest(7)


            1. NAME

            cdist-manifest - Define types to be used

            2. DESCRIPTION

            Manifests exist to define which configurations should be applied to a specific +cdist-manifest(7)

            cdist-manifest(7)


            1. NAME

            cdist-manifest - Define types to be used

            2. DESCRIPTION

            Manifests exist to define which configurations should be applied to a specific host as well as to define which configurations should be applied within a type. Manifests are executed locally and the resulting objects are stored in an internal database.

            The same object can be redefined in multiple different manifests as long as diff --git a/software/cdist/man/cdist-mass-deploy.html b/software/cdist/man/cdist-mass-deploy.html new file mode 100644 index 00000000..192794e9 --- /dev/null +++ b/software/cdist/man/cdist-mass-deploy.html @@ -0,0 +1,10 @@ + + +cdist-mass-deploy(1)

            cdist-mass-deploy(1)


            1. NAME

            cdist-mass-deploy - Deploy configuration to many hosts

            2. SYNOPSIS

            cdist-mass-deploy [-p] HOSTNAME [HOSTNAME …]

            3. DESCRIPTION

            cdist-mass-deploy is essentially a wrapper around cdist-deploy-to to +be able to deploy to many hosts on one command line.

            4. EXAMPLES

            Deploy in parallel to all hosts specfied in the dsh group configuration ikr, +which is prefixed by "root@":

            cdist-mass-deploy -p $(cat ~/.dsh/group/ikr | sed 's/^root@//')

            5. SEE ALSO

            • +cdist(7) +
            • +cdist-deploy-to(1) +

            6. COPYING

            Copyright (C) 2010-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-object-all.html b/software/cdist/man/cdist-object-all.html new file mode 100644 index 00000000..bc829076 --- /dev/null +++ b/software/cdist/man/cdist-object-all.html @@ -0,0 +1,9 @@ + + +cdist-object-all(1)

            cdist-object-all(1)


            1. NAME

            cdist-object-all - Run the given command on all objects

            2. SYNOPSIS

            cdist-object-all HOSTNAME COMMAND

            3. DESCRIPTION

            Iterates over all defined objects and executes the given command on each +of them.

            4. SEE ALSO

            • +cdist(7) +
            • +cdist-type(1) +

            5. 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-object-code-run.html b/software/cdist/man/cdist-object-code-run.html index b2b56fc8..5bfe4be5 100644 --- a/software/cdist/man/cdist-object-code-run.html +++ b/software/cdist/man/cdist-object-code-run.html @@ -1,9 +1,9 @@ -cdist-object-code-run(1)

            cdist-object-code-run(1)


            1. NAME

            cdist-object-code-run - Execute the generated code for a object

            2. SYNOPSIS

            cdist-object-code-run HOSTNAME OBJECT

            3. DESCRIPTION

            Execute the local and remote code for the given object.

            4. SEE ALSO

            • +cdist-object-code-run(1)

              cdist-object-code-run(1)


              1. NAME

              cdist-object-code-run - Execute the generated code for a object

              2. SYNOPSIS

              cdist-object-code-run HOSTNAME OBJECT

              3. DESCRIPTION

              Execute the local and remote code for the given object.

              4. SEE ALSO

              • cdist(7)
              • -cdist-object-run-all(1) +cdist-object-run(1)
              • cdist-code-run(1)
              • diff --git a/software/cdist/man/cdist-object-explorer-run.html b/software/cdist/man/cdist-object-explorer-run.html index 5c354557..2fab9272 100644 --- a/software/cdist/man/cdist-object-explorer-run.html +++ b/software/cdist/man/cdist-object-explorer-run.html @@ -1,6 +1,6 @@ -cdist-object-explorer-run(1)

                cdist-object-explorer-run(1)


                1. NAME

                cdist-object-explorer-run - Run type explorers for a object

                2. SYNOPSIS

                cdist-object-explorer-run HOSTNAME OBJECT

                3. DESCRIPTION

                Runs the explorers for the given object on the target host.

                4. SEE ALSO

                • +cdist-object-explorer-run(1)

                  cdist-object-explorer-run(1)


                  1. NAME

                  cdist-object-explorer-run - Run type explorers for a object

                  2. SYNOPSIS

                  cdist-object-explorer-run HOSTNAME OBJECT

                  3. DESCRIPTION

                  Runs the explorers for the given object on the target host.

                  4. SEE ALSO

                  • cdist(7)
                  • cdist-deploy-to(1) diff --git a/software/cdist/man/cdist-object-gencode-run.html b/software/cdist/man/cdist-object-gencode-run.html index 3f1a045a..42967bd5 100644 --- a/software/cdist/man/cdist-object-gencode-run.html +++ b/software/cdist/man/cdist-object-gencode-run.html @@ -1,11 +1,11 @@ -cdist-object-gencode-run(1)

                    cdist-object-gencode-run(1)


                    1. NAME

                    cdist-object-gencode-run - Generate code for a object

                    2. SYNOPSIS

                    cdist-object-gencode-run HOSTNAME OBJECT

                    3. DESCRIPTION

                    For the given object, generate the code for local and remote execution.

                    4. SEE ALSO

                    • +cdist-object-gencode-run(1)

                      cdist-object-gencode-run(1)


                      1. NAME

                      cdist-object-gencode-run - Generate code for a object

                      2. SYNOPSIS

                      cdist-object-gencode-run HOSTNAME OBJECT

                      3. DESCRIPTION

                      For the given object, generate the code for local and remote execution.

                      4. SEE ALSO

                      • cdist(7)
                      • cdist-code-run(1)
                      • -cdist-object-run-all(1) +cdist-object-run(1)
                      • cdist-object-gencode(1)

                      5. COPYING

                      Copyright (C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is diff --git a/software/cdist/man/cdist-object-gencode.html b/software/cdist/man/cdist-object-gencode.html index 99d81f27..5f75e575 100644 --- a/software/cdist/man/cdist-object-gencode.html +++ b/software/cdist/man/cdist-object-gencode.html @@ -1,6 +1,6 @@ -cdist-object-gencode(1)

                      cdist-object-gencode(1)


                      1. NAME

                      cdist-object-gencode - Generate code for a given object

                      2. SYNOPSIS

                      cdist-object-gencode HOSTNAME OBJECT

                      3. DESCRIPTION

                      For the given object, run the gencode executable. The output of this +cdist-object-gencode(1)

                      cdist-object-gencode(1)


                      1. NAME

                      cdist-object-gencode - Generate code for a given object

                      2. SYNOPSIS

                      cdist-object-gencode HOSTNAME OBJECT

                      3. DESCRIPTION

                      For the given object, run the gencode executable. The output of this executable on stdout will be used by cdist-object-gencode-all(1).

                      4. SEE ALSO

                      • cdist(7)
                      • diff --git a/software/cdist/man/cdist-object-manifest-run.html b/software/cdist/man/cdist-object-manifest-run.html index 0f3eae9c..660d691a 100644 --- a/software/cdist/man/cdist-object-manifest-run.html +++ b/software/cdist/man/cdist-object-manifest-run.html @@ -1,6 +1,6 @@ -cdist-object-manifest-run(1)

                        cdist-object-manifest-run(1)


                        1. NAME

                        cdist-object-manifest-run - Run an objects manifest

                        2. SYNOPSIS

                        cdist-object-manifest-run HOSTNAME OBJECT

                        3. DESCRIPTION

                        Run the manifest for the given object.

                        4. SEE ALSO

                        • +cdist-object-manifest-run(1)

                          cdist-object-manifest-run(1)


                          1. NAME

                          cdist-object-manifest-run - Run an objects manifest

                          2. SYNOPSIS

                          cdist-object-manifest-run HOSTNAME OBJECT

                          3. DESCRIPTION

                          Run the manifest for the given object.

                          4. SEE ALSO

                          • cdist(7)
                          • cdist-deploy-to(1) diff --git a/software/cdist/man/cdist-object-prepare.html b/software/cdist/man/cdist-object-prepare.html new file mode 100644 index 00000000..9d9ac9b7 --- /dev/null +++ b/software/cdist/man/cdist-object-prepare.html @@ -0,0 +1,16 @@ + + +cdist-object-prepare(1)

                            cdist-object-prepare(1)


                            1. NAME

                            cdist-object-prepare - Prepare an object

                            2. SYNOPSIS

                            cdist-object-prepare HOSTNAME OBJECT

                            3. DESCRIPTION

                            Prepare the given object by running it through stage 3 (object information +retrieval) and stage 4 (run the object manifest). +See related man pages for details.

                            4. SEE ALSO

                            • +cdist(7) +
                            • +cdist-stages(7) +
                            • +cdist-object-explorer-run(1) +
                            • +cdist-object-manifest-run(1) +
                            • +cdist-type(1) +

                            5. 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-object-push.html b/software/cdist/man/cdist-object-push.html index b4d97928..24094dba 100644 --- a/software/cdist/man/cdist-object-push.html +++ b/software/cdist/man/cdist-object-push.html @@ -1,9 +1,9 @@ -cdist-object-push(1)

                            cdist-object-push(1)


                            1. NAME

                            cdist-object-push - Transfer a object to the target host

                            2. SYNOPSIS

                            cdist-object-push HOSTNAME OBJECT

                            3. DESCRIPTION

                            Transfers the given object to the target host.

                            4. SEE ALSO

                            • +cdist-object-push(1)

                              cdist-object-push(1)


                              1. NAME

                              cdist-object-push - Transfer a object to the target host

                              2. SYNOPSIS

                              cdist-object-push HOSTNAME OBJECT

                              3. DESCRIPTION

                              Transfers the given object to the target host.

                              4. SEE ALSO

                              • cdist(7)
                              • -cdist-object-run-all(1) +cdist-object-run(1)
                              • cdist-type(1)

                              5. COPYING

                              Copyright (C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is diff --git a/software/cdist/man/cdist-object-run-all.html b/software/cdist/man/cdist-object-run-all.html index 5d6dc084..4a1161b2 100644 --- a/software/cdist/man/cdist-object-run-all.html +++ b/software/cdist/man/cdist-object-run-all.html @@ -1,6 +1,6 @@ -cdist-object-run-all(1)

                              cdist-object-run-all(1)


                              1. NAME

                              cdist-object-run-all - Run all created objects on the target host

                              2. SYNOPSIS

                              cdist-object-run-all HOSTNAME

                              3. DESCRIPTION

                              Transfers type explorers to the target then runs cdist-object-run(1) +cdist-object-run-all(1)

                              cdist-object-run-all(1)


                              1. NAME

                              cdist-object-run-all - Run all created objects on the target host

                              2. SYNOPSIS

                              cdist-object-run-all HOSTNAME

                              3. DESCRIPTION

                              Transfers type explorers to the target then runs cdist-object-run(1) for each created object.

                              4. SEE ALSO

                              • cdist(7)
                              • diff --git a/software/cdist/man/cdist-object-run.html b/software/cdist/man/cdist-object-run.html index ac5ad976..ec9ea223 100644 --- a/software/cdist/man/cdist-object-run.html +++ b/software/cdist/man/cdist-object-run.html @@ -1,11 +1,11 @@ -cdist-object-run(1)

                                cdist-object-run(1)


                                1. NAME

                                cdist-object-run - Run an object

                                2. SYNOPSIS

                                cdist-object-run HOSTNAME OBJECT

                                3. DESCRIPTION

                                Runs the given object on the given target host. -The different subtasks are dispatched to specialized exectuables. +cdist-object-run(1)

                                cdist-object-run(1)


                                1. NAME

                                cdist-object-run - Run an object

                                2. SYNOPSIS

                                cdist-object-run HOSTNAME OBJECT

                                3. DESCRIPTION

                                Applies the given object on the target host by running it through stage 5 +(code generation) and stage 6 (code execution). See related man pages for details.

                                4. SEE ALSO

                                • cdist(7)
                                • -cdist-object-explorer-run(1) +cdist-stages(7)
                                • cdist-object-gencode-run(1)
                                • @@ -14,5 +14,5 @@ cdist-object-push(1) cdist-object-code-run(1)
                                • cdist-type(1) -

                                5. COPYING

                                Copyright (C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is +

                              5. 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-quickstart.html b/software/cdist/man/cdist-quickstart.html index d0fa33a7..24a7413f 100644 --- a/software/cdist/man/cdist-quickstart.html +++ b/software/cdist/man/cdist-quickstart.html @@ -1,6 +1,6 @@ -cdist-quickstart(1)

                              cdist-quickstart(1)


                              1. NAME

                              cdist-quickstart - Make use of cinit in 5 minutes

                              2. SYNOPSIS

                              cdist-quickstart

                              3. DESCRIPTION

                              cdist-quickstart is an interactive guide to cdist. It should be one +cdist-quickstart(1)

                              cdist-quickstart(1)


                              1. NAME

                              cdist-quickstart - Make use of cinit in 5 minutes

                              2. SYNOPSIS

                              cdist-quickstart

                              3. DESCRIPTION

                              cdist-quickstart is an interactive guide to cdist. It should be one of the first tools you use when you begin with cdist.

                              4. EXAMPLES

                              To use cdist-quickstart, add the bin directory to your PATH, execute cdist-quickstart and enjoy cdist:

                              # Bourne shell example
                               export PATH=$(pwd -P)/bin:$PATH
                              diff --git a/software/cdist/man/cdist-reference.html b/software/cdist/man/cdist-reference.html
                              index bc2076c4..f39da8e2 100644
                              --- a/software/cdist/man/cdist-reference.html
                              +++ b/software/cdist/man/cdist-reference.html
                              @@ -1,19 +1,24 @@
                               
                               
                              -cdist-reference(7)

                              cdist-reference(7)


                              1. NAME

                              cdist-reference - Variable, path and type reference for cdist

                              2. DESCRIPTION

                              Various scripts which are not in the core need information on how -to find information. This manpage summarises the available environment -variables, types and paths and clearifies with part may access which variables.

                              3. PATHS

                              If not specified otherwise, all paths are relative to the checkout directory.

                              +cdist-reference(7)

                              cdist-reference(7)


                              1. NAME

                              cdist-reference - Variable, path and type reference for cdist

                              2. DESCRIPTION

                              This reference summarises

                              • +environment variables +
                              • +paths +
                              • +types +

                              3. PATHS

                              If not specified otherwise, all paths are relative to the checkout directory.

                              conf/
                              Contains the (static) configuration like manifests, types and explorers.
                              conf/manifest/init -

                              +

                              This is the central entry point used by cdist-manifest-init(1). It is an executable (+x bit set) shell script that can use values from the explorers to decide which configuration to create for the specified target host. -

                              It should be primary used to define mapping from configurations to hosts.
                              + It should be primary used to define mapping from configurations to hosts. +
                              conf/manifest/*
                              All other files in this directory are not directly used by cdist, but you @@ -59,14 +64,17 @@ conf/type/<name>/parameters/optional Parameters optionally accepted by type, \n seperated list.
                              conf/type/<name>/explorer -

                              +

                              Location of the type specific explorers. -

                              This directory is referenced by the variable __type_explorer (see below).
                              See cdist-explorer(7).
                              + This directory is referenced by the variable __type_explorer (see below). + See cdist-explorer(7). +
                              out/ -

                              +

                              This directory contains output of cdist and is usually located in a temporary directory and thus will be removed after the run. -

                              This directory is referenced by the variable __global (see below).
                              + This directory is referenced by the variable __global (see below). +
                              out/explorer
                              Output of general explorers. @@ -76,9 +84,10 @@ out/object Objects created for the host.
                              out/object/<object> -

                              +

                              Contains all object specific information. -

                              This directory is referenced by the variable __object (see below).
                              + This directory is referenced by the variable __object (see below). +
                              out/object/<object>/explorers
                              Output of type specific explorers, per object. @@ -88,8 +97,41 @@ tmp_dir A tempdir and a tempfile is used by cdist internally, which will be removed when the scripts end automatically. See cdist-config(1). -

                              4. TYPES

                              The available types are listed in the SEE ALSO section -and are referenced as cdist-type__TYPENAME.

                              5. VARIABLES

                              +

                              4. TYPES

                              The following types are available:

                              • +addifnosuchline (cdist-typeaddifnosuchline(7)) +
                              • +apt_ppa (cdist-typeapt_ppa(7)) +
                              • +debconf_set_selections (cdist-typedebconf_set_selections(7)) +
                              • +directory (cdist-typedirectory(7)) +
                              • +file (cdist-typefile(7)) +
                              • +group (cdist-typegroup(7)) +
                              • +issue (cdist-typeissue(7)) +
                              • +key_value (cdist-typekey_value(7)) +
                              • +link (cdist-typelink(7)) +
                              • +motd (cdist-typemotd(7)) +
                              • +package_apt (cdist-typepackage_apt(7)) +
                              • +package_pacman (cdist-typepackage_pacman(7)) +
                              • +package (cdist-typepackage(7)) +
                              • +package_yum (cdist-typepackage_yum(7)) +
                              • +process (cdist-typeprocess(7)) +
                              • +removeline (cdist-typeremoveline(7)) +
                              • +user (cdist-typeuser(7)) +

                              5. ENVIRONMENT VARIABLES

                              __explorer
                              Directory that contains all explorers. @@ -141,39 +183,5 @@ __type_explorers Available for: type explorer

                              6. SEE ALSO

                              • cdist(7) -
                              • -cdist-type__addifnosuchline(7) -
                              • -cdist-type__apt_ppa(7) -
                              • -cdist-type__debconf_set_selections(7) -
                              • -cdist-type__directory(7) -
                              • -cdist-type__file(7) -
                              • -cdist-type__group(7) -
                              • -cdist-type__issue(7) -
                              • -cdist-type__key_value(7) -
                              • -cdist-type__link(7) -
                              • -cdist-type__motd(7) -
                              • -cdist-type__package(7) -
                              • -cdist-type__package_apt(7) -
                              • -cdist-type__package_pacman(7) -
                              • -cdist-type__package_yum(7) -
                              • -cdist-type__process(7) -
                              • -cdist-type__removeline(7) -
                              • -cdist-type__user(7)

                              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-remote-explorer-run.html b/software/cdist/man/cdist-remote-explorer-run.html index eb191cbf..9b89f19c 100644 --- a/software/cdist/man/cdist-remote-explorer-run.html +++ b/software/cdist/man/cdist-remote-explorer-run.html @@ -1,6 +1,6 @@ -cdist-remote-explorer-run(1)

                              cdist-remote-explorer-run(1)


                              1. NAME

                              cdist-remote-explorer-run - Run explorer remotely

                              2. SYNOPSIS

                              cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR

                              3. DESCRIPTION

                              cdist-remote-explorer-run is executed on the target. +cdist-remote-explorer-run(1)

                              cdist-remote-explorer-run(1)


                              1. NAME

                              cdist-remote-explorer-run - Run explorer remotely

                              2. SYNOPSIS

                              cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR

                              3. DESCRIPTION

                              cdist-remote-explorer-run is executed on the target. It sets up the variable VARIABLE_NAME to point to the given EXPLORER_DIR and runs all explorer found in EXPLORER_DIR. The output of every run explorer is saved into OUT_DIR.

                              4. SEE ALSO

                              • diff --git a/software/cdist/man/cdist-run-remote.html b/software/cdist/man/cdist-run-remote.html index eaeb140c..7333d190 100644 --- a/software/cdist/man/cdist-run-remote.html +++ b/software/cdist/man/cdist-run-remote.html @@ -1,6 +1,6 @@ -cdist-run-remote(1)

                                cdist-run-remote(1)


                                1. NAME

                                cdist-run-remote - Execute something on the target

                                2. SYNOPSIS

                                cdist-run-remote HOSTNAME EXECUTABLE [ARGUMENTS FOR EXECUTABLE]

                                3. DESCRIPTION

                                cdist-run-remote runs the given executable on the remote host. +cdist-run-remote(1)

                                cdist-run-remote(1)


                                1. NAME

                                cdist-run-remote - Execute something on the target

                                2. SYNOPSIS

                                cdist-run-remote HOSTNAME EXECUTABLE [ARGUMENTS FOR EXECUTABLE]

                                3. DESCRIPTION

                                cdist-run-remote runs the given executable on the remote host. It ensures PATH is setup correctly on the target side.

                                4. SEE ALSO

                                • cdist(7)
                                • diff --git a/software/cdist/man/cdist-stages.html b/software/cdist/man/cdist-stages.html index 4ee0796a..6db7cbf0 100644 --- a/software/cdist/man/cdist-stages.html +++ b/software/cdist/man/cdist-stages.html @@ -1,9 +1,9 @@ -cdist-stages(7)

                                  cdist-stages(7)


                                  1. NAME

                                  cdist-stages - Stages used during configuration deployment

                                  2. DESCRIPTION

                                  Starting the execution of deployment with cdist-deploy-to(1), cdist passes +cdist-stages(7)

                                  cdist-stages(7)


                                  1. NAME

                                  cdist-stages - Stages used during configuration deployment

                                  2. DESCRIPTION

                                  Starting the execution of deployment with cdist-deploy-to(1), cdist passes through different stages, each can be triggered and debugged on its own. -Reading the source of the cdist-deploy-to and cdist-object-run-all executables -shows the scripts responsible for each stage.

                                  3. STAGE 0: INTERNAL PREPERATION

                                  Before running the user facing stages, cdist prepares the target host +Reading the source of the cdist-deploy-to executable shows the scripts +responsible for each stage.

                                  3. STAGE 0: INTERNAL PREPERATION

                                  Before running the user facing stages, cdist prepares the target host to contain cdist binaries and creates a clean environment for the configuration run.

                                  Related documentation: - Source of cdist-deploy-to

                                  4. STAGE 1: TARGET INFORMATION RETRIEVAL

                                  In this stage information is collected about the target host using so called @@ -21,25 +21,23 @@ be created.

                                  Related documentation: - cdist-manifest-run(1) - cdist-manifest(7)

                                  6. STAGE 3: OBJECT INFORMATION RETRIEVAL

                                  Every object is checked whether its type has explorers and if so, these are transfered to the target host and executed. The results are transfered back -and can be used in the following stages to decide what changes need to made +and can be used in the following stages to decide what changes need to be made on the target to implement the desired state.

                                  Related documentation: - cdist-object-explorer-run(1) - cdist-remote-explorer-run(1) - cdist-type(7) - - cdist-explorer(7)

                                  7. STAGE 4: RUN THE OBJECT MANIFEST

                                  Every object is checked whether its type has a manifest file. If the type has -a manifest file and it is executable, it will be executed. The manifest script -may generate and change the created objects. In other words, one type can reuse -other types.

                                  For instance the object apache/www.test.ch is of type apache, which may + - cdist-explorer(7)

                                  7. 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, +one type can reuse other types.

                                  For instance the object apache/www.test.ch is of type apache, which may contain a manifest script, which creates new objects of type __file.

                                  The newly created objects are merged back into the existing tree. No conflicts may occur during the merge. A conflict would mean that two different objects try to create the same object, which indicates a broken configuration.

                                  Related documentation: - cdist-object-manifest-run(1) - cdist-manifest-run(1) - - cdist-type(7)

                                  8. STAGE 5: CODE GENERATION

                                  In this stage for every created objects its type is checked whether it has a -gencode script. If the type has a gencode script and it is executable it will -be executed. This executable should create code to be executed on the target -on stdout. If the gencode executable fails, it must print diagnostic messages -on stderr and exit non-zero.

                                  Related documentation: + - cdist-type(7)

                                  8. 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 +target on stdout. If the gencode executables fail, they must print diagnostic +messages on stderr and exit non-zero.

                                  Related documentation: - cdist-object-gencode-run(1) - cdist-object-gencode(1) - cdist-type(7)

                                  9. STAGE 6: CODE EXECUTION

                                  For every object the resulting code from the previous stage is transferred to diff --git a/software/cdist/man/cdist-type-build-emulation.html b/software/cdist/man/cdist-type-build-emulation.html index 9eed17ab..06999eb6 100644 --- a/software/cdist/man/cdist-type-build-emulation.html +++ b/software/cdist/man/cdist-type-build-emulation.html @@ -1,6 +1,6 @@ -cdist-type-build-emulation(1)

                                  cdist-type-build-emulation(1)


                                  1. NAME

                                  cdist-type-build-emulation - Build executables for types

                                  2. SYNOPSIS

                                  cdist-type-build-emulation OUT_DIR

                                  3. DESCRIPTION

                                  cdist-type-build-emulation creates a link to cdist-type-emulator +cdist-type-build-emulation(1)

                                  cdist-type-build-emulation(1)


                                  1. NAME

                                  cdist-type-build-emulation - Build executables for types

                                  2. SYNOPSIS

                                  cdist-type-build-emulation OUT_DIR

                                  3. DESCRIPTION

                                  cdist-type-build-emulation creates a link to cdist-type-emulator for every TYPE. These links are placed in a OUT_DIR, which is prepended into $PATH. This way the user can use TYPE in the manifests like any other executable.

                                  4. SEE ALSO

                              6. SEE ALSO

                              • cdist-type(7)
                              • cdist-type__package(7) diff --git a/software/cdist/man/cdist-type__package_pacman.html b/software/cdist/man/cdist-type__package_pacman.html index 74db3cd3..80357ef8 100644 --- a/software/cdist/man/cdist-type__package_pacman.html +++ b/software/cdist/man/cdist-type__package_pacman.html @@ -1,10 +1,10 @@ -cdist-type__package_pacman(7)

                                cdist-type__package_pacman(7)


                                1. NAME

                                cdist-type__package_pacman - Manage packages with pacman

                                2. DESCRIPTION

                                Pacman is usually used on the Archlinux distribution to manage +cdist-type__package_pacman(7)

                                cdist-type__package_pacman(7)


                                1. NAME

                                cdist-type__package_pacman - Manage packages with pacman

                                2. DESCRIPTION

                                Pacman is usually used on the Archlinux distribution to manage packages.

                                3. REQUIRED PARAMETERS

                                state
                                - Either "installed" or "deinstalled". + Either "installed" or "removed".

                                4. OPTIONAL PARAMETERS

                                name
                                @@ -16,7 +16,7 @@ __package_pacman zsh --state installed __package_pacman python --state installed --name python2 # Remove obsolete package -__package_pacman puppet --state deinstalled

                                6. SEE ALSO

                                • +__package_pacman puppet --state removed

                                6. SEE ALSO

                                • cdist-type(7)
                                • cdist-type__package(7) diff --git a/software/cdist/man/cdist-type__package_yum.html b/software/cdist/man/cdist-type__package_yum.html index fdec5545..1dbd84f4 100644 --- a/software/cdist/man/cdist-type__package_yum.html +++ b/software/cdist/man/cdist-type__package_yum.html @@ -1,11 +1,11 @@ -cdist-type__package_yum(7)

                                  cdist-type__package_yum(7)


                                  1. NAME

                                  cdist-type__package_yum - Manage packages with yum

                                  2. DESCRIPTION

                                  Yum is usually used on the Fedora distribution to manage packages. +cdist-type__package_yum(7)

                                  cdist-type__package_yum(7)


                                  1. NAME

                                  cdist-type__package_yum - Manage packages with yum

                                  2. DESCRIPTION

                                  Yum is usually used on the Fedora distribution to manage packages. If you specify an unknown package, yum will display the slightly confusing error message "Error: Nothing to do".

                                  3. REQUIRED PARAMETERS

                                  state
                                  - Either "installed" or "deinstalled". + Either "installed" or "removed".

                                  4. OPTIONAL PARAMETERS

                                  name
                                  @@ -17,7 +17,7 @@ __package_yum zsh --state installed __package_yum python --state installed --name python2 # Remove obsolete package -__package_yum puppet --state deinstalled

                                  6. SEE ALSO

                                  • +__package_yum puppet --state removed

                                  6. SEE ALSO

                                  • cdist-type(7)
                                  • cdist-type__package(7) diff --git a/software/cdist/man/cdist-type__process.html b/software/cdist/man/cdist-type__process.html index 4d67204d..4e8fa60f 100644 --- a/software/cdist/man/cdist-type__process.html +++ b/software/cdist/man/cdist-type__process.html @@ -1,6 +1,6 @@ -cdist-type__process(7)

                                    cdist-type__process(7)


                                    1. NAME

                                    cdist-type__process - Start or stop process

                                    2. DESCRIPTION

                                    This cdist type allows you to define the state of a process.

                                    3. REQUIRED PARAMETERS

                                    +cdist-type__process(7)

                                    cdist-type__process(7)


                                    1. NAME

                                    cdist-type__process - Start or stop process

                                    2. DESCRIPTION

                                    This cdist type allows you to define the state of a process.

                                    3. REQUIRED PARAMETERS

                                    state
                                    State of the process: Either stopped or running. diff --git a/software/cdist/man/cdist.html b/software/cdist/man/cdist.html index b890ad5b..6f2f5521 100644 --- a/software/cdist/man/cdist.html +++ b/software/cdist/man/cdist.html @@ -1,6 +1,6 @@ -cdist(7)

                                    cdist(7)


                                    1. NAME

                                    cdist - Configuration management system

                                    2. DESCRIPTION

                                    Cdist is a usable configuration management system. +cdist(7)

                                    cdist(7)


                                    1. NAME

                                    cdist - Configuration management system

                                    2. DESCRIPTION

                                    Cdist is a usable configuration management system. The easiest way to get started with cdist is to initialise the environment and run cdist-quickstart:

                                    eval `./bin/cdist-env` && cdist-quickstart

                                    Cdist configurations are written in the shell scripting language. The mapping of configurations to hosts is defined in so called manifests,