cf-remote config md

Signed-off-by: Victor Moene <victor.moene@northern.tech>

Author: victormlg

vm-config.md

@@ -1,54 +1,50 @@
-# Indempotent VM spawning config
+# Idempotent VM spawning config
 
+## Idempotency:
+The user defines a desired state in the form of a config in yaml, and cf-remote makes it a reality. If run against an existing environment, it detects changes and 'repairs' the current state using the configuration.
 
-
-## Core concepts:
-
-- Fully reproducible and sharable cfengine testing environment
-- Should work for dev environment: support for package install and scripts
-- Atomic config: either all vms created or none. No in-between states.
-- Top-down run order
-- VMs bound to config that generated them. Should not manually interfer: VMs should not be destroyed manually and the config should not be modified while VMs are running.
-- Should provide abstraction of provider (aws, vagrant, static)
-
-
-## Example:
+## Example
 
 ```
-machines:
-  - ubuntu-vm:
-      provider: aws # if we want to force provider
-      count: 1 # ignore if provider is "static"
-
+templates:
+  ubuntu-vm:
+    provider:
+      name: aws
       aws:
         image: ubuntu-24
 
+  centos7:
+    provider:
+      name: vagrant
       vagrant:
-        image: ubuntu/focal64
-        memory: 1024
-        cpus: 2
+        box: generic/centos7
 
-      static: 
-        hosts: [ ubuntu@8.8.8.8, ubuntu@1.1.1.1 ]
+groups:
+  - myhub:
+      role: hub
+      count: 1
+      spawn-config: ubuntu-vm
+      cfengine: 3.24.3 
+      scripts: [ ./script.sh ]
+
+  - myclient:
+      role: client
+      count: 3
+      bootstrap: myhub
+      spawn-config: centos7
+      cfengine: 3.24.3
+
+  - other:
+      role: client
+      hosts: [ ubuntu@1.1.1.1 ]
+      bootstrap: myhub
+      cfengine: 3.24.3
+```
 
-packages:
-  - cfengine-master:
-      package: cfengine
-      version: master
-      bootstrap: myhub # myhub count must be 1
+To apply the config:
 
-  - git-latest:
-      package: git
-      version: latest
+`cf-remote up config.yaml`
 
-hubs:
-  - myhub:
-      from: ubuntu-vm
-      install: [ cfengine-master, git-latest ]
-      scripts: [ ./provision.sh ]
-
-clients:
-  - myclient: 
-      from: ubuntu-vm
-      install: [ cfengine-master ]
-```
+# Future features
+
+- inlining (being able to split config in smaller subtrees)