Skip to content

Commit ec212cf

Browse files
authored
docs: update examples in documentation (#31)
1 parent 59b4deb commit ec212cf

File tree

1 file changed

+35
-11
lines changed

1 file changed

+35
-11
lines changed

docs/config/dns-service-config.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,13 @@ Matches all `Cluster` resources that do not have `foo` in their purpose list.
126126

127127
All examples below use a purpose selector that matches all `Cluster` resources which have `test` among their purposes.
128128

129-
###### Example 1 - Git Repo with DNS Secret
129+
###### Example 1 - Git Repo
130130

131131
```yaml
132132
apiVersion: dns.openmcp.cloud/v1alpha1
133133
kind: DNSServiceConfig
134134
metadata:
135135
name: dns
136-
namespace: openmcp-system
137136
spec:
138137
secretsToCopy:
139138
toTargetCluster:
@@ -153,11 +152,19 @@ spec:
153152
purposeSelector:
154153
name: test
155154
helmValues:
155+
policy: sync
156+
txtOwnerId: '<environment>.<cluster.namespace>.<cluster.name>'
157+
sources:
158+
- service
159+
- gateway-httproute
160+
- gateway-tlsroute
156161
provider:
157162
name: aws
158163
env:
159164
- name: AWS_DEFAULT_REGION
160165
value: eu-central-1
166+
- name: AWS_SHARED_CREDENTIALS_FILE
167+
value: /.aws/credentials
161168
extraVolumes:
162169
- name: aws-credentials
163170
secret:
@@ -168,6 +175,21 @@ spec:
168175
readOnly: true
169176
```
170177

178+
The AWS secret for this example is expected to look like this:
179+
```yaml
180+
apiVersion: v1
181+
kind: Secret
182+
metadata:
183+
name: route53-access
184+
namespace: openmcp-system
185+
stringData:
186+
credentials: |
187+
[default]
188+
aws_access_key_id=<access-key-id>
189+
aws_secret_access_key=<secret-access-key>
190+
type: Opaque
191+
```
192+
171193
###### Example 2 - OCI Repo with Auth Secret
172194

173195
```yaml
@@ -178,9 +200,12 @@ metadata:
178200
namespace: openmcp-system
179201
spec:
180202
secretsToCopy:
203+
toTargetCluster:
204+
- source:
205+
name: route53-access
181206
toPlatformCluster:
182207
- source:
183-
name: ghcr-access
208+
name: ghcr-access # pull secret for OCI registry holding the helm chart
184209
185210
externalDNSSource:
186211
oci:
@@ -192,10 +217,7 @@ spec:
192217
name: ghcr-access
193218
194219
externalDNSForPurposes:
195-
- name: test
196-
purposeSelector:
197-
name: test
198-
helmValues: {}
220+
# similar to example 1
199221
```
200222

201223
###### Example 3 - Helm Repo
@@ -207,15 +229,17 @@ metadata:
207229
name: dns
208230
namespace: openmcp-system
209231
spec:
232+
secretsToCopy:
233+
toTargetCluster:
234+
- source:
235+
name: route53-access
236+
210237
externalDNSSource:
211238
chartName: external-dns@1.19.0
212239
helm:
213240
url: https://kubernetes-sigs.github.io/external-dns/
214241
interval: 1h
215242
216243
externalDNSForPurposes:
217-
- name: test
218-
purposeSelector:
219-
name: test
220-
helmValues: {}
244+
# similar to example 1
221245
```

0 commit comments

Comments
 (0)