about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@gmail.com>2017-02-08T12·15+0100
committerVincent Ambo <tazjin@gmail.com>2017-02-08T12·15+0100
commita1c23d701826aa4ab963416946ff7054aabc1a7a (patch)
treece1350406cebae6f5500b43702c6f738c7c9bb00
parentd94a0ffc25f5e6205dd2fa770819c2095160800a (diff)
docs: Add YAML to docs
-rw-r--r--README.md31
-rw-r--r--example/prod-cluster.yaml10
2 files changed, 24 insertions, 17 deletions
diff --git a/README.md b/README.md
index df74f2c334f3..24bc9a37a2e5 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ KonTemplate lets you describe resources as you normally would in a simple folder
 
 ```
 .
-├── prod-cluster.json
+├── prod-cluster.yaml
 └── some-api
     ├── deployment.yaml
     └── service.yaml
@@ -22,24 +22,21 @@ KonTemplate lets you describe resources as you normally would in a simple folder
 This example has all resources belonging to `some-api` (no file naming conventions enforced at all!) in the `some-api`
 folder and the configuration for the cluster `prod-cluster` in the corresponding file.
 
-Lets take a short look at `prod-cluster.json`:
-
-```json
-{
-  "context": "k8s.prod.mydomain.com",
-  "include": [
-    {
-      "name": "some-api",
-      "values": {
-        "importantFeature": true,
-        "apiPort": 4567
-      }
-    }
-  ]
-}
+Lets take a short look at `prod-cluster.yaml`:
+
+```yaml
+---
+context: k8s.prod.mydomain.com
+global:
+  globalVar: lizards
+include:
+  - name: some-api
+    values:
+      version: 1.0-0e6884d
+      importantFeature: true
+      apiPort: 4567
 ```
 
-
 Those values are then templated into the resource files of `some-api`.
 
 ## Usage
diff --git a/example/prod-cluster.yaml b/example/prod-cluster.yaml
new file mode 100644
index 000000000000..dd7804f719c3
--- /dev/null
+++ b/example/prod-cluster.yaml
@@ -0,0 +1,10 @@
+---
+context: k8s.prod.mydomain.com
+global:
+  globalVar: lizards
+include:
+  - name: some-api
+    values:
+      version: 1.0-0e6884d
+      importantFeature: true
+      apiPort: 4567