Skip to content

Commit 81b3f0a

Browse files
committed
Updated README for cfengine up
Signed-off-by: Victor Moene <victor.moene@northern.tech>
1 parent 72a8bac commit 81b3f0a

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,26 @@ groups:
9999
spawn: ubuntu
100100
```
101101
102-
up will spawn the necessary VMs and install cfengine using cf-remote
102+
`up` will spawn the necessary VMs and install cfengine using cf-remote
103103

104-
```
104+
```bash
105105
cfengine up config.yaml
106106
```
107107

108+
To validate the config, one can run:
109+
110+
```bash
111+
cfengine up --validate config.yaml
112+
```
113+
114+
Every time `up` is run, it will do all the necessary (spawn, destroy, install, uninstall) to reconciliate the current state with the input configuration. After a successful run, the applied configuration is saved. On subsequent runs, CFEngine compares the previously applied configuration with the current configuration and applies only the necessary changes.
115+
116+
To ignore the previously saved configuration and apply the current configuration as-is, run:
117+
118+
```bash
119+
cfengine up --reset config.yaml
120+
```
121+
108122
## Supported platforms and versions
109123

110124
This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.

0 commit comments

Comments
 (0)