cdist configuration management Latest manual: https://www.cdi.st/manual/latest/ Home page: https://www.cdi.st
Go to file
Nico Schottelius 33005eb794 update hackers readme
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
2011-03-04 11:09:52 +01:00
bin finish cdist-quickstart 2011-03-04 11:02:28 +01:00
conf finish cdist-quickstart 2011-03-04 02:06:13 +01:00
doc finish cdist-quickstart 2011-03-04 11:02:28 +01:00
.gitignore prepare manpage generation in makefile 2011-02-26 11:46:52 +01:00
HACKERS_README update hackers readme 2011-03-04 11:09:52 +01:00
Makefile finish cdist-manifest.text 2011-02-26 20:41:33 +01:00
README Describe latest features 2011-02-02 21:49:01 +01:00
REAL_README pointer to cdist-quickstart on website 2011-03-04 11:05:45 +01:00
TODO-1.0 cleanup todo for documentation 2011-03-03 10:54:38 +01:00

README

cat << eof

Hey hackers,

this README is for you, for those who want to dig into cdist, hack it or try
to get a deeper understanding.

A lot of documentation is still missing, but running cdist-quickstart should
give you an impression of how cdist works.

I hope you have a lot of fun with cdist, because it was also a lot of fun to
develop it!

   -- Nico, 20110304


## Conventions

- All variables exported by cdist are prefixed with a double underscore (__)
- All cdist-internal variables are prefixed with __cdist_ and are generally not exported.

## Running cdist when developing

This file is suitable for execution and saving the objects and
explorers from cdist. I usually do it like this:

   % ./HACKERS_README

################################################################################
eof

set -x
# Tell the user what we do, so this script makes sense during execution

# prepare use (only from top level directory)
export PATH="$PATH:$(pwd -P)/bin"
export __cdist_conf_dir="$(pwd -P)/conf"

# Allow user to supply hostname
target="${1:-localhost}"

# And use hostname as basedir (dangerous, but hackers know what they do)
export __cdist_local_base_dir="/tmp/$target"

# Run the real script
cdist-deploy-to "$target"

# Display results
find "${__cdist_local_base_dir}"