/
zz_generated.swagger_doc_generated.go
1484 lines (1200 loc) · 109 KB
/
zz_generated.swagger_doc_generated.go
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
package v1
// This file contains a collection of methods that can be used from go-restful to
// generate Swagger API documentation for its models. Please read this PR for more
// information on the implementation: https://github.com/emicklei/go-restful/pull/215
//
// TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if
// they are on one line! For multiple line or blocks that you want to ignore use ---.
// Any context after a --- is ignored.
//
// Those methods can be generated by using hack/update-swagger-docs.sh
// AUTO-GENERATED FUNCTIONS START HERE
var map_AdmissionConfig = map[string]string{
"enabledPlugins": "enabledPlugins is a list of admission plugins that must be on in addition to the default list. Some admission plugins are disabled by default, but certain configurations require them. This is fairly uncommon and can result in performance penalties and unexpected behavior.",
"disabledPlugins": "disabledPlugins is a list of admission plugins that must be off. Putting something in this list is almost always a mistake and likely to result in cluster instability.",
}
func (AdmissionConfig) SwaggerDoc() map[string]string {
return map_AdmissionConfig
}
var map_AdmissionPluginConfig = map[string]string{
"": "AdmissionPluginConfig holds the necessary configuration options for admission plugins",
"location": "Location is the path to a configuration file that contains the plugin's configuration",
"configuration": "Configuration is an embedded configuration object to be used as the plugin's configuration. If present, it will be used instead of the path to the configuration file.",
}
func (AdmissionPluginConfig) SwaggerDoc() map[string]string {
return map_AdmissionPluginConfig
}
var map_AuditConfig = map[string]string{
"": "AuditConfig holds configuration for the audit capabilities",
"enabled": "If this flag is set, audit log will be printed in the logs. The logs contains, method, user and a requested URL.",
"auditFilePath": "All requests coming to the apiserver will be logged to this file.",
"maximumFileRetentionDays": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.",
"maximumRetainedFiles": "Maximum number of old log files to retain.",
"maximumFileSizeMegabytes": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.",
"policyFile": "PolicyFile is a path to the file that defines the audit policy configuration.",
"policyConfiguration": "PolicyConfiguration is an embedded policy configuration object to be used as the audit policy configuration. If present, it will be used instead of the path to the policy file.",
"logFormat": "Format of saved audits (legacy or json).",
"webHookKubeConfig": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.",
"webHookMode": "Strategy for sending audit events (block or batch).",
}
func (AuditConfig) SwaggerDoc() map[string]string {
return map_AuditConfig
}
var map_CertInfo = map[string]string{
"": "CertInfo relates a certificate with a private key",
"certFile": "CertFile is a file containing a PEM-encoded certificate",
"keyFile": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
}
func (CertInfo) SwaggerDoc() map[string]string {
return map_CertInfo
}
var map_ClientConnectionOverrides = map[string]string{
"acceptContentTypes": "acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.",
"contentType": "contentType is the content type used when sending data to the server from this client.",
"qps": "qps controls the number of queries per second allowed for this connection.",
"burst": "burst allows extra queries to accumulate when a client is exceeding its rate.",
}
func (ClientConnectionOverrides) SwaggerDoc() map[string]string {
return map_ClientConnectionOverrides
}
var map_ConfigMapFileReference = map[string]string{
"": "ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
"key": "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.",
}
func (ConfigMapFileReference) SwaggerDoc() map[string]string {
return map_ConfigMapFileReference
}
var map_ConfigMapNameReference = map[string]string{
"": "ConfigMapNameReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
"name": "name is the metadata.name of the referenced config map",
}
func (ConfigMapNameReference) SwaggerDoc() map[string]string {
return map_ConfigMapNameReference
}
var map_DelegatedAuthentication = map[string]string{
"": "DelegatedAuthentication allows authentication to be disabled.",
"disabled": "disabled indicates that authentication should be disabled. By default it will use delegated authentication.",
}
func (DelegatedAuthentication) SwaggerDoc() map[string]string {
return map_DelegatedAuthentication
}
var map_DelegatedAuthorization = map[string]string{
"": "DelegatedAuthorization allows authorization to be disabled.",
"disabled": "disabled indicates that authorization should be disabled. By default it will use delegated authorization.",
}
func (DelegatedAuthorization) SwaggerDoc() map[string]string {
return map_DelegatedAuthorization
}
var map_EtcdConnectionInfo = map[string]string{
"": "EtcdConnectionInfo holds information necessary for connecting to an etcd server",
"urls": "URLs are the URLs for etcd",
"ca": "CA is a file containing trusted roots for the etcd server certificates",
}
func (EtcdConnectionInfo) SwaggerDoc() map[string]string {
return map_EtcdConnectionInfo
}
var map_EtcdStorageConfig = map[string]string{
"storagePrefix": "StoragePrefix is the path within etcd that the OpenShift resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located.",
}
func (EtcdStorageConfig) SwaggerDoc() map[string]string {
return map_EtcdStorageConfig
}
var map_GenericAPIServerConfig = map[string]string{
"": "GenericAPIServerConfig is an inline-able struct for aggregated apiservers that need to store data in etcd",
"servingInfo": "servingInfo describes how to start serving",
"corsAllowedOrigins": "corsAllowedOrigins",
"auditConfig": "auditConfig describes how to configure audit information",
"storageConfig": "storageConfig contains information about how to use",
"admission": "admissionConfig holds information about how to configure admission.",
}
func (GenericAPIServerConfig) SwaggerDoc() map[string]string {
return map_GenericAPIServerConfig
}
var map_GenericControllerConfig = map[string]string{
"": "GenericControllerConfig provides information to configure a controller",
"servingInfo": "ServingInfo is the HTTP serving information for the controller's endpoints",
"leaderElection": "leaderElection provides information to elect a leader. Only override this if you have a specific need",
"authentication": "authentication allows configuration of authentication for the endpoints",
"authorization": "authorization allows configuration of authentication for the endpoints",
}
func (GenericControllerConfig) SwaggerDoc() map[string]string {
return map_GenericControllerConfig
}
var map_HTTPServingInfo = map[string]string{
"": "HTTPServingInfo holds configuration for serving HTTP",
"maxRequestsInFlight": "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.",
"requestTimeoutSeconds": "RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.",
}
func (HTTPServingInfo) SwaggerDoc() map[string]string {
return map_HTTPServingInfo
}
var map_KubeClientConfig = map[string]string{
"kubeConfig": "kubeConfig is a .kubeconfig filename for going to the owning kube-apiserver. Empty uses an in-cluster-config",
"connectionOverrides": "connectionOverrides specifies client overrides for system components to loop back to this master.",
}
func (KubeClientConfig) SwaggerDoc() map[string]string {
return map_KubeClientConfig
}
var map_LeaderElection = map[string]string{
"": "LeaderElection provides information to elect a leader",
"disable": "disable allows leader election to be suspended while allowing a fully defaulted \"normal\" startup case.",
"namespace": "namespace indicates which namespace the resource is in",
"name": "name indicates what name to use for the resource",
"leaseDuration": "leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.",
"renewDeadline": "renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.",
"retryPeriod": "retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.",
}
func (LeaderElection) SwaggerDoc() map[string]string {
return map_LeaderElection
}
var map_NamedCertificate = map[string]string{
"": "NamedCertificate specifies a certificate/key, and the names it should be served for",
"names": "Names is a list of DNS names this certificate should be used to secure A name can be a normal DNS name, or can contain leading wildcard segments.",
}
func (NamedCertificate) SwaggerDoc() map[string]string {
return map_NamedCertificate
}
var map_RemoteConnectionInfo = map[string]string{
"": "RemoteConnectionInfo holds information necessary for establishing a remote connection",
"url": "URL is the remote URL to connect to",
"ca": "CA is the CA for verifying TLS connections",
}
func (RemoteConnectionInfo) SwaggerDoc() map[string]string {
return map_RemoteConnectionInfo
}
var map_SecretNameReference = map[string]string{
"": "SecretNameReference references a secret in a specific namespace. The namespace must be specified at the point of use.",
"name": "name is the metadata.name of the referenced secret",
}
func (SecretNameReference) SwaggerDoc() map[string]string {
return map_SecretNameReference
}
var map_ServingInfo = map[string]string{
"": "ServingInfo holds information about serving web pages",
"bindAddress": "BindAddress is the ip:port to serve on",
"bindNetwork": "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
"clientCA": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
"namedCertificates": "NamedCertificates is a list of certificates to use to secure requests to specific hostnames",
"minTLSVersion": "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
"cipherSuites": "CipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
}
func (ServingInfo) SwaggerDoc() map[string]string {
return map_ServingInfo
}
var map_StringSource = map[string]string{
"": "StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.",
}
func (StringSource) SwaggerDoc() map[string]string {
return map_StringSource
}
var map_StringSourceSpec = map[string]string{
"": "StringSourceSpec specifies a string value, or external location",
"value": "Value specifies the cleartext value, or an encrypted value if keyFile is specified.",
"env": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
"file": "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
"keyFile": "KeyFile references a file containing the key to use to decrypt the value.",
}
func (StringSourceSpec) SwaggerDoc() map[string]string {
return map_StringSourceSpec
}
var map_APIServer = map[string]string{
"": "APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'.",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (APIServer) SwaggerDoc() map[string]string {
return map_APIServer
}
var map_APIServerEncryption = map[string]string{
"type": "type defines what encryption type should be used to encrypt resources at the datastore layer. When this field is unset (i.e. when it is set to the empty string), identity is implied. The behavior of unset can and will change over time. Even if encryption is enabled by default, the meaning of unset may change to a different encryption type based on changes in best practices.\n\nWhen encryption is enabled, all sensitive resources shipped with the platform are encrypted. This list of sensitive resources can and will change over time. The current authoritative list is:\n\n 1. secrets\n 2. configmaps\n 3. routes.route.openshift.io\n 4. oauthaccesstokens.oauth.openshift.io\n 5. oauthauthorizetokens.oauth.openshift.io",
}
func (APIServerEncryption) SwaggerDoc() map[string]string {
return map_APIServerEncryption
}
var map_APIServerNamedServingCert = map[string]string{
"": "APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.",
"names": "names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates. Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names.",
"servingCertificate": "servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data[\"tls.key\"] - TLS private key. - Secret.Data[\"tls.crt\"] - TLS certificate.",
}
func (APIServerNamedServingCert) SwaggerDoc() map[string]string {
return map_APIServerNamedServingCert
}
var map_APIServerServingCerts = map[string]string{
"namedCertificates": "namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames. If no named certificates are provided, or no named certificates match the server name as understood by a client, the defaultServingCertificate will be used.",
}
func (APIServerServingCerts) SwaggerDoc() map[string]string {
return map_APIServerServingCerts
}
var map_APIServerSpec = map[string]string{
"servingCerts": "servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates will be used for serving secure traffic.",
"clientCA": "clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid. You usually only have to set this if you have your own PKI you wish to honor client certificates from. The ConfigMap must exist in the openshift-config namespace and contain the following required fields: - ConfigMap.Data[\"ca-bundle.crt\"] - CA bundle.",
"additionalCORSAllowedOrigins": "additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth server from JavaScript applications. The values are regular expressions that correspond to the Golang regular expression language.",
"encryption": "encryption allows the configuration of encryption of resources at the datastore layer.",
"tlsSecurityProfile": "tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.\n\nIf unset, a default (which may change between releases) is chosen. Note that only Old and Intermediate profiles are currently supported, and the maximum available MinTLSVersions is VersionTLS12.",
"audit": "audit specifies the settings for audit configuration to be applied to all OpenShift-provided API servers in the cluster.",
}
func (APIServerSpec) SwaggerDoc() map[string]string {
return map_APIServerSpec
}
var map_Audit = map[string]string{
"profile": "profile specifies the name of the desired audit policy configuration to be deployed to all OpenShift-provided API servers in the cluster.\n\nThe following profiles are provided: - Default: the existing default policy. - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list).\n\nIf unset, the 'Default' profile is used as the default.",
}
func (Audit) SwaggerDoc() map[string]string {
return map_Audit
}
var map_Authentication = map[string]string{
"": "Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (Authentication) SwaggerDoc() map[string]string {
return map_Authentication
}
var map_AuthenticationSpec = map[string]string{
"type": "type identifies the cluster managed, user facing authentication mode in use. Specifically, it manages the component that responds to login attempts. The default is IntegratedOAuth.",
"oauthMetadata": "oauthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for an external OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 If oauthMetadata.name is non-empty, this value has precedence over any metadata reference stored in status. The key \"oauthMetadata\" is used to locate the data. If specified and the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config.",
"webhookTokenAuthenticators": "webhookTokenAuthenticators is DEPRECATED, setting it has no effect.",
"webhookTokenAuthenticator": "webhookTokenAuthenticator configures a remote token reviewer. These remote authentication webhooks can be used to verify bearer tokens via the tokenreviews.authentication.k8s.io REST API. This is required to honor bearer tokens that are provisioned by an external authentication service.",
"serviceAccountIssuer": "serviceAccountIssuer is the identifier of the bound service account token issuer. The default is https://kubernetes.default.svc WARNING: Updating this field will result in the invalidation of all bound tokens with the previous issuer value. Unless the holder of a bound token has explicit support for a change in issuer, they will not request a new bound token until pod restart or until their existing token exceeds 80% of its duration.",
}
func (AuthenticationSpec) SwaggerDoc() map[string]string {
return map_AuthenticationSpec
}
var map_AuthenticationStatus = map[string]string{
"integratedOAuthMetadata": "integratedOAuthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for the in-cluster integrated OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This contains the observed value based on cluster state. An explicitly set value in spec.oauthMetadata has precedence over this field. This field has no meaning if authentication spec.type is not set to IntegratedOAuth. The key \"oauthMetadata\" is used to locate the data. If the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config-managed.",
}
func (AuthenticationStatus) SwaggerDoc() map[string]string {
return map_AuthenticationStatus
}
var map_DeprecatedWebhookTokenAuthenticator = map[string]string{
"": "deprecatedWebhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator. It's the same as WebhookTokenAuthenticator but it's missing the 'required' validation on KubeConfig field.",
"kubeConfig": "kubeConfig contains kube config file data which describes how to access the remote webhook service. For further details, see: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication The key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. The namespace for this secret is determined by the point of use.",
}
func (DeprecatedWebhookTokenAuthenticator) SwaggerDoc() map[string]string {
return map_DeprecatedWebhookTokenAuthenticator
}
var map_WebhookTokenAuthenticator = map[string]string{
"": "webhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator",
"kubeConfig": "kubeConfig references a secret that contains kube config file data which describes how to access the remote webhook service. The namespace for the referenced secret is openshift-config.\n\nFor further details, see:\n\nhttps://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication\n\nThe key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored.",
}
func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string {
return map_WebhookTokenAuthenticator
}
var map_Build = map[string]string{
"": "Build configures the behavior of OpenShift builds for the entire cluster. This includes default settings that can be overridden in BuildConfig objects, and overrides which are applied to all builds.\n\nThe canonical name is \"cluster\"",
"spec": "Spec holds user-settable values for the build controller configuration",
}
func (Build) SwaggerDoc() map[string]string {
return map_Build
}
var map_BuildDefaults = map[string]string{
"defaultProxy": "DefaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.\n\nValues can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables in the build config's strategy.",
"gitProxy": "GitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.\n\nValues that are not set here will be inherited from DefaultProxy.",
"env": "Env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
"imageLabels": "ImageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
"resources": "Resources defines resource requirements to execute the build.",
}
func (BuildDefaults) SwaggerDoc() map[string]string {
return map_BuildDefaults
}
var map_BuildOverrides = map[string]string{
"imageLabels": "ImageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
"nodeSelector": "NodeSelector is a selector which must be true for the build pod to fit on a node",
"tolerations": "Tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
"forcePull": "ForcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself",
}
func (BuildOverrides) SwaggerDoc() map[string]string {
return map_BuildOverrides
}
var map_BuildSpec = map[string]string{
"additionalTrustedCA": "AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.\n\nDEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead.",
"buildDefaults": "BuildDefaults controls the default information for Builds",
"buildOverrides": "BuildOverrides controls override settings for builds",
}
func (BuildSpec) SwaggerDoc() map[string]string {
return map_BuildSpec
}
var map_ImageLabel = map[string]string{
"name": "Name defines the name of the label. It must have non-zero length.",
"value": "Value defines the literal value of the label.",
}
func (ImageLabel) SwaggerDoc() map[string]string {
return map_ImageLabel
}
var map_ClusterOperator = map[string]string{
"": "ClusterOperator is the Custom Resource object which holds the current state of an operator. This object is used by operators to convey their state to the rest of the cluster.",
"spec": "spec holds configuration that could apply to any operator.",
"status": "status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.",
}
func (ClusterOperator) SwaggerDoc() map[string]string {
return map_ClusterOperator
}
var map_ClusterOperatorList = map[string]string{
"": "ClusterOperatorList is a list of OperatorStatus resources.",
}
func (ClusterOperatorList) SwaggerDoc() map[string]string {
return map_ClusterOperatorList
}
var map_ClusterOperatorSpec = map[string]string{
"": "ClusterOperatorSpec is empty for now, but you could imagine holding information like \"pause\".",
}
func (ClusterOperatorSpec) SwaggerDoc() map[string]string {
return map_ClusterOperatorSpec
}
var map_ClusterOperatorStatus = map[string]string{
"": "ClusterOperatorStatus provides information about the status of the operator.",
"conditions": "conditions describes the state of the operator's managed and monitored components.",
"versions": "versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name \"operator\". An operator reports a new \"operator\" version when it has rolled out the new version to all of its operands.",
"relatedObjects": "relatedObjects is a list of objects that are \"interesting\" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces",
"extension": "extension contains any additional status information specific to the operator which owns this status object.",
}
func (ClusterOperatorStatus) SwaggerDoc() map[string]string {
return map_ClusterOperatorStatus
}
var map_ClusterOperatorStatusCondition = map[string]string{
"": "ClusterOperatorStatusCondition represents the state of the operator's managed and monitored components.",
"type": "type specifies the aspect reported by this condition.",
"status": "status of the condition, one of True, False, Unknown.",
"lastTransitionTime": "lastTransitionTime is the time of the last update to the current status property.",
"reason": "reason is the CamelCase reason for the condition's current status.",
"message": "message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
}
func (ClusterOperatorStatusCondition) SwaggerDoc() map[string]string {
return map_ClusterOperatorStatusCondition
}
var map_ObjectReference = map[string]string{
"": "ObjectReference contains enough information to let you inspect or modify the referred object.",
"group": "group of the referent.",
"resource": "resource of the referent.",
"namespace": "namespace of the referent.",
"name": "name of the referent.",
}
func (ObjectReference) SwaggerDoc() map[string]string {
return map_ObjectReference
}
var map_OperandVersion = map[string]string{
"name": "name is the name of the particular operand this version is for. It usually matches container images, not operators.",
"version": "version indicates which version of a particular operand is currently being managed. It must always match the Available operand. If 1.0.0 is Available, then this must indicate 1.0.0 even if the operator is trying to rollout 1.1.0",
}
func (OperandVersion) SwaggerDoc() map[string]string {
return map_OperandVersion
}
var map_ClusterVersion = map[string]string{
"": "ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.",
"spec": "spec is the desired state of the cluster version - the operator will work to ensure that the desired version is applied to the cluster.",
"status": "status contains information about the available updates and any in-progress updates.",
}
func (ClusterVersion) SwaggerDoc() map[string]string {
return map_ClusterVersion
}
var map_ClusterVersionList = map[string]string{
"": "ClusterVersionList is a list of ClusterVersion resources.",
}
func (ClusterVersionList) SwaggerDoc() map[string]string {
return map_ClusterVersionList
}
var map_ClusterVersionSpec = map[string]string{
"": "ClusterVersionSpec is the desired version state of the cluster. It includes the version the cluster should be at, how the cluster is identified, and where the cluster should look for version updates.",
"clusterID": "clusterID uniquely identifies this cluster. This is expected to be an RFC4122 UUID value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx in hexadecimal values). This is a required field.",
"desiredUpdate": "desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version). The set of recommended update values is listed as part of available updates in status, and setting values outside that range may cause the upgrade to fail. You may specify the version field without setting image if an update exists with that version in the availableUpdates or history.\n\nIf an upgrade fails the operator will halt and report status about the failing component. Setting the desired update value back to the previous version will cause a rollback to be attempted. Not all rollbacks will succeed.",
"upstream": "upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region.",
"channel": "channel is an identifier for explicitly requesting that a non-default set of updates be applied to this cluster. The default channel will be contain stable updates that are appropriate for production clusters.",
"overrides": "overrides is list of overides for components that are managed by cluster version operator. Marking a component unmanaged will prevent the operator from creating or updating the object.",
}
func (ClusterVersionSpec) SwaggerDoc() map[string]string {
return map_ClusterVersionSpec
}
var map_ClusterVersionStatus = map[string]string{
"": "ClusterVersionStatus reports the status of the cluster versioning, including any upgrades that are in progress. The current field will be set to whichever version the cluster is reconciling to, and the conditions array will report whether the update succeeded, is in progress, or is failing.",
"desired": "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.",
"history": "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.",
"observedGeneration": "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.",
"versionHash": "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.",
"conditions": "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.",
"availableUpdates": "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.",
}
func (ClusterVersionStatus) SwaggerDoc() map[string]string {
return map_ClusterVersionStatus
}
var map_ComponentOverride = map[string]string{
"": "ComponentOverride allows overriding cluster version operator's behavior for a component.",
"kind": "kind indentifies which object to override.",
"group": "group identifies the API group that the kind is in.",
"namespace": "namespace is the component's namespace. If the resource is cluster scoped, the namespace should be empty.",
"name": "name is the component's name.",
"unmanaged": "unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false",
}
func (ComponentOverride) SwaggerDoc() map[string]string {
return map_ComponentOverride
}
var map_Release = map[string]string{
"": "Release represents an OpenShift release image and associated metadata.",
"version": "version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified.",
"image": "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.",
"url": "url contains information about this release. This URL is set by the 'url' metadata property on a release or the metadata returned by the update API and should be displayed as a link in user interfaces. The URL field may not be set for test or nightly releases.",
"channels": "channels is the set of Cincinnati channels to which the release currently belongs.",
}
func (Release) SwaggerDoc() map[string]string {
return map_Release
}
var map_Update = map[string]string{
"": "Update represents an administrator update request.",
"version": "version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified.",
"image": "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.",
"force": "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\nThis flag does not override other forms of consistency checking that are required before a new update is deployed.",
}
func (Update) SwaggerDoc() map[string]string {
return map_Update
}
var map_UpdateHistory = map[string]string{
"": "UpdateHistory is a single attempted update to the cluster.",
"state": "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).",
"startedTime": "startedTime is the time at which the update was started.",
"completionTime": "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).",
"version": "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.",
"image": "image is a container image location that contains the update. This value is always populated.",
"verified": "verified indicates whether the provided update was properly verified before it was installed. If this is false the cluster may not be trusted.",
}
func (UpdateHistory) SwaggerDoc() map[string]string {
return map_UpdateHistory
}
var map_Console = map[string]string{
"": "Console holds cluster-wide configuration for the web console, including the logout URL, and reports the public URL of the console. The canonical name is `cluster`.",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (Console) SwaggerDoc() map[string]string {
return map_Console
}
var map_ConsoleAuthentication = map[string]string{
"": "ConsoleAuthentication defines a list of optional configuration for console authentication.",
"logoutRedirect": "An optional, absolute URL to redirect web browsers to after logging out of the console. If not specified, it will redirect to the default login page. This is required when using an identity provider that supports single sign-on (SSO) such as: - OpenID (Keycloak, Azure) - RequestHeader (GSSAPI, SSPI, SAML) - OAuth (GitHub, GitLab, Google) Logging out of the console will destroy the user's token. The logoutRedirect provides the user the option to perform single logout (SLO) through the identity provider to destroy their single sign-on session.",
}
func (ConsoleAuthentication) SwaggerDoc() map[string]string {
return map_ConsoleAuthentication
}
var map_ConsoleSpec = map[string]string{
"": "ConsoleSpec is the specification of the desired behavior of the Console.",
}
func (ConsoleSpec) SwaggerDoc() map[string]string {
return map_ConsoleSpec
}
var map_ConsoleStatus = map[string]string{
"": "ConsoleStatus defines the observed status of the Console.",
"consoleURL": "The URL for the console. This will be derived from the host for the route that is created for the console.",
}
func (ConsoleStatus) SwaggerDoc() map[string]string {
return map_ConsoleStatus
}
var map_DNS = map[string]string{
"": "DNS holds cluster-wide information about DNS. The canonical name is `cluster`",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (DNS) SwaggerDoc() map[string]string {
return map_DNS
}
var map_DNSSpec = map[string]string{
"baseDomain": "baseDomain is the base domain of the cluster. All managed DNS records will be sub-domains of this base.\n\nFor example, given the base domain `openshift.example.com`, an API server DNS record may be created for `cluster-api.openshift.example.com`.\n\nOnce set, this field cannot be changed.",
"publicZone": "publicZone is the location where all the DNS records that are publicly accessible to the internet exist.\n\nIf this field is nil, no public records should be created.\n\nOnce set, this field cannot be changed.",
"privateZone": "privateZone is the location where all the DNS records that are only available internally to the cluster exist.\n\nIf this field is nil, no private records should be created.\n\nOnce set, this field cannot be changed.",
}
func (DNSSpec) SwaggerDoc() map[string]string {
return map_DNSSpec
}
var map_DNSZone = map[string]string{
"": "DNSZone is used to define a DNS hosted zone. A zone can be identified by an ID or tags.",
"id": "id is the identifier that can be used to find the DNS hosted zone.\n\non AWS zone can be fetched using `ID` as id in [1] on Azure zone can be fetched using `ID` as a pre-determined name in [2], on GCP zone can be fetched using `ID` as a pre-determined name in [3].\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get",
"tags": "tags can be used to query the DNS hosted zone.\n\non AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options",
}
func (DNSZone) SwaggerDoc() map[string]string {
return map_DNSZone
}
var map_CustomFeatureGates = map[string]string{
"enabled": "enabled is a list of all feature gates that you want to force on",
"disabled": "disabled is a list of all feature gates that you want to force off",
}
func (CustomFeatureGates) SwaggerDoc() map[string]string {
return map_CustomFeatureGates
}
var map_FeatureGate = map[string]string{
"": "Feature holds cluster-wide information about feature gates. The canonical name is `cluster`",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (FeatureGate) SwaggerDoc() map[string]string {
return map_FeatureGate
}
var map_FeatureGateSelection = map[string]string{
"featureSet": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
"customNoUpgrade": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
}
func (FeatureGateSelection) SwaggerDoc() map[string]string {
return map_FeatureGateSelection
}
var map_Image = map[string]string{
"": "Image governs policies related to imagestream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing OpenShift's image registry to the public, this also lets cluster admins specify the external hostname.",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (Image) SwaggerDoc() map[string]string {
return map_Image
}
var map_ImageSpec = map[string]string{
"allowedRegistriesForImport": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
"externalRegistryHostnames": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
"additionalTrustedCA": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.",
"registrySources": "registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access). It does not contain configuration for the internal cluster registry.",
}
func (ImageSpec) SwaggerDoc() map[string]string {
return map_ImageSpec
}
var map_ImageStatus = map[string]string{
"internalRegistryHostname": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. This value is set by the image registry operator which controls the internal registry hostname. For backward compatibility, users can still use OPENSHIFT_DEFAULT_REGISTRY environment variable but this setting overrides the environment variable.",
"externalRegistryHostnames": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
}
func (ImageStatus) SwaggerDoc() map[string]string {
return map_ImageStatus
}
var map_RegistryLocation = map[string]string{
"": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
"domainName": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
"insecure": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
}
func (RegistryLocation) SwaggerDoc() map[string]string {
return map_RegistryLocation
}
var map_RegistrySources = map[string]string{
"": "RegistrySources holds cluster-wide information about how to handle the registries config.",
"insecureRegistries": "insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.",
"blockedRegistries": "blockedRegistries cannot be used for image pull and push actions. All other registries are permitted.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
"allowedRegistries": "allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
"containerRuntimeSearchRegistries": "containerRuntimeSearchRegistries are registries that will be searched when pulling images that do not have fully qualified domains in their pull specs. Registries will be searched in the order provided in the list. Note: this search list only works with the container runtime, i.e CRI-O. Will NOT work with builds or imagestream imports.",
}
func (RegistrySources) SwaggerDoc() map[string]string {
return map_RegistrySources
}
var map_AWSPlatformSpec = map[string]string{
"": "AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
"serviceEndpoints": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
}
func (AWSPlatformSpec) SwaggerDoc() map[string]string {
return map_AWSPlatformSpec
}
var map_AWSPlatformStatus = map[string]string{
"": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.",
"region": "region holds the default AWS region for new AWS resources created by the cluster.",
"serviceEndpoints": "ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
"resourceTags": "resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.",
}
func (AWSPlatformStatus) SwaggerDoc() map[string]string {
return map_AWSPlatformStatus
}
var map_AWSResourceTag = map[string]string{
"": "AWSResourceTag is a tag to apply to AWS resources created for the cluster.",
"key": "key is the key of the tag",
"value": "value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.",
}
func (AWSResourceTag) SwaggerDoc() map[string]string {
return map_AWSResourceTag
}
var map_AWSServiceEndpoint = map[string]string{
"": "AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.",
"name": "name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.",
"url": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
}
func (AWSServiceEndpoint) SwaggerDoc() map[string]string {
return map_AWSServiceEndpoint
}
var map_AzurePlatformSpec = map[string]string{
"": "AzurePlatformSpec holds the desired state of the Azure infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (AzurePlatformSpec) SwaggerDoc() map[string]string {
return map_AzurePlatformSpec
}
var map_AzurePlatformStatus = map[string]string{
"": "AzurePlatformStatus holds the current status of the Azure infrastructure provider.",
"resourceGroupName": "resourceGroupName is the Resource Group for new Azure resources created for the cluster.",
"networkResourceGroupName": "networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.",
"cloudName": "cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to `AzurePublicCloud`.",
}
func (AzurePlatformStatus) SwaggerDoc() map[string]string {
return map_AzurePlatformStatus
}
var map_BareMetalPlatformSpec = map[string]string{
"": "BareMetalPlatformSpec holds the desired state of the BareMetal infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (BareMetalPlatformSpec) SwaggerDoc() map[string]string {
return map_BareMetalPlatformSpec
}
var map_BareMetalPlatformStatus = map[string]string{
"": "BareMetalPlatformStatus holds the current status of the BareMetal infrastructure provider. For more information about the network architecture used with the BareMetal platform type, see: https://github.com/openshift/installer/blob/master/docs/design/baremetal/networking-infrastructure.md",
"apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
"nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
}
func (BareMetalPlatformStatus) SwaggerDoc() map[string]string {
return map_BareMetalPlatformStatus
}
var map_GCPPlatformSpec = map[string]string{
"": "GCPPlatformSpec holds the desired state of the Google Cloud Platform infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (GCPPlatformSpec) SwaggerDoc() map[string]string {
return map_GCPPlatformSpec
}
var map_GCPPlatformStatus = map[string]string{
"": "GCPPlatformStatus holds the current status of the Google Cloud Platform infrastructure provider.",
"projectID": "resourceGroupName is the Project ID for new GCP resources created for the cluster.",
"region": "region holds the region for new GCP resources created for the cluster.",
}
func (GCPPlatformStatus) SwaggerDoc() map[string]string {
return map_GCPPlatformStatus
}
var map_IBMCloudPlatformSpec = map[string]string{
"": "IBMCloudPlatformSpec holds the desired state of the IBMCloud infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (IBMCloudPlatformSpec) SwaggerDoc() map[string]string {
return map_IBMCloudPlatformSpec
}
var map_IBMCloudPlatformStatus = map[string]string{
"": "IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.",
"location": "Location is where the cluster has been deployed",
"resourceGroupName": "ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.",
"providerType": "ProviderType indicates the type of cluster that was created",
}
func (IBMCloudPlatformStatus) SwaggerDoc() map[string]string {
return map_IBMCloudPlatformStatus
}
var map_Infrastructure = map[string]string{
"": "Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (Infrastructure) SwaggerDoc() map[string]string {
return map_Infrastructure
}
var map_InfrastructureList = map[string]string{
"": "InfrastructureList is",
}
func (InfrastructureList) SwaggerDoc() map[string]string {
return map_InfrastructureList
}
var map_InfrastructureSpec = map[string]string{
"": "InfrastructureSpec contains settings that apply to the cluster infrastructure.",
"cloudConfig": "cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.\n\ncloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.",
"platformSpec": "platformSpec holds desired information specific to the underlying infrastructure provider.",
}
func (InfrastructureSpec) SwaggerDoc() map[string]string {
return map_InfrastructureSpec
}
var map_InfrastructureStatus = map[string]string{
"": "InfrastructureStatus describes the infrastructure the cluster is leveraging.",
"infrastructureName": "infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.",
"platform": "platform is the underlying infrastructure provider for the cluster.\n\nDeprecated: Use platformStatus.type instead.",
"platformStatus": "platformStatus holds status information specific to the underlying infrastructure provider.",
"etcdDiscoveryDomain": "etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.",
"apiServerURL": "apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.",
"apiServerInternalURI": "apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.",
}
func (InfrastructureStatus) SwaggerDoc() map[string]string {
return map_InfrastructureStatus
}
var map_KubevirtPlatformSpec = map[string]string{
"": "KubevirtPlatformSpec holds the desired state of the kubevirt infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (KubevirtPlatformSpec) SwaggerDoc() map[string]string {
return map_KubevirtPlatformSpec
}
var map_KubevirtPlatformStatus = map[string]string{
"": "KubevirtPlatformStatus holds the current status of the kubevirt infrastructure provider.",
"apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
}
func (KubevirtPlatformStatus) SwaggerDoc() map[string]string {
return map_KubevirtPlatformStatus
}
var map_OpenStackPlatformSpec = map[string]string{
"": "OpenStackPlatformSpec holds the desired state of the OpenStack infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (OpenStackPlatformSpec) SwaggerDoc() map[string]string {
return map_OpenStackPlatformSpec
}
var map_OpenStackPlatformStatus = map[string]string{
"": "OpenStackPlatformStatus holds the current status of the OpenStack infrastructure provider.",
"apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"cloudName": "cloudName is the name of the desired OpenStack cloud in the client configuration file (`clouds.yaml`).",
"ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
"nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
}
func (OpenStackPlatformStatus) SwaggerDoc() map[string]string {
return map_OpenStackPlatformStatus
}
var map_OvirtPlatformSpec = map[string]string{
"": "OvirtPlatformSpec holds the desired state of the oVirt infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (OvirtPlatformSpec) SwaggerDoc() map[string]string {
return map_OvirtPlatformSpec
}
var map_OvirtPlatformStatus = map[string]string{
"": "OvirtPlatformStatus holds the current status of the oVirt infrastructure provider.",
"apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
"nodeDNSIP": "deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.",
}
func (OvirtPlatformStatus) SwaggerDoc() map[string]string {
return map_OvirtPlatformStatus
}
var map_PlatformSpec = map[string]string{
"": "PlatformSpec holds the desired state specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
"type": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
"aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.",
"azure": "Azure contains settings specific to the Azure infrastructure provider.",
"gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.",
"baremetal": "BareMetal contains settings specific to the BareMetal platform.",
"openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.",
"ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.",
"vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.",
"ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.",
"kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.",
}
func (PlatformSpec) SwaggerDoc() map[string]string {
return map_PlatformSpec
}
var map_PlatformStatus = map[string]string{
"": "PlatformStatus holds the current status specific to the underlying infrastructure provider of the current cluster. Since these are used at status-level for the underlying cluster, it is supposed that only one of the status structs is set.",
"type": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.\n\nThis value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.",
"aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.",
"azure": "Azure contains settings specific to the Azure infrastructure provider.",
"gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.",
"baremetal": "BareMetal contains settings specific to the BareMetal platform.",
"openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.",
"ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.",
"vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.",
"ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.",
"kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.",
}
func (PlatformStatus) SwaggerDoc() map[string]string {
return map_PlatformStatus
}
var map_VSpherePlatformSpec = map[string]string{
"": "VSpherePlatformSpec holds the desired state of the vSphere infrastructure provider. This only includes fields that can be modified in the cluster.",
}
func (VSpherePlatformSpec) SwaggerDoc() map[string]string {
return map_VSpherePlatformSpec
}
var map_VSpherePlatformStatus = map[string]string{
"": "VSpherePlatformStatus holds the current status of the vSphere infrastructure provider.",
"apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
"nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
}
func (VSpherePlatformStatus) SwaggerDoc() map[string]string {
return map_VSpherePlatformStatus
}
var map_Ingress = map[string]string{
"": "Ingress holds cluster-wide information about ingress, including the default ingress domain used for routes. The canonical name is `cluster`.",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (Ingress) SwaggerDoc() map[string]string {
return map_Ingress
}
var map_IngressSpec = map[string]string{
"domain": "domain is used to generate a default host name for a route when the route's host name is empty. The generated host name will follow this pattern: \"<route-name>.<route-namespace>.<domain>\".\n\nIt is also used as the default wildcard domain suffix for ingress. The default ingresscontroller domain will follow this pattern: \"*.<domain>\".\n\nOnce set, changing domain is not currently supported.",
"appsDomain": "appsDomain is an optional domain to use instead of the one specified in the domain field when a Route is created without specifying an explicit host. If appsDomain is nonempty, this value is used to generate default host values for Route. Unlike domain, appsDomain may be modified after installation. This assumes a new ingresscontroller has been setup with a wildcard certificate.",
}
func (IngressSpec) SwaggerDoc() map[string]string {
return map_IngressSpec