-
Notifications
You must be signed in to change notification settings - Fork 238
/
hive.openshift.io_clusterdeployments.yaml
1027 lines (1027 loc) · 52.2 KB
/
hive.openshift.io_clusterdeployments.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
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
creationTimestamp: null
name: clusterdeployments.hive.openshift.io
spec:
additionalPrinterColumns:
- JSONPath: .spec.clusterName
name: ClusterName
type: string
- JSONPath: .metadata.labels.hive\.openshift\.io/cluster-type
name: ClusterType
type: string
- JSONPath: .spec.baseDomain
name: BaseDomain
type: string
- JSONPath: .spec.installed
name: Installed
type: boolean
- JSONPath: .spec.clusterMetadata.infraID
name: InfraID
type: string
- JSONPath: .metadata.creationTimestamp
name: Age
type: date
group: hive.openshift.io
names:
kind: ClusterDeployment
listKind: ClusterDeploymentList
plural: clusterdeployments
shortNames:
- cd
singular: clusterdeployment
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
description: ClusterDeployment is the Schema for the clusterdeployments API
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: ClusterDeploymentSpec defines the desired state of ClusterDeployment
properties:
baseDomain:
description: BaseDomain is the base domain to which the cluster should
belong.
type: string
certificateBundles:
description: CertificateBundles is a list of certificate bundles associated
with this cluster
items:
description: CertificateBundleSpec specifies a certificate bundle
associated with a cluster deployment
properties:
certificateSecretRef:
description: CertificateSecretRef is the reference to the secret
that contains the certificate bundle. If the certificate bundle
is to be generated, it will be generated with the name in this
reference. Otherwise, it is expected that the secret should
exist in the same namespace as the ClusterDeployment
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
generate:
description: Generate indicates whether this bundle should have
real certificates generated for it.
type: boolean
name:
description: Name is an identifier that must be unique within
the bundle and must be referenced by an ingress or by the control
plane serving certs
type: string
required:
- certificateSecretRef
- name
type: object
type: array
clusterMetadata:
description: ClusterMetadata contains metadata information about the
installed cluster.
properties:
adminKubeconfigSecretRef:
description: AdminKubeconfigSecretRef references the secret containing
the admin kubeconfig for this cluster.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
adminPasswordSecretRef:
description: AdminPasswordSecretRef references the secret containing
the admin username/password which can be used to login to this
cluster.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
clusterID:
description: ClusterID is a globally unique identifier for this
cluster generated during installation. Used for reporting metrics
among other places.
type: string
infraID:
description: InfraID is an identifier for this cluster generated
during installation and used for tagging/naming resources in cloud
providers.
type: string
required:
- adminKubeconfigSecretRef
- adminPasswordSecretRef
- clusterID
- infraID
type: object
clusterName:
description: ClusterName is the friendly name of the cluster. It is
used for subdomains, some resource tagging, and other instances where
a friendly name for the cluster is useful.
type: string
clusterPoolRef:
description: ClusterPoolRef is a reference to the ClusterPool that this
ClusterDeployment originated from.
properties:
name:
description: Name is the name of the ClusterPool that this refers
to.
type: string
namespace:
description: Namespace is the namespace where the ClusterPool resides.
type: string
state:
description: State reflects the state of the ClusterDeployment in
relation to the ClusterPool it originated from.
type: string
required:
- name
- namespace
- state
type: object
controlPlaneConfig:
description: ControlPlaneConfig contains additional configuration for
the target cluster's control plane
properties:
apiURLOverride:
description: APIURLOverride is the optional URL override to which
Hive will transition for communication with the API server of
the remote cluster. When a remote cluster is created, Hive will
initially communicate using the API URL established during installation.
If an API URL Override is specified, Hive will periodically attempt
to connect to the remote cluster using the override URL. Once
Hive has determined that the override URL is active, Hive will
use the override URL for further communications with the API server
of the remote cluster.
type: string
servingCertificates:
description: ServingCertificates specifies serving certificates
for the control plane
properties:
additional:
description: Additional is a list of additional domains and
certificates that are also associated with the control plane's
api endpoint.
items:
description: ControlPlaneAdditionalCertificate defines an
additional serving certificate for a control plane
properties:
domain:
description: Domain is the domain of the additional control
plane certificate
type: string
name:
description: Name references a CertificateBundle in the
ClusterDeployment.Spec that should be used for this
additional certificate.
type: string
required:
- domain
- name
type: object
type: array
default:
description: Default references the name of a CertificateBundle
in the ClusterDeployment that should be used for the control
plane's default endpoint.
type: string
type: object
type: object
ingress:
description: Ingress allows defining desired clusteringress/shards to
be configured on the cluster.
items:
description: ClusterIngress contains the configurable pieces for any
ClusterIngress objects that should exist on the cluster.
properties:
domain:
description: Domain (sometimes referred to as shard) is the full
DNS suffix that the resulting IngressController object will
service (eg abcd.mycluster.mydomain.com).
type: string
name:
description: Name of the ClusterIngress object to create.
type: string
namespaceSelector:
description: NamespaceSelector allows filtering the list of namespaces
serviced by the ingress controller.
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
routeSelector:
description: RouteSelector allows filtering the set of Routes
serviced by the ingress controller
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
servingCertificate:
description: ServingCertificate references a CertificateBundle
in the ClusterDeployment.Spec that should be used for this Ingress
type: string
required:
- domain
- name
type: object
type: array
installed:
description: Installed is true if the cluster has been installed
type: boolean
manageDNS:
description: ManageDNS specifies whether a DNSZone should be created
and managed automatically for this ClusterDeployment
type: boolean
platform:
description: Platform is the configuration for the specific platform
upon which to perform the installation.
properties:
aws:
description: AWS is the configuration used when installing on AWS.
properties:
credentialsSecretRef:
description: CredentialsSecretRef refers to a secret that contains
the AWS account access credentials.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
region:
description: Region specifies the AWS region where the cluster
will be created.
type: string
userTags:
additionalProperties:
type: string
description: UserTags specifies additional tags for AWS resources
created for the cluster.
type: object
required:
- credentialsSecretRef
- region
type: object
azure:
description: Azure is the configuration used when installing on
Azure.
properties:
baseDomainResourceGroupName:
description: BaseDomainResourceGroupName specifies the resource
group where the azure DNS zone for the base domain is found
type: string
credentialsSecretRef:
description: CredentialsSecretRef refers to a secret that contains
the Azure account access credentials.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
region:
description: Region specifies the Azure region where the cluster
will be created.
type: string
required:
- credentialsSecretRef
- region
type: object
baremetal:
description: BareMetal is the configuration used when installing
on bare metal.
properties:
libvirtSSHPrivateKeySecretRef:
description: LibvirtSSHPrivateKeySecretRef is the reference
to the secret that contains the private SSH key to use for
access to the libvirt provisioning host. The SSH private key
is expected to be in the secret data under the "ssh-privatekey"
key.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
required:
- libvirtSSHPrivateKeySecretRef
type: object
gcp:
description: GCP is the configuration used when installing on Google
Cloud Platform.
properties:
credentialsSecretRef:
description: CredentialsSecretRef refers to a secret that contains
the GCP account access credentials.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
region:
description: Region specifies the GCP region where the cluster
will be created.
type: string
required:
- credentialsSecretRef
- region
type: object
openstack:
description: OpenStack is the configuration used when installing
on OpenStack
properties:
cloud:
description: Cloud will be used to indicate the OS_CLOUD value
to use the right section from the cloud.yaml in the CredentialsSecretRef.
type: string
credentialsSecretRef:
description: CredentialsSecretRef refers to a secret that contains
the OpenStack account access credentials.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
trunkSupport:
description: TrunkSupport indicates whether or not to use trunk
ports in your OpenShift cluster.
type: boolean
required:
- cloud
- credentialsSecretRef
type: object
ovirt:
description: Ovirt is the configuration used when installing on
oVirt
properties:
certificatesSecretRef:
description: CertificatesSecretRef refers to a secret that contains
the oVirt CA certificates necessary for communicating with
oVirt.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
credentialsSecretRef:
description: 'CredentialsSecretRef refers to a secret that contains
the oVirt account access credentials with fields: ovirt_url,
ovirt_username, ovirt_password, ovirt_ca_bundle'
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
ovirt_cluster_id:
description: The target cluster under which all VMs will run
type: string
ovirt_network_name:
description: The target network of all the network interfaces
of the nodes. Omitting defaults to ovirtmgmt network which
is a default network for evert ovirt cluster.
type: string
storage_domain_id:
description: The target storage domain under which all VM disk
would be created.
type: string
required:
- certificatesSecretRef
- credentialsSecretRef
- ovirt_cluster_id
- storage_domain_id
type: object
vsphere:
description: VSphere is the configuration used when installing on
vSphere
properties:
certificatesSecretRef:
description: CertificatesSecretRef refers to a secret that contains
the vSphere CA certificates necessary for communicating with
the VCenter.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
cluster:
description: Cluster is the name of the cluster virtual machines
will be cloned into.
type: string
credentialsSecretRef:
description: 'CredentialsSecretRef refers to a secret that contains
the vSphere account access credentials: GOVC_USERNAME, GOVC_PASSWORD
fields.'
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
datacenter:
description: Datacenter is the name of the datacenter to use
in the vCenter.
type: string
defaultDatastore:
description: DefaultDatastore is the default datastore to use
for provisioning volumes.
type: string
folder:
description: Folder is the name of the folder that will be used
and/or created for virtual machines.
type: string
network:
description: Network specifies the name of the network to be
used by the cluster.
type: string
vCenter:
description: VCenter is the domain name or IP address of the
vCenter.
type: string
required:
- certificatesSecretRef
- credentialsSecretRef
- datacenter
- defaultDatastore
- vCenter
type: object
type: object
powerState:
description: PowerState indicates whether a cluster should be running
or hibernating. When omitted, PowerState defaults to the Running state.
enum:
- ""
- Running
- Hibernating
type: string
preserveOnDelete:
description: PreserveOnDelete allows the user to disconnect a cluster
from Hive without deprovisioning it
type: boolean
provisioning:
description: Provisioning contains settings used only for initial cluster
provisioning. May be unset in the case of adopted clusters.
properties:
imageSetRef:
description: ImageSetRef is a reference to a ClusterImageSet. If
a value is specified for ReleaseImage, that will take precedence
over the one from the ClusterImageSet.
properties:
name:
description: Name is the name of the ClusterImageSet that this
refers to
type: string
required:
- name
type: object
installConfigSecretRef:
description: InstallConfigSecretRef is the reference to a secret
that contains an openshift-install InstallConfig. This file will
be passed through directly to the installer. Any version of InstallConfig
can be used, provided it can be parsed by the openshift-install
version for the release you are provisioning.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
installerEnv:
description: InstallerEnv are extra environment variables to pass
through to the installer. This may be used to enable additional
features of the installer.
items:
description: EnvVar represents an environment variable present
in a Container.
properties:
name:
description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
description: 'Variable references $(VAR_NAME) are expanded
using the previous defined environment variables in the
container and any service environment variables. If a variable
cannot be resolved, the reference in the input string will
be unchanged. The $(VAR_NAME) syntax can be escaped with
a double $$, ie: $$(VAR_NAME). Escaped references will never
be expanded, regardless of whether the variable exists or
not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's value.
Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
properties:
key:
description: The key to select.
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind,
uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
key must be defined
type: boolean
required:
- key
type: object
fieldRef:
description: 'Selects a field of the pod: supports metadata.name,
metadata.namespace, metadata.labels, metadata.annotations,
spec.nodeName, spec.serviceAccountName, status.hostIP,
status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the FieldPath is
written in terms of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to select in the specified
API version.
type: string
required:
- fieldPath
type: object
resourceFieldRef:
description: 'Selects a resource of the container: only
resources limits and requests (limits.cpu, limits.memory,
limits.ephemeral-storage, requests.cpu, requests.memory
and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
description: 'Container name: required for volumes,
optional for env vars'
type: string
divisor:
description: Specifies the output format of the exposed
resources, defaults to "1"
type: string
resource:
description: 'Required: resource to select'
type: string
required:
- resource
type: object
secretKeyRef:
description: Selects a key of a secret in the pod's namespace
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind,
uid?'
type: string
optional:
description: Specify whether the Secret or its key
must be defined
type: boolean
required:
- key
type: object
type: object
required:
- name
type: object
type: array
manifestsConfigMapRef:
description: ManifestsConfigMapRef is a reference to user-provided
manifests to add to or replace manifests that are generated by
the installer.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
releaseImage:
description: ReleaseImage is the image containing metadata for all
components that run in the cluster, and is the primary and best
way to specify what specific version of OpenShift you wish to
install.
type: string
sshKnownHosts:
description: SSHKnownHosts are known hosts to be configured in the
hive install manager pod to avoid ssh prompts. Use of ssh in the
install pod is somewhat limited today (failure log gathering from
cluster, some bare metal provisioning scenarios), so this setting
is often not needed.
items:
type: string
type: array
sshPrivateKeySecretRef:
description: SSHPrivateKeySecretRef is the reference to the secret
that contains the private SSH key to use for access to compute
instances. This private key should correspond to the public key
included in the InstallConfig. The private key is used by Hive
to gather logs on the target cluster if there are install failures.
The SSH private key is expected to be in the secret data under
the "ssh-privatekey" key.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
required:
- installConfigSecretRef
type: object
pullSecretRef:
description: PullSecretRef is the reference to the secret to use when
pulling images.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
required:
- baseDomain
- clusterName
- platform
type: object
status:
description: ClusterDeploymentStatus defines the observed state of ClusterDeployment
properties:
apiURL:
description: APIURL is the URL where the cluster's API can be accessed.
type: string
certificateBundles:
description: CertificateBundles contains of the status of the certificate
bundles associated with this cluster deployment.
items:
description: CertificateBundleStatus specifies whether a certificate
bundle was generated for this cluster deployment.
properties:
generated:
description: Generated indicates whether the certificate bundle
was generated
type: boolean
name:
description: Name of the certificate bundle
type: string
required:
- generated
- name
type: object
type: array
cliImage:
description: CLIImage is the name of the oc cli image to use when installing
the target cluster
type: string
clusterVersionStatus:
description: ClusterVersionStatus will hold a copy of the remote cluster's
ClusterVersion.Status
properties:
availableUpdates:
description: availableUpdates contains the list of updates that
are appropriate for this cluster. This list may be empty if no
updates are recommended, if the update service is unavailable,
or if an invalid channel has been specified.
items:
description: Update represents a release of the ClusterVersionOperator,
referenced by the Image member.
properties:
force:
description: "force allows an administrator to update to an
image that has failed verification, does not appear in the
availableUpdates list, or otherwise would be blocked by
normal protections on update. This option should only be
used when the authenticity of the provided image has been
verified out of band because the provided image will run
with full administrative access to the cluster. Do not use
this flag with images that comes from unknown or potentially
malicious sources. \n This flag does not override other
forms of consistency checking that are required before a
new update is deployed."
type: boolean
image:
description: image is a container image location that contains
the update. When this field is part of spec, image is optional
if version is specified and the availableUpdates field contains
a matching version.
type: string
version:
description: version is a semantic versioning identifying
the update version. When this field is part of spec, version
is optional if image is specified.
type: string
type: object
nullable: true
type: array
conditions:
description: conditions provides information about the cluster version.
The condition "Available" is set to true if the desiredUpdate
has been reached. The condition "Progressing" is set to true if
an update is being applied. The condition "Degraded" is set to
true if an update is currently blocked by a temporary or permanent
error. Conditions are only valid for the current desiredUpdate
when metadata.generation is equal to status.generation.
items:
description: ClusterOperatorStatusCondition represents the state
of the operator's managed and monitored components.
properties:
lastTransitionTime:
description: lastTransitionTime is the time of the last update
to the current status property.
format: date-time
type: string
message:
description: message provides additional information about
the current condition. This is only to be consumed by humans.
type: string
reason:
description: reason is the CamelCase reason for the condition's
current status.
type: string
status:
description: status of the condition, one of True, False,
Unknown.
type: string
type:
description: type specifies the aspect reported by this condition.
type: string
required:
- lastTransitionTime
- status
- type
type: object
type: array
desired:
description: desired is the version that the cluster is reconciling
towards. If the cluster is not yet fully initialized desired will
be set with the information available, which may be an image or
a tag.
properties:
force:
description: "force allows an administrator to update to an
image that has failed verification, does not appear in the
availableUpdates list, or otherwise would be blocked by normal
protections on update. This option should only be used when
the authenticity of the provided image has been verified out
of band because the provided image will run with full administrative
access to the cluster. Do not use this flag with images that
comes from unknown or potentially malicious sources. \n This
flag does not override other forms of consistency checking
that are required before a new update is deployed."
type: boolean
image:
description: image is a container image location that contains
the update. When this field is part of spec, image is optional
if version is specified and the availableUpdates field contains
a matching version.
type: string
version:
description: version is a semantic versioning identifying the
update version. When this field is part of spec, version is
optional if image is specified.
type: string
type: object
history:
description: history contains a list of the most recent versions
applied to the cluster. This value may be empty during cluster
startup, and then will be updated when a new update is being applied.
The newest update is first in the list and it is ordered by recency.
Updates in the history have state Completed if the rollout completed
- if an update was failing or halfway applied the state will be
Partial. Only a limited amount of update history is preserved.
items:
description: UpdateHistory is a single attempted update to the
cluster.
properties:
completionTime:
description: completionTime, if set, is when the update was
fully applied. The update that is currently being applied
will have a null completion time. Completion time will always
be set for entries that are not the current update (usually
to the started time of the next update).
format: date-time
nullable: true
type: string
image:
description: image is a container image location that contains
the update. This value is always populated.
type: string
startedTime:
description: startedTime is the time at which the update was
started.
format: date-time
type: string
state:
description: state reflects whether the update was fully applied.
The Partial state indicates the update is not fully applied,
while the Completed state indicates the update was successfully
rolled out at least once (all parts of the update successfully
applied).
type: string
verified:
description: verified indicates whether the provided update
was properly verified before it was installed. If this is
false the cluster may not be trusted.
type: boolean
version:
description: version is a semantic versioning identifying
the update version. If the requested image does not define
a version, or if a failure occurs retrieving the image,
this value may be empty.
type: string
required:
- completionTime
- image
- startedTime
- state
- verified
type: object
type: array
observedGeneration:
description: observedGeneration reports which version of the spec
is being synced. If this value is not equal to metadata.generation,
then the desired and conditions fields may represent a previous
version.
format: int64
type: integer
versionHash:
description: versionHash is a fingerprint of the content that the
cluster will be updated with. It is used by the operator to avoid
unnecessary work and is for internal use only.
type: string
required:
- availableUpdates
- desired
- observedGeneration
- versionHash
type: object
conditions:
description: Conditions includes more detailed status for the cluster
deployment
items:
description: ClusterDeploymentCondition contains details for the current
condition of a cluster deployment
properties:
lastProbeTime:
description: LastProbeTime is the last time we probed the condition.
format: date-time
type: string
lastTransitionTime:
description: LastTransitionTime is the last time the condition
transitioned from one status to another.
format: date-time
type: string
message:
description: Message is a human-readable message indicating details
about last transition.
type: string
reason:
description: Reason is a unique, one-word, CamelCase reason for
the condition's last transition.
type: string
status:
description: Status is the status of the condition.
type: string
type:
description: Type is the type of the condition.
type: string
required:
- status
- type
type: object
type: array
installRestarts:
description: InstallRestarts is the total count of container restarts
on the clusters install job.
type: integer
installedTimestamp:
description: InstalledTimestamp is the time we first detected that the
cluster has been successfully installed.
format: date-time
type: string
installerImage:
description: InstallerImage is the name of the installer image to use