-
Notifications
You must be signed in to change notification settings - Fork 609
Expand file tree
/
Copy pathzz_generated.swagger_doc_generated.go
More file actions
2220 lines (1794 loc) · 214 KB
/
zz_generated.swagger_doc_generated.go
File metadata and controls
2220 lines (1794 loc) · 214 KB
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_GenerationStatus = map[string]string{
"": "GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.",
"group": "group is the group of the thing you're tracking",
"resource": "resource is the resource type of the thing you're tracking",
"namespace": "namespace is where the thing you're tracking is",
"name": "name is the name of the thing you're tracking",
"lastGeneration": "lastGeneration is the last generation of the workload controller involved",
"hash": "hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps",
}
func (GenerationStatus) SwaggerDoc() map[string]string {
return map_GenerationStatus
}
var map_MyOperatorResource = map[string]string{
"": "MyOperatorResource is an example operator configuration type\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (MyOperatorResource) SwaggerDoc() map[string]string {
return map_MyOperatorResource
}
var map_NodeStatus = map[string]string{
"": "NodeStatus provides information about the current state of a particular node managed by this operator.",
"nodeName": "nodeName is the name of the node",
"nodeUID": "nodeUID is the UID of the node. This field is used to detect that a node has been deleted and recreated with the same name. When the UID changes, it indicates the node is a new instance and the status should be reset.",
"currentRevision": "currentRevision is the generation of the most recently successful deployment. Can not be set on creation of a nodeStatus. Updates must only increase the value.",
"targetRevision": "targetRevision is the generation of the deployment we're trying to apply. Can not be set on creation of a nodeStatus.",
"lastFailedRevision": "lastFailedRevision is the generation of the deployment we tried and failed to deploy.",
"lastFailedTime": "lastFailedTime is the time the last failed revision failed the last time.",
"lastFailedReason": "lastFailedReason is a machine readable failure reason string.",
"lastFailedCount": "lastFailedCount is how often the installer pod of the last failed revision failed.",
"lastFallbackCount": "lastFallbackCount is how often a fallback to a previous revision happened.",
"lastFailedRevisionErrors": "lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision.",
}
func (NodeStatus) SwaggerDoc() map[string]string {
return map_NodeStatus
}
var map_OperatorCondition = map[string]string{
"": "OperatorCondition is just the standard condition fields.",
"type": "type of condition in CamelCase or in foo.example.com/CamelCase.",
"status": "status of the condition, one of True, False, Unknown.",
"lastTransitionTime": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
}
func (OperatorCondition) SwaggerDoc() map[string]string {
return map_OperatorCondition
}
var map_OperatorSpec = map[string]string{
"": "OperatorSpec contains common fields operators need. It is intended to be anonymous included inside of the Spec struct for your particular operator.",
"managementState": "managementState indicates whether and how the operator should manage the component",
"logLevel": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
"operatorLogLevel": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
"unsupportedConfigOverrides": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
"observedConfig": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
}
func (OperatorSpec) SwaggerDoc() map[string]string {
return map_OperatorSpec
}
var map_OperatorStatus = map[string]string{
"observedGeneration": "observedGeneration is the last generation change you've dealt with",
"conditions": "conditions is a list of conditions and their status",
"version": "version is the level this availability applies to",
"readyReplicas": "readyReplicas indicates how many replicas are ready and at the desired state",
"latestAvailableRevision": "latestAvailableRevision is the deploymentID of the most recent deployment",
"generations": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
}
func (OperatorStatus) SwaggerDoc() map[string]string {
return map_OperatorStatus
}
var map_StaticPodOperatorSpec = map[string]string{
"": "StaticPodOperatorSpec is spec for controllers that manage static pods.",
"forceRedeploymentReason": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
"failedRevisionLimit": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
"succeededRevisionLimit": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
}
func (StaticPodOperatorSpec) SwaggerDoc() map[string]string {
return map_StaticPodOperatorSpec
}
var map_StaticPodOperatorStatus = map[string]string{
"": "StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked.",
"latestAvailableRevisionReason": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
"nodeStatuses": "nodeStatuses track the deployment values and errors across individual nodes",
}
func (StaticPodOperatorStatus) SwaggerDoc() map[string]string {
return map_StaticPodOperatorStatus
}
var map_Authentication = map[string]string{
"": "Authentication provides information to configure an operator to manage authentication.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (Authentication) SwaggerDoc() map[string]string {
return map_Authentication
}
var map_AuthenticationList = map[string]string{
"": "AuthenticationList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (AuthenticationList) SwaggerDoc() map[string]string {
return map_AuthenticationList
}
var map_AuthenticationStatus = map[string]string{
"oauthAPIServer": "oauthAPIServer holds status specific only to oauth-apiserver",
}
func (AuthenticationStatus) SwaggerDoc() map[string]string {
return map_AuthenticationStatus
}
var map_OAuthAPIServerStatus = map[string]string{
"latestAvailableRevision": "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.",
}
func (OAuthAPIServerStatus) SwaggerDoc() map[string]string {
return map_OAuthAPIServerStatus
}
var map_CloudCredential = map[string]string{
"": "CloudCredential provides a means to configure an operator to manage CredentialsRequests.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (CloudCredential) SwaggerDoc() map[string]string {
return map_CloudCredential
}
var map_CloudCredentialList = map[string]string{
"": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (CloudCredentialList) SwaggerDoc() map[string]string {
return map_CloudCredentialList
}
var map_CloudCredentialSpec = map[string]string{
"": "CloudCredentialSpec is the specification of the desired behavior of the cloud-credential-operator.",
"credentialsMode": "credentialsMode allows informing CCO that it should not attempt to dynamically determine the root cloud credentials capabilities, and it should just run in the specified mode. It also allows putting the operator into \"manual\" mode if desired. Leaving the field in default mode runs CCO so that the cluster's cloud credentials will be dynamically probed for capabilities (on supported clouds/platforms). Supported modes:\n AWS/Azure/GCP: \"\" (Default), \"Mint\", \"Passthrough\", \"Manual\"\n Others: Do not set value as other platforms only support running in \"Passthrough\"",
}
func (CloudCredentialSpec) SwaggerDoc() map[string]string {
return map_CloudCredentialSpec
}
var map_CloudCredentialStatus = map[string]string{
"": "CloudCredentialStatus defines the observed status of the cloud-credential-operator.",
}
func (CloudCredentialStatus) SwaggerDoc() map[string]string {
return map_CloudCredentialStatus
}
var map_Config = map[string]string{
"": "Config specifies the behavior of the config operator which is responsible for creating the initial configuration of other components on the cluster. The operator also handles installation, migration or synchronization of cloud configurations for AWS and Azure cloud based clusters\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "spec is the specification of the desired behavior of the Config Operator.",
"status": "status defines the observed status of the Config Operator.",
}
func (Config) SwaggerDoc() map[string]string {
return map_Config
}
var map_ConfigList = map[string]string{
"": "ConfigList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "items contains the items",
}
func (ConfigList) SwaggerDoc() map[string]string {
return map_ConfigList
}
var map_AddPage = map[string]string{
"": "AddPage allows customizing actions on the Add page in developer perspective.",
"disabledActions": "disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID.",
}
func (AddPage) SwaggerDoc() map[string]string {
return map_AddPage
}
var map_Capability = map[string]string{
"": "Capabilities contains set of UI capabilities and their state in the console UI.",
"name": "name is the unique name of a capability. Available capabilities are LightspeedButton, GettingStartedBanner, and GuidedTour.",
"visibility": "visibility defines the visibility state of the capability.",
}
func (Capability) SwaggerDoc() map[string]string {
return map_Capability
}
var map_CapabilityVisibility = map[string]string{
"": "CapabilityVisibility defines the criteria to enable/disable a capability.",
"state": "state defines if the capability is enabled or disabled in the console UI. Enabling the capability in the console UI is represented by the \"Enabled\" value. Disabling the capability in the console UI is represented by the \"Disabled\" value.",
}
func (CapabilityVisibility) SwaggerDoc() map[string]string {
return map_CapabilityVisibility
}
var map_ConfigMapFileReference = map[string]string{
"": "ConfigMapFileReference references a specific file within a ConfigMap.",
"name": "name is the name of the ConfigMap. name is a required field. Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character. Must be at most 253 characters in length.",
"key": "key is the logo key inside the referenced ConfigMap. Must consist only of alphanumeric characters, dashes (-), underscores (_), and periods (.). Must be at most 253 characters in length. Must end in a valid file extension. A valid file extension must consist of a period followed by 2 to 5 alpha characters.",
}
func (ConfigMapFileReference) SwaggerDoc() map[string]string {
return map_ConfigMapFileReference
}
var map_Console = map[string]string{
"": "Console provides a means to configure an operator to manage the console.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (Console) SwaggerDoc() map[string]string {
return map_Console
}
var map_ConsoleConfigRoute = map[string]string{
"": "ConsoleConfigRoute holds information on external route access to console. DEPRECATED",
"hostname": "hostname is the desired custom domain under which console will be available.",
"secret": "secret points to secret in the openshift-config namespace that contains custom certificate and key and needs to be created manually by the cluster admin. Referenced Secret is required to contain following key value pairs: - \"tls.crt\" - to specifies custom certificate - \"tls.key\" - to specifies private key of the custom certificate If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.",
}
func (ConsoleConfigRoute) SwaggerDoc() map[string]string {
return map_ConsoleConfigRoute
}
var map_ConsoleCustomization = map[string]string{
"": "ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.",
"logos": "logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos. logos is an optional field that allows a list of logos. Only one of logos or customLogoFile can be set at a time. If logos is set, customLogoFile must be unset. When specified, there must be at least one entry and no more than 2 entries. Each type must appear only once in the list.",
"capabilities": "capabilities defines an array of capabilities that can be interacted with in the console UI. Each capability defines a visual state that can be interacted with the console to render in the UI. Available capabilities are LightspeedButton, GettingStartedBanner, and GuidedTour. Each of the available capabilities may appear only once in the list.",
"brand": "brand is the default branding of the web console which can be overridden by providing the brand field. There is a limited set of specific brand options. This field controls elements of the console such as the logo. Invalid value will prevent a console rollout.",
"documentationBaseURL": "documentationBaseURL links to external documentation are shown in various sections of the web console. Providing documentationBaseURL will override the default documentation URL. Invalid value will prevent a console rollout.",
"customProductName": "customProductName is the name that will be displayed in page titles, logo alt text, and the about dialog instead of the normal OpenShift product name.",
"customLogoFile": "customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a Only one of customLogoFile or logos can be set at a time. ConfigMap in the openshift-config namespace. This can be created with a command like 'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'. Image size must be less than 1 MB due to constraints on the ConfigMap size. The ConfigMap key should include a file extension so that the console serves the file with the correct MIME type. The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser. Deprecated: Use logos instead.",
"developerCatalog": "developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).",
"projectAccess": "projectAccess allows customizing the available list of ClusterRoles in the Developer perspective Project access page which can be used by a project admin to specify roles to other users and restrict access within the project. If set, the list will replace the default ClusterRole options.",
"quickStarts": "quickStarts allows customization of available ConsoleQuickStart resources in console.",
"addPage": "addPage allows customizing actions on the Add page in developer perspective.",
"perspectives": "perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.",
}
func (ConsoleCustomization) SwaggerDoc() map[string]string {
return map_ConsoleCustomization
}
var map_ConsoleList = map[string]string{
"": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (ConsoleList) SwaggerDoc() map[string]string {
return map_ConsoleList
}
var map_ConsoleProviders = map[string]string{
"": "ConsoleProviders defines a list of optional additional providers of functionality to the console.",
"statuspage": "statuspage contains ID for statuspage.io page that provides status info about.",
}
func (ConsoleProviders) SwaggerDoc() map[string]string {
return map_ConsoleProviders
}
var map_ConsoleSpec = map[string]string{
"": "ConsoleSpec is the specification of the desired behavior of the Console.",
"customization": "customization is used to optionally provide a small set of customization options to the web console.",
"providers": "providers contains configuration for using specific service providers.",
"route": "route contains hostname and secret reference that contains the serving certificate. If a custom route is specified, a new route will be created with the provided hostname, under which console will be available. In case of custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary. The default console route will be maintained to reserve the default hostname for console if the custom route is removed. If not specified, default route will be used. DEPRECATED",
"plugins": "plugins defines a list of enabled console plugin names.",
"ingress": "ingress allows to configure the alternative ingress for the console. This field is intended for clusters without ingress capability, where access to routes is not possible.",
}
func (ConsoleSpec) SwaggerDoc() map[string]string {
return map_ConsoleSpec
}
var map_ConsoleStatus = map[string]string{
"": "ConsoleStatus defines the observed status of the Console.",
}
func (ConsoleStatus) SwaggerDoc() map[string]string {
return map_ConsoleStatus
}
var map_DeveloperConsoleCatalogCategory = map[string]string{
"": "DeveloperConsoleCatalogCategory for the developer console catalog.",
"subcategories": "subcategories defines a list of child categories.",
}
func (DeveloperConsoleCatalogCategory) SwaggerDoc() map[string]string {
return map_DeveloperConsoleCatalogCategory
}
var map_DeveloperConsoleCatalogCategoryMeta = map[string]string{
"": "DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.",
"id": "id is an identifier used in the URL to enable deep linking in console. ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.",
"label": "label defines a category display label. It is required and must have 1-64 characters.",
"tags": "tags is a list of strings that will match the category. A selected category show all items which has at least one overlapping tag between category and item.",
}
func (DeveloperConsoleCatalogCategoryMeta) SwaggerDoc() map[string]string {
return map_DeveloperConsoleCatalogCategoryMeta
}
var map_DeveloperConsoleCatalogCustomization = map[string]string{
"": "DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog.",
"categories": "categories which are shown in the developer catalog.",
"types": "types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog. When omitted, all the sub-catalog types will be shown.",
}
func (DeveloperConsoleCatalogCustomization) SwaggerDoc() map[string]string {
return map_DeveloperConsoleCatalogCustomization
}
var map_DeveloperConsoleCatalogTypes = map[string]string{
"": "DeveloperConsoleCatalogTypes defines the state of the sub-catalog types.",
"state": "state defines if a list of catalog types should be enabled or disabled.",
"enabled": "enabled is a list of developer catalog types (sub-catalogs IDs) that will be shown to users. Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available in the console on the cluster configuration page, or when editing the YAML in the console. Example: \"Devfile\", \"HelmChart\", \"BuilderImage\" If the list is non-empty, a new type will not be shown to the user until it is added to list. If the list is empty the complete developer catalog will be shown.",
"disabled": "disabled is a list of developer catalog types (sub-catalogs IDs) that are not shown to users. Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available in the console on the cluster configuration page, or when editing the YAML in the console. Example: \"Devfile\", \"HelmChart\", \"BuilderImage\" If the list is empty or all the available sub-catalog types are added, then the complete developer catalog should be hidden.",
}
func (DeveloperConsoleCatalogTypes) SwaggerDoc() map[string]string {
return map_DeveloperConsoleCatalogTypes
}
var map_FileReferenceSource = map[string]string{
"": "FileReferenceSource is used by the console to locate the specified file containing a custom logo.",
"from": "from is a required field to specify the source type of the file reference. Allowed values are ConfigMap. When set to ConfigMap, the file will be sourced from a ConfigMap in the openshift-config namespace. The configMap field must be set when from is set to ConfigMap.",
"configMap": "configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file. The ConfigMap must exist in the openshift-config namespace. Required when from is \"ConfigMap\", and forbidden otherwise.",
}
func (FileReferenceSource) SwaggerDoc() map[string]string {
return map_FileReferenceSource
}
var map_Ingress = map[string]string{
"": "Ingress allows cluster admin to configure alternative ingress for the console.",
"consoleURL": "consoleURL is a URL to be used as the base console address. If not specified, the console route hostname will be used. This field is required for clusters without ingress capability, where access to routes is not possible. Make sure that appropriate ingress is set up at this URL. The console operator will monitor the URL and may go degraded if it's unreachable for an extended period. Must use the HTTPS scheme.",
"clientDownloadsURL": "clientDownloadsURL is a URL to be used as the address to download client binaries. If not specified, the downloads route hostname will be used. This field is required for clusters without ingress capability, where access to routes is not possible. The console operator will monitor the URL and may go degraded if it's unreachable for an extended period. Must use the HTTPS scheme.",
}
func (Ingress) SwaggerDoc() map[string]string {
return map_Ingress
}
var map_Logo = map[string]string{
"": "Logo defines a configuration based on theme modes for the console UI logo.",
"type": "type specifies the type of the logo for the console UI. It determines whether the logo is for the masthead or favicon. type is a required field that allows values of Masthead and Favicon. When set to \"Masthead\", the logo will be used in the masthead and about modal of the console UI. When set to \"Favicon\", the logo will be used as the favicon of the console UI.",
"themes": "themes specifies the themes for the console UI logo. themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field. Each mode determines whether the logo is for the dark or light mode of the console UI. If a theme is not specified, the default OpenShift logo will be displayed for that theme. There must be at least one entry and no more than 2 entries.",
}
func (Logo) SwaggerDoc() map[string]string {
return map_Logo
}
var map_Perspective = map[string]string{
"": "Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown",
"id": "id defines the id of the perspective. Example: \"dev\", \"admin\". The available perspective ids can be found in the code snippet section next to the yaml editor. Incorrect or unknown ids will be ignored.",
"visibility": "visibility defines the state of perspective along with access review checks if needed for that perspective.",
"pinnedResources": "pinnedResources defines the list of default pinned resources that users will see on the perspective navigation if they have not customized these pinned resources themselves. The list of available Kubernetes resources could be read via `kubectl api-resources`. The console will also provide a configuration UI and a YAML snippet that will list the available resources that can be pinned to the navigation. Incorrect or unknown resources will be ignored.",
}
func (Perspective) SwaggerDoc() map[string]string {
return map_Perspective
}
var map_PerspectiveVisibility = map[string]string{
"": "PerspectiveVisibility defines the criteria to show/hide a perspective",
"state": "state defines the perspective is enabled or disabled or access review check is required.",
"accessReview": "accessReview defines required and missing access review checks.",
}
func (PerspectiveVisibility) SwaggerDoc() map[string]string {
return map_PerspectiveVisibility
}
var map_PinnedResourceReference = map[string]string{
"": "PinnedResourceReference includes the group, version and type of resource",
"group": "group is the API Group of the Resource. Enter empty string for the core group. This value should consist of only lowercase alphanumeric characters, hyphens and periods. Example: \"\", \"apps\", \"build.openshift.io\", etc.",
"version": "version is the API Version of the Resource. This value should consist of only lowercase alphanumeric characters. Example: \"v1\", \"v1beta1\", etc.",
"resource": "resource is the type that is being referenced. It is normally the plural form of the resource kind in lowercase. This value should consist of only lowercase alphanumeric characters and hyphens. Example: \"deployments\", \"deploymentconfigs\", \"pods\", etc.",
}
func (PinnedResourceReference) SwaggerDoc() map[string]string {
return map_PinnedResourceReference
}
var map_ProjectAccess = map[string]string{
"": "ProjectAccess contains options for project access roles",
"availableClusterRoles": "availableClusterRoles is the list of ClusterRole names that are assignable to users through the project access tab.",
}
func (ProjectAccess) SwaggerDoc() map[string]string {
return map_ProjectAccess
}
var map_QuickStarts = map[string]string{
"": "QuickStarts allow cluster admins to customize available ConsoleQuickStart resources.",
"disabled": "disabled is a list of ConsoleQuickStart resource names that are not shown to users.",
}
func (QuickStarts) SwaggerDoc() map[string]string {
return map_QuickStarts
}
var map_ResourceAttributesAccessReview = map[string]string{
"": "ResourceAttributesAccessReview defines the visibility of the perspective depending on the access review checks. `required` and `missing` can work together esp. in the case where the cluster admin wants to show another perspective to users without specific permissions. Out of `required` and `missing` atleast one property should be non-empty.",
"required": "required defines a list of permission checks. The perspective will only be shown when all checks are successful. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the missing access review list.",
"missing": "missing defines a list of permission checks. The perspective will only be shown when at least one check fails. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the required access review list.",
}
func (ResourceAttributesAccessReview) SwaggerDoc() map[string]string {
return map_ResourceAttributesAccessReview
}
var map_StatuspageProvider = map[string]string{
"": "StatuspageProvider provides identity for statuspage account.",
"pageID": "pageID is the unique ID assigned by Statuspage for your page. This must be a public page.",
}
func (StatuspageProvider) SwaggerDoc() map[string]string {
return map_StatuspageProvider
}
var map_Theme = map[string]string{
"": "Theme defines a theme mode for the console UI.",
"mode": "mode is used to specify what theme mode a logo will apply to in the console UI. mode is a required field that allows values of Dark and Light. When set to Dark, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Dark mode. When set to Light, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Light mode.",
"source": "source is used by the console to locate the specified file containing a custom logo. source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace. You can create it with a command like: - 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file' The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type. The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser. The logo image size must be less than 1 MB due to constraints on the ConfigMap size. For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console",
}
func (Theme) SwaggerDoc() map[string]string {
return map_Theme
}
var map_AWSCSIDriverConfigSpec = map[string]string{
"": "AWSCSIDriverConfigSpec defines properties that can be configured for the AWS CSI driver.",
"kmsKeyARN": "kmsKeyARN sets the cluster default storage class to encrypt volumes with a user-defined KMS key, rather than the default KMS key used by AWS. The value may be either the ARN or Alias ARN of a KMS key.\n\nThe ARN must follow the format: arn:<partition>:kms:<region>:<account-id>:(key|alias)/<key-id-or-alias>, where: <partition> is the AWS partition (aws, aws-cn, aws-us-gov, aws-iso, aws-iso-b, aws-iso-e, aws-iso-f, or aws-eusc), <region> is the AWS region, <account-id> is a 12-digit numeric identifier for the AWS account, <key-id-or-alias> is the KMS key ID or alias name.",
"efsVolumeMetrics": "efsVolumeMetrics sets the configuration for collecting metrics from EFS volumes used by the EFS CSI Driver.",
}
func (AWSCSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_AWSCSIDriverConfigSpec
}
var map_AWSEFSVolumeMetrics = map[string]string{
"": "AWSEFSVolumeMetrics defines the configuration for volume metrics in the EFS CSI Driver.",
"state": "state defines the state of metric collection in the AWS EFS CSI Driver. This field is required and must be set to one of the following values: Disabled or RecursiveWalk. Disabled means no metrics collection will be performed. This is the default value. RecursiveWalk means the AWS EFS CSI Driver will recursively scan volumes to collect metrics. This process may result in high CPU and memory usage, depending on the volume size.",
"recursiveWalk": "recursiveWalk provides additional configuration for collecting volume metrics in the AWS EFS CSI Driver when the state is set to RecursiveWalk.",
}
func (AWSEFSVolumeMetrics) SwaggerDoc() map[string]string {
return map_AWSEFSVolumeMetrics
}
var map_AWSEFSVolumeMetricsRecursiveWalkConfig = map[string]string{
"": "AWSEFSVolumeMetricsRecursiveWalkConfig defines options for volume metrics in the EFS CSI Driver.",
"refreshPeriodMinutes": "refreshPeriodMinutes specifies the frequency, in minutes, at which volume metrics are refreshed. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 240. The valid range is from 1 to 43200 minutes (30 days).",
"fsRateLimit": "fsRateLimit defines the rate limit, in goroutines per file system, for processing volume metrics. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 5. The valid range is from 1 to 100 goroutines.",
}
func (AWSEFSVolumeMetricsRecursiveWalkConfig) SwaggerDoc() map[string]string {
return map_AWSEFSVolumeMetricsRecursiveWalkConfig
}
var map_AzureCSIDriverConfigSpec = map[string]string{
"": "AzureCSIDriverConfigSpec defines properties that can be configured for the Azure CSI driver.",
"diskEncryptionSet": "diskEncryptionSet sets the cluster default storage class to encrypt volumes with a customer-managed encryption set, rather than the default platform-managed keys.",
}
func (AzureCSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_AzureCSIDriverConfigSpec
}
var map_AzureDiskEncryptionSet = map[string]string{
"": "AzureDiskEncryptionSet defines the configuration for a disk encryption set.",
"subscriptionID": "subscriptionID defines the Azure subscription that contains the disk encryption set. The value should meet the following conditions: 1. It should be a 128-bit number. 2. It should be 36 characters (32 hexadecimal characters and 4 hyphens) long. 3. It should be displayed in five groups separated by hyphens (-). 4. The first group should be 8 characters long. 5. The second, third, and fourth groups should be 4 characters long. 6. The fifth group should be 12 characters long. An Example SubscrionID: f2007bbf-f802-4a47-9336-cf7c6b89b378",
"resourceGroup": "resourceGroup defines the Azure resource group that contains the disk encryption set. The value should consist of only alphanumberic characters, underscores (_), parentheses, hyphens and periods. The value should not end in a period and be at most 90 characters in length.",
"name": "name is the name of the disk encryption set that will be set on the default storage class. The value should consist of only alphanumberic characters, underscores (_), hyphens, and be at most 80 characters in length.",
}
func (AzureDiskEncryptionSet) SwaggerDoc() map[string]string {
return map_AzureDiskEncryptionSet
}
var map_CSIDriverConfigSpec = map[string]string{
"": "CSIDriverConfigSpec defines configuration spec that can be used to optionally configure a specific CSI Driver.",
"driverType": "driverType indicates type of CSI driver for which the driverConfig is being applied to. Valid values are: AWS, Azure, GCP, IBMCloud, vSphere and omitted. Consumers should treat unknown values as a NO-OP.",
"aws": "aws is used to configure the AWS CSI driver.",
"azure": "azure is used to configure the Azure CSI driver.",
"gcp": "gcp is used to configure the GCP CSI driver.",
"ibmcloud": "ibmcloud is used to configure the IBM Cloud CSI driver.",
"vSphere": "vSphere is used to configure the vsphere CSI driver.",
}
func (CSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_CSIDriverConfigSpec
}
var map_ClusterCSIDriver = map[string]string{
"": "ClusterCSIDriver object allows management and configuration of a CSI driver operator installed by default in OpenShift. Name of the object must be name of the CSI driver it operates. See CSIDriverName type for list of allowed values.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (ClusterCSIDriver) SwaggerDoc() map[string]string {
return map_ClusterCSIDriver
}
var map_ClusterCSIDriverList = map[string]string{
"": "ClusterCSIDriverList contains a list of ClusterCSIDriver\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (ClusterCSIDriverList) SwaggerDoc() map[string]string {
return map_ClusterCSIDriverList
}
var map_ClusterCSIDriverSpec = map[string]string{
"": "ClusterCSIDriverSpec is the desired behavior of CSI driver operator",
"storageClassState": "storageClassState determines if CSI operator should create and manage storage classes. If this field value is empty or Managed - CSI operator will continuously reconcile storage class and create if necessary. If this field value is Unmanaged - CSI operator will not reconcile any previously created storage class. If this field value is Removed - CSI operator will delete the storage class it created previously. When omitted, this means the user has no opinion and the platform chooses a reasonable default, which is subject to change over time. The current default behaviour is Managed.",
"driverConfig": "driverConfig can be used to specify platform specific driver configuration. When omitted, this means no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
}
func (ClusterCSIDriverSpec) SwaggerDoc() map[string]string {
return map_ClusterCSIDriverSpec
}
var map_ClusterCSIDriverStatus = map[string]string{
"": "ClusterCSIDriverStatus is the observed status of CSI driver operator",
}
func (ClusterCSIDriverStatus) SwaggerDoc() map[string]string {
return map_ClusterCSIDriverStatus
}
var map_GCPCSIDriverConfigSpec = map[string]string{
"": "GCPCSIDriverConfigSpec defines properties that can be configured for the GCP CSI driver.",
"kmsKey": "kmsKey sets the cluster default storage class to encrypt volumes with customer-supplied encryption keys, rather than the default keys managed by GCP.",
}
func (GCPCSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_GCPCSIDriverConfigSpec
}
var map_GCPKMSKeyReference = map[string]string{
"": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key",
"name": "name is the name of the customer-managed encryption key to be used for disk encryption. The value should correspond to an existing KMS key and should consist of only alphanumeric characters, hyphens (-) and underscores (_), and be at most 63 characters in length.",
"keyRing": "keyRing is the name of the KMS Key Ring which the KMS Key belongs to. The value should correspond to an existing KMS key ring and should consist of only alphanumeric characters, hyphens (-) and underscores (_), and be at most 63 characters in length.",
"projectID": "projectID is the ID of the Project in which the KMS Key Ring exists. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited.",
"location": "location is the GCP location in which the Key Ring exists. The value must match an existing GCP location, or \"global\". Defaults to global, if not set.",
}
func (GCPKMSKeyReference) SwaggerDoc() map[string]string {
return map_GCPKMSKeyReference
}
var map_IBMCloudCSIDriverConfigSpec = map[string]string{
"": "IBMCloudCSIDriverConfigSpec defines the properties that can be configured for the IBM Cloud CSI driver.",
"encryptionKeyCRN": "encryptionKeyCRN is the IBM Cloud CRN of the customer-managed root key to use for disk encryption of volumes for the default storage classes.",
}
func (IBMCloudCSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_IBMCloudCSIDriverConfigSpec
}
var map_VSphereCSIDriverConfigSpec = map[string]string{
"": "VSphereCSIDriverConfigSpec defines properties that can be configured for vsphere CSI driver.",
"topologyCategories": "topologyCategories indicates tag categories with which vcenter resources such as hostcluster or datacenter were tagged with. If cluster Infrastructure object has a topology, values specified in Infrastructure object will be used and modifications to topologyCategories will be rejected.",
"globalMaxSnapshotsPerBlockVolume": "globalMaxSnapshotsPerBlockVolume is a global configuration parameter that applies to volumes on all kinds of datastores. If omitted, the platform chooses a default, which is subject to change over time, currently that default is 3. Snapshots can not be disabled using this parameter. Increasing number of snapshots above 3 can have negative impact on performance, for more details see: https://kb.vmware.com/s/article/1025279 Volume snapshot documentation: https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/3.0/vmware-vsphere-csp-getting-started/GUID-E0B41C69-7EEB-450F-A73D-5FD2FF39E891.html",
"granularMaxSnapshotsPerBlockVolumeInVSAN": "granularMaxSnapshotsPerBlockVolumeInVSAN is a granular configuration parameter on vSAN datastore only. It overrides GlobalMaxSnapshotsPerBlockVolume if set, while it falls back to the global constraint if unset. Snapshots for VSAN can not be disabled using this parameter.",
"granularMaxSnapshotsPerBlockVolumeInVVOL": "granularMaxSnapshotsPerBlockVolumeInVVOL is a granular configuration parameter on Virtual Volumes datastore only. It overrides GlobalMaxSnapshotsPerBlockVolume if set, while it falls back to the global constraint if unset. Snapshots for VVOL can not be disabled using this parameter.",
"maxAllowedBlockVolumesPerNode": "maxAllowedBlockVolumesPerNode is an optional configuration parameter that allows setting a custom value for the limit of the number of PersistentVolumes attached to a node. In vSphere version 7 this limit was set to 59 by default, however in vSphere version 8 this limit was increased to 255. Before increasing this value above 59 the cluster administrator needs to ensure that every node forming the cluster is updated to ESXi version 8 or higher and that all nodes are running the same version. The limit must be between 1 and 255, which matches the vSphere version 8 maximum. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 59, which matches the limit for vSphere version 7.",
}
func (VSphereCSIDriverConfigSpec) SwaggerDoc() map[string]string {
return map_VSphereCSIDriverConfigSpec
}
var map_CSISnapshotController = map[string]string{
"": "CSISnapshotController provides a means to configure an operator to manage the CSI snapshots. `cluster` is the canonical name.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "spec holds user settable values for configuration",
"status": "status holds observed values from the cluster. They may not be overridden.",
}
func (CSISnapshotController) SwaggerDoc() map[string]string {
return map_CSISnapshotController
}
var map_CSISnapshotControllerList = map[string]string{
"": "CSISnapshotControllerList contains a list of CSISnapshotControllers.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (CSISnapshotControllerList) SwaggerDoc() map[string]string {
return map_CSISnapshotControllerList
}
var map_CSISnapshotControllerSpec = map[string]string{
"": "CSISnapshotControllerSpec is the specification of the desired behavior of the CSISnapshotController operator.",
}
func (CSISnapshotControllerSpec) SwaggerDoc() map[string]string {
return map_CSISnapshotControllerSpec
}
var map_CSISnapshotControllerStatus = map[string]string{
"": "CSISnapshotControllerStatus defines the observed status of the CSISnapshotController operator.",
}
func (CSISnapshotControllerStatus) SwaggerDoc() map[string]string {
return map_CSISnapshotControllerStatus
}
var map_DNS = map[string]string{
"": "DNS manages the CoreDNS component to provide a name resolution service for pods and services in the cluster.\n\nThis supports the DNS-based service discovery specification: https://github.com/kubernetes/dns/blob/master/docs/specification.md\n\nMore details: https://kubernetes.io/docs/tasks/administer-cluster/coredns\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "spec is the specification of the desired behavior of the DNS.",
"status": "status is the most recently observed status of the DNS.",
}
func (DNS) SwaggerDoc() map[string]string {
return map_DNS
}
var map_DNSCache = map[string]string{
"": "DNSCache defines the fields for configuring DNS caching.",
"positiveTTL": "positiveTTL is optional and specifies the amount of time that a positive response should be cached.\n\nIf configured, it must be a value of 1s (1 second) or greater up to a theoretical maximum of several years. This field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"100s\", \"1m30s\", \"12h30m10s\". Values that are fractions of a second are rounded down to the nearest second. If the configured value is less than 1s, the default value will be used. If not configured, the value will be 0s and OpenShift will use a default value of 900 seconds unless noted otherwise in the respective Corefile for your version of OpenShift. The default value of 900 seconds is subject to change.",
"negativeTTL": "negativeTTL is optional and specifies the amount of time that a negative response should be cached.\n\nIf configured, it must be a value of 1s (1 second) or greater up to a theoretical maximum of several years. This field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"100s\", \"1m30s\", \"12h30m10s\". Values that are fractions of a second are rounded down to the nearest second. If the configured value is less than 1s, the default value will be used. If not configured, the value will be 0s and OpenShift will use a default value of 30 seconds unless noted otherwise in the respective Corefile for your version of OpenShift. The default value of 30 seconds is subject to change.",
}
func (DNSCache) SwaggerDoc() map[string]string {
return map_DNSCache
}
var map_DNSList = map[string]string{
"": "DNSList contains a list of DNS\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (DNSList) SwaggerDoc() map[string]string {
return map_DNSList
}
var map_DNSNodePlacement = map[string]string{
"": "DNSNodePlacement describes the node scheduling configuration for DNS pods.",
"nodeSelector": "nodeSelector is the node selector applied to DNS pods.\n\nIf empty, the default is used, which is currently the following:\n\n kubernetes.io/os: linux\n\nThis default is subject to change.\n\nIf set, the specified selector is used and replaces the default.",
"tolerations": "tolerations is a list of tolerations applied to DNS pods.\n\nIf empty, the DNS operator sets a toleration for the \"node-role.kubernetes.io/master\" taint. This default is subject to change. Specifying tolerations without including a toleration for the \"node-role.kubernetes.io/master\" taint may be risky as it could lead to an outage if all worker nodes become unavailable.\n\nNote that the daemon controller adds some tolerations as well. See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
}
func (DNSNodePlacement) SwaggerDoc() map[string]string {
return map_DNSNodePlacement
}
var map_DNSOverTLSConfig = map[string]string{
"": "DNSOverTLSConfig describes optional DNSTransportConfig fields that should be captured.",
"serverName": "serverName is the upstream server to connect to when forwarding DNS queries. This is required when Transport is set to \"TLS\". ServerName will be validated against the DNS naming conventions in RFC 1123 and should match the TLS certificate installed in the upstream resolver(s).",
"caBundle": "caBundle references a ConfigMap that must contain either a single CA Certificate or a CA Bundle. This allows cluster administrators to provide their own CA or CA bundle for validating the certificate of upstream resolvers.\n\n1. The configmap must contain a `ca-bundle.crt` key. 2. The value must be a PEM encoded CA certificate or CA bundle. 3. The administrator must create this configmap in the openshift-config namespace. 4. The upstream server certificate must contain a Subject Alternative Name (SAN) that matches ServerName.",
}
func (DNSOverTLSConfig) SwaggerDoc() map[string]string {
return map_DNSOverTLSConfig
}
var map_DNSSpec = map[string]string{
"": "DNSSpec is the specification of the desired behavior of the DNS.",
"servers": "servers is a list of DNS resolvers that provide name query delegation for one or more subdomains outside the scope of the cluster domain. If servers consists of more than one Server, longest suffix match will be used to determine the Server.\n\nFor example, if there are two Servers, one for \"foo.com\" and another for \"a.foo.com\", and the name query is for \"www.a.foo.com\", it will be routed to the Server with Zone \"a.foo.com\".\n\nIf this field is nil, no servers are created.",
"upstreamResolvers": "upstreamResolvers defines a schema for configuring CoreDNS to proxy DNS messages to upstream resolvers for the case of the default (\".\") server\n\nIf this field is not specified, the upstream used will default to /etc/resolv.conf, with policy \"sequential\"",
"nodePlacement": "nodePlacement provides explicit control over the scheduling of DNS pods.\n\nGenerally, it is useful to run a DNS pod on every node so that DNS queries are always handled by a local DNS pod instead of going over the network to a DNS pod on another node. However, security policies may require restricting the placement of DNS pods to specific nodes. For example, if a security policy prohibits pods on arbitrary nodes from communicating with the API, a node selector can be specified to restrict DNS pods to nodes that are permitted to communicate with the API. Conversely, if running DNS pods on nodes with a particular taint is desired, a toleration can be specified for that taint.\n\nIf unset, defaults are used. See nodePlacement for more details.",
"managementState": "managementState indicates whether the DNS operator should manage cluster DNS",
"operatorLogLevel": "operatorLogLevel controls the logging level of the DNS Operator. Valid values are: \"Normal\", \"Debug\", \"Trace\". Defaults to \"Normal\". setting operatorLogLevel: Trace will produce extremely verbose logs.",
"logLevel": "logLevel describes the desired logging verbosity for CoreDNS. Any one of the following values may be specified: * Normal logs errors from upstream resolvers. * Debug logs errors, NXDOMAIN responses, and NODATA responses. * Trace logs errors and all responses.\n Setting logLevel: Trace will produce extremely verbose logs.\nValid values are: \"Normal\", \"Debug\", \"Trace\". Defaults to \"Normal\".",
"cache": "cache describes the caching configuration that applies to all server blocks listed in the Corefile. This field allows a cluster admin to optionally configure: * positiveTTL which is a duration for which positive responses should be cached. * negativeTTL which is a duration for which negative responses should be cached. If this is not configured, OpenShift will configure positive and negative caching with a default value that is subject to change. At the time of writing, the default positiveTTL is 900 seconds and the default negativeTTL is 30 seconds or as noted in the respective Corefile for your version of OpenShift.",
}
func (DNSSpec) SwaggerDoc() map[string]string {
return map_DNSSpec
}
var map_DNSStatus = map[string]string{
"": "DNSStatus defines the observed status of the DNS.",
"clusterIP": "clusterIP is the service IP through which this DNS is made available.\n\nIn the case of the default DNS, this will be a well known IP that is used as the default nameserver for pods that are using the default ClusterFirst DNS policy.\n\nIn general, this IP can be specified in a pod's spec.dnsConfig.nameservers list or used explicitly when performing name resolution from within the cluster. Example: dig foo.com @<service IP>\n\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"clusterDomain": "clusterDomain is the local cluster DNS domain suffix for DNS services. This will be a subdomain as defined in RFC 1034, section 3.5: https://tools.ietf.org/html/rfc1034#section-3.5 Example: \"cluster.local\"\n\nMore info: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service",
"conditions": "conditions provide information about the state of the DNS on the cluster.\n\nThese are the supported DNS conditions:\n\n * Available\n - True if the following conditions are met:\n * DNS controller daemonset is available.\n - False if any of those conditions are unsatisfied.",
}
func (DNSStatus) SwaggerDoc() map[string]string {
return map_DNSStatus
}
var map_DNSTransportConfig = map[string]string{
"": "DNSTransportConfig groups related configuration parameters used for configuring forwarding to upstream resolvers that support DNS-over-TLS.",
"transport": "transport allows cluster administrators to opt-in to using a DNS-over-TLS connection between cluster DNS and an upstream resolver(s). Configuring TLS as the transport at this level without configuring a CABundle will result in the system certificates being used to verify the serving certificate of the upstream resolver(s).\n\nPossible values: \"\" (empty) - This means no explicit choice has been made and the platform chooses the default which is subject to change over time. The current default is \"Cleartext\". \"Cleartext\" - Cluster admin specified cleartext option. This results in the same functionality as an empty value but may be useful when a cluster admin wants to be more explicit about the transport, or wants to switch from \"TLS\" to \"Cleartext\" explicitly. \"TLS\" - This indicates that DNS queries should be sent over a TLS connection. If Transport is set to TLS, you MUST also set ServerName. If a port is not included with the upstream IP, port 853 will be tried by default per RFC 7858 section 3.1; https://datatracker.ietf.org/doc/html/rfc7858#section-3.1.",
"tls": "tls contains the additional configuration options to use when Transport is set to \"TLS\".",
}
func (DNSTransportConfig) SwaggerDoc() map[string]string {
return map_DNSTransportConfig
}
var map_ForwardPlugin = map[string]string{
"": "ForwardPlugin defines a schema for configuring the CoreDNS forward plugin.",
"upstreams": "upstreams is a list of resolvers to forward name queries for subdomains of Zones. Each instance of CoreDNS performs health checking of Upstreams. When a healthy upstream returns an error during the exchange, another resolver is tried from Upstreams. The Upstreams are selected in the order specified in Policy. Each upstream is represented by an IP address or IP:port if the upstream listens on a port other than 53.\n\nA maximum of 15 upstreams is allowed per ForwardPlugin.",
"policy": "policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified:\n\n* \"Random\" picks a random upstream server for each query. * \"RoundRobin\" picks upstream servers in a round-robin order, moving to the next server for each new query. * \"Sequential\" tries querying upstream servers in a sequential order until one responds, starting with the first server for each new query.\n\nThe default value is \"Random\"",
"transportConfig": "transportConfig is used to configure the transport type, server name, and optional custom CA or CA bundle to use when forwarding DNS requests to an upstream resolver.\n\nThe default value is \"\" (empty) which results in a standard cleartext connection being used when forwarding DNS requests to an upstream resolver.",
"protocolStrategy": "protocolStrategy specifies the protocol to use for upstream DNS requests. Valid values for protocolStrategy are \"TCP\" and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is to use the protocol of the original client request. \"TCP\" specifies that the platform should use TCP for all upstream DNS requests, even if the client request uses UDP. \"TCP\" is useful for UDP-specific issues such as those created by non-compliant upstream resolvers, but may consume more bandwidth or increase DNS response time. Note that protocolStrategy only affects the protocol of DNS requests that CoreDNS makes to upstream resolvers. It does not affect the protocol of DNS requests between clients and CoreDNS.",
}
func (ForwardPlugin) SwaggerDoc() map[string]string {
return map_ForwardPlugin
}
var map_Server = map[string]string{
"": "Server defines the schema for a server that runs per instance of CoreDNS.",
"name": "name is required and specifies a unique name for the server. Name must comply with the Service Name Syntax of rfc6335.",
"zones": "zones is required and specifies the subdomains that Server is authoritative for. Zones must conform to the rfc1123 definition of a subdomain. Specifying the cluster domain (i.e., \"cluster.local\") is invalid.",
"forwardPlugin": "forwardPlugin defines a schema for configuring CoreDNS to proxy DNS messages to upstream resolvers.",
}
func (Server) SwaggerDoc() map[string]string {
return map_Server
}
var map_Upstream = map[string]string{
"": "Upstream can either be of type SystemResolvConf, or of type Network.\n\n - For an Upstream of type SystemResolvConf, no further fields are necessary:\n The upstream will be configured to use /etc/resolv.conf.\n - For an Upstream of type Network, a NetworkResolver field needs to be defined\n with an IP address or IP:port if the upstream listens on a port other than 53.",
"type": "type defines whether this upstream contains an IP/IP:port resolver or the local /etc/resolv.conf. Type accepts 2 possible values: SystemResolvConf or Network.\n\n* When SystemResolvConf is used, the Upstream structure does not require any further fields to be defined:\n /etc/resolv.conf will be used\n* When Network is used, the Upstream structure must contain at least an Address",
"address": "address must be defined when Type is set to Network. It will be ignored otherwise. It must be a valid ipv4 or ipv6 address.",
"port": "port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535",
}
func (Upstream) SwaggerDoc() map[string]string {
return map_Upstream
}
var map_UpstreamResolvers = map[string]string{
"": "UpstreamResolvers defines a schema for configuring the CoreDNS forward plugin in the specific case of the default (\".\") server. It defers from ForwardPlugin in the default values it accepts: * At least one upstream should be specified. * the default policy is Sequential",
"upstreams": "upstreams is a list of resolvers to forward name queries for the \".\" domain. Each instance of CoreDNS performs health checking of Upstreams. When a healthy upstream returns an error during the exchange, another resolver is tried from Upstreams. The Upstreams are selected in the order specified in Policy.\n\nA maximum of 15 upstreams is allowed per ForwardPlugin. If no Upstreams are specified, /etc/resolv.conf is used by default",
"policy": "policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified:\n\n* \"Random\" picks a random upstream server for each query. * \"RoundRobin\" picks upstream servers in a round-robin order, moving to the next server for each new query. * \"Sequential\" tries querying upstream servers in a sequential order until one responds, starting with the first server for each new query.\n\nThe default value is \"Sequential\"",
"transportConfig": "transportConfig is used to configure the transport type, server name, and optional custom CA or CA bundle to use when forwarding DNS requests to an upstream resolver.\n\nThe default value is \"\" (empty) which results in a standard cleartext connection being used when forwarding DNS requests to an upstream resolver.",
"protocolStrategy": "protocolStrategy specifies the protocol to use for upstream DNS requests. Valid values for protocolStrategy are \"TCP\" and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is to use the protocol of the original client request. \"TCP\" specifies that the platform should use TCP for all upstream DNS requests, even if the client request uses UDP. \"TCP\" is useful for UDP-specific issues such as those created by non-compliant upstream resolvers, but may consume more bandwidth or increase DNS response time. Note that protocolStrategy only affects the protocol of DNS requests that CoreDNS makes to upstream resolvers. It does not affect the protocol of DNS requests between clients and CoreDNS.",
}
func (UpstreamResolvers) SwaggerDoc() map[string]string {
return map_UpstreamResolvers
}
var map_Etcd = map[string]string{
"": "Etcd provides information to configure an operator to manage etcd.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}
func (Etcd) SwaggerDoc() map[string]string {
return map_Etcd
}
var map_EtcdList = map[string]string{
"": "KubeAPISOperatorConfigList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "items contains the items",
}
func (EtcdList) SwaggerDoc() map[string]string {
return map_EtcdList
}
var map_EtcdSpec = map[string]string{
"controlPlaneHardwareSpeed": "HardwareSpeed allows user to change the etcd tuning profile which configures the latency parameters for heartbeat interval and leader election timeouts allowing the cluster to tolerate longer round-trip-times between etcd members. Valid values are \"\", \"Standard\" and \"Slower\".\n\t\"\" means no opinion and the platform is left to choose a reasonable default\n\twhich is subject to change without notice.",
"backendQuotaGiB": "backendQuotaGiB sets the etcd backend storage size limit in gibibytes. The value should be an integer not less than 8 and not more than 32. When not specified, the default value is 8.",
}
func (EtcdSpec) SwaggerDoc() map[string]string {
return map_EtcdSpec
}
var map_AWSClassicLoadBalancerParameters = map[string]string{
"": "AWSClassicLoadBalancerParameters holds configuration parameters for an AWS Classic load balancer.",
"connectionIdleTimeout": "connectionIdleTimeout specifies the maximum time period that a connection may be idle before the load balancer closes the connection. The value must be parseable as a time duration value; see <https://pkg.go.dev/time#ParseDuration>. A nil or zero value means no opinion, in which case a default value is used. The default value for this field is 60s. This default is subject to change.",
"subnets": "subnets specifies the subnets to which the load balancer will attach. The subnets may be specified by either their ID or name. The total number of subnets is limited to 10.\n\nIn order for the load balancer to be provisioned with subnets, each subnet must exist, each subnet must be from a different availability zone, and the load balancer service must be recreated to pick up new values.\n\nWhen omitted from the spec, the subnets will be auto-discovered for each availability zone. Auto-discovered subnets are not reported in the status of the IngressController object.",
}
func (AWSClassicLoadBalancerParameters) SwaggerDoc() map[string]string {
return map_AWSClassicLoadBalancerParameters
}
var map_AWSLoadBalancerParameters = map[string]string{
"": "AWSLoadBalancerParameters provides configuration settings that are specific to AWS load balancers.",
"type": "type is the type of AWS load balancer to instantiate for an ingresscontroller.\n\nValid values are:\n\n* \"Classic\": A Classic Load Balancer that makes routing decisions at either\n the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See\n the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb\n\n* \"NLB\": A Network Load Balancer that makes routing decisions at the\n transport layer (TCP/SSL). See the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb",
"classicLoadBalancer": "classicLoadBalancerParameters holds configuration parameters for an AWS classic load balancer. Present only if type is Classic.",
"networkLoadBalancer": "networkLoadBalancerParameters holds configuration parameters for an AWS network load balancer. Present only if type is NLB.",
}
func (AWSLoadBalancerParameters) SwaggerDoc() map[string]string {
return map_AWSLoadBalancerParameters
}
var map_AWSNetworkLoadBalancerParameters = map[string]string{
"": "AWSNetworkLoadBalancerParameters holds configuration parameters for an AWS Network load balancer. For Example: Setting AWS EIPs https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html",
"subnets": "subnets specifies the subnets to which the load balancer will attach. The subnets may be specified by either their ID or name. The total number of subnets is limited to 10.\n\nIn order for the load balancer to be provisioned with subnets, each subnet must exist, each subnet must be from a different availability zone, and the load balancer service must be recreated to pick up new values.\n\nWhen omitted from the spec, the subnets will be auto-discovered for each availability zone. Auto-discovered subnets are not reported in the status of the IngressController object.",
"eipAllocations": "eipAllocations is a list of IDs for Elastic IP (EIP) addresses that are assigned to the Network Load Balancer. The following restrictions apply:\n\neipAllocations can only be used with external scope, not internal. An EIP can be allocated to only a single IngressController. The number of EIP allocations must match the number of subnets that are used for the load balancer. Each EIP allocation must be unique. A maximum of 10 EIP allocations are permitted.\n\nSee https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html for general information about configuration, characteristics, and limitations of Elastic IP addresses.",
}
func (AWSNetworkLoadBalancerParameters) SwaggerDoc() map[string]string {
return map_AWSNetworkLoadBalancerParameters
}
var map_AWSSubnets = map[string]string{
"": "AWSSubnets contains a list of references to AWS subnets by ID or name.",
"ids": "ids specifies a list of AWS subnets by subnet ID. Subnet IDs must start with \"subnet-\", consist only of alphanumeric characters, must be exactly 24 characters long, must be unique, and the total number of subnets specified by ids and names must not exceed 10.",
"names": "names specifies a list of AWS subnets by subnet name. Subnet names must not start with \"subnet-\", must not include commas, must be under 256 characters in length, must be unique, and the total number of subnets specified by ids and names must not exceed 10.",
}
func (AWSSubnets) SwaggerDoc() map[string]string {
return map_AWSSubnets
}
var map_AccessLogging = map[string]string{
"": "AccessLogging describes how client requests should be logged.",
"destination": "destination is where access logs go.",
"httpLogFormat": "httpLogFormat specifies the format of the log message for an HTTP request.\n\nIf this field is empty, log messages use the implementation's default HTTP log format. For HAProxy's default HTTP log format, see the HAProxy documentation: http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3\n\nNote that this format only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). It does not affect the log format for TLS passthrough connections.",
"httpCaptureHeaders": "httpCaptureHeaders defines HTTP headers that should be captured in access logs. If this field is empty, no headers are captured.\n\nNote that this option only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). Headers cannot be captured for TLS passthrough connections.",
"httpCaptureCookies": "httpCaptureCookies specifies HTTP cookies that should be captured in access logs. If this field is empty, no cookies are captured.",
"logEmptyRequests": "logEmptyRequests specifies how connections on which no request is received should be logged. Typically, these empty requests come from load balancers' health probes or Web browsers' speculative connections (\"preconnect\"), in which case logging these requests may be undesirable. However, these requests may also be caused by network errors, in which case logging empty requests may be useful for diagnosing the errors. In addition, these requests may be caused by port scans, in which case logging empty requests may aid in detecting intrusion attempts. Allowed values for this field are \"Log\" and \"Ignore\". The default value is \"Log\".",
}
func (AccessLogging) SwaggerDoc() map[string]string {
return map_AccessLogging
}
var map_ClientTLS = map[string]string{
"": "ClientTLS specifies TLS configuration to enable client-to-server authentication, which can be used for mutual TLS.",
"clientCertificatePolicy": "clientCertificatePolicy specifies whether the ingress controller requires clients to provide certificates. This field accepts the values \"Required\" or \"Optional\".\n\nNote that the ingress controller only checks client certificates for edge-terminated and reencrypt TLS routes; it cannot check certificates for cleartext HTTP or passthrough TLS routes.",
"clientCA": "clientCA specifies a configmap containing the PEM-encoded CA certificate bundle that should be used to verify a client's certificate. The administrator must create this configmap in the openshift-config namespace.",
"allowedSubjectPatterns": "allowedSubjectPatterns specifies a list of regular expressions that should be matched against the distinguished name on a valid client certificate to filter requests. The regular expressions must use PCRE syntax. If this list is empty, no filtering is performed. If the list is nonempty, then at least one pattern must match a client certificate's distinguished name or else the ingress controller rejects the certificate and denies the connection.",
}
func (ClientTLS) SwaggerDoc() map[string]string {
return map_ClientTLS
}
var map_ContainerLoggingDestinationParameters = map[string]string{
"": "ContainerLoggingDestinationParameters describes parameters for the Container logging destination type.",
"maxLength": "maxLength is the maximum length of the log message.\n\nValid values are integers in the range 480 to 8192, inclusive.\n\nWhen omitted, the default value is 1024.",
}
func (ContainerLoggingDestinationParameters) SwaggerDoc() map[string]string {
return map_ContainerLoggingDestinationParameters
}
var map_EndpointPublishingStrategy = map[string]string{
"": "EndpointPublishingStrategy is a way to publish the endpoints of an IngressController, and represents the type and any additional configuration for a specific type.",
"type": "type is the publishing strategy to use. Valid values are:\n\n* LoadBalancerService\n\nPublishes the ingress controller using a Kubernetes LoadBalancer Service.\n\nIn this configuration, the ingress controller deployment uses container networking. A LoadBalancer Service is created to publish the deployment.\n\nSee: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer\n\nIf domain is set, a wildcard DNS record will be managed to point at the LoadBalancer Service's external name. DNS records are managed only in DNS zones defined by dns.config.openshift.io/cluster .spec.publicZone and .spec.privateZone.\n\nWildcard DNS management is currently supported only on the AWS, Azure, and GCP platforms.\n\n* HostNetwork\n\nPublishes the ingress controller on node ports where the ingress controller is deployed.\n\nIn this configuration, the ingress controller deployment uses host networking, bound to node ports 80 and 443. The user is responsible for configuring an external load balancer to publish the ingress controller via the node ports.\n\n* Private\n\nDoes not publish the ingress controller.\n\nIn this configuration, the ingress controller deployment uses container networking, and is not explicitly published. The user must manually publish the ingress controller.\n\n* NodePortService\n\nPublishes the ingress controller using a Kubernetes NodePort Service.\n\nIn this configuration, the ingress controller deployment uses container networking. A NodePort Service is created to publish the deployment. The specific node ports are dynamically allocated by OpenShift; however, to support static port allocations, user changes to the node port field of the managed NodePort Service will preserved.",
"loadBalancer": "loadBalancer holds parameters for the load balancer. Present only if type is LoadBalancerService.",
"hostNetwork": "hostNetwork holds parameters for the HostNetwork endpoint publishing strategy. Present only if type is HostNetwork.",
"private": "private holds parameters for the Private endpoint publishing strategy. Present only if type is Private.",
"nodePort": "nodePort holds parameters for the NodePortService endpoint publishing strategy. Present only if type is NodePortService.",
}
func (EndpointPublishingStrategy) SwaggerDoc() map[string]string {
return map_EndpointPublishingStrategy
}
var map_GCPLoadBalancerParameters = map[string]string{
"": "GCPLoadBalancerParameters provides configuration settings that are specific to GCP load balancers.",
"clientAccess": "clientAccess describes how client access is restricted for internal load balancers.\n\nValid values are: * \"Global\": Specifying an internal load balancer with Global client access\n allows clients from any region within the VPC to communicate with the load\n balancer.\n\n https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access\n\n* \"Local\": Specifying an internal load balancer with Local client access\n means only clients within the same region (and VPC) as the GCP load balancer\n can communicate with the load balancer. Note that this is the default behavior.\n\n https://cloud.google.com/load-balancing/docs/internal#client_access",
}
func (GCPLoadBalancerParameters) SwaggerDoc() map[string]string {
return map_GCPLoadBalancerParameters
}
var map_HTTPCompressionPolicy = map[string]string{
"": "httpCompressionPolicy turns on compression for the specified MIME types.\n\nThis field is optional, and its absence implies that compression should not be enabled globally in HAProxy.\n\nIf httpCompressionPolicy exists, compression should be enabled only for the specified MIME types.",
"mimeTypes": "mimeTypes is a list of MIME types that should have compression applied. This list can be empty, in which case the ingress controller does not apply compression.\n\nNote: Not all MIME types benefit from compression, but HAProxy will still use resources to try to compress if instructed to. Generally speaking, text (html, css, js, etc.) formats benefit from compression, but formats that are already compressed (image, audio, video, etc.) benefit little in exchange for the time and cpu spent on compressing again. See https://joehonton.medium.com/the-gzip-penalty-d31bd697f1a2",
}
func (HTTPCompressionPolicy) SwaggerDoc() map[string]string {
return map_HTTPCompressionPolicy
}
var map_HostNetworkStrategy = map[string]string{
"": "HostNetworkStrategy holds parameters for the HostNetwork endpoint publishing strategy.",
"protocol": "protocol specifies whether the IngressController expects incoming connections to use plain TCP or whether the IngressController expects PROXY protocol.\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nThe following values are valid for this field:\n\n* The empty string. * \"TCP\". * \"PROXY\".\n\nThe empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change.",
"httpPort": "httpPort is the port on the host which should be used to listen for HTTP requests. This field should be set when port 80 is already in use. The value should not coincide with the NodePort range of the cluster. When the value is 0 or is not specified it defaults to 80.",
"httpsPort": "httpsPort is the port on the host which should be used to listen for HTTPS requests. This field should be set when port 443 is already in use. The value should not coincide with the NodePort range of the cluster. When the value is 0 or is not specified it defaults to 443.",
"statsPort": "statsPort is the port on the host where the stats from the router are published. The value should not coincide with the NodePort range of the cluster. If an external load balancer is configured to forward connections to this IngressController, the load balancer should use this port for health checks. The load balancer can send HTTP probes on this port on a given node, with the path /healthz/ready to determine if the ingress controller is ready to receive traffic on the node. For proper operation the load balancer must not forward traffic to a node until the health check reports ready. The load balancer should also stop forwarding requests within a maximum of 45 seconds after /healthz/ready starts reporting not-ready. Probing every 5 to 10 seconds, with a 5-second timeout and with a threshold of two successful or failed requests to become healthy or unhealthy respectively, are well-tested values. When the value is 0 or is not specified it defaults to 1936.",
}
func (HostNetworkStrategy) SwaggerDoc() map[string]string {
return map_HostNetworkStrategy
}
var map_IBMLoadBalancerParameters = map[string]string{
"": "IBMLoadBalancerParameters provides configuration settings that are specific to IBM Cloud load balancers.",
"protocol": "protocol specifies whether the load balancer uses PROXY protocol to forward connections to the IngressController. See \"service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features: \"proxy-protocol\"\" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas\"\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nValid values for protocol are TCP, PROXY and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is TCP, without the proxy protocol enabled.",
}
func (IBMLoadBalancerParameters) SwaggerDoc() map[string]string {
return map_IBMLoadBalancerParameters
}
var map_IngressController = map[string]string{
"": "IngressController describes a managed ingress controller for the cluster. The controller can service OpenShift Route and Kubernetes Ingress resources.\n\nWhen an IngressController is created, a new ingress controller deployment is created to allow external traffic to reach the services that expose Ingress or Route resources. Updating this resource may lead to disruption for public facing network connections as a new ingress controller revision may be rolled out.\n\nhttps://kubernetes.io/docs/concepts/services-networking/ingress-controllers\n\nWhenever possible, sensible defaults for the platform are used. See each field for more details.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "spec is the specification of the desired behavior of the IngressController.",
"status": "status is the most recently observed status of the IngressController.",
}
func (IngressController) SwaggerDoc() map[string]string {
return map_IngressController
}
var map_IngressControllerCaptureHTTPCookie = map[string]string{
"": "IngressControllerCaptureHTTPCookie describes an HTTP cookie that should be captured.",
"maxLength": "maxLength specifies a maximum length of the string that will be logged, which includes the cookie name, cookie value, and one-character delimiter. If the log entry exceeds this length, the value will be truncated in the log message. Note that the ingress controller may impose a separate bound on the total length of HTTP headers in a request.",
}
func (IngressControllerCaptureHTTPCookie) SwaggerDoc() map[string]string {
return map_IngressControllerCaptureHTTPCookie
}
var map_IngressControllerCaptureHTTPCookieUnion = map[string]string{
"": "IngressControllerCaptureHTTPCookieUnion describes optional fields of an HTTP cookie that should be captured.",
"matchType": "matchType specifies the type of match to be performed on the cookie name. Allowed values are \"Exact\" for an exact string match and \"Prefix\" for a string prefix match. If \"Exact\" is specified, a name must be specified in the name field. If \"Prefix\" is provided, a prefix must be specified in the namePrefix field. For example, specifying matchType \"Prefix\" and namePrefix \"foo\" will capture a cookie named \"foo\" or \"foobar\" but not one named \"bar\". The first matching cookie is captured.",
"name": "name specifies a cookie name. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
"namePrefix": "namePrefix specifies a cookie name prefix. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
}
func (IngressControllerCaptureHTTPCookieUnion) SwaggerDoc() map[string]string {
return map_IngressControllerCaptureHTTPCookieUnion
}
var map_IngressControllerCaptureHTTPHeader = map[string]string{
"": "IngressControllerCaptureHTTPHeader describes an HTTP header that should be captured.",
"name": "name specifies a header name. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2.",
"maxLength": "maxLength specifies a maximum length for the header value. If a header value exceeds this length, the value will be truncated in the log message. Note that the ingress controller may impose a separate bound on the total length of HTTP headers in a request.",
}
func (IngressControllerCaptureHTTPHeader) SwaggerDoc() map[string]string {
return map_IngressControllerCaptureHTTPHeader
}
var map_IngressControllerCaptureHTTPHeaders = map[string]string{
"": "IngressControllerCaptureHTTPHeaders specifies which HTTP headers the IngressController captures.",
"request": "request specifies which HTTP request headers to capture.\n\nIf this field is empty, no request headers are captured.",
"response": "response specifies which HTTP response headers to capture.\n\nIf this field is empty, no response headers are captured.",
}
func (IngressControllerCaptureHTTPHeaders) SwaggerDoc() map[string]string {
return map_IngressControllerCaptureHTTPHeaders
}
var map_IngressControllerHTTPHeader = map[string]string{
"": "IngressControllerHTTPHeader specifies configuration for setting or deleting an HTTP header.",
"name": "name specifies the name of a header on which to perform an action. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2. The name must consist only of alphanumeric and the following special characters, \"-!#$%&'*+.^_`\". The following header names are reserved and may not be modified via this API: Strict-Transport-Security, Proxy, Host, Cookie, Set-Cookie. It must be no more than 255 characters in length. Header name must be unique.",
"action": "action specifies actions to perform on headers, such as setting or deleting headers.",
}
func (IngressControllerHTTPHeader) SwaggerDoc() map[string]string {
return map_IngressControllerHTTPHeader
}
var map_IngressControllerHTTPHeaderActionUnion = map[string]string{
"": "IngressControllerHTTPHeaderActionUnion specifies an action to take on an HTTP header.",
"type": "type defines the type of the action to be applied on the header. Possible values are Set or Delete. Set allows you to set HTTP request and response headers. Delete allows you to delete HTTP request and response headers.",
"set": "set specifies how the HTTP header should be set. This field is required when type is Set and forbidden otherwise.",
}