Skip to content

Commit 745211b

Browse files
author
Derek Smart
committed
docs update
Signed-off-by: Derek Smart <derek.smart@delphix.com>
1 parent 3cf07a4 commit 745211b

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Delphix Automation Framework
22

3-
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.
3+
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.
44

55
#### Table of Contents
66
1. [Description](#description)
77
2. [Installation](#installation)
8+
* [The delphix.yaml file](#delphix-yaml)
89
3. [Usage](#usage)
910
4. [Links](#links)
1011
5. [Contribute](#contribute)
@@ -17,14 +18,18 @@ Always include a project title with the largest heading. A project logo may repl
1718

1819
## <a id="description"></a>Description
1920

21+
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.
2022

2123
## <a id="installation"></a>Installation
2224

25+
The tools and executable for DAF have been containerized with docker for convenience. Use the latest version by pulling the container below.
26+
2327
```bash
2428
docker pull delphix/daf
2529
```
30+
### <a id="delphix-yaml"></a>The delphix.yaml file
2631

27-
Create a `delphix.yaml` file based on this guide: [Configure Delphix YAML](./configure-delphix-yaml.md)
32+
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)
2833

2934
## <a id="usage"></a>Usage
3035

configure-delphix-yaml.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ environments:
4545
|[branch](#branch)|The source GIT branch for a specific Application Environment.
4646
|[datapod](#datapod)|The Delphix Datapod for a specific Application Environment.
4747
|[when](#when)|The collection of Actions for a specific Application Environment.
48+
|[then](#then)|The Delphix Self Service action executed for this `when` trigger.
4849

4950

5051
### <a id="template"></a>template
@@ -92,6 +93,10 @@ The name of the datapod used for the database of the environment. Must have been
9293

9394
The collection of Actions for an environment based on the Given -> When -> Then format described above.
9495

96+
### <a id="then"></a>then
97+
98+
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`.
99+
95100
## Overwrites
96101

97102
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.

0 commit comments

Comments
 (0)