cdist doc update
This commit is contained in:
Darko Poljak
parent
27165cbead
commit
83a939f0c2
5 changed files with 89 additions and 116 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
[[!meta title="Documentation"]]
|
[[!meta title="Documentation"]]
|
||||||
|
|
||||||
You can browse the latest
|
You can browse the
|
||||||
[latest version of the manpages](/software/cdist/man/latest) or
|
[latest version of the documentation](/software/cdist/man/latest) or
|
||||||
have a look at [all versions](/software/cdist/man).
|
have a look at [all versions](/software/cdist/man).
|
||||||
|
|
||||||
You can also view [speeches about cdist](/software/cdist/speeches).
|
You can also view [speeches about cdist](/software/cdist/speeches).
|
||||||
|
|
|
||||||
|
|
@ -17,114 +17,6 @@ This is the machine you use to configure the target hosts.
|
||||||
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
|
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
|
||||||
* SSH server
|
* SSH server
|
||||||
|
|
||||||
## Requirement Installation: Python >= 3.2
|
|
||||||
|
|
||||||
Ensure you have at least Python 3.2 or newer installed on
|
|
||||||
the **source host**.
|
|
||||||
You can check this by running **python -V**:
|
|
||||||
|
|
||||||
% python -V
|
|
||||||
Python 3.3.0
|
|
||||||
|
|
||||||
### Archlinux
|
|
||||||
|
|
||||||
Archlinux includes a recent python in the extra repository.
|
|
||||||
You can install it using
|
|
||||||
|
|
||||||
pacman -S python
|
|
||||||
|
|
||||||
### CentOS
|
|
||||||
|
|
||||||
See the "From source" section
|
|
||||||
|
|
||||||
### Debian
|
|
||||||
|
|
||||||
For Debian **wheezy** or newer:
|
|
||||||
|
|
||||||
aptitude install python3
|
|
||||||
|
|
||||||
On **squeeze** you can add following line in **/etc/apt/sources.list**
|
|
||||||
|
|
||||||
deb http://ftp.debian.org/debian wheezy main
|
|
||||||
|
|
||||||
And add pinning entry in **/etc/apt/preferences.d/wheezy**:
|
|
||||||
|
|
||||||
Package: *
|
|
||||||
Pin: release n=wheezy
|
|
||||||
Pin-Priority: 1
|
|
||||||
|
|
||||||
Please be aware that both **openssh-server** and **openssh-client** might be
|
|
||||||
removed on **python3.2** installation. You surely want to reinstall them:
|
|
||||||
|
|
||||||
apt-get install -t wheezy openssh-server openssh-client
|
|
||||||
|
|
||||||
For older Debian versions, installing python 3.2 from source is required.
|
|
||||||
|
|
||||||
If you want to build the cdist manpages:
|
|
||||||
|
|
||||||
aptitude install --without-recommends asciidoc xsltproc
|
|
||||||
|
|
||||||
### Fedora
|
|
||||||
|
|
||||||
Fedora 15 and newer includes a recent python.
|
|
||||||
You can install it using
|
|
||||||
|
|
||||||
yum install python3
|
|
||||||
|
|
||||||
### FreeBSD
|
|
||||||
|
|
||||||
For the port:
|
|
||||||
|
|
||||||
cd /usr/ports/lang/python32/ && make install clean
|
|
||||||
|
|
||||||
For the package:
|
|
||||||
|
|
||||||
pkg_add -r python32
|
|
||||||
|
|
||||||
You can also use any newer version, but at least python 3.2 is required.
|
|
||||||
|
|
||||||
### Gentoo
|
|
||||||
|
|
||||||
Gentoo only provides python 3.2 in testing packages (http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=3&chap=3).
|
|
||||||
If you want to ensure nothing breaks you must set back the python version to what was default before.
|
|
||||||
|
|
||||||
emerge -av =python-3.2.2 --autounmask-write
|
|
||||||
emerge -av =python-3.2.2
|
|
||||||
eselect python list
|
|
||||||
eselect python list set python3.2
|
|
||||||
|
|
||||||
### Max OS X
|
|
||||||
|
|
||||||
You can choose between Homebrew and Macports, either way works:
|
|
||||||
|
|
||||||
[Homebrew](http://mxcl.github.com/homebrew/) variant:
|
|
||||||
|
|
||||||
brew install python3
|
|
||||||
|
|
||||||
[Macports](http://www.macports.org/install.php) variant:
|
|
||||||
|
|
||||||
port install python32
|
|
||||||
ln -s /opt/local/bin/python3.2 /opt/local/bin/python3
|
|
||||||
|
|
||||||
### Redhat
|
|
||||||
|
|
||||||
See the "From source" section
|
|
||||||
|
|
||||||
### From Source
|
|
||||||
|
|
||||||
For those operating systems not yet supporting Python 3.2:
|
|
||||||
|
|
||||||
pyversion=3.2.3
|
|
||||||
wget http://www.python.org/ftp/python/$pyversion/Python-${pyversion}.tar.bz2
|
|
||||||
tar xvfj Python-${pyversion}.tar.bz2
|
|
||||||
cd Python-${pyversion}
|
|
||||||
./configure
|
|
||||||
make
|
|
||||||
sudo make install
|
|
||||||
|
|
||||||
This installs python 3.2 to /usr/local/bin.
|
|
||||||
Ensure this directory is in your PATH environment variable.
|
|
||||||
|
|
||||||
## Install cdist
|
## Install cdist
|
||||||
|
|
||||||
You can install cdist either from git or as a python package.
|
You can install cdist either from git or as a python package.
|
||||||
|
|
@ -141,10 +33,8 @@ To install cdist, execute the following commands:
|
||||||
cd cdist
|
cd cdist
|
||||||
export PATH=$PATH:$(pwd -P)/bin
|
export PATH=$PATH:$(pwd -P)/bin
|
||||||
|
|
||||||
If you want to build and use the manpages, run:
|
From version 4.2.0 cdist tags and github releases are signed.
|
||||||
|
You can get GPG public key used for signing [here](/software/cdist/pgp-key-EFD2AE4EC36B6901.asc).
|
||||||
make man
|
|
||||||
export MANPATH=$MANPATH:$(pwd -P)/doc/man
|
|
||||||
|
|
||||||
#### Available versions in git
|
#### Available versions in git
|
||||||
|
|
||||||
|
|
@ -169,6 +59,36 @@ If the main site is down, you can acquire cdist from one of the following sites:
|
||||||
* git://github.com/telmich/cdist.git ([github](https://github.com/telmich/cdist))
|
* git://github.com/telmich/cdist.git ([github](https://github.com/telmich/cdist))
|
||||||
* git://git.code.sf.net/p/cdist/code ([sourceforge](https://sourceforge.net/p/cdist/code))
|
* git://git.code.sf.net/p/cdist/code ([sourceforge](https://sourceforge.net/p/cdist/code))
|
||||||
|
|
||||||
|
#### Building and using documentation (man and html)
|
||||||
|
|
||||||
|
If you want to build and use the documentation, run:
|
||||||
|
|
||||||
|
make docs
|
||||||
|
|
||||||
|
Documentation comes in two formats, man pages and full HTML
|
||||||
|
documentation. Documentation is built into distribution's
|
||||||
|
docs/dist directory. man pages are in docs/dist/man and
|
||||||
|
HTML documentation in docs/dist/html.
|
||||||
|
|
||||||
|
If you want to use man pages, run:
|
||||||
|
|
||||||
|
export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man
|
||||||
|
|
||||||
|
Or you can move manpages from docs/dist/man directory to some
|
||||||
|
other directory and add it to MANPATH.
|
||||||
|
|
||||||
|
Full HTML documentation can be accessed at docs/dist/html/index.html.
|
||||||
|
|
||||||
|
You can also build manpages for types in your ~/.cdist directory:
|
||||||
|
|
||||||
|
make dotman
|
||||||
|
|
||||||
|
Built manpages are now in docs/dist/man directory. If you have
|
||||||
|
some other custom .cdist directory, e.g. /opt/cdist then use:
|
||||||
|
|
||||||
|
DOT_CDIST_PATH=/opt/cdist make dotman
|
||||||
|
|
||||||
|
|
||||||
### Python Package
|
### Python Package
|
||||||
|
|
||||||
Cdist is available as a python package at
|
Cdist is available as a python package at
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@ cdist was tested or is know to run on at least
|
||||||
* [Archlinux](http://www.archlinux.org/)
|
* [Archlinux](http://www.archlinux.org/)
|
||||||
* [Debian](http://www.debian.org/)
|
* [Debian](http://www.debian.org/)
|
||||||
* [CentOS](http://www.centos.org/)
|
* [CentOS](http://www.centos.org/)
|
||||||
|
* [Scientific](https://www.scientificlinux.org/)
|
||||||
* [Fedora](http://fedoraproject.org/)
|
* [Fedora](http://fedoraproject.org/)
|
||||||
* [FreeBSD](http://www.freebsd.org)
|
* [FreeBSD](http://www.freebsd.org)
|
||||||
* [Gentoo](http://www.gentoo.org/)
|
* [Gentoo](http://www.gentoo.org/)
|
||||||
|
|
|
||||||
52
software/cdist/pgp-key-EFD2AE4EC36B6901.asc
Normal file
52
software/cdist/pgp-key-EFD2AE4EC36B6901.asc
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||||||
|
Version: GnuPG v2
|
||||||
|
|
||||||
|
mQINBFeCnRQBEACoybnhBEubglOHJrZQ8PKcdeQaGZRoTc3cDs84lr6a9HiLeoBO
|
||||||
|
f8x9fpN4LJbaJOyFJLcvVHHcljvooCLqL5t8/pj7Lyvq1AYuMAeS2Wy19amy3tE5
|
||||||
|
aYYdN85idE/m81B+nD76URL4UjXm0T9ITNLbSE3cZTh/25fsFLub+CHauuP0zxJJ
|
||||||
|
4SlWnIvvcx1hg9n0la9M1DwcNSdI9A7bZLHIM3Ixuq8HTXcuuozXvJOxTgKZ6Yfs
|
||||||
|
UmTW7mMykbcxcNZx9bADj8kJOEf9FlJzalkW3XVGbBBYgwDrqoRGl+gtt5up71cE
|
||||||
|
N0NSL6+6mNJBW3ek9kI88z2qUlVe5UXZQxe5sgjrcnE2sPJkAjCiYUXhVzjV5Oo1
|
||||||
|
CZ8m1egZLM4IWwAVg8lTizSozYWm9Rs5BcHRVSbQenXoJffTYJY//UE7sAkAfKCf
|
||||||
|
vsHCdc1H1yK2OwC418nj/T2Zu8Yt0CWiQT3Sogtqz6R7HgVCmSqEdQl3+VL2hQkk
|
||||||
|
4s0lSOCtBpe0R700phJ67QsnCB8cGMqfUbYZ9cEppJwPA3X3tZd5BJ2OYFU/qhrM
|
||||||
|
SJ9konAWxnFkViBz0MCKhVjMh6DsH40xdQQsrXsF2aSwEv3MFw/sj+xt1KIuRE5i
|
||||||
|
IDrZpbaWVjshoJVH6l4eK01DfxRHRJdj8AyH/xJTQQRal2J4CNWjtl+NzwARAQAB
|
||||||
|
tDB1bmdsZWljaCBHbWJIICh1bmdsZWljaCBGT1NTKSA8Zm9zc0B1bmdsZWljaC5j
|
||||||
|
aD6JAjcEEwEIACEFAleCnRQCGwMFCwkIBwIGFQgJCgsCBBYCAwECHgECF4AACgkQ
|
||||||
|
79KuTsNraQGQ6w//dLuEsGzhqQ4FdYwpTOOfcWB6+i42PGb2TgXzwbx5kgzKv6oi
|
||||||
|
nGuMlXKfamaqbCQuPRyHxR34VRgJslDcvhIXDhB7ELdi5ib8vpA2bX082Es9cKUB
|
||||||
|
TSGPtp8y7n9aN9ebu/HWLQu88YdAHEcB8BhSuMmcxGvRM1H2a59lW5WizQ7KUPLt
|
||||||
|
5a8UeELmf/Xz0k4YLP39ApXHxfis0kbGYBni6f7WsyVw2SBEqiG6Z9XktRcSo0e/
|
||||||
|
RlZb8FlEQgkZtafmFh2qLS710sll8bcD4Xqktzy4ztUgp6ImtpUY8CwdO9H8VCZK
|
||||||
|
xCwEIX3W25qAXiV8aFSJ9T4M15dkZivq1vvAEmE0G1zEi8AwI3NGjMXDh61A1yH3
|
||||||
|
auHdSOPzdlICqZDBDlX70tmzL3MBOBy32DkVMwe5JHlj9RBjrpp/B3wch1La2NND
|
||||||
|
4tFEzYMYlkDxCjJKpNqGDZO+ZqHA7dOx3sx6XPlGtSyWnFfFPu2bBvrDhyORmMbO
|
||||||
|
20pLotDXIzJ8qNCsZ6XAiJ1PDeHintxbRwJxERScv3EcvcE/lcxrlS/TX9LbBJPE
|
||||||
|
0y/JMpXLx+9WdG5KpDCxpuZHVyKkcXP0TAPq/IG+VPo9wTGg6cy///Se2PKBbuMm
|
||||||
|
X90VVM/C5PYmDjJ+IxZckBm6oXLJSZd0rETrf0G4HQCznnA8oiQbZu1ac/O5Ag0E
|
||||||
|
V4KdFAEQALoVDmDKujONT1yDT+AFUc2a/IBBU7V5Ut86+ZdiXltKVpQA3Dc17bdt
|
||||||
|
GS5YqMVnIaKZ7MqRhfo0XeVzyTBzjGLr+2EZdWb51I7JNto/HVZgUOvon9BiMoTK
|
||||||
|
KUOD8gFlhblCcKd/aVOJXPDzKYfu2jgBmgtcHecbyXRbjlha6l0/jsFJj0VJySQv
|
||||||
|
pj2AftKtb7mltz5Wfm/FkUfpEYGl2NSucW3bYNe0j6BmQXqRqLupeoSdmWrPT+oa
|
||||||
|
RXxKfM0Ug43WnNYgXsAwU383pdfmYIzxsV7RRIXZZswNKuMj4XyDp1hvF4++6Nqb
|
||||||
|
ySsCGWRWYG1TK0yCQyzRYvaaY15W9ZX8q91Qx9R6RksXs8bjDmHKo55z4V3Dy5KG
|
||||||
|
dwanyatmEwkbcKjFECK84V8zNJDspsLS1BGiUF69qWdU/wREMs4kp0gUC+3Fbguf
|
||||||
|
u/v4yc87SO9QvIIv2lWp3nRpQC5661+SK4dB2SVYL88Yd+LFoe883qI5GQIFLad+
|
||||||
|
Q5Y/c305r44VOlACV/EsP01LoHHfSsTeneoBUW8ndoKyE3yJ5LKYUV9caROG4/Wh
|
||||||
|
hGWulkZTXSUXv8q6rUoCIkJiTPPnozwjtErlGyNGcnG1WR55sRV8SFr/SflnUDh9
|
||||||
|
tAo+I1xegS+B9W+I89jv3ujkpDVNoST8nb44EZrAq/R0WST48zDHABEBAAGJAh8E
|
||||||
|
GAEIAAkFAleCnRQCGwwACgkQ79KuTsNraQH7Iw//YclkUN193xbaOho/y4Dj4vk1
|
||||||
|
/Gl4bRgek5CkeMll2uxvsvaVEhL1fbBOR501kmYKzCynkESWft8FG7LNxLi7t3Y9
|
||||||
|
XrnvvIqPVGAwD8x1+fj+LWCAOZAcFQ3nPSXRY+aZ545G5Mu24EHKsaBEFiyGlDSY
|
||||||
|
6+XLJchQEpUwVn3MIk9RKCyYi9pAdofgvHuDbB8fFz2YGyjmBn+WbZCmvTm62AIP
|
||||||
|
WzaNBx507l9LBObY2teBTFLFOnUmNW0QLNpV8lGlWv/rVGfzqD3VVavRNGcXLkI9
|
||||||
|
spv4r5ci9tQWwW52Z8fAFMo4yWeeWnS0uk4vKtq3ANwFqFtxLuA8WBy9FYQ/5BR0
|
||||||
|
RdbI0a/iVN2rJcZxGqUbz22U+4N7g89EmHA40LFsWmIl5duAtXZ3XIlMFzCuXwYf
|
||||||
|
u9fpLUs6uIdRuVVg/qVJva608hn/7/fEqetbwoHmmSBVUSOQYdMZZ5SyR8zDUbBh
|
||||||
|
acGOOPRSN7tJG8ycoPSQKQci4fXEpqkBfojalqNKGgJUj+5IWApZWvZV0Z6fFLO7
|
||||||
|
Q2vd1jXYb4lKv04pfxqfOuOlSy9w6ElNewF4V7jSdGqfitw2lQNXlC1EaoajkiZJ
|
||||||
|
Evcb9b5HexuJPI3cxyJGZyUYyqk2FF0ztGigbhK986iyKILJB+OqiLbAs3KIgezD
|
||||||
|
vsomtv+pm41l0JK+Xps=
|
||||||
|
=/2wY
|
||||||
|
-----END PGP PUBLIC KEY BLOCK-----
|
||||||
|
|
@ -8,7 +8,7 @@ You can join the development ***IRC channel***
|
||||||
### Mailing list
|
### Mailing list
|
||||||
|
|
||||||
Bug reports, questions, patches, etc. should be send to the
|
Bug reports, questions, patches, etc. should be send to the
|
||||||
[cdist mailing list](https://groups.google.com/forum/#!forum/cdist-configuration-management).
|
[cdist mailing list](http://l.schottelius.org/mailman/listinfo/cdist).
|
||||||
|
|
||||||
### Linkedin
|
### Linkedin
|
||||||
|
|
||||||
|
|
@ -20,6 +20,6 @@ you can join the
|
||||||
### Commercial support
|
### Commercial support
|
||||||
|
|
||||||
You can request commercial support for cdist from
|
You can request commercial support for cdist from
|
||||||
[my company](http://www.ungleich.ch/).
|
[my company](http://www.ungleich.ch/english/).
|
||||||
|
|
||||||
[[!tag cdist unix]]
|
[[!tag cdist unix]]
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue