forked from skonfig/base
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,20 @@ | ||
# cdist-contrib | ||
# cdist-extra | ||
|
||
This project extends the [cdist][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 is the [community maintained](https://github.com/cdist-community) | ||
fork of ungleich's [cdist](https://github.com/ungleich/cdist) | ||
(after [f061fb1](https://github.com/ungleich/cdist/commit/f061fb168ddacc894cb6e9882ff5c8ba002fadd8)). | ||
|
||
This project does not have releases and is continously updated: see git history | ||
for change log. You will find HTML documentation at | ||
[contrib.cdi.st](https://contrib.cdi.st). | ||
Work is split between three repositories: | ||
|
||
## Using cdist-contrib | ||
* [cdist](https://github.com/cdist-community/cdist) - implementation of the **cdist core**. | ||
* [cdist-conf](https://github.com/cdist-community/cdist-conf) - **essential** explorers and types. | ||
* **cdist-extra** - **non-essential** explorers, types, scripts, tools etc (this repository). | ||
|
||
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][cdistconfig]. | ||
Difference between essential and non-essential? Explorers and types which are | ||
used to manage state of the operating system (modify files and directories, | ||
install packages, manage services, etc.) and are not strictly related to some | ||
specific piece of software are considered essential. | ||
|
||
An example of this would be: | ||
## Getting Started | ||
|
||
```ini | ||
# 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][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][cdist] community | ||
|
||
Join us on [#cdist:ungleich.ch][cdistmatrix] on matrix! | ||
|
||
[cdist]: https://www.cdi.st/ | ||
[cdistconfig]: https://www.cdi.st/manual/latest/cdist-configuration.html | ||
[cdistmatrix]: https://matrix.to/#/#cdist:ungleich.ch | ||
|
||
## Contributing | ||
|
||
The preferred way to submit patches is by opening Merge Requests against the | ||
[cdist-contrib project on | ||
code.ungleich.ch](https://code.ungleich.ch/ungleich-public/cdist-contrib) (you | ||
can make an account on | ||
[account.ungleich.ch](https://account.ungleich.ch/). | ||
|
||
Every type in cdist-contrib must: | ||
|
||
* Have a `man.rst` documentation page. | ||
* Pass [shellcheck](http://shellcheck.net/) without errors. | ||
|
||
## Other resources | ||
|
||
Some people/organizations are known to keep some cdist types that might be of | ||
interest to others: | ||
|
||
* [cdist-evilham](https://git.sr.ht/~evilham/cdist-evilham): Evilham's cdist-types | ||
* [cdist-recycledcloud](https://code.recycled.cloud/RecycledCloud/cdist-recycledcloud): e-Durable SA / Recycled Cloud public types | ||
* [cdist-ungleich](https://code.ungleich.ch/ungleich-public/cdist-ungleich): ungleich public types | ||
See [cdist](https://github.com/cdist-community/cdist) repository. |