Skip to content

Commit 84856bb

Browse files
committed
DOC/MINOR: discovery: adding configuration file snippets for YAML format
1 parent ab2c764 commit 84856bb

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

discovery/AWS.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,22 @@ service_discovery {
4545
}
4646
```
4747

48+
```yaml
49+
aws_regions:
50+
- description: "Allowlist example"
51+
allowlist:
52+
- key: tag-key
53+
value: "Must:Have:This:Tag:Key"
54+
enabled: false
55+
id: 96b14c57-b011-42e5-8d01-b58feba07319
56+
name: john.doe
57+
region: "us-east-1"
58+
retrytimeout: 10
59+
serverslotsbase: 10
60+
serverslotsgrowthincrement: 10
61+
serverslotsgrowthtype: exponential
62+
```
63+
4864
As `allowlist`, the `denylist` option allows to filter out specific instances matching the desired filters.
4965

5066
```hcl
@@ -77,6 +93,25 @@ service_discovery {
7793
}
7894
```
7995

96+
```yaml
97+
aws_regions:
98+
- description: "Denylist example"
99+
allowlist:
100+
- key: tag-key
101+
value: "Must:Have:This:Tag:Key"
102+
denylist:
103+
- key: "tag:Environment
104+
value: Development"
105+
enabled: false
106+
id: 96b14c57-b011-42e5-8d01-b58feba07319
107+
name: john.doe
108+
region: "us-east-1"
109+
retrytimeout: 10
110+
serverslotsbase: 10
111+
serverslotsgrowthincrement: 10
112+
serverslotsgrowthtype: exponential
113+
```
114+
80115
## Authorization
81116

82117
Data Plane API needs the plain AWS credentials to interact with it.
@@ -101,6 +136,21 @@ service_discovery {
101136
}
102137
```
103138

139+
```yaml
140+
aws_regions:
141+
- description: "Credentials example"
142+
secretaccesskey: "************************************soLl"
143+
accesskeyid: "****************L7GT"
144+
enabled: false
145+
id: 96b14c57-b011-42e5-8d01-b58feba07319
146+
name: john.doe
147+
region: "us-east-1"
148+
retrytimeout: 10
149+
serverslotsbase: 10
150+
serverslotsgrowthincrement: 10
151+
serverslotsgrowthtype: exponential
152+
```
153+
104154
> In case of Data Plane API running in an EC2 with a IAM Role attached (as [`AmazonEC2ReadOnlyAccess`](https://console.aws.amazon.com/iam/home#/policies/arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess$serviceLevelSummary)), there's no need for additional credentials.
105155

106156
## Server options
@@ -158,6 +208,16 @@ service_discovery {
158208
}
159209
```
160210

211+
```yaml
212+
aws_regions:
213+
- enabled: true
214+
name: john.doe
215+
region: "us-east-1"
216+
secretaccesskey: "************************************soLl"
217+
ipv4address: private
218+
retrytimeout: 60
219+
```
220+
161221
The resulting output will be the following, YMMV.
162222

163223
```
@@ -208,6 +268,17 @@ service_discovery {
208268
}
209269
```
210270

271+
```yaml
272+
aws_regions:
273+
- accesskeyid: "****************L7GT"
274+
enabled: false
275+
name: my-service-discovery
276+
region: "us-east-1"
277+
secretaccesskey: "****************soLl"
278+
ipv4address: private
279+
retrytimeout: 60
280+
```
281+
211282
As a result of this action, Data Plane API will not update the discovered `backend` sections and their `server` entries: no data will be lost.
212283

213284
> Potentially, due to the spawn of newer EC2 instances or reboots with a change of the IPv4 address, data could be outdated.

0 commit comments

Comments
 (0)