From 8f335c8e1f24697c2d2eddf3c31ef3cd433b3b05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bence=20S=C3=A1ntha?= Date: Sun, 11 Aug 2019 09:21:13 +0200 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b1ffffd..fa27fb2 100644 --- a/README.md +++ b/README.md @@ -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! ``` @@ -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 | | @@ -41,6 +47,7 @@ default attribute is optional! | source | Unix Path | False | None | if state == present | Example: + ``` file: path: /var/www/html/index.html @@ -50,7 +57,9 @@ Example: mode: 0755 source: /root/index.html.j2 ``` -###Full example + +### Full example + ``` - - - tasks: