From f784ae2c6850005c25588d079fb5bd9cc732f6bb Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Tue, 29 Mar 2011 16:56:24 +0200 Subject: [PATCH] cdist update --- software/cdist.mdwn | 38 ++-- software/cdist/man/cdist-best-practice.html | 2 +- software/cdist/man/cdist-cache.html | 2 +- software/cdist/man/cdist-code-run-all.html | 12 -- software/cdist/man/cdist-code-run.html | 2 +- software/cdist/man/cdist-config.html | 2 +- software/cdist/man/cdist-deploy-to.html | 2 +- software/cdist/man/cdist-dir.html | 2 +- software/cdist/man/cdist-env.html | 2 +- .../cdist/man/cdist-explorer-run-global.html | 2 +- software/cdist/man/cdist-explorer.html | 2 +- software/cdist/man/cdist-hacker.html | 2 +- .../cdist/man/cdist-manifest-run-all.html | 11 -- .../cdist/man/cdist-manifest-run-init.html | 2 +- software/cdist/man/cdist-manifest-run.html | 2 +- software/cdist/man/cdist-manifest.html | 2 +- .../cdist/man/cdist-object-explorer-all.html | 12 -- .../cdist/man/cdist-object-gencode-all.html | 12 -- software/cdist/man/cdist-object-gencode.html | 2 +- software/cdist/man/cdist-quickstart.html | 2 +- software/cdist/man/cdist-reference.html | 175 +----------------- .../cdist/man/cdist-remote-explorer-run.html | 2 +- software/cdist/man/cdist-run-remote.html | 4 +- software/cdist/man/cdist-stages.html | 52 +++--- .../cdist/man/cdist-type-build-emulation.html | 2 +- software/cdist/man/cdist-type-emulator.html | 2 +- software/cdist/man/cdist-type-template.html | 2 +- software/cdist/man/cdist-type.html | 2 +- .../man/cdist-type__addifnosuchline.html | 2 +- software/cdist/man/cdist-type__apt_ppa.html | 2 +- software/cdist/man/cdist-type__directory.html | 2 +- software/cdist/man/cdist-type__file.html | 2 +- software/cdist/man/cdist-type__group.html | 2 +- software/cdist/man/cdist-type__issue.html | 2 +- software/cdist/man/cdist-type__key_value.html | 2 +- software/cdist/man/cdist-type__link.html | 2 +- software/cdist/man/cdist-type__motd.html | 2 +- software/cdist/man/cdist-type__package.html | 2 +- .../cdist/man/cdist-type__package_apt.html | 2 +- .../cdist/man/cdist-type__package_pacman.html | 2 +- software/cdist/man/cdist-type__process.html | 36 ++++ .../cdist/man/cdist-type__removeline.html | 2 +- software/cdist/man/cdist-type__user.html | 2 +- software/cdist/man/cdist.html | 2 +- 44 files changed, 135 insertions(+), 287 deletions(-) delete mode 100644 software/cdist/man/cdist-code-run-all.html delete mode 100644 software/cdist/man/cdist-manifest-run-all.html delete mode 100644 software/cdist/man/cdist-object-explorer-all.html delete mode 100644 software/cdist/man/cdist-object-gencode-all.html create mode 100644 software/cdist/man/cdist-type__process.html diff --git a/software/cdist.mdwn b/software/cdist.mdwn index 48b934f1..3a4b2051 100644 --- a/software/cdist.mdwn +++ b/software/cdist.mdwn @@ -52,22 +52,28 @@ You can [browse the documentation for the latest version online](man) as well. ### Features -Stuff that should probably be included in every configuration management, -but is not. Or: Why I began to write cdist: - - * Speed - * Elegant code - * Clean design + * Elegant code and clean design + * Type and core cleanly seperated + * Small codebase in core * Good documentation (man pages) - * Meaningful error messages - * The no surprise factor * Consistency in behaviour, naming and documentation + * Meaningful error messages + * Either standard error messages from tools or added description for clearification + * The no surprise factor + * No magic guessing of what the user wants + * Simple and well-known DSL + * Posix shell * Easy integration into bare metal installations - * Simple and well-known DSL: posix shell - * It must be very easy to extend and debug cdist - * Focus on reuse of existing functionality (like sh, ssh, find, rm, ...) - * Easy upgrade: ***There is no need to update cdist on target hosts!*** - * cdist only needs to be update on the master server + * requires only ssh + sh + * Easy upgrade + * ***There is no need to update cdist on target hosts!*** + * cdist only needs to be updated on the master server(s) + * Very easy to extend + * Can be done via types, which can be stacked on top of others + * Reuse of existing functionality + * sh, ssh, find, rm, mv, ... + * Very easy to debug + * Just add set -x in the scripts ### OS support @@ -121,10 +127,11 @@ how to use cdist. There are at least the following branches available: * master: the development branch - * 1.4: Support for redefiniton of objects (if equal) + * 1.5: Focus on object orientation instead of global stage orientation Old versions: + * 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 @@ -137,7 +144,8 @@ may vanish at any point. To select a specific branch use git checkout -b origin/ # Stay on a specific version - git checkout -b 1.4 origin/1.4 + version=1.5 + git checkout -b $version origin/$version ### Mirrors diff --git a/software/cdist/man/cdist-best-practice.html b/software/cdist/man/cdist-best-practice.html index 4eea9c93..925794fa 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)

Table of Contents

1. NAME
2. PASSWORDLESS CONNECTIONS
3. SPEEDING UP SSH CONNECTIONS
4. MULTI MASTER OR ENVIRONMENT SETUPS
5. SEE ALSO
6. COPYING

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)

Table of Contents

1. NAME
2. PASSWORDLESS CONNECTIONS
3. SPEEDING UP SSH CONNECTIONS
4. MULTI MASTER OR ENVIRONMENT SETUPS
5. SEE ALSO
6. COPYING

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 b9a2733a..9229be09 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)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

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)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

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-all.html b/software/cdist/man/cdist-code-run-all.html deleted file mode 100644 index c8c1f349..00000000 --- a/software/cdist/man/cdist-code-run-all.html +++ /dev/null @@ -1,12 +0,0 @@ - - -cdist-code-run-all(1)

cdist-code-run-all(1)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

1. NAME

cdist-code-run-all - Execute all generated code on the target

2. SYNOPSIS

cdist-code-run-all HOSTNAME

3. DESCRIPTION

cdist-code-run-all is just a wrapper for cdist-remote-code-run-all.

4. SEE ALSO

  • -cdist(7) -
  • -cdist-deploy-to(1) -
  • -cdist-remote-code-run-all(1) -
  • -cdist-run-remote(1) -

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 f635f8e9..7c22e746 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)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

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)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

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 34f8d09e..d42e7f8f 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)

    Table of Contents

    1. NAME
    2. DESCRIPTION
    3. SEE ALSO
    4. COPYING

    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)

    Table of Contents

    1. NAME
    2. DESCRIPTION
    3. SEE ALSO
    4. COPYING

    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 4833be62..fb741733 100644 --- a/software/cdist/man/cdist-deploy-to.html +++ b/software/cdist/man/cdist-deploy-to.html @@ -1,6 +1,6 @@ -cdist-deploy-to(1)

    cdist-deploy-to(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. ENVIRONMENT
    5. SEE ALSO
    6. COPYING

    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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. ENVIRONMENT
    5. SEE ALSO
    6. COPYING

    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 diff --git a/software/cdist/man/cdist-dir.html b/software/cdist/man/cdist-dir.html index fcf4ba21..ea49ed88 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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    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 d72425dc..a4051698 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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. EXAMPLES
    5. SEE ALSO
    6. COPYING

    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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. EXAMPLES
    5. SEE ALSO
    6. COPYING

    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 cc9735f2..a8f4e4f5 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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    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)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    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 6f208be0..4127e251 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)

      Table of Contents

      1. NAME
      2. DESCRIPTION
      3. EXAMPLES
      4. SEE ALSO
      5. COPYING

      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)

      Table of Contents

      1. NAME
      2. DESCRIPTION
      3. EXAMPLES
      4. SEE ALSO
      5. COPYING

      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 b340b2a7..d9f0d896 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)

      Table of Contents

      1. NAME
      2. WELCOME
      3. UNDERSTANDING CDIST INTERNALS
      4. CODING CONVENTIONS (CORE)
      5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST
      6. HOW TO SUBMIT A NEW TYPE
      7. SEE ALSO
      8. COPYING

      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)

      Table of Contents

      1. NAME
      2. WELCOME
      3. UNDERSTANDING CDIST INTERNALS
      4. CODING CONVENTIONS (CORE)
      5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST
      6. HOW TO SUBMIT A NEW TYPE
      7. SEE ALSO
      8. COPYING

      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 diff --git a/software/cdist/man/cdist-manifest-run-all.html b/software/cdist/man/cdist-manifest-run-all.html deleted file mode 100644 index 9b1604cd..00000000 --- a/software/cdist/man/cdist-manifest-run-all.html +++ /dev/null @@ -1,11 +0,0 @@ - - -cdist-manifest-run-all(1)

      cdist-manifest-run-all(1)

      Table of Contents

      1. NAME
      2. SYNOPSIS
      3. DESCRIPTION
      4. SEE ALSO
      5. COPYING

      1. NAME

      cdist-manifest-run-all - Run manifests of all created types

      2. SYNOPSIS

      cdist-manifest-run-all HOSTNAME

      3. DESCRIPTION

      cdist-manifest-run-all iterates over every existing object and -executes the manifest of its type.

      4. SEE ALSO

      • -cdist(7) -
      • -cdist-deploy-to(1) -
      • -cdist-manifest-run-init(1) -

      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-manifest-run-init.html b/software/cdist/man/cdist-manifest-run-init.html index 4d74047e..3e75152e 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)

      Table of Contents

      1. NAME
      2. SYNOPSIS
      3. DESCRIPTION
      4. SEE ALSO
      5. COPYING

      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)

      Table of Contents

      1. NAME
      2. SYNOPSIS
      3. DESCRIPTION
      4. SEE ALSO
      5. COPYING

      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 94cb513c..9839bac3 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)

        Table of Contents

        1. NAME
        2. SYNOPSIS
        3. DESCRIPTION
        4. SEE ALSO
        5. COPYING

        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)

        Table of Contents

        1. NAME
        2. SYNOPSIS
        3. DESCRIPTION
        4. SEE ALSO
        5. COPYING

        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 beb1f8fc..8b56b788 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)

          Table of Contents

          1. NAME
          2. DESCRIPTION
          3. EXAMPLE
          4. DEPENDENCIES
          5. SEE ALSO
          6. COPYING

          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)

          Table of Contents

          1. NAME
          2. DESCRIPTION
          3. EXAMPLE
          4. DEPENDENCIES
          5. SEE ALSO
          6. COPYING

          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-object-explorer-all.html b/software/cdist/man/cdist-object-explorer-all.html deleted file mode 100644 index 2909c8cd..00000000 --- a/software/cdist/man/cdist-object-explorer-all.html +++ /dev/null @@ -1,12 +0,0 @@ - - -cdist-object-explorer-all(1)

          cdist-object-explorer-all(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-explorer-all - Run type explorer for every object

          2. SYNOPSIS

          cdist-object-explorer-all HOSTNAME

          3. DESCRIPTION

          For every object, it checks whether the type has one or more explorers. -If so, the explorers of the type are copied to the target and executed -once per object.

          4. SEE ALSO

          • -cdist(7) -
          • -cdist-deploy-to(1) -
          • -cdist-remote-explorer-run(1) -

          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-object-gencode-all.html b/software/cdist/man/cdist-object-gencode-all.html deleted file mode 100644 index 81b90616..00000000 --- a/software/cdist/man/cdist-object-gencode-all.html +++ /dev/null @@ -1,12 +0,0 @@ - - -cdist-object-gencode-all(1)

          cdist-object-gencode-all(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-gencode-all - Generate code for every existing object

          2. SYNOPSIS

          cdist-object-gencode-all HOSTNAME

          3. DESCRIPTION

          For every object that exists, the cdist-object-gencode is executed.

          4. SEE ALSO

          • -cdist(7) -
          • -cdist-code-run(1) -
          • -cdist-deploy-to(1) -
          • -cdist-object-gencode(1) -

          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-object-gencode.html b/software/cdist/man/cdist-object-gencode.html index b3df2e3f..09a9dc17 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)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          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)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          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-quickstart.html b/software/cdist/man/cdist-quickstart.html index 389654e9..bbfba5c2 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)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. EXAMPLES
            5. SEE ALSO
            6. COPYING

            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)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. EXAMPLES
            5. SEE ALSO
            6. COPYING

            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 096527a1..2e8fe947 100644
--- a/software/cdist/man/cdist-reference.html
+++ b/software/cdist/man/cdist-reference.html
@@ -1,6 +1,6 @@
 
 
-cdist-reference(7)
            cdist-reference(7)
            Table of Contents
            1. NAME
            2. DESCRIPTION
            3. PATHS
            4. TYPES
            5. VARIABLES
            6. SEE ALSO
            7. COPYING
            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
+cdist-reference(7)
            cdist-reference(7)
            Table of Contents
            1. NAME
            2. DESCRIPTION
            3. PATHS
            4. TYPES
            5. VARIABLES
            6. SEE ALSO
            7. COPYING
            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.
            
 conf/
@@ -89,89 +89,7 @@ tmp_dir
    which will be removed when the scripts end automatically.
    See cdist-config(1).
 
            4. TYPES
            The following types are available:
            • 
-__addifnosuchline
-
            • 
-__addifnosuchline.html
-
            • 
-__addifnosuchline.text
-
            • 
-__apt_ppa
-
            • 
-__apt_ppa.html
-
            • 
-__apt_ppa.text
-
            • 
-__directory
-
            • 
-__directory.html
-
            • 
-__directory.text
-
            • 
-__file
-
            • 
-__file.html
-
            • 
-__file.text
-
            • 
-__group
-
            • 
-__group.html
-
            • 
-__group.text
-
            • 
-__issue
-
            • 
-__issue.html
-
            • 
-__issue.text
-
            • 
-__key_value
-
            • 
-__key_value.html
-
            • 
-__key_value.text
-
            • 
-__link
-
            • 
-__link.html
-
            • 
-__link.text
-
            • 
-__motd
-
            • 
-__motd.html
-
            • 
-__motd.text
-
            • 
-__package
-
            • 
-__package_apt
-
            • 
-__package_apt.html
-
            • 
-__package_apt.text
-
            • 
-__package.html
-
            • 
-__package_pacman
-
            • 
-__package_pacman.html
-
            • 
-__package_pacman.text
-
            • 
-__package.text
-
            • 
-__removeline
-
            • 
-__removeline.html
-
            • 
-__removeline.text
-
            • 
-__user
-
            • 
-__user.html
-
            • 
-__user.text
+__*
 
            5. VARIABLES
            
 __explorer
 
            
@@ -198,6 +116,11 @@ __object_id
    The type unique object id.
    Available for: type manifest, type explorer, type codegen
 
            
+__self
+
            
+   The full qualified name of the current object.
+   Available for: type manifest, type explorer, type codegen
+
            
 __target_host
 
            
    The host we are deploying to.
@@ -220,88 +143,6 @@ __type_explorers
 
            6. SEE ALSO
            • 
 cdist(7)
 
            • 
-cdist-type__addifnosuchline(7)
-
            • 
-cdist-type__addifnosuchline.html(7)
-
            • 
-cdist-type__addifnosuchline.text(7)
-
            • 
-cdist-type__apt_ppa(7)
-
            • 
-cdist-type__apt_ppa.html(7)
-
            • 
-cdist-type__apt_ppa.text(7)
-
            • 
-cdist-type__directory(7)
-
            • 
-cdist-type__directory.html(7)
-
            • 
-cdist-type__directory.text(7)
-
            • 
-cdist-type__file(7)
-
            • 
-cdist-type__file.html(7)
-
            • 
-cdist-type__file.text(7)
-
            • 
-cdist-type__group(7)
-
            • 
-cdist-type__group.html(7)
-
            • 
-cdist-type__group.text(7)
-
            • 
-cdist-type__issue(7)
-
            • 
-cdist-type__issue.html(7)
-
            • 
-cdist-type__issue.text(7)
-
            • 
-cdist-type__key_value(7)
-
            • 
-cdist-type__key_value.html(7)
-
            • 
-cdist-type__key_value.text(7)
-
            • 
-cdist-type__link(7)
-
            • 
-cdist-type__link.html(7)
-
            • 
-cdist-type__link.text(7)
-
            • 
-cdist-type__motd(7)
-
            • 
-cdist-type__motd.html(7)
-
            • 
-cdist-type__motd.text(7)
-
            • 
-cdist-type__package(7)
-
            • 
-cdist-type__package_apt(7)
-
            • 
-cdist-type__package_apt.html(7)
-
            • 
-cdist-type__package_apt.text(7)
-
            • 
-cdist-type__package.html(7)
-
            • 
-cdist-type__package_pacman(7)
-
            • 
-cdist-type__package_pacman.html(7)
-
            • 
-cdist-type__package_pacman.text(7)
-
            • 
-cdist-type__package.text(7)
-
            • 
-cdist-type__removeline(7)
-
            • 
-cdist-type__removeline.html(7)
-
            • 
-cdist-type__removeline.text(7)
-
            • 
-cdist-type__user(7)
-
            • 
-cdist-type__user.html(7)
-
            • 
-cdist-type__user.text(7)
+cdist-type__*(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 b560379a..25adddef 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)
            Table of Contents
            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING
            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)
            Table of Contents
            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING
            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 c11cb9b8..6e96f16e 100644
--- a/software/cdist/man/cdist-run-remote.html
+++ b/software/cdist/man/cdist-run-remote.html
@@ -1,10 +1,10 @@
 
 
-cdist-run-remote(1)
              cdist-run-remote(1)
              Table of Contents
              1. NAME
              2. SYNOPSIS
              3. DESCRIPTION
              4. SEE ALSO
              5. COPYING
              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)
              Table of Contents
              1. NAME
              2. SYNOPSIS
              3. DESCRIPTION
              4. SEE ALSO
              5. COPYING
              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)
 
              • 
-cdist-code-run-all(1)
+cdist-object-code-run(1)
 
              • 
 cdist-deploy-to(1)
 
              • 
diff --git a/software/cdist/man/cdist-stages.html b/software/cdist/man/cdist-stages.html
index 423baf75..bf594d2c 100644
--- a/software/cdist/man/cdist-stages.html
+++ b/software/cdist/man/cdist-stages.html
@@ -1,49 +1,59 @@
 
 
-cdist-stages(7)
                cdist-stages(7)
                Table of Contents
                1. NAME
                2. DESCRIPTION
                3. STAGE 0: INTERNAL PREPERATION
                4. STAGE 1: TARGET INFORMATION RETRIEVAL
                5. STAGE 2: RUN THE INITIAL MANIFEST
                6. STAGE 3: EXECUTION OF TYPES
                7. STAGE 4: CODE GENERATION
                8. STAGE 5: CODE EXECUTION
                9. SUMMARY
                10. SEE ALSO
                11. COPYING
                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)
                Nico Schottelius <nico-cdist--@--schottelius.org>, Steven Armstrong <steven-dist--@--armstrong.cc>
                Table of Contents
                1. NAME
                2. DESCRIPTION
                3. STAGE 0: INTERNAL PREPERATION
                4. STAGE 1: TARGET INFORMATION RETRIEVAL
                5. STAGE 2: RUN THE INITIAL MANIFEST
                6. STAGE 3: OBJECT INFORMATION RETRIEVAL
                7. STAGE 4: RUN THE OBJECT MANIFEST
                8. STAGE 5: CODE GENERATION
                9. STAGE 6: CODE EXECUTION
                10. STAGE 7: CACHE
                11. SUMMARY
                12. SEE ALSO
                13. COPYING
                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 executable shous 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 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
 to contain cdist binaries and creates a clean environment for the
-configuration run.
                Related manpages:
-   - cdist-bin-transfer(1)
                4. STAGE 1: TARGET INFORMATION RETRIEVAL
                In this stage information is collected about the target host using so called
+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
 explorers. Every existing explorer is run on the target and the output of all
 explorers are copied back into the local cache. The results can be used by
-manifests and types.
                Related manpages:
+manifests and types.
                Related documentation:
+   - cdist-explorer-run-global(1)
+   - cdist-remote-explorer-run(1)
    - cdist-explorer(7)
                5. STAGE 2: RUN THE INITIAL MANIFEST
                The initial manifest, which should be used for mappings of hosts to types,
 is executed. This stage creates objects in a cconfig database that contains
 the objects as defined in the manifest for the specific host. In this stage,
 no conflicts may occur, i.e. no object of the same type with the same id may
-be created.
                Related manpages:
-   - cdist-manifest(7)
+be created.
                Related documentation:
+   - cdist-manifest-run-init(1)
    - cdist-manifest-run(1)
-   - cdist-manifest-run-init(1)
                6. STAGE 3: EXECUTION OF TYPES
                Every object is checked whether its type has a manifest file. If the type has
+   - 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
+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
 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 manpages:
+try to create the same object, which indicates a broken configuration.
                Related documentation:
+   - cdist-object-manifest-run(1)
    - cdist-manifest-run(1)
-   - cdist-manifest-run-all(1)
-   - cdist-type(7)
                7. STAGE 4: CODE GENERATION
                In this stage for every created objects its type is checked whether it has a
+   - 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 manpages:
-   - cdist-gencode(1)
-   - cdist-gencode-all(1)
-   - cdist-type(7)
                8. STAGE 5: CODE EXECUTION
                The resulting code from the previous stage is transferred to the target host
-and executed there to apply the configuration changes,
                Related manpages:
-   - cdist-exec-run(1)
-   - cdist-exec-transfer(1)
                9. SUMMARY
                If, and only if, all the stages complete without an errors, the configuration
+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
+the target host and executed there to apply the configuration changes.
                Related documentation:
+   - cdist-object-code-run(1)
+   - cdist-code-run(1)
                10. STAGE 7: CACHE
                The cache stores the information from the current run for later use.
                Related documentation:
+   - cdist-cache(1)
                11. SUMMARY
                If, and only if, all the stages complete without an errors, the configuration
 will be applied to the target. Each stage can also be run individually, though
 dependencies for each stage must be fulfilled and thus the stages must be run
-in correct order.
                10. SEE ALSO
                • 
+in correct order.
                12. SEE ALSO
                • 
 cdist(7)
 
                • 
 cdist-deploy-to(1)
 
                • 
 cdist-reference(7)
-
                11. COPYING
                Copyright (C) 2010-2011 Nico Schottelius. Free use of this software is
+
              13. COPYING
              Copyright (C) 2010-2011 Nico Schottelius, Steven Armstrong. Free use of this software is
 granted under the terms of the GNU General Public License version 3 (GPLv3).
              
diff --git a/software/cdist/man/cdist-type-build-emulation.html b/software/cdist/man/cdist-type-build-emulation.html
index e9f9b525..a83c66ff 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)
              Table of Contents
              1. NAME
              2. SYNOPSIS
              3. DESCRIPTION
              4. SEE ALSO
              5. COPYING
              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)
              Table of Contents
              1. NAME
              2. SYNOPSIS
              3. DESCRIPTION
              4. SEE ALSO
              5. COPYING
              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