-
Notifications
You must be signed in to change notification settings - Fork 33
/
externaldns.olm.openshift.io_externaldnses.yaml
956 lines (956 loc) · 51.5 KB
/
externaldns.olm.openshift.io_externaldnses.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.6.2
creationTimestamp: null
name: externaldnses.externaldns.olm.openshift.io
spec:
group: externaldns.olm.openshift.io
names:
kind: ExternalDNS
listKind: ExternalDNSList
plural: externaldnses
singular: externaldns
scope: Cluster
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: ExternalDNS describes a managed ExternalDNS controller instance
for a cluster. The controller is responsible for creating external DNS records
in supported DNS providers based off of instances of select Kubernetes resources.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: spec is the specification of the desired behavior of the
ExternalDNS.
properties:
domains:
description: "Domains specifies which domains that ExternalDNS should
create DNS records for. Multiple domain values can be specified
such that subdomains of an included domain can effectively be ignored
using the \"Include\" and \"Exclude\" domain filter options. \n
An empty list of domains means ExternalDNS will create DNS records
for any included source resource regardless of the resource's desired
hostname. \n Populating Domains with only excluded options means
ExternalDNS will create DNS records for any included source resource
that do not match the provided excluded domain options. \n Excluding
DNS records that were previous included via a resource update will
*not* result in the original DNS records being deleted."
items:
description: ExternalDNSDomain describes how sets of included or
excluded domains are to be constructed.
properties:
filterType:
description: "FilterType marks the Name or Pattern field as
an included or excluded set of domains. \n In the event of
contradicting domain options, preference is given to excluded
domains. \n This field accepts the following values: \n \"Include\":
Include the domain set specified by name or pattern. \n \"Exclude\":
Exclude the domain set specified by name or pattern."
enum:
- Include
- Exclude
type: string
matchType:
description: "MatchType specifies the type of match to be performed
by ExternalDNS when determining whether or not to publish
DNS records for a given source resource based on the resource's
requested hostname. \n This field accepts the following values:
\n \"Exact\": Explicitly match the full domain string specified
via the Name field, including any subdomains of Name. \n
\ \"Pattern\": Match potential domains against the provided
regular expression pattern string."
enum:
- Exact
- Pattern
type: string
name:
description: "Name is a string representing a single domain
value. Subdomains are included. \n e.g. my-app.my-cluster-domain.com
would also include foo.my-app.my-cluster-domain.com"
type: string
pattern:
description: Pattern is a regular expression used to match a
set of domains. Any provided regular expressions should follow
the syntax used by the go regexp package (RE2). See https://golang.org/pkg/regexp/
for more information.
type: string
required:
- filterType
- matchType
type: object
type: array
provider:
description: Provider refers to the DNS provider that ExternalDNS
should publish records to. Note that each ExternalDNS is tied to
a single provider.
properties:
aws:
description: AWS describes provider configuration options specific
to AWS (Route 53).
properties:
credentials:
description: "Credentials is a reference to a secret containing
the shared credentials file (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
under `credentials` key or following keys (with corresponding
values): \n * aws_access_key_id * aws_secret_access_key
\n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/aws.md
for more information."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- credentials
type: object
azure:
description: Azure describes provider configuration options specific
to Azure DNS.
properties:
configFile:
description: "ConfigFile is a reference to a secret containing
the necessary information to use the Azure provider. The
secret referenced by ConfigFile should contain a key named
`azure.json` similar to the following: \n { \"tenantId\":
\"123\", \"subscriptionId\": \"456\", \"resourceGroup\":
\"MyDnsResourceGroup\", \"aadClientId\": \"789\", \"aadClientSecret\":
\"123\" } \n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/azure.md
for more information on the necessary configuration key/values
and how to obtain them."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- configFile
type: object
blueCat:
description: BlueCat describes provider configuration options
specific to BlueCat DNS.
properties:
configFile:
description: "ConfigFile is a reference to a secret containing
the necessary information to use the BlueCat provider. The
secret referenced by ConfigFile should contain an object
named `bluecat.json` similar to the following: \n { \"gatewayHost\":
\"https://bluecatgw.example.com\", \"gatewayUsername\":
\"user\", \"gatewayPassword\": \"pass\", \"dnsConfiguration\":
\"Example\", \"dnsView\": \"Internal\", \"rootZone\":
\"example.com\", \"skipTLSVerify\": false } \n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/bluecat.md
for more information on the necessary configuration values
and how to obtain them."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- configFile
type: object
gcp:
description: GCP describes provider configuration options specific
to GCP (Google DNS).
properties:
credentials:
description: Credentials is a reference to a secret containing
the necessary GCP service account keys. The secret referenced
by Credentials should contain a key named `gcp-credentials.json`
presumably generated by the gcloud CLI.
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
project:
description: Project is the GCP project to use for creating
DNS records. This field is not necessary when running on
GCP as externalDNS auto-detects the GCP project to use when
running on GCP.
type: string
required:
- credentials
type: object
infoblox:
description: Infoblox describes provider configuration options
specific to Infoblox DNS.
properties:
credentials:
description: "Credentials is a reference to a secret containing
the following keys (with proper corresponding values): \n
* EXTERNAL_DNS_INFOBLOX_WAPI_USERNAME * EXTERNAL_DNS_INFOBLOX_WAPI_PASSWORD
\n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/infoblox.md
for more information and configuration options."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
gridHost:
description: GridHost is the IP of the Infoblox Grid host.
type: string
wapiPort:
description: WAPIPort is the port for the Infoblox WAPI.
type: integer
wapiVersion:
description: WAPIVersion is the version of the Infoblox WAPI.
type: string
required:
- credentials
- gridHost
- wapiPort
- wapiVersion
type: object
type:
description: "Type describes which DNS provider ExternalDNS should
publish records to. The following DNS providers are supported:
\n * AWS (Route 53) * GCP (Google DNS) * Azure * BlueCat
\ * Infoblox"
enum:
- AWS
- GCP
- Azure
- BlueCat
- Infoblox
type: string
required:
- type
type: object
source:
description: "Source describes which source resource ExternalDNS will
be configured to create DNS records for. \n Multiple ExternalDNS
CRs must be created if multiple ExternalDNS source resources are
desired."
properties:
fqdnTemplate:
description: "FQDNTemplate sets a templated string that's used
to generate DNS names from sources that don't define a hostname
themselves. Multiple global FQDN templates are possible. \n
This field must be specified with a nonempty value if the source
type is Service or CRD and HostnameAnnotationPolicy is set to
Ignore. The field value may be omitted or empty if HostnameAnnotationPolicy
is set to Allow or if the source type is OpenShiftRoute. \n
Provided templates should follow the syntax defined for text/template
Go package, see https://pkg.go.dev/text/template. Annotations
inside the template correspond to the definition of the source
resource object (e.g. Kubernetes service, OpenShift route).
Example: \"{{.Name}}.example.com\" would be expanded to \"myservice.example.com\"
for service source"
items:
type: string
type: array
hostnameAnnotation:
default: Ignore
description: "HostnameAnnotationPolicy specifies whether or not
ExternalDNS should ignore the \"external-dns.alpha.kubernetes.io/hostname\"
annotation, which overrides DNS hostnames on a given source
resource. \n The following values are accepted: \n \"Ignore\":
Ignore any hostname annotation overrides. \"Allow\": Allow
all hostname annotation overrides. \n The default behavior of
the ExternalDNS is \"Ignore\". \n Note that by setting a HostnameAnnotationPolicy
of \"Allow\", may grant privileged DNS permissions to under-privileged
cluster users."
enum:
- Ignore
- Allow
type: string
labelFilter:
description: LabelFilter specifies a label selector for filtering
the objects for which ExternalDNS publishes records. The filter
uses label selector semantics against object labels. Specifying
a null or empty label selector causes ExternalDNS to publish
records for all objects of the source type resource.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector
that contains values, a key, and an operator that relates
the key and values.
properties:
key:
description: key is the label key that the selector
applies to.
type: string
operator:
description: operator represents a key's relationship
to a set of values. Valid operators are In, NotIn,
Exists and DoesNotExist.
type: string
values:
description: values is an array of string values. If
the operator is In or NotIn, the values array must
be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced
during a strategic merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A
single {key,value} in the matchLabels map is equivalent
to an element of matchExpressions, whose key field is "key",
the operator is "In", and the values array contains only
"value". The requirements are ANDed.
type: object
type: object
openshiftRouteOptions:
description: OpenShiftRoute describes source configuration options
specific to the routes.route.openshift.io resource.
properties:
routerName:
description: RouterName is the name of a router (AKA ingress
controller) as reported in Route.status.ingress[].routerName. External-dns
will use the canonical hostname of the router identified
by this name when publishing records for a given route.
type: string
required:
- routerName
type: object
service:
description: Service describes source configuration options specific
to the service source resource.
properties:
serviceType:
default:
- LoadBalancer
description: "ServiceType determines what types of Service
resources are watched by ExternalDNS. The following types
are available options: \n \"NodePort\" \"ExternalName\"
\ \"LoadBalancer\" \"ClusterIP\" \n One or more Service
types can be specified, if desired. \n Note that using the
\"ClusterIP\" service type will enable the ExternalDNS \"--publish-internal-services\"
flag, which allows ExternalDNS to publish DNS records for
ClusterIP services. \n If no service types are provided,
ExternalDNS will be configured to create DNS records for
LoadBalancer services only by default."
items:
description: Service Type string describes ingress methods
for a service
type: string
minItems: 1
type: array
type: object
type:
description: Type specifies an ExternalDNS source resource to
create DNS records for.
enum:
- OpenShiftRoute
- Service
- CRD
type: string
required:
- type
type: object
zones:
description: "Zones describes which DNS Zone IDs ExternalDNS should
publish records to. \n Updating this field after creation will cause
all DNS records in the previous zone(s) to be left behind. \n An
empty list of zones means that the ExternalDNS will publish to all
zones (i.e public and private), unless the operator runs on a platform
on which the operator can lookup a default set of zones e.g on OpenShift
with its cluster DNS config"
items:
type: string
maxItems: 10
type: array
required:
- provider
- source
type: object
status:
description: status is the most recently observed status of the ExternalDNS.
properties:
conditions:
description: Conditions is a list of operator-specific conditions
and their status.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n \ttype FooStatus struct{ \t // Represents the observations
of a foo's current state. \t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\" \t //
+patchMergeKey=type \t // +patchStrategy=merge \t // +listType=map
\t // +listMapKey=type \t Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n \t // other fields
\t}"
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another. This should be when
the underlying condition changed. If that is not known, then
using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: reason contains a programmatic identifier indicating
the reason for the condition's last transition. Producers
of specific condition types may define expected values and
meanings for this field, and whether the values are considered
a guaranteed API. The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
observedGeneration:
description: ObservedGeneration is the most recent generation observed.
format: int64
type: integer
zones:
description: Zones is the configured zones in use by ExternalDNS.
items:
type: string
type: array
type: object
required:
- spec
type: object
served: true
storage: false
subresources:
status: {}
- name: v1beta1
schema:
openAPIV3Schema:
description: ExternalDNS describes a managed ExternalDNS controller instance
for a cluster. The controller is responsible for creating external DNS records
in supported DNS providers based off of instances of select Kubernetes resources.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: spec is the specification of the desired behavior of the
ExternalDNS.
properties:
domains:
description: "Domains specifies which domains that ExternalDNS should
create DNS records for. Multiple domain values can be specified
such that subdomains of an included domain can effectively be ignored
using the \"Include\" and \"Exclude\" domain filter options. \n
An empty list of domains means ExternalDNS will create DNS records
for any included source resource regardless of the resource's desired
hostname. \n Populating Domains with only excluded options means
ExternalDNS will create DNS records for any included source resource
that do not match the provided excluded domain options. \n Excluding
DNS records that were previous included via a resource update will
*not* result in the original DNS records being deleted."
items:
description: ExternalDNSDomain describes how sets of included or
excluded domains are to be constructed.
properties:
filterType:
description: "FilterType marks the Name or Pattern field as
an included or excluded set of domains. \n In the event of
contradicting domain options, preference is given to excluded
domains. \n This field accepts the following values: \n \"Include\":
Include the domain set specified by name or pattern. \n \"Exclude\":
Exclude the domain set specified by name or pattern."
enum:
- Include
- Exclude
type: string
matchType:
description: "MatchType specifies the type of match to be performed
by ExternalDNS when determining whether or not to publish
DNS records for a given source resource based on the resource's
requested hostname. \n This field accepts the following values:
\n \"Exact\": Explicitly match the full domain string specified
via the Name field, including any subdomains of Name. \n
\ \"Pattern\": Match potential domains against the provided
regular expression pattern string."
enum:
- Exact
- Pattern
type: string
name:
description: "Name is a string representing a single domain
value. Subdomains are included. \n e.g. my-app.my-cluster-domain.com
would also include foo.my-app.my-cluster-domain.com"
type: string
pattern:
description: Pattern is a regular expression used to match a
set of domains. Any provided regular expressions should follow
the syntax used by the go regexp package (RE2). See https://golang.org/pkg/regexp/
for more information.
type: string
required:
- filterType
- matchType
type: object
type: array
provider:
description: Provider refers to the DNS provider that ExternalDNS
should publish records to. Note that each ExternalDNS is tied to
a single provider.
properties:
aws:
description: AWS describes provider configuration options specific
to AWS (Route 53).
properties:
credentials:
description: "Credentials is a reference to a secret containing
the following keys (with corresponding values): \n * aws_access_key_id
* aws_secret_access_key \n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/aws.md
for more information."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- credentials
type: object
azure:
description: Azure describes provider configuration options specific
to Azure DNS.
properties:
configFile:
description: "ConfigFile is a reference to a secret containing
the necessary information to use the Azure provider. The
secret referenced by ConfigFile should contain a key named
`azure.json` similar to the following: \n { \"tenantId\":
\"123\", \"subscriptionId\": \"456\", \"resourceGroup\":
\"MyDnsResourceGroup\", \"aadClientId\": \"789\", \"aadClientSecret\":
\"123\" } \n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/azure.md
for more information on the necessary configuration key/values
and how to obtain them."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- configFile
type: object
blueCat:
description: BlueCat describes provider configuration options
specific to BlueCat DNS.
properties:
configFile:
description: "ConfigFile is a reference to a secret containing
the necessary information to use the BlueCat provider. The
secret referenced by ConfigFile should contain an object
named `bluecat.json` similar to the following: \n { \"gatewayHost\":
\"https://bluecatgw.example.com\", \"gatewayUsername\":
\"user\", \"gatewayPassword\": \"pass\", \"dnsConfiguration\":
\"Example\", \"dnsView\": \"Internal\", \"rootZone\":
\"example.com\", \"skipTLSVerify\": false } \n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/bluecat.md
for more information on the necessary configuration values
and how to obtain them."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
required:
- configFile
type: object
gcp:
description: GCP describes provider configuration options specific
to GCP (Google DNS).
properties:
credentials:
description: Credentials is a reference to a secret containing
the necessary GCP service account keys. The secret referenced
by Credentials should contain a key named `gcp-credentials.json`
presumably generated by the gcloud CLI.
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
project:
description: Project is the GCP project to use for creating
DNS records. This field is not necessary when running on
GCP as externalDNS auto-detects the GCP project to use when
running on GCP.
type: string
required:
- credentials
type: object
infoblox:
description: Infoblox describes provider configuration options
specific to Infoblox DNS.
properties:
credentials:
description: "Credentials is a reference to a secret containing
the following keys (with proper corresponding values): \n
* EXTERNAL_DNS_INFOBLOX_WAPI_USERNAME * EXTERNAL_DNS_INFOBLOX_WAPI_PASSWORD
\n See https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/infoblox.md
for more information and configuration options."
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
gridHost:
description: GridHost is the IP of the Infoblox Grid host.
type: string
wapiPort:
description: WAPIPort is the port for the Infoblox WAPI.
type: integer
wapiVersion:
description: WAPIVersion is the version of the Infoblox WAPI.
type: string
required:
- credentials
- gridHost
- wapiPort
- wapiVersion
type: object
type:
description: "Type describes which DNS provider ExternalDNS should
publish records to. The following DNS providers are supported:
\n * AWS (Route 53) * GCP (Google DNS) * Azure * BlueCat
\ * Infoblox"
enum:
- AWS
- GCP
- Azure
- BlueCat
- Infoblox
type: string
required:
- type
type: object
source:
description: "Source describes which source resource ExternalDNS will
be configured to create DNS records for. \n Multiple ExternalDNS
CRs must be created if multiple ExternalDNS source resources are
desired."
properties:
fqdnTemplate:
description: "FQDNTemplate sets a templated string that's used
to generate DNS names from sources that don't define a hostname
themselves. Multiple global FQDN templates are possible. \n
This field must be specified with a nonempty value if the source
type is Service or CRD and HostnameAnnotationPolicy is set to
Ignore. The field value may be omitted or empty if HostnameAnnotationPolicy
is set to Allow or if the source type is OpenShiftRoute. \n
Provided templates should follow the syntax defined for text/template
Go package, see https://pkg.go.dev/text/template. Annotations
inside the template correspond to the definition of the source
resource object (e.g. Kubernetes service, OpenShift route).
Example: \"{{.Name}}.example.com\" would be expanded to \"myservice.example.com\"
for service source"
items:
type: string
type: array
hostnameAnnotation:
default: Ignore
description: "HostnameAnnotationPolicy specifies whether or not
ExternalDNS should ignore the \"external-dns.alpha.kubernetes.io/hostname\"
annotation, which overrides DNS hostnames on a given source
resource. \n The following values are accepted: \n \"Ignore\":
Ignore any hostname annotation overrides. \"Allow\": Allow
all hostname annotation overrides. \n The default behavior of
the ExternalDNS is \"Ignore\". \n Note that by setting a HostnameAnnotationPolicy
of \"Allow\", may grant privileged DNS permissions to under-privileged
cluster users."
enum:
- Ignore
- Allow
type: string
labelFilter:
description: LabelFilter specifies a label selector for filtering
the objects for which ExternalDNS publishes records. The filter
uses label selector semantics against object labels. Specifying
a null or empty label selector causes ExternalDNS to publish
records for all objects of the source type resource.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector
that contains values, a key, and an operator that relates
the key and values.
properties:
key:
description: key is the label key that the selector
applies to.
type: string
operator:
description: operator represents a key's relationship
to a set of values. Valid operators are In, NotIn,
Exists and DoesNotExist.
type: string
values:
description: values is an array of string values. If
the operator is In or NotIn, the values array must
be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced
during a strategic merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A
single {key,value} in the matchLabels map is equivalent
to an element of matchExpressions, whose key field is "key",
the operator is "In", and the values array contains only
"value". The requirements are ANDed.
type: object
type: object
openshiftRouteOptions:
description: OpenShiftRoute describes source configuration options
specific to the routes.route.openshift.io resource.
properties:
routerName:
description: RouterName is the name of a router (AKA ingress
controller) as reported in Route.status.ingress[].routerName. External-dns
will use the canonical hostname of the router identified
by this name when publishing records for a given route.
type: string
required:
- routerName
type: object
service:
description: Service describes source configuration options specific
to the service source resource.
properties:
serviceType:
default:
- LoadBalancer
description: "ServiceType determines what types of Service
resources are watched by ExternalDNS. The following types
are available options: \n \"NodePort\" \"ExternalName\"
\ \"LoadBalancer\" \"ClusterIP\" \n One or more Service
types can be specified, if desired. \n Note that using the
\"ClusterIP\" service type will enable the ExternalDNS \"--publish-internal-services\"
flag, which allows ExternalDNS to publish DNS records for
ClusterIP services. \n If no service types are provided,
ExternalDNS will be configured to create DNS records for
LoadBalancer services only by default."
items:
description: Service Type string describes ingress methods
for a service
type: string
minItems: 1
type: array
type: object
type:
description: Type specifies an ExternalDNS source resource to
create DNS records for.
enum:
- OpenShiftRoute
- Service
- CRD
type: string
required:
- type
type: object
zones:
description: "Zones describes which DNS Zone IDs ExternalDNS should
publish records to. \n Updating this field after creation will cause
all DNS records in the previous zone(s) to be left behind. \n An
empty list of zones means that the ExternalDNS will publish to all
zones (i.e public and private), unless the operator runs on a platform
on which the operator can lookup a default set of zones e.g on OpenShift
with its cluster DNS config"
items:
type: string
maxItems: 10
type: array
required:
- provider
- source
type: object
status:
description: status is the most recently observed status of the ExternalDNS.
properties:
conditions:
description: Conditions is a list of operator-specific conditions
and their status.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n \ttype FooStatus struct{ \t // Represents the observations
of a foo's current state. \t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\" \t //
+patchMergeKey=type \t // +patchStrategy=merge \t // +listType=map
\t // +listMapKey=type \t Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n \t // other fields
\t}"
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another. This should be when
the underlying condition changed. If that is not known, then
using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: reason contains a programmatic identifier indicating
the reason for the condition's last transition. Producers
of specific condition types may define expected values and
meanings for this field, and whether the values are considered
a guaranteed API. The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
observedGeneration:
description: ObservedGeneration is the most recent generation observed.
format: int64
type: integer
zones:
description: Zones is the configured zones in use by ExternalDNS.
items:
type: string
type: array
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []