cdist/doc/man/man7/cdist-tutorial.text

102 lines
2.5 KiB
Text
Raw Normal View History

cdist-tutorial(7)
=================
Nico Schottelius <nico-cdist--@--schottelius.org>
NAME
----
cdist-tutorial - a guided introduction into cdist
INTRODUCTION
------------
This document gives you a pointer on what to read in
which order and is thus a "guide to the right locations".
So in case you are just starting, just "begin at the beginning"
(Brave New World). You can see the target audience in [] brackets
after the description.
cdist-quickstart::
New to cdist? Want to get your hands dirty? Read this. [beginner]
cdist-bootstrap::
The comprehensive guide to your first cdist installation [beginner]
cdist-initial-manifest::
Learn how to define which hosts get which configurations [beginner]
MANAGING YOUR OWN CONFIGURATION
cdist-type::
Understand how types are working and created [intermediate]
CREATING YOUR FIRST OWN TYPE
----------------------------
=> short example, reference to cdist-type(7)!
=> motivation
Use a type to bundle functionalitY
<with object id? or signleton here already>
Debug with var - can be used by yourself
__debug::
If this variable is setup, cdist runs in debug mode.
You can use this information, to only output stuff in debug
mode as well.
Available for: initial manifest, type manifest, gencode, code
USING EXPLORERS
---------------
cdist-explorer.text
DEBUGGING YOUR TYPES
--------------------
cdist-best-practice::
Hints from real life experience to help you to organise cdist [intermediate]
cdist-reference::
The type, explorers and environment variables reference [intermediate]
cdist-explorer::
Interested in getting more information about the target system? [intermediate]
cdist-cache::
How to get use information about the hosts we have been working on [advanced]
cdist-scaling-tuning::
How to scale out with cdist and which tunings to apply. [advanced]
TUNING CDIST
------------
- speedup processing with ControlMaster option of
ssh
=> different document
cdist-stages::
Understand the internal workflow of cdist. [advanced]
cdist-hacker::
README, if you want to extend or modify cdist. [hacker]
SEE ALSO
--------
- cdist(1)
- cdist-type(7)
- cdist-best-practice(7)
- cdist-stages(7)?
- Brave New World by Aldous Huxley
COPYING
-------
Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).