Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
## Configuration Manager

The most of configuration managers using lot of system resource. With this program you can manage your system's files, run custom command and store many outputs to a central based storage. This program using Jinja2 templates and you'll use variables in template files.

###Catalog
### Catalog

Catalog is a YAML based file. Catalog name is its file name.

Every Catalog must start with:
`---`
Every Catalog must start with: `---`

### Catalog Task

###Catalog Task
You can declare unlimited tasks in Catalog. In task you can create one resource definition only!

```
Expand All @@ -20,17 +22,21 @@ You can declare unlimited tasks in Catalog. In task you can create one resource
register: VARIABLE_NAME
```

###Resource definition
#####ReadEnv resource:
### Resource definition
##### ReadEnv resource:

You can read system environment variables and store variable value. If ENV not exists in the system, you can set 'default' attribute.

```
readenv:
name: ENV_NAME
[default: DEFAULT_VALUE]
```

default attribute is optional!

#####File resource
##### File resource

| | type | require | default | conditional |
|--------|-------------------|---------|---------|---------------------|
| path | Unix Path | True | None | |
Expand All @@ -41,6 +47,7 @@ default attribute is optional!
| source | Unix Path | False | None | if state == present |

Example:

```
file:
path: /var/www/html/index.html
Expand All @@ -50,7 +57,9 @@ Example:
mode: 0755
source: /root/index.html.j2
```
###Full example

### Full example

```
- - -
tasks:
Expand Down