Skip to content

Commit 3cf07a4

Browse files
author
Derek Smart
committed
remove api and data-source requirements
Signed-off-by: Derek Smart <derek.smart@delphix.com>
1 parent 8d7e508 commit 3cf07a4

File tree

6 files changed

+3
-46
lines changed

6 files changed

+3
-46
lines changed

configure-delphix-yaml.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,8 @@ environments:
3535
|Keyword|Description
3636
|---|---
3737
|[template](#template)|The name of the Delphix Self-Service template for this project.
38-
|[api-key](#api-key)|Orbital API Key for the account connected to your Delphix Engine.
3938
|[connectors](#connectors)|A collection of database connector references.
40-
|[data-sources](#data-sources)|A collection of data sources used to create the template and any specifics that can be overwritten.
4139
|[environments](#environments)|A collection of application environments, their datapods, and the actions to take during the CI/CD pipeline.
42-
|[ami](#ami)|ID of AMI to be used for target hosts.
4340
|[host](#host)|Reference for the application host in KMS.
4441
|[port](#port)|Reference for the application port in KMS.
4542
|[database](#database)|Reference for the application database in KMS.
@@ -54,25 +51,14 @@ environments:
5451

5552
The name of the Delphix Self-Service template.
5653

57-
### <a id="api-key"></a>api-key
58-
59-
The Orbital API Key for the automation user.
60-
6154
### <a id="connectors"></a>connectors
6255

6356
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.
6457

65-
### <a id="data-sources"></a>data-sources
66-
67-
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.
68-
6958
### <a id="environments"></a>environments
7059

7160
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.
7261

73-
### <a id="ami"></a>ami
74-
75-
Optional. A preconfigured AMI to be used as a target host.
7662

7763
### <a id="host"></a>host
7864

@@ -115,9 +101,6 @@ environments:
115101
- staging:
116102
branch: staging
117103
datapod: staging-pod
118-
data-sources:
119-
- postgres:
120-
ami: ami-different-id
121104
connectors:
122105
- postgres:
123106
database: differentDbName
@@ -130,17 +113,7 @@ environments:
130113

131114
```
132115
template: Sample Template
133-
api_key: abf7746cff392
134116
parent: dSource Name
135-
config:
136-
notes: description *optional*
137-
data-sources:
138-
- postgres:
139-
notes: Here are notes
140-
replica: Default
141-
source: dbdhcp3
142-
start-order: 1
143-
ami: ami-0dfffed98347ecd
144117
connectors:
145118
- postgres:
146119
host: host_ref_in_kms

delphix.yaml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
template: DAF
22
parent: dms-source
3-
api_key: app_key_token in KMS
4-
config:
5-
notes: description *optional*
6-
data-sources:
7-
- postgres:
8-
notes: Here are notes
9-
replica: Default
10-
source: dbdhcp3
11-
start-order: 1
12-
ami: ami-0dfffed98347ecd
133
connectors:
144
- postgres:
155
host: host_ref_in_kms
@@ -40,5 +30,5 @@ environments:
4030
branch: origin/feature/unit-tests
4131
datapod: Develop
4232
when:
43-
- custom: datapod.refresh
33+
- push: datapod.refresh
4434
- build-failure: datapod.undo

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class Mapper {
6666
return Yaml(
6767
contents.get("template").asText(),
6868
contents.get("parent").asText(),
69-
contents.get("api_key").asText(),
69+
//contents.get("api_key").asText(),
7070
mappedConfig,
7171
mappedConnector,
7272
mapEnvironments(contents["environments"])

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ class Validator(val contents: JsonNode) {
8585
fun validate() {
8686
field(contents, "template")
8787
field(contents, "parent")
88-
field(contents, "api_key")
8988
node(contents, "environments")
9089
environments(contents["environments"])
9190

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package com.delphix.yamlparser
33
data class Yaml(
44
val template: String,
55
val parent: String,
6-
val api_key: String,
76
val config: Config? = null,
87
val connectors: List<Connector>? = null,
98
val environments: List<Environment>

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,12 @@ class YamlTest {
1616
private val connector = Connector("name", "host", "port", "database", "username", "password")
1717
private val action = Action("event", "action")
1818
private val environment = Environment("develop", "branch", "datapod", listOf(action))
19-
private val yaml = Yaml("template", "parent", "api_key", config, listOf(connector), listOf(environment));
19+
private val yaml = Yaml("template", "parent", config, listOf(connector), listOf(environment));
2020

2121
@Test fun `can get template`() : Unit {
2222
assertEquals("template", yaml.template)
2323
}
2424

25-
@Test fun `can get api_key`() : Unit {
26-
assertEquals("api_key", yaml.api_key)
27-
}
28-
2925
@Test fun `can get environment`() : Unit {
3026
assertEquals("branch", yaml.environments.get(0).branch);
3127
}

0 commit comments

Comments
 (0)