Skip to content

Commit ace229b

Browse files
Merge pull request #222 from alebedev87/docs-fix-indent
OCPBUGS-37059: docs/usage.md - fix broken yaml indent
2 parents 1ea7602 + 7b3ab8f commit ace229b

File tree

1 file changed

+69
-65
lines changed

1 file changed

+69
-65
lines changed

docs/usage.md

Lines changed: 69 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ the namespace where the _external-dns_ deployments are created so that they can
2424
apiVersion: v1
2525
kind: Secret
2626
metadata:
27-
name: aws-access-key
28-
namespace: external-dns-operator
27+
name: aws-access-key
28+
namespace: external-dns-operator
2929
stringData:
30-
credentials: |-
30+
credentials: |-
3131
[default]
32-
aws_access_key_id = " <AWS_ACCESS_KEY_ID>"
32+
aws_access_key_id = "<AWS_ACCESS_KEY_ID>"
3333
aws_secret_access_key = "<AWS_SECRET_ACCESS_KEY>"
3434
```
3535
@@ -39,16 +39,16 @@ the namespace where the _external-dns_ deployments are created so that they can
3939
apiVersion: externaldns.olm.openshift.io/v1beta1
4040
kind: ExternalDNS
4141
metadata:
42-
name: aws-example
42+
name: aws-example
4343
spec:
44-
provider:
44+
provider:
4545
type: AWS
4646
aws:
47-
credentials:
47+
credentials:
4848
name: aws-access-key
49-
zones: # Replace with the desired hosted zone IDs
49+
zones: # Replace with the desired hosted zone IDs
5050
- "Z3URY6TWQ91KXX"
51-
source:
51+
source:
5252
type: Service
5353
fqdnTemplate:
5454
- '{{.Name}}.mydomain.net'
@@ -129,7 +129,7 @@ As for the rest: the usage is exactly the same as for [AWS](#aws).
129129
3. Attach the permission policy to the role:
130130

131131
```bash
132-
curl -o external-dns-permission-policy.json https://raw.githubusercontent.com/openshift/external-dns-operator/main/assets/iam-policy.json
132+
curl -o external-dns-permission-policy.json https://raw.githubusercontent.com/openshift/external-dns-operator/main/assets/iam_policy.json
133133
aws iam put-role-policy --role-name external-dns --policy-name perms-policy-external-dns --policy-document file://external-dns-permission-policy.json
134134
```
135135

@@ -139,10 +139,10 @@ As for the rest: the usage is exactly the same as for [AWS](#aws).
139139
apiVersion: v1
140140
kind: Secret
141141
metadata:
142-
name: aws-sts-creds
143-
namespace: external-dns-operator
142+
name: aws-sts-creds
143+
namespace: external-dns-operator
144144
stringData:
145-
credentials: |-
145+
credentials: |-
146146
[default]
147147
sts_regional_endpoints = regional
148148
role_arn = ${EXTERNAL_DNS_ROLEARN}
@@ -155,16 +155,16 @@ As for the rest: the usage is exactly the same as for [AWS](#aws).
155155
apiVersion: externaldns.olm.openshift.io/v1beta1
156156
kind: ExternalDNS
157157
metadata:
158-
name: ${EXTERNAL_DNS_NAME}
158+
name: ${EXTERNAL_DNS_NAME}
159159
spec:
160-
provider:
160+
provider:
161161
type: AWS
162162
aws:
163-
credentials:
163+
credentials:
164164
name: aws-sts-creds
165-
zones: # Replace with the desired hosted zone IDs
165+
zones: # Replace with the desired hosted zone IDs
166166
- "Z3URY6TWQ91KXX"
167-
source:
167+
source:
168168
type: Service
169169
fqdnTemplate:
170170
- '{{.Name}}.mydomain.net'
@@ -187,11 +187,11 @@ the following information is required:
187187
apiVersion: v1
188188
kind: Secret
189189
metadata:
190-
name: infoblox-credentials
191-
namespace: #operator namespace
190+
name: infoblox-credentials
191+
namespace: external-dns-operator
192192
data:
193-
EXTERNAL_DNS_INFOBLOX_WAPI_USERNAME: # Base-64 encoded username
194-
EXTERNAL_DNS_INFOBLOX_WAPI_PASSWORD: # Base-64 encoded password
193+
EXTERNAL_DNS_INFOBLOX_WAPI_USERNAME: # Base-64 encoded username
194+
EXTERNAL_DNS_INFOBLOX_WAPI_PASSWORD: # Base-64 encoded password
195195
```
196196

197197
2. Create an `ExternalDNS` resource as follows:
@@ -200,19 +200,19 @@ the following information is required:
200200
apiVersion: externaldns.olm.openshift.io/v1beta1
201201
kind: ExternalDNS
202202
metadata:
203-
name: infoblox-example
203+
name: infoblox-example
204204
spec:
205-
provider:
205+
provider:
206206
type: Infoblox
207207
infoblox:
208-
credentials:
208+
credentials:
209209
name: infoblox-credentials
210-
gridHost: # the grid master host from the previous step. eg: 172.26.1.200
211-
wapiPort: # the WAPI port, eg: 80, 443, 8080
212-
wapiVersion: # the WAPI version, eg: 2.11, 2.3.1
213-
zones: # Replace with the desired hosted zones
210+
gridHost: # the grid master host from the previous step. eg: 172.26.1.200
211+
wapiPort: # the WAPI port, eg: 80, 443, 8080
212+
wapiVersion: # the WAPI version, eg: 2.11, 2.3.1
213+
zones: # Replace with the desired hosted zones
214214
- "ZG5zLm5ldHdvcmtfdmlldyQw"
215-
source:
215+
source:
216216
type: Service
217217
fqdnTemplate:
218218
- '{{.Name}}.mydomain.net'
@@ -237,13 +237,13 @@ running note down the following details:
237237

238238
```json
239239
{
240-
"gatewayHost": "https://bluecatgw.example.com",
241-
"gatewayUsername": "user",
242-
"gatewayPassword": "pass",
243-
"dnsConfiguration": "Example",
244-
"dnsView": "Internal",
245-
"rootZone": "example.com",
246-
"skipTLSVerify": false
240+
"gatewayHost": "https://bluecatgw.example.com",
241+
"gatewayUsername": "user",
242+
"gatewayPassword": "pass",
243+
"dnsConfiguration": "Example",
244+
"dnsView": "Internal",
245+
"rootZone": "example.com",
246+
"skipTLSVerify": false
247247
}
248248
```
249249

@@ -263,15 +263,19 @@ external-dns [documentation for BlueCat](https://github.com/kubernetes-sigs/exte
263263
apiVersion: externaldns.olm.openshift.io/v1beta1
264264
kind: ExternalDNS
265265
metadata:
266-
name: bluecat-example
266+
name: bluecat-example
267267
spec:
268-
provider:
268+
provider:
269269
type: BlueCat
270270
blueCat:
271-
config:
271+
configFile:
272272
name: bluecat-config
273-
zones: # Replace with the desired hosted zones
273+
zones: # Replace with the desired hosted zones
274274
- "78127234..."
275+
source:
276+
type: Service
277+
fqdnTemplate:
278+
- '{{.Name}}.mydomain.net'
275279
```
276280

277281
# GCP
@@ -284,10 +288,10 @@ Before creating an ExternalDNS resource for GCP, the following is required:
284288
apiVersion: v1
285289
kind: Secret
286290
metadata:
287-
name: gcp-access-key
288-
namespace: #operator namespace
291+
name: gcp-access-key
292+
namespace: external-dns-operator
289293
data:
290-
gcp-credentials.json: # gcp-service-account-key-file
294+
gcp-credentials.json: # gcp-service-account-key-file
291295
```
292296

293297
2. Create an `ExternalDNS` CR as follows:
@@ -296,18 +300,18 @@ Before creating an ExternalDNS resource for GCP, the following is required:
296300
apiVersion: externaldns.olm.openshift.io/v1beta1
297301
kind: ExternalDNS
298302
metadata:
299-
name: sample-gcp
303+
name: sample-gcp
300304
spec:
301-
# DNS provider
302-
provider:
305+
# DNS provider
306+
provider:
303307
type: GCP
304308
gcp:
305-
credentials:
309+
credentials:
306310
name: gcp-access-key
307-
project: gcp-devel
308-
zones: # Replace with the desired managed zones
311+
project: gcp-devel
312+
zones: # Replace with the desired managed zones
309313
- "3651032588905568971"
310-
source:
314+
source:
311315
type: Service
312316
fqdnTemplate:
313317
- '{{.Name}}.mydomain.net'
@@ -323,21 +327,21 @@ Before creating an ExternalDNS resource for Azure, the following is required:
323327
apiVersion: v1
324328
kind: Secret
325329
metadata:
326-
name: azure-config-file
327-
namespace: #operator namespace
330+
name: azure-config-file
331+
namespace: external-dns-operator
328332
data:
329-
azure.json: # azure-config-file
333+
azure.json: # azure-config-file
330334
```
331335

332336
The contents of `azure.json` should be similar to this:
333337

334338
```json
335339
{
336-
"tenantId": "01234abc-de56-ff78-abc1-234567890def",
337-
"subscriptionId": "01234abc-de56-ff78-abc1-234567890def",
338-
"resourceGroup": "MyDnsResourceGroup",
339-
"aadClientId": "01234abc-de56-ff78-abc1-234567890def",
340-
"aadClientSecret": "<clientSecret>"
340+
"tenantId": "01234abc-de56-ff78-abc1-234567890def",
341+
"subscriptionId": "01234abc-de56-ff78-abc1-234567890def",
342+
"resourceGroup": "MyDnsResourceGroup",
343+
"aadClientId": "01234abc-de56-ff78-abc1-234567890def",
344+
"aadClientSecret": "<clientSecret>"
341345
}
342346
```
343347

@@ -347,17 +351,17 @@ Before creating an ExternalDNS resource for Azure, the following is required:
347351
apiVersion: externaldns.olm.openshift.io/v1beta1
348352
kind: ExternalDNS
349353
metadata:
350-
name: sample-azure
354+
name: sample-azure
351355
spec:
352-
# DNS provider
353-
provider:
356+
# DNS provider
357+
provider:
354358
type: Azure
355359
azure:
356-
configFile:
360+
configFile:
357361
name: azure-config-file
358-
zones: # Replace with the desired hosted zones
362+
zones: # Replace with the desired hosted zones
359363
- "myzoneid"
360-
source:
364+
source:
361365
type: Service
362366
fqdnTemplate:
363367
- '{{.Name}}.mydomain.net'

0 commit comments

Comments
 (0)