1 package v1
2
3
4
5
6
7
8
9
10
11
12
13
14 var map_AdmissionConfig = map[string]string{
15 "enabledPlugins": "enabledPlugins is a list of admission plugins that must be on in addition to the default list. Some admission plugins are disabled by default, but certain configurations require them. This is fairly uncommon and can result in performance penalties and unexpected behavior.",
16 "disabledPlugins": "disabledPlugins is a list of admission plugins that must be off. Putting something in this list is almost always a mistake and likely to result in cluster instability.",
17 }
18
19 func (AdmissionConfig) SwaggerDoc() map[string]string {
20 return map_AdmissionConfig
21 }
22
23 var map_AdmissionPluginConfig = map[string]string{
24 "": "AdmissionPluginConfig holds the necessary configuration options for admission plugins",
25 "location": "Location is the path to a configuration file that contains the plugin's configuration",
26 "configuration": "Configuration is an embedded configuration object to be used as the plugin's configuration. If present, it will be used instead of the path to the configuration file.",
27 }
28
29 func (AdmissionPluginConfig) SwaggerDoc() map[string]string {
30 return map_AdmissionPluginConfig
31 }
32
33 var map_AuditConfig = map[string]string{
34 "": "AuditConfig holds configuration for the audit capabilities",
35 "enabled": "If this flag is set, audit log will be printed in the logs. The logs contains, method, user and a requested URL.",
36 "auditFilePath": "All requests coming to the apiserver will be logged to this file.",
37 "maximumFileRetentionDays": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.",
38 "maximumRetainedFiles": "Maximum number of old log files to retain.",
39 "maximumFileSizeMegabytes": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.",
40 "policyFile": "PolicyFile is a path to the file that defines the audit policy configuration.",
41 "policyConfiguration": "PolicyConfiguration is an embedded policy configuration object to be used as the audit policy configuration. If present, it will be used instead of the path to the policy file.",
42 "logFormat": "Format of saved audits (legacy or json).",
43 "webHookKubeConfig": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.",
44 "webHookMode": "Strategy for sending audit events (block or batch).",
45 }
46
47 func (AuditConfig) SwaggerDoc() map[string]string {
48 return map_AuditConfig
49 }
50
51 var map_CertInfo = map[string]string{
52 "": "CertInfo relates a certificate with a private key",
53 "certFile": "CertFile is a file containing a PEM-encoded certificate",
54 "keyFile": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
55 }
56
57 func (CertInfo) SwaggerDoc() map[string]string {
58 return map_CertInfo
59 }
60
61 var map_ClientConnectionOverrides = map[string]string{
62 "acceptContentTypes": "acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.",
63 "contentType": "contentType is the content type used when sending data to the server from this client.",
64 "qps": "qps controls the number of queries per second allowed for this connection.",
65 "burst": "burst allows extra queries to accumulate when a client is exceeding its rate.",
66 }
67
68 func (ClientConnectionOverrides) SwaggerDoc() map[string]string {
69 return map_ClientConnectionOverrides
70 }
71
72 var map_ConfigMapFileReference = map[string]string{
73 "": "ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
74 "key": "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.",
75 }
76
77 func (ConfigMapFileReference) SwaggerDoc() map[string]string {
78 return map_ConfigMapFileReference
79 }
80
81 var map_ConfigMapNameReference = map[string]string{
82 "": "ConfigMapNameReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
83 "name": "name is the metadata.name of the referenced config map",
84 }
85
86 func (ConfigMapNameReference) SwaggerDoc() map[string]string {
87 return map_ConfigMapNameReference
88 }
89
90 var map_DelegatedAuthentication = map[string]string{
91 "": "DelegatedAuthentication allows authentication to be disabled.",
92 "disabled": "disabled indicates that authentication should be disabled. By default it will use delegated authentication.",
93 }
94
95 func (DelegatedAuthentication) SwaggerDoc() map[string]string {
96 return map_DelegatedAuthentication
97 }
98
99 var map_DelegatedAuthorization = map[string]string{
100 "": "DelegatedAuthorization allows authorization to be disabled.",
101 "disabled": "disabled indicates that authorization should be disabled. By default it will use delegated authorization.",
102 }
103
104 func (DelegatedAuthorization) SwaggerDoc() map[string]string {
105 return map_DelegatedAuthorization
106 }
107
108 var map_EtcdConnectionInfo = map[string]string{
109 "": "EtcdConnectionInfo holds information necessary for connecting to an etcd server",
110 "urls": "URLs are the URLs for etcd",
111 "ca": "CA is a file containing trusted roots for the etcd server certificates",
112 }
113
114 func (EtcdConnectionInfo) SwaggerDoc() map[string]string {
115 return map_EtcdConnectionInfo
116 }
117
118 var map_EtcdStorageConfig = map[string]string{
119 "storagePrefix": "StoragePrefix is the path within etcd that the OpenShift resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located.",
120 }
121
122 func (EtcdStorageConfig) SwaggerDoc() map[string]string {
123 return map_EtcdStorageConfig
124 }
125
126 var map_GenericAPIServerConfig = map[string]string{
127 "": "GenericAPIServerConfig is an inline-able struct for aggregated apiservers that need to store data in etcd",
128 "servingInfo": "servingInfo describes how to start serving",
129 "corsAllowedOrigins": "corsAllowedOrigins",
130 "auditConfig": "auditConfig describes how to configure audit information",
131 "storageConfig": "storageConfig contains information about how to use",
132 "admission": "admissionConfig holds information about how to configure admission.",
133 }
134
135 func (GenericAPIServerConfig) SwaggerDoc() map[string]string {
136 return map_GenericAPIServerConfig
137 }
138
139 var map_GenericControllerConfig = map[string]string{
140 "": "GenericControllerConfig provides information to configure a controller",
141 "servingInfo": "ServingInfo is the HTTP serving information for the controller's endpoints",
142 "leaderElection": "leaderElection provides information to elect a leader. Only override this if you have a specific need",
143 "authentication": "authentication allows configuration of authentication for the endpoints",
144 "authorization": "authorization allows configuration of authentication for the endpoints",
145 }
146
147 func (GenericControllerConfig) SwaggerDoc() map[string]string {
148 return map_GenericControllerConfig
149 }
150
151 var map_HTTPServingInfo = map[string]string{
152 "": "HTTPServingInfo holds configuration for serving HTTP",
153 "maxRequestsInFlight": "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.",
154 "requestTimeoutSeconds": "RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.",
155 }
156
157 func (HTTPServingInfo) SwaggerDoc() map[string]string {
158 return map_HTTPServingInfo
159 }
160
161 var map_KubeClientConfig = map[string]string{
162 "kubeConfig": "kubeConfig is a .kubeconfig filename for going to the owning kube-apiserver. Empty uses an in-cluster-config",
163 "connectionOverrides": "connectionOverrides specifies client overrides for system components to loop back to this master.",
164 }
165
166 func (KubeClientConfig) SwaggerDoc() map[string]string {
167 return map_KubeClientConfig
168 }
169
170 var map_LeaderElection = map[string]string{
171 "": "LeaderElection provides information to elect a leader",
172 "disable": "disable allows leader election to be suspended while allowing a fully defaulted \"normal\" startup case.",
173 "namespace": "namespace indicates which namespace the resource is in",
174 "name": "name indicates what name to use for the resource",
175 "leaseDuration": "leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.",
176 "renewDeadline": "renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.",
177 "retryPeriod": "retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.",
178 }
179
180 func (LeaderElection) SwaggerDoc() map[string]string {
181 return map_LeaderElection
182 }
183
184 var map_MaxAgePolicy = map[string]string{
185 "": "MaxAgePolicy contains a numeric range for specifying a compliant HSTS max-age for the enclosing RequiredHSTSPolicy",
186 "largestMaxAge": "The largest allowed value (in seconds) of the RequiredHSTSPolicy max-age This value can be left unspecified, in which case no upper limit is enforced.",
187 "smallestMaxAge": "The smallest allowed value (in seconds) of the RequiredHSTSPolicy max-age Setting max-age=0 allows the deletion of an existing HSTS header from a host. This is a necessary tool for administrators to quickly correct mistakes. This value can be left unspecified, in which case no lower limit is enforced.",
188 }
189
190 func (MaxAgePolicy) SwaggerDoc() map[string]string {
191 return map_MaxAgePolicy
192 }
193
194 var map_NamedCertificate = map[string]string{
195 "": "NamedCertificate specifies a certificate/key, and the names it should be served for",
196 "names": "Names is a list of DNS names this certificate should be used to secure A name can be a normal DNS name, or can contain leading wildcard segments.",
197 }
198
199 func (NamedCertificate) SwaggerDoc() map[string]string {
200 return map_NamedCertificate
201 }
202
203 var map_RemoteConnectionInfo = map[string]string{
204 "": "RemoteConnectionInfo holds information necessary for establishing a remote connection",
205 "url": "URL is the remote URL to connect to",
206 "ca": "CA is the CA for verifying TLS connections",
207 }
208
209 func (RemoteConnectionInfo) SwaggerDoc() map[string]string {
210 return map_RemoteConnectionInfo
211 }
212
213 var map_RequiredHSTSPolicy = map[string]string{
214 "namespaceSelector": "namespaceSelector specifies a label selector such that the policy applies only to those routes that are in namespaces with labels that match the selector, and are in one of the DomainPatterns. Defaults to the empty LabelSelector, which matches everything.",
215 "domainPatterns": "domainPatterns is a list of domains for which the desired HSTS annotations are required. If domainPatterns is specified and a route is created with a spec.host matching one of the domains, the route must specify the HSTS Policy components described in the matching RequiredHSTSPolicy.\n\nThe use of wildcards is allowed like this: *.foo.com matches everything under foo.com. foo.com only matches foo.com, so to cover foo.com and everything under it, you must specify *both*.",
216 "maxAge": "maxAge is the delta time range in seconds during which hosts are regarded as HSTS hosts. If set to 0, it negates the effect, and hosts are removed as HSTS hosts. If set to 0 and includeSubdomains is specified, all subdomains of the host are also removed as HSTS hosts. maxAge is a time-to-live value, and if this policy is not refreshed on a client, the HSTS policy will eventually expire on that client.",
217 "preloadPolicy": "preloadPolicy directs the client to include hosts in its host preload list so that it never needs to do an initial load to get the HSTS header (note that this is not defined in RFC 6797 and is therefore client implementation-dependent).",
218 "includeSubDomainsPolicy": "includeSubDomainsPolicy means the HSTS Policy should apply to any subdomains of the host's domain name. Thus, for the host bar.foo.com, if includeSubDomainsPolicy was set to RequireIncludeSubDomains: - the host app.bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host foo.com would NOT inherit the HSTS Policy of bar.foo.com - the host def.foo.com would NOT inherit the HSTS Policy of bar.foo.com",
219 }
220
221 func (RequiredHSTSPolicy) SwaggerDoc() map[string]string {
222 return map_RequiredHSTSPolicy
223 }
224
225 var map_SecretNameReference = map[string]string{
226 "": "SecretNameReference references a secret in a specific namespace. The namespace must be specified at the point of use.",
227 "name": "name is the metadata.name of the referenced secret",
228 }
229
230 func (SecretNameReference) SwaggerDoc() map[string]string {
231 return map_SecretNameReference
232 }
233
234 var map_ServingInfo = map[string]string{
235 "": "ServingInfo holds information about serving web pages",
236 "bindAddress": "BindAddress is the ip:port to serve on",
237 "bindNetwork": "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
238 "clientCA": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
239 "namedCertificates": "NamedCertificates is a list of certificates to use to secure requests to specific hostnames",
240 "minTLSVersion": "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
241 "cipherSuites": "CipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
242 }
243
244 func (ServingInfo) SwaggerDoc() map[string]string {
245 return map_ServingInfo
246 }
247
248 var map_StringSource = map[string]string{
249 "": "StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.",
250 }
251
252 func (StringSource) SwaggerDoc() map[string]string {
253 return map_StringSource
254 }
255
256 var map_StringSourceSpec = map[string]string{
257 "": "StringSourceSpec specifies a string value, or external location",
258 "value": "Value specifies the cleartext value, or an encrypted value if keyFile is specified.",
259 "env": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
260 "file": "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
261 "keyFile": "KeyFile references a file containing the key to use to decrypt the value.",
262 }
263
264 func (StringSourceSpec) SwaggerDoc() map[string]string {
265 return map_StringSourceSpec
266 }
267
268 var map_APIServer = map[string]string{
269 "": "APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
270 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
271 "spec": "spec holds user settable values for configuration",
272 "status": "status holds observed values from the cluster. They may not be overridden.",
273 }
274
275 func (APIServer) SwaggerDoc() map[string]string {
276 return map_APIServer
277 }
278
279 var map_APIServerEncryption = map[string]string{
280 "type": "type defines what encryption type should be used to encrypt resources at the datastore layer. When this field is unset (i.e. when it is set to the empty string), identity is implied. The behavior of unset can and will change over time. Even if encryption is enabled by default, the meaning of unset may change to a different encryption type based on changes in best practices.\n\nWhen encryption is enabled, all sensitive resources shipped with the platform are encrypted. This list of sensitive resources can and will change over time. The current authoritative list is:\n\n 1. secrets\n 2. configmaps\n 3. routes.route.openshift.io\n 4. oauthaccesstokens.oauth.openshift.io\n 5. oauthauthorizetokens.oauth.openshift.io",
281 }
282
283 func (APIServerEncryption) SwaggerDoc() map[string]string {
284 return map_APIServerEncryption
285 }
286
287 var map_APIServerList = map[string]string{
288 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
289 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
290 }
291
292 func (APIServerList) SwaggerDoc() map[string]string {
293 return map_APIServerList
294 }
295
296 var map_APIServerNamedServingCert = map[string]string{
297 "": "APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.",
298 "names": "names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates. Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names.",
299 "servingCertificate": "servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data[\"tls.key\"] - TLS private key. - Secret.Data[\"tls.crt\"] - TLS certificate.",
300 }
301
302 func (APIServerNamedServingCert) SwaggerDoc() map[string]string {
303 return map_APIServerNamedServingCert
304 }
305
306 var map_APIServerServingCerts = map[string]string{
307 "namedCertificates": "namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames. If no named certificates are provided, or no named certificates match the server name as understood by a client, the defaultServingCertificate will be used.",
308 }
309
310 func (APIServerServingCerts) SwaggerDoc() map[string]string {
311 return map_APIServerServingCerts
312 }
313
314 var map_APIServerSpec = map[string]string{
315 "servingCerts": "servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates will be used for serving secure traffic.",
316 "clientCA": "clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid. You usually only have to set this if you have your own PKI you wish to honor client certificates from. The ConfigMap must exist in the openshift-config namespace and contain the following required fields: - ConfigMap.Data[\"ca-bundle.crt\"] - CA bundle.",
317 "additionalCORSAllowedOrigins": "additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth server from JavaScript applications. The values are regular expressions that correspond to the Golang regular expression language.",
318 "encryption": "encryption allows the configuration of encryption of resources at the datastore layer.",
319 "tlsSecurityProfile": "tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.\n\nIf unset, a default (which may change between releases) is chosen. Note that only Old, Intermediate and Custom profiles are currently supported, and the maximum available MinTLSVersions is VersionTLS12.",
320 "audit": "audit specifies the settings for audit configuration to be applied to all OpenShift-provided API servers in the cluster.",
321 }
322
323 func (APIServerSpec) SwaggerDoc() map[string]string {
324 return map_APIServerSpec
325 }
326
327 var map_Audit = map[string]string{
328 "profile": "profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules.\n\nThe following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events\n (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody\n level).\n- WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nWarning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.\n\nIf unset, the 'Default' profile is used as the default.",
329 "customRules": "customRules specify profiles per group. These profile take precedence over the top-level profile field if they apply. They are evaluation from top to bottom and the first one that matches, applies.",
330 }
331
332 func (Audit) SwaggerDoc() map[string]string {
333 return map_Audit
334 }
335
336 var map_AuditCustomRule = map[string]string{
337 "": "AuditCustomRule describes a custom rule for an audit profile that takes precedence over the top-level profile.",
338 "group": "group is a name of group a request user must be member of in order to this profile to apply.",
339 "profile": "profile specifies the name of the desired audit policy configuration to be deployed to all OpenShift-provided API servers in the cluster.\n\nThe following profiles are provided: - Default: the existing default policy. - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nIf unset, the 'Default' profile is used as the default.",
340 }
341
342 func (AuditCustomRule) SwaggerDoc() map[string]string {
343 return map_AuditCustomRule
344 }
345
346 var map_Authentication = map[string]string{
347 "": "Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
348 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
349 "spec": "spec holds user settable values for configuration",
350 "status": "status holds observed values from the cluster. They may not be overridden.",
351 }
352
353 func (Authentication) SwaggerDoc() map[string]string {
354 return map_Authentication
355 }
356
357 var map_AuthenticationList = map[string]string{
358 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
359 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
360 }
361
362 func (AuthenticationList) SwaggerDoc() map[string]string {
363 return map_AuthenticationList
364 }
365
366 var map_AuthenticationSpec = map[string]string{
367 "type": "type identifies the cluster managed, user facing authentication mode in use. Specifically, it manages the component that responds to login attempts. The default is IntegratedOAuth.",
368 "oauthMetadata": "oauthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for an external OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 If oauthMetadata.name is non-empty, this value has precedence over any metadata reference stored in status. The key \"oauthMetadata\" is used to locate the data. If specified and the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config.",
369 "webhookTokenAuthenticators": "webhookTokenAuthenticators is DEPRECATED, setting it has no effect.",
370 "webhookTokenAuthenticator": "webhookTokenAuthenticator configures a remote token reviewer. These remote authentication webhooks can be used to verify bearer tokens via the tokenreviews.authentication.k8s.io REST API. This is required to honor bearer tokens that are provisioned by an external authentication service.",
371 "serviceAccountIssuer": "serviceAccountIssuer is the identifier of the bound service account token issuer. The default is https://kubernetes.default.svc WARNING: Updating this field will not result in immediate invalidation of all bound tokens with the previous issuer value. Instead, the tokens issued by previous service account issuer will continue to be trusted for a time period chosen by the platform (currently set to 24h). This time period is subject to change over time. This allows internal components to transition to use new service account issuer without service distruption.",
372 }
373
374 func (AuthenticationSpec) SwaggerDoc() map[string]string {
375 return map_AuthenticationSpec
376 }
377
378 var map_AuthenticationStatus = map[string]string{
379 "integratedOAuthMetadata": "integratedOAuthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for the in-cluster integrated OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This contains the observed value based on cluster state. An explicitly set value in spec.oauthMetadata has precedence over this field. This field has no meaning if authentication spec.type is not set to IntegratedOAuth. The key \"oauthMetadata\" is used to locate the data. If the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config-managed.",
380 }
381
382 func (AuthenticationStatus) SwaggerDoc() map[string]string {
383 return map_AuthenticationStatus
384 }
385
386 var map_DeprecatedWebhookTokenAuthenticator = map[string]string{
387 "": "deprecatedWebhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator. It's the same as WebhookTokenAuthenticator but it's missing the 'required' validation on KubeConfig field.",
388 "kubeConfig": "kubeConfig contains kube config file data which describes how to access the remote webhook service. For further details, see: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication The key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. The namespace for this secret is determined by the point of use.",
389 }
390
391 func (DeprecatedWebhookTokenAuthenticator) SwaggerDoc() map[string]string {
392 return map_DeprecatedWebhookTokenAuthenticator
393 }
394
395 var map_WebhookTokenAuthenticator = map[string]string{
396 "": "webhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator",
397 "kubeConfig": "kubeConfig references a secret that contains kube config file data which describes how to access the remote webhook service. The namespace for the referenced secret is openshift-config.\n\nFor further details, see:\n\nhttps://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication\n\nThe key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored.",
398 }
399
400 func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string {
401 return map_WebhookTokenAuthenticator
402 }
403
404 var map_Build = map[string]string{
405 "": "Build configures the behavior of OpenShift builds for the entire cluster. This includes default settings that can be overridden in BuildConfig objects, and overrides which are applied to all builds.\n\nThe canonical name is \"cluster\"\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
406 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
407 "spec": "Spec holds user-settable values for the build controller configuration",
408 }
409
410 func (Build) SwaggerDoc() map[string]string {
411 return map_Build
412 }
413
414 var map_BuildDefaults = map[string]string{
415 "defaultProxy": "DefaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.\n\nValues can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables in the build config's strategy.",
416 "gitProxy": "GitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.\n\nValues that are not set here will be inherited from DefaultProxy.",
417 "env": "Env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
418 "imageLabels": "ImageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
419 "resources": "Resources defines resource requirements to execute the build.",
420 }
421
422 func (BuildDefaults) SwaggerDoc() map[string]string {
423 return map_BuildDefaults
424 }
425
426 var map_BuildList = map[string]string{
427 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
428 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
429 }
430
431 func (BuildList) SwaggerDoc() map[string]string {
432 return map_BuildList
433 }
434
435 var map_BuildOverrides = map[string]string{
436 "imageLabels": "ImageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
437 "nodeSelector": "NodeSelector is a selector which must be true for the build pod to fit on a node",
438 "tolerations": "Tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
439 "forcePull": "ForcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself",
440 }
441
442 func (BuildOverrides) SwaggerDoc() map[string]string {
443 return map_BuildOverrides
444 }
445
446 var map_BuildSpec = map[string]string{
447 "additionalTrustedCA": "AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.\n\nDEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead.",
448 "buildDefaults": "BuildDefaults controls the default information for Builds",
449 "buildOverrides": "BuildOverrides controls override settings for builds",
450 }
451
452 func (BuildSpec) SwaggerDoc() map[string]string {
453 return map_BuildSpec
454 }
455
456 var map_ImageLabel = map[string]string{
457 "name": "Name defines the name of the label. It must have non-zero length.",
458 "value": "Value defines the literal value of the label.",
459 }
460
461 func (ImageLabel) SwaggerDoc() map[string]string {
462 return map_ImageLabel
463 }
464
465 var map_ClusterOperator = map[string]string{
466 "": "ClusterOperator is the Custom Resource object which holds the current state of an operator. This object is used by operators to convey their state to the rest of the cluster.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
467 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
468 "spec": "spec holds configuration that could apply to any operator.",
469 "status": "status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.",
470 }
471
472 func (ClusterOperator) SwaggerDoc() map[string]string {
473 return map_ClusterOperator
474 }
475
476 var map_ClusterOperatorList = map[string]string{
477 "": "ClusterOperatorList is a list of OperatorStatus resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
478 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
479 }
480
481 func (ClusterOperatorList) SwaggerDoc() map[string]string {
482 return map_ClusterOperatorList
483 }
484
485 var map_ClusterOperatorSpec = map[string]string{
486 "": "ClusterOperatorSpec is empty for now, but you could imagine holding information like \"pause\".",
487 }
488
489 func (ClusterOperatorSpec) SwaggerDoc() map[string]string {
490 return map_ClusterOperatorSpec
491 }
492
493 var map_ClusterOperatorStatus = map[string]string{
494 "": "ClusterOperatorStatus provides information about the status of the operator.",
495 "conditions": "conditions describes the state of the operator's managed and monitored components.",
496 "versions": "versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name \"operator\". An operator reports a new \"operator\" version when it has rolled out the new version to all of its operands.",
497 "relatedObjects": "relatedObjects is a list of objects that are \"interesting\" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces",
498 "extension": "extension contains any additional status information specific to the operator which owns this status object.",
499 }
500
501 func (ClusterOperatorStatus) SwaggerDoc() map[string]string {
502 return map_ClusterOperatorStatus
503 }
504
505 var map_ClusterOperatorStatusCondition = map[string]string{
506 "": "ClusterOperatorStatusCondition represents the state of the operator's managed and monitored components.",
507 "type": "type specifies the aspect reported by this condition.",
508 "status": "status of the condition, one of True, False, Unknown.",
509 "lastTransitionTime": "lastTransitionTime is the time of the last update to the current status property.",
510 "reason": "reason is the CamelCase reason for the condition's current status.",
511 "message": "message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
512 }
513
514 func (ClusterOperatorStatusCondition) SwaggerDoc() map[string]string {
515 return map_ClusterOperatorStatusCondition
516 }
517
518 var map_ObjectReference = map[string]string{
519 "": "ObjectReference contains enough information to let you inspect or modify the referred object.",
520 "group": "group of the referent.",
521 "resource": "resource of the referent.",
522 "namespace": "namespace of the referent.",
523 "name": "name of the referent.",
524 }
525
526 func (ObjectReference) SwaggerDoc() map[string]string {
527 return map_ObjectReference
528 }
529
530 var map_OperandVersion = map[string]string{
531 "name": "name is the name of the particular operand this version is for. It usually matches container images, not operators.",
532 "version": "version indicates which version of a particular operand is currently being managed. It must always match the Available operand. If 1.0.0 is Available, then this must indicate 1.0.0 even if the operator is trying to rollout 1.1.0",
533 }
534
535 func (OperandVersion) SwaggerDoc() map[string]string {
536 return map_OperandVersion
537 }
538
539 var map_ClusterCondition = map[string]string{
540 "": "ClusterCondition is a union of typed cluster conditions. The 'type' property determines which of the type-specific properties are relevant. When evaluated on a cluster, the condition may match, not match, or fail to evaluate.",
541 "type": "type represents the cluster-condition type. This defines the members and semantics of any additional properties.",
542 "promql": "promQL represents a cluster condition based on PromQL.",
543 }
544
545 func (ClusterCondition) SwaggerDoc() map[string]string {
546 return map_ClusterCondition
547 }
548
549 var map_ClusterVersion = map[string]string{
550 "": "ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
551 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
552 "spec": "spec is the desired state of the cluster version - the operator will work to ensure that the desired version is applied to the cluster.",
553 "status": "status contains information about the available updates and any in-progress updates.",
554 }
555
556 func (ClusterVersion) SwaggerDoc() map[string]string {
557 return map_ClusterVersion
558 }
559
560 var map_ClusterVersionCapabilitiesSpec = map[string]string{
561 "": "ClusterVersionCapabilitiesSpec selects the managed set of optional, core cluster components.",
562 "baselineCapabilitySet": "baselineCapabilitySet selects an initial set of optional capabilities to enable, which can be extended via additionalEnabledCapabilities. If unset, the cluster will choose a default, and the default may change over time. The current default is vCurrent.",
563 "additionalEnabledCapabilities": "additionalEnabledCapabilities extends the set of managed capabilities beyond the baseline defined in baselineCapabilitySet. The default is an empty set.",
564 }
565
566 func (ClusterVersionCapabilitiesSpec) SwaggerDoc() map[string]string {
567 return map_ClusterVersionCapabilitiesSpec
568 }
569
570 var map_ClusterVersionCapabilitiesStatus = map[string]string{
571 "": "ClusterVersionCapabilitiesStatus describes the state of optional, core cluster components.",
572 "enabledCapabilities": "enabledCapabilities lists all the capabilities that are currently managed.",
573 "knownCapabilities": "knownCapabilities lists all the capabilities known to the current cluster.",
574 }
575
576 func (ClusterVersionCapabilitiesStatus) SwaggerDoc() map[string]string {
577 return map_ClusterVersionCapabilitiesStatus
578 }
579
580 var map_ClusterVersionList = map[string]string{
581 "": "ClusterVersionList is a list of ClusterVersion resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
582 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
583 }
584
585 func (ClusterVersionList) SwaggerDoc() map[string]string {
586 return map_ClusterVersionList
587 }
588
589 var map_ClusterVersionSpec = map[string]string{
590 "": "ClusterVersionSpec is the desired version state of the cluster. It includes the version the cluster should be at, how the cluster is identified, and where the cluster should look for version updates.",
591 "clusterID": "clusterID uniquely identifies this cluster. This is expected to be an RFC4122 UUID value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx in hexadecimal values). This is a required field.",
592 "desiredUpdate": "desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version). The set of recommended update values is listed as part of available updates in status, and setting values outside that range may cause the upgrade to fail.\n\nSome of the fields are inter-related with restrictions and meanings described here. 1. image is specified, version is specified, architecture is specified. API validation error. 2. image is specified, version is specified, architecture is not specified. You should not do this. version is silently ignored and image is used. 3. image is specified, version is not specified, architecture is specified. API validation error. 4. image is specified, version is not specified, architecture is not specified. image is used. 5. image is not specified, version is specified, architecture is specified. version and desired architecture are used to select an image. 6. image is not specified, version is specified, architecture is not specified. version and current architecture are used to select an image. 7. image is not specified, version is not specified, architecture is specified. API validation error. 8. image is not specified, version is not specified, architecture is not specified. API validation error.\n\nIf an upgrade fails the operator will halt and report status about the failing component. Setting the desired update value back to the previous version will cause a rollback to be attempted. Not all rollbacks will succeed.",
593 "upstream": "upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region.",
594 "channel": "channel is an identifier for explicitly requesting that a non-default set of updates be applied to this cluster. The default channel will be contain stable updates that are appropriate for production clusters.",
595 "capabilities": "capabilities configures the installation of optional, core cluster components. A null value here is identical to an empty object; see the child properties for default semantics.",
596 "overrides": "overrides is list of overides for components that are managed by cluster version operator. Marking a component unmanaged will prevent the operator from creating or updating the object.",
597 }
598
599 func (ClusterVersionSpec) SwaggerDoc() map[string]string {
600 return map_ClusterVersionSpec
601 }
602
603 var map_ClusterVersionStatus = map[string]string{
604 "": "ClusterVersionStatus reports the status of the cluster versioning, including any upgrades that are in progress. The current field will be set to whichever version the cluster is reconciling to, and the conditions array will report whether the update succeeded, is in progress, or is failing.",
605 "desired": "desired is the version that the cluster is reconciling towards. If the cluster is not yet fully initialized desired will be set with the information available, which may be an image or a tag.",
606 "history": "history contains a list of the most recent versions applied to the cluster. This value may be empty during cluster startup, and then will be updated when a new update is being applied. The newest update is first in the list and it is ordered by recency. Updates in the history have state Completed if the rollout completed - if an update was failing or halfway applied the state will be Partial. Only a limited amount of update history is preserved.",
607 "observedGeneration": "observedGeneration reports which version of the spec is being synced. If this value is not equal to metadata.generation, then the desired and conditions fields may represent a previous version.",
608 "versionHash": "versionHash is a fingerprint of the content that the cluster will be updated with. It is used by the operator to avoid unnecessary work and is for internal use only.",
609 "capabilities": "capabilities describes the state of optional, core cluster components.",
610 "conditions": "conditions provides information about the cluster version. The condition \"Available\" is set to true if the desiredUpdate has been reached. The condition \"Progressing\" is set to true if an update is being applied. The condition \"Degraded\" is set to true if an update is currently blocked by a temporary or permanent error. Conditions are only valid for the current desiredUpdate when metadata.generation is equal to status.generation.",
611 "availableUpdates": "availableUpdates contains updates recommended for this cluster. Updates which appear in conditionalUpdates but not in availableUpdates may expose this cluster to known issues. This list may be empty if no updates are recommended, if the update service is unavailable, or if an invalid channel has been specified.",
612 "conditionalUpdates": "conditionalUpdates contains the list of updates that may be recommended for this cluster if it meets specific required conditions. Consumers interested in the set of updates that are actually recommended for this cluster should use availableUpdates. This list may be empty if no updates are recommended, if the update service is unavailable, or if an empty or invalid channel has been specified.",
613 }
614
615 func (ClusterVersionStatus) SwaggerDoc() map[string]string {
616 return map_ClusterVersionStatus
617 }
618
619 var map_ComponentOverride = map[string]string{
620 "": "ComponentOverride allows overriding cluster version operator's behavior for a component.",
621 "kind": "kind indentifies which object to override.",
622 "group": "group identifies the API group that the kind is in.",
623 "namespace": "namespace is the component's namespace. If the resource is cluster scoped, the namespace should be empty.",
624 "name": "name is the component's name.",
625 "unmanaged": "unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false",
626 }
627
628 func (ComponentOverride) SwaggerDoc() map[string]string {
629 return map_ComponentOverride
630 }
631
632 var map_ConditionalUpdate = map[string]string{
633 "": "ConditionalUpdate represents an update which is recommended to some clusters on the version the current cluster is reconciling, but which may not be recommended for the current cluster.",
634 "release": "release is the target of the update.",
635 "risks": "risks represents the range of issues associated with updating to the target release. The cluster-version operator will evaluate all entries, and only recommend the update if there is at least one entry and all entries recommend the update.",
636 "conditions": "conditions represents the observations of the conditional update's current status. Known types are: * Evaluating, for whether the cluster-version operator will attempt to evaluate any risks[].matchingRules. * Recommended, for whether the update is recommended for the current cluster.",
637 }
638
639 func (ConditionalUpdate) SwaggerDoc() map[string]string {
640 return map_ConditionalUpdate
641 }
642
643 var map_ConditionalUpdateRisk = map[string]string{
644 "": "ConditionalUpdateRisk represents a reason and cluster-state for not recommending a conditional update.",
645 "url": "url contains information about this risk.",
646 "name": "name is the CamelCase reason for not recommending a conditional update, in the event that matchingRules match the cluster state.",
647 "message": "message provides additional information about the risk of updating, in the event that matchingRules match the cluster state. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
648 "matchingRules": "matchingRules is a slice of conditions for deciding which clusters match the risk and which do not. The slice is ordered by decreasing precedence. The cluster-version operator will walk the slice in order, and stop after the first it can successfully evaluate. If no condition can be successfully evaluated, the update will not be recommended.",
649 }
650
651 func (ConditionalUpdateRisk) SwaggerDoc() map[string]string {
652 return map_ConditionalUpdateRisk
653 }
654
655 var map_PromQLClusterCondition = map[string]string{
656 "": "PromQLClusterCondition represents a cluster condition based on PromQL.",
657 "promql": "PromQL is a PromQL query classifying clusters. This query query should return a 1 in the match case and a 0 in the does-not-match case. Queries which return no time series, or which return values besides 0 or 1, are evaluation failures.",
658 }
659
660 func (PromQLClusterCondition) SwaggerDoc() map[string]string {
661 return map_PromQLClusterCondition
662 }
663
664 var map_Release = map[string]string{
665 "": "Release represents an OpenShift release image and associated metadata.",
666 "version": "version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.",
667 "image": "image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified and the availableUpdates field contains a matching version.",
668 "url": "url contains information about this release. This URL is set by the 'url' metadata property on a release or the metadata returned by the update API and should be displayed as a link in user interfaces. The URL field may not be set for test or nightly releases.",
669 "channels": "channels is the set of Cincinnati channels to which the release currently belongs.",
670 }
671
672 func (Release) SwaggerDoc() map[string]string {
673 return map_Release
674 }
675
676 var map_Update = map[string]string{
677 "": "Update represents an administrator update request.",
678 "architecture": "architecture is an optional field that indicates the desired value of the cluster architecture. In this context cluster architecture means either a single architecture or a multi architecture. architecture can only be set to Multi thereby only allowing updates from single to multi architecture. If architecture is set, image cannot be set and version must be set. Valid values are 'Multi' and empty.",
679 "version": "version is a semantic version identifying the update version. version is ignored if image is specified and required if architecture is specified.",
680 "image": "image is a container image location that contains the update. image should be used when the desired version does not exist in availableUpdates or history. When image is set, version is ignored. When image is set, version should be empty. When image is set, architecture cannot be specified.",
681 "force": "force allows an administrator to update to an image that has failed verification or upgradeable checks. This option should only be used when the authenticity of the provided image has been verified out of band because the provided image will run with full administrative access to the cluster. Do not use this flag with images that comes from unknown or potentially malicious sources.",
682 }
683
684 func (Update) SwaggerDoc() map[string]string {
685 return map_Update
686 }
687
688 var map_UpdateHistory = map[string]string{
689 "": "UpdateHistory is a single attempted update to the cluster.",
690 "state": "state reflects whether the update was fully applied. The Partial state indicates the update is not fully applied, while the Completed state indicates the update was successfully rolled out at least once (all parts of the update successfully applied).",
691 "startedTime": "startedTime is the time at which the update was started.",
692 "completionTime": "completionTime, if set, is when the update was fully applied. The update that is currently being applied will have a null completion time. Completion time will always be set for entries that are not the current update (usually to the started time of the next update).",
693 "version": "version is a semantic version identifying the update version. If the requested image does not define a version, or if a failure occurs retrieving the image, this value may be empty.",
694 "image": "image is a container image location that contains the update. This value is always populated.",
695 "verified": "verified indicates whether the provided update was properly verified before it was installed. If this is false the cluster may not be trusted. Verified does not cover upgradeable checks that depend on the cluster state at the time when the update target was accepted.",
696 "acceptedRisks": "acceptedRisks records risks which were accepted to initiate the update. For example, it may menition an Upgradeable=False or missing signature that was overriden via desiredUpdate.force, or an update that was initiated despite not being in the availableUpdates set of recommended update targets.",
697 }
698
699 func (UpdateHistory) SwaggerDoc() map[string]string {
700 return map_UpdateHistory
701 }
702
703 var map_Console = map[string]string{
704 "": "Console holds cluster-wide configuration for the web console, including the logout URL, and reports the public URL of the console. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
705 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
706 "spec": "spec holds user settable values for configuration",
707 "status": "status holds observed values from the cluster. They may not be overridden.",
708 }
709
710 func (Console) SwaggerDoc() map[string]string {
711 return map_Console
712 }
713
714 var map_ConsoleAuthentication = map[string]string{
715 "": "ConsoleAuthentication defines a list of optional configuration for console authentication.",
716 "logoutRedirect": "An optional, absolute URL to redirect web browsers to after logging out of the console. If not specified, it will redirect to the default login page. This is required when using an identity provider that supports single sign-on (SSO) such as: - OpenID (Keycloak, Azure) - RequestHeader (GSSAPI, SSPI, SAML) - OAuth (GitHub, GitLab, Google) Logging out of the console will destroy the user's token. The logoutRedirect provides the user the option to perform single logout (SLO) through the identity provider to destroy their single sign-on session.",
717 }
718
719 func (ConsoleAuthentication) SwaggerDoc() map[string]string {
720 return map_ConsoleAuthentication
721 }
722
723 var map_ConsoleList = map[string]string{
724 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
725 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
726 }
727
728 func (ConsoleList) SwaggerDoc() map[string]string {
729 return map_ConsoleList
730 }
731
732 var map_ConsoleSpec = map[string]string{
733 "": "ConsoleSpec is the specification of the desired behavior of the Console.",
734 }
735
736 func (ConsoleSpec) SwaggerDoc() map[string]string {
737 return map_ConsoleSpec
738 }
739
740 var map_ConsoleStatus = map[string]string{
741 "": "ConsoleStatus defines the observed status of the Console.",
742 "consoleURL": "The URL for the console. This will be derived from the host for the route that is created for the console.",
743 }
744
745 func (ConsoleStatus) SwaggerDoc() map[string]string {
746 return map_ConsoleStatus
747 }
748
749 var map_DNS = map[string]string{
750 "": "DNS holds cluster-wide information about DNS. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
751 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
752 "spec": "spec holds user settable values for configuration",
753 "status": "status holds observed values from the cluster. They may not be overridden.",
754 }
755
756 func (DNS) SwaggerDoc() map[string]string {
757 return map_DNS
758 }
759
760 var map_DNSList = map[string]string{
761 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
762 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
763 }
764
765 func (DNSList) SwaggerDoc() map[string]string {
766 return map_DNSList
767 }
768
769 var map_DNSSpec = map[string]string{
770 "baseDomain": "baseDomain is the base domain of the cluster. All managed DNS records will be sub-domains of this base.\n\nFor example, given the base domain `openshift.example.com`, an API server DNS record may be created for `cluster-api.openshift.example.com`.\n\nOnce set, this field cannot be changed.",
771 "publicZone": "publicZone is the location where all the DNS records that are publicly accessible to the internet exist.\n\nIf this field is nil, no public records should be created.\n\nOnce set, this field cannot be changed.",
772 "privateZone": "privateZone is the location where all the DNS records that are only available internally to the cluster exist.\n\nIf this field is nil, no private records should be created.\n\nOnce set, this field cannot be changed.",
773 }
774
775 func (DNSSpec) SwaggerDoc() map[string]string {
776 return map_DNSSpec
777 }
778
779 var map_DNSZone = map[string]string{
780 "": "DNSZone is used to define a DNS hosted zone. A zone can be identified by an ID or tags.",
781 "id": "id is the identifier that can be used to find the DNS hosted zone.\n\non AWS zone can be fetched using `ID` as id in [1] on Azure zone can be fetched using `ID` as a pre-determined name in [2], on GCP zone can be fetched using `ID` as a pre-determined name in [3].\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get",
782 "tags": "tags can be used to query the DNS hosted zone.\n\non AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options",
783 }
784
785 func (DNSZone) SwaggerDoc() map[string]string {
786 return map_DNSZone
787 }
788
789 var map_CustomFeatureGates = map[string]string{
790 "enabled": "enabled is a list of all feature gates that you want to force on",
791 "disabled": "disabled is a list of all feature gates that you want to force off",
792 }
793
794 func (CustomFeatureGates) SwaggerDoc() map[string]string {
795 return map_CustomFeatureGates
796 }
797
798 var map_FeatureGate = map[string]string{
799 "": "Feature holds cluster-wide information about feature gates. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
800 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
801 "spec": "spec holds user settable values for configuration",
802 "status": "status holds observed values from the cluster. They may not be overridden.",
803 }
804
805 func (FeatureGate) SwaggerDoc() map[string]string {
806 return map_FeatureGate
807 }
808
809 var map_FeatureGateAttributes = map[string]string{
810 "name": "name is the name of the FeatureGate.",
811 }
812
813 func (FeatureGateAttributes) SwaggerDoc() map[string]string {
814 return map_FeatureGateAttributes
815 }
816
817 var map_FeatureGateDetails = map[string]string{
818 "version": "version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field.",
819 "enabled": "enabled is a list of all feature gates that are enabled in the cluster for the named version.",
820 "disabled": "disabled is a list of all feature gates that are disabled in the cluster for the named version.",
821 }
822
823 func (FeatureGateDetails) SwaggerDoc() map[string]string {
824 return map_FeatureGateDetails
825 }
826
827 var map_FeatureGateList = map[string]string{
828 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
829 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
830 }
831
832 func (FeatureGateList) SwaggerDoc() map[string]string {
833 return map_FeatureGateList
834 }
835
836 var map_FeatureGateSelection = map[string]string{
837 "featureSet": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
838 "customNoUpgrade": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
839 }
840
841 func (FeatureGateSelection) SwaggerDoc() map[string]string {
842 return map_FeatureGateSelection
843 }
844
845 var map_FeatureGateStatus = map[string]string{
846 "conditions": "conditions represent the observations of the current state. Known .status.conditions.type are: \"DeterminationDegraded\"",
847 "featureGates": "featureGates contains a list of enabled and disabled featureGates that are keyed by payloadVersion. Operators other than the CVO and cluster-config-operator, must read the .status.featureGates, locate the version they are managing, find the enabled/disabled featuregates and make the operand and operator match. The enabled/disabled values for a particular version may change during the life of the cluster as various .spec.featureSet values are selected. Operators may choose to restart their processes to pick up these changes, but remembering past enable/disable lists is beyond the scope of this API and is the responsibility of individual operators. Only featureGates with .version in the ClusterVersion.status will be present in this list.",
848 }
849
850 func (FeatureGateStatus) SwaggerDoc() map[string]string {
851 return map_FeatureGateStatus
852 }
853
854 var map_Image = map[string]string{
855 "": "Image governs policies related to imagestream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing OpenShift's image registry to the public, this also lets cluster admins specify the external hostname.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
856 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
857 "spec": "spec holds user settable values for configuration",
858 "status": "status holds observed values from the cluster. They may not be overridden.",
859 }
860
861 func (Image) SwaggerDoc() map[string]string {
862 return map_Image
863 }
864
865 var map_ImageList = map[string]string{
866 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
867 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
868 }
869
870 func (ImageList) SwaggerDoc() map[string]string {
871 return map_ImageList
872 }
873
874 var map_ImageSpec = map[string]string{
875 "allowedRegistriesForImport": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
876 "externalRegistryHostnames": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
877 "additionalTrustedCA": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.",
878 "registrySources": "registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access). It does not contain configuration for the internal cluster registry.",
879 }
880
881 func (ImageSpec) SwaggerDoc() map[string]string {
882 return map_ImageSpec
883 }
884
885 var map_ImageStatus = map[string]string{
886 "internalRegistryHostname": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. This value is set by the image registry operator which controls the internal registry hostname. For backward compatibility, users can still use OPENSHIFT_DEFAULT_REGISTRY environment variable but this setting overrides the environment variable.",
887 "externalRegistryHostnames": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
888 }
889
890 func (ImageStatus) SwaggerDoc() map[string]string {
891 return map_ImageStatus
892 }
893
894 var map_RegistryLocation = map[string]string{
895 "": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
896 "domainName": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
897 "insecure": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
898 }
899
900 func (RegistryLocation) SwaggerDoc() map[string]string {
901 return map_RegistryLocation
902 }
903
904 var map_RegistrySources = map[string]string{
905 "": "RegistrySources holds cluster-wide information about how to handle the registries config.",
906 "insecureRegistries": "insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.",
907 "blockedRegistries": "blockedRegistries cannot be used for image pull and push actions. All other registries are permitted.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
908 "allowedRegistries": "allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
909 "containerRuntimeSearchRegistries": "containerRuntimeSearchRegistries are registries that will be searched when pulling images that do not have fully qualified domains in their pull specs. Registries will be searched in the order provided in the list. Note: this search list only works with the container runtime, i.e CRI-O. Will NOT work with builds or imagestream imports.",
910 }
911
912 func (RegistrySources) SwaggerDoc() map[string]string {
913 return map_RegistrySources
914 }
915
916 var map_ImageContentPolicy = map[string]string{
917 "": "ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
918 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
919 "spec": "spec holds user settable values for configuration",
920 }
921
922 func (ImageContentPolicy) SwaggerDoc() map[string]string {
923 return map_ImageContentPolicy
924 }
925
926 var map_ImageContentPolicyList = map[string]string{
927 "": "ImageContentPolicyList lists the items in the ImageContentPolicy CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
928 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
929 }
930
931 func (ImageContentPolicyList) SwaggerDoc() map[string]string {
932 return map_ImageContentPolicyList
933 }
934
935 var map_ImageContentPolicySpec = map[string]string{
936 "": "ImageContentPolicySpec is the specification of the ImageContentPolicy CRD.",
937 "repositoryDigestMirrors": "repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To pull image from mirrors by tags, should set the \"allowMirrorByTags\".\n\nEach “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.",
938 }
939
940 func (ImageContentPolicySpec) SwaggerDoc() map[string]string {
941 return map_ImageContentPolicySpec
942 }
943
944 var map_RepositoryDigestMirrors = map[string]string{
945 "": "RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
946 "source": "source is the repository that users refer to, e.g. in image pull specifications.",
947 "allowMirrorByTags": "allowMirrorByTags if true, the mirrors can be used to pull the images that are referenced by their tags. Default is false, the mirrors only work when pulling the images that are referenced by their digests. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Forcing digest-pulls for mirrors avoids that issue.",
948 "mirrors": "mirrors is zero or more repositories that may also contain the same images. If the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec. No mirror will be configured. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. Other cluster configuration, including (but not limited to) other repositoryDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering.",
949 }
950
951 func (RepositoryDigestMirrors) SwaggerDoc() map[string]string {
952 return map_RepositoryDigestMirrors
953 }
954
955 var map_ImageDigestMirrorSet = map[string]string{
956 "": "ImageDigestMirrorSet holds cluster-wide information about how to handle registry mirror rules on using digest pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
957 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
958 "spec": "spec holds user settable values for configuration",
959 "status": "status contains the observed state of the resource.",
960 }
961
962 func (ImageDigestMirrorSet) SwaggerDoc() map[string]string {
963 return map_ImageDigestMirrorSet
964 }
965
966 var map_ImageDigestMirrorSetList = map[string]string{
967 "": "ImageDigestMirrorSetList lists the items in the ImageDigestMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
968 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
969 }
970
971 func (ImageDigestMirrorSetList) SwaggerDoc() map[string]string {
972 return map_ImageDigestMirrorSetList
973 }
974
975 var map_ImageDigestMirrorSetSpec = map[string]string{
976 "": "ImageDigestMirrorSetSpec is the specification of the ImageDigestMirrorSet CRD.",
977 "imageDigestMirrors": "imageDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using tag specification, users should configure a list of mirrors using \"ImageTagMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagedigestmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a specific order of mirrors, should configure them into one list of mirrors using the expected order.",
978 }
979
980 func (ImageDigestMirrorSetSpec) SwaggerDoc() map[string]string {
981 return map_ImageDigestMirrorSetSpec
982 }
983
984 var map_ImageDigestMirrors = map[string]string{
985 "": "ImageDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
986 "source": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
987 "mirrors": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\" Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
988 "mirrorSourcePolicy": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
989 }
990
991 func (ImageDigestMirrors) SwaggerDoc() map[string]string {
992 return map_ImageDigestMirrors
993 }
994
995 var map_ImageTagMirrorSet = map[string]string{
996 "": "ImageTagMirrorSet holds cluster-wide information about how to handle registry mirror rules on using tag pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
997 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
998 "spec": "spec holds user settable values for configuration",
999 "status": "status contains the observed state of the resource.",
1000 }
1001
1002 func (ImageTagMirrorSet) SwaggerDoc() map[string]string {
1003 return map_ImageTagMirrorSet
1004 }
1005
1006 var map_ImageTagMirrorSetList = map[string]string{
1007 "": "ImageTagMirrorSetList lists the items in the ImageTagMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1008 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1009 }
1010
1011 func (ImageTagMirrorSetList) SwaggerDoc() map[string]string {
1012 return map_ImageTagMirrorSetList
1013 }
1014
1015 var map_ImageTagMirrorSetSpec = map[string]string{
1016 "": "ImageTagMirrorSetSpec is the specification of the ImageTagMirrorSet CRD.",
1017 "imageTagMirrors": "imageTagMirrors allows images referenced by image tags in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageTagMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using digest specification only, users should configure a list of mirrors using \"ImageDigestMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagetagmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a deterministic order of mirrors, should configure them into one list of mirrors using the expected order.",
1018 }
1019
1020 func (ImageTagMirrorSetSpec) SwaggerDoc() map[string]string {
1021 return map_ImageTagMirrorSetSpec
1022 }
1023
1024 var map_ImageTagMirrors = map[string]string{
1025 "": "ImageTagMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
1026 "source": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
1027 "mirrors": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their tags. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Configuring a list of mirrors using \"ImageDigestMirrorSet\" CRD and forcing digest-pulls for mirrors avoids that issue. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\". Other cluster configuration, including (but not limited to) other imageTagMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
1028 "mirrorSourcePolicy": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
1029 }
1030
1031 func (ImageTagMirrors) SwaggerDoc() map[string]string {
1032 return map_ImageTagMirrors
1033 }
1034
1035 var map_AWSPlatformSpec = map[string]string{
1036 "": "AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
1037 "serviceEndpoints": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
1038 }
1039
1040 func (AWSPlatformSpec) SwaggerDoc() map[string]string {
1041 return map_AWSPlatformSpec
1042 }
1043
1044 var map_AWSPlatformStatus = map[string]string{
1045 "": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.",
1046 "region": "region holds the default AWS region for new AWS resources created by the cluster.",
1047 "serviceEndpoints": "ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
1048 "resourceTags": "resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.",
1049 }
1050
1051 func (AWSPlatformStatus) SwaggerDoc() map[string]string {
1052 return map_AWSPlatformStatus
1053 }
1054
1055 var map_AWSResourceTag = map[string]string{
1056 "": "AWSResourceTag is a tag to apply to AWS resources created for the cluster.",
1057 "key": "key is the key of the tag",
1058 "value": "value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.",
1059 }
1060
1061 func (AWSResourceTag) SwaggerDoc() map[string]string {
1062 return map_AWSResourceTag
1063 }
1064
1065 var map_AWSServiceEndpoint = map[string]string{
1066 "": "AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.",
1067 "name": "name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.",
1068 "url": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
1069 }
1070
1071 func (AWSServiceEndpoint) SwaggerDoc() map[string]string {
1072 return map_AWSServiceEndpoint
1073 }
1074
1075 var map_AlibabaCloudPlatformSpec = map[string]string{
1076 "": "AlibabaCloudPlatformSpec holds the desired state of the Alibaba Cloud infrastructure provider. This only includes fields that can be modified in the cluster.",
1077 }
1078
1079 func (AlibabaCloudPlatformSpec) SwaggerDoc() map[string]string {
1080 return map_AlibabaCloudPlatformSpec
1081 }
1082
1083 var map_AlibabaCloudPlatformStatus = map[string]string{
1084 "": "AlibabaCloudPlatformStatus holds the current status of the Alibaba Cloud infrastructure provider.",
1085 "region": "region specifies the region for Alibaba Cloud resources created for the cluster.",
1086 "resourceGroupID": "resourceGroupID is the ID of the resource group for the cluster.",
1087 "resourceTags": "resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.",
1088 }
1089
1090 func (AlibabaCloudPlatformStatus) SwaggerDoc() map[string]string {
1091 return map_AlibabaCloudPlatformStatus
1092 }
1093
1094 var map_AlibabaCloudResourceTag = map[string]string{
1095 "": "AlibabaCloudResourceTag is the set of tags to add to apply to resources.",
1096 "key": "key is the key of the tag.",
1097 "value": "value is the value of the tag.",
1098 }
1099
1100 func (AlibabaCloudResourceTag) SwaggerDoc() map[string]string {
1101 return map_AlibabaCloudResourceTag
1102 }
1103
1104 var map_AzurePlatformSpec = map[string]string{
1105 "": "AzurePlatformSpec holds the desired state of the Azure infrastructure provider. This only includes fields that can be modified in the cluster.",
1106 }
1107
1108 func (AzurePlatformSpec) SwaggerDoc() map[string]string {
1109 return map_AzurePlatformSpec
1110 }
1111
1112 var map_AzurePlatformStatus = map[string]string{
1113 "": "AzurePlatformStatus holds the current status of the Azure infrastructure provider.",
1114 "resourceGroupName": "resourceGroupName is the Resource Group for new Azure resources created for the cluster.",
1115 "networkResourceGroupName": "networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.",
1116 "cloudName": "cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to `AzurePublicCloud`.",
1117 "armEndpoint": "armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack.",
1118 "resourceTags": "resourceTags is a list of additional tags to apply to Azure resources created for the cluster. See https://docs.microsoft.com/en-us/rest/api/resources/tags for information on tagging Azure resources. Due to limitations on Automation, Content Delivery Network, DNS Azure resources, a maximum of 15 tags may be applied. OpenShift reserves 5 tags for internal use, allowing 10 tags for user configuration.",
1119 }
1120
1121 func (AzurePlatformStatus) SwaggerDoc() map[string]string {
1122 return map_AzurePlatformStatus
1123 }
1124
1125 var map_AzureResourceTag = map[string]string{
1126 "": "AzureResourceTag is a tag to apply to Azure resources created for the cluster.",
1127 "key": "key is the key part of the tag. A tag key can have a maximum of 128 characters and cannot be empty. Key must begin with a letter, end with a letter, number or underscore, and must contain only alphanumeric characters and the following special characters `_ . -`.",
1128 "value": "value is the value part of the tag. A tag value can have a maximum of 256 characters and cannot be empty. Value must contain only alphanumeric characters and the following special characters `_ + , - . / : ; < = > ? @`.",
1129 }
1130
1131 func (AzureResourceTag) SwaggerDoc() map[string]string {
1132 return map_AzureResourceTag
1133 }
1134
1135 var map_BareMetalPlatformLoadBalancer = map[string]string{
1136 "": "BareMetalPlatformLoadBalancer defines the load balancer used by the cluster on BareMetal platform.",
1137 "type": "type defines the type of load balancer used by the cluster on BareMetal platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
1138 }
1139
1140 func (BareMetalPlatformLoadBalancer) SwaggerDoc() map[string]string {
1141 return map_BareMetalPlatformLoadBalancer
1142 }
1143
1144 var map_BareMetalPlatformSpec = map[string]string{
1145 "": "BareMetalPlatformSpec holds the desired state of the BareMetal infrastructure provider. This only includes fields that can be modified in the cluster.",
1146 }
1147
1148 func (BareMetalPlatformSpec) SwaggerDoc() map[string]string {
1149 return map_BareMetalPlatformSpec
1150 }
1151
1152 var map_BareMetalPlatformStatus = map[string]string{
1153 "": "BareMetalPlatformStatus holds the current status of the BareMetal infrastructure provider. For more information about the network architecture used with the BareMetal platform type, see: https://github.com/openshift/installer/blob/master/docs/design/baremetal/networking-infrastructure.md",
1154 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
1155 "apiServerInternalIPs": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
1156 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
1157 "ingressIPs": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
1158 "nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
1159 "loadBalancer": "loadBalancer defines how the load balancer used by the cluster is configured.",
1160 }
1161
1162 func (BareMetalPlatformStatus) SwaggerDoc() map[string]string {
1163 return map_BareMetalPlatformStatus
1164 }
1165
1166 var map_EquinixMetalPlatformSpec = map[string]string{
1167 "": "EquinixMetalPlatformSpec holds the desired state of the Equinix Metal infrastructure provider. This only includes fields that can be modified in the cluster.",
1168 }
1169
1170 func (EquinixMetalPlatformSpec) SwaggerDoc() map[string]string {
1171 return map_EquinixMetalPlatformSpec
1172 }
1173
1174 var map_EquinixMetalPlatformStatus = map[string]string{
1175 "": "EquinixMetalPlatformStatus holds the current status of the Equinix Metal infrastructure provider.",
1176 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
1177 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
1178 }
1179
1180 func (EquinixMetalPlatformStatus) SwaggerDoc() map[string]string {
1181 return map_EquinixMetalPlatformStatus
1182 }
1183
1184 var map_ExternalPlatformSpec = map[string]string{
1185 "": "ExternalPlatformSpec holds the desired state for the generic External infrastructure provider.",
1186 "platformName": "PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. This field is solely for informational and reporting purposes and is not expected to be used for decision-making.",
1187 }
1188
1189 func (ExternalPlatformSpec) SwaggerDoc() map[string]string {
1190 return map_ExternalPlatformSpec
1191 }
1192
1193 var map_ExternalPlatformStatus = map[string]string{
1194 "": "ExternalPlatformStatus holds the current status of the generic External infrastructure provider.",
1195 }
1196
1197 func (ExternalPlatformStatus) SwaggerDoc() map[string]string {
1198 return map_ExternalPlatformStatus
1199 }
1200
1201 var map_GCPPlatformSpec = map[string]string{
1202 "": "GCPPlatformSpec holds the desired state of the Google Cloud Platform infrastructure provider. This only includes fields that can be modified in the cluster.",
1203 }
1204
1205 func (GCPPlatformSpec) SwaggerDoc() map[string]string {
1206 return map_GCPPlatformSpec
1207 }
1208
1209 var map_GCPPlatformStatus = map[string]string{
1210 "": "GCPPlatformStatus holds the current status of the Google Cloud Platform infrastructure provider.",
1211 "projectID": "resourceGroupName is the Project ID for new GCP resources created for the cluster.",
1212 "region": "region holds the region for new GCP resources created for the cluster.",
1213 }
1214
1215 func (GCPPlatformStatus) SwaggerDoc() map[string]string {
1216 return map_GCPPlatformStatus
1217 }
1218
1219 var map_IBMCloudPlatformSpec = map[string]string{
1220 "": "IBMCloudPlatformSpec holds the desired state of the IBMCloud infrastructure provider. This only includes fields that can be modified in the cluster.",
1221 }
1222
1223 func (IBMCloudPlatformSpec) SwaggerDoc() map[string]string {
1224 return map_IBMCloudPlatformSpec
1225 }
1226
1227 var map_IBMCloudPlatformStatus = map[string]string{
1228 "": "IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.",
1229 "location": "Location is where the cluster has been deployed",
1230 "resourceGroupName": "ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.",
1231 "providerType": "ProviderType indicates the type of cluster that was created",
1232 "cisInstanceCRN": "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
1233 "dnsInstanceCRN": "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
1234 }
1235
1236 func (IBMCloudPlatformStatus) SwaggerDoc() map[string]string {
1237 return map_IBMCloudPlatformStatus
1238 }
1239
1240 var map_Infrastructure = map[string]string{
1241 "": "Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1242 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1243 "spec": "spec holds user settable values for configuration",
1244 "status": "status holds observed values from the cluster. They may not be overridden.",
1245 }
1246
1247 func (Infrastructure) SwaggerDoc() map[string]string {
1248 return map_Infrastructure
1249 }
1250
1251 var map_InfrastructureList = map[string]string{
1252 "": "InfrastructureList is\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1253 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1254 }
1255
1256 func (InfrastructureList) SwaggerDoc() map[string]string {
1257 return map_InfrastructureList
1258 }
1259
1260 var map_InfrastructureSpec = map[string]string{
1261 "": "InfrastructureSpec contains settings that apply to the cluster infrastructure.",
1262 "cloudConfig": "cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.\n\ncloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.",
1263 "platformSpec": "platformSpec holds desired information specific to the underlying infrastructure provider.",
1264 }
1265
1266 func (InfrastructureSpec) SwaggerDoc() map[string]string {
1267 return map_InfrastructureSpec
1268 }
1269
1270 var map_InfrastructureStatus = map[string]string{
1271 "": "InfrastructureStatus describes the infrastructure the cluster is leveraging.",
1272 "infrastructureName": "infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.",
1273 "platform": "platform is the underlying infrastructure provider for the cluster.\n\nDeprecated: Use platformStatus.type instead.",
1274 "platformStatus": "platformStatus holds status information specific to the underlying infrastructure provider.",
1275 "etcdDiscoveryDomain": "etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.",
1276 "apiServerURL": "apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.",
1277 "apiServerInternalURI": "apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.",
1278 "controlPlaneTopology": "controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster.",
1279 "infrastructureTopology": "infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a `role` value other than `master`. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation NOTE: External topology mode is not applicable for this field.",
1280 "cpuPartitioning": "cpuPartitioning expresses if CPU partitioning is a currently enabled feature in the cluster. CPU Partitioning means that this cluster can support partitioning workloads to specific CPU Sets. Valid values are \"None\" and \"AllNodes\". When omitted, the default value is \"None\". The default value of \"None\" indicates that no nodes will be setup with CPU partitioning. The \"AllNodes\" value indicates that all nodes have been setup with CPU partitioning, and can then be further configured via the PerformanceProfile API.",
1281 }
1282
1283 func (InfrastructureStatus) SwaggerDoc() map[string]string {
1284 return map_InfrastructureStatus
1285 }
1286
1287 var map_KubevirtPlatformSpec = map[string]string{
1288 "": "KubevirtPlatformSpec holds the desired state of the kubevirt infrastructure provider. This only includes fields that can be modified in the cluster.",
1289 }
1290
1291 func (KubevirtPlatformSpec) SwaggerDoc() map[string]string {
1292 return map_KubevirtPlatformSpec
1293 }
1294
1295 var map_KubevirtPlatformStatus = map[string]string{
1296 "": "KubevirtPlatformStatus holds the current status of the kubevirt infrastructure provider.",
1297 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
1298 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
1299 }
1300
1301 func (KubevirtPlatformStatus) SwaggerDoc() map[string]string {
1302 return map_KubevirtPlatformStatus
1303 }
1304
1305 var map_NutanixPlatformLoadBalancer = map[string]string{
1306 "": "NutanixPlatformLoadBalancer defines the load balancer used by the cluster on Nutanix platform.",
1307 "type": "type defines the type of load balancer used by the cluster on Nutanix platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
1308 }
1309
1310 func (NutanixPlatformLoadBalancer) SwaggerDoc() map[string]string {
1311 return map_NutanixPlatformLoadBalancer
1312 }
1313
1314 var map_NutanixPlatformSpec = map[string]string{
1315 "": "NutanixPlatformSpec holds the desired state of the Nutanix infrastructure provider. This only includes fields that can be modified in the cluster.",
1316 "prismCentral": "prismCentral holds the endpoint address and port to access the Nutanix Prism Central. When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
1317 "prismElements": "prismElements holds one or more endpoint address and port data to access the Nutanix Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.) used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.) spread over multiple Prism Elements (clusters) of the Prism Central.",
1318 }
1319
1320 func (NutanixPlatformSpec) SwaggerDoc() map[string]string {
1321 return map_NutanixPlatformSpec
1322 }
1323
1324 var map_NutanixPlatformStatus = map[string]string{
1325 "": "NutanixPlatformStatus holds the current status of the Nutanix infrastructure provider.",
1326 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
1327 "apiServerInternalIPs": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
1328 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
1329 "ingressIPs": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
1330 "loadBalancer": "loadBalancer defines how the load balancer used by the cluster is configured.",
1331 }
1332
1333 func (NutanixPlatformStatus) SwaggerDoc() map[string]string {
1334 return map_NutanixPlatformStatus
1335 }
1336
1337 var map_NutanixPrismElementEndpoint = map[string]string{
1338 "": "NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)",
1339 "name": "name is the name of the Prism Element (cluster). This value will correspond with the cluster field configured on other resources (eg Machines, PVCs, etc).",
1340 "endpoint": "endpoint holds the endpoint address and port data of the Prism Element (cluster). When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
1341 }
1342
1343 func (NutanixPrismElementEndpoint) SwaggerDoc() map[string]string {
1344 return map_NutanixPrismElementEndpoint
1345 }
1346
1347 var map_NutanixPrismEndpoint = map[string]string{
1348 "": "NutanixPrismEndpoint holds the endpoint address and port to access the Nutanix Prism Central or Element (cluster)",
1349 "address": "address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)",
1350 "port": "port is the port number to access the Nutanix Prism Central or Element (cluster)",
1351 }
1352
1353 func (NutanixPrismEndpoint) SwaggerDoc() map[string]string {
1354 return map_NutanixPrismEndpoint
1355 }
1356
1357 var map_OpenStackPlatformLoadBalancer = map[string]string{
1358 "": "OpenStackPlatformLoadBalancer defines the load balancer used by the cluster on OpenStack platform.",
1359 "type": "type defines the type of load balancer used by the cluster on OpenStack platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
1360 }
1361
1362 func (OpenStackPlatformLoadBalancer) SwaggerDoc() map[string]string {
1363 return map_OpenStackPlatformLoadBalancer
1364 }
1365
1366 var map_OpenStackPlatformSpec = map[string]string{
1367 "": "OpenStackPlatformSpec holds the desired state of the OpenStack infrastructure provider. This only includes fields that can be modified in the cluster.",
1368 }
1369
1370 func (OpenStackPlatformSpec) SwaggerDoc() map[string]string {
1371 return map_OpenStackPlatformSpec
1372 }
1373
1374 var map_OpenStackPlatformStatus = map[string]string{
1375 "": "OpenStackPlatformStatus holds the current status of the OpenStack infrastructure provider.",
1376 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
1377 "apiServerInternalIPs": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
1378 "cloudName": "cloudName is the name of the desired OpenStack cloud in the client configuration file (`clouds.yaml`).",
1379 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
1380 "ingressIPs": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
1381 "nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
1382 "loadBalancer": "loadBalancer defines how the load balancer used by the cluster is configured.",
1383 }
1384
1385 func (OpenStackPlatformStatus) SwaggerDoc() map[string]string {
1386 return map_OpenStackPlatformStatus
1387 }
1388
1389 var map_OvirtPlatformLoadBalancer = map[string]string{
1390 "": "OvirtPlatformLoadBalancer defines the load balancer used by the cluster on Ovirt platform.",
1391 "type": "type defines the type of load balancer used by the cluster on Ovirt platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
1392 }
1393
1394 func (OvirtPlatformLoadBalancer) SwaggerDoc() map[string]string {
1395 return map_OvirtPlatformLoadBalancer
1396 }
1397
1398 var map_OvirtPlatformSpec = map[string]string{
1399 "": "OvirtPlatformSpec holds the desired state of the oVirt infrastructure provider. This only includes fields that can be modified in the cluster.",
1400 }
1401
1402 func (OvirtPlatformSpec) SwaggerDoc() map[string]string {
1403 return map_OvirtPlatformSpec
1404 }
1405
1406 var map_OvirtPlatformStatus = map[string]string{
1407 "": "OvirtPlatformStatus holds the current status of the oVirt infrastructure provider.",
1408 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
1409 "apiServerInternalIPs": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
1410 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
1411 "ingressIPs": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
1412 "nodeDNSIP": "deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.",
1413 "loadBalancer": "loadBalancer defines how the load balancer used by the cluster is configured.",
1414 }
1415
1416 func (OvirtPlatformStatus) SwaggerDoc() map[string]string {
1417 return map_OvirtPlatformStatus
1418 }
1419
1420 var map_PlatformSpec = map[string]string{
1421 "": "PlatformSpec holds the desired state specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
1422 "type": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
1423 "aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.",
1424 "azure": "Azure contains settings specific to the Azure infrastructure provider.",
1425 "gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.",
1426 "baremetal": "BareMetal contains settings specific to the BareMetal platform.",
1427 "openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.",
1428 "ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.",
1429 "vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.",
1430 "ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.",
1431 "kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.",
1432 "equinixMetal": "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
1433 "powervs": "PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.",
1434 "alibabaCloud": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
1435 "nutanix": "Nutanix contains settings specific to the Nutanix infrastructure provider.",
1436 "external": "ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.",
1437 }
1438
1439 func (PlatformSpec) SwaggerDoc() map[string]string {
1440 return map_PlatformSpec
1441 }
1442
1443 var map_PlatformStatus = map[string]string{
1444 "": "PlatformStatus holds the current status specific to the underlying infrastructure provider of the current cluster. Since these are used at status-level for the underlying cluster, it is supposed that only one of the status structs is set.",
1445 "type": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.\n\nThis value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.",
1446 "aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.",
1447 "azure": "Azure contains settings specific to the Azure infrastructure provider.",
1448 "gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.",
1449 "baremetal": "BareMetal contains settings specific to the BareMetal platform.",
1450 "openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.",
1451 "ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.",
1452 "vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.",
1453 "ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.",
1454 "kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.",
1455 "equinixMetal": "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
1456 "powervs": "PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.",
1457 "alibabaCloud": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
1458 "nutanix": "Nutanix contains settings specific to the Nutanix infrastructure provider.",
1459 "external": "External contains settings specific to the generic External infrastructure provider.",
1460 }
1461
1462 func (PlatformStatus) SwaggerDoc() map[string]string {
1463 return map_PlatformStatus
1464 }
1465
1466 var map_PowerVSPlatformSpec = map[string]string{
1467 "": "PowerVSPlatformSpec holds the desired state of the IBM Power Systems Virtual Servers infrastructure provider. This only includes fields that can be modified in the cluster.",
1468 "serviceEndpoints": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
1469 }
1470
1471 func (PowerVSPlatformSpec) SwaggerDoc() map[string]string {
1472 return map_PowerVSPlatformSpec
1473 }
1474
1475 var map_PowerVSPlatformStatus = map[string]string{
1476 "": "PowerVSPlatformStatus holds the current status of the IBM Power Systems Virtual Servers infrastrucutre provider.",
1477 "region": "region holds the default Power VS region for new Power VS resources created by the cluster.",
1478 "zone": "zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported",
1479 "resourceGroup": "resourceGroup is the resource group name for new IBMCloud resources created for a cluster. The resource group specified here will be used by cluster-image-registry-operator to set up a COS Instance in IBMCloud for the cluster registry. More about resource groups can be found here: https://cloud.ibm.com/docs/account?topic=account-rgs. When omitted, the image registry operator won't be able to configure storage, which results in the image registry cluster operator not being in an available state.",
1480 "serviceEndpoints": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
1481 "cisInstanceCRN": "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
1482 "dnsInstanceCRN": "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
1483 }
1484
1485 func (PowerVSPlatformStatus) SwaggerDoc() map[string]string {
1486 return map_PowerVSPlatformStatus
1487 }
1488
1489 var map_PowerVSServiceEndpoint = map[string]string{
1490 "": "PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.",
1491 "name": "name is the name of the Power VS service. Few of the services are IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud",
1492 "url": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
1493 }
1494
1495 func (PowerVSServiceEndpoint) SwaggerDoc() map[string]string {
1496 return map_PowerVSServiceEndpoint
1497 }
1498
1499 var map_VSpherePlatformFailureDomainSpec = map[string]string{
1500 "": "VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.",
1501 "name": "name defines the arbitrary but unique name of a failure domain.",
1502 "region": "region defines the name of a region tag that will be attached to a vCenter datacenter. The tag category in vCenter must be named openshift-region.",
1503 "zone": "zone defines the name of a zone tag that will be attached to a vCenter cluster. The tag category in vCenter must be named openshift-zone.",
1504 "server": "server is the fully-qualified domain name or the IP address of the vCenter server.",
1505 "topology": "Topology describes a given failure domain using vSphere constructs",
1506 }
1507
1508 func (VSpherePlatformFailureDomainSpec) SwaggerDoc() map[string]string {
1509 return map_VSpherePlatformFailureDomainSpec
1510 }
1511
1512 var map_VSpherePlatformLoadBalancer = map[string]string{
1513 "": "VSpherePlatformLoadBalancer defines the load balancer used by the cluster on VSphere platform.",
1514 "type": "type defines the type of load balancer used by the cluster on VSphere platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
1515 }
1516
1517 func (VSpherePlatformLoadBalancer) SwaggerDoc() map[string]string {
1518 return map_VSpherePlatformLoadBalancer
1519 }
1520
1521 var map_VSpherePlatformNodeNetworking = map[string]string{
1522 "": "VSpherePlatformNodeNetworking holds the external and internal node networking spec.",
1523 "external": "external represents the network configuration of the node that is externally routable.",
1524 "internal": "internal represents the network configuration of the node that is routable only within the cluster.",
1525 }
1526
1527 func (VSpherePlatformNodeNetworking) SwaggerDoc() map[string]string {
1528 return map_VSpherePlatformNodeNetworking
1529 }
1530
1531 var map_VSpherePlatformNodeNetworkingSpec = map[string]string{
1532 "": "VSpherePlatformNodeNetworkingSpec holds the network CIDR(s) and port group name for including and excluding IP ranges in the cloud provider. This would be used for example when multiple network adapters are attached to a guest to help determine which IP address the cloud config manager should use for the external and internal node networking.",
1533 "networkSubnetCidr": "networkSubnetCidr IP address on VirtualMachine's network interfaces included in the fields' CIDRs that will be used in respective status.addresses fields.",
1534 "network": "network VirtualMachine's VM Network names that will be used to when searching for status.addresses fields. Note that if internal.networkSubnetCIDR and external.networkSubnetCIDR are not set, then the vNIC associated to this network must only have a single IP address assigned to it. The available networks (port groups) can be listed using `govc ls 'network/*'`",
1535 "excludeNetworkSubnetCidr": "excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting the IP address from the VirtualMachine's VM for use in the status.addresses fields.",
1536 }
1537
1538 func (VSpherePlatformNodeNetworkingSpec) SwaggerDoc() map[string]string {
1539 return map_VSpherePlatformNodeNetworkingSpec
1540 }
1541
1542 var map_VSpherePlatformSpec = map[string]string{
1543 "": "VSpherePlatformSpec holds the desired state of the vSphere infrastructure provider. In the future the cloud provider operator, storage operator and machine operator will use these fields for configuration.",
1544 "vcenters": "vcenters holds the connection details for services to communicate with vCenter. Currently, only a single vCenter is supported.",
1545 "failureDomains": "failureDomains contains the definition of region, zone and the vCenter topology. If this is omitted failure domains (regions and zones) will not be used.",
1546 "nodeNetworking": "nodeNetworking contains the definition of internal and external network constraints for assigning the node's networking. If this field is omitted, networking defaults to the legacy address selection behavior which is to only support a single address and return the first one found.",
1547 }
1548
1549 func (VSpherePlatformSpec) SwaggerDoc() map[string]string {
1550 return map_VSpherePlatformSpec
1551 }
1552
1553 var map_VSpherePlatformStatus = map[string]string{
1554 "": "VSpherePlatformStatus holds the current status of the vSphere infrastructure provider.",
1555 "apiServerInternalIP": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
1556 "apiServerInternalIPs": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
1557 "ingressIP": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
1558 "ingressIPs": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
1559 "nodeDNSIP": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
1560 "loadBalancer": "loadBalancer defines how the load balancer used by the cluster is configured.",
1561 }
1562
1563 func (VSpherePlatformStatus) SwaggerDoc() map[string]string {
1564 return map_VSpherePlatformStatus
1565 }
1566
1567 var map_VSpherePlatformTopology = map[string]string{
1568 "": "VSpherePlatformTopology holds the required and optional vCenter objects - datacenter, computeCluster, networks, datastore and resourcePool - to provision virtual machines.",
1569 "datacenter": "datacenter is the name of vCenter datacenter in which virtual machines will be located. The maximum length of the datacenter name is 80 characters.",
1570 "computeCluster": "computeCluster the absolute path of the vCenter cluster in which virtual machine will be located. The absolute path is of the form /<datacenter>/host/<cluster>. The maximum length of the path is 2048 characters.",
1571 "networks": "networks is the list of port group network names within this failure domain. Currently, we only support a single interface per RHCOS virtual machine. The available networks (port groups) can be listed using `govc ls 'network/*'` The single interface should be the absolute path of the form /<datacenter>/network/<portgroup>.",
1572 "datastore": "datastore is the absolute path of the datastore in which the virtual machine is located. The absolute path is of the form /<datacenter>/datastore/<datastore> The maximum length of the path is 2048 characters.",
1573 "resourcePool": "resourcePool is the absolute path of the resource pool where virtual machines will be created. The absolute path is of the form /<datacenter>/host/<cluster>/Resources/<resourcepool>. The maximum length of the path is 2048 characters.",
1574 "folder": "folder is the absolute path of the folder where virtual machines are located. The absolute path is of the form /<datacenter>/vm/<folder>. The maximum length of the path is 2048 characters.",
1575 }
1576
1577 func (VSpherePlatformTopology) SwaggerDoc() map[string]string {
1578 return map_VSpherePlatformTopology
1579 }
1580
1581 var map_VSpherePlatformVCenterSpec = map[string]string{
1582 "": "VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.",
1583 "server": "server is the fully-qualified domain name or the IP address of the vCenter server.",
1584 "port": "port is the TCP port that will be used to communicate to the vCenter endpoint. When omitted, this means the user has no opinion and it is up to the platform to choose a sensible default, which is subject to change over time.",
1585 "datacenters": "The vCenter Datacenters in which the RHCOS vm guests are located. This field will be used by the Cloud Controller Manager. Each datacenter listed here should be used within a topology.",
1586 }
1587
1588 func (VSpherePlatformVCenterSpec) SwaggerDoc() map[string]string {
1589 return map_VSpherePlatformVCenterSpec
1590 }
1591
1592 var map_AWSIngressSpec = map[string]string{
1593 "": "AWSIngressSpec holds the desired state of the Ingress for Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
1594 "type": "type allows user to set a load balancer type. When this field is set the default ingresscontroller will get created using the specified LBType. If this field is not set then the default ingress controller of LBType Classic will be created. Valid 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",
1595 }
1596
1597 func (AWSIngressSpec) SwaggerDoc() map[string]string {
1598 return map_AWSIngressSpec
1599 }
1600
1601 var map_ComponentRouteSpec = map[string]string{
1602 "": "ComponentRouteSpec allows for configuration of a route's hostname and serving certificate.",
1603 "namespace": "namespace is the namespace of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
1604 "name": "name is the logical name of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
1605 "hostname": "hostname is the hostname that should be used by the route.",
1606 "servingCertKeyPairSecret": "servingCertKeyPairSecret is a reference to a secret of type `kubernetes.io/tls` in the openshift-config namespace. The serving cert/key pair must match and will be used by the operator to fulfill the intent of serving with this name. If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.",
1607 }
1608
1609 func (ComponentRouteSpec) SwaggerDoc() map[string]string {
1610 return map_ComponentRouteSpec
1611 }
1612
1613 var map_ComponentRouteStatus = map[string]string{
1614 "": "ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate.",
1615 "namespace": "namespace is the namespace of the route to customize. It must be a real namespace. Using an actual namespace ensures that no two components will conflict and the same component can be installed multiple times.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
1616 "name": "name is the logical name of the route to customize. It does not have to be the actual name of a route resource but it cannot be renamed.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
1617 "defaultHostname": "defaultHostname is the hostname of this route prior to customization.",
1618 "consumingUsers": "consumingUsers is a slice of ServiceAccounts that need to have read permission on the servingCertKeyPairSecret secret.",
1619 "currentHostnames": "currentHostnames is the list of current names used by the route. Typically, this list should consist of a single hostname, but if multiple hostnames are supported by the route the operator may write multiple entries to this list.",
1620 "conditions": "conditions are used to communicate the state of the componentRoutes entry.\n\nSupported conditions include Available, Degraded and Progressing.\n\nIf available is true, the content served by the route can be accessed by users. This includes cases where a default may continue to serve content while the customized route specified by the cluster-admin is being configured.\n\nIf Degraded is true, that means something has gone wrong trying to handle the componentRoutes entry. The currentHostnames field may or may not be in effect.\n\nIf Progressing is true, that means the component is taking some action related to the componentRoutes entry.",
1621 "relatedObjects": "relatedObjects is a list of resources which are useful when debugging or inspecting how spec.componentRoutes is applied.",
1622 }
1623
1624 func (ComponentRouteStatus) SwaggerDoc() map[string]string {
1625 return map_ComponentRouteStatus
1626 }
1627
1628 var map_Ingress = map[string]string{
1629 "": "Ingress holds cluster-wide information about ingress, including the default ingress domain used for routes. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1630 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1631 "spec": "spec holds user settable values for configuration",
1632 "status": "status holds observed values from the cluster. They may not be overridden.",
1633 }
1634
1635 func (Ingress) SwaggerDoc() map[string]string {
1636 return map_Ingress
1637 }
1638
1639 var map_IngressList = map[string]string{
1640 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1641 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1642 }
1643
1644 func (IngressList) SwaggerDoc() map[string]string {
1645 return map_IngressList
1646 }
1647
1648 var map_IngressPlatformSpec = map[string]string{
1649 "": "IngressPlatformSpec holds the desired state of Ingress specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
1650 "type": "type is the underlying infrastructure provider for the cluster. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
1651 "aws": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
1652 }
1653
1654 func (IngressPlatformSpec) SwaggerDoc() map[string]string {
1655 return map_IngressPlatformSpec
1656 }
1657
1658 var map_IngressSpec = map[string]string{
1659 "domain": "domain is used to generate a default host name for a route when the route's host name is empty. The generated host name will follow this pattern: \"<route-name>.<route-namespace>.<domain>\".\n\nIt is also used as the default wildcard domain suffix for ingress. The default ingresscontroller domain will follow this pattern: \"*.<domain>\".\n\nOnce set, changing domain is not currently supported.",
1660 "appsDomain": "appsDomain is an optional domain to use instead of the one specified in the domain field when a Route is created without specifying an explicit host. If appsDomain is nonempty, this value is used to generate default host values for Route. Unlike domain, appsDomain may be modified after installation. This assumes a new ingresscontroller has been setup with a wildcard certificate.",
1661 "componentRoutes": "componentRoutes is an optional list of routes that are managed by OpenShift components that a cluster-admin is able to configure the hostname and serving certificate for. The namespace and name of each route in this list should match an existing entry in the status.componentRoutes list.\n\nTo determine the set of configurable Routes, look at namespace and name of entries in the .status.componentRoutes list, where participating operators write the status of configurable routes.",
1662 "requiredHSTSPolicies": "requiredHSTSPolicies specifies HSTS policies that are required to be set on newly created or updated routes matching the domainPattern/s and namespaceSelector/s that are specified in the policy. Each requiredHSTSPolicy must have at least a domainPattern and a maxAge to validate a route HSTS Policy route annotation, and affect route admission.\n\nA candidate route is checked for HSTS Policies if it has the HSTS Policy route annotation: \"haproxy.router.openshift.io/hsts_header\" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains\n\n- For each candidate route, if it matches a requiredHSTSPolicy domainPattern and optional namespaceSelector, then the maxAge, preloadPolicy, and includeSubdomainsPolicy must be valid to be admitted. Otherwise, the route is rejected. - The first match, by domainPattern and optional namespaceSelector, in the ordering of the RequiredHSTSPolicies determines the route's admission status. - If the candidate route doesn't match any requiredHSTSPolicy domainPattern and optional namespaceSelector, then it may use any HSTS Policy annotation.\n\nThe HSTS policy configuration may be changed after routes have already been created. An update to a previously admitted route may then fail if the updated route does not conform to the updated HSTS policy configuration. However, changing the HSTS policy configuration will not cause a route that is already admitted to stop working.\n\nNote that if there are no RequiredHSTSPolicies, any HSTS Policy annotation on the route is valid.",
1663 "loadBalancer": "loadBalancer contains the load balancer details in general which are not only specific to the underlying infrastructure provider of the current cluster and are required for Ingress Controller to work on OpenShift.",
1664 }
1665
1666 func (IngressSpec) SwaggerDoc() map[string]string {
1667 return map_IngressSpec
1668 }
1669
1670 var map_IngressStatus = map[string]string{
1671 "componentRoutes": "componentRoutes is where participating operators place the current route status for routes whose hostnames and serving certificates can be customized by the cluster-admin.",
1672 "defaultPlacement": "defaultPlacement is set at installation time to control which nodes will host the ingress router pods by default. The options are control-plane nodes or worker nodes.\n\nThis field works by dictating how the Cluster Ingress Operator will consider unset replicas and nodePlacement fields in IngressController resources when creating the corresponding Deployments.\n\nSee the documentation for the IngressController replicas and nodePlacement fields for more information.\n\nWhen omitted, the default value is Workers",
1673 }
1674
1675 func (IngressStatus) SwaggerDoc() map[string]string {
1676 return map_IngressStatus
1677 }
1678
1679 var map_LoadBalancer = map[string]string{
1680 "platform": "platform holds configuration specific to the underlying infrastructure provider for the ingress load balancers. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
1681 }
1682
1683 func (LoadBalancer) SwaggerDoc() map[string]string {
1684 return map_LoadBalancer
1685 }
1686
1687 var map_ClusterNetworkEntry = map[string]string{
1688 "": "ClusterNetworkEntry is a contiguous block of IP addresses from which pod IPs are allocated.",
1689 "cidr": "The complete block for pod IPs.",
1690 "hostPrefix": "The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset.",
1691 }
1692
1693 func (ClusterNetworkEntry) SwaggerDoc() map[string]string {
1694 return map_ClusterNetworkEntry
1695 }
1696
1697 var map_ExternalIPConfig = map[string]string{
1698 "": "ExternalIPConfig specifies some IP blocks relevant for the ExternalIP field of a Service resource.",
1699 "policy": "policy is a set of restrictions applied to the ExternalIP field. If nil or empty, then ExternalIP is not allowed to be set.",
1700 "autoAssignCIDRs": "autoAssignCIDRs is a list of CIDRs from which to automatically assign Service.ExternalIP. These are assigned when the service is of type LoadBalancer. In general, this is only useful for bare-metal clusters. In Openshift 3.x, this was misleadingly called \"IngressIPs\". Automatically assigned External IPs are not affected by any ExternalIPPolicy rules. Currently, only one entry may be provided.",
1701 }
1702
1703 func (ExternalIPConfig) SwaggerDoc() map[string]string {
1704 return map_ExternalIPConfig
1705 }
1706
1707 var map_ExternalIPPolicy = map[string]string{
1708 "": "ExternalIPPolicy configures exactly which IPs are allowed for the ExternalIP field in a Service. If the zero struct is supplied, then none are permitted. The policy controller always allows automatically assigned external IPs.",
1709 "allowedCIDRs": "allowedCIDRs is the list of allowed CIDRs.",
1710 "rejectedCIDRs": "rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs.",
1711 }
1712
1713 func (ExternalIPPolicy) SwaggerDoc() map[string]string {
1714 return map_ExternalIPPolicy
1715 }
1716
1717 var map_MTUMigration = map[string]string{
1718 "": "MTUMigration contains infomation about MTU migration.",
1719 "network": "Network contains MTU migration configuration for the default network.",
1720 "machine": "Machine contains MTU migration configuration for the machine's uplink.",
1721 }
1722
1723 func (MTUMigration) SwaggerDoc() map[string]string {
1724 return map_MTUMigration
1725 }
1726
1727 var map_MTUMigrationValues = map[string]string{
1728 "": "MTUMigrationValues contains the values for a MTU migration.",
1729 "to": "To is the MTU to migrate to.",
1730 "from": "From is the MTU to migrate from.",
1731 }
1732
1733 func (MTUMigrationValues) SwaggerDoc() map[string]string {
1734 return map_MTUMigrationValues
1735 }
1736
1737 var map_Network = map[string]string{
1738 "": "Network holds cluster-wide information about Network. The canonical name is `cluster`. It is used to configure the desired network configuration, such as: IP address pools for services/pod IPs, network plugin, etc. Please view network.spec for an explanation on what applies when configuring this resource.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1739 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1740 "spec": "spec holds user settable values for configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
1741 "status": "status holds observed values from the cluster. They may not be overridden.",
1742 }
1743
1744 func (Network) SwaggerDoc() map[string]string {
1745 return map_Network
1746 }
1747
1748 var map_NetworkList = map[string]string{
1749 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1750 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1751 }
1752
1753 func (NetworkList) SwaggerDoc() map[string]string {
1754 return map_NetworkList
1755 }
1756
1757 var map_NetworkMigration = map[string]string{
1758 "": "NetworkMigration represents the cluster network configuration.",
1759 "networkType": "NetworkType is the target plugin that is to be deployed. Currently supported values are: OpenShiftSDN, OVNKubernetes",
1760 "mtu": "MTU contains the MTU migration configuration.",
1761 }
1762
1763 func (NetworkMigration) SwaggerDoc() map[string]string {
1764 return map_NetworkMigration
1765 }
1766
1767 var map_NetworkSpec = map[string]string{
1768 "": "NetworkSpec is the desired network configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
1769 "clusterNetwork": "IP address pool to use for pod IPs. This field is immutable after installation.",
1770 "serviceNetwork": "IP address pool for services. Currently, we only support a single entry here. This field is immutable after installation.",
1771 "networkType": "NetworkType is the plugin that is to be deployed (e.g. OpenShiftSDN). This should match a value that the cluster-network-operator understands, or else no networking will be installed. Currently supported values are: - OpenShiftSDN This field is immutable after installation.",
1772 "externalIP": "externalIP defines configuration for controllers that affect Service.ExternalIP. If nil, then ExternalIP is not allowed to be set.",
1773 "serviceNodePortRange": "The port range allowed for Services of type NodePort. If not specified, the default of 30000-32767 will be used. Such Services without a NodePort specified will have one automatically allocated from this range. This parameter can be updated after the cluster is installed.",
1774 }
1775
1776 func (NetworkSpec) SwaggerDoc() map[string]string {
1777 return map_NetworkSpec
1778 }
1779
1780 var map_NetworkStatus = map[string]string{
1781 "": "NetworkStatus is the current network configuration.",
1782 "clusterNetwork": "IP address pool to use for pod IPs.",
1783 "serviceNetwork": "IP address pool for services. Currently, we only support a single entry here.",
1784 "networkType": "NetworkType is the plugin that is deployed (e.g. OpenShiftSDN).",
1785 "clusterNetworkMTU": "ClusterNetworkMTU is the MTU for inter-pod networking.",
1786 "migration": "Migration contains the cluster network migration configuration.",
1787 }
1788
1789 func (NetworkStatus) SwaggerDoc() map[string]string {
1790 return map_NetworkStatus
1791 }
1792
1793 var map_Node = map[string]string{
1794 "": "Node holds cluster-wide information about node specific features.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1795 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1796 "spec": "spec holds user settable values for configuration",
1797 "status": "status holds observed values.",
1798 }
1799
1800 func (Node) SwaggerDoc() map[string]string {
1801 return map_Node
1802 }
1803
1804 var map_NodeList = map[string]string{
1805 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1806 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1807 }
1808
1809 func (NodeList) SwaggerDoc() map[string]string {
1810 return map_NodeList
1811 }
1812
1813 var map_NodeSpec = map[string]string{
1814 "cgroupMode": "CgroupMode determines the cgroups version on the node",
1815 "workerLatencyProfile": "WorkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster",
1816 }
1817
1818 func (NodeSpec) SwaggerDoc() map[string]string {
1819 return map_NodeSpec
1820 }
1821
1822 var map_BasicAuthIdentityProvider = map[string]string{
1823 "": "BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials",
1824 }
1825
1826 func (BasicAuthIdentityProvider) SwaggerDoc() map[string]string {
1827 return map_BasicAuthIdentityProvider
1828 }
1829
1830 var map_GitHubIdentityProvider = map[string]string{
1831 "": "GitHubIdentityProvider provides identities for users authenticating using GitHub credentials",
1832 "clientID": "clientID is the oauth client ID",
1833 "clientSecret": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
1834 "organizations": "organizations optionally restricts which organizations are allowed to log in",
1835 "teams": "teams optionally restricts which teams are allowed to log in. Format is <org>/<team>.",
1836 "hostname": "hostname is the optional domain (e.g. \"mycompany.com\") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value configured at /setup/settings#hostname.",
1837 "ca": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config.",
1838 }
1839
1840 func (GitHubIdentityProvider) SwaggerDoc() map[string]string {
1841 return map_GitHubIdentityProvider
1842 }
1843
1844 var map_GitLabIdentityProvider = map[string]string{
1845 "": "GitLabIdentityProvider provides identities for users authenticating using GitLab credentials",
1846 "clientID": "clientID is the oauth client ID",
1847 "clientSecret": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
1848 "url": "url is the oauth server base URL",
1849 "ca": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
1850 }
1851
1852 func (GitLabIdentityProvider) SwaggerDoc() map[string]string {
1853 return map_GitLabIdentityProvider
1854 }
1855
1856 var map_GoogleIdentityProvider = map[string]string{
1857 "": "GoogleIdentityProvider provides identities for users authenticating using Google credentials",
1858 "clientID": "clientID is the oauth client ID",
1859 "clientSecret": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
1860 "hostedDomain": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to",
1861 }
1862
1863 func (GoogleIdentityProvider) SwaggerDoc() map[string]string {
1864 return map_GoogleIdentityProvider
1865 }
1866
1867 var map_HTPasswdIdentityProvider = map[string]string{
1868 "": "HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials",
1869 "fileData": "fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key \"htpasswd\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
1870 }
1871
1872 func (HTPasswdIdentityProvider) SwaggerDoc() map[string]string {
1873 return map_HTPasswdIdentityProvider
1874 }
1875
1876 var map_IdentityProvider = map[string]string{
1877 "": "IdentityProvider provides identities for users authenticating using credentials",
1878 "name": "name is used to qualify the identities returned by this provider. - It MUST be unique and not shared by any other identity provider used - It MUST be a valid path segment: name cannot equal \".\" or \"..\" or contain \"/\" or \"%\" or \":\"\n Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName",
1879 "mappingMethod": "mappingMethod determines how identities from this provider are mapped to users Defaults to \"claim\"",
1880 }
1881
1882 func (IdentityProvider) SwaggerDoc() map[string]string {
1883 return map_IdentityProvider
1884 }
1885
1886 var map_IdentityProviderConfig = map[string]string{
1887 "": "IdentityProviderConfig contains configuration for using a specific identity provider",
1888 "type": "type identifies the identity provider type for this entry.",
1889 "basicAuth": "basicAuth contains configuration options for the BasicAuth IdP",
1890 "github": "github enables user authentication using GitHub credentials",
1891 "gitlab": "gitlab enables user authentication using GitLab credentials",
1892 "google": "google enables user authentication using Google credentials",
1893 "htpasswd": "htpasswd enables user authentication using an HTPasswd file to validate credentials",
1894 "keystone": "keystone enables user authentication using keystone password credentials",
1895 "ldap": "ldap enables user authentication using LDAP credentials",
1896 "openID": "openID enables user authentication using OpenID credentials",
1897 "requestHeader": "requestHeader enables user authentication using request header credentials",
1898 }
1899
1900 func (IdentityProviderConfig) SwaggerDoc() map[string]string {
1901 return map_IdentityProviderConfig
1902 }
1903
1904 var map_KeystoneIdentityProvider = map[string]string{
1905 "": "KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials",
1906 "domainName": "domainName is required for keystone v3",
1907 }
1908
1909 func (KeystoneIdentityProvider) SwaggerDoc() map[string]string {
1910 return map_KeystoneIdentityProvider
1911 }
1912
1913 var map_LDAPAttributeMapping = map[string]string{
1914 "": "LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields",
1915 "id": "id is the list of attributes whose values should be used as the user ID. Required. First non-empty attribute is used. At least one attribute is required. If none of the listed attribute have a value, authentication fails. LDAP standard identity attribute is \"dn\"",
1916 "preferredUsername": "preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"",
1917 "name": "name is the list of attributes whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity LDAP standard display name attribute is \"cn\"",
1918 "email": "email is the list of attributes whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
1919 }
1920
1921 func (LDAPAttributeMapping) SwaggerDoc() map[string]string {
1922 return map_LDAPAttributeMapping
1923 }
1924
1925 var map_LDAPIdentityProvider = map[string]string{
1926 "": "LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials",
1927 "url": "url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter",
1928 "bindDN": "bindDN is an optional DN to bind with during the search phase.",
1929 "bindPassword": "bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key \"bindPassword\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
1930 "insecure": "insecure, if true, indicates the connection should not use TLS WARNING: Should not be set to `true` with the URL scheme \"ldaps://\" as \"ldaps://\" URLs always\n attempt to connect using TLS, even when `insecure` is set to `true`\nWhen `true`, \"ldap://\" URLS connect insecurely. When `false`, \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830.",
1931 "ca": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
1932 "attributes": "attributes maps LDAP attributes to identities",
1933 }
1934
1935 func (LDAPIdentityProvider) SwaggerDoc() map[string]string {
1936 return map_LDAPIdentityProvider
1937 }
1938
1939 var map_OAuth = map[string]string{
1940 "": "OAuth holds cluster-wide information about OAuth. The canonical name is `cluster`. It is used to configure the integrated OAuth server. This configuration is only honored when the top level Authentication config has type set to IntegratedOAuth.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1941 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1942 "spec": "spec holds user settable values for configuration",
1943 "status": "status holds observed values from the cluster. They may not be overridden.",
1944 }
1945
1946 func (OAuth) SwaggerDoc() map[string]string {
1947 return map_OAuth
1948 }
1949
1950 var map_OAuthList = map[string]string{
1951 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
1952 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
1953 }
1954
1955 func (OAuthList) SwaggerDoc() map[string]string {
1956 return map_OAuthList
1957 }
1958
1959 var map_OAuthRemoteConnectionInfo = map[string]string{
1960 "": "OAuthRemoteConnectionInfo holds information necessary for establishing a remote connection",
1961 "url": "url is the remote URL to connect to",
1962 "ca": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
1963 "tlsClientCert": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
1964 "tlsClientKey": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
1965 }
1966
1967 func (OAuthRemoteConnectionInfo) SwaggerDoc() map[string]string {
1968 return map_OAuthRemoteConnectionInfo
1969 }
1970
1971 var map_OAuthSpec = map[string]string{
1972 "": "OAuthSpec contains desired cluster auth configuration",
1973 "identityProviders": "identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users.",
1974 "tokenConfig": "tokenConfig contains options for authorization and access tokens",
1975 "templates": "templates allow you to customize pages like the login page.",
1976 }
1977
1978 func (OAuthSpec) SwaggerDoc() map[string]string {
1979 return map_OAuthSpec
1980 }
1981
1982 var map_OAuthStatus = map[string]string{
1983 "": "OAuthStatus shows current known state of OAuth server in the cluster",
1984 }
1985
1986 func (OAuthStatus) SwaggerDoc() map[string]string {
1987 return map_OAuthStatus
1988 }
1989
1990 var map_OAuthTemplates = map[string]string{
1991 "": "OAuthTemplates allow for customization of pages like the login page",
1992 "login": "login is the name of a secret that specifies a go template to use to render the login page. The key \"login.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config.",
1993 "providerSelection": "providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key \"providers.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config.",
1994 "error": "error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key \"errors.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config.",
1995 }
1996
1997 func (OAuthTemplates) SwaggerDoc() map[string]string {
1998 return map_OAuthTemplates
1999 }
2000
2001 var map_OpenIDClaims = map[string]string{
2002 "": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider",
2003 "preferredUsername": "preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim",
2004 "name": "name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity",
2005 "email": "email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
2006 "groups": "groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user. If multiple claims are specified, the first one with a non-empty value is used.",
2007 }
2008
2009 func (OpenIDClaims) SwaggerDoc() map[string]string {
2010 return map_OpenIDClaims
2011 }
2012
2013 var map_OpenIDIdentityProvider = map[string]string{
2014 "": "OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials",
2015 "clientID": "clientID is the oauth client ID",
2016 "clientSecret": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
2017 "ca": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
2018 "extraScopes": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.",
2019 "extraAuthorizeParameters": "extraAuthorizeParameters are any custom parameters to add to the authorize request.",
2020 "issuer": "issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component.",
2021 "claims": "claims mappings",
2022 }
2023
2024 func (OpenIDIdentityProvider) SwaggerDoc() map[string]string {
2025 return map_OpenIDIdentityProvider
2026 }
2027
2028 var map_RequestHeaderIdentityProvider = map[string]string{
2029 "": "RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials",
2030 "loginURL": "loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when login is set to true.",
2031 "challengeURL": "challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here. ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when challenge is set to true.",
2032 "ca": "ca is a required reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key \"ca.crt\" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config.",
2033 "clientCommonNames": "clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative.",
2034 "headers": "headers is the set of headers to check for identity information",
2035 "preferredUsernameHeaders": "preferredUsernameHeaders is the set of headers to check for the preferred username",
2036 "nameHeaders": "nameHeaders is the set of headers to check for the display name",
2037 "emailHeaders": "emailHeaders is the set of headers to check for the email address",
2038 }
2039
2040 func (RequestHeaderIdentityProvider) SwaggerDoc() map[string]string {
2041 return map_RequestHeaderIdentityProvider
2042 }
2043
2044 var map_TokenConfig = map[string]string{
2045 "": "TokenConfig holds the necessary configuration options for authorization and access tokens",
2046 "accessTokenMaxAgeSeconds": "accessTokenMaxAgeSeconds defines the maximum age of access tokens",
2047 "accessTokenInactivityTimeoutSeconds": "accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect.",
2048 "accessTokenInactivityTimeout": "accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as \"5m\", \"1.5h\" or \"2h45m\". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime.\n\nWARNING: existing tokens' timeout will not be affected (lowered) by changing this value",
2049 }
2050
2051 func (TokenConfig) SwaggerDoc() map[string]string {
2052 return map_TokenConfig
2053 }
2054
2055 var map_HubSource = map[string]string{
2056 "": "HubSource is used to specify the hub source and its configuration",
2057 "name": "name is the name of one of the default hub sources",
2058 "disabled": "disabled is used to disable a default hub source on cluster",
2059 }
2060
2061 func (HubSource) SwaggerDoc() map[string]string {
2062 return map_HubSource
2063 }
2064
2065 var map_HubSourceStatus = map[string]string{
2066 "": "HubSourceStatus is used to reflect the current state of applying the configuration to a default source",
2067 "status": "status indicates success or failure in applying the configuration",
2068 "message": "message provides more information regarding failures",
2069 }
2070
2071 func (HubSourceStatus) SwaggerDoc() map[string]string {
2072 return map_HubSourceStatus
2073 }
2074
2075 var map_OperatorHub = map[string]string{
2076 "": "OperatorHub is the Schema for the operatorhubs API. It can be used to change the state of the default hub sources for OperatorHub on the cluster from enabled to disabled and vice versa.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2077 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2078 }
2079
2080 func (OperatorHub) SwaggerDoc() map[string]string {
2081 return map_OperatorHub
2082 }
2083
2084 var map_OperatorHubList = map[string]string{
2085 "": "OperatorHubList contains a list of OperatorHub\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2086 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2087 }
2088
2089 func (OperatorHubList) SwaggerDoc() map[string]string {
2090 return map_OperatorHubList
2091 }
2092
2093 var map_OperatorHubSpec = map[string]string{
2094 "": "OperatorHubSpec defines the desired state of OperatorHub",
2095 "disableAllDefaultSources": "disableAllDefaultSources allows you to disable all the default hub sources. If this is true, a specific entry in sources can be used to enable a default source. If this is false, a specific entry in sources can be used to disable or enable a default source.",
2096 "sources": "sources is the list of default hub sources and their configuration. If the list is empty, it implies that the default hub sources are enabled on the cluster unless disableAllDefaultSources is true. If disableAllDefaultSources is true and sources is not empty, the configuration present in sources will take precedence. The list of default hub sources and their current state will always be reflected in the status block.",
2097 }
2098
2099 func (OperatorHubSpec) SwaggerDoc() map[string]string {
2100 return map_OperatorHubSpec
2101 }
2102
2103 var map_OperatorHubStatus = map[string]string{
2104 "": "OperatorHubStatus defines the observed state of OperatorHub. The current state of the default hub sources will always be reflected here.",
2105 "sources": "sources encapsulates the result of applying the configuration for each hub source",
2106 }
2107
2108 func (OperatorHubStatus) SwaggerDoc() map[string]string {
2109 return map_OperatorHubStatus
2110 }
2111
2112 var map_Project = map[string]string{
2113 "": "Project holds cluster-wide information about Project. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2114 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2115 "spec": "spec holds user settable values for configuration",
2116 "status": "status holds observed values from the cluster. They may not be overridden.",
2117 }
2118
2119 func (Project) SwaggerDoc() map[string]string {
2120 return map_Project
2121 }
2122
2123 var map_ProjectList = map[string]string{
2124 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2125 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2126 }
2127
2128 func (ProjectList) SwaggerDoc() map[string]string {
2129 return map_ProjectList
2130 }
2131
2132 var map_ProjectSpec = map[string]string{
2133 "": "ProjectSpec holds the project creation configuration.",
2134 "projectRequestMessage": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint",
2135 "projectRequestTemplate": "projectRequestTemplate is the template to use for creating projects in response to projectrequest. This must point to a template in 'openshift-config' namespace. It is optional. If it is not specified, a default template is used.",
2136 }
2137
2138 func (ProjectSpec) SwaggerDoc() map[string]string {
2139 return map_ProjectSpec
2140 }
2141
2142 var map_TemplateReference = map[string]string{
2143 "": "TemplateReference references a template in a specific namespace. The namespace must be specified at the point of use.",
2144 "name": "name is the metadata.name of the referenced project request template",
2145 }
2146
2147 func (TemplateReference) SwaggerDoc() map[string]string {
2148 return map_TemplateReference
2149 }
2150
2151 var map_Proxy = map[string]string{
2152 "": "Proxy holds cluster-wide information on how to configure default proxies for the cluster. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2153 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2154 "spec": "Spec holds user-settable values for the proxy configuration",
2155 "status": "status holds observed values from the cluster. They may not be overridden.",
2156 }
2157
2158 func (Proxy) SwaggerDoc() map[string]string {
2159 return map_Proxy
2160 }
2161
2162 var map_ProxyList = map[string]string{
2163 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2164 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2165 }
2166
2167 func (ProxyList) SwaggerDoc() map[string]string {
2168 return map_ProxyList
2169 }
2170
2171 var map_ProxySpec = map[string]string{
2172 "": "ProxySpec contains cluster proxy creation configuration.",
2173 "httpProxy": "httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var.",
2174 "httpsProxy": "httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var.",
2175 "noProxy": "noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var.",
2176 "readinessEndpoints": "readinessEndpoints is a list of endpoints used to verify readiness of the proxy.",
2177 "trustedCA": "trustedCA is a reference to a ConfigMap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key \"ca-bundle.crt\", merging it with the system default trust bundle, and writing the merged trust bundle to a ConfigMap named \"trusted-ca-bundle\" in the \"openshift-config-managed\" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.\n\nThe namespace for the ConfigMap referenced by trustedCA is \"openshift-config\". Here is an example ConfigMap (in yaml):\n\napiVersion: v1 kind: ConfigMap metadata:\n name: user-ca-bundle\n namespace: openshift-config\n data:\n ca-bundle.crt: |",
2178 }
2179
2180 func (ProxySpec) SwaggerDoc() map[string]string {
2181 return map_ProxySpec
2182 }
2183
2184 var map_ProxyStatus = map[string]string{
2185 "": "ProxyStatus shows current known state of the cluster proxy.",
2186 "httpProxy": "httpProxy is the URL of the proxy for HTTP requests.",
2187 "httpsProxy": "httpsProxy is the URL of the proxy for HTTPS requests.",
2188 "noProxy": "noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used.",
2189 }
2190
2191 func (ProxyStatus) SwaggerDoc() map[string]string {
2192 return map_ProxyStatus
2193 }
2194
2195 var map_Scheduler = map[string]string{
2196 "": "Scheduler holds cluster-wide config information to run the Kubernetes Scheduler and influence its placement decisions. The canonical name for this config is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2197 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2198 "spec": "spec holds user settable values for configuration",
2199 "status": "status holds observed values from the cluster. They may not be overridden.",
2200 }
2201
2202 func (Scheduler) SwaggerDoc() map[string]string {
2203 return map_Scheduler
2204 }
2205
2206 var map_SchedulerList = map[string]string{
2207 "": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
2208 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
2209 }
2210
2211 func (SchedulerList) SwaggerDoc() map[string]string {
2212 return map_SchedulerList
2213 }
2214
2215 var map_SchedulerSpec = map[string]string{
2216 "policy": "DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release. policy is a reference to a ConfigMap containing scheduler policy which has user specified predicates and priorities. If this ConfigMap is not available scheduler will default to use DefaultAlgorithmProvider. The namespace for this configmap is openshift-config.",
2217 "profile": "profile sets which scheduling profile should be set in order to configure scheduling decisions for new pods.\n\nValid values are \"LowNodeUtilization\", \"HighNodeUtilization\", \"NoScoring\" Defaults to \"LowNodeUtilization\"",
2218 "defaultNodeSelector": "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
2219 "mastersSchedulable": "MastersSchedulable allows masters nodes to be schedulable. When this flag is turned on, all the master nodes in the cluster will be made schedulable, so that workload pods can run on them. The default value for this field is false, meaning none of the master nodes are schedulable. Important Note: Once the workload pods start running on the master nodes, extreme care must be taken to ensure that cluster-critical control plane components are not impacted. Please turn on this field after doing due diligence.",
2220 }
2221
2222 func (SchedulerSpec) SwaggerDoc() map[string]string {
2223 return map_SchedulerSpec
2224 }
2225
2226 var map_CustomTLSProfile = map[string]string{
2227 "": "CustomTLSProfile is a user-defined TLS security profile. Be extremely careful using a custom TLS profile as invalid configurations can be catastrophic.",
2228 }
2229
2230 func (CustomTLSProfile) SwaggerDoc() map[string]string {
2231 return map_CustomTLSProfile
2232 }
2233
2234 var map_IntermediateTLSProfile = map[string]string{
2235 "": "IntermediateTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29",
2236 }
2237
2238 func (IntermediateTLSProfile) SwaggerDoc() map[string]string {
2239 return map_IntermediateTLSProfile
2240 }
2241
2242 var map_ModernTLSProfile = map[string]string{
2243 "": "ModernTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility",
2244 }
2245
2246 func (ModernTLSProfile) SwaggerDoc() map[string]string {
2247 return map_ModernTLSProfile
2248 }
2249
2250 var map_OldTLSProfile = map[string]string{
2251 "": "OldTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility",
2252 }
2253
2254 func (OldTLSProfile) SwaggerDoc() map[string]string {
2255 return map_OldTLSProfile
2256 }
2257
2258 var map_TLSProfileSpec = map[string]string{
2259 "": "TLSProfileSpec is the desired behavior of a TLSSecurityProfile.",
2260 "ciphers": "ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):\n\n ciphers:\n - DES-CBC3-SHA",
2261 "minTLSVersion": "minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):\n\n minTLSVersion: TLSv1.1\n\nNOTE: currently the highest minTLSVersion allowed is VersionTLS12",
2262 }
2263
2264 func (TLSProfileSpec) SwaggerDoc() map[string]string {
2265 return map_TLSProfileSpec
2266 }
2267
2268 var map_TLSSecurityProfile = map[string]string{
2269 "": "TLSSecurityProfile defines the schema for a TLS security profile. This object is used by operators to apply TLS security settings to operands.",
2270 "type": "type is one of Old, Intermediate, Modern or Custom. Custom provides the ability to specify individual TLS security profile parameters. Old, Intermediate and Modern are TLS security profiles based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations\n\nThe profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be reduced.\n\nNote that the Modern profile is currently not supported because it is not yet well adopted by common software libraries.",
2271 "old": "old is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n - TLS_AES_128_GCM_SHA256\n - TLS_AES_256_GCM_SHA384\n - TLS_CHACHA20_POLY1305_SHA256\n - ECDHE-ECDSA-AES128-GCM-SHA256\n - ECDHE-RSA-AES128-GCM-SHA256\n - ECDHE-ECDSA-AES256-GCM-SHA384\n - ECDHE-RSA-AES256-GCM-SHA384\n - ECDHE-ECDSA-CHACHA20-POLY1305\n - ECDHE-RSA-CHACHA20-POLY1305\n - DHE-RSA-AES128-GCM-SHA256\n - DHE-RSA-AES256-GCM-SHA384\n - DHE-RSA-CHACHA20-POLY1305\n - ECDHE-ECDSA-AES128-SHA256\n - ECDHE-RSA-AES128-SHA256\n - ECDHE-ECDSA-AES128-SHA\n - ECDHE-RSA-AES128-SHA\n - ECDHE-ECDSA-AES256-SHA384\n - ECDHE-RSA-AES256-SHA384\n - ECDHE-ECDSA-AES256-SHA\n - ECDHE-RSA-AES256-SHA\n - DHE-RSA-AES128-SHA256\n - DHE-RSA-AES256-SHA256\n - AES128-GCM-SHA256\n - AES256-GCM-SHA384\n - AES128-SHA256\n - AES256-SHA256\n - AES128-SHA\n - AES256-SHA\n - DES-CBC3-SHA\n minTLSVersion: TLSv1.0",
2272 "intermediate": "intermediate is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29\n\nand looks like this (yaml):\n\n ciphers:\n - TLS_AES_128_GCM_SHA256\n - TLS_AES_256_GCM_SHA384\n - TLS_CHACHA20_POLY1305_SHA256\n - ECDHE-ECDSA-AES128-GCM-SHA256\n - ECDHE-RSA-AES128-GCM-SHA256\n - ECDHE-ECDSA-AES256-GCM-SHA384\n - ECDHE-RSA-AES256-GCM-SHA384\n - ECDHE-ECDSA-CHACHA20-POLY1305\n - ECDHE-RSA-CHACHA20-POLY1305\n - DHE-RSA-AES128-GCM-SHA256\n - DHE-RSA-AES256-GCM-SHA384\n minTLSVersion: TLSv1.2",
2273 "modern": "modern is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n - TLS_AES_128_GCM_SHA256\n - TLS_AES_256_GCM_SHA384\n - TLS_CHACHA20_POLY1305_SHA256\n minTLSVersion: TLSv1.3\n\nNOTE: Currently unsupported.",
2274 "custom": "custom is a user-defined TLS security profile. Be extremely careful using a custom profile as invalid configurations can be catastrophic. An example custom profile looks like this:\n\n ciphers:\n - ECDHE-ECDSA-CHACHA20-POLY1305\n - ECDHE-RSA-CHACHA20-POLY1305\n - ECDHE-RSA-AES128-GCM-SHA256\n - ECDHE-ECDSA-AES128-GCM-SHA256\n minTLSVersion: TLSv1.1",
2275 }
2276
2277 func (TLSSecurityProfile) SwaggerDoc() map[string]string {
2278 return map_TLSSecurityProfile
2279 }
2280
2281
2282
View as plain text