Merge pull request #192 from niels-nijens/yaml-configuration-task-docs

Add documentation of stage specific configuration functionality in YamlConfigurationTask
accompli · Jul 16, 2016 · 7df87a1 · 7df87a1
2 parents b40fb76 + 81e33f2
commit 7df87a1
Showing 1 changed file with 39 additions and 9 deletions.
diff --git a/docs/tasks/YamlConfigurationTask.md b/docs/tasks/YamlConfigurationTask.md
@@ -2,8 +2,45 @@
 
 Creates or updates a YAML configuration file. When the same file with a .yml.dist extension is available the task will use that file as template.
 
-## Generating unique SHA1 hash values for a key within the YAML configuration
+## Configuration options
+
+| Name                        | Type     | Default value | Description                                                     |
+|-----------------------------|----------|---------------|-----------------------------------------------------------------|
+| configurationFile           | string   |               | The location of the YAML configuration file within the release. |
+| configuration               | array    |               | The configuration to be added to the YAML configuration file.   |
+| stageSpecificConfigurations | array    |               | The configuration to be added to the YAML configuration file based on the stage being installed to. |
+| generateValueForParameters  | string[] |               | An array with configuration keys that require generation of a SHA1 hash value. |
+
+
+### Configuring stage specific configuration
+With the `stageSpecificConfigurations` option you are able to add configuration that should only be added when installing a release to a specific stage.
+
+The following example shows a specific key being set with a different value per stage:
+``` json
+{
+    "class": "Accompli\\Task\\YamlConfigurationTask",
+    "configurationFile": "/app/config/parameters.yml",
+    "configuration": {
+        "parameters": {
+            "database_user": "aUsername"
+        }
+    },
+    "stageSpecificConfigurations": {
+        "production": {
+            "database_password": "aProductionPassword"
+        },
+        "acceptance": {
+            "database_password": "anAcceptancePassword"
+        },
+        "test": {
+            "database_password": "aTestPassword"
+        }
+    }
+}
+```
+
 
+### Generating unique SHA1 hash values for a key within the YAML configuration
 To generate a unique SHA1 hash value for a key you need to specify that key in the 'generateValueForParameters' configuration option.
 When the key is a child of another key you can use a dotted notation as lookup syntax.
 
@@ -15,13 +52,6 @@ bar:
 
 When you specify 'bar.baz' with 'generateValueForParameters' the task will generate a new unique SHA1 hash value.
 
-# Configuration options
-
-| Name | Type | Default value | Description |
-|------|------|---------------|-------------|
-| configurationFile | string |  | The location of the YAML configuration file within the release. |
-| configuration | array |  | The configuration to be added to the YAML configuration file. |
-| generateValueForParameters | string[] |  | An array with configuration keys that require generation of a SHA1 hash value. |
 
-# Event flow
+## Event flow
 ![Flowchart with highlighted events YamlConfigurationTask is listening to](../images/event-flows/YamlConfigurationTask.png)