1 package v1
2
3
4
5
6
7
8
9
10
11
12
13
14 var map_GenerationStatus = map[string]string{
15 "": "GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.",
16 "group": "group is the group of the thing you're tracking",
17 "resource": "resource is the resource type of the thing you're tracking",
18 "namespace": "namespace is where the thing you're tracking is",
19 "name": "name is the name of the thing you're tracking",
20 "lastGeneration": "lastGeneration is the last generation of the workload controller involved",
21 "hash": "hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps",
22 }
23
24 func (GenerationStatus) SwaggerDoc() map[string]string {
25 return map_GenerationStatus
26 }
27
28 var map_MyOperatorResource = map[string]string{
29 "": "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.",
30 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
31 }
32
33 func (MyOperatorResource) SwaggerDoc() map[string]string {
34 return map_MyOperatorResource
35 }
36
37 var map_NodeStatus = map[string]string{
38 "": "NodeStatus provides information about the current state of a particular node managed by this operator.",
39 "nodeName": "nodeName is the name of the node",
40 "currentRevision": "currentRevision is the generation of the most recently successful deployment",
41 "targetRevision": "targetRevision is the generation of the deployment we're trying to apply",
42 "lastFailedRevision": "lastFailedRevision is the generation of the deployment we tried and failed to deploy.",
43 "lastFailedTime": "lastFailedTime is the time the last failed revision failed the last time.",
44 "lastFailedReason": "lastFailedReason is a machine readable failure reason string.",
45 "lastFailedCount": "lastFailedCount is how often the installer pod of the last failed revision failed.",
46 "lastFallbackCount": "lastFallbackCount is how often a fallback to a previous revision happened.",
47 "lastFailedRevisionErrors": "lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision.",
48 }
49
50 func (NodeStatus) SwaggerDoc() map[string]string {
51 return map_NodeStatus
52 }
53
54 var map_OperatorCondition = map[string]string{
55 "": "OperatorCondition is just the standard condition fields.",
56 }
57
58 func (OperatorCondition) SwaggerDoc() map[string]string {
59 return map_OperatorCondition
60 }
61
62 var map_OperatorSpec = map[string]string{
63 "": "OperatorSpec contains common fields operators need. It is intended to be anonymous included inside of the Spec struct for your particular operator.",
64 "managementState": "managementState indicates whether and how the operator should manage the component",
65 "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\".",
66 "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\".",
67 "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.",
68 "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",
69 }
70
71 func (OperatorSpec) SwaggerDoc() map[string]string {
72 return map_OperatorSpec
73 }
74
75 var map_OperatorStatus = map[string]string{
76 "observedGeneration": "observedGeneration is the last generation change you've dealt with",
77 "conditions": "conditions is a list of conditions and their status",
78 "version": "version is the level this availability applies to",
79 "readyReplicas": "readyReplicas indicates how many replicas are ready and at the desired state",
80 "generations": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
81 }
82
83 func (OperatorStatus) SwaggerDoc() map[string]string {
84 return map_OperatorStatus
85 }
86
87 var map_StaticPodOperatorSpec = map[string]string{
88 "": "StaticPodOperatorSpec is spec for controllers that manage static pods.",
89 "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.",
90 "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)",
91 "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)",
92 }
93
94 func (StaticPodOperatorSpec) SwaggerDoc() map[string]string {
95 return map_StaticPodOperatorSpec
96 }
97
98 var map_StaticPodOperatorStatus = map[string]string{
99 "": "StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked.",
100 "latestAvailableRevision": "latestAvailableRevision is the deploymentID of the most recent deployment",
101 "latestAvailableRevisionReason": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
102 "nodeStatuses": "nodeStatuses track the deployment values and errors across individual nodes",
103 }
104
105 func (StaticPodOperatorStatus) SwaggerDoc() map[string]string {
106 return map_StaticPodOperatorStatus
107 }
108
109 var map_Authentication = map[string]string{
110 "": "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).",
111 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
112 }
113
114 func (Authentication) SwaggerDoc() map[string]string {
115 return map_Authentication
116 }
117
118 var map_AuthenticationList = map[string]string{
119 "": "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).",
120 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
121 }
122
123 func (AuthenticationList) SwaggerDoc() map[string]string {
124 return map_AuthenticationList
125 }
126
127 var map_AuthenticationStatus = map[string]string{
128 "oauthAPIServer": "OAuthAPIServer holds status specific only to oauth-apiserver",
129 }
130
131 func (AuthenticationStatus) SwaggerDoc() map[string]string {
132 return map_AuthenticationStatus
133 }
134
135 var map_OAuthAPIServerStatus = map[string]string{
136 "latestAvailableRevision": "LatestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.",
137 }
138
139 func (OAuthAPIServerStatus) SwaggerDoc() map[string]string {
140 return map_OAuthAPIServerStatus
141 }
142
143 var map_CloudCredential = map[string]string{
144 "": "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).",
145 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
146 }
147
148 func (CloudCredential) SwaggerDoc() map[string]string {
149 return map_CloudCredential
150 }
151
152 var map_CloudCredentialList = map[string]string{
153 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
154 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
155 }
156
157 func (CloudCredentialList) SwaggerDoc() map[string]string {
158 return map_CloudCredentialList
159 }
160
161 var map_CloudCredentialSpec = map[string]string{
162 "": "CloudCredentialSpec is the specification of the desired behavior of the cloud-credential-operator.",
163 "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\"",
164 }
165
166 func (CloudCredentialSpec) SwaggerDoc() map[string]string {
167 return map_CloudCredentialSpec
168 }
169
170 var map_CloudCredentialStatus = map[string]string{
171 "": "CloudCredentialStatus defines the observed status of the cloud-credential-operator.",
172 }
173
174 func (CloudCredentialStatus) SwaggerDoc() map[string]string {
175 return map_CloudCredentialStatus
176 }
177
178 var map_Config = map[string]string{
179 "": "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).",
180 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
181 "spec": "spec is the specification of the desired behavior of the Config Operator.",
182 "status": "status defines the observed status of the Config Operator.",
183 }
184
185 func (Config) SwaggerDoc() map[string]string {
186 return map_Config
187 }
188
189 var map_ConfigList = map[string]string{
190 "": "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).",
191 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
192 "items": "Items contains the items",
193 }
194
195 func (ConfigList) SwaggerDoc() map[string]string {
196 return map_ConfigList
197 }
198
199 var map_AddPage = map[string]string{
200 "": "AddPage allows customizing actions on the Add page in developer perspective.",
201 "disabledActions": "disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID.",
202 }
203
204 func (AddPage) SwaggerDoc() map[string]string {
205 return map_AddPage
206 }
207
208 var map_Console = map[string]string{
209 "": "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).",
210 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
211 }
212
213 func (Console) SwaggerDoc() map[string]string {
214 return map_Console
215 }
216
217 var map_ConsoleConfigRoute = map[string]string{
218 "": "ConsoleConfigRoute holds information on external route access to console. DEPRECATED",
219 "hostname": "hostname is the desired custom domain under which console will be available.",
220 "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.",
221 }
222
223 func (ConsoleConfigRoute) SwaggerDoc() map[string]string {
224 return map_ConsoleConfigRoute
225 }
226
227 var map_ConsoleCustomization = map[string]string{
228 "": "ConsoleCustomization defines a list of optional configuration for the console UI.",
229 "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.",
230 "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.",
231 "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.",
232 "customLogoFile": "customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a 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. Recommended logo specifications: Dimensions: Max height of 68px and max width of 200px SVG format preferred",
233 "developerCatalog": "developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).",
234 "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.",
235 "quickStarts": "quickStarts allows customization of available ConsoleQuickStart resources in console.",
236 "addPage": "addPage allows customizing actions on the Add page in developer perspective.",
237 "perspectives": "perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.",
238 }
239
240 func (ConsoleCustomization) SwaggerDoc() map[string]string {
241 return map_ConsoleCustomization
242 }
243
244 var map_ConsoleList = map[string]string{
245 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
246 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
247 }
248
249 func (ConsoleList) SwaggerDoc() map[string]string {
250 return map_ConsoleList
251 }
252
253 var map_ConsoleProviders = map[string]string{
254 "": "ConsoleProviders defines a list of optional additional providers of functionality to the console.",
255 "statuspage": "statuspage contains ID for statuspage.io page that provides status info about.",
256 }
257
258 func (ConsoleProviders) SwaggerDoc() map[string]string {
259 return map_ConsoleProviders
260 }
261
262 var map_ConsoleSpec = map[string]string{
263 "": "ConsoleSpec is the specification of the desired behavior of the Console.",
264 "customization": "customization is used to optionally provide a small set of customization options to the web console.",
265 "providers": "providers contains configuration for using specific service providers.",
266 "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",
267 "plugins": "plugins defines a list of enabled console plugin names.",
268 }
269
270 func (ConsoleSpec) SwaggerDoc() map[string]string {
271 return map_ConsoleSpec
272 }
273
274 var map_ConsoleStatus = map[string]string{
275 "": "ConsoleStatus defines the observed status of the Console.",
276 }
277
278 func (ConsoleStatus) SwaggerDoc() map[string]string {
279 return map_ConsoleStatus
280 }
281
282 var map_DeveloperConsoleCatalogCategory = map[string]string{
283 "": "DeveloperConsoleCatalogCategory for the developer console catalog.",
284 "subcategories": "subcategories defines a list of child categories.",
285 }
286
287 func (DeveloperConsoleCatalogCategory) SwaggerDoc() map[string]string {
288 return map_DeveloperConsoleCatalogCategory
289 }
290
291 var map_DeveloperConsoleCatalogCategoryMeta = map[string]string{
292 "": "DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.",
293 "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.",
294 "label": "label defines a category display label. It is required and must have 1-64 characters.",
295 "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.",
296 }
297
298 func (DeveloperConsoleCatalogCategoryMeta) SwaggerDoc() map[string]string {
299 return map_DeveloperConsoleCatalogCategoryMeta
300 }
301
302 var map_DeveloperConsoleCatalogCustomization = map[string]string{
303 "": "DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog.",
304 "categories": "categories which are shown in the developer catalog.",
305 "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.",
306 }
307
308 func (DeveloperConsoleCatalogCustomization) SwaggerDoc() map[string]string {
309 return map_DeveloperConsoleCatalogCustomization
310 }
311
312 var map_DeveloperConsoleCatalogTypes = map[string]string{
313 "": "DeveloperConsoleCatalogTypes defines the state of the sub-catalog types.",
314 "state": "state defines if a list of catalog types should be enabled or disabled.",
315 "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.",
316 "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.",
317 }
318
319 func (DeveloperConsoleCatalogTypes) SwaggerDoc() map[string]string {
320 return map_DeveloperConsoleCatalogTypes
321 }
322
323 var map_Perspective = map[string]string{
324 "": "Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown",
325 "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.",
326 "visibility": "visibility defines the state of perspective along with access review checks if needed for that perspective.",
327 "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.",
328 }
329
330 func (Perspective) SwaggerDoc() map[string]string {
331 return map_Perspective
332 }
333
334 var map_PerspectiveVisibility = map[string]string{
335 "": "PerspectiveVisibility defines the criteria to show/hide a perspective",
336 "state": "state defines the perspective is enabled or disabled or access review check is required.",
337 "accessReview": "accessReview defines required and missing access review checks.",
338 }
339
340 func (PerspectiveVisibility) SwaggerDoc() map[string]string {
341 return map_PerspectiveVisibility
342 }
343
344 var map_PinnedResourceReference = map[string]string{
345 "": "PinnedResourceReference includes the group, version and type of resource",
346 "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.",
347 "version": "version is the API Version of the Resource. This value should consist of only lowercase alphanumeric characters. Example: \"v1\", \"v1beta1\", etc.",
348 "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.",
349 }
350
351 func (PinnedResourceReference) SwaggerDoc() map[string]string {
352 return map_PinnedResourceReference
353 }
354
355 var map_ProjectAccess = map[string]string{
356 "": "ProjectAccess contains options for project access roles",
357 "availableClusterRoles": "availableClusterRoles is the list of ClusterRole names that are assignable to users through the project access tab.",
358 }
359
360 func (ProjectAccess) SwaggerDoc() map[string]string {
361 return map_ProjectAccess
362 }
363
364 var map_QuickStarts = map[string]string{
365 "": "QuickStarts allow cluster admins to customize available ConsoleQuickStart resources.",
366 "disabled": "disabled is a list of ConsoleQuickStart resource names that are not shown to users.",
367 }
368
369 func (QuickStarts) SwaggerDoc() map[string]string {
370 return map_QuickStarts
371 }
372
373 var map_ResourceAttributesAccessReview = map[string]string{
374 "": "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.",
375 "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.",
376 "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.",
377 }
378
379 func (ResourceAttributesAccessReview) SwaggerDoc() map[string]string {
380 return map_ResourceAttributesAccessReview
381 }
382
383 var map_StatuspageProvider = map[string]string{
384 "": "StatuspageProvider provides identity for statuspage account.",
385 "pageID": "pageID is the unique ID assigned by Statuspage for your page. This must be a public page.",
386 }
387
388 func (StatuspageProvider) SwaggerDoc() map[string]string {
389 return map_StatuspageProvider
390 }
391
392 var map_AWSCSIDriverConfigSpec = map[string]string{
393 "": "AWSCSIDriverConfigSpec defines properties that can be configured for the AWS CSI driver.",
394 "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.",
395 }
396
397 func (AWSCSIDriverConfigSpec) SwaggerDoc() map[string]string {
398 return map_AWSCSIDriverConfigSpec
399 }
400
401 var map_AzureCSIDriverConfigSpec = map[string]string{
402 "": "AzureCSIDriverConfigSpec defines properties that can be configured for the Azure CSI driver.",
403 "diskEncryptionSet": "diskEncryptionSet sets the cluster default storage class to encrypt volumes with a customer-managed encryption set, rather than the default platform-managed keys.",
404 }
405
406 func (AzureCSIDriverConfigSpec) SwaggerDoc() map[string]string {
407 return map_AzureCSIDriverConfigSpec
408 }
409
410 var map_AzureDiskEncryptionSet = map[string]string{
411 "": "AzureDiskEncryptionSet defines the configuration for a disk encryption set.",
412 "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",
413 "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.",
414 "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.",
415 }
416
417 func (AzureDiskEncryptionSet) SwaggerDoc() map[string]string {
418 return map_AzureDiskEncryptionSet
419 }
420
421 var map_CSIDriverConfigSpec = map[string]string{
422 "": "CSIDriverConfigSpec defines configuration spec that can be used to optionally configure a specific CSI Driver.",
423 "driverType": "driverType indicates type of CSI driver for which the driverConfig is being applied to. Valid values are: AWS, Azure, GCP, vSphere and omitted. Consumers should treat unknown values as a NO-OP.",
424 "aws": "aws is used to configure the AWS CSI driver.",
425 "azure": "azure is used to configure the Azure CSI driver.",
426 "gcp": "gcp is used to configure the GCP CSI driver.",
427 "vSphere": "vsphere is used to configure the vsphere CSI driver.",
428 }
429
430 func (CSIDriverConfigSpec) SwaggerDoc() map[string]string {
431 return map_CSIDriverConfigSpec
432 }
433
434 var map_ClusterCSIDriver = map[string]string{
435 "": "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).",
436 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
437 "spec": "spec holds user settable values for configuration",
438 "status": "status holds observed values from the cluster. They may not be overridden.",
439 }
440
441 func (ClusterCSIDriver) SwaggerDoc() map[string]string {
442 return map_ClusterCSIDriver
443 }
444
445 var map_ClusterCSIDriverList = map[string]string{
446 "": "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).",
447 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
448 }
449
450 func (ClusterCSIDriverList) SwaggerDoc() map[string]string {
451 return map_ClusterCSIDriverList
452 }
453
454 var map_ClusterCSIDriverSpec = map[string]string{
455 "": "ClusterCSIDriverSpec is the desired behavior of CSI driver operator",
456 "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.",
457 "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.",
458 }
459
460 func (ClusterCSIDriverSpec) SwaggerDoc() map[string]string {
461 return map_ClusterCSIDriverSpec
462 }
463
464 var map_ClusterCSIDriverStatus = map[string]string{
465 "": "ClusterCSIDriverStatus is the observed status of CSI driver operator",
466 }
467
468 func (ClusterCSIDriverStatus) SwaggerDoc() map[string]string {
469 return map_ClusterCSIDriverStatus
470 }
471
472 var map_GCPCSIDriverConfigSpec = map[string]string{
473 "": "GCPCSIDriverConfigSpec defines properties that can be configured for the GCP CSI driver.",
474 "kmsKey": "kmsKey sets the cluster default storage class to encrypt volumes with customer-supplied encryption keys, rather than the default keys managed by GCP.",
475 }
476
477 func (GCPCSIDriverConfigSpec) SwaggerDoc() map[string]string {
478 return map_GCPCSIDriverConfigSpec
479 }
480
481 var map_GCPKMSKeyReference = map[string]string{
482 "": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key",
483 "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.",
484 "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.",
485 "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.",
486 "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.",
487 }
488
489 func (GCPKMSKeyReference) SwaggerDoc() map[string]string {
490 return map_GCPKMSKeyReference
491 }
492
493 var map_VSphereCSIDriverConfigSpec = map[string]string{
494 "": "VSphereCSIDriverConfigSpec defines properties that can be configured for vsphere CSI driver.",
495 "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.",
496 }
497
498 func (VSphereCSIDriverConfigSpec) SwaggerDoc() map[string]string {
499 return map_VSphereCSIDriverConfigSpec
500 }
501
502 var map_CSISnapshotController = map[string]string{
503 "": "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).",
504 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
505 "spec": "spec holds user settable values for configuration",
506 "status": "status holds observed values from the cluster. They may not be overridden.",
507 }
508
509 func (CSISnapshotController) SwaggerDoc() map[string]string {
510 return map_CSISnapshotController
511 }
512
513 var map_CSISnapshotControllerList = map[string]string{
514 "": "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).",
515 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
516 }
517
518 func (CSISnapshotControllerList) SwaggerDoc() map[string]string {
519 return map_CSISnapshotControllerList
520 }
521
522 var map_CSISnapshotControllerSpec = map[string]string{
523 "": "CSISnapshotControllerSpec is the specification of the desired behavior of the CSISnapshotController operator.",
524 }
525
526 func (CSISnapshotControllerSpec) SwaggerDoc() map[string]string {
527 return map_CSISnapshotControllerSpec
528 }
529
530 var map_CSISnapshotControllerStatus = map[string]string{
531 "": "CSISnapshotControllerStatus defines the observed status of the CSISnapshotController operator.",
532 }
533
534 func (CSISnapshotControllerStatus) SwaggerDoc() map[string]string {
535 return map_CSISnapshotControllerStatus
536 }
537
538 var map_DNS = map[string]string{
539 "": "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).",
540 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
541 "spec": "spec is the specification of the desired behavior of the DNS.",
542 "status": "status is the most recently observed status of the DNS.",
543 }
544
545 func (DNS) SwaggerDoc() map[string]string {
546 return map_DNS
547 }
548
549 var map_DNSCache = map[string]string{
550 "": "DNSCache defines the fields for configuring DNS caching.",
551 "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.",
552 "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.",
553 }
554
555 func (DNSCache) SwaggerDoc() map[string]string {
556 return map_DNSCache
557 }
558
559 var map_DNSList = map[string]string{
560 "": "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).",
561 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
562 }
563
564 func (DNSList) SwaggerDoc() map[string]string {
565 return map_DNSList
566 }
567
568 var map_DNSNodePlacement = map[string]string{
569 "": "DNSNodePlacement describes the node scheduling configuration for DNS pods.",
570 "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.",
571 "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/",
572 }
573
574 func (DNSNodePlacement) SwaggerDoc() map[string]string {
575 return map_DNSNodePlacement
576 }
577
578 var map_DNSOverTLSConfig = map[string]string{
579 "": "DNSOverTLSConfig describes optional DNSTransportConfig fields that should be captured.",
580 "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).",
581 "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.",
582 }
583
584 func (DNSOverTLSConfig) SwaggerDoc() map[string]string {
585 return map_DNSOverTLSConfig
586 }
587
588 var map_DNSSpec = map[string]string{
589 "": "DNSSpec is the specification of the desired behavior of the DNS.",
590 "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.",
591 "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\"",
592 "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.",
593 "managementState": "managementState indicates whether the DNS operator should manage cluster DNS",
594 "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.",
595 "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\".",
596 "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.",
597 }
598
599 func (DNSSpec) SwaggerDoc() map[string]string {
600 return map_DNSSpec
601 }
602
603 var map_DNSStatus = map[string]string{
604 "": "DNSStatus defines the observed status of the DNS.",
605 "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",
606 "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",
607 "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.",
608 }
609
610 func (DNSStatus) SwaggerDoc() map[string]string {
611 return map_DNSStatus
612 }
613
614 var map_DNSTransportConfig = map[string]string{
615 "": "DNSTransportConfig groups related configuration parameters used for configuring forwarding to upstream resolvers that support DNS-over-TLS.",
616 "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.",
617 "tls": "tls contains the additional configuration options to use when Transport is set to \"TLS\".",
618 }
619
620 func (DNSTransportConfig) SwaggerDoc() map[string]string {
621 return map_DNSTransportConfig
622 }
623
624 var map_ForwardPlugin = map[string]string{
625 "": "ForwardPlugin defines a schema for configuring the CoreDNS forward plugin.",
626 "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.",
627 "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\"",
628 "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.",
629 }
630
631 func (ForwardPlugin) SwaggerDoc() map[string]string {
632 return map_ForwardPlugin
633 }
634
635 var map_Server = map[string]string{
636 "": "Server defines the schema for a server that runs per instance of CoreDNS.",
637 "name": "name is required and specifies a unique name for the server. Name must comply with the Service Name Syntax of rfc6335.",
638 "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.",
639 "forwardPlugin": "forwardPlugin defines a schema for configuring CoreDNS to proxy DNS messages to upstream resolvers.",
640 }
641
642 func (Server) SwaggerDoc() map[string]string {
643 return map_Server
644 }
645
646 var map_Upstream = map[string]string{
647 "": "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.",
648 "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",
649 "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.",
650 "port": "Port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535",
651 }
652
653 func (Upstream) SwaggerDoc() map[string]string {
654 return map_Upstream
655 }
656
657 var map_UpstreamResolvers = map[string]string{
658 "": "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",
659 "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",
660 "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\"",
661 "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.",
662 }
663
664 func (UpstreamResolvers) SwaggerDoc() map[string]string {
665 return map_UpstreamResolvers
666 }
667
668 var map_Etcd = map[string]string{
669 "": "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).",
670 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
671 }
672
673 func (Etcd) SwaggerDoc() map[string]string {
674 return map_Etcd
675 }
676
677 var map_EtcdList = map[string]string{
678 "": "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).",
679 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
680 "items": "Items contains the items",
681 }
682
683 func (EtcdList) SwaggerDoc() map[string]string {
684 return map_EtcdList
685 }
686
687 var map_AWSClassicLoadBalancerParameters = map[string]string{
688 "": "AWSClassicLoadBalancerParameters holds configuration parameters for an AWS Classic load balancer.",
689 "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.",
690 }
691
692 func (AWSClassicLoadBalancerParameters) SwaggerDoc() map[string]string {
693 return map_AWSClassicLoadBalancerParameters
694 }
695
696 var map_AWSLoadBalancerParameters = map[string]string{
697 "": "AWSLoadBalancerParameters provides configuration settings that are specific to AWS load balancers.",
698 "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",
699 "classicLoadBalancer": "classicLoadBalancerParameters holds configuration parameters for an AWS classic load balancer. Present only if type is Classic.",
700 "networkLoadBalancer": "networkLoadBalancerParameters holds configuration parameters for an AWS network load balancer. Present only if type is NLB.",
701 }
702
703 func (AWSLoadBalancerParameters) SwaggerDoc() map[string]string {
704 return map_AWSLoadBalancerParameters
705 }
706
707 var map_AWSNetworkLoadBalancerParameters = map[string]string{
708 "": "AWSNetworkLoadBalancerParameters holds configuration parameters for an AWS Network load balancer.",
709 }
710
711 func (AWSNetworkLoadBalancerParameters) SwaggerDoc() map[string]string {
712 return map_AWSNetworkLoadBalancerParameters
713 }
714
715 var map_AccessLogging = map[string]string{
716 "": "AccessLogging describes how client requests should be logged.",
717 "destination": "destination is where access logs go.",
718 "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.",
719 "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.",
720 "httpCaptureCookies": "httpCaptureCookies specifies HTTP cookies that should be captured in access logs. If this field is empty, no cookies are captured.",
721 "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\".",
722 }
723
724 func (AccessLogging) SwaggerDoc() map[string]string {
725 return map_AccessLogging
726 }
727
728 var map_ClientTLS = map[string]string{
729 "": "ClientTLS specifies TLS configuration to enable client-to-server authentication, which can be used for mutual TLS.",
730 "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.",
731 "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.",
732 "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.",
733 }
734
735 func (ClientTLS) SwaggerDoc() map[string]string {
736 return map_ClientTLS
737 }
738
739 var map_ContainerLoggingDestinationParameters = map[string]string{
740 "": "ContainerLoggingDestinationParameters describes parameters for the Container logging destination type.",
741 }
742
743 func (ContainerLoggingDestinationParameters) SwaggerDoc() map[string]string {
744 return map_ContainerLoggingDestinationParameters
745 }
746
747 var map_EndpointPublishingStrategy = map[string]string{
748 "": "EndpointPublishingStrategy is a way to publish the endpoints of an IngressController, and represents the type and any additional configuration for a specific type.",
749 "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.",
750 "loadBalancer": "loadBalancer holds parameters for the load balancer. Present only if type is LoadBalancerService.",
751 "hostNetwork": "hostNetwork holds parameters for the HostNetwork endpoint publishing strategy. Present only if type is HostNetwork.",
752 "private": "private holds parameters for the Private endpoint publishing strategy. Present only if type is Private.",
753 "nodePort": "nodePort holds parameters for the NodePortService endpoint publishing strategy. Present only if type is NodePortService.",
754 }
755
756 func (EndpointPublishingStrategy) SwaggerDoc() map[string]string {
757 return map_EndpointPublishingStrategy
758 }
759
760 var map_GCPLoadBalancerParameters = map[string]string{
761 "": "GCPLoadBalancerParameters provides configuration settings that are specific to GCP load balancers.",
762 "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",
763 }
764
765 func (GCPLoadBalancerParameters) SwaggerDoc() map[string]string {
766 return map_GCPLoadBalancerParameters
767 }
768
769 var map_HTTPCompressionPolicy = map[string]string{
770 "": "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.",
771 "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",
772 }
773
774 func (HTTPCompressionPolicy) SwaggerDoc() map[string]string {
775 return map_HTTPCompressionPolicy
776 }
777
778 var map_HostNetworkStrategy = map[string]string{
779 "": "HostNetworkStrategy holds parameters for the HostNetwork endpoint publishing strategy.",
780 "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.",
781 "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.",
782 "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.",
783 "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.",
784 }
785
786 func (HostNetworkStrategy) SwaggerDoc() map[string]string {
787 return map_HostNetworkStrategy
788 }
789
790 var map_IBMLoadBalancerParameters = map[string]string{
791 "": "IBMLoadBalancerParameters provides configuration settings that are specific to IBM Cloud load balancers.",
792 "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.",
793 }
794
795 func (IBMLoadBalancerParameters) SwaggerDoc() map[string]string {
796 return map_IBMLoadBalancerParameters
797 }
798
799 var map_IngressController = map[string]string{
800 "": "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).",
801 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
802 "spec": "spec is the specification of the desired behavior of the IngressController.",
803 "status": "status is the most recently observed status of the IngressController.",
804 }
805
806 func (IngressController) SwaggerDoc() map[string]string {
807 return map_IngressController
808 }
809
810 var map_IngressControllerCaptureHTTPCookie = map[string]string{
811 "": "IngressControllerCaptureHTTPCookie describes an HTTP cookie that should be captured.",
812 "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.",
813 }
814
815 func (IngressControllerCaptureHTTPCookie) SwaggerDoc() map[string]string {
816 return map_IngressControllerCaptureHTTPCookie
817 }
818
819 var map_IngressControllerCaptureHTTPCookieUnion = map[string]string{
820 "": "IngressControllerCaptureHTTPCookieUnion describes optional fields of an HTTP cookie that should be captured.",
821 "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.",
822 "name": "name specifies a cookie name. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
823 "namePrefix": "namePrefix specifies a cookie name prefix. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
824 }
825
826 func (IngressControllerCaptureHTTPCookieUnion) SwaggerDoc() map[string]string {
827 return map_IngressControllerCaptureHTTPCookieUnion
828 }
829
830 var map_IngressControllerCaptureHTTPHeader = map[string]string{
831 "": "IngressControllerCaptureHTTPHeader describes an HTTP header that should be captured.",
832 "name": "name specifies a header name. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2.",
833 "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.",
834 }
835
836 func (IngressControllerCaptureHTTPHeader) SwaggerDoc() map[string]string {
837 return map_IngressControllerCaptureHTTPHeader
838 }
839
840 var map_IngressControllerCaptureHTTPHeaders = map[string]string{
841 "": "IngressControllerCaptureHTTPHeaders specifies which HTTP headers the IngressController captures.",
842 "request": "request specifies which HTTP request headers to capture.\n\nIf this field is empty, no request headers are captured.",
843 "response": "response specifies which HTTP response headers to capture.\n\nIf this field is empty, no response headers are captured.",
844 }
845
846 func (IngressControllerCaptureHTTPHeaders) SwaggerDoc() map[string]string {
847 return map_IngressControllerCaptureHTTPHeaders
848 }
849
850 var map_IngressControllerHTTPHeaders = map[string]string{
851 "": "IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.",
852 "forwardedHeaderPolicy": "forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers. The value may be one of the following:\n\n* \"Append\", which specifies that the IngressController appends the\n headers, preserving existing headers.\n\n* \"Replace\", which specifies that the IngressController sets the\n headers, replacing any existing Forwarded or X-Forwarded-* headers.\n\n* \"IfNone\", which specifies that the IngressController sets the\n headers if they are not already set.\n\n* \"Never\", which specifies that the IngressController never sets the\n headers, preserving any existing headers.\n\nBy default, the policy is \"Append\".",
853 "uniqueId": "uniqueId describes configuration for a custom HTTP header that the ingress controller should inject into incoming HTTP requests. Typically, this header is configured to have a value that is unique to the HTTP request. The header can be used by applications or included in access logs to facilitate tracing individual HTTP requests.\n\nIf this field is empty, no such header is injected into requests.",
854 "headerNameCaseAdjustments": "headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names. Each adjustment is specified as an HTTP header name with the desired capitalization. For example, specifying \"X-Forwarded-For\" indicates that the \"x-forwarded-for\" HTTP header should be adjusted to have the specified capitalization.\n\nThese adjustments are only applied to cleartext, edge-terminated, and re-encrypt routes, and only when using HTTP/1.\n\nFor request headers, these adjustments are applied only for routes that have the haproxy.router.openshift.io/h1-adjust-case=true annotation. For response headers, these adjustments are applied to all HTTP responses.\n\nIf this field is empty, no request headers are adjusted.",
855 }
856
857 func (IngressControllerHTTPHeaders) SwaggerDoc() map[string]string {
858 return map_IngressControllerHTTPHeaders
859 }
860
861 var map_IngressControllerHTTPUniqueIdHeaderPolicy = map[string]string{
862 "": "IngressControllerHTTPUniqueIdHeaderPolicy describes configuration for a unique id header.",
863 "name": "name specifies the name of the HTTP header (for example, \"unique-id\") that the ingress controller should inject into HTTP requests. The field's value must be a valid HTTP header name as defined in RFC 2616 section 4.2. If the field is empty, no header is injected.",
864 "format": "format specifies the format for the injected HTTP header's value. This field has no effect unless name is specified. For the HAProxy-based ingress controller implementation, this format uses the same syntax as the HTTP log format. If the field is empty, the default value is \"%{+X}o\\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid\"; see the corresponding HAProxy documentation: http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3",
865 }
866
867 func (IngressControllerHTTPUniqueIdHeaderPolicy) SwaggerDoc() map[string]string {
868 return map_IngressControllerHTTPUniqueIdHeaderPolicy
869 }
870
871 var map_IngressControllerList = map[string]string{
872 "": "IngressControllerList contains a list of IngressControllers.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
873 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
874 }
875
876 func (IngressControllerList) SwaggerDoc() map[string]string {
877 return map_IngressControllerList
878 }
879
880 var map_IngressControllerLogging = map[string]string{
881 "": "IngressControllerLogging describes what should be logged where.",
882 "access": "access describes how the client requests should be logged.\n\nIf this field is empty, access logging is disabled.",
883 }
884
885 func (IngressControllerLogging) SwaggerDoc() map[string]string {
886 return map_IngressControllerLogging
887 }
888
889 var map_IngressControllerSpec = map[string]string{
890 "": "IngressControllerSpec is the specification of the desired behavior of the IngressController.",
891 "domain": "domain is a DNS name serviced by the ingress controller and is used to configure multiple features:\n\n* For the LoadBalancerService endpoint publishing strategy, domain is\n used to configure DNS records. See endpointPublishingStrategy.\n\n* When using a generated default certificate, the certificate will be valid\n for domain and its subdomains. See defaultCertificate.\n\n* The value is published to individual Route statuses so that end-users\n know where to target external DNS records.\n\ndomain must be unique among all IngressControllers, and cannot be updated.\n\nIf empty, defaults to ingress.config.openshift.io/cluster .spec.domain.",
892 "httpErrorCodePages": "httpErrorCodePages specifies a configmap with custom error pages. The administrator must create this configmap in the openshift-config namespace. This configmap should have keys in the format \"error-page-<error code>.http\", where <error code> is an HTTP error code. For example, \"error-page-503.http\" defines an error page for HTTP 503 responses. Currently only error pages for 503 and 404 responses can be customized. Each value in the configmap should be the full response, including HTTP headers. Eg- https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http If this field is empty, the ingress controller uses the default error pages.",
893 "replicas": "replicas is the desired number of ingress controller replicas. If unset, the default depends on the value of the defaultPlacement field in the cluster config.openshift.io/v1/ingresses status.\n\nThe value of replicas is set based on the value of a chosen field in the Infrastructure CR. If defaultPlacement is set to ControlPlane, the chosen field will be controlPlaneTopology. If it is set to Workers the chosen field will be infrastructureTopology. Replicas will then be set to 1 or 2 based whether the chosen field's value is SingleReplica or HighlyAvailable, respectively.\n\nThese defaults are subject to change.",
894 "endpointPublishingStrategy": "endpointPublishingStrategy is used to publish the ingress controller endpoints to other networks, enable load balancer integrations, etc.\n\nIf unset, the default is based on infrastructure.config.openshift.io/cluster .status.platform:\n\n AWS: LoadBalancerService (with External scope)\n Azure: LoadBalancerService (with External scope)\n GCP: LoadBalancerService (with External scope)\n IBMCloud: LoadBalancerService (with External scope)\n AlibabaCloud: LoadBalancerService (with External scope)\n Libvirt: HostNetwork\n\nAny other platform types (including None) default to HostNetwork.\n\nendpointPublishingStrategy cannot be updated.",
895 "defaultCertificate": "defaultCertificate is a reference to a secret containing the default certificate served by the ingress controller. When Routes don't specify their own certificate, defaultCertificate is used.\n\nThe secret must contain the following keys and data:\n\n tls.crt: certificate file contents\n tls.key: key file contents\n\nIf unset, a wildcard certificate is automatically generated and used. The certificate is valid for the ingress controller domain (and subdomains) and the generated certificate's CA will be automatically integrated with the cluster's trust store.\n\nIf a wildcard certificate is used and shared by multiple HTTP/2 enabled routes (which implies ALPN) then clients (i.e., notably browsers) are at liberty to reuse open connections. This means a client can reuse a connection to another route and that is likely to fail. This behaviour is generally known as connection coalescing.\n\nThe in-use certificate (whether generated or user-specified) will be automatically integrated with OpenShift's built-in OAuth server.",
896 "namespaceSelector": "namespaceSelector is used to filter the set of namespaces serviced by the ingress controller. This is useful for implementing shards.\n\nIf unset, the default is no filtering.",
897 "routeSelector": "routeSelector is used to filter the set of Routes serviced by the ingress controller. This is useful for implementing shards.\n\nIf unset, the default is no filtering.",
898 "nodePlacement": "nodePlacement enables explicit control over the scheduling of the ingress controller.\n\nIf unset, defaults are used. See NodePlacement for more details.",
899 "tlsSecurityProfile": "tlsSecurityProfile specifies settings for TLS connections for ingresscontrollers.\n\nIf unset, the default is based on the apiservers.config.openshift.io/cluster resource.\n\nNote that when using the Old, Intermediate, and Modern profile types, the effective profile configuration is subject to change between releases. For example, given a specification to use the Intermediate profile deployed on release X.Y.Z, an upgrade to release X.Y.Z+1 may cause a new profile configuration to be applied to the ingress controller, resulting in a rollout.",
900 "clientTLS": "clientTLS specifies settings for requesting and verifying client certificates, which can be used to enable mutual TLS for edge-terminated and reencrypt routes.",
901 "routeAdmission": "routeAdmission defines a policy for handling new route claims (for example, to allow or deny claims across namespaces).\n\nIf empty, defaults will be applied. See specific routeAdmission fields for details about their defaults.",
902 "logging": "logging defines parameters for what should be logged where. If this field is empty, operational logs are enabled but access logs are disabled.",
903 "httpHeaders": "httpHeaders defines policy for HTTP headers.\n\nIf this field is empty, the default values are used.",
904 "httpEmptyRequestsPolicy": "httpEmptyRequestsPolicy describes how HTTP connections should be handled if the connection times out before a request is received. Allowed values for this field are \"Respond\" and \"Ignore\". If the field is set to \"Respond\", the ingress controller sends an HTTP 400 or 408 response, logs the connection (if access logging is enabled), and counts the connection in the appropriate metrics. If the field is set to \"Ignore\", the ingress controller closes the connection without sending a response, logging the connection, or incrementing metrics. The default value is \"Respond\".\n\nTypically, these connections come from load balancers' health probes or Web browsers' speculative connections (\"preconnect\") and can be safely ignored. However, these requests may also be caused by network errors, and so setting this field to \"Ignore\" may impede detection and diagnosis of problems. In addition, these requests may be caused by port scans, in which case logging empty requests may aid in detecting intrusion attempts.",
905 "tuningOptions": "tuningOptions defines parameters for adjusting the performance of ingress controller pods. All fields are optional and will use their respective defaults if not set. See specific tuningOptions fields for more details.\n\nSetting fields within tuningOptions is generally not recommended. The default values are suitable for most configurations.",
906 "unsupportedConfigOverrides": "unsupportedConfigOverrides allows specifying unsupported configuration options. Its use is unsupported.",
907 "httpCompression": "httpCompression defines a policy for HTTP traffic compression. By default, there is no HTTP compression.",
908 }
909
910 func (IngressControllerSpec) SwaggerDoc() map[string]string {
911 return map_IngressControllerSpec
912 }
913
914 var map_IngressControllerStatus = map[string]string{
915 "": "IngressControllerStatus defines the observed status of the IngressController.",
916 "availableReplicas": "availableReplicas is number of observed available replicas according to the ingress controller deployment.",
917 "selector": "selector is a label selector, in string format, for ingress controller pods corresponding to the IngressController. The number of matching pods should equal the value of availableReplicas.",
918 "domain": "domain is the actual domain in use.",
919 "endpointPublishingStrategy": "endpointPublishingStrategy is the actual strategy in use.",
920 "conditions": "conditions is a list of conditions and their status.\n\nAvailable means the ingress controller deployment is available and servicing route and ingress resources (i.e, .status.availableReplicas equals .spec.replicas)\n\nThere are additional conditions which indicate the status of other ingress controller features and capabilities.\n\n * LoadBalancerManaged\n - True if the following conditions are met:\n * The endpoint publishing strategy requires a service load balancer.\n - False if any of those conditions are unsatisfied.\n\n * LoadBalancerReady\n - True if the following conditions are met:\n * A load balancer is managed.\n * The load balancer is ready.\n - False if any of those conditions are unsatisfied.\n\n * DNSManaged\n - True if the following conditions are met:\n * The endpoint publishing strategy and platform support DNS.\n * The ingress controller domain is set.\n * dns.config.openshift.io/cluster configures DNS zones.\n - False if any of those conditions are unsatisfied.\n\n * DNSReady\n - True if the following conditions are met:\n * DNS is managed.\n * DNS records have been successfully created.\n - False if any of those conditions are unsatisfied.",
921 "tlsProfile": "tlsProfile is the TLS connection configuration that is in effect.",
922 "observedGeneration": "observedGeneration is the most recent generation observed.",
923 "namespaceSelector": "namespaceSelector is the actual namespaceSelector in use.",
924 "routeSelector": "routeSelector is the actual routeSelector in use.",
925 }
926
927 func (IngressControllerStatus) SwaggerDoc() map[string]string {
928 return map_IngressControllerStatus
929 }
930
931 var map_IngressControllerTuningOptions = map[string]string{
932 "": "IngressControllerTuningOptions specifies options for tuning the performance of ingress controller pods",
933 "headerBufferBytes": "headerBufferBytes describes how much memory should be reserved (in bytes) for IngressController connection sessions. Note that this value must be at least 16384 if HTTP/2 is enabled for the IngressController (https://tools.ietf.org/html/rfc7540). If this field is empty, the IngressController will use a default value of 32768 bytes.\n\nSetting this field is generally not recommended as headerBufferBytes values that are too small may break the IngressController and headerBufferBytes values that are too large could cause the IngressController to use significantly more memory than necessary.",
934 "headerBufferMaxRewriteBytes": "headerBufferMaxRewriteBytes describes how much memory should be reserved (in bytes) from headerBufferBytes for HTTP header rewriting and appending for IngressController connection sessions. Note that incoming HTTP requests will be limited to (headerBufferBytes - headerBufferMaxRewriteBytes) bytes, meaning headerBufferBytes must be greater than headerBufferMaxRewriteBytes. If this field is empty, the IngressController will use a default value of 8192 bytes.\n\nSetting this field is generally not recommended as headerBufferMaxRewriteBytes values that are too small may break the IngressController and headerBufferMaxRewriteBytes values that are too large could cause the IngressController to use significantly more memory than necessary.",
935 "threadCount": "threadCount defines the number of threads created per HAProxy process. Creating more threads allows each ingress controller pod to handle more connections, at the cost of more system resources being used. HAProxy currently supports up to 64 threads. If this field is empty, the IngressController will use the default value. The current default is 4 threads, but this may change in future releases.\n\nSetting this field is generally not recommended. Increasing the number of HAProxy threads allows ingress controller pods to utilize more CPU time under load, potentially starving other pods if set too high. Reducing the number of threads may cause the ingress controller to perform poorly.",
936 "clientTimeout": "clientTimeout defines how long a connection will be held open while waiting for a client response.\n\nIf unset, the default timeout is 30s",
937 "clientFinTimeout": "clientFinTimeout defines how long a connection will be held open while waiting for the client response to the server/backend closing the connection.\n\nIf unset, the default timeout is 1s",
938 "serverTimeout": "serverTimeout defines how long a connection will be held open while waiting for a server/backend response.\n\nIf unset, the default timeout is 30s",
939 "serverFinTimeout": "serverFinTimeout defines how long a connection will be held open while waiting for the server/backend response to the client closing the connection.\n\nIf unset, the default timeout is 1s",
940 "tunnelTimeout": "tunnelTimeout defines how long a tunnel connection (including websockets) will be held open while the tunnel is idle.\n\nIf unset, the default timeout is 1h",
941 "tlsInspectDelay": "tlsInspectDelay defines how long the router can hold data to find a matching route.\n\nSetting this too short can cause the router to fall back to the default certificate for edge-terminated or reencrypt routes even when a better matching certificate could be used.\n\nIf unset, the default inspect delay is 5s",
942 "healthCheckInterval": "healthCheckInterval defines how long the router waits between two consecutive health checks on its configured backends. This value is applied globally as a default for all routes, but may be overridden per-route by the route annotation \"router.openshift.io/haproxy.health.check.interval\".\n\nExpects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\" U+00B5 or \"μs\" U+03BC), \"ms\", \"s\", \"m\", \"h\".\n\nSetting this to less than 5s can cause excess traffic due to too frequent TCP health checks and accompanying SYN packet storms. Alternatively, setting this too high can result in increased latency, due to backend servers that are no longer available, but haven't yet been detected as such.\n\nAn empty or zero healthCheckInterval means no opinion and IngressController chooses a default, which is subject to change over time. Currently the default healthCheckInterval value is 5s.\n\nCurrently the minimum allowed value is 1s and the maximum allowed value is 2147483647ms (24.85 days). Both are subject to change over time.",
943 "maxConnections": "maxConnections defines the maximum number of simultaneous connections that can be established per HAProxy process. Increasing this value allows each ingress controller pod to handle more connections but at the cost of additional system resources being consumed.\n\nPermitted values are: empty, 0, -1, and the range 2000-2000000.\n\nIf this field is empty or 0, the IngressController will use the default value of 50000, but the default is subject to change in future releases.\n\nIf the value is -1 then HAProxy will dynamically compute a maximum value based on the available ulimits in the running container. Selecting -1 (i.e., auto) will result in a large value being computed (~520000 on OpenShift >=4.10 clusters) and therefore each HAProxy process will incur significant memory usage compared to the current default of 50000.\n\nSetting a value that is greater than the current operating system limit will prevent the HAProxy process from starting.\n\nIf you choose a discrete value (e.g., 750000) and the router pod is migrated to a new node, there's no guarantee that that new node has identical ulimits configured. In such a scenario the pod would fail to start. If you have nodes with different ulimits configured (e.g., different tuned profiles) and you choose a discrete value then the guidance is to use -1 and let the value be computed dynamically at runtime.\n\nYou can monitor memory usage for router containers with the following metric: 'container_memory_working_set_bytes{container=\"router\",namespace=\"openshift-ingress\"}'.\n\nYou can monitor memory usage of individual HAProxy processes in router containers with the following metric: 'container_memory_working_set_bytes{container=\"router\",namespace=\"openshift-ingress\"}/container_processes{container=\"router\",namespace=\"openshift-ingress\"}'.",
944 "reloadInterval": "reloadInterval defines the minimum interval at which the router is allowed to reload to accept new changes. Increasing this value can prevent the accumulation of HAProxy processes, depending on the scenario. Increasing this interval can also lessen load imbalance on a backend's servers when using the roundrobin balancing algorithm. Alternatively, decreasing this value may decrease latency since updates to HAProxy's configuration can take effect more quickly.\n\nThe value must be a time duration value; see <https://pkg.go.dev/time#ParseDuration>. Currently, the minimum value allowed is 1s, and the maximum allowed value is 120s. Minimum and maximum allowed values may change in future versions of OpenShift. Note that if a duration outside of these bounds is provided, the value of reloadInterval will be capped/floored and not rejected (e.g. a duration of over 120s will be capped to 120s; the IngressController will not reject and replace this disallowed value with the default).\n\nA zero value for reloadInterval tells the IngressController to choose the default, which is currently 5s and subject to change without notice.\n\nThis field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\" U+00B5 or \"μs\" U+03BC), \"ms\", \"s\", \"m\", \"h\".\n\nNote: Setting a value significantly larger than the default of 5s can cause latency in observing updates to routes and their endpoints. HAProxy's configuration will be reloaded less frequently, and newly created routes will not be served until the subsequent reload.",
945 }
946
947 func (IngressControllerTuningOptions) SwaggerDoc() map[string]string {
948 return map_IngressControllerTuningOptions
949 }
950
951 var map_LoadBalancerStrategy = map[string]string{
952 "": "LoadBalancerStrategy holds parameters for a load balancer.",
953 "scope": "scope indicates the scope at which the load balancer is exposed. Possible values are \"External\" and \"Internal\".",
954 "allowedSourceRanges": "allowedSourceRanges specifies an allowlist of IP address ranges to which access to the load balancer should be restricted. Each range must be specified using CIDR notation (e.g. \"10.0.0.0/8\" or \"fd00::/8\"). If no range is specified, \"0.0.0.0/0\" for IPv4 and \"::/0\" for IPv6 are used by default, which allows all source addresses.\n\nTo facilitate migration from earlier versions of OpenShift that did not have the allowedSourceRanges field, you may set the service.beta.kubernetes.io/load-balancer-source-ranges annotation on the \"router-<ingresscontroller name>\" service in the \"openshift-ingress\" namespace, and this annotation will take effect if allowedSourceRanges is empty on OpenShift 4.12.",
955 "providerParameters": "providerParameters holds desired load balancer information specific to the underlying infrastructure provider.\n\nIf empty, defaults will be applied. See specific providerParameters fields for details about their defaults.",
956 "dnsManagementPolicy": "dnsManagementPolicy indicates if the lifecycle of the wildcard DNS record associated with the load balancer service will be managed by the ingress operator. It defaults to Managed. Valid values are: Managed and Unmanaged.",
957 }
958
959 func (LoadBalancerStrategy) SwaggerDoc() map[string]string {
960 return map_LoadBalancerStrategy
961 }
962
963 var map_LoggingDestination = map[string]string{
964 "": "LoggingDestination describes a destination for log messages.",
965 "type": "type is the type of destination for logs. It must be one of the following:\n\n* Container\n\nThe ingress operator configures the sidecar container named \"logs\" on the ingress controller pod and configures the ingress controller to write logs to the sidecar. The logs are then available as container logs. The expectation is that the administrator configures a custom logging solution that reads logs from this sidecar. Note that using container logs means that logs may be dropped if the rate of logs exceeds the container runtime's or the custom logging solution's capacity.\n\n* Syslog\n\nLogs are sent to a syslog endpoint. The administrator must specify an endpoint that can receive syslog messages. The expectation is that the administrator has configured a custom syslog instance.",
966 "syslog": "syslog holds parameters for a syslog endpoint. Present only if type is Syslog.",
967 "container": "container holds parameters for the Container logging destination. Present only if type is Container.",
968 }
969
970 func (LoggingDestination) SwaggerDoc() map[string]string {
971 return map_LoggingDestination
972 }
973
974 var map_NodePlacement = map[string]string{
975 "": "NodePlacement describes node scheduling configuration for an ingress controller.",
976 "nodeSelector": "nodeSelector is the node selector applied to ingress controller deployments.\n\nIf set, the specified selector is used and replaces the default.\n\nIf unset, the default depends on the value of the defaultPlacement field in the cluster config.openshift.io/v1/ingresses status.\n\nWhen defaultPlacement is Workers, the default is:\n\n kubernetes.io/os: linux\n node-role.kubernetes.io/worker: ''\n\nWhen defaultPlacement is ControlPlane, the default is:\n\n kubernetes.io/os: linux\n node-role.kubernetes.io/master: ''\n\nThese defaults are subject to change.\n\nNote that using nodeSelector.matchExpressions is not supported. Only nodeSelector.matchLabels may be used. This is a limitation of the Kubernetes API: the pod spec does not allow complex expressions for node selectors.",
977 "tolerations": "tolerations is a list of tolerations applied to ingress controller deployments.\n\nThe default is an empty list.\n\nSee https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
978 }
979
980 func (NodePlacement) SwaggerDoc() map[string]string {
981 return map_NodePlacement
982 }
983
984 var map_NodePortStrategy = map[string]string{
985 "": "NodePortStrategy holds parameters for the NodePortService endpoint publishing strategy.",
986 "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.",
987 }
988
989 func (NodePortStrategy) SwaggerDoc() map[string]string {
990 return map_NodePortStrategy
991 }
992
993 var map_PrivateStrategy = map[string]string{
994 "": "PrivateStrategy holds parameters for the Private endpoint publishing strategy.",
995 "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.",
996 }
997
998 func (PrivateStrategy) SwaggerDoc() map[string]string {
999 return map_PrivateStrategy
1000 }
1001
1002 var map_ProviderLoadBalancerParameters = map[string]string{
1003 "": "ProviderLoadBalancerParameters holds desired load balancer information specific to the underlying infrastructure provider.",
1004 "type": "type is the underlying infrastructure provider for the load balancer. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"IBM\", \"Nutanix\", \"OpenStack\", and \"VSphere\".",
1005 "aws": "aws provides configuration settings that are specific to AWS load balancers.\n\nIf empty, defaults will be applied. See specific aws fields for details about their defaults.",
1006 "gcp": "gcp provides configuration settings that are specific to GCP load balancers.\n\nIf empty, defaults will be applied. See specific gcp fields for details about their defaults.",
1007 "ibm": "ibm provides configuration settings that are specific to IBM Cloud load balancers.\n\nIf empty, defaults will be applied. See specific ibm fields for details about their defaults.",
1008 }
1009
1010 func (ProviderLoadBalancerParameters) SwaggerDoc() map[string]string {
1011 return map_ProviderLoadBalancerParameters
1012 }
1013
1014 var map_RouteAdmissionPolicy = map[string]string{
1015 "": "RouteAdmissionPolicy is an admission policy for allowing new route claims.",
1016 "namespaceOwnership": "namespaceOwnership describes how host name claims across namespaces should be handled.\n\nValue must be one of:\n\n- Strict: Do not allow routes in different namespaces to claim the same host.\n\n- InterNamespaceAllowed: Allow routes to claim different paths of the same\n host name across namespaces.\n\nIf empty, the default is Strict.",
1017 "wildcardPolicy": "wildcardPolicy describes how routes with wildcard policies should be handled for the ingress controller. WildcardPolicy controls use of routes [1] exposed by the ingress controller based on the route's wildcard policy.\n\n[1] https://github.com/openshift/api/blob/master/route/v1/types.go\n\nNote: Updating WildcardPolicy from WildcardsAllowed to WildcardsDisallowed will cause admitted routes with a wildcard policy of Subdomain to stop working. These routes must be updated to a wildcard policy of None to be readmitted by the ingress controller.\n\nWildcardPolicy supports WildcardsAllowed and WildcardsDisallowed values.\n\nIf empty, defaults to \"WildcardsDisallowed\".",
1018 }
1019
1020 func (RouteAdmissionPolicy) SwaggerDoc() map[string]string {
1021 return map_RouteAdmissionPolicy
1022 }
1023
1024 var map_SyslogLoggingDestinationParameters = map[string]string{
1025 "": "SyslogLoggingDestinationParameters describes parameters for the Syslog logging destination type.",
1026 "address": "address is the IP address of the syslog endpoint that receives log messages.",
1027 "port": "port is the UDP port number of the syslog endpoint that receives log messages.",
1028 "facility": "facility specifies the syslog facility of log messages.\n\nIf this field is empty, the facility is \"local1\".",
1029 "maxLength": "maxLength is the maximum length of the syslog message\n\nIf this field is empty, the maxLength is set to \"1024\".",
1030 }
1031
1032 func (SyslogLoggingDestinationParameters) SwaggerDoc() map[string]string {
1033 return map_SyslogLoggingDestinationParameters
1034 }
1035
1036 var map_GatherStatus = map[string]string{
1037 "": "gatherStatus provides information about the last known gather event.",
1038 "lastGatherTime": "lastGatherTime is the last time when Insights data gathering finished. An empty value means that no data has been gathered yet.",
1039 "lastGatherDuration": "lastGatherDuration is the total time taken to process all gatherers during the last gather event.",
1040 "gatherers": "gatherers is a list of active gatherers (and their statuses) in the last gathering.",
1041 }
1042
1043 func (GatherStatus) SwaggerDoc() map[string]string {
1044 return map_GatherStatus
1045 }
1046
1047 var map_GathererStatus = map[string]string{
1048 "": "gathererStatus represents information about a particular data gatherer.",
1049 "conditions": "conditions provide details on the status of each gatherer.",
1050 "name": "name is the name of the gatherer.",
1051 "lastGatherDuration": "lastGatherDuration represents the time spent gathering.",
1052 }
1053
1054 func (GathererStatus) SwaggerDoc() map[string]string {
1055 return map_GathererStatus
1056 }
1057
1058 var map_HealthCheck = map[string]string{
1059 "": "healthCheck represents an Insights health check attributes.",
1060 "description": "description provides basic description of the healtcheck.",
1061 "totalRisk": "totalRisk of the healthcheck. Indicator of the total risk posed by the detected issue; combination of impact and likelihood. The values can be from 1 to 4, and the higher the number, the more important the issue.",
1062 "advisorURI": "advisorURI provides the URL link to the Insights Advisor.",
1063 "state": "state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.",
1064 }
1065
1066 func (HealthCheck) SwaggerDoc() map[string]string {
1067 return map_HealthCheck
1068 }
1069
1070 var map_InsightsOperator = map[string]string{
1071 "": "\n\nInsightsOperator holds cluster-wide information about the Insights Operator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1072 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1073 "spec": "spec is the specification of the desired behavior of the Insights.",
1074 "status": "status is the most recently observed status of the Insights operator.",
1075 }
1076
1077 func (InsightsOperator) SwaggerDoc() map[string]string {
1078 return map_InsightsOperator
1079 }
1080
1081 var map_InsightsOperatorList = map[string]string{
1082 "": "InsightsOperatorList 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).",
1083 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1084 }
1085
1086 func (InsightsOperatorList) SwaggerDoc() map[string]string {
1087 return map_InsightsOperatorList
1088 }
1089
1090 var map_InsightsOperatorStatus = map[string]string{
1091 "gatherStatus": "gatherStatus provides basic information about the last Insights data gathering. When omitted, this means no data gathering has taken place yet.",
1092 "insightsReport": "insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet.",
1093 }
1094
1095 func (InsightsOperatorStatus) SwaggerDoc() map[string]string {
1096 return map_InsightsOperatorStatus
1097 }
1098
1099 var map_InsightsReport = map[string]string{
1100 "": "insightsReport provides Insights health check report based on the most recently sent Insights data.",
1101 "downloadedAt": "downloadedAt is the time when the last Insights report was downloaded. An empty value means that there has not been any Insights report downloaded yet and it usually appears in disconnected clusters (or clusters when the Insights data gathering is disabled).",
1102 "healthChecks": "healthChecks provides basic information about active Insights health checks in a cluster.",
1103 }
1104
1105 func (InsightsReport) SwaggerDoc() map[string]string {
1106 return map_InsightsReport
1107 }
1108
1109 var map_KubeAPIServer = map[string]string{
1110 "": "KubeAPIServer provides information to configure an operator to manage kube-apiserver.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1111 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1112 "spec": "spec is the specification of the desired behavior of the Kubernetes API Server",
1113 "status": "status is the most recently observed status of the Kubernetes API Server",
1114 }
1115
1116 func (KubeAPIServer) SwaggerDoc() map[string]string {
1117 return map_KubeAPIServer
1118 }
1119
1120 var map_KubeAPIServerList = map[string]string{
1121 "": "KubeAPIServerList 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).",
1122 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1123 "items": "Items contains the items",
1124 }
1125
1126 func (KubeAPIServerList) SwaggerDoc() map[string]string {
1127 return map_KubeAPIServerList
1128 }
1129
1130 var map_KubeAPIServerStatus = map[string]string{
1131 "serviceAccountIssuers": "serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection",
1132 }
1133
1134 func (KubeAPIServerStatus) SwaggerDoc() map[string]string {
1135 return map_KubeAPIServerStatus
1136 }
1137
1138 var map_ServiceAccountIssuerStatus = map[string]string{
1139 "name": "name is the name of the service account issuer",
1140 "expirationTime": "expirationTime is the time after which this service account issuer will be pruned and removed from the trusted list of service account issuers.",
1141 }
1142
1143 func (ServiceAccountIssuerStatus) SwaggerDoc() map[string]string {
1144 return map_ServiceAccountIssuerStatus
1145 }
1146
1147 var map_KubeControllerManager = map[string]string{
1148 "": "KubeControllerManager provides information to configure an operator to manage kube-controller-manager.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1149 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1150 "spec": "spec is the specification of the desired behavior of the Kubernetes Controller Manager",
1151 "status": "status is the most recently observed status of the Kubernetes Controller Manager",
1152 }
1153
1154 func (KubeControllerManager) SwaggerDoc() map[string]string {
1155 return map_KubeControllerManager
1156 }
1157
1158 var map_KubeControllerManagerList = map[string]string{
1159 "": "KubeControllerManagerList 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).",
1160 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1161 "items": "Items contains the items",
1162 }
1163
1164 func (KubeControllerManagerList) SwaggerDoc() map[string]string {
1165 return map_KubeControllerManagerList
1166 }
1167
1168 var map_KubeControllerManagerSpec = map[string]string{
1169 "useMoreSecureServiceCA": "useMoreSecureServiceCA indicates that the service-ca.crt provided in SA token volumes should include only enough certificates to validate service serving certificates. Once set to true, it cannot be set to false. Even if someone finds a way to set it back to false, the service-ca.crt files that previously existed will only have the more secure content.",
1170 }
1171
1172 func (KubeControllerManagerSpec) SwaggerDoc() map[string]string {
1173 return map_KubeControllerManagerSpec
1174 }
1175
1176 var map_KubeStorageVersionMigrator = map[string]string{
1177 "": "KubeStorageVersionMigrator provides information to configure an operator to manage kube-storage-version-migrator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1178 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1179 }
1180
1181 func (KubeStorageVersionMigrator) SwaggerDoc() map[string]string {
1182 return map_KubeStorageVersionMigrator
1183 }
1184
1185 var map_KubeStorageVersionMigratorList = map[string]string{
1186 "": "KubeStorageVersionMigratorList 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).",
1187 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1188 "items": "Items contains the items",
1189 }
1190
1191 func (KubeStorageVersionMigratorList) SwaggerDoc() map[string]string {
1192 return map_KubeStorageVersionMigratorList
1193 }
1194
1195 var map_AdditionalNetworkDefinition = map[string]string{
1196 "": "AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one \"Config\" that matches the type.",
1197 "type": "type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan",
1198 "name": "name is the name of the network. This will be populated in the resulting CRD This must be unique.",
1199 "namespace": "namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.",
1200 "rawCNIConfig": "rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD",
1201 "simpleMacvlanConfig": "SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan",
1202 }
1203
1204 func (AdditionalNetworkDefinition) SwaggerDoc() map[string]string {
1205 return map_AdditionalNetworkDefinition
1206 }
1207
1208 var map_ClusterNetworkEntry = map[string]string{
1209 "": "ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks",
1210 }
1211
1212 func (ClusterNetworkEntry) SwaggerDoc() map[string]string {
1213 return map_ClusterNetworkEntry
1214 }
1215
1216 var map_DefaultNetworkDefinition = map[string]string{
1217 "": "DefaultNetworkDefinition represents a single network plugin's configuration. type must be specified, along with exactly one \"Config\" that matches the type.",
1218 "type": "type is the type of network All NetworkTypes are supported except for NetworkTypeRaw",
1219 "openshiftSDNConfig": "openShiftSDNConfig configures the openshift-sdn plugin",
1220 "ovnKubernetesConfig": "ovnKubernetesConfig configures the ovn-kubernetes plugin.",
1221 "kuryrConfig": "KuryrConfig configures the kuryr plugin",
1222 }
1223
1224 func (DefaultNetworkDefinition) SwaggerDoc() map[string]string {
1225 return map_DefaultNetworkDefinition
1226 }
1227
1228 var map_EgressIPConfig = map[string]string{
1229 "": "EgressIPConfig defines the configuration knobs for egressip",
1230 "reachabilityTotalTimeoutSeconds": "reachabilityTotalTimeout configures the EgressIP node reachability check total timeout in seconds. If the EgressIP node cannot be reached within this timeout, the node is declared down. Setting a large value may cause the EgressIP feature to react slowly to node changes. In particular, it may react slowly for EgressIP nodes that really have a genuine problem and are unreachable. When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 1 second. A value of 0 disables the EgressIP node's reachability check.",
1231 }
1232
1233 func (EgressIPConfig) SwaggerDoc() map[string]string {
1234 return map_EgressIPConfig
1235 }
1236
1237 var map_ExportNetworkFlows = map[string]string{
1238 "netFlow": "netFlow defines the NetFlow configuration.",
1239 "sFlow": "sFlow defines the SFlow configuration.",
1240 "ipfix": "ipfix defines IPFIX configuration.",
1241 }
1242
1243 func (ExportNetworkFlows) SwaggerDoc() map[string]string {
1244 return map_ExportNetworkFlows
1245 }
1246
1247 var map_FeaturesMigration = map[string]string{
1248 "egressIP": "egressIP specifies whether or not the Egress IP configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and Egress IP configure is migrated.",
1249 "egressFirewall": "egressFirewall specifies whether or not the Egress Firewall configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and Egress Firewall configure is migrated.",
1250 "multicast": "multicast specifies whether or not the multicast configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and multicast configure is migrated.",
1251 }
1252
1253 func (FeaturesMigration) SwaggerDoc() map[string]string {
1254 return map_FeaturesMigration
1255 }
1256
1257 var map_GatewayConfig = map[string]string{
1258 "": "GatewayConfig holds node gateway-related parsed config file parameters and command-line overrides",
1259 "routingViaHost": "RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port into the host before sending it out. If this is not set, traffic will always egress directly from OVN to outside without touching the host stack. Setting this to true means hardware offload will not be supported. Default is false if GatewayConfig is specified.",
1260 }
1261
1262 func (GatewayConfig) SwaggerDoc() map[string]string {
1263 return map_GatewayConfig
1264 }
1265
1266 var map_HybridOverlayConfig = map[string]string{
1267 "hybridClusterNetwork": "HybridClusterNetwork defines a network space given to nodes on an additional overlay network.",
1268 "hybridOverlayVXLANPort": "HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789",
1269 }
1270
1271 func (HybridOverlayConfig) SwaggerDoc() map[string]string {
1272 return map_HybridOverlayConfig
1273 }
1274
1275 var map_IPAMConfig = map[string]string{
1276 "": "IPAMConfig contains configurations for IPAM (IP Address Management)",
1277 "type": "Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic",
1278 "staticIPAMConfig": "StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic",
1279 }
1280
1281 func (IPAMConfig) SwaggerDoc() map[string]string {
1282 return map_IPAMConfig
1283 }
1284
1285 var map_IPFIXConfig = map[string]string{
1286 "collectors": "ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items",
1287 }
1288
1289 func (IPFIXConfig) SwaggerDoc() map[string]string {
1290 return map_IPFIXConfig
1291 }
1292
1293 var map_KuryrConfig = map[string]string{
1294 "": "KuryrConfig configures the Kuryr-Kubernetes SDN",
1295 "daemonProbesPort": "The port kuryr-daemon will listen for readiness and liveness requests.",
1296 "controllerProbesPort": "The port kuryr-controller will listen for readiness and liveness requests.",
1297 "openStackServiceNetwork": "openStackServiceNetwork contains the CIDR of network from which to allocate IPs for OpenStack Octavia's Amphora VMs. Please note that with Amphora driver Octavia uses two IPs from that network for each loadbalancer - one given by OpenShift and second for VRRP connections. As the first one is managed by OpenShift's and second by Neutron's IPAMs, those need to come from different pools. Therefore `openStackServiceNetwork` needs to be at least twice the size of `serviceNetwork`, and whole `serviceNetwork` must be overlapping with `openStackServiceNetwork`. cluster-network-operator will then make sure VRRP IPs are taken from the ranges inside `openStackServiceNetwork` that are not overlapping with `serviceNetwork`, effectivly preventing conflicts. If not set cluster-network-operator will use `serviceNetwork` expanded by decrementing the prefix size by 1.",
1298 "enablePortPoolsPrepopulation": "enablePortPoolsPrepopulation when true will make Kuryr prepopulate each newly created port pool with a minimum number of ports. Kuryr uses Neutron port pooling to fight the fact that it takes a significant amount of time to create one. It creates a number of ports when the first pod that is configured to use the dedicated network for pods is created in a namespace, and keeps them ready to be attached to pods. Port prepopulation is disabled by default.",
1299 "poolMaxPorts": "poolMaxPorts sets a maximum number of free ports that are being kept in a port pool. If the number of ports exceeds this setting, free ports will get deleted. Setting 0 will disable this upper bound, effectively preventing pools from shrinking and this is the default value. For more information about port pools see enablePortPoolsPrepopulation setting.",
1300 "poolMinPorts": "poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting.",
1301 "poolBatchPorts": "poolBatchPorts sets a number of ports that should be created in a single batch request to extend the port pool. The default is 3. For more information about port pools see enablePortPoolsPrepopulation setting.",
1302 "mtu": "mtu is the MTU that Kuryr should use when creating pod networks in Neutron. The value has to be lower or equal to the MTU of the nodes network and Neutron has to allow creation of tenant networks with such MTU. If unset Pod networks will be created with the same MTU as the nodes network has. This also affects the services network created by cluster-network-operator.",
1303 }
1304
1305 func (KuryrConfig) SwaggerDoc() map[string]string {
1306 return map_KuryrConfig
1307 }
1308
1309 var map_MTUMigration = map[string]string{
1310 "": "MTUMigration MTU contains infomation about MTU migration.",
1311 "network": "network contains information about MTU migration for the default network. Migrations are only allowed to MTU values lower than the machine's uplink MTU by the minimum appropriate offset.",
1312 "machine": "machine contains MTU migration configuration for the machine's uplink. Needs to be migrated along with the default network MTU unless the current uplink MTU already accommodates the default network MTU.",
1313 }
1314
1315 func (MTUMigration) SwaggerDoc() map[string]string {
1316 return map_MTUMigration
1317 }
1318
1319 var map_MTUMigrationValues = map[string]string{
1320 "": "MTUMigrationValues contains the values for a MTU migration.",
1321 "to": "to is the MTU to migrate to.",
1322 "from": "from is the MTU to migrate from.",
1323 }
1324
1325 func (MTUMigrationValues) SwaggerDoc() map[string]string {
1326 return map_MTUMigrationValues
1327 }
1328
1329 var map_NetFlowConfig = map[string]string{
1330 "collectors": "netFlow defines the NetFlow collectors that will consume the flow data exported from OVS. It is a list of strings formatted as ip:port with a maximum of ten items",
1331 }
1332
1333 func (NetFlowConfig) SwaggerDoc() map[string]string {
1334 return map_NetFlowConfig
1335 }
1336
1337 var map_Network = map[string]string{
1338 "": "Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1339 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1340 }
1341
1342 func (Network) SwaggerDoc() map[string]string {
1343 return map_Network
1344 }
1345
1346 var map_NetworkList = map[string]string{
1347 "": "NetworkList contains a list of Network configurations\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1348 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1349 }
1350
1351 func (NetworkList) SwaggerDoc() map[string]string {
1352 return map_NetworkList
1353 }
1354
1355 var map_NetworkMigration = map[string]string{
1356 "": "NetworkMigration represents the cluster network configuration.",
1357 "networkType": "networkType is the target type of network migration. Set this to the target network type to allow changing the default network. If unset, the operation of changing cluster default network plugin will be rejected. The supported values are OpenShiftSDN, OVNKubernetes",
1358 "mtu": "mtu contains the MTU migration configuration. Set this to allow changing the MTU values for the default network. If unset, the operation of changing the MTU for the default network will be rejected.",
1359 "features": "features contains the features migration configuration. Set this to migrate feature configuration when changing the cluster default network provider. if unset, the default operation is to migrate all the configuration of supported features.",
1360 }
1361
1362 func (NetworkMigration) SwaggerDoc() map[string]string {
1363 return map_NetworkMigration
1364 }
1365
1366 var map_NetworkSpec = map[string]string{
1367 "": "NetworkSpec is the top-level network configuration object.",
1368 "clusterNetwork": "clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.",
1369 "serviceNetwork": "serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.",
1370 "defaultNetwork": "defaultNetwork is the \"default\" network that all pods will receive",
1371 "additionalNetworks": "additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.",
1372 "disableMultiNetwork": "disableMultiNetwork specifies whether or not multiple pod network support should be disabled. If unset, this property defaults to 'false' and multiple network support is enabled.",
1373 "useMultiNetworkPolicy": "useMultiNetworkPolicy enables a controller which allows for MultiNetworkPolicy objects to be used on additional networks as created by Multus CNI. MultiNetworkPolicy are similar to NetworkPolicy objects, but NetworkPolicy objects only apply to the primary interface. With MultiNetworkPolicy, you can control the traffic that a pod can receive over the secondary interfaces. If unset, this property defaults to 'false' and MultiNetworkPolicy objects are ignored. If 'disableMultiNetwork' is 'true' then the value of this field is ignored.",
1374 "deployKubeProxy": "deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when OpenShift SDN and ovn-kubernetes are used and true otherwise.",
1375 "disableNetworkDiagnostics": "disableNetworkDiagnostics specifies whether or not PodNetworkConnectivityCheck CRs from a test pod to every node, apiserver and LB should be disabled or not. If unset, this property defaults to 'false' and network diagnostics is enabled. Setting this to 'true' would reduce the additional load of the pods performing the checks.",
1376 "kubeProxyConfig": "kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.",
1377 "exportNetworkFlows": "exportNetworkFlows enables and configures the export of network flow metadata from the pod network by using protocols NetFlow, SFlow or IPFIX. Currently only supported on OVN-Kubernetes plugin. If unset, flows will not be exported to any collector.",
1378 "migration": "migration enables and configures the cluster network migration. The migration procedure allows to change the network type and the MTU.",
1379 }
1380
1381 func (NetworkSpec) SwaggerDoc() map[string]string {
1382 return map_NetworkSpec
1383 }
1384
1385 var map_NetworkStatus = map[string]string{
1386 "": "NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.",
1387 }
1388
1389 func (NetworkStatus) SwaggerDoc() map[string]string {
1390 return map_NetworkStatus
1391 }
1392
1393 var map_OVNKubernetesConfig = map[string]string{
1394 "": "ovnKubernetesConfig contains the configuration parameters for networks using the ovn-kubernetes network project",
1395 "mtu": "mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400",
1396 "genevePort": "geneve port is the UDP port to be used by geneve encapulation. Default is 6081",
1397 "hybridOverlayConfig": "HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.",
1398 "ipsecConfig": "ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.",
1399 "policyAuditConfig": "policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.",
1400 "gatewayConfig": "gatewayConfig holds the configuration for node gateway options.",
1401 "v4InternalSubnet": "v4InternalSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value cannot be changed after installation. Default is 100.64.0.0/16",
1402 "v6InternalSubnet": "v6InternalSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value cannot be changed after installation. Default is fd98::/48",
1403 "egressIPConfig": "egressIPConfig holds the configuration for EgressIP options.",
1404 }
1405
1406 func (OVNKubernetesConfig) SwaggerDoc() map[string]string {
1407 return map_OVNKubernetesConfig
1408 }
1409
1410 var map_OpenShiftSDNConfig = map[string]string{
1411 "": "OpenShiftSDNConfig configures the three openshift-sdn plugins",
1412 "mode": "mode is one of \"Multitenant\", \"Subnet\", or \"NetworkPolicy\"",
1413 "vxlanPort": "vxlanPort is the port to use for all vxlan packets. The default is 4789.",
1414 "mtu": "mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine's uplink.",
1415 "useExternalOpenvswitch": "useExternalOpenvswitch used to control whether the operator would deploy an OVS DaemonSet itself or expect someone else to start OVS. As of 4.6, OVS is always run as a system service, and this flag is ignored. DEPRECATED: non-functional as of 4.6",
1416 "enableUnidling": "enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.",
1417 }
1418
1419 func (OpenShiftSDNConfig) SwaggerDoc() map[string]string {
1420 return map_OpenShiftSDNConfig
1421 }
1422
1423 var map_PolicyAuditConfig = map[string]string{
1424 "rateLimit": "rateLimit is the approximate maximum number of messages to generate per-second per-node. If unset the default of 20 msg/sec is used.",
1425 "maxFileSize": "maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs Units are in MB and the Default is 50MB",
1426 "destination": "destination is the location for policy log messages. Regardless of this config, persistent logs will always be dumped to the host at /var/log/ovn/ however Additionally syslog output may be configured as follows. Valid values are: - \"libc\" -> to use the libc syslog() function of the host node's journdald process - \"udp:host:port\" -> for sending syslog over UDP - \"unix:file\" -> for using the UNIX domain socket directly - \"null\" -> to discard all messages logged to syslog The default is \"null\"",
1427 "syslogFacility": "syslogFacility the RFC5424 facility for generated messages, e.g. \"kern\". Default is \"local0\"",
1428 }
1429
1430 func (PolicyAuditConfig) SwaggerDoc() map[string]string {
1431 return map_PolicyAuditConfig
1432 }
1433
1434 var map_ProxyConfig = map[string]string{
1435 "": "ProxyConfig defines the configuration knobs for kubeproxy All of these are optional and have sensible defaults",
1436 "iptablesSyncPeriod": "An internal kube-proxy parameter. In older releases of OCP, this sometimes needed to be adjusted in large clusters for performance reasons, but this is no longer necessary, and there is no reason to change this from the default value. Default: 30s",
1437 "bindAddress": "The address to \"bind\" on Defaults to 0.0.0.0",
1438 "proxyArguments": "Any additional arguments to pass to the kubeproxy process",
1439 }
1440
1441 func (ProxyConfig) SwaggerDoc() map[string]string {
1442 return map_ProxyConfig
1443 }
1444
1445 var map_SFlowConfig = map[string]string{
1446 "collectors": "sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items",
1447 }
1448
1449 func (SFlowConfig) SwaggerDoc() map[string]string {
1450 return map_SFlowConfig
1451 }
1452
1453 var map_SimpleMacvlanConfig = map[string]string{
1454 "": "SimpleMacvlanConfig contains configurations for macvlan interface.",
1455 "master": "master is the host interface to create the macvlan interface from. If not specified, it will be default route interface",
1456 "ipamConfig": "IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).",
1457 "mode": "mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge",
1458 "mtu": "mtu is the mtu to use for the macvlan interface. if unset, host's kernel will select the value.",
1459 }
1460
1461 func (SimpleMacvlanConfig) SwaggerDoc() map[string]string {
1462 return map_SimpleMacvlanConfig
1463 }
1464
1465 var map_StaticIPAMAddresses = map[string]string{
1466 "": "StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses",
1467 "address": "Address is the IP address in CIDR format",
1468 "gateway": "Gateway is IP inside of subnet to designate as the gateway",
1469 }
1470
1471 func (StaticIPAMAddresses) SwaggerDoc() map[string]string {
1472 return map_StaticIPAMAddresses
1473 }
1474
1475 var map_StaticIPAMConfig = map[string]string{
1476 "": "StaticIPAMConfig contains configurations for static IPAM (IP Address Management)",
1477 "addresses": "Addresses configures IP address for the interface",
1478 "routes": "Routes configures IP routes for the interface",
1479 "dns": "DNS configures DNS for the interface",
1480 }
1481
1482 func (StaticIPAMConfig) SwaggerDoc() map[string]string {
1483 return map_StaticIPAMConfig
1484 }
1485
1486 var map_StaticIPAMDNS = map[string]string{
1487 "": "StaticIPAMDNS provides DNS related information for static IPAM",
1488 "nameservers": "Nameservers points DNS servers for IP lookup",
1489 "domain": "Domain configures the domainname the local domain used for short hostname lookups",
1490 "search": "Search configures priority ordered search domains for short hostname lookups",
1491 }
1492
1493 func (StaticIPAMDNS) SwaggerDoc() map[string]string {
1494 return map_StaticIPAMDNS
1495 }
1496
1497 var map_StaticIPAMRoutes = map[string]string{
1498 "": "StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes",
1499 "destination": "Destination points the IP route destination",
1500 "gateway": "Gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).",
1501 }
1502
1503 func (StaticIPAMRoutes) SwaggerDoc() map[string]string {
1504 return map_StaticIPAMRoutes
1505 }
1506
1507 var map_OpenShiftAPIServer = map[string]string{
1508 "": "OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1509 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1510 "spec": "spec is the specification of the desired behavior of the OpenShift API Server.",
1511 "status": "status defines the observed status of the OpenShift API Server.",
1512 }
1513
1514 func (OpenShiftAPIServer) SwaggerDoc() map[string]string {
1515 return map_OpenShiftAPIServer
1516 }
1517
1518 var map_OpenShiftAPIServerList = map[string]string{
1519 "": "OpenShiftAPIServerList 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).",
1520 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1521 "items": "Items contains the items",
1522 }
1523
1524 func (OpenShiftAPIServerList) SwaggerDoc() map[string]string {
1525 return map_OpenShiftAPIServerList
1526 }
1527
1528 var map_OpenShiftAPIServerStatus = map[string]string{
1529 "latestAvailableRevision": "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.",
1530 }
1531
1532 func (OpenShiftAPIServerStatus) SwaggerDoc() map[string]string {
1533 return map_OpenShiftAPIServerStatus
1534 }
1535
1536 var map_OpenShiftControllerManager = map[string]string{
1537 "": "OpenShiftControllerManager provides information to configure an operator to manage openshift-controller-manager.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1538 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1539 }
1540
1541 func (OpenShiftControllerManager) SwaggerDoc() map[string]string {
1542 return map_OpenShiftControllerManager
1543 }
1544
1545 var map_OpenShiftControllerManagerList = map[string]string{
1546 "": "OpenShiftControllerManagerList 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).",
1547 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1548 "items": "Items contains the items",
1549 }
1550
1551 func (OpenShiftControllerManagerList) SwaggerDoc() map[string]string {
1552 return map_OpenShiftControllerManagerList
1553 }
1554
1555 var map_KubeScheduler = map[string]string{
1556 "": "KubeScheduler provides information to configure an operator to manage scheduler.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1557 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1558 "spec": "spec is the specification of the desired behavior of the Kubernetes Scheduler",
1559 "status": "status is the most recently observed status of the Kubernetes Scheduler",
1560 }
1561
1562 func (KubeScheduler) SwaggerDoc() map[string]string {
1563 return map_KubeScheduler
1564 }
1565
1566 var map_KubeSchedulerList = map[string]string{
1567 "": "KubeSchedulerList 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).",
1568 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1569 "items": "Items contains the items",
1570 }
1571
1572 func (KubeSchedulerList) SwaggerDoc() map[string]string {
1573 return map_KubeSchedulerList
1574 }
1575
1576 var map_ServiceCA = map[string]string{
1577 "": "ServiceCA provides information to configure an operator to manage the service cert controllers\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1578 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1579 "spec": "spec holds user settable values for configuration",
1580 "status": "status holds observed values from the cluster. They may not be overridden.",
1581 }
1582
1583 func (ServiceCA) SwaggerDoc() map[string]string {
1584 return map_ServiceCA
1585 }
1586
1587 var map_ServiceCAList = map[string]string{
1588 "": "ServiceCAList 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).",
1589 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1590 "items": "Items contains the items",
1591 }
1592
1593 func (ServiceCAList) SwaggerDoc() map[string]string {
1594 return map_ServiceCAList
1595 }
1596
1597 var map_ServiceCatalogAPIServer = map[string]string{
1598 "": "ServiceCatalogAPIServer provides information to configure an operator to manage Service Catalog API Server DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1599 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1600 }
1601
1602 func (ServiceCatalogAPIServer) SwaggerDoc() map[string]string {
1603 return map_ServiceCatalogAPIServer
1604 }
1605
1606 var map_ServiceCatalogAPIServerList = map[string]string{
1607 "": "ServiceCatalogAPIServerList is a collection of items DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1608 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1609 "items": "Items contains the items",
1610 }
1611
1612 func (ServiceCatalogAPIServerList) SwaggerDoc() map[string]string {
1613 return map_ServiceCatalogAPIServerList
1614 }
1615
1616 var map_ServiceCatalogControllerManager = map[string]string{
1617 "": "ServiceCatalogControllerManager provides information to configure an operator to manage Service Catalog Controller Manager DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1618 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1619 }
1620
1621 func (ServiceCatalogControllerManager) SwaggerDoc() map[string]string {
1622 return map_ServiceCatalogControllerManager
1623 }
1624
1625 var map_ServiceCatalogControllerManagerList = map[string]string{
1626 "": "ServiceCatalogControllerManagerList is a collection of items DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1627 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1628 "items": "Items contains the items",
1629 }
1630
1631 func (ServiceCatalogControllerManagerList) SwaggerDoc() map[string]string {
1632 return map_ServiceCatalogControllerManagerList
1633 }
1634
1635 var map_Storage = map[string]string{
1636 "": "Storage provides a means to configure an operator to manage the cluster storage operator. `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).",
1637 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1638 "spec": "spec holds user settable values for configuration",
1639 "status": "status holds observed values from the cluster. They may not be overridden.",
1640 }
1641
1642 func (Storage) SwaggerDoc() map[string]string {
1643 return map_Storage
1644 }
1645
1646 var map_StorageList = map[string]string{
1647 "": "StorageList contains a list of Storages.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1648 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1649 }
1650
1651 func (StorageList) SwaggerDoc() map[string]string {
1652 return map_StorageList
1653 }
1654
1655 var map_StorageSpec = map[string]string{
1656 "": "StorageSpec is the specification of the desired behavior of the cluster storage operator.",
1657 "vsphereStorageDriver": "VSphereStorageDriver indicates the storage driver to use on VSphere clusters. Once this field is set to CSIWithMigrationDriver, it can not be changed. If this is empty, the platform will choose a good default, which may change over time without notice. The current default is CSIWithMigrationDriver and may not be changed. DEPRECATED: This field will be removed in a future release.",
1658 }
1659
1660 func (StorageSpec) SwaggerDoc() map[string]string {
1661 return map_StorageSpec
1662 }
1663
1664 var map_StorageStatus = map[string]string{
1665 "": "StorageStatus defines the observed status of the cluster storage operator.",
1666 }
1667
1668 func (StorageStatus) SwaggerDoc() map[string]string {
1669 return map_StorageStatus
1670 }
1671
1672
1673
View as plain text