Merge branch 'develop'

Author: Derek Smart

README.md

@@ -1,10 +1,11 @@
 # Delphix Automation Framework
 
-Always include a project title with the largest heading. A project logo may replace the project title, if one has been designed. Project badges are common for OSS projects. They show quick information like Build Status, Download Count, etc... If there are any relevant badges, include them below the project title in MD format. In the paragraph immediately following the project title and badges, include information about the project and/or an overview that explains **what** the project is.
+The Delphix Automation Framework (DAF) allows automating data management via APIs at scale. Easily automate Delphix Self Service actions in CI/CD Pipelines without being tied to any specific CI Software.
 
 #### Table of Contents
 1.  [Description](#description)
 2.  [Installation](#installation)
+    *   [The delphix.yaml file](#delphix-yaml)
 3.  [Usage](#usage)
 4.  [Links](#links)
 5.  [Contribute](#contribute)
@@ -17,14 +18,18 @@ Always include a project title with the largest heading. A project logo may repl
 
 ## <a id="description"></a>Description
 
+DAF combines environment variables commonly available during CI/CD and data management as code in the `delphix.yaml` file to automate API calls to the Delphix Dynamic Data Platform. This allows for chain-able API calls that can be triggered during different stages of the CI/CD pipeline. The data state for different non-production environments is now visible through code configuration and that configuration is under version control.
 
 ## <a id="installation"></a>Installation
 
+The tools and executable for DAF have been containerized with docker for convenience. Use the latest version by pulling the container below.
+
 ```bash
 docker pull delphix/daf
 ```
+### <a id="delphix-yaml"></a>The delphix.yaml file
 
-Create a `delphix.yaml` file based on this guide: [Configure Delphix YAML](./configure-delphix-yaml.md)
+The `delphix.yaml` file is the configuration file that defines the data management as code strategy for the project. Create a `delphix.yaml` file based on this guide: [Configure Delphix YAML](./configure-delphix-yaml.md)
 
 ## <a id="usage"></a>Usage
 

configure-delphix-yaml.md

@@ -35,11 +35,8 @@ environments:
 |Keyword|Description
 |---|---
 |[template](#template)|The name of the Delphix Self-Service template for this project.
-|[api-key](#api-key)|Orbital API Key for the account connected to your Delphix Engine.
 |[connectors](#connectors)|A collection of database connector references.
-|[data-sources](#data-sources)|A collection of data sources used to create the template and any specifics that can be overwritten.
 |[environments](#environments)|A collection of application environments, their datapods, and the actions to take during the CI/CD pipeline.
-|[ami](#ami)|ID of AMI to be used for target hosts.
 |[host](#host)|Reference for the application host in KMS.
 |[port](#port)|Reference for the application port in KMS.
 |[database](#database)|Reference for the application database in KMS.
@@ -48,31 +45,21 @@ environments:
 |[branch](#branch)|The source GIT branch for a specific Application Environment.
 |[datapod](#datapod)|The Delphix Datapod for a specific Application Environment.
 |[when](#when)|The collection of Actions for a specific Application Environment.
+|[then](#then)|The Delphix Self Service action executed for this `when` trigger.
 
 
 ### <a id="template"></a>template
 
 The name of the Delphix Self-Service template.
 
-### <a id="api-key"></a>api-key
-
-The Orbital API Key for the automation user.
-
 ### <a id="connectors"></a>connectors
 
 The collection of database connector key references for each data source. Do not commit any connector values to your version control. These are only key references, not values. E.g. database_name vs dbName.
 
-### <a id="data-sources"></a>data-sources
-
-The collection of data-sources used to create the template. This is optional and only used if an specific EC2 AMI is used for the creation of target hosts. The name of each data-source should correspond to the data-source names that are in the Delphix Self-Service template.
-
 ### <a id="environments"></a>environments
 
 The collection of application environments, their GIT branches, the datapod used as the database, and the collection of Actions to be executed during the CI/CD build phase. The names of the collections are arbitrary and only used for developer identification.
 
-### <a id="ami"></a>ami
-
-Optional. A preconfigured AMI to be used as a target host.
 
 ### <a id="host"></a>host
 
@@ -106,6 +93,10 @@ The name of the datapod used for the database of the environment. Must have been
 
 The collection of Actions for an environment based on the Given -> When -> Then format described above.
 
+### <a id="then"></a>then
+
+The specific Self Service API call to be executed during this Action. Acceptable values: `datapod.refresh`, `datapod.create`, `datapod.delete`, `bookmark.share`, `bookmark.create`, `datapod.undo`, and `bookmark.delete`.
+
 ## Overwrites
 
 Each environment has the ability to overwrite individual values for connectors or data-sources. A specific environment might need to use a different AMI or have different database connector keys.
@@ -115,9 +106,6 @@ environments:
   - staging:
       branch: staging
       datapod: staging-pod
-      data-sources:
-        - postgres:
-            ami: ami-different-id
       connectors:
         - postgres:
             database: differentDbName
@@ -130,17 +118,7 @@ environments:
 
 ```
 template: Sample Template
-api_key: abf7746cff392
 parent: dSource Name
-config:
-  notes: description *optional*
-  data-sources:
-    - postgres:
-        notes: Here are notes
-        replica: Default
-        source: dbdhcp3
-        start-order: 1
-        ami: ami-0dfffed98347ecd
 connectors:
   - postgres:
       host: host_ref_in_kms

delphix.yaml

@@ -1,15 +1,5 @@
 template: DAF
 parent: dms-source
-api_key: app_key_token in KMS
-config:
-  notes: description *optional*
-  data-sources:
-    - postgres:
-        notes: Here are notes
-        replica: Default
-        source: dbdhcp3
-        start-order: 1
-        ami: ami-0dfffed98347ecd
 connectors:
   - postgres:
       host: host_ref_in_kms
@@ -40,5 +30,5 @@ environments:
       branch: origin/feature/unit-tests
       datapod: Develop
       when:
-        - custom: datapod.refresh
+        - push: datapod.refresh
         - build-failure: datapod.undo

src/main/kotlin/com/delphix/yamlparser/Mapper.kt

@@ -66,7 +66,7 @@ class Mapper {
         return Yaml(
             contents.get("template").asText(),
             contents.get("parent").asText(),
-            contents.get("api_key").asText(),
+            //contents.get("api_key").asText(),
             mappedConfig,
             mappedConnector,
             mapEnvironments(contents["environments"])

src/main/kotlin/com/delphix/yamlparser/Validator.kt

@@ -85,7 +85,6 @@ class Validator(val contents: JsonNode) {
     fun validate() {
         field(contents, "template")
         field(contents, "parent")
-        field(contents, "api_key")
         node(contents, "environments")
         environments(contents["environments"])
 

src/main/kotlin/com/delphix/yamlparser/Yaml.kt

@@ -3,7 +3,6 @@ package com.delphix.yamlparser
 data class Yaml(
   val template: String,
   val parent: String,
-  val api_key: String,
   val config: Config? = null,
   val connectors: List<Connector>? = null,
   val environments: List<Environment>

src/test/kotlin/com/delphix/yamlparser/YamlTest.kt

@@ -16,16 +16,12 @@ class YamlTest {
     private val connector = Connector("name", "host", "port", "database", "username", "password")
     private val action = Action("event", "action")
     private val environment = Environment("develop", "branch", "datapod", listOf(action))
-    private val yaml = Yaml("template", "parent", "api_key", config, listOf(connector), listOf(environment));
+    private val yaml = Yaml("template", "parent", config, listOf(connector), listOf(environment));
 
     @Test fun `can get template`() : Unit {
         assertEquals("template", yaml.template)
     }
 
-    @Test fun `can get api_key`() : Unit {
-        assertEquals("api_key", yaml.api_key)
-    }
-
     @Test fun `can get environment`() : Unit {
         assertEquals("branch", yaml.environments.get(0).branch);
     }