-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy path0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml
650 lines (646 loc) · 34.9 KB
/
0000_00_operator.open-cluster-management.io_klusterlets.crd.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
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: klusterlets.operator.open-cluster-management.io
spec:
group: operator.open-cluster-management.io
names:
kind: Klusterlet
listKind: KlusterletList
plural: klusterlets
singular: klusterlet
preserveUnknownFields: false
scope: Cluster
versions:
- name: v1
schema:
openAPIV3Schema:
description: |-
Klusterlet represents controllers to install the resources for a managed cluster.
When configured, the Klusterlet requires a secret named bootstrap-hub-kubeconfig in the
agent namespace to allow API requests to the hub for the registration protocol.
In Hosted mode, the Klusterlet requires an additional secret named external-managed-kubeconfig
in the agent namespace to allow API requests to the managed cluster for resources installation.
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 represents the desired deployment configuration of Klusterlet
agent.
properties:
clusterName:
description: |-
ClusterName is the name of the managed cluster to be created on hub.
The Klusterlet agent generates a random name if it is not set, or discovers the appropriate cluster name on OpenShift.
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
deployOption:
description: DeployOption contains the options of deploying a klusterlet
properties:
mode:
description: |-
Mode can be Default, Hosted, Singleton or SingletonHosted. It is Default mode if not specified
In Default mode, all klusterlet related resources are deployed on the managed cluster.
In Hosted mode, only crd and configurations are installed on the spoke/managed cluster. Controllers run in another
cluster (defined as management-cluster) and connect to the mangaged cluster with the kubeconfig in secret of
"external-managed-kubeconfig"(a kubeconfig of managed-cluster with cluster-admin permission).
In Singleton mode, registration/work agent is started as a single deployment.
In SingletonHosted mode, agent is started as a single deployment in hosted mode.
Note: Do not modify the Mode field once it's applied.
type: string
type: object
externalServerURLs:
description: |-
ExternalServerURLs represents a list of apiserver urls and ca bundles that is accessible externally
If it is set empty, managed cluster has no externally accessible url that hub cluster can visit.
items:
description: ServerURL represents the apiserver url and ca bundle
that is accessible externally
properties:
caBundle:
description: |-
CABundle is the ca bundle to connect to apiserver of the managed cluster.
System certs are used if it is not set.
format: byte
type: string
url:
description: URL is the url of apiserver endpoint of the managed
cluster.
type: string
required:
- url
type: object
type: array
hubApiServerHostAlias:
description: |-
HubApiServerHostAlias contains the host alias for hub api server.
registration-agent and work-agent will use it to communicate with hub api server.
properties:
hostname:
description: Hostname for the above IP address.
pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$
type: string
ip:
description: IP address of the host file entry.
pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
type: string
required:
- hostname
- ip
type: object
imagePullSpec:
description: |-
ImagePullSpec represents the desired image configuration of agent, it takes effect only when
singleton mode is set. quay.io/open-cluster-management.io/registration-operator:latest will
be used if unspecified
type: string
namespace:
description: |-
Namespace is the namespace to deploy the agent on the managed cluster.
The namespace must have a prefix of "open-cluster-management-", and if it is not set,
the namespace of "open-cluster-management-agent" is used to deploy agent.
In addition, the add-ons are deployed to the namespace of "{Namespace}-addon".
In the Hosted mode, this namespace still exists on the managed cluster to contain
necessary resources, like service accounts, roles and rolebindings, while the agent
is deployed to the namespace with the same name as klusterlet on the management cluster.
maxLength: 57
pattern: ^open-cluster-management-[-a-z0-9]*[a-z0-9]$
type: string
nodePlacement:
description: NodePlacement enables explicit control over the scheduling
of the deployed pods.
properties:
nodeSelector:
additionalProperties:
type: string
description: NodeSelector defines which Nodes the Pods are scheduled
on. The default is an empty list.
type: object
tolerations:
description: |-
Tolerations are attached by pods to tolerate any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
The default is an empty list.
items:
description: |-
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
description: |-
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
description: |-
Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.
type: string
operator:
description: |-
Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.
type: string
tolerationSeconds:
description: |-
TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
description: |-
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
type: object
priorityClassName:
description: |-
PriorityClassName is the name of the PriorityClass that will be used by the
deployed klusterlet agent. It will be ignored when the PriorityClass/v1 API
is not available on the managed cluster.
type: string
registrationConfiguration:
description: RegistrationConfiguration contains the configuration
of registration
properties:
bootstrapKubeConfigs:
description: |-
BootstrapKubeConfigs defines the ordered list of bootstrap kubeconfigs. The order decides which bootstrap kubeconfig to use first when rebootstrap.
When the agent loses the connection to the current hub over HubConnectionTimeoutSeconds, or the managedcluster CR
is set `hubAcceptsClient=false` on the hub, the controller marks the related bootstrap kubeconfig as "failed".
A failed bootstrapkubeconfig won't be used for the duration specified by SkipFailedBootstrapKubeConfigSeconds.
But if the user updates the content of a failed bootstrapkubeconfig, the "failed" mark will be cleared.
properties:
localSecretsConfig:
description: |-
LocalSecretsConfig include a list of secrets that contains the kubeconfigs for ordered bootstrap kubeconifigs.
The secrets must be in the same namespace where the agent controller runs.
properties:
hubConnectionTimeoutSeconds:
default: 600
description: |-
HubConnectionTimeoutSeconds is used to set the timeout of connecting to the hub cluster.
When agent loses the connection to the hub over the timeout seconds, the agent do a rebootstrap.
By default is 10 mins.
format: int32
minimum: 180
type: integer
kubeConfigSecrets:
description: KubeConfigSecrets is a list of secret names.
The secrets are in the same namespace where the agent
controller runs.
items:
properties:
name:
description: Name is the name of the secret.
type: string
required:
- name
type: object
type: array
required:
- kubeConfigSecrets
type: object
type:
default: None
description: |-
Type specifies the type of priority bootstrap kubeconfigs.
By default, it is set to None, representing no priority bootstrap kubeconfigs are set.
enum:
- None
- LocalSecrets
type: string
required:
- type
type: object
clientCertExpirationSeconds:
description: |-
clientCertExpirationSeconds represents the seconds of a client certificate to expire. If it is not set or 0, the default
duration seconds will be set by the hub cluster. If the value is larger than the max signing duration seconds set on
the hub cluster, the max signing duration seconds will be set.
format: int32
type: integer
clusterAnnotations:
additionalProperties:
type: string
description: |-
ClusterAnnotations is annotations with the reserve prefix "agent.open-cluster-management.io" set on
ManagedCluster when creating only, other actors can update it afterwards.
type: object
clusterClaimConfiguration:
description: |-
ClusterClaimConfiguration represents the configuration of ClusterClaim
Effective only when the `ClusterClaim` feature gate is enabled.
properties:
maxCustomClusterClaims:
default: 20
description: Maximum number of custom ClusterClaims allowed.
format: int32
type: integer
reservedClusterClaimSuffixes:
description: Custom suffixes for reserved ClusterClaims.
items:
type: string
type: array
required:
- maxCustomClusterClaims
type: object
featureGates:
description: "FeatureGates represents the list of feature gates
for registration\nIf it is set empty, default feature gates
will be used.\nIf it is set, featuregate/Foo is an example of
one item in FeatureGates:\n 1. If featuregate/Foo does not
exist, registration-operator will discard it\n 2. If featuregate/Foo
exists and is false by default. It is now possible to set featuregate/Foo=[false|true]\n
\ 3. If featuregate/Foo exists and is true by default. If a
cluster-admin upgrading from 1 to 2 wants to continue having
featuregate/Foo=false,\n \the can set featuregate/Foo=false
before upgrading. Let's say the cluster-admin wants featuregate/Foo=false."
items:
properties:
feature:
description: Feature is the key of feature gate. e.g. featuregate/Foo.
type: string
mode:
default: Disable
description: |-
Mode is either Enable, Disable, "" where "" is Disable by default.
In Enable mode, a valid feature gate `featuregate/Foo` will be set to "--featuregate/Foo=true".
In Disable mode, a valid feature gate `featuregate/Foo` will be set to "--featuregate/Foo=false".
enum:
- Enable
- Disable
type: string
required:
- feature
type: object
type: array
kubeAPIBurst:
default: 100
description: |-
KubeAPIBurst indicates the maximum burst of the throttle while talking with apiserver of hub cluster from the spoke cluster.
If it is set empty, use the default value: 100
format: int32
type: integer
kubeAPIQPS:
default: 50
description: |-
KubeAPIQPS indicates the maximum QPS while talking with apiserver of hub cluster from the spoke cluster.
If it is set empty, use the default value: 50
format: int32
type: integer
registrationDriver:
description: This provides driver details required to register
with hub
properties:
authType:
default: csr
description: Type of the authentication used by managedcluster
to register as well as pull work from hub. Possible values
are csr and awsirsa.
enum:
- csr
- awsirsa
type: string
awsIrsa:
description: |-
Contain the details required for registering with hub cluster (ie: an EKS cluster) using AWS IAM roles for service account.
This is required only when the authType is awsirsa.
properties:
hubClusterArn:
description: |-
The arn of the hub cluster (ie: an EKS cluster). This will be required to pass information to hub, which hub will use to create IAM identities for this klusterlet.
Example - arn:eks:us-west-2:12345678910:cluster/hub-cluster1.
minLength: 1
pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
type: string
managedClusterArn:
description: |-
The arn of the managed cluster (ie: an EKS cluster). This will be required to generate the md5hash which will be used as a suffix to create IAM role on hub
as well as used by kluslerlet-agent, to assume role suffixed with the md5hash, on startup.
Example - arn:eks:us-west-2:12345678910:cluster/managed-cluster1.
minLength: 1
pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
type: string
required:
- hubClusterArn
- managedClusterArn
type: object
required:
- authType
type: object
type: object
registrationImagePullSpec:
description: |-
RegistrationImagePullSpec represents the desired image configuration of registration agent.
quay.io/open-cluster-management.io/registration:latest will be used if unspecified.
type: string
resourceRequirement:
description: |-
ResourceRequirement specify QoS classes of deployments managed by klusterlet.
It applies to all the containers in the deployments.
properties:
resourceRequirements:
description: ResourceRequirements defines resource requests and
limits when Type is ResourceQosClassResourceRequirement
properties:
claims:
description: |-
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: |-
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
type: string
request:
description: |-
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
type:
default: Default
enum:
- Default
- BestEffort
- ResourceRequirement
type: string
type: object
workConfiguration:
description: WorkConfiguration contains the configuration of work
properties:
appliedManifestWorkEvictionGracePeriod:
description: |-
AppliedManifestWorkEvictionGracePeriod is the eviction grace period the work agent will wait before
evicting the AppliedManifestWorks, whose corresponding ManifestWorks are missing on the hub cluster, from
the managed cluster. If not present, the default value of the work agent will be used.
pattern: ^([0-9]+(s|m|h))+$
type: string
featureGates:
description: "FeatureGates represents the list of feature gates
for work\nIf it is set empty, default feature gates will be
used.\nIf it is set, featuregate/Foo is an example of one item
in FeatureGates:\n 1. If featuregate/Foo does not exist, registration-operator
will discard it\n 2. If featuregate/Foo exists and is false
by default. It is now possible to set featuregate/Foo=[false|true]\n
\ 3. If featuregate/Foo exists and is true by default. If a
cluster-admin upgrading from 1 to 2 wants to continue having
featuregate/Foo=false,\n \the can set featuregate/Foo=false
before upgrading. Let's say the cluster-admin wants featuregate/Foo=false."
items:
properties:
feature:
description: Feature is the key of feature gate. e.g. featuregate/Foo.
type: string
mode:
default: Disable
description: |-
Mode is either Enable, Disable, "" where "" is Disable by default.
In Enable mode, a valid feature gate `featuregate/Foo` will be set to "--featuregate/Foo=true".
In Disable mode, a valid feature gate `featuregate/Foo` will be set to "--featuregate/Foo=false".
enum:
- Enable
- Disable
type: string
required:
- feature
type: object
type: array
kubeAPIBurst:
default: 100
description: |-
KubeAPIBurst indicates the maximum burst of the throttle while talking with apiserver of hub cluster from the spoke cluster.
If it is set empty, use the default value: 100
format: int32
type: integer
kubeAPIQPS:
default: 50
description: |-
KubeAPIQPS indicates the maximum QPS while talking with apiserver of hub cluster from the spoke cluster.
If it is set empty, use the default value: 50
format: int32
type: integer
type: object
workImagePullSpec:
description: |-
WorkImagePullSpec represents the desired image configuration of work agent.
quay.io/open-cluster-management.io/work:latest will be used if unspecified.
type: string
type: object
status:
description: Status represents the current status of Klusterlet agent.
properties:
conditions:
description: |-
Conditions contain the different condition statuses for this Klusterlet.
Valid condition types are:
Applied: Components have been applied in the managed cluster.
Available: Components in the managed cluster are available and ready to serve.
Progressing: Components in the managed cluster are in a transitioning state.
Degraded: Components in the managed cluster do not match the desired configuration and only provide
degraded service.
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
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.
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
generations:
description: Generations are used to determine when an item needs
to be reconciled or has changed in a way that needs a reaction.
items:
description: |-
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
The definition matches the GenerationStatus defined in github.com/openshift/api/v1
properties:
group:
description: group is the group of the resource that you're
tracking
type: string
lastGeneration:
description: lastGeneration is the last generation of the resource
that controller applies
format: int64
type: integer
name:
description: name is the name of the resource that you're tracking
type: string
namespace:
description: namespace is where the resource that you're tracking
is
type: string
resource:
description: resource is the resource type of the resource that
you're tracking
type: string
version:
description: version is the version of the resource that you're
tracking
type: string
required:
- group
- lastGeneration
- name
- resource
- version
type: object
type: array
observedGeneration:
description: ObservedGeneration is the last generation change you've
dealt with
format: int64
type: integer
relatedResources:
description: RelatedResources are used to track the resources that
are related to this Klusterlet.
items:
description: RelatedResourceMeta represents the resource that is
managed by an operator
properties:
group:
description: group is the group of the resource that you're
tracking
type: string
name:
description: name is the name of the resource that you're tracking
type: string
namespace:
description: namespace is where the thing you're tracking is
type: string
resource:
description: resource is the resource type of the resource that
you're tracking
type: string
version:
description: version is the version of the thing you're tracking
type: string
required:
- group
- name
- resource
- version
type: object
type: array
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []