cdist-contrib/README.md

1.8 KiB

cdist-contrib

This project extends the cdist configuration management tool with community-maitained types which are either too specific to fit/be maintained in cdist itself or were not accepted in code cdist but could still be useful.

This project does not have releases and is continously updated: see CHANGELOG.md for details.

Using cdist-contrib

We would recommend that you clone this repository next to your regular cdist config directory, then setup conf_dir with relative paths in cdist configuration.

An example of this would be:

# contents of cdist.cfg next to cdist-contrib
[GLOBAL]
# Notice that types defined in last dir win and can override native types.
# Consider using a prefix for your own types to avoid collisions.
conf_dir = cdist-contrib:cdist-private

And you would run cdist from the same directory as follows:

cdist config -g cdist.cfg
# Or setup your CDIST_CONFIG_FILE environment variable and run as usual

Participating in the cdist community

Join us on #cdist:ungleich.ch on matrix or on #cdist over mattermost.

Contributing

The preferred way to submit patches is by opening Merge Requests against the cdist-contrib project on code.ungleich.ch (you can make an account on account.ungleich.ch.

Every type in cdist-contrib must:

  • Have a man.rst documentation page.
  • Pass shellcheck without errors.