xanderio/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improvements to the english.

Browse source
This commit is contained in:
mhameed 2017-06-30 16:45:14 +01:00
parent adfec76bce
commit b42a6d7431
4 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/src/cdist-best-practice.rst
View file

@ -171,7 +171,7 @@ Templating
} }
EOF EOF
* in the manifest, export the relevant variables and add the following lines in your manifest: * in the manifest, export the relevant variables and add the following lines to your manifest:
.. code-block:: console .. code-block:: console

2
docs/src/cdist-manifest.rst
View file

@ -51,7 +51,7 @@ The **initial manifest** is the entry point for cdist to find out, which
**objects** to configure on the selected host. **objects** to configure on the selected host.
Cdist expects the initial manifest at **cdist/conf/manifest/init**. Cdist expects the initial manifest at **cdist/conf/manifest/init**.
Within this initial manifest you define, which objects should be Within this initial manifest you define which objects should be
created on which host. To distinguish between hosts, you can use the created on which host. To distinguish between hosts, you can use the
environment variable **__target_host** and/or **__target_hostname** and/or environment variable **__target_host** and/or **__target_hostname** and/or
**__target_fqdn**. Let's have a look at a simple example:: **__target_fqdn**. Let's have a look at a simple example::

4
docs/src/cdist-why.rst
View file

@ -42,7 +42,7 @@ Zero dependency configuration management
Cdist requires very little on a target system. Even better, Cdist requires very little on a target system. Even better,
in almost all cases all dependencies are usually fulfilled. in almost all cases all dependencies are usually fulfilled.
Cdist does not require an agent or a high level programming Cdist does not require an agent or high level programming
languages on the target host: it will run on any host that languages on the target host: it will run on any host that
has a **ssh server running** and a posix compatible shell has a **ssh server running** and a posix compatible shell
(**/bin/sh**). Compared to other configuration management systems, (**/bin/sh**). Compared to other configuration management systems,
@ -52,7 +52,7 @@ Push based distribution
----------------------- -----------------------
Cdist uses the push based model for configuration. In this Cdist uses the push based model for configuration. In this
scenario, one (or more) computers connect the target hosts scenario, one (or more) computers connect to the target hosts
and apply the configuration. That way the source host has and apply the configuration. That way the source host has
very little requirements: Cdist can even run on a sysadmin very little requirements: Cdist can even run on a sysadmin
notebook that is loosely connected to the network and has notebook that is loosely connected to the network and has

17
docs/src/man1/cdist.rst
View file

@ -88,8 +88,8 @@ Configure/install one or more hosts.
.. option:: -f HOSTFILE, --file HOSTFILE .. option:: -f HOSTFILE, --file HOSTFILE
Read additional hosts to operate on from specified file Read specified file for a list of additional hosts to operate on
or from stdin if '-' (each host on separate line). or if '-' is given, read stdin (one host per line).
If no host or host file is specified then, by default, If no host or host file is specified then, by default,
read hosts from stdin. For the file format see below. read hosts from stdin. For the file format see below.
@ -134,12 +134,13 @@ Configure/install one or more hosts.
HOSTFILE FORMAT HOSTFILE FORMAT
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
HOSTFILE contains hosts per line. The HOSTFILE contains one host per line.
All characters after and including '#' until the end of line is a comment. A comment is started with '#' and continues to the end of the line.
In a line, all leading and trailing whitespace characters are ignored. Any leading and trailing whitespace on a line is ignored.
Empty lines are ignored/skipped. Empty lines are ignored/skipped.
Hostfile line is processed like the following. First, all comments are
The Hostfile lines are processed as follows. First, all comments are
removed. Then all leading and trailing whitespace characters are stripped. removed. Then all leading and trailing whitespace characters are stripped.
If such a line results in empty line it is ignored/skipped. Otherwise, If such a line results in empty line it is ignored/skipped. Otherwise,
host string is used. host string is used.
@ -275,10 +276,10 @@ options. For more details refer to :strong:`sshd_config`\ (5).
When requirements for the same object are defined in different manifests (see When requirements for the same object are defined in different manifests (see
example below), for example, in init manifest and in some other type manifest example below), for example, in init manifest and in some other type manifest
and those requirements differ then dependency resolver cannot detect and those requirements differ then dependency resolver cannot detect
dependencies right. This happens because cdist cannot prepare all objects first dependencies correctly. This happens because cdist cannot prepare all objects first
and run all objects afterwards. Some object can depend on the result of type and run all objects afterwards. Some object can depend on the result of type
explorer(s) and explorers are executed during object run. cdist will detect explorer(s) and explorers are executed during object run. cdist will detect
such case and write warning message. Example for such a case: such case and display a warning message. An example of such a case:
.. code-block:: sh .. code-block:: sh