From be787f62ec83b890c501771c76acddce32e7b7a2 Mon Sep 17 00:00:00 2001 From: Victor Moene Date: Mon, 15 Jun 2026 10:36:52 +0200 Subject: [PATCH] Updated README for cfengine up Signed-off-by: Victor Moene --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18a28a7..065d091 100644 --- a/README.md +++ b/README.md @@ -99,12 +99,24 @@ groups: spawn: ubuntu ``` -up will spawn the necessary VMs and install cfengine using cf-remote +`up` will spawn the necessary VMs and install cfengine using cf-remote -``` +```bash cfengine up config.yaml ``` +To validate the config, one can run: +```bash +cfengine up --validate config.yaml +``` + +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. + +To ignore the previously saved configuration and apply the current configuration as-is, run: +```bash +cfengine up --reset config.yaml +``` + ## Supported platforms and versions This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.