Documentation ¶
Overview ¶
+kubebuilder:validation:Optional +groupName=config.openshift.io Package v1 is the v1 version of the API.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type APIServer
- type APIServerEncryption
- type APIServerList
- type APIServerNamedServingCert
- type APIServerServingCerts
- type APIServerSpec
- type APIServerStatus
- type AWSDNSSpec
- type AWSIngressSpec
- type AWSLBType
- type AWSPlatformSpec
- type AWSPlatformStatus
- type AWSResourceTag
- type AWSServiceEndpoint
- type AdmissionConfig
- type AdmissionPluginConfig
- type AlibabaCloudPlatformSpec
- type AlibabaCloudPlatformStatus
- type AlibabaCloudResourceTag
- type Audit
- type AuditConfig
- type AuditCustomRule
- type AuditProfileType
- type Authentication
- type AuthenticationList
- type AuthenticationSpec
- type AuthenticationStatus
- type AuthenticationType
- type AzureCloudEnvironment
- type AzurePlatformSpec
- type AzurePlatformStatus
- type AzureResourceTag
- type BareMetalPlatformLoadBalancer
- type BareMetalPlatformSpec
- type BareMetalPlatformStatus
- type BasicAuthIdentityProvider
- type Build
- type BuildDefaults
- type BuildList
- type BuildOverrides
- type BuildSpec
- type CIDR
- type CPUPartitioningMode
- type CertInfo
- type CgroupMode
- type ClientConnectionOverrides
- type CloudControllerManagerState
- type CloudControllerManagerStatus
- type CloudLoadBalancerConfig
- type CloudLoadBalancerIPs
- type ClusterCondition
- type ClusterID
- type ClusterNetworkEntry
- type ClusterOperator
- type ClusterOperatorList
- type ClusterOperatorSpec
- type ClusterOperatorStatus
- type ClusterOperatorStatusCondition
- type ClusterStatusConditionType
- type ClusterVersion
- type ClusterVersionArchitecture
- type ClusterVersionCapabilitiesSpec
- type ClusterVersionCapabilitiesStatus
- type ClusterVersionCapability
- type ClusterVersionCapabilitySet
- type ClusterVersionList
- type ClusterVersionSpec
- type ClusterVersionStatus
- type ComponentOverride
- type ComponentRouteSpec
- type ComponentRouteStatus
- type ConditionStatus
- type ConditionalUpdate
- type ConditionalUpdateRisk
- type ConfigMapFileReference
- type ConfigMapNameReference
- type Console
- type ConsoleAuthentication
- type ConsoleList
- type ConsoleSpec
- type ConsoleStatus
- type ConsumingUser
- type CustomFeatureGates
- type CustomTLSProfile
- type DNS
- type DNSList
- type DNSPlatformSpec
- type DNSSpec
- type DNSStatus
- type DNSType
- type DNSZone
- type DRAEnablement
- type DefaultPlacement
- type DelegatedAuthentication
- type DelegatedAuthorization
- type DeprecatedWebhookTokenAuthenticator
- type EncryptionType
- type EquinixMetalPlatformSpec
- type EquinixMetalPlatformStatus
- type EtcdConnectionInfo
- type EtcdStorageConfig
- type ExternalIPConfig
- type ExternalIPPolicy
- type ExternalPlatformSpec
- type ExternalPlatformStatus
- type FeatureGate
- type FeatureGateAttributes
- type FeatureGateDetails
- type FeatureGateList
- type FeatureGateName
- type FeatureGateSelection
- type FeatureGateSpec
- type FeatureGateStatus
- type FeatureGateTests
- type FeatureSet
- type GCPPlatformSpec
- type GCPPlatformStatus
- type GCPResourceLabel
- type GCPResourceTag
- type GenericAPIServerConfig
- type GenericControllerConfig
- type GitHubIdentityProvider
- type GitLabIdentityProvider
- type GoogleIdentityProvider
- type HTPasswdIdentityProvider
- type HTTPServingInfo
- type Hostname
- type HubSource
- type HubSourceStatus
- type IBMCloudPlatformSpec
- type IBMCloudPlatformStatus
- type IBMCloudProviderType
- type IBMCloudServiceEndpoint
- type IBMCloudServiceName
- type IP
- type IdentityProvider
- type IdentityProviderConfig
- type IdentityProviderType
- type Image
- type ImageContentPolicy
- type ImageContentPolicyList
- type ImageContentPolicySpec
- type ImageDigestMirrorSet
- type ImageDigestMirrorSetList
- type ImageDigestMirrorSetSpec
- type ImageDigestMirrorSetStatus
- type ImageDigestMirrors
- type ImageLabel
- type ImageList
- type ImageMirror
- type ImageSpec
- type ImageStatus
- type ImageTagMirrorSet
- type ImageTagMirrorSetList
- type ImageTagMirrorSetSpec
- type ImageTagMirrorSetStatus
- type ImageTagMirrors
- type ImportModeType
- type IncludeSubDomainsPolicy
- type Infrastructure
- type InfrastructureList
- type InfrastructureSpec
- type InfrastructureStatus
- type Ingress
- type IngressList
- type IngressPlatformSpec
- type IngressSpec
- type IngressStatus
- type IntermediateTLSProfile
- type KeystoneIdentityProvider
- type KubeClientConfig
- type KubevirtPlatformSpec
- type KubevirtPlatformStatus
- type LDAPAttributeMapping
- type LDAPIdentityProvider
- type LeaderElection
- type LoadBalancer
- type LogFormatType
- type MTUMigration
- type MTUMigrationValues
- type MappingMethodType
- type MaxAgePolicy
- type Mirror
- type MirrorSourcePolicy
- type ModernTLSProfile
- type NamedCertificate
- type Network
- type NetworkDiagnostics
- type NetworkDiagnosticsMode
- type NetworkDiagnosticsSourcePlacement
- type NetworkDiagnosticsTargetPlacement
- type NetworkList
- type NetworkMigration
- type NetworkSpec
- type NetworkStatus
- type Node
- type NodeList
- type NodeSpec
- type NodeStatus
- type NutanixFailureDomain
- type NutanixIdentifierType
- type NutanixPlatformLoadBalancer
- type NutanixPlatformSpec
- type NutanixPlatformStatus
- type NutanixPrismElementEndpoint
- type NutanixPrismEndpoint
- type NutanixResourceIdentifier
- type OAuth
- type OAuthList
- type OAuthRemoteConnectionInfo
- type OAuthSpec
- type OAuthStatus
- type OAuthTemplates
- type OIDCClientConfig
- type OIDCClientReference
- type OIDCClientStatus
- type OIDCProvider
- type ObjectReference
- type OldTLSProfile
- type OpenIDClaim
- type OpenIDClaims
- type OpenIDIdentityProvider
- type OpenStackPlatformLoadBalancer
- type OpenStackPlatformSpec
- type OpenStackPlatformStatus
- type OperandVersion
- type OperatorHub
- type OperatorHubList
- type OperatorHubSpec
- type OperatorHubStatus
- type OvirtPlatformLoadBalancer
- type OvirtPlatformSpec
- type OvirtPlatformStatus
- type PlatformLoadBalancerType
- type PlatformSpec
- type PlatformStatus
- type PlatformType
- type PowerVSPlatformSpec
- type PowerVSPlatformStatus
- type PowerVSServiceEndpoint
- type PrefixedClaimMapping
- type PreloadPolicy
- type ProfileCustomizations
- type Project
- type ProjectList
- type ProjectSpec
- type ProjectStatus
- type PromQLClusterCondition
- type Proxy
- type ProxyList
- type ProxySpec
- type ProxyStatus
- type RegistryLocation
- type RegistrySources
- type Release
- type RemoteConnectionInfo
- type RepositoryDigestMirrors
- type RequestHeaderIdentityProvider
- type RequiredHSTSPolicy
- type Scheduler
- type SchedulerList
- type SchedulerProfile
- type SchedulerSpec
- type SchedulerStatus
- type SecretNameReference
- type ServingInfo
- type SignatureStore
- type StringSource
- type StringSourceSpec
- type TLSProfileSpec
- type TLSProfileType
- type TLSProtocolVersion
- type TLSSecurityProfile
- type TemplateReference
- type TestDetails
- type TestReporting
- type TestReportingSpec
- type TestReportingStatus
- type TokenAudience
- type TokenClaimMapping
- type TokenClaimMappings
- type TokenClaimValidationRule
- type TokenConfig
- type TokenIssuer
- type TokenRequiredClaim
- type TokenValidationRuleType
- type TopologyMode
- type URL
- type Update
- type UpdateHistory
- type UpdateState
- type UsernameClaimMapping
- type UsernamePrefix
- type UsernamePrefixPolicy
- type VSphereFailureDomainHostGroup
- type VSphereFailureDomainRegionAffinity
- type VSphereFailureDomainRegionType
- type VSphereFailureDomainZoneAffinity
- type VSphereFailureDomainZoneType
- type VSpherePlatformFailureDomainSpec
- type VSpherePlatformLoadBalancer
- type VSpherePlatformNodeNetworking
- type VSpherePlatformNodeNetworkingSpec
- type VSpherePlatformSpec
- type VSpherePlatformStatus
- type VSpherePlatformTopology
- type VSpherePlatformVCenterSpec
- type WebHookModeType
- type WebhookTokenAuthenticator
- type WorkerLatencyProfileType
Constants ¶
const ( // LogFormatLegacy saves event in 1-line text format. LogFormatLegacy LogFormatType = "legacy" // LogFormatJson saves event in structured json format. LogFormatJson LogFormatType = "json" // WebHookModeBatch indicates that the webhook should buffer audit events // internally, sending batch updates either once a certain number of // events have been received or a certain amount of time has passed. WebHookModeBatch WebHookModeType = "batch" // WebHookModeBlocking causes the webhook to block on every attempt to process // a set of events. This causes requests to the API server to wait for a // round trip to the external audit service before sending a response. WebHookModeBlocking WebHookModeType = "blocking" )
const ( // OAuthMetadataKey is the key for the oauth authorization server metadata OAuthMetadataKey = "oauthMetadata" // KubeConfigKey is the key for the kube config file data in a secret KubeConfigKey = "kubeConfig" )
const ( // HostGroupFailureDomainZone is a failure domain zone for a vCenter vm-host group. HostGroupFailureDomainZone VSphereFailureDomainZoneType = "HostGroup" // ComputeClusterFailureDomainZone is a failure domain zone for a vCenter compute cluster. ComputeClusterFailureDomainZone VSphereFailureDomainZoneType = "ComputeCluster" // DatacenterFailureDomainRegion is a failure domain region for a vCenter datacenter. DatacenterFailureDomainRegion VSphereFailureDomainRegionType = "Datacenter" // ComputeClusterFailureDomainRegion is a failure domain region for a vCenter compute cluster. ComputeClusterFailureDomainRegion VSphereFailureDomainRegionType = "ComputeCluster" )
const ( // DefaultNodeStatusUpdateFrequency refers to the "--node-status-update-frequency" of the kubelet in case of DefaultUpdateDefaultReaction WorkerLatencyProfile type DefaultNodeStatusUpdateFrequency = 10 * time.Second // DefaultNodeMonitorGracePeriod refers to the "--node-monitor-grace-period" of the Kube Controller Manager in case of DefaultUpdateDefaultReaction WorkerLatencyProfile type DefaultNodeMonitorGracePeriod = 40 * time.Second // DefaultNotReadyTolerationSeconds refers to the "--default-not-ready-toleration-seconds" of the Kube API Server in case of DefaultUpdateDefaultReaction WorkerLatencyProfile type DefaultNotReadyTolerationSeconds = 300 // DefaultUnreachableTolerationSeconds refers to the "--default-unreachable-toleration-seconds" of the Kube API Server in case of DefaultUpdateDefaultReaction WorkerLatencyProfile type DefaultUnreachableTolerationSeconds = 300 // MediumNodeStatusUpdateFrequency refers to the "--node-status-update-frequency" of the kubelet in case of MediumUpdateAverageReaction WorkerLatencyProfile type MediumNodeStatusUpdateFrequency = 20 * time.Second // MediumNodeMonitorGracePeriod refers to the "--node-monitor-grace-period" of the Kube Controller Manager in case of MediumUpdateAverageReaction WorkerLatencyProfile type MediumNodeMonitorGracePeriod = 2 * time.Minute // MediumNotReadyTolerationSeconds refers to the "--default-not-ready-toleration-seconds" of the Kube API Server in case of MediumUpdateAverageReaction WorkerLatencyProfile type MediumNotReadyTolerationSeconds = 60 // MediumUnreachableTolerationSeconds refers to the "--default-unreachable-toleration-seconds" of the Kube API Server in case of MediumUpdateAverageReaction WorkerLatencyProfile type MediumUnreachableTolerationSeconds = 60 // LowNodeStatusUpdateFrequency refers to the "--node-status-update-frequency" of the kubelet in case of LowUpdateSlowReaction WorkerLatencyProfile type LowNodeStatusUpdateFrequency = 1 * time.Minute // LowNodeMonitorGracePeriod refers to the "--node-monitor-grace-period" of the Kube Controller Manager in case of LowUpdateSlowReaction WorkerLatencyProfile type LowNodeMonitorGracePeriod = 5 * time.Minute // LowNotReadyTolerationSeconds refers to the "--default-not-ready-toleration-seconds" of the Kube API Server in case of LowUpdateSlowReaction WorkerLatencyProfile type LowNotReadyTolerationSeconds = 60 // LowUnreachableTolerationSeconds refers to the "--default-unreachable-toleration-seconds" of the Kube API Server in case of LowUpdateSlowReaction WorkerLatencyProfile type LowUnreachableTolerationSeconds = 60 )
const ( // LoginTemplateKey is the key of the login template in a secret LoginTemplateKey = "login.html" // ProviderSelectionTemplateKey is the key for the provider selection template in a secret ProviderSelectionTemplateKey = "providers.html" // ErrorsTemplateKey is the key for the errors template in a secret ErrorsTemplateKey = "errors.html" // BindPasswordKey is the key for the LDAP bind password in a secret BindPasswordKey = "bindPassword" // ClientSecretKey is the key for the oauth client secret data in a secret ClientSecretKey = "clientSecret" // HTPasswdDataKey is the key for the htpasswd file data in a secret HTPasswdDataKey = "htpasswd" )
const (
TokenValidationRuleTypeRequiredClaim = "RequiredClaim"
)
const UserIDClaim = "sub"
UserIDClaim is the claim used to provide a stable identifier for OIDC identities. Per http://openid.net/specs/openid-connect-core-1_0.html#ClaimStability
"The sub (subject) and iss (issuer) Claims, used together, are the only Claims that an RP can rely upon as a stable identifier for the End-User, since the sub Claim MUST be locally unique and never reassigned within the Issuer for a particular End-User, as described in Section 2. Therefore, the only guaranteed unique identifier for a given End-User is the combination of the iss Claim and the sub Claim."
Variables ¶
var ( GroupName = "config.openshift.io" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
var ClusterVersionCapabilitySets = map[ClusterVersionCapabilitySet][]ClusterVersionCapability{ ClusterVersionCapabilitySetNone: {}, ClusterVersionCapabilitySet4_11: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityMachineAPI, }, ClusterVersionCapabilitySet4_12: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityMachineAPI, }, ClusterVersionCapabilitySet4_13: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, }, ClusterVersionCapabilitySet4_14: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, }, ClusterVersionCapabilitySet4_15: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityCloudCredential, }, ClusterVersionCapabilitySet4_16: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityCloudCredential, ClusterVersionCapabilityIngress, ClusterVersionCapabilityCloudControllerManager, }, ClusterVersionCapabilitySet4_17: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityCloudCredential, ClusterVersionCapabilityIngress, ClusterVersionCapabilityCloudControllerManager, }, ClusterVersionCapabilitySet4_18: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityOperatorLifecycleManagerV1, ClusterVersionCapabilityCloudCredential, ClusterVersionCapabilityIngress, ClusterVersionCapabilityCloudControllerManager, }, ClusterVersionCapabilitySetCurrent: { ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityOperatorLifecycleManagerV1, ClusterVersionCapabilityCloudCredential, ClusterVersionCapabilityIngress, ClusterVersionCapabilityCloudControllerManager, }, }
ClusterVersionCapabilitySets defines sets of cluster version capabilities.
var KnownClusterVersionCapabilities = []ClusterVersionCapability{ ClusterVersionCapabilityBaremetal, ClusterVersionCapabilityConsole, ClusterVersionCapabilityInsights, ClusterVersionCapabilityMarketplace, ClusterVersionCapabilityStorage, ClusterVersionCapabilityOpenShiftSamples, ClusterVersionCapabilityCSISnapshot, ClusterVersionCapabilityNodeTuning, ClusterVersionCapabilityMachineAPI, ClusterVersionCapabilityBuild, ClusterVersionCapabilityDeploymentConfig, ClusterVersionCapabilityImageRegistry, ClusterVersionCapabilityOperatorLifecycleManager, ClusterVersionCapabilityOperatorLifecycleManagerV1, ClusterVersionCapabilityCloudCredential, ClusterVersionCapabilityIngress, ClusterVersionCapabilityCloudControllerManager, }
KnownClusterVersionCapabilities includes all known optional, core cluster components.
var TLSProfiles = map[TLSProfileType]*TLSProfileSpec{ TLSProfileOldType: { Ciphers: []string{ "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-CHACHA20-POLY1305", "DHE-RSA-AES128-GCM-SHA256", "DHE-RSA-AES256-GCM-SHA384", "DHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES128-SHA256", "ECDHE-RSA-AES128-SHA256", "ECDHE-ECDSA-AES128-SHA", "ECDHE-RSA-AES128-SHA", "ECDHE-ECDSA-AES256-SHA384", "ECDHE-RSA-AES256-SHA384", "ECDHE-ECDSA-AES256-SHA", "ECDHE-RSA-AES256-SHA", "DHE-RSA-AES128-SHA256", "DHE-RSA-AES256-SHA256", "AES128-GCM-SHA256", "AES256-GCM-SHA384", "AES128-SHA256", "AES256-SHA256", "AES128-SHA", "AES256-SHA", "DES-CBC3-SHA", }, MinTLSVersion: VersionTLS10, }, TLSProfileIntermediateType: { Ciphers: []string{ "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-CHACHA20-POLY1305", "DHE-RSA-AES128-GCM-SHA256", "DHE-RSA-AES256-GCM-SHA384", }, MinTLSVersion: VersionTLS12, }, TLSProfileModernType: { Ciphers: []string{ "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", }, MinTLSVersion: VersionTLS13, }, }
TLSProfiles Contains a map of TLSProfileType names to TLSProfileSpec.
NOTE: The caller needs to make sure to check that these constants are valid for their binary. Not all entries map to values for all binaries. In the case of ties, the kube-apiserver wins. Do not fail, just be sure to whitelist only and everything will be ok.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type APIServer ¶
type APIServer struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec APIServerSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status APIServerStatus `json:"status"` }
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'.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=apiservers,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*APIServer) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServer.
func (*APIServer) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIServer) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (APIServer) SwaggerDoc ¶
type APIServerEncryption ¶
type APIServerEncryption struct { // 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. // // When 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: // // 1. secrets // 2. configmaps // 3. routes.route.openshift.io // 4. oauthaccesstokens.oauth.openshift.io // 5. oauthauthorizetokens.oauth.openshift.io // // +unionDiscriminator // +optional Type EncryptionType `json:"type,omitempty"` }
func (*APIServerEncryption) DeepCopy ¶
func (in *APIServerEncryption) DeepCopy() *APIServerEncryption
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerEncryption.
func (*APIServerEncryption) DeepCopyInto ¶
func (in *APIServerEncryption) DeepCopyInto(out *APIServerEncryption)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (APIServerEncryption) SwaggerDoc ¶
func (APIServerEncryption) SwaggerDoc() map[string]string
type APIServerList ¶
type APIServerList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []APIServer `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*APIServerList) DeepCopy ¶
func (in *APIServerList) DeepCopy() *APIServerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerList.
func (*APIServerList) DeepCopyInto ¶
func (in *APIServerList) DeepCopyInto(out *APIServerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIServerList) DeepCopyObject ¶
func (in *APIServerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (APIServerList) SwaggerDoc ¶
func (APIServerList) SwaggerDoc() map[string]string
type APIServerNamedServingCert ¶
type APIServerNamedServingCert struct { // 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. // +optional Names []string `json:"names,omitempty"` // 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. ServingCertificate SecretNameReference `json:"servingCertificate"` }
APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.
func (*APIServerNamedServingCert) DeepCopy ¶
func (in *APIServerNamedServingCert) DeepCopy() *APIServerNamedServingCert
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerNamedServingCert.
func (*APIServerNamedServingCert) DeepCopyInto ¶
func (in *APIServerNamedServingCert) DeepCopyInto(out *APIServerNamedServingCert)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (APIServerNamedServingCert) SwaggerDoc ¶
func (APIServerNamedServingCert) SwaggerDoc() map[string]string
type APIServerServingCerts ¶
type APIServerServingCerts struct { // 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. // +optional NamedCertificates []APIServerNamedServingCert `json:"namedCertificates,omitempty"` }
func (*APIServerServingCerts) DeepCopy ¶
func (in *APIServerServingCerts) DeepCopy() *APIServerServingCerts
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerServingCerts.
func (*APIServerServingCerts) DeepCopyInto ¶
func (in *APIServerServingCerts) DeepCopyInto(out *APIServerServingCerts)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (APIServerServingCerts) SwaggerDoc ¶
func (APIServerServingCerts) SwaggerDoc() map[string]string
type APIServerSpec ¶
type APIServerSpec struct { // servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates // will be used for serving secure traffic. // +optional ServingCerts APIServerServingCerts `json:"servingCerts"` // 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. // +optional ClientCA ConfigMapNameReference `json:"clientCA"` // 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. // +optional AdditionalCORSAllowedOrigins []string `json:"additionalCORSAllowedOrigins,omitempty"` // encryption allows the configuration of encryption of resources at the datastore layer. // +optional Encryption APIServerEncryption `json:"encryption"` // tlsSecurityProfile specifies settings for TLS connections for externally exposed servers. // // If 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 // minTLSVersion is VersionTLS12. // +optional TLSSecurityProfile *TLSSecurityProfile `json:"tlsSecurityProfile,omitempty"` // audit specifies the settings for audit configuration to be applied to all OpenShift-provided // API servers in the cluster. // +optional // +kubebuilder:default={profile: Default} Audit Audit `json:"audit"` }
func (*APIServerSpec) DeepCopy ¶
func (in *APIServerSpec) DeepCopy() *APIServerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerSpec.
func (*APIServerSpec) DeepCopyInto ¶
func (in *APIServerSpec) DeepCopyInto(out *APIServerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (APIServerSpec) SwaggerDoc ¶
func (APIServerSpec) SwaggerDoc() map[string]string
type APIServerStatus ¶
type APIServerStatus struct { }
func (*APIServerStatus) DeepCopy ¶
func (in *APIServerStatus) DeepCopy() *APIServerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServerStatus.
func (*APIServerStatus) DeepCopyInto ¶
func (in *APIServerStatus) DeepCopyInto(out *APIServerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AWSDNSSpec ¶
type AWSDNSSpec struct { // privateZoneIAMRole contains the ARN of an IAM role that should be assumed when performing // operations on the cluster's private hosted zone specified in the cluster DNS config. // When left empty, no role should be assumed. // +kubebuilder:validation:Pattern:=`^arn:(aws|aws-cn|aws-us-gov):iam::[0-9]{12}:role\/.*$` // +optional PrivateZoneIAMRole string `json:"privateZoneIAMRole"` }
AWSDNSSpec contains DNS configuration specific to the Amazon Web Services cloud provider.
func (*AWSDNSSpec) DeepCopy ¶
func (in *AWSDNSSpec) DeepCopy() *AWSDNSSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSDNSSpec.
func (*AWSDNSSpec) DeepCopyInto ¶
func (in *AWSDNSSpec) DeepCopyInto(out *AWSDNSSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSDNSSpec) SwaggerDoc ¶
func (AWSDNSSpec) SwaggerDoc() map[string]string
type AWSIngressSpec ¶
type AWSIngressSpec struct { // 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: // // * "Classic": A Classic Load Balancer that makes routing decisions at either // the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See // the following for additional details: // // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb // // * "NLB": A Network Load Balancer that makes routing decisions at the // transport layer (TCP/SSL). See the following for additional details: // // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb // +unionDiscriminator // +kubebuilder:validation:Enum:=NLB;Classic // +required Type AWSLBType `json:"type,omitempty"` }
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. +union
func (*AWSIngressSpec) DeepCopy ¶
func (in *AWSIngressSpec) DeepCopy() *AWSIngressSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSIngressSpec.
func (*AWSIngressSpec) DeepCopyInto ¶
func (in *AWSIngressSpec) DeepCopyInto(out *AWSIngressSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSIngressSpec) SwaggerDoc ¶
func (AWSIngressSpec) SwaggerDoc() map[string]string
type AWSLBType ¶
type AWSLBType string
const ( // NLB is the Network Load Balancer Type of AWS. Using NLB one can set NLB load balancer type for the default ingress controller. NLB AWSLBType = "NLB" // Classic is the Classic Load Balancer Type of AWS. Using CLassic one can set Classic load balancer type for the default ingress controller. Classic AWSLBType = "Classic" )
type AWSPlatformSpec ¶
type AWSPlatformSpec struct { // serviceEndpoints list contains custom endpoints which will override default // service endpoint of AWS Services. // There must be only one ServiceEndpoint for a service. // +listType=atomic // +optional ServiceEndpoints []AWSServiceEndpoint `json:"serviceEndpoints,omitempty"` }
AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.
func (*AWSPlatformSpec) DeepCopy ¶
func (in *AWSPlatformSpec) DeepCopy() *AWSPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSPlatformSpec.
func (*AWSPlatformSpec) DeepCopyInto ¶
func (in *AWSPlatformSpec) DeepCopyInto(out *AWSPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSPlatformSpec) SwaggerDoc ¶
func (AWSPlatformSpec) SwaggerDoc() map[string]string
type AWSPlatformStatus ¶
type AWSPlatformStatus struct { // region holds the default AWS region for new AWS resources created by the cluster. Region string `json:"region"` // serviceEndpoints list contains custom endpoints which will override default // service endpoint of AWS Services. // There must be only one ServiceEndpoint for a service. // +listType=atomic // +optional ServiceEndpoints []AWSServiceEndpoint `json:"serviceEndpoints,omitempty"` // 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. // +kubebuilder:validation:MaxItems=25 // +listType=atomic // +optional ResourceTags []AWSResourceTag `json:"resourceTags,omitempty"` // cloudLoadBalancerConfig holds configuration related to DNS and cloud // load balancers. It allows configuration of in-cluster DNS as an alternative // to the platform default DNS implementation. // When using the ClusterHosted DNS type, Load Balancer IP addresses // must be provided for the API and internal API load balancers as well as the // ingress load balancer. // // +default={"dnsType": "PlatformDefault"} // +kubebuilder:default={"dnsType": "PlatformDefault"} // +openshift:enable:FeatureGate=AWSClusterHostedDNS // +optional // +nullable CloudLoadBalancerConfig *CloudLoadBalancerConfig `json:"cloudLoadBalancerConfig,omitempty"` }
AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.
func (*AWSPlatformStatus) DeepCopy ¶
func (in *AWSPlatformStatus) DeepCopy() *AWSPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSPlatformStatus.
func (*AWSPlatformStatus) DeepCopyInto ¶
func (in *AWSPlatformStatus) DeepCopyInto(out *AWSPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSPlatformStatus) SwaggerDoc ¶
func (AWSPlatformStatus) SwaggerDoc() map[string]string
type AWSResourceTag ¶
type AWSResourceTag struct { // key is the key of the tag // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.:/=+-@]+$` // +required Key string `json:"key"` // 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. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.:/=+-@]+$` // +required Value string `json:"value"` }
AWSResourceTag is a tag to apply to AWS resources created for the cluster.
func (*AWSResourceTag) DeepCopy ¶
func (in *AWSResourceTag) DeepCopy() *AWSResourceTag
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSResourceTag.
func (*AWSResourceTag) DeepCopyInto ¶
func (in *AWSResourceTag) DeepCopyInto(out *AWSResourceTag)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSResourceTag) SwaggerDoc ¶
func (AWSResourceTag) SwaggerDoc() map[string]string
type AWSServiceEndpoint ¶
type AWSServiceEndpoint struct { // 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. // // +kubebuilder:validation:Pattern=`^[a-z0-9-]+$` Name string `json:"name"` // 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. // // +kubebuilder:validation:Pattern=`^https://` URL string `json:"url"` }
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
func (*AWSServiceEndpoint) DeepCopy ¶
func (in *AWSServiceEndpoint) DeepCopy() *AWSServiceEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSServiceEndpoint.
func (*AWSServiceEndpoint) DeepCopyInto ¶
func (in *AWSServiceEndpoint) DeepCopyInto(out *AWSServiceEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AWSServiceEndpoint) SwaggerDoc ¶
func (AWSServiceEndpoint) SwaggerDoc() map[string]string
type AdmissionConfig ¶
type AdmissionConfig struct { PluginConfig map[string]AdmissionPluginConfig `json:"pluginConfig,omitempty"` // 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. EnabledAdmissionPlugins []string `json:"enabledPlugins,omitempty"` // 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. DisabledAdmissionPlugins []string `json:"disabledPlugins,omitempty"` }
func (*AdmissionConfig) DeepCopy ¶
func (in *AdmissionConfig) DeepCopy() *AdmissionConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdmissionConfig.
func (*AdmissionConfig) DeepCopyInto ¶
func (in *AdmissionConfig) DeepCopyInto(out *AdmissionConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AdmissionConfig) SwaggerDoc ¶
func (AdmissionConfig) SwaggerDoc() map[string]string
type AdmissionPluginConfig ¶
type AdmissionPluginConfig struct { // location is the path to a configuration file that contains the plugin's // configuration Location string `json:"location"` // 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. // +nullable // +kubebuilder:pruning:PreserveUnknownFields Configuration runtime.RawExtension `json:"configuration"` }
AdmissionPluginConfig holds the necessary configuration options for admission plugins
func (*AdmissionPluginConfig) DeepCopy ¶
func (in *AdmissionPluginConfig) DeepCopy() *AdmissionPluginConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdmissionPluginConfig.
func (*AdmissionPluginConfig) DeepCopyInto ¶
func (in *AdmissionPluginConfig) DeepCopyInto(out *AdmissionPluginConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AdmissionPluginConfig) SwaggerDoc ¶
func (AdmissionPluginConfig) SwaggerDoc() map[string]string
type AlibabaCloudPlatformSpec ¶
type AlibabaCloudPlatformSpec struct{}
AlibabaCloudPlatformSpec holds the desired state of the Alibaba Cloud infrastructure provider. This only includes fields that can be modified in the cluster.
func (*AlibabaCloudPlatformSpec) DeepCopy ¶
func (in *AlibabaCloudPlatformSpec) DeepCopy() *AlibabaCloudPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlibabaCloudPlatformSpec.
func (*AlibabaCloudPlatformSpec) DeepCopyInto ¶
func (in *AlibabaCloudPlatformSpec) DeepCopyInto(out *AlibabaCloudPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AlibabaCloudPlatformSpec) SwaggerDoc ¶
func (AlibabaCloudPlatformSpec) SwaggerDoc() map[string]string
type AlibabaCloudPlatformStatus ¶
type AlibabaCloudPlatformStatus struct { // region specifies the region for Alibaba Cloud resources created for the cluster. // +kubebuilder:validation:Pattern=`^[0-9A-Za-z-]+$` // +required Region string `json:"region"` // resourceGroupID is the ID of the resource group for the cluster. // +kubebuilder:validation:Pattern=`^(rg-[0-9A-Za-z]+)?$` // +optional ResourceGroupID string `json:"resourceGroupID,omitempty"` // resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster. // +kubebuilder:validation:MaxItems=20 // +listType=map // +listMapKey=key // +optional ResourceTags []AlibabaCloudResourceTag `json:"resourceTags,omitempty"` }
AlibabaCloudPlatformStatus holds the current status of the Alibaba Cloud infrastructure provider.
func (*AlibabaCloudPlatformStatus) DeepCopy ¶
func (in *AlibabaCloudPlatformStatus) DeepCopy() *AlibabaCloudPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlibabaCloudPlatformStatus.
func (*AlibabaCloudPlatformStatus) DeepCopyInto ¶
func (in *AlibabaCloudPlatformStatus) DeepCopyInto(out *AlibabaCloudPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AlibabaCloudPlatformStatus) SwaggerDoc ¶
func (AlibabaCloudPlatformStatus) SwaggerDoc() map[string]string
type AlibabaCloudResourceTag ¶
type AlibabaCloudResourceTag struct { // key is the key of the tag. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +required Key string `json:"key"` // value is the value of the tag. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +required Value string `json:"value"` }
AlibabaCloudResourceTag is the set of tags to add to apply to resources.
func (*AlibabaCloudResourceTag) DeepCopy ¶
func (in *AlibabaCloudResourceTag) DeepCopy() *AlibabaCloudResourceTag
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlibabaCloudResourceTag.
func (*AlibabaCloudResourceTag) DeepCopyInto ¶
func (in *AlibabaCloudResourceTag) DeepCopyInto(out *AlibabaCloudResourceTag)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AlibabaCloudResourceTag) SwaggerDoc ¶
func (AlibabaCloudResourceTag) SwaggerDoc() map[string]string
type Audit ¶
type Audit struct { // 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. // // The following profiles are provided: // - Default: default policy which means MetaData level logging with the exception of events // (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody // level). // - 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. // // Warning: 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. // // If unset, the 'Default' profile is used as the default. // // +kubebuilder:default=Default Profile AuditProfileType `json:"profile,omitempty"` // 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. // +listType=map // +listMapKey=group // +optional CustomRules []AuditCustomRule `json:"customRules,omitempty"` }
func (*Audit) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Audit.
func (*Audit) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Audit) SwaggerDoc ¶
type AuditConfig ¶
type AuditConfig struct { // If this flag is set, audit log will be printed in the logs. // The logs contains, method, user and a requested URL. Enabled bool `json:"enabled"` // All requests coming to the apiserver will be logged to this file. AuditFilePath string `json:"auditFilePath"` // Maximum number of days to retain old log files based on the timestamp encoded in their filename. MaximumFileRetentionDays int32 `json:"maximumFileRetentionDays"` // Maximum number of old log files to retain. MaximumRetainedFiles int32 `json:"maximumRetainedFiles"` // Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB. MaximumFileSizeMegabytes int32 `json:"maximumFileSizeMegabytes"` // policyFile is a path to the file that defines the audit policy configuration. PolicyFile string `json:"policyFile"` // 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. // +nullable // +kubebuilder:pruning:PreserveUnknownFields PolicyConfiguration runtime.RawExtension `json:"policyConfiguration"` // Format of saved audits (legacy or json). LogFormat LogFormatType `json:"logFormat"` // Path to a .kubeconfig formatted file that defines the audit webhook configuration. WebHookKubeConfig string `json:"webHookKubeConfig"` // Strategy for sending audit events (block or batch). WebHookMode WebHookModeType `json:"webHookMode"` }
AuditConfig holds configuration for the audit capabilities
func (*AuditConfig) DeepCopy ¶
func (in *AuditConfig) DeepCopy() *AuditConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuditConfig.
func (*AuditConfig) DeepCopyInto ¶
func (in *AuditConfig) DeepCopyInto(out *AuditConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AuditConfig) SwaggerDoc ¶
func (AuditConfig) SwaggerDoc() map[string]string
type AuditCustomRule ¶
type AuditCustomRule struct { // group is a name of group a request user must be member of in order to this profile to apply. // // +kubebuilder:validation:MinLength=1 // +required Group string `json:"group"` // profile specifies the name of the desired audit policy configuration to be deployed to // all OpenShift-provided API servers in the cluster. // // The 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. // // If unset, the 'Default' profile is used as the default. // // +required Profile AuditProfileType `json:"profile,omitempty"` }
AuditCustomRule describes a custom rule for an audit profile that takes precedence over the top-level profile.
func (*AuditCustomRule) DeepCopy ¶
func (in *AuditCustomRule) DeepCopy() *AuditCustomRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuditCustomRule.
func (*AuditCustomRule) DeepCopyInto ¶
func (in *AuditCustomRule) DeepCopyInto(out *AuditCustomRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AuditCustomRule) SwaggerDoc ¶
func (AuditCustomRule) SwaggerDoc() map[string]string
type AuditProfileType ¶
type AuditProfileType string
AuditProfileType defines the audit policy profile type. +kubebuilder:validation:Enum=Default;WriteRequestBodies;AllRequestBodies;None
const ( // "None" disables audit logs. NoneAuditProfileType AuditProfileType = "None" // "Default" is the existing default audit configuration policy. DefaultAuditProfileType AuditProfileType = "Default" // "WriteRequestBodies" is similar to Default but it logs request and response // HTTP payloads for write requests (create, update, patch) WriteRequestBodiesAuditProfileType AuditProfileType = "WriteRequestBodies" // "AllRequestBodies" is similar to WriteRequestBodies, but also logs request // and response HTTP payloads for read requests (get, list). AllRequestBodiesAuditProfileType AuditProfileType = "AllRequestBodies" )
type Authentication ¶
type Authentication struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec AuthenticationSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status AuthenticationStatus `json:"status"` }
Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=authentications,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Authentication) DeepCopy ¶
func (in *Authentication) DeepCopy() *Authentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authentication.
func (*Authentication) DeepCopyInto ¶
func (in *Authentication) DeepCopyInto(out *Authentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Authentication) DeepCopyObject ¶
func (in *Authentication) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Authentication) SwaggerDoc ¶
func (Authentication) SwaggerDoc() map[string]string
type AuthenticationList ¶
type AuthenticationList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Authentication `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*AuthenticationList) DeepCopy ¶
func (in *AuthenticationList) DeepCopy() *AuthenticationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationList.
func (*AuthenticationList) DeepCopyInto ¶
func (in *AuthenticationList) DeepCopyInto(out *AuthenticationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AuthenticationList) DeepCopyObject ¶
func (in *AuthenticationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (AuthenticationList) SwaggerDoc ¶
func (AuthenticationList) SwaggerDoc() map[string]string
type AuthenticationSpec ¶
type AuthenticationSpec struct { // 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. // +optional Type AuthenticationType `json:"type"` // 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. // +optional OAuthMetadata ConfigMapNameReference `json:"oauthMetadata"` // webhookTokenAuthenticators is DEPRECATED, setting it has no effect. // +listType=atomic WebhookTokenAuthenticators []DeprecatedWebhookTokenAuthenticator `json:"webhookTokenAuthenticators,omitempty"` // 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. // // Can only be set if "Type" is set to "None". // // +optional WebhookTokenAuthenticator *WebhookTokenAuthenticator `json:"webhookTokenAuthenticator,omitempty"` // 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. // +optional ServiceAccountIssuer string `json:"serviceAccountIssuer"` // oidcProviders are OIDC identity providers that can issue tokens // for this cluster // Can only be set if "Type" is set to "OIDC". // // At most one provider can be configured. // // +listType=map // +listMapKey=name // +kubebuilder:validation:MaxItems=1 // +openshift:enable:FeatureGate=ExternalOIDC OIDCProviders []OIDCProvider `json:"oidcProviders,omitempty"` }
func (*AuthenticationSpec) DeepCopy ¶
func (in *AuthenticationSpec) DeepCopy() *AuthenticationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationSpec.
func (*AuthenticationSpec) DeepCopyInto ¶
func (in *AuthenticationSpec) DeepCopyInto(out *AuthenticationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AuthenticationSpec) SwaggerDoc ¶
func (AuthenticationSpec) SwaggerDoc() map[string]string
type AuthenticationStatus ¶
type AuthenticationStatus struct { // 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. IntegratedOAuthMetadata ConfigMapNameReference `json:"integratedOAuthMetadata"` // oidcClients is where participating operators place the current OIDC client status // for OIDC clients that can be customized by the cluster-admin. // // +listType=map // +listMapKey=componentNamespace // +listMapKey=componentName // +kubebuilder:validation:MaxItems=20 // +openshift:enable:FeatureGate=ExternalOIDC OIDCClients []OIDCClientStatus `json:"oidcClients"` }
func (*AuthenticationStatus) DeepCopy ¶
func (in *AuthenticationStatus) DeepCopy() *AuthenticationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationStatus.
func (*AuthenticationStatus) DeepCopyInto ¶
func (in *AuthenticationStatus) DeepCopyInto(out *AuthenticationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AuthenticationStatus) SwaggerDoc ¶
func (AuthenticationStatus) SwaggerDoc() map[string]string
type AuthenticationType ¶
type AuthenticationType string
+openshift:validation:FeatureGateAwareEnum:featureGate="",enum="";None;IntegratedOAuth +openshift:validation:FeatureGateAwareEnum:featureGate=ExternalOIDC,enum="";None;IntegratedOAuth;OIDC
const ( // None means that no cluster managed authentication system is in place. // Note that user login will only work if a manually configured system is in place and // referenced in authentication spec via oauthMetadata and // webhookTokenAuthenticator/oidcProviders AuthenticationTypeNone AuthenticationType = "None" // IntegratedOAuth refers to the cluster managed OAuth server. // It is configured via the top level OAuth config. AuthenticationTypeIntegratedOAuth AuthenticationType = "IntegratedOAuth" // AuthenticationTypeOIDC refers to a configuration with an external // OIDC server configured directly with the kube-apiserver. AuthenticationTypeOIDC AuthenticationType = "OIDC" )
type AzureCloudEnvironment ¶
type AzureCloudEnvironment string
AzureCloudEnvironment is the name of the Azure cloud environment +kubebuilder:validation:Enum="";AzurePublicCloud;AzureUSGovernmentCloud;AzureChinaCloud;AzureGermanCloud;AzureStackCloud
const ( // AzurePublicCloud is the general-purpose, public Azure cloud environment. AzurePublicCloud AzureCloudEnvironment = "AzurePublicCloud" // AzureUSGovernmentCloud is the Azure cloud environment for the US government. AzureUSGovernmentCloud AzureCloudEnvironment = "AzureUSGovernmentCloud" // AzureChinaCloud is the Azure cloud environment used in China. AzureChinaCloud AzureCloudEnvironment = "AzureChinaCloud" // AzureGermanCloud is the Azure cloud environment used in Germany. AzureGermanCloud AzureCloudEnvironment = "AzureGermanCloud" // AzureStackCloud is the Azure cloud environment used at the edge and on premises. AzureStackCloud AzureCloudEnvironment = "AzureStackCloud" )
type AzurePlatformSpec ¶
type AzurePlatformSpec struct{}
AzurePlatformSpec holds the desired state of the Azure infrastructure provider. This only includes fields that can be modified in the cluster.
func (*AzurePlatformSpec) DeepCopy ¶
func (in *AzurePlatformSpec) DeepCopy() *AzurePlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzurePlatformSpec.
func (*AzurePlatformSpec) DeepCopyInto ¶
func (in *AzurePlatformSpec) DeepCopyInto(out *AzurePlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AzurePlatformSpec) SwaggerDoc ¶
func (AzurePlatformSpec) SwaggerDoc() map[string]string
type AzurePlatformStatus ¶
type AzurePlatformStatus struct { // resourceGroupName is the Resource Group for new Azure resources created for the cluster. ResourceGroupName string `json:"resourceGroupName"` // 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. // +optional NetworkResourceGroupName string `json:"networkResourceGroupName,omitempty"` // 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`. // +optional CloudName AzureCloudEnvironment `json:"cloudName,omitempty"` // armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack. // +optional ARMEndpoint string `json:"armEndpoint,omitempty"` // 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. // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.all(x, x in oldSelf) && oldSelf.all(x, x in self)",message="resourceTags are immutable and may only be configured during installation" // +listType=atomic // +optional ResourceTags []AzureResourceTag `json:"resourceTags,omitempty"` }
AzurePlatformStatus holds the current status of the Azure infrastructure provider. +kubebuilder:validation:XValidation:rule="!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)",message="resourceTags may only be configured during installation"
func (*AzurePlatformStatus) DeepCopy ¶
func (in *AzurePlatformStatus) DeepCopy() *AzurePlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzurePlatformStatus.
func (*AzurePlatformStatus) DeepCopyInto ¶
func (in *AzurePlatformStatus) DeepCopyInto(out *AzurePlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AzurePlatformStatus) SwaggerDoc ¶
func (AzurePlatformStatus) SwaggerDoc() map[string]string
type AzureResourceTag ¶
type AzureResourceTag struct { // 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 `_ . -`. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +kubebuilder:validation:Pattern=`^[a-zA-Z]([0-9A-Za-z_.-]*[0-9A-Za-z_])?$` Key string `json:"key"` // 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 `_ + , - . / : ; < = > ? @`. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.=+-@]+$` Value string `json:"value"` }
AzureResourceTag is a tag to apply to Azure resources created for the cluster.
func (*AzureResourceTag) DeepCopy ¶
func (in *AzureResourceTag) DeepCopy() *AzureResourceTag
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureResourceTag.
func (*AzureResourceTag) DeepCopyInto ¶
func (in *AzureResourceTag) DeepCopyInto(out *AzureResourceTag)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AzureResourceTag) SwaggerDoc ¶
func (AzureResourceTag) SwaggerDoc() map[string]string
type BareMetalPlatformLoadBalancer ¶
type BareMetalPlatformLoadBalancer struct { // 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. // +default="OpenShiftManagedDefault" // +kubebuilder:default:="OpenShiftManagedDefault" // +kubebuilder:validation:Enum:="OpenShiftManagedDefault";"UserManaged" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="type is immutable once set" // +optional // +unionDiscriminator Type PlatformLoadBalancerType `json:"type,omitempty"` }
BareMetalPlatformLoadBalancer defines the load balancer used by the cluster on BareMetal platform. +union
func (*BareMetalPlatformLoadBalancer) DeepCopy ¶
func (in *BareMetalPlatformLoadBalancer) DeepCopy() *BareMetalPlatformLoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BareMetalPlatformLoadBalancer.
func (*BareMetalPlatformLoadBalancer) DeepCopyInto ¶
func (in *BareMetalPlatformLoadBalancer) DeepCopyInto(out *BareMetalPlatformLoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BareMetalPlatformLoadBalancer) SwaggerDoc ¶
func (BareMetalPlatformLoadBalancer) SwaggerDoc() map[string]string
type BareMetalPlatformSpec ¶
type BareMetalPlatformSpec struct { // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.apiServerInternalIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional APIServerInternalIPs []IP `json:"apiServerInternalIPs"` // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.ingressIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional IngressIPs []IP `json:"ingressIPs"` // machineNetworks are IP networks used to connect all the OpenShift cluster // nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, // for example "10.0.0.0/8" or "fd00::/8". // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
BareMetalPlatformSpec holds the desired state of the BareMetal infrastructure provider. This only includes fields that can be modified in the cluster. +kubebuilder:validation:XValidation:rule="!has(oldSelf.apiServerInternalIPs) || has(self.apiServerInternalIPs)",message="apiServerInternalIPs list is required once set" +kubebuilder:validation:XValidation:rule="!has(oldSelf.ingressIPs) || has(self.ingressIPs)",message="ingressIPs list is required once set"
func (*BareMetalPlatformSpec) DeepCopy ¶
func (in *BareMetalPlatformSpec) DeepCopy() *BareMetalPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BareMetalPlatformSpec.
func (*BareMetalPlatformSpec) DeepCopyInto ¶
func (in *BareMetalPlatformSpec) DeepCopyInto(out *BareMetalPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BareMetalPlatformSpec) SwaggerDoc ¶
func (BareMetalPlatformSpec) SwaggerDoc() map[string]string
type BareMetalPlatformStatus ¶
type BareMetalPlatformStatus struct { // 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. // // Deprecated: Use APIServerInternalIPs instead. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic APIServerInternalIPs []string `json:"apiServerInternalIPs"` // 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. // // Deprecated: Use IngressIPs instead. IngressIP string `json:"ingressIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic IngressIPs []string `json:"ingressIPs"` // 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. NodeDNSIP string `json:"nodeDNSIP,omitempty"` // loadBalancer defines how the load balancer used by the cluster is configured. // +default={"type": "OpenShiftManagedDefault"} // +kubebuilder:default={"type": "OpenShiftManagedDefault"} // +openshift:enable:FeatureGate=BareMetalLoadBalancer // +optional LoadBalancer *BareMetalPlatformLoadBalancer `json:"loadBalancer,omitempty"` // machineNetworks are IP networks used to connect all the OpenShift cluster nodes. // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
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
func (*BareMetalPlatformStatus) DeepCopy ¶
func (in *BareMetalPlatformStatus) DeepCopy() *BareMetalPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BareMetalPlatformStatus.
func (*BareMetalPlatformStatus) DeepCopyInto ¶
func (in *BareMetalPlatformStatus) DeepCopyInto(out *BareMetalPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BareMetalPlatformStatus) SwaggerDoc ¶
func (BareMetalPlatformStatus) SwaggerDoc() map[string]string
type BasicAuthIdentityProvider ¶
type BasicAuthIdentityProvider struct { // OAuthRemoteConnectionInfo contains information about how to connect to the external basic auth server OAuthRemoteConnectionInfo `json:",inline"` }
BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials
func (*BasicAuthIdentityProvider) DeepCopy ¶
func (in *BasicAuthIdentityProvider) DeepCopy() *BasicAuthIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BasicAuthIdentityProvider.
func (*BasicAuthIdentityProvider) DeepCopyInto ¶
func (in *BasicAuthIdentityProvider) DeepCopyInto(out *BasicAuthIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BasicAuthIdentityProvider) SwaggerDoc ¶
func (BasicAuthIdentityProvider) SwaggerDoc() map[string]string
type Build ¶
type Build struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user-settable values for the build controller configuration // +required Spec BuildSpec `json:"spec"` }
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.
The canonical name is "cluster"
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=openshift-controller-manager,operatorOrdering=01 +openshift:capability=Build +kubebuilder:object:root=true +kubebuilder:resource:path=builds,scope=Cluster +kubebuilder:subresource:status
func (*Build) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Build.
func (*Build) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Build) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Build) SwaggerDoc ¶
type BuildDefaults ¶
type BuildDefaults struct { // defaultProxy contains the default proxy settings for all build operations, including image pull/push // and source download. // // Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables // in the build config's strategy. // +optional DefaultProxy *ProxySpec `json:"defaultProxy,omitempty"` // 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. // // Values that are not set here will be inherited from DefaultProxy. // +optional GitProxy *ProxySpec `json:"gitProxy,omitempty"` // 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 // +optional Env []corev1.EnvVar `json:"env,omitempty"` // 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. // +optional ImageLabels []ImageLabel `json:"imageLabels,omitempty"` // resources defines resource requirements to execute the build. // +optional Resources corev1.ResourceRequirements `json:"resources"` }
func (*BuildDefaults) DeepCopy ¶
func (in *BuildDefaults) DeepCopy() *BuildDefaults
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildDefaults.
func (*BuildDefaults) DeepCopyInto ¶
func (in *BuildDefaults) DeepCopyInto(out *BuildDefaults)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BuildDefaults) SwaggerDoc ¶
func (BuildDefaults) SwaggerDoc() map[string]string
type BuildList ¶
type BuildList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Build `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*BuildList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildList.
func (*BuildList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BuildList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (BuildList) SwaggerDoc ¶
type BuildOverrides ¶
type BuildOverrides struct { // 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. // +optional ImageLabels []ImageLabel `json:"imageLabels,omitempty"` // nodeSelector is a selector which must be true for the build pod to fit on a node // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // tolerations is a list of Tolerations that will override any existing // tolerations set on a build pod. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // 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 // +optional ForcePull *bool `json:"forcePull,omitempty"` }
func (*BuildOverrides) DeepCopy ¶
func (in *BuildOverrides) DeepCopy() *BuildOverrides
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildOverrides.
func (*BuildOverrides) DeepCopyInto ¶
func (in *BuildOverrides) DeepCopyInto(out *BuildOverrides)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BuildOverrides) SwaggerDoc ¶
func (BuildOverrides) SwaggerDoc() map[string]string
type BuildSpec ¶
type BuildSpec struct { // 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. // // DEPRECATED: Additional CAs for image pull and push should be set on // image.config.openshift.io/cluster instead. // // +optional AdditionalTrustedCA ConfigMapNameReference `json:"additionalTrustedCA"` // buildDefaults controls the default information for Builds // +optional BuildDefaults BuildDefaults `json:"buildDefaults"` // buildOverrides controls override settings for builds // +optional BuildOverrides BuildOverrides `json:"buildOverrides"` }
func (*BuildSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildSpec.
func (*BuildSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (BuildSpec) SwaggerDoc ¶
type CIDR ¶
type CIDR string
CIDR is an IP address range in CIDR notation (for example, "10.0.0.0/8" or "fd00::/8"). +kubebuilder:validation:XValidation:rule="isCIDR(self)",message="value must be a valid CIDR network address" +kubebuilder:validation:MaxLength:=43 +kubebuilder:validation:MinLength:=1
type CPUPartitioningMode ¶
type CPUPartitioningMode string
CPUPartitioningMode defines the mode for CPU partitioning
const ( // CPUPartitioningNone means that no CPU Partitioning is on in this cluster infrastructure CPUPartitioningNone CPUPartitioningMode = "None" // CPUPartitioningAllNodes means that all nodes are configured with CPU Partitioning in this cluster CPUPartitioningAllNodes CPUPartitioningMode = "AllNodes" )
type CertInfo ¶
type CertInfo struct { // certFile is a file containing a PEM-encoded certificate CertFile string `json:"certFile"` // keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile KeyFile string `json:"keyFile"` }
CertInfo relates a certificate with a private key
func (*CertInfo) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertInfo.
func (*CertInfo) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CertInfo) SwaggerDoc ¶
type CgroupMode ¶
type CgroupMode string
+kubebuilder:validation:Enum=v1;v2;""
const ( CgroupModeEmpty CgroupMode = "" // Empty string indicates to honor user set value on the system that should not be overridden by OpenShift CgroupModeV1 CgroupMode = "v1" CgroupModeV2 CgroupMode = "v2" CgroupModeDefault CgroupMode = CgroupModeV1 )
type ClientConnectionOverrides ¶
type ClientConnectionOverrides struct { // 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. AcceptContentTypes string `json:"acceptContentTypes"` // contentType is the content type used when sending data to the server from this client. ContentType string `json:"contentType"` // qps controls the number of queries per second allowed for this connection. QPS float32 `json:"qps"` // burst allows extra queries to accumulate when a client is exceeding its rate. Burst int32 `json:"burst"` }
func (*ClientConnectionOverrides) DeepCopy ¶
func (in *ClientConnectionOverrides) DeepCopy() *ClientConnectionOverrides
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConnectionOverrides.
func (*ClientConnectionOverrides) DeepCopyInto ¶
func (in *ClientConnectionOverrides) DeepCopyInto(out *ClientConnectionOverrides)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClientConnectionOverrides) SwaggerDoc ¶
func (ClientConnectionOverrides) SwaggerDoc() map[string]string
type CloudControllerManagerState ¶
type CloudControllerManagerState string
CloudControllerManagerState defines whether Cloud Controller Manager presence is expected or not
const ( // Cloud Controller Manager is enabled and expected to be installed. // This value indicates that new nodes should be tainted as uninitialized when created, // preventing them from running workloads until they are initialized by the cloud controller manager. CloudControllerManagerExternal CloudControllerManagerState = "External" // Cloud Controller Manager is disabled and not expected to be installed. // This value indicates that new nodes should not be tainted // and no extra node initialization is expected from the cloud controller manager. CloudControllerManagerNone CloudControllerManagerState = "None" )
type CloudControllerManagerStatus ¶
type CloudControllerManagerStatus struct { // state determines whether or not an external Cloud Controller Manager is expected to // be installed within the cluster. // https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager // // Valid values are "External", "None" and omitted. // When set to "External", new nodes will be tainted as uninitialized when created, // preventing them from running workloads until they are initialized by the cloud controller manager. // When omitted or set to "None", new nodes will be not tainted // and no extra initialization from the cloud controller manager is expected. // +kubebuilder:validation:Enum="";External;None // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="state is immutable once set" // +optional State CloudControllerManagerState `json:"state"` }
CloudControllerManagerStatus holds the state of Cloud Controller Manager (a.k.a. CCM or CPI) related settings +kubebuilder:validation:XValidation:rule="(has(self.state) == has(oldSelf.state)) || (!has(oldSelf.state) && self.state != \"External\")",message="state may not be added or removed once set"
func (*CloudControllerManagerStatus) DeepCopy ¶
func (in *CloudControllerManagerStatus) DeepCopy() *CloudControllerManagerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudControllerManagerStatus.
func (*CloudControllerManagerStatus) DeepCopyInto ¶
func (in *CloudControllerManagerStatus) DeepCopyInto(out *CloudControllerManagerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CloudControllerManagerStatus) SwaggerDoc ¶
func (CloudControllerManagerStatus) SwaggerDoc() map[string]string
type CloudLoadBalancerConfig ¶
type CloudLoadBalancerConfig struct { // dnsType indicates the type of DNS solution in use within the cluster. Its default value of // `PlatformDefault` indicates that the cluster's DNS is the default provided by the cloud platform. // It can be set to `ClusterHosted` to bypass the configuration of the cloud default DNS. In this mode, // the cluster needs to provide a self-hosted DNS solution for the cluster's installation to succeed. // The cluster's use of the cloud's Load Balancers is unaffected by this setting. // The value is immutable after it has been set at install time. // Currently, there is no way for the customer to add additional DNS entries into the cluster hosted DNS. // Enabling this functionality allows the user to start their own DNS solution outside the cluster after // installation is complete. The customer would be responsible for configuring this custom DNS solution, // and it can be run in addition to the in-cluster DNS solution. // +default="PlatformDefault" // +kubebuilder:default:="PlatformDefault" // +kubebuilder:validation:Enum="ClusterHosted";"PlatformDefault" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="dnsType is immutable" // +optional // +unionDiscriminator DNSType DNSType `json:"dnsType,omitempty"` // clusterHosted holds the IP addresses of API, API-Int and Ingress Load // Balancers on Cloud Platforms. The DNS solution hosted within the cluster // use these IP addresses to provide resolution for API, API-Int and Ingress // services. // +optional // +unionMember,optional ClusterHosted *CloudLoadBalancerIPs `json:"clusterHosted,omitempty"` }
CloudLoadBalancerConfig contains an union discriminator indicating the type of DNS solution in use within the cluster. When the DNSType is `ClusterHosted`, the cloud's Load Balancer configuration needs to be provided so that the DNS solution hosted within the cluster can be configured with those values. +kubebuilder:validation:XValidation:rule="has(self.dnsType) && self.dnsType != 'ClusterHosted' ? !has(self.clusterHosted) : true",message="clusterHosted is permitted only when dnsType is ClusterHosted" +union
func (*CloudLoadBalancerConfig) DeepCopy ¶
func (in *CloudLoadBalancerConfig) DeepCopy() *CloudLoadBalancerConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudLoadBalancerConfig.
func (*CloudLoadBalancerConfig) DeepCopyInto ¶
func (in *CloudLoadBalancerConfig) DeepCopyInto(out *CloudLoadBalancerConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CloudLoadBalancerConfig) SwaggerDoc ¶
func (CloudLoadBalancerConfig) SwaggerDoc() map[string]string
type CloudLoadBalancerIPs ¶
type CloudLoadBalancerIPs struct { // apiIntLoadBalancerIPs holds Load Balancer IPs for the internal API service. // These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. // Entries in the apiIntLoadBalancerIPs must be unique. // A maximum of 16 IP addresses are permitted. // +kubebuilder:validation:Format=ip // +listType=set // +kubebuilder:validation:MaxItems=16 // +optional APIIntLoadBalancerIPs []IP `json:"apiIntLoadBalancerIPs,omitempty"` // apiLoadBalancerIPs holds Load Balancer IPs for the API service. // These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. // Could be empty for private clusters. // Entries in the apiLoadBalancerIPs must be unique. // A maximum of 16 IP addresses are permitted. // +kubebuilder:validation:Format=ip // +listType=set // +kubebuilder:validation:MaxItems=16 // +optional APILoadBalancerIPs []IP `json:"apiLoadBalancerIPs,omitempty"` // ingressLoadBalancerIPs holds IPs for Ingress Load Balancers. // These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. // Entries in the ingressLoadBalancerIPs must be unique. // A maximum of 16 IP addresses are permitted. // +kubebuilder:validation:Format=ip // +listType=set // +kubebuilder:validation:MaxItems=16 // +optional IngressLoadBalancerIPs []IP `json:"ingressLoadBalancerIPs,omitempty"` }
CloudLoadBalancerIPs contains the Load Balancer IPs for the cloud's API, API-Int and Ingress Load balancers. They will be populated as soon as the respective Load Balancers have been configured. These values are utilized to configure the DNS solution hosted within the cluster.
func (*CloudLoadBalancerIPs) DeepCopy ¶
func (in *CloudLoadBalancerIPs) DeepCopy() *CloudLoadBalancerIPs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudLoadBalancerIPs.
func (*CloudLoadBalancerIPs) DeepCopyInto ¶
func (in *CloudLoadBalancerIPs) DeepCopyInto(out *CloudLoadBalancerIPs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CloudLoadBalancerIPs) SwaggerDoc ¶
func (CloudLoadBalancerIPs) SwaggerDoc() map[string]string
type ClusterCondition ¶
type ClusterCondition struct { // type represents the cluster-condition type. This defines // the members and semantics of any additional properties. // +kubebuilder:validation:Enum={"Always","PromQL"} // +required Type string `json:"type"` // promql represents a cluster condition based on PromQL. // +optional PromQL *PromQLClusterCondition `json:"promql,omitempty"` }
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. +k8s:deepcopy-gen=true
func (*ClusterCondition) DeepCopy ¶
func (in *ClusterCondition) DeepCopy() *ClusterCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCondition.
func (*ClusterCondition) DeepCopyInto ¶
func (in *ClusterCondition) DeepCopyInto(out *ClusterCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterCondition) SwaggerDoc ¶
func (ClusterCondition) SwaggerDoc() map[string]string
type ClusterNetworkEntry ¶
type ClusterNetworkEntry struct { // The complete block for pod IPs. CIDR string `json:"cidr"` // The size (prefix) of block to allocate to each node. If this // field is not used by the plugin, it can be left unset. // +kubebuilder:validation:Minimum=0 // +optional HostPrefix uint32 `json:"hostPrefix,omitempty"` }
ClusterNetworkEntry is a contiguous block of IP addresses from which pod IPs are allocated.
func (*ClusterNetworkEntry) DeepCopy ¶
func (in *ClusterNetworkEntry) DeepCopy() *ClusterNetworkEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterNetworkEntry.
func (*ClusterNetworkEntry) DeepCopyInto ¶
func (in *ClusterNetworkEntry) DeepCopyInto(out *ClusterNetworkEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterNetworkEntry) SwaggerDoc ¶
func (ClusterNetworkEntry) SwaggerDoc() map[string]string
type ClusterOperator ¶
type ClusterOperator struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` // spec holds configuration that could apply to any operator. // +required Spec ClusterOperatorSpec `json:"spec"` // status holds the information about the state of an operator. It is consistent with status information across // the Kubernetes ecosystem. // +optional Status ClusterOperatorStatus `json:"status"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/497 +openshift:file-pattern=cvoRunLevel=0000_00,operatorName=cluster-version-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=clusteroperators,scope=Cluster,shortName=co +kubebuilder:subresource:status +kubebuilder:printcolumn:name=Version,JSONPath=.status.versions[?(@.name=="operator")].version,type=string,description=The version the operator is at. +kubebuilder:printcolumn:name=Available,JSONPath=.status.conditions[?(@.type=="Available")].status,type=string,description=Whether the operator is running and stable. +kubebuilder:printcolumn:name=Progressing,JSONPath=.status.conditions[?(@.type=="Progressing")].status,type=string,description=Whether the operator is processing changes. +kubebuilder:printcolumn:name=Degraded,JSONPath=.status.conditions[?(@.type=="Degraded")].status,type=string,description=Whether the operator is degraded. +kubebuilder:printcolumn:name=Since,JSONPath=.status.conditions[?(@.type=="Available")].lastTransitionTime,type=date,description=The time the operator's Available status last changed. +kubebuilder:metadata:annotations=include.release.openshift.io/self-managed-high-availability=true
func (*ClusterOperator) DeepCopy ¶
func (in *ClusterOperator) DeepCopy() *ClusterOperator
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOperator.
func (*ClusterOperator) DeepCopyInto ¶
func (in *ClusterOperator) DeepCopyInto(out *ClusterOperator)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterOperator) DeepCopyObject ¶
func (in *ClusterOperator) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ClusterOperator) SwaggerDoc ¶
func (ClusterOperator) SwaggerDoc() map[string]string
type ClusterOperatorList ¶
type ClusterOperatorList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []ClusterOperator `json:"items"` }
ClusterOperatorList is a list of OperatorStatus resources.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +openshift:compatibility-gen:level=1
func (*ClusterOperatorList) DeepCopy ¶
func (in *ClusterOperatorList) DeepCopy() *ClusterOperatorList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOperatorList.
func (*ClusterOperatorList) DeepCopyInto ¶
func (in *ClusterOperatorList) DeepCopyInto(out *ClusterOperatorList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterOperatorList) DeepCopyObject ¶
func (in *ClusterOperatorList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ClusterOperatorList) SwaggerDoc ¶
func (ClusterOperatorList) SwaggerDoc() map[string]string
type ClusterOperatorSpec ¶
type ClusterOperatorSpec struct { }
ClusterOperatorSpec is empty for now, but you could imagine holding information like "pause".
func (*ClusterOperatorSpec) DeepCopy ¶
func (in *ClusterOperatorSpec) DeepCopy() *ClusterOperatorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOperatorSpec.
func (*ClusterOperatorSpec) DeepCopyInto ¶
func (in *ClusterOperatorSpec) DeepCopyInto(out *ClusterOperatorSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterOperatorSpec) SwaggerDoc ¶
func (ClusterOperatorSpec) SwaggerDoc() map[string]string
type ClusterOperatorStatus ¶
type ClusterOperatorStatus struct { // conditions describes the state of the operator's managed and monitored components. // +patchMergeKey=type // +patchStrategy=merge // +optional Conditions []ClusterOperatorStatusCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // 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. // +optional Versions []OperandVersion `json:"versions,omitempty"` // 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 // +optional RelatedObjects []ObjectReference `json:"relatedObjects,omitempty"` // extension contains any additional status information specific to the // operator which owns this status object. // +nullable // +optional // +kubebuilder:pruning:PreserveUnknownFields Extension runtime.RawExtension `json:"extension"` }
ClusterOperatorStatus provides information about the status of the operator. +k8s:deepcopy-gen=true
func (*ClusterOperatorStatus) DeepCopy ¶
func (in *ClusterOperatorStatus) DeepCopy() *ClusterOperatorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOperatorStatus.
func (*ClusterOperatorStatus) DeepCopyInto ¶
func (in *ClusterOperatorStatus) DeepCopyInto(out *ClusterOperatorStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterOperatorStatus) SwaggerDoc ¶
func (ClusterOperatorStatus) SwaggerDoc() map[string]string
type ClusterOperatorStatusCondition ¶
type ClusterOperatorStatusCondition struct { // type specifies the aspect reported by this condition. // +required Type ClusterStatusConditionType `json:"type"` // status of the condition, one of True, False, Unknown. // +required Status ConditionStatus `json:"status"` // lastTransitionTime is the time of the last update to the current status property. // +required LastTransitionTime metav1.Time `json:"lastTransitionTime"` // reason is the CamelCase reason for the condition's current status. // +optional Reason string `json:"reason,omitempty"` // 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. // +optional Message string `json:"message,omitempty"` }
ClusterOperatorStatusCondition represents the state of the operator's managed and monitored components. +k8s:deepcopy-gen=true
func (*ClusterOperatorStatusCondition) DeepCopy ¶
func (in *ClusterOperatorStatusCondition) DeepCopy() *ClusterOperatorStatusCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOperatorStatusCondition.
func (*ClusterOperatorStatusCondition) DeepCopyInto ¶
func (in *ClusterOperatorStatusCondition) DeepCopyInto(out *ClusterOperatorStatusCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterOperatorStatusCondition) SwaggerDoc ¶
func (ClusterOperatorStatusCondition) SwaggerDoc() map[string]string
type ClusterStatusConditionType ¶
type ClusterStatusConditionType string
ClusterStatusConditionType is an aspect of operator state.
const ( // Available indicates that the component (operator and all configured operands) // is functional and available in the cluster. Available=False means at least // part of the component is non-functional, and that the condition requires // immediate administrator intervention. OperatorAvailable ClusterStatusConditionType = "Available" // Progressing indicates that the component (operator and all configured operands) // is actively rolling out new code, propagating config changes, or otherwise // moving from one steady state to another. Operators should not report // progressing when they are reconciling (without action) a previously known // state. If the observed cluster state has changed and the component is // reacting to it (scaling up for instance), Progressing should become true // since it is moving from one steady state to another. OperatorProgressing ClusterStatusConditionType = "Progressing" // Degraded indicates that the component (operator and all configured operands) // does not match its desired state over a period of time resulting in a lower // quality of service. The period of time may vary by component, but a Degraded // state represents persistent observation of a condition. As a result, a // component should not oscillate in and out of Degraded state. A component may // be Available even if its degraded. For example, a component may desire 3 // running pods, but 1 pod is crash-looping. The component is Available but // Degraded because it may have a lower quality of service. A component may be // Progressing but not Degraded because the transition from one state to // another does not persist over a long enough period to report Degraded. A // component should not report Degraded during the course of a normal upgrade. // A component may report Degraded in response to a persistent infrastructure // failure that requires eventual administrator intervention. For example, if // a control plane host is unhealthy and must be replaced. A component should // report Degraded if unexpected errors occur over a period, but the // expectation is that all unexpected errors are handled as operators mature. OperatorDegraded ClusterStatusConditionType = "Degraded" // Upgradeable indicates whether the component (operator and all configured // operands) is safe to upgrade based on the current cluster state. When // Upgradeable is False, the cluster-version operator will prevent the // cluster from performing impacted updates unless forced. When set on // ClusterVersion, the message will explain which updates (minor or patch) // are impacted. When set on ClusterOperator, False will block minor // OpenShift updates. The message field should contain a human readable // description of what the administrator should do to allow the cluster or // component to successfully update. The cluster-version operator will // allow updates when this condition is not False, including when it is // missing, True, or Unknown. OperatorUpgradeable ClusterStatusConditionType = "Upgradeable" // EvaluationConditionsDetected is used to indicate the result of the detection // logic that was added to a component to evaluate the introduction of an // invasive change that could potentially result in highly visible alerts, // breakages or upgrade failures. You can concatenate multiple Reason using // the "::" delimiter if you need to evaluate the introduction of multiple changes. EvaluationConditionsDetected ClusterStatusConditionType = "EvaluationConditionsDetected" )
const RetrievedUpdates ClusterStatusConditionType = "RetrievedUpdates"
RetrievedUpdates reports whether available updates have been retrieved from the upstream update server. The condition is Unknown before retrieval, False if the updates could not be retrieved or recently failed, or True if the availableUpdates field is accurate and recent.
type ClusterVersion ¶
type ClusterVersion struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec is the desired state of the cluster version - the operator will work // to ensure that the desired version is applied to the cluster. // +required Spec ClusterVersionSpec `json:"spec"` // status contains information about the available updates and any in-progress // updates. // +optional Status ClusterVersionStatus `json:"status"` }
ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/495 +openshift:file-pattern=cvoRunLevel=0000_00,operatorName=cluster-version-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:path=clusterversions,scope=Cluster +kubebuilder:validation:XValidation:rule="has(self.spec.capabilities) && has(self.spec.capabilities.additionalEnabledCapabilities) && self.spec.capabilities.baselineCapabilitySet == 'None' && 'marketplace' in self.spec.capabilities.additionalEnabledCapabilities ? 'OperatorLifecycleManager' in self.spec.capabilities.additionalEnabledCapabilities || (has(self.status) && has(self.status.capabilities) && has(self.status.capabilities.enabledCapabilities) && 'OperatorLifecycleManager' in self.status.capabilities.enabledCapabilities) : true",message="the `marketplace` capability requires the `OperatorLifecycleManager` capability, which is neither explicitly or implicitly enabled in this cluster, please enable the `OperatorLifecycleManager` capability" +kubebuilder:printcolumn:name=Version,JSONPath=.status.history[?(@.state=="Completed")].version,type=string +kubebuilder:printcolumn:name=Available,JSONPath=.status.conditions[?(@.type=="Available")].status,type=string +kubebuilder:printcolumn:name=Progressing,JSONPath=.status.conditions[?(@.type=="Progressing")].status,type=string +kubebuilder:printcolumn:name=Since,JSONPath=.status.conditions[?(@.type=="Progressing")].lastTransitionTime,type=date +kubebuilder:printcolumn:name=Status,JSONPath=.status.conditions[?(@.type=="Progressing")].message,type=string +kubebuilder:metadata:annotations=include.release.openshift.io/self-managed-high-availability=true
func (*ClusterVersion) DeepCopy ¶
func (in *ClusterVersion) DeepCopy() *ClusterVersion
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersion.
func (*ClusterVersion) DeepCopyInto ¶
func (in *ClusterVersion) DeepCopyInto(out *ClusterVersion)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterVersion) DeepCopyObject ¶
func (in *ClusterVersion) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ClusterVersion) SwaggerDoc ¶
func (ClusterVersion) SwaggerDoc() map[string]string
type ClusterVersionArchitecture ¶
type ClusterVersionArchitecture string
ClusterVersionArchitecture enumerates valid cluster architectures. +kubebuilder:validation:Enum="Multi";""
const ( // ClusterVersionArchitectureMulti identifies a multi architecture. A multi // architecture cluster is capable of running nodes with multiple architectures. ClusterVersionArchitectureMulti ClusterVersionArchitecture = "Multi" )
type ClusterVersionCapabilitiesSpec ¶
type ClusterVersionCapabilitiesSpec struct { // 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. // +optional BaselineCapabilitySet ClusterVersionCapabilitySet `json:"baselineCapabilitySet,omitempty"` // additionalEnabledCapabilities extends the set of managed // capabilities beyond the baseline defined in // baselineCapabilitySet. The default is an empty set. // +listType=atomic // +optional AdditionalEnabledCapabilities []ClusterVersionCapability `json:"additionalEnabledCapabilities,omitempty"` }
ClusterVersionCapabilitiesSpec selects the managed set of optional, core cluster components. +k8s:deepcopy-gen=true
func (*ClusterVersionCapabilitiesSpec) DeepCopy ¶
func (in *ClusterVersionCapabilitiesSpec) DeepCopy() *ClusterVersionCapabilitiesSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersionCapabilitiesSpec.
func (*ClusterVersionCapabilitiesSpec) DeepCopyInto ¶
func (in *ClusterVersionCapabilitiesSpec) DeepCopyInto(out *ClusterVersionCapabilitiesSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterVersionCapabilitiesSpec) SwaggerDoc ¶
func (ClusterVersionCapabilitiesSpec) SwaggerDoc() map[string]string
type ClusterVersionCapabilitiesStatus ¶
type ClusterVersionCapabilitiesStatus struct { // enabledCapabilities lists all the capabilities that are currently managed. // +listType=atomic // +optional EnabledCapabilities []ClusterVersionCapability `json:"enabledCapabilities,omitempty"` // knownCapabilities lists all the capabilities known to the current cluster. // +listType=atomic // +optional KnownCapabilities []ClusterVersionCapability `json:"knownCapabilities,omitempty"` }
ClusterVersionCapabilitiesStatus describes the state of optional, core cluster components. +k8s:deepcopy-gen=true
func (*ClusterVersionCapabilitiesStatus) DeepCopy ¶
func (in *ClusterVersionCapabilitiesStatus) DeepCopy() *ClusterVersionCapabilitiesStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersionCapabilitiesStatus.
func (*ClusterVersionCapabilitiesStatus) DeepCopyInto ¶
func (in *ClusterVersionCapabilitiesStatus) DeepCopyInto(out *ClusterVersionCapabilitiesStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterVersionCapabilitiesStatus) SwaggerDoc ¶
func (ClusterVersionCapabilitiesStatus) SwaggerDoc() map[string]string
type ClusterVersionCapability ¶
type ClusterVersionCapability string
ClusterVersionCapability enumerates optional, core cluster components. +kubebuilder:validation:Enum=openshift-samples;baremetal;marketplace;Console;Insights;Storage;CSISnapshot;NodeTuning;MachineAPI;Build;DeploymentConfig;ImageRegistry;OperatorLifecycleManager;CloudCredential;Ingress;CloudControllerManager;OperatorLifecycleManagerV1
const ( // ClusterVersionCapabilityOpenShiftSamples manages the sample // image streams and templates stored in the openshift // namespace, and any registry credentials, stored as a secret, // needed for the image streams to import the images they // reference. ClusterVersionCapabilityOpenShiftSamples ClusterVersionCapability = "openshift-samples" // ClusterVersionCapabilityBaremetal manages the cluster // baremetal operator which is responsible for running the metal3 // deployment. ClusterVersionCapabilityBaremetal ClusterVersionCapability = "baremetal" // ClusterVersionCapabilityMarketplace manages the Marketplace operator which // supplies Operator Lifecycle Manager (OLM) users with default catalogs of // "optional" operators. // // Note that Marketplace has a hard requirement on OLM. OLM can not be disabled // while Marketplace is enabled. ClusterVersionCapabilityMarketplace ClusterVersionCapability = "marketplace" // ClusterVersionCapabilityConsole manages the Console operator which // installs and maintains the web console. ClusterVersionCapabilityConsole ClusterVersionCapability = "Console" // ClusterVersionCapabilityInsights manages the Insights operator which // collects anonymized information about the cluster to generate // recommendations for possible cluster issues. ClusterVersionCapabilityInsights ClusterVersionCapability = "Insights" // ClusterVersionCapabilityStorage manages the storage operator which // is responsible for providing cluster-wide storage defaults // WARNING: Do not disable this capability when deployed to // RHEV and OpenStack without reading the docs. // These clusters heavily rely on that capability and may cause // damage to the cluster. ClusterVersionCapabilityStorage ClusterVersionCapability = "Storage" // ClusterVersionCapabilityCSISnapshot manages the csi snapshot // controller operator which is responsible for watching the // VolumeSnapshot CRD objects and manages the creation and deletion // lifecycle of volume snapshots ClusterVersionCapabilityCSISnapshot ClusterVersionCapability = "CSISnapshot" // ClusterVersionCapabilityNodeTuning manages the Node Tuning Operator // which is responsible for watching the Tuned and Profile CRD // objects and manages the containerized TuneD daemon which controls // system level tuning of Nodes ClusterVersionCapabilityNodeTuning ClusterVersionCapability = "NodeTuning" // ClusterVersionCapabilityMachineAPI manages // machine-api-operator // cluster-autoscaler-operator // cluster-control-plane-machine-set-operator // which is responsible for machines configuration and heavily // targeted for SNO clusters. // // The following CRDs are disabled as well // machines // machineset // controlplanemachineset // // WARNING: Do not disable that capability without reading // documentation. This is important part of openshift system // and may cause cluster damage ClusterVersionCapabilityMachineAPI ClusterVersionCapability = "MachineAPI" // ClusterVersionCapabilityBuild manages the Build API which is responsible // for watching the Build API objects and managing their lifecycle. // The functionality is located under openshift-apiserver and openshift-controller-manager. // // The following resources are taken into account: // - builds // - buildconfigs ClusterVersionCapabilityBuild ClusterVersionCapability = "Build" // ClusterVersionCapabilityDeploymentConfig manages the DeploymentConfig API // which is responsible for watching the DeploymentConfig API and managing their lifecycle. // The functionality is located under openshift-apiserver and openshift-controller-manager. // // The following resources are taken into account: // - deploymentconfigs ClusterVersionCapabilityDeploymentConfig ClusterVersionCapability = "DeploymentConfig" // ClusterVersionCapabilityImageRegistry manages the image registry which // allows to distribute Docker images ClusterVersionCapabilityImageRegistry ClusterVersionCapability = "ImageRegistry" // ClusterVersionCapabilityOperatorLifecycleManager manages the Operator Lifecycle Manager (legacy) // which itself manages the lifecycle of operators ClusterVersionCapabilityOperatorLifecycleManager ClusterVersionCapability = "OperatorLifecycleManager" // ClusterVersionCapabilityOperatorLifecycleManagerV1 manages the Operator Lifecycle Manager (v1) // which itself manages the lifecycle of operators ClusterVersionCapabilityOperatorLifecycleManagerV1 ClusterVersionCapability = "OperatorLifecycleManagerV1" // ClusterVersionCapabilityCloudCredential manages credentials for cloud providers // in openshift cluster ClusterVersionCapabilityCloudCredential ClusterVersionCapability = "CloudCredential" // ClusterVersionCapabilityIngress manages the cluster ingress operator // which is responsible for running the ingress controllers (including OpenShift router). // // The following CRDs are part of the capability as well: // IngressController // DNSRecord // GatewayClass // Gateway // HTTPRoute // ReferenceGrant // // WARNING: This capability cannot be disabled on the standalone OpenShift. ClusterVersionCapabilityIngress ClusterVersionCapability = "Ingress" // ClusterVersionCapabilityCloudControllerManager manages various Cloud Controller // Managers deployed on top of OpenShift. They help you to work with cloud // provider API and embeds cloud-specific control logic. ClusterVersionCapabilityCloudControllerManager ClusterVersionCapability = "CloudControllerManager" )
type ClusterVersionCapabilitySet ¶
type ClusterVersionCapabilitySet string
ClusterVersionCapabilitySet defines sets of cluster version capabilities. +kubebuilder:validation:Enum=None;v4.11;v4.12;v4.13;v4.14;v4.15;v4.16;v4.17;v4.18;vCurrent
const ( // ClusterVersionCapabilitySetNone is an empty set enabling // no optional capabilities. ClusterVersionCapabilitySetNone ClusterVersionCapabilitySet = "None" // ClusterVersionCapabilitySet4_11 is the recommended set of // optional capabilities to enable for the 4.11 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_11 ClusterVersionCapabilitySet = "v4.11" // ClusterVersionCapabilitySet4_12 is the recommended set of // optional capabilities to enable for the 4.12 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_12 ClusterVersionCapabilitySet = "v4.12" // ClusterVersionCapabilitySet4_13 is the recommended set of // optional capabilities to enable for the 4.13 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_13 ClusterVersionCapabilitySet = "v4.13" // ClusterVersionCapabilitySet4_14 is the recommended set of // optional capabilities to enable for the 4.14 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_14 ClusterVersionCapabilitySet = "v4.14" // ClusterVersionCapabilitySet4_15 is the recommended set of // optional capabilities to enable for the 4.15 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_15 ClusterVersionCapabilitySet = "v4.15" // ClusterVersionCapabilitySet4_16 is the recommended set of // optional capabilities to enable for the 4.16 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_16 ClusterVersionCapabilitySet = "v4.16" // ClusterVersionCapabilitySet4_17 is the recommended set of // optional capabilities to enable for the 4.17 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_17 ClusterVersionCapabilitySet = "v4.17" // ClusterVersionCapabilitySet4_18 is the recommended set of // optional capabilities to enable for the 4.18 version of // OpenShift. This list will remain the same no matter which // version of OpenShift is installed. ClusterVersionCapabilitySet4_18 ClusterVersionCapabilitySet = "v4.18" // ClusterVersionCapabilitySetCurrent is the recommended set // of optional capabilities to enable for the cluster's // current version of OpenShift. ClusterVersionCapabilitySetCurrent ClusterVersionCapabilitySet = "vCurrent" )
type ClusterVersionList ¶
type ClusterVersionList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []ClusterVersion `json:"items"` }
ClusterVersionList is a list of ClusterVersion resources.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +openshift:compatibility-gen:level=1
func (*ClusterVersionList) DeepCopy ¶
func (in *ClusterVersionList) DeepCopy() *ClusterVersionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersionList.
func (*ClusterVersionList) DeepCopyInto ¶
func (in *ClusterVersionList) DeepCopyInto(out *ClusterVersionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterVersionList) DeepCopyObject ¶
func (in *ClusterVersionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ClusterVersionList) SwaggerDoc ¶
func (ClusterVersionList) SwaggerDoc() map[string]string
type ClusterVersionSpec ¶
type ClusterVersionSpec struct { // 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. // +required ClusterID ClusterID `json:"clusterID"` // 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. // // Some 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. // // If 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. // // +optional DesiredUpdate *Update `json:"desiredUpdate,omitempty"` // upstream may be used to specify the preferred update server. By default // it will use the appropriate update server for the cluster and region. // // +optional Upstream URL `json:"upstream,omitempty"` // 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. // // +optional Channel string `json:"channel,omitempty"` // 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. // +optional Capabilities *ClusterVersionCapabilitiesSpec `json:"capabilities,omitempty"` // signatureStores contains the upstream URIs to verify release signatures and optional // reference to a config map by name containing the PEM-encoded CA bundle. // // By default, CVO will use existing signature stores if this property is empty. // The CVO will check the release signatures in the local ConfigMaps first. It will search for a valid signature // in these stores in parallel only when local ConfigMaps did not include a valid signature. // Validation will fail if none of the signature stores reply with valid signature before timeout. // Setting signatureStores will replace the default signature stores with custom signature stores. // Default stores can be used with custom signature stores by adding them manually. // // A maximum of 32 signature stores may be configured. // +kubebuilder:validation:MaxItems=32 // +openshift:enable:FeatureGate=SignatureStores // +listType=map // +listMapKey=url // +optional SignatureStores []SignatureStore `json:"signatureStores"` // 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. // +listType=map // +listMapKey=kind // +listMapKey=group // +listMapKey=namespace // +listMapKey=name // +optional Overrides []ComponentOverride `json:"overrides,omitempty"` }
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. +k8s:deepcopy-gen=true
func (*ClusterVersionSpec) DeepCopy ¶
func (in *ClusterVersionSpec) DeepCopy() *ClusterVersionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersionSpec.
func (*ClusterVersionSpec) DeepCopyInto ¶
func (in *ClusterVersionSpec) DeepCopyInto(out *ClusterVersionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterVersionSpec) SwaggerDoc ¶
func (ClusterVersionSpec) SwaggerDoc() map[string]string
type ClusterVersionStatus ¶
type ClusterVersionStatus struct { // 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. // +required Desired Release `json:"desired"` // 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. // +listType=atomic // +optional History []UpdateHistory `json:"history,omitempty"` // 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. // +required ObservedGeneration int64 `json:"observedGeneration"` // 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. // +required VersionHash string `json:"versionHash"` // capabilities describes the state of optional, core cluster components. Capabilities ClusterVersionCapabilitiesStatus `json:"capabilities"` // 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. // +listType=map // +listMapKey=type // +patchMergeKey=type // +patchStrategy=merge // +optional Conditions []ClusterOperatorStatusCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // 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. // +nullable // +listType=atomic // +required AvailableUpdates []Release `json:"availableUpdates"` // 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. // +listType=atomic // +optional ConditionalUpdates []ConditionalUpdate `json:"conditionalUpdates,omitempty"` }
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. +k8s:deepcopy-gen=true
func (*ClusterVersionStatus) DeepCopy ¶
func (in *ClusterVersionStatus) DeepCopy() *ClusterVersionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterVersionStatus.
func (*ClusterVersionStatus) DeepCopyInto ¶
func (in *ClusterVersionStatus) DeepCopyInto(out *ClusterVersionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterVersionStatus) SwaggerDoc ¶
func (ClusterVersionStatus) SwaggerDoc() map[string]string
type ComponentOverride ¶
type ComponentOverride struct { // kind indentifies which object to override. // +required Kind string `json:"kind"` // group identifies the API group that the kind is in. // +required Group string `json:"group"` // namespace is the component's namespace. If the resource is cluster // scoped, the namespace should be empty. // +required Namespace string `json:"namespace"` // name is the component's name. // +required Name string `json:"name"` // unmanaged controls if cluster version operator should stop managing the // resources in this cluster. // Default: false // +required Unmanaged bool `json:"unmanaged"` }
ComponentOverride allows overriding cluster version operator's behavior for a component. +k8s:deepcopy-gen=true
func (*ComponentOverride) DeepCopy ¶
func (in *ComponentOverride) DeepCopy() *ComponentOverride
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentOverride.
func (*ComponentOverride) DeepCopyInto ¶
func (in *ComponentOverride) DeepCopyInto(out *ComponentOverride)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ComponentOverride) SwaggerDoc ¶
func (ComponentOverride) SwaggerDoc() map[string]string
type ComponentRouteSpec ¶
type ComponentRouteSpec struct { // namespace is the namespace of the route to customize. // // The namespace and name of this componentRoute must match a corresponding // entry in the list of status.componentRoutes if the route is to be customized. // +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +required Namespace string `json:"namespace"` // name is the logical name of the route to customize. // // The namespace and name of this componentRoute must match a corresponding // entry in the list of status.componentRoutes if the route is to be customized. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +required Name string `json:"name"` // hostname is the hostname that should be used by the route. // +required Hostname Hostname `json:"hostname"` // 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. // +optional ServingCertKeyPairSecret SecretNameReference `json:"servingCertKeyPairSecret"` }
ComponentRouteSpec allows for configuration of a route's hostname and serving certificate.
func (*ComponentRouteSpec) DeepCopy ¶
func (in *ComponentRouteSpec) DeepCopy() *ComponentRouteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentRouteSpec.
func (*ComponentRouteSpec) DeepCopyInto ¶
func (in *ComponentRouteSpec) DeepCopyInto(out *ComponentRouteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ComponentRouteSpec) SwaggerDoc ¶
func (ComponentRouteSpec) SwaggerDoc() map[string]string
type ComponentRouteStatus ¶
type ComponentRouteStatus struct { // 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. // // The namespace and name of this componentRoute must match a corresponding // entry in the list of spec.componentRoutes if the route is to be customized. // +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +required Namespace string `json:"namespace"` // 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. // // The namespace and name of this componentRoute must match a corresponding // entry in the list of spec.componentRoutes if the route is to be customized. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +required Name string `json:"name"` // defaultHostname is the hostname of this route prior to customization. // +required DefaultHostname Hostname `json:"defaultHostname"` // consumingUsers is a slice of ServiceAccounts that need to have read permission on the servingCertKeyPairSecret secret. // +kubebuilder:validation:MaxItems=5 // +optional ConsumingUsers []ConsumingUser `json:"consumingUsers,omitempty"` // 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. // +kubebuilder:validation:MinItems=1 // +optional CurrentHostnames []Hostname `json:"currentHostnames,omitempty"` // conditions are used to communicate the state of the componentRoutes entry. // // Supported conditions include Available, Degraded and Progressing. // // If 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. // // If 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. // // If Progressing is true, that means the component is taking some action related to the componentRoutes entry. // +optional // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty"` // relatedObjects is a list of resources which are useful when debugging or inspecting how spec.componentRoutes is applied. // +kubebuilder:validation:MinItems=1 // +required RelatedObjects []ObjectReference `json:"relatedObjects"` }
ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate.
func (*ComponentRouteStatus) DeepCopy ¶
func (in *ComponentRouteStatus) DeepCopy() *ComponentRouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentRouteStatus.
func (*ComponentRouteStatus) DeepCopyInto ¶
func (in *ComponentRouteStatus) DeepCopyInto(out *ComponentRouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ComponentRouteStatus) SwaggerDoc ¶
func (ComponentRouteStatus) SwaggerDoc() map[string]string
type ConditionStatus ¶
type ConditionStatus string
const ( ConditionTrue ConditionStatus = "True" ConditionFalse ConditionStatus = "False" ConditionUnknown ConditionStatus = "Unknown" )
These are valid condition statuses. "ConditionTrue" means a resource is in the condition. "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.
type ConditionalUpdate ¶
type ConditionalUpdate struct { // release is the target of the update. // +required Release Release `json:"release"` // 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. // +kubebuilder:validation:MinItems=1 // +patchMergeKey=name // +patchStrategy=merge // +listType=map // +listMapKey=name // +required Risks []ConditionalUpdateRisk `json:"risks" patchStrategy:"merge" patchMergeKey:"name"` // conditions represents the observations of the conditional update's // current status. Known types are: // * Recommended, for whether the update is recommended for the current cluster. // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` }
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.
func (*ConditionalUpdate) DeepCopy ¶
func (in *ConditionalUpdate) DeepCopy() *ConditionalUpdate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionalUpdate.
func (*ConditionalUpdate) DeepCopyInto ¶
func (in *ConditionalUpdate) DeepCopyInto(out *ConditionalUpdate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConditionalUpdate) SwaggerDoc ¶
func (ConditionalUpdate) SwaggerDoc() map[string]string
type ConditionalUpdateRisk ¶
type ConditionalUpdateRisk struct { // url contains information about this risk. // +kubebuilder:validation:Format=uri // +kubebuilder:validation:MinLength=1 // +required URL string `json:"url"` // name is the CamelCase reason for not recommending a // conditional update, in the event that matchingRules match the // cluster state. // +kubebuilder:validation:MinLength=1 // +required Name string `json:"name"` // 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. // +kubebuilder:validation:MinLength=1 // +required Message string `json:"message"` // 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. // +kubebuilder:validation:MinItems=1 // +listType=atomic // +required MatchingRules []ClusterCondition `json:"matchingRules"` }
ConditionalUpdateRisk represents a reason and cluster-state for not recommending a conditional update. +k8s:deepcopy-gen=true
func (*ConditionalUpdateRisk) DeepCopy ¶
func (in *ConditionalUpdateRisk) DeepCopy() *ConditionalUpdateRisk
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionalUpdateRisk.
func (*ConditionalUpdateRisk) DeepCopyInto ¶
func (in *ConditionalUpdateRisk) DeepCopyInto(out *ConditionalUpdateRisk)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConditionalUpdateRisk) SwaggerDoc ¶
func (ConditionalUpdateRisk) SwaggerDoc() map[string]string
type ConfigMapFileReference ¶
type ConfigMapFileReference struct { Name string `json:"name"` // key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. Key string `json:"key,omitempty"` }
ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.
func (*ConfigMapFileReference) DeepCopy ¶
func (in *ConfigMapFileReference) DeepCopy() *ConfigMapFileReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapFileReference.
func (*ConfigMapFileReference) DeepCopyInto ¶
func (in *ConfigMapFileReference) DeepCopyInto(out *ConfigMapFileReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConfigMapFileReference) SwaggerDoc ¶
func (ConfigMapFileReference) SwaggerDoc() map[string]string
type ConfigMapNameReference ¶
type ConfigMapNameReference struct { // name is the metadata.name of the referenced config map // +required Name string `json:"name"` }
ConfigMapNameReference references a config map in a specific namespace. The namespace must be specified at the point of use.
func (*ConfigMapNameReference) DeepCopy ¶
func (in *ConfigMapNameReference) DeepCopy() *ConfigMapNameReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapNameReference.
func (*ConfigMapNameReference) DeepCopyInto ¶
func (in *ConfigMapNameReference) DeepCopyInto(out *ConfigMapNameReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConfigMapNameReference) SwaggerDoc ¶
func (ConfigMapNameReference) SwaggerDoc() map[string]string
type Console ¶
type Console struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ConsoleSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status ConsoleStatus `json:"status"` }
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`.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=consoles,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Console) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Console.
func (*Console) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Console) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Console) SwaggerDoc ¶
type ConsoleAuthentication ¶
type ConsoleAuthentication struct { // 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. // +optional // +kubebuilder:validation:Pattern=`^$|^((https):\/\/?)[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|\/?))$` LogoutRedirect string `json:"logoutRedirect,omitempty"` }
ConsoleAuthentication defines a list of optional configuration for console authentication.
func (*ConsoleAuthentication) DeepCopy ¶
func (in *ConsoleAuthentication) DeepCopy() *ConsoleAuthentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleAuthentication.
func (*ConsoleAuthentication) DeepCopyInto ¶
func (in *ConsoleAuthentication) DeepCopyInto(out *ConsoleAuthentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleAuthentication) SwaggerDoc ¶
func (ConsoleAuthentication) SwaggerDoc() map[string]string
type ConsoleList ¶
type ConsoleList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Console `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ConsoleList) DeepCopy ¶
func (in *ConsoleList) DeepCopy() *ConsoleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleList.
func (*ConsoleList) DeepCopyInto ¶
func (in *ConsoleList) DeepCopyInto(out *ConsoleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConsoleList) DeepCopyObject ¶
func (in *ConsoleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleList) SwaggerDoc ¶
func (ConsoleList) SwaggerDoc() map[string]string
type ConsoleSpec ¶
type ConsoleSpec struct { // +optional Authentication ConsoleAuthentication `json:"authentication"` }
ConsoleSpec is the specification of the desired behavior of the Console.
func (*ConsoleSpec) DeepCopy ¶
func (in *ConsoleSpec) DeepCopy() *ConsoleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleSpec.
func (*ConsoleSpec) DeepCopyInto ¶
func (in *ConsoleSpec) DeepCopyInto(out *ConsoleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleSpec) SwaggerDoc ¶
func (ConsoleSpec) SwaggerDoc() map[string]string
type ConsoleStatus ¶
type ConsoleStatus struct { // The URL for the console. This will be derived from the host for the route that // is created for the console. ConsoleURL string `json:"consoleURL"` }
ConsoleStatus defines the observed status of the Console.
func (*ConsoleStatus) DeepCopy ¶
func (in *ConsoleStatus) DeepCopy() *ConsoleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleStatus.
func (*ConsoleStatus) DeepCopyInto ¶
func (in *ConsoleStatus) DeepCopyInto(out *ConsoleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleStatus) SwaggerDoc ¶
func (ConsoleStatus) SwaggerDoc() map[string]string
type ConsumingUser ¶
type ConsumingUser string
ConsumingUser is an alias for string which we add validation to. Currently only service accounts are supported. +kubebuilder:validation:Pattern="^system:serviceaccount:[a-z0-9]([-a-z0-9]*[a-z0-9])?:[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=512
type CustomFeatureGates ¶
type CustomFeatureGates struct { // enabled is a list of all feature gates that you want to force on // +optional Enabled []FeatureGateName `json:"enabled,omitempty"` // disabled is a list of all feature gates that you want to force off // +optional Disabled []FeatureGateName `json:"disabled,omitempty"` }
func (*CustomFeatureGates) DeepCopy ¶
func (in *CustomFeatureGates) DeepCopy() *CustomFeatureGates
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomFeatureGates.
func (*CustomFeatureGates) DeepCopyInto ¶
func (in *CustomFeatureGates) DeepCopyInto(out *CustomFeatureGates)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CustomFeatureGates) SwaggerDoc ¶
func (CustomFeatureGates) SwaggerDoc() map[string]string
type CustomTLSProfile ¶
type CustomTLSProfile struct {
TLSProfileSpec `json:",inline"`
}
CustomTLSProfile is a user-defined TLS security profile. Be extremely careful using a custom TLS profile as invalid configurations can be catastrophic.
func (*CustomTLSProfile) DeepCopy ¶
func (in *CustomTLSProfile) DeepCopy() *CustomTLSProfile
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomTLSProfile.
func (*CustomTLSProfile) DeepCopyInto ¶
func (in *CustomTLSProfile) DeepCopyInto(out *CustomTLSProfile)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CustomTLSProfile) SwaggerDoc ¶
func (CustomTLSProfile) SwaggerDoc() map[string]string
type DNS ¶
type DNS struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec DNSSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status DNSStatus `json:"status"` }
DNS holds cluster-wide information about DNS. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=dnses,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*DNS) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNS.
func (*DNS) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DNS) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (DNS) SwaggerDoc ¶
type DNSList ¶
type DNSList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []DNS `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*DNSList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSList.
func (*DNSList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DNSList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (DNSList) SwaggerDoc ¶
type DNSPlatformSpec ¶
type DNSPlatformSpec struct { // type is the underlying infrastructure provider for the cluster. // Allowed values: "", "AWS". // // Individual components may not support all platforms, // and must handle unrecognized platforms with best-effort defaults. // // +unionDiscriminator // +required // +kubebuilder:validation:XValidation:rule="self in [”,'AWS']",message="allowed values are ” and 'AWS'" Type PlatformType `json:"type"` // aws contains DNS configuration specific to the Amazon Web Services cloud provider. // +optional AWS *AWSDNSSpec `json:"aws"` }
DNSPlatformSpec holds cloud-provider-specific configuration for DNS administration. +union +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'AWS' ? has(self.aws) : !has(self.aws)",message="aws configuration is required when platform is AWS, and forbidden otherwise"
func (*DNSPlatformSpec) DeepCopy ¶
func (in *DNSPlatformSpec) DeepCopy() *DNSPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSPlatformSpec.
func (*DNSPlatformSpec) DeepCopyInto ¶
func (in *DNSPlatformSpec) DeepCopyInto(out *DNSPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSPlatformSpec) SwaggerDoc ¶
func (DNSPlatformSpec) SwaggerDoc() map[string]string
type DNSSpec ¶
type DNSSpec struct { // baseDomain is the base domain of the cluster. All managed DNS records will // be sub-domains of this base. // // For example, given the base domain `openshift.example.com`, an API server // DNS record may be created for `cluster-api.openshift.example.com`. // // Once set, this field cannot be changed. BaseDomain string `json:"baseDomain"` // publicZone is the location where all the DNS records that are publicly accessible to // the internet exist. // // If this field is nil, no public records should be created. // // Once set, this field cannot be changed. // // +optional PublicZone *DNSZone `json:"publicZone,omitempty"` // privateZone is the location where all the DNS records that are only available internally // to the cluster exist. // // If this field is nil, no private records should be created. // // Once set, this field cannot be changed. // // +optional PrivateZone *DNSZone `json:"privateZone,omitempty"` // platform holds configuration specific to the underlying // infrastructure provider for DNS. // 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. // +optional Platform DNSPlatformSpec `json:"platform,omitempty"` }
func (*DNSSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSSpec.
func (*DNSSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSSpec) SwaggerDoc ¶
type DNSStatus ¶
type DNSStatus struct { }
func (*DNSStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSStatus.
func (*DNSStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DNSType ¶
type DNSType string
DNSType indicates whether the cluster DNS is hosted by the cluster or Core DNS .
const ( // ClusterHosted indicates that a DNS solution other than the default provided by the // cloud platform is in use. In this mode, the cluster hosts a DNS solution during installation and the // user is expected to provide their own DNS solution post-install. // When the DNS solution is `ClusterHosted`, the cluster will continue to use the // default Load Balancers provided by the cloud platform. ClusterHostedDNSType DNSType = "ClusterHosted" // PlatformDefault indicates that the cluster is using the default DNS solution for the // cloud platform. OpenShift is responsible for all the LB and DNS configuration needed for the // cluster to be functional with no intervention from the user. To accomplish this, OpenShift // configures the default LB and DNS solutions provided by the underlying cloud. PlatformDefaultDNSType DNSType = "PlatformDefault" )
type DNSZone ¶
type DNSZone struct { // id is the identifier that can be used to find the DNS hosted zone. // // on 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]. // // [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 // +optional ID string `json:"id,omitempty"` // tags can be used to query the DNS hosted zone. // // on AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters, // // [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options // +optional Tags map[string]string `json:"tags,omitempty"` }
DNSZone is used to define a DNS hosted zone. A zone can be identified by an ID or tags.
func (*DNSZone) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSZone.
func (*DNSZone) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSZone) SwaggerDoc ¶
type DRAEnablement ¶
type DRAEnablement string
+kubebuilder:validation:Enum:="";"Enabled";"Disabled"
var ( // DRAEnablementEnabled enables dynamic resource allocation feature DRAEnablementEnabled DRAEnablement = "Enabled" // DRAEnablementDisabled disables dynamic resource allocation feature DRAEnablementDisabled DRAEnablement = "Disabled" )
type DefaultPlacement ¶
type DefaultPlacement string
DefaultPlacement defines the default placement of ingress router pods.
const ( // "Workers" is for having router pods placed on worker nodes by default. DefaultPlacementWorkers DefaultPlacement = "Workers" // "ControlPlane" is for having router pods placed on control-plane nodes by default. DefaultPlacementControlPlane DefaultPlacement = "ControlPlane" )
type DelegatedAuthentication ¶
type DelegatedAuthentication struct { // disabled indicates that authentication should be disabled. By default it will use delegated authentication. Disabled bool `json:"disabled,omitempty"` }
DelegatedAuthentication allows authentication to be disabled.
func (*DelegatedAuthentication) DeepCopy ¶
func (in *DelegatedAuthentication) DeepCopy() *DelegatedAuthentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DelegatedAuthentication.
func (*DelegatedAuthentication) DeepCopyInto ¶
func (in *DelegatedAuthentication) DeepCopyInto(out *DelegatedAuthentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DelegatedAuthentication) SwaggerDoc ¶
func (DelegatedAuthentication) SwaggerDoc() map[string]string
type DelegatedAuthorization ¶
type DelegatedAuthorization struct { // disabled indicates that authorization should be disabled. By default it will use delegated authorization. Disabled bool `json:"disabled,omitempty"` }
DelegatedAuthorization allows authorization to be disabled.
func (*DelegatedAuthorization) DeepCopy ¶
func (in *DelegatedAuthorization) DeepCopy() *DelegatedAuthorization
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DelegatedAuthorization.
func (*DelegatedAuthorization) DeepCopyInto ¶
func (in *DelegatedAuthorization) DeepCopyInto(out *DelegatedAuthorization)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DelegatedAuthorization) SwaggerDoc ¶
func (DelegatedAuthorization) SwaggerDoc() map[string]string
type DeprecatedWebhookTokenAuthenticator ¶
type DeprecatedWebhookTokenAuthenticator struct { // 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. KubeConfig SecretNameReference `json:"kubeConfig"` }
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.
func (*DeprecatedWebhookTokenAuthenticator) DeepCopy ¶
func (in *DeprecatedWebhookTokenAuthenticator) DeepCopy() *DeprecatedWebhookTokenAuthenticator
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeprecatedWebhookTokenAuthenticator.
func (*DeprecatedWebhookTokenAuthenticator) DeepCopyInto ¶
func (in *DeprecatedWebhookTokenAuthenticator) DeepCopyInto(out *DeprecatedWebhookTokenAuthenticator)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DeprecatedWebhookTokenAuthenticator) SwaggerDoc ¶
func (DeprecatedWebhookTokenAuthenticator) SwaggerDoc() map[string]string
type EncryptionType ¶
type EncryptionType string
+kubebuilder:validation:Enum="";identity;aescbc;aesgcm
const ( // identity refers to a type where no encryption is performed at the datastore layer. // Resources are written as-is without encryption. EncryptionTypeIdentity EncryptionType = "identity" // aescbc refers to a type where AES-CBC with PKCS#7 padding and a 32-byte key // is used to perform encryption at the datastore layer. EncryptionTypeAESCBC EncryptionType = "aescbc" // aesgcm refers to a type where AES-GCM with random nonce and a 32-byte key // is used to perform encryption at the datastore layer. EncryptionTypeAESGCM EncryptionType = "aesgcm" )
type EquinixMetalPlatformSpec ¶
type EquinixMetalPlatformSpec struct{}
EquinixMetalPlatformSpec holds the desired state of the Equinix Metal infrastructure provider. This only includes fields that can be modified in the cluster.
func (*EquinixMetalPlatformSpec) DeepCopy ¶
func (in *EquinixMetalPlatformSpec) DeepCopy() *EquinixMetalPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EquinixMetalPlatformSpec.
func (*EquinixMetalPlatformSpec) DeepCopyInto ¶
func (in *EquinixMetalPlatformSpec) DeepCopyInto(out *EquinixMetalPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EquinixMetalPlatformSpec) SwaggerDoc ¶
func (EquinixMetalPlatformSpec) SwaggerDoc() map[string]string
type EquinixMetalPlatformStatus ¶
type EquinixMetalPlatformStatus struct { // 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. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. IngressIP string `json:"ingressIP,omitempty"` }
EquinixMetalPlatformStatus holds the current status of the Equinix Metal infrastructure provider.
func (*EquinixMetalPlatformStatus) DeepCopy ¶
func (in *EquinixMetalPlatformStatus) DeepCopy() *EquinixMetalPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EquinixMetalPlatformStatus.
func (*EquinixMetalPlatformStatus) DeepCopyInto ¶
func (in *EquinixMetalPlatformStatus) DeepCopyInto(out *EquinixMetalPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EquinixMetalPlatformStatus) SwaggerDoc ¶
func (EquinixMetalPlatformStatus) SwaggerDoc() map[string]string
type EtcdConnectionInfo ¶
type EtcdConnectionInfo struct { // urls are the URLs for etcd URLs []string `json:"urls,omitempty"` // ca is a file containing trusted roots for the etcd server certificates CA string `json:"ca"` // CertInfo is the TLS client cert information for securing communication to etcd // this is anonymous so that we can inline it for serialization CertInfo `json:",inline"` }
EtcdConnectionInfo holds information necessary for connecting to an etcd server
func (*EtcdConnectionInfo) DeepCopy ¶
func (in *EtcdConnectionInfo) DeepCopy() *EtcdConnectionInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EtcdConnectionInfo.
func (*EtcdConnectionInfo) DeepCopyInto ¶
func (in *EtcdConnectionInfo) DeepCopyInto(out *EtcdConnectionInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EtcdConnectionInfo) SwaggerDoc ¶
func (EtcdConnectionInfo) SwaggerDoc() map[string]string
type EtcdStorageConfig ¶
type EtcdStorageConfig struct { EtcdConnectionInfo `json:",inline"` // 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. StoragePrefix string `json:"storagePrefix"` }
func (*EtcdStorageConfig) DeepCopy ¶
func (in *EtcdStorageConfig) DeepCopy() *EtcdStorageConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EtcdStorageConfig.
func (*EtcdStorageConfig) DeepCopyInto ¶
func (in *EtcdStorageConfig) DeepCopyInto(out *EtcdStorageConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EtcdStorageConfig) SwaggerDoc ¶
func (EtcdStorageConfig) SwaggerDoc() map[string]string
type ExternalIPConfig ¶
type ExternalIPConfig struct { // policy is a set of restrictions applied to the ExternalIP field. // If nil or empty, then ExternalIP is not allowed to be set. // +optional Policy *ExternalIPPolicy `json:"policy,omitempty"` // 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. // +optional // +listType=atomic AutoAssignCIDRs []string `json:"autoAssignCIDRs,omitempty"` }
ExternalIPConfig specifies some IP blocks relevant for the ExternalIP field of a Service resource.
func (*ExternalIPConfig) DeepCopy ¶
func (in *ExternalIPConfig) DeepCopy() *ExternalIPConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalIPConfig.
func (*ExternalIPConfig) DeepCopyInto ¶
func (in *ExternalIPConfig) DeepCopyInto(out *ExternalIPConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ExternalIPConfig) SwaggerDoc ¶
func (ExternalIPConfig) SwaggerDoc() map[string]string
type ExternalIPPolicy ¶
type ExternalIPPolicy struct { // allowedCIDRs is the list of allowed CIDRs. // +listType=atomic AllowedCIDRs []string `json:"allowedCIDRs,omitempty"` // rejectedCIDRs is the list of disallowed CIDRs. These take precedence // over allowedCIDRs. // +optional // +listType=atomic RejectedCIDRs []string `json:"rejectedCIDRs,omitempty"` }
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.
func (*ExternalIPPolicy) DeepCopy ¶
func (in *ExternalIPPolicy) DeepCopy() *ExternalIPPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalIPPolicy.
func (*ExternalIPPolicy) DeepCopyInto ¶
func (in *ExternalIPPolicy) DeepCopyInto(out *ExternalIPPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ExternalIPPolicy) SwaggerDoc ¶
func (ExternalIPPolicy) SwaggerDoc() map[string]string
type ExternalPlatformSpec ¶
type ExternalPlatformSpec struct { // 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. // +kubebuilder:default:="Unknown" // +default="Unknown" // +kubebuilder:validation:XValidation:rule="oldSelf == 'Unknown' || self == oldSelf",message="platform name cannot be changed once set" // +optional PlatformName string `json:"platformName,omitempty"` }
ExternalPlatformSpec holds the desired state for the generic External infrastructure provider.
func (*ExternalPlatformSpec) DeepCopy ¶
func (in *ExternalPlatformSpec) DeepCopy() *ExternalPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalPlatformSpec.
func (*ExternalPlatformSpec) DeepCopyInto ¶
func (in *ExternalPlatformSpec) DeepCopyInto(out *ExternalPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ExternalPlatformSpec) SwaggerDoc ¶
func (ExternalPlatformSpec) SwaggerDoc() map[string]string
type ExternalPlatformStatus ¶
type ExternalPlatformStatus struct { // cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). // When omitted, new nodes will be not tainted // and no extra initialization from the cloud controller manager is expected. // +optional CloudControllerManager CloudControllerManagerStatus `json:"cloudControllerManager"` }
ExternalPlatformStatus holds the current status of the generic External infrastructure provider. +kubebuilder:validation:XValidation:rule="has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager)",message="cloudControllerManager may not be added or removed once set"
func (*ExternalPlatformStatus) DeepCopy ¶
func (in *ExternalPlatformStatus) DeepCopy() *ExternalPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalPlatformStatus.
func (*ExternalPlatformStatus) DeepCopyInto ¶
func (in *ExternalPlatformStatus) DeepCopyInto(out *ExternalPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ExternalPlatformStatus) SwaggerDoc ¶
func (ExternalPlatformStatus) SwaggerDoc() map[string]string
type FeatureGate ¶
type FeatureGate struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required // +kubebuilder:validation:XValidation:rule="has(oldSelf.featureSet) ? has(self.featureSet) : true",message=".spec.featureSet cannot be removed" Spec FeatureGateSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status FeatureGateStatus `json:"status"` }
Feature holds cluster-wide information about feature gates. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=featuregates,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*FeatureGate) DeepCopy ¶
func (in *FeatureGate) DeepCopy() *FeatureGate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGate.
func (*FeatureGate) DeepCopyInto ¶
func (in *FeatureGate) DeepCopyInto(out *FeatureGate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FeatureGate) DeepCopyObject ¶
func (in *FeatureGate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (FeatureGate) SwaggerDoc ¶
func (FeatureGate) SwaggerDoc() map[string]string
type FeatureGateAttributes ¶
type FeatureGateAttributes struct { // name is the name of the FeatureGate. // +required Name FeatureGateName `json:"name"` }
func (*FeatureGateAttributes) DeepCopy ¶
func (in *FeatureGateAttributes) DeepCopy() *FeatureGateAttributes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateAttributes.
func (*FeatureGateAttributes) DeepCopyInto ¶
func (in *FeatureGateAttributes) DeepCopyInto(out *FeatureGateAttributes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeatureGateAttributes) SwaggerDoc ¶
func (FeatureGateAttributes) SwaggerDoc() map[string]string
type FeatureGateDetails ¶
type FeatureGateDetails struct { // version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field. // +required Version string `json:"version"` // enabled is a list of all feature gates that are enabled in the cluster for the named version. // +optional Enabled []FeatureGateAttributes `json:"enabled"` // disabled is a list of all feature gates that are disabled in the cluster for the named version. // +optional Disabled []FeatureGateAttributes `json:"disabled"` }
func (*FeatureGateDetails) DeepCopy ¶
func (in *FeatureGateDetails) DeepCopy() *FeatureGateDetails
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateDetails.
func (*FeatureGateDetails) DeepCopyInto ¶
func (in *FeatureGateDetails) DeepCopyInto(out *FeatureGateDetails)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeatureGateDetails) SwaggerDoc ¶
func (FeatureGateDetails) SwaggerDoc() map[string]string
type FeatureGateList ¶
type FeatureGateList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []FeatureGate `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*FeatureGateList) DeepCopy ¶
func (in *FeatureGateList) DeepCopy() *FeatureGateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateList.
func (*FeatureGateList) DeepCopyInto ¶
func (in *FeatureGateList) DeepCopyInto(out *FeatureGateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FeatureGateList) DeepCopyObject ¶
func (in *FeatureGateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (FeatureGateList) SwaggerDoc ¶
func (FeatureGateList) SwaggerDoc() map[string]string
type FeatureGateName ¶
type FeatureGateName string
FeatureGateName is a string to enforce patterns on the name of a FeatureGate +kubebuilder:validation:Pattern=`^([A-Za-z0-9-]+\.)*[A-Za-z0-9-]+\.?$`
type FeatureGateSelection ¶
type FeatureGateSelection struct { // 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. // +unionDiscriminator // +optional // +kubebuilder:validation:Enum=CustomNoUpgrade;DevPreviewNoUpgrade;TechPreviewNoUpgrade;"" // +kubebuilder:validation:XValidation:rule="oldSelf == 'CustomNoUpgrade' ? self == 'CustomNoUpgrade' : true",message="CustomNoUpgrade may not be changed" // +kubebuilder:validation:XValidation:rule="oldSelf == 'TechPreviewNoUpgrade' ? self == 'TechPreviewNoUpgrade' : true",message="TechPreviewNoUpgrade may not be changed" // +kubebuilder:validation:XValidation:rule="oldSelf == 'DevPreviewNoUpgrade' ? self == 'DevPreviewNoUpgrade' : true",message="DevPreviewNoUpgrade may not be changed" FeatureSet FeatureSet `json:"featureSet,omitempty"` // 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. // +optional // +nullable CustomNoUpgrade *CustomFeatureGates `json:"customNoUpgrade,omitempty"` }
+union
func (*FeatureGateSelection) DeepCopy ¶
func (in *FeatureGateSelection) DeepCopy() *FeatureGateSelection
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateSelection.
func (*FeatureGateSelection) DeepCopyInto ¶
func (in *FeatureGateSelection) DeepCopyInto(out *FeatureGateSelection)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeatureGateSelection) SwaggerDoc ¶
func (FeatureGateSelection) SwaggerDoc() map[string]string
type FeatureGateSpec ¶
type FeatureGateSpec struct {
FeatureGateSelection `json:",inline"`
}
func (*FeatureGateSpec) DeepCopy ¶
func (in *FeatureGateSpec) DeepCopy() *FeatureGateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateSpec.
func (*FeatureGateSpec) DeepCopyInto ¶
func (in *FeatureGateSpec) DeepCopyInto(out *FeatureGateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FeatureGateStatus ¶
type FeatureGateStatus struct { // conditions represent the observations of the current state. // Known .status.conditions.type are: "DeterminationDegraded" // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty"` // 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. // +listType=map // +listMapKey=version FeatureGates []FeatureGateDetails `json:"featureGates"` }
func (*FeatureGateStatus) DeepCopy ¶
func (in *FeatureGateStatus) DeepCopy() *FeatureGateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateStatus.
func (*FeatureGateStatus) DeepCopyInto ¶
func (in *FeatureGateStatus) DeepCopyInto(out *FeatureGateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeatureGateStatus) SwaggerDoc ¶
func (FeatureGateStatus) SwaggerDoc() map[string]string
type FeatureGateTests ¶
type FeatureGateTests struct { // featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance. FeatureGate string `json:"featureGate"` // tests contains an item for every TestName Tests []TestDetails `json:"tests"` }
func (*FeatureGateTests) DeepCopy ¶
func (in *FeatureGateTests) DeepCopy() *FeatureGateTests
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGateTests.
func (*FeatureGateTests) DeepCopyInto ¶
func (in *FeatureGateTests) DeepCopyInto(out *FeatureGateTests)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeatureGateTests) SwaggerDoc ¶
func (FeatureGateTests) SwaggerDoc() map[string]string
type FeatureSet ¶
type FeatureSet string
var ( // Default feature set that allows upgrades. Default FeatureSet = "" // TechPreviewNoUpgrade turns on tech preview features that are not part of the normal supported platform. Turning // this feature set on CANNOT BE UNDONE and PREVENTS UPGRADES. TechPreviewNoUpgrade FeatureSet = "TechPreviewNoUpgrade" // DevPreviewNoUpgrade turns on dev preview features that are not part of the normal supported platform. Turning // this feature set on CANNOT BE UNDONE and PREVENTS UPGRADES. DevPreviewNoUpgrade FeatureSet = "DevPreviewNoUpgrade" // 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. CustomNoUpgrade FeatureSet = "CustomNoUpgrade" // AllFixedFeatureSets are the featuresets that have known featuregates. Custom doesn't for instance. LatencySensitive is dead AllFixedFeatureSets = []FeatureSet{Default, TechPreviewNoUpgrade, DevPreviewNoUpgrade} )
type GCPPlatformSpec ¶
type GCPPlatformSpec struct{}
GCPPlatformSpec holds the desired state of the Google Cloud Platform infrastructure provider. This only includes fields that can be modified in the cluster.
func (*GCPPlatformSpec) DeepCopy ¶
func (in *GCPPlatformSpec) DeepCopy() *GCPPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPPlatformSpec.
func (*GCPPlatformSpec) DeepCopyInto ¶
func (in *GCPPlatformSpec) DeepCopyInto(out *GCPPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GCPPlatformSpec) SwaggerDoc ¶
func (GCPPlatformSpec) SwaggerDoc() map[string]string
type GCPPlatformStatus ¶
type GCPPlatformStatus struct { // resourceGroupName is the Project ID for new GCP resources created for the cluster. ProjectID string `json:"projectID"` // region holds the region for new GCP resources created for the cluster. Region string `json:"region"` // resourceLabels is a list of additional labels to apply to GCP resources created for the cluster. // See https://cloud.google.com/compute/docs/labeling-resources for information on labeling GCP resources. // GCP supports a maximum of 64 labels per resource. OpenShift reserves 32 labels for internal use, // allowing 32 labels for user configuration. // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, x in oldSelf) && oldSelf.all(x, x in self)",message="resourceLabels are immutable and may only be configured during installation" // +listType=map // +listMapKey=key // +optional // +openshift:enable:FeatureGate=GCPLabelsTags ResourceLabels []GCPResourceLabel `json:"resourceLabels,omitempty"` // resourceTags is a list of additional tags to apply to GCP resources created for the cluster. // See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on // tagging GCP resources. GCP supports a maximum of 50 tags per resource. // +kubebuilder:validation:MaxItems=50 // +kubebuilder:validation:XValidation:rule="self.all(x, x in oldSelf) && oldSelf.all(x, x in self)",message="resourceTags are immutable and may only be configured during installation" // +listType=map // +listMapKey=key // +optional // +openshift:enable:FeatureGate=GCPLabelsTags ResourceTags []GCPResourceTag `json:"resourceTags,omitempty"` // cloudLoadBalancerConfig holds configuration related to DNS and cloud // load balancers. It allows configuration of in-cluster DNS as an alternative // to the platform default DNS implementation. // When using the ClusterHosted DNS type, Load Balancer IP addresses // must be provided for the API and internal API load balancers as well as the // ingress load balancer. // // +default={"dnsType": "PlatformDefault"} // +kubebuilder:default={"dnsType": "PlatformDefault"} // +openshift:enable:FeatureGate=GCPClusterHostedDNS // +optional // +nullable CloudLoadBalancerConfig *CloudLoadBalancerConfig `json:"cloudLoadBalancerConfig,omitempty"` }
GCPPlatformStatus holds the current status of the Google Cloud Platform infrastructure provider. +openshift:validation:FeatureGateAwareXValidation:featureGate=GCPLabelsTags,rule="!has(oldSelf.resourceLabels) && !has(self.resourceLabels) || has(oldSelf.resourceLabels) && has(self.resourceLabels)",message="resourceLabels may only be configured during installation" +openshift:validation:FeatureGateAwareXValidation:featureGate=GCPLabelsTags,rule="!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)",message="resourceTags may only be configured during installation"
func (*GCPPlatformStatus) DeepCopy ¶
func (in *GCPPlatformStatus) DeepCopy() *GCPPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPPlatformStatus.
func (*GCPPlatformStatus) DeepCopyInto ¶
func (in *GCPPlatformStatus) DeepCopyInto(out *GCPPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GCPPlatformStatus) SwaggerDoc ¶
func (GCPPlatformStatus) SwaggerDoc() map[string]string
type GCPResourceLabel ¶
type GCPResourceLabel struct { // key is the key part of the label. A label key can have a maximum of 63 characters and cannot be empty. // Label key must begin with a lowercase letter, and must contain only lowercase letters, numeric characters, // and the following special characters `_-`. Label key must not have the reserved prefixes `kubernetes-io` // and `openshift-io`. // +kubebuilder:validation:XValidation:rule="!self.startsWith('openshift-io') && !self.startsWith('kubernetes-io')",message="label keys must not start with either `openshift-io` or `kubernetes-io`" // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-z][0-9a-z_-]{0,62}$` Key string `json:"key"` // value is the value part of the label. A label value can have a maximum of 63 characters and cannot be empty. // Value must contain only lowercase letters, numeric characters, and the following special characters `_-`. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[0-9a-z_-]{1,63}$` Value string `json:"value"` }
GCPResourceLabel is a label to apply to GCP resources created for the cluster.
func (*GCPResourceLabel) DeepCopy ¶
func (in *GCPResourceLabel) DeepCopy() *GCPResourceLabel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPResourceLabel.
func (*GCPResourceLabel) DeepCopyInto ¶
func (in *GCPResourceLabel) DeepCopyInto(out *GCPResourceLabel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GCPResourceLabel) SwaggerDoc ¶
func (GCPResourceLabel) SwaggerDoc() map[string]string
type GCPResourceTag ¶
type GCPResourceTag struct { // parentID is the ID of the hierarchical resource where the tags are defined, // e.g. at the Organization or the Project level. To find the Organization or Project ID refer to the following pages: // https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id, // https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects. // An OrganizationID must consist of decimal numbers, and cannot have leading zeroes. // A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, // and hyphens, and must start with a letter, and cannot end with a hyphen. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=32 // +kubebuilder:validation:Pattern=`(^[1-9][0-9]{0,31}$)|(^[a-z][a-z0-9-]{4,28}[a-z0-9]$)` ParentID string `json:"parentID"` // key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. // Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase // alphanumeric characters, and the following special characters `._-`. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.-]{0,61}[a-zA-Z0-9])?$` Key string `json:"key"` // value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. // Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase // alphanumeric characters, and the following special characters `_-.@%=+:,*#&(){}[]` and spaces. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.@%=+:,*#&()\[\]{}\-\s]{0,61}[a-zA-Z0-9])?$` Value string `json:"value"` }
GCPResourceTag is a tag to apply to GCP resources created for the cluster.
func (*GCPResourceTag) DeepCopy ¶
func (in *GCPResourceTag) DeepCopy() *GCPResourceTag
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPResourceTag.
func (*GCPResourceTag) DeepCopyInto ¶
func (in *GCPResourceTag) DeepCopyInto(out *GCPResourceTag)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GCPResourceTag) SwaggerDoc ¶
func (GCPResourceTag) SwaggerDoc() map[string]string
type GenericAPIServerConfig ¶
type GenericAPIServerConfig struct { // servingInfo describes how to start serving ServingInfo HTTPServingInfo `json:"servingInfo"` // corsAllowedOrigins CORSAllowedOrigins []string `json:"corsAllowedOrigins"` // auditConfig describes how to configure audit information AuditConfig AuditConfig `json:"auditConfig"` // storageConfig contains information about how to use StorageConfig EtcdStorageConfig `json:"storageConfig"` // admissionConfig holds information about how to configure admission. AdmissionConfig AdmissionConfig `json:"admission"` KubeClientConfig KubeClientConfig `json:"kubeClientConfig"` }
GenericAPIServerConfig is an inline-able struct for aggregated apiservers that need to store data in etcd
func (*GenericAPIServerConfig) DeepCopy ¶
func (in *GenericAPIServerConfig) DeepCopy() *GenericAPIServerConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericAPIServerConfig.
func (*GenericAPIServerConfig) DeepCopyInto ¶
func (in *GenericAPIServerConfig) DeepCopyInto(out *GenericAPIServerConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GenericAPIServerConfig) SwaggerDoc ¶
func (GenericAPIServerConfig) SwaggerDoc() map[string]string
type GenericControllerConfig ¶
type GenericControllerConfig struct { // servingInfo is the HTTP serving information for the controller's endpoints ServingInfo HTTPServingInfo `json:"servingInfo"` // leaderElection provides information to elect a leader. Only override this if you have a specific need LeaderElection LeaderElection `json:"leaderElection"` // authentication allows configuration of authentication for the endpoints Authentication DelegatedAuthentication `json:"authentication"` // authorization allows configuration of authentication for the endpoints Authorization DelegatedAuthorization `json:"authorization"` }
GenericControllerConfig provides information to configure a controller
func (*GenericControllerConfig) DeepCopy ¶
func (in *GenericControllerConfig) DeepCopy() *GenericControllerConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericControllerConfig.
func (*GenericControllerConfig) DeepCopyInto ¶
func (in *GenericControllerConfig) DeepCopyInto(out *GenericControllerConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GenericControllerConfig) SwaggerDoc ¶
func (GenericControllerConfig) SwaggerDoc() map[string]string
type GitHubIdentityProvider ¶
type GitHubIdentityProvider struct { // clientID is the oauth client ID ClientID string `json:"clientID"` // 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. ClientSecret SecretNameReference `json:"clientSecret"` // organizations optionally restricts which organizations are allowed to log in // +optional Organizations []string `json:"organizations,omitempty"` // teams optionally restricts which teams are allowed to log in. Format is <org>/<team>. // +optional Teams []string `json:"teams,omitempty"` // 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. // +optional Hostname string `json:"hostname"` // 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. // +optional CA ConfigMapNameReference `json:"ca"` }
GitHubIdentityProvider provides identities for users authenticating using GitHub credentials
func (*GitHubIdentityProvider) DeepCopy ¶
func (in *GitHubIdentityProvider) DeepCopy() *GitHubIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitHubIdentityProvider.
func (*GitHubIdentityProvider) DeepCopyInto ¶
func (in *GitHubIdentityProvider) DeepCopyInto(out *GitHubIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GitHubIdentityProvider) SwaggerDoc ¶
func (GitHubIdentityProvider) SwaggerDoc() map[string]string
type GitLabIdentityProvider ¶
type GitLabIdentityProvider struct { // clientID is the oauth client ID ClientID string `json:"clientID"` // 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. ClientSecret SecretNameReference `json:"clientSecret"` // url is the oauth server base URL URL string `json:"url"` // 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. // +optional CA ConfigMapNameReference `json:"ca"` }
GitLabIdentityProvider provides identities for users authenticating using GitLab credentials
func (*GitLabIdentityProvider) DeepCopy ¶
func (in *GitLabIdentityProvider) DeepCopy() *GitLabIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitLabIdentityProvider.
func (*GitLabIdentityProvider) DeepCopyInto ¶
func (in *GitLabIdentityProvider) DeepCopyInto(out *GitLabIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GitLabIdentityProvider) SwaggerDoc ¶
func (GitLabIdentityProvider) SwaggerDoc() map[string]string
type GoogleIdentityProvider ¶
type GoogleIdentityProvider struct { // clientID is the oauth client ID ClientID string `json:"clientID"` // 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. ClientSecret SecretNameReference `json:"clientSecret"` // hostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to // +optional HostedDomain string `json:"hostedDomain"` }
GoogleIdentityProvider provides identities for users authenticating using Google credentials
func (*GoogleIdentityProvider) DeepCopy ¶
func (in *GoogleIdentityProvider) DeepCopy() *GoogleIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GoogleIdentityProvider.
func (*GoogleIdentityProvider) DeepCopyInto ¶
func (in *GoogleIdentityProvider) DeepCopyInto(out *GoogleIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GoogleIdentityProvider) SwaggerDoc ¶
func (GoogleIdentityProvider) SwaggerDoc() map[string]string
type HTPasswdIdentityProvider ¶
type HTPasswdIdentityProvider struct { // 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. FileData SecretNameReference `json:"fileData"` }
HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials
func (*HTPasswdIdentityProvider) DeepCopy ¶
func (in *HTPasswdIdentityProvider) DeepCopy() *HTPasswdIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTPasswdIdentityProvider.
func (*HTPasswdIdentityProvider) DeepCopyInto ¶
func (in *HTPasswdIdentityProvider) DeepCopyInto(out *HTPasswdIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HTPasswdIdentityProvider) SwaggerDoc ¶
func (HTPasswdIdentityProvider) SwaggerDoc() map[string]string
type HTTPServingInfo ¶
type HTTPServingInfo struct { // ServingInfo is the HTTP serving information ServingInfo `json:",inline"` // maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit. MaxRequestsInFlight int64 `json:"maxRequestsInFlight"` // requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if // -1 there is no limit on requests. RequestTimeoutSeconds int64 `json:"requestTimeoutSeconds"` }
HTTPServingInfo holds configuration for serving HTTP
func (*HTTPServingInfo) DeepCopy ¶
func (in *HTTPServingInfo) DeepCopy() *HTTPServingInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPServingInfo.
func (*HTTPServingInfo) DeepCopyInto ¶
func (in *HTTPServingInfo) DeepCopyInto(out *HTTPServingInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HTTPServingInfo) SwaggerDoc ¶
func (HTTPServingInfo) SwaggerDoc() map[string]string
type Hostname ¶
type Hostname string
Hostname is a host name as defined by RFC-1123. + --- + The left operand of the | is the original kubebuilder hostname validation format, which is incorrect because it + allows upper case letters, disallows hyphen or number in the TLD, and allows labels to start/end in non-alphanumeric + characters. See https://bugzilla.redhat.com/show_bug.cgi?id=2039256. + ^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$ + + The right operand of the | is a new pattern that mimics the current API route admission validation on hostname, + except that it allows hostnames longer than the maximum length: + ^(([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})[\.]){0,}([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})$ + + Both operand patterns are made available so that modifications on ingress spec can still happen after an invalid hostname + was saved via validation by the incorrect left operand of the | operator. + +kubebuilder:validation:Pattern=`^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$|^(([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})[\.]){0,}([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})$`
type HubSource ¶
type HubSource struct { // name is the name of one of the default hub sources // +kubebuilder:validation:MaxLength=253 // +kubebuilder:validation:MinLength=1 // +kubebuilder:Required Name string `json:"name"` // disabled is used to disable a default hub source on cluster // +kubebuilder:Required Disabled bool `json:"disabled"` }
HubSource is used to specify the hub source and its configuration
func (*HubSource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HubSource.
func (*HubSource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HubSource) SwaggerDoc ¶
type HubSourceStatus ¶
type HubSourceStatus struct { HubSource `json:",omitempty"` // status indicates success or failure in applying the configuration Status string `json:"status,omitempty"` // message provides more information regarding failures Message string `json:"message,omitempty"` }
HubSourceStatus is used to reflect the current state of applying the configuration to a default source
func (*HubSourceStatus) DeepCopy ¶
func (in *HubSourceStatus) DeepCopy() *HubSourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HubSourceStatus.
func (*HubSourceStatus) DeepCopyInto ¶
func (in *HubSourceStatus) DeepCopyInto(out *HubSourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HubSourceStatus) SwaggerDoc ¶
func (HubSourceStatus) SwaggerDoc() map[string]string
type IBMCloudPlatformSpec ¶
type IBMCloudPlatformSpec struct{}
IBMCloudPlatformSpec holds the desired state of the IBMCloud infrastructure provider. This only includes fields that can be modified in the cluster.
func (*IBMCloudPlatformSpec) DeepCopy ¶
func (in *IBMCloudPlatformSpec) DeepCopy() *IBMCloudPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IBMCloudPlatformSpec.
func (*IBMCloudPlatformSpec) DeepCopyInto ¶
func (in *IBMCloudPlatformSpec) DeepCopyInto(out *IBMCloudPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IBMCloudPlatformSpec) SwaggerDoc ¶
func (IBMCloudPlatformSpec) SwaggerDoc() map[string]string
type IBMCloudPlatformStatus ¶
type IBMCloudPlatformStatus struct { // location is where the cluster has been deployed Location string `json:"location,omitempty"` // resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. ResourceGroupName string `json:"resourceGroupName,omitempty"` // providerType indicates the type of cluster that was created ProviderType IBMCloudProviderType `json:"providerType,omitempty"` // cisInstanceCRN is the CRN of the Cloud Internet Services instance managing // the DNS zone for the cluster's base domain CISInstanceCRN string `json:"cisInstanceCRN,omitempty"` // dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone // for the cluster's base domain DNSInstanceCRN string `json:"dnsInstanceCRN,omitempty"` // serviceEndpoints is a list of custom endpoints which will override the default // service endpoints of an IBM Cloud service. These endpoints are consumed by // components within the cluster to reach the respective IBM Cloud Services. // +listType=map // +listMapKey=name // +optional ServiceEndpoints []IBMCloudServiceEndpoint `json:"serviceEndpoints,omitempty"` }
IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.
func (*IBMCloudPlatformStatus) DeepCopy ¶
func (in *IBMCloudPlatformStatus) DeepCopy() *IBMCloudPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IBMCloudPlatformStatus.
func (*IBMCloudPlatformStatus) DeepCopyInto ¶
func (in *IBMCloudPlatformStatus) DeepCopyInto(out *IBMCloudPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IBMCloudPlatformStatus) SwaggerDoc ¶
func (IBMCloudPlatformStatus) SwaggerDoc() map[string]string
type IBMCloudProviderType ¶
type IBMCloudProviderType string
IBMCloudProviderType is a specific supported IBM Cloud provider cluster type
const ( // Classic means that the IBM Cloud cluster is using classic infrastructure IBMCloudProviderTypeClassic IBMCloudProviderType = "Classic" // VPC means that the IBM Cloud cluster is using VPC infrastructure IBMCloudProviderTypeVPC IBMCloudProviderType = "VPC" // IBMCloudProviderTypeUPI means that the IBM Cloud cluster is using user provided infrastructure. // This is utilized in IBM Cloud Satellite environments. IBMCloudProviderTypeUPI IBMCloudProviderType = "UPI" )
type IBMCloudServiceEndpoint ¶
type IBMCloudServiceEndpoint struct { // name is the name of the IBM Cloud service. // Possible values are: CIS, COS, COSConfig, DNSServices, GlobalCatalog, GlobalSearch, GlobalTagging, HyperProtect, IAM, KeyProtect, ResourceController, ResourceManager, or VPC. // For example, the IBM Cloud Private IAM service could be configured with the // service `name` of `IAM` and `url` of `https://private.iam.cloud.ibm.com` // Whereas the IBM Cloud Private VPC service for US South (Dallas) could be configured // with the service `name` of `VPC` and `url` of `https://us.south.private.iaas.cloud.ibm.com` // // +required Name IBMCloudServiceName `json:"name"` // 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. // // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:XValidation:rule="isURL(self)",message="url must be a valid absolute URL" URL string `json:"url"` }
IBMCloudServiceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud Services.
func (*IBMCloudServiceEndpoint) DeepCopy ¶
func (in *IBMCloudServiceEndpoint) DeepCopy() *IBMCloudServiceEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IBMCloudServiceEndpoint.
func (*IBMCloudServiceEndpoint) DeepCopyInto ¶
func (in *IBMCloudServiceEndpoint) DeepCopyInto(out *IBMCloudServiceEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IBMCloudServiceEndpoint) SwaggerDoc ¶
func (IBMCloudServiceEndpoint) SwaggerDoc() map[string]string
type IBMCloudServiceName ¶
type IBMCloudServiceName string
IBMCloudServiceName contains a value specifying the name of an IBM Cloud Service, which are used by MAPI, CIRO, CIO, Installer, etc. +kubebuilder:validation:Enum=CIS;COS;COSConfig;DNSServices;GlobalCatalog;GlobalSearch;GlobalTagging;HyperProtect;IAM;KeyProtect;ResourceController;ResourceManager;VPC
const ( // IBMCloudServiceCIS is the name for IBM Cloud CIS. IBMCloudServiceCIS IBMCloudServiceName = "CIS" // IBMCloudServiceCOS is the name for IBM Cloud COS. IBMCloudServiceCOS IBMCloudServiceName = "COS" // IBMCloudServiceCOSConfig is the name for IBM Cloud COS Config service. IBMCloudServiceCOSConfig IBMCloudServiceName = "COSConfig" // IBMCloudServiceDNSServices is the name for IBM Cloud DNS Services. IBMCloudServiceDNSServices IBMCloudServiceName = "DNSServices" // IBMCloudServiceGlobalCatalog is the name for IBM Cloud Global Catalog service. IBMCloudServiceGlobalCatalog IBMCloudServiceName = "GlobalCatalog" // IBMCloudServiceGlobalSearch is the name for IBM Cloud Global Search. IBMCloudServiceGlobalSearch IBMCloudServiceName = "GlobalSearch" // IBMCloudServiceGlobalTagging is the name for IBM Cloud Global Tagging. IBMCloudServiceGlobalTagging IBMCloudServiceName = "GlobalTagging" // IBMCloudServiceHyperProtect is the name for IBM Cloud Hyper Protect. IBMCloudServiceHyperProtect IBMCloudServiceName = "HyperProtect" // IBMCloudServiceIAM is the name for IBM Cloud IAM. IBMCloudServiceIAM IBMCloudServiceName = "IAM" // IBMCloudServiceKeyProtect is the name for IBM Cloud Key Protect. IBMCloudServiceKeyProtect IBMCloudServiceName = "KeyProtect" // IBMCloudServiceResourceController is the name for IBM Cloud Resource Controller. IBMCloudServiceResourceController IBMCloudServiceName = "ResourceController" // IBMCloudServiceResourceManager is the name for IBM Cloud Resource Manager. IBMCloudServiceResourceManager IBMCloudServiceName = "ResourceManager" // IBMCloudServiceVPC is the name for IBM Cloud VPC. IBMCloudServiceVPC IBMCloudServiceName = "VPC" )
type IP ¶
type IP string
IP is an IP address (for example, "10.0.0.0" or "fd00::"). +kubebuilder:validation:XValidation:rule="isIP(self)",message="value must be a valid IP address" +kubebuilder:validation:MaxLength:=39 +kubebuilder:validation:MinLength:=1
type IdentityProvider ¶
type IdentityProvider struct { // 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 ":" // Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName Name string `json:"name"` // mappingMethod determines how identities from this provider are mapped to users // Defaults to "claim" // +optional MappingMethod MappingMethodType `json:"mappingMethod,omitempty"` IdentityProviderConfig `json:",inline"` }
IdentityProvider provides identities for users authenticating using credentials
func (*IdentityProvider) DeepCopy ¶
func (in *IdentityProvider) DeepCopy() *IdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityProvider.
func (*IdentityProvider) DeepCopyInto ¶
func (in *IdentityProvider) DeepCopyInto(out *IdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IdentityProvider) SwaggerDoc ¶
func (IdentityProvider) SwaggerDoc() map[string]string
type IdentityProviderConfig ¶
type IdentityProviderConfig struct { // type identifies the identity provider type for this entry. Type IdentityProviderType `json:"type"` // basicAuth contains configuration options for the BasicAuth IdP // +optional BasicAuth *BasicAuthIdentityProvider `json:"basicAuth,omitempty"` // github enables user authentication using GitHub credentials // +optional GitHub *GitHubIdentityProvider `json:"github,omitempty"` // gitlab enables user authentication using GitLab credentials // +optional GitLab *GitLabIdentityProvider `json:"gitlab,omitempty"` // google enables user authentication using Google credentials // +optional Google *GoogleIdentityProvider `json:"google,omitempty"` // htpasswd enables user authentication using an HTPasswd file to validate credentials // +optional HTPasswd *HTPasswdIdentityProvider `json:"htpasswd,omitempty"` // keystone enables user authentication using keystone password credentials // +optional Keystone *KeystoneIdentityProvider `json:"keystone,omitempty"` // ldap enables user authentication using LDAP credentials // +optional LDAP *LDAPIdentityProvider `json:"ldap,omitempty"` // openID enables user authentication using OpenID credentials // +optional OpenID *OpenIDIdentityProvider `json:"openID,omitempty"` // requestHeader enables user authentication using request header credentials // +optional RequestHeader *RequestHeaderIdentityProvider `json:"requestHeader,omitempty"` }
IdentityProviderConfig contains configuration for using a specific identity provider
func (*IdentityProviderConfig) DeepCopy ¶
func (in *IdentityProviderConfig) DeepCopy() *IdentityProviderConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityProviderConfig.
func (*IdentityProviderConfig) DeepCopyInto ¶
func (in *IdentityProviderConfig) DeepCopyInto(out *IdentityProviderConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IdentityProviderConfig) SwaggerDoc ¶
func (IdentityProviderConfig) SwaggerDoc() map[string]string
type IdentityProviderType ¶
type IdentityProviderType string
const ( // IdentityProviderTypeBasicAuth provides identities for users authenticating with HTTP Basic Auth IdentityProviderTypeBasicAuth IdentityProviderType = "BasicAuth" // IdentityProviderTypeGitHub provides identities for users authenticating using GitHub credentials IdentityProviderTypeGitHub IdentityProviderType = "GitHub" // IdentityProviderTypeGitLab provides identities for users authenticating using GitLab credentials IdentityProviderTypeGitLab IdentityProviderType = "GitLab" // IdentityProviderTypeGoogle provides identities for users authenticating using Google credentials IdentityProviderTypeGoogle IdentityProviderType = "Google" // IdentityProviderTypeHTPasswd provides identities from an HTPasswd file IdentityProviderTypeHTPasswd IdentityProviderType = "HTPasswd" // IdentityProviderTypeKeystone provides identitities for users authenticating using keystone password credentials IdentityProviderTypeKeystone IdentityProviderType = "Keystone" // IdentityProviderTypeLDAP provides identities for users authenticating using LDAP credentials IdentityProviderTypeLDAP IdentityProviderType = "LDAP" // IdentityProviderTypeOpenID provides identities for users authenticating using OpenID credentials IdentityProviderTypeOpenID IdentityProviderType = "OpenID" // IdentityProviderTypeRequestHeader provides identities for users authenticating using request header credentials IdentityProviderTypeRequestHeader IdentityProviderType = "RequestHeader" )
type Image ¶
type Image struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ImageSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status ImageStatus `json:"status"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=images,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Image) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Image.
func (*Image) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Image) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Image) SwaggerDoc ¶
type ImageContentPolicy ¶
type ImageContentPolicy struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ImageContentPolicySpec `json:"spec"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/874 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=imagecontentpolicies,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*ImageContentPolicy) DeepCopy ¶
func (in *ImageContentPolicy) DeepCopy() *ImageContentPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentPolicy.
func (*ImageContentPolicy) DeepCopyInto ¶
func (in *ImageContentPolicy) DeepCopyInto(out *ImageContentPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageContentPolicy) DeepCopyObject ¶
func (in *ImageContentPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageContentPolicy) SwaggerDoc ¶
func (ImageContentPolicy) SwaggerDoc() map[string]string
type ImageContentPolicyList ¶
type ImageContentPolicyList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []ImageContentPolicy `json:"items"` }
ImageContentPolicyList lists the items in the ImageContentPolicy CRD.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ImageContentPolicyList) DeepCopy ¶
func (in *ImageContentPolicyList) DeepCopy() *ImageContentPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentPolicyList.
func (*ImageContentPolicyList) DeepCopyInto ¶
func (in *ImageContentPolicyList) DeepCopyInto(out *ImageContentPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageContentPolicyList) DeepCopyObject ¶
func (in *ImageContentPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageContentPolicyList) SwaggerDoc ¶
func (ImageContentPolicyList) SwaggerDoc() map[string]string
type ImageContentPolicySpec ¶
type ImageContentPolicySpec struct { // 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". // // Each “source” repository is treated independently; configurations for different “source” // repositories don’t interact. // // If the "mirrors" is not specified, the image will continue to be pulled from the specified // repository in the pull spec. // // When 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. // +optional // +listType=map // +listMapKey=source RepositoryDigestMirrors []RepositoryDigestMirrors `json:"repositoryDigestMirrors"` }
ImageContentPolicySpec is the specification of the ImageContentPolicy CRD.
func (*ImageContentPolicySpec) DeepCopy ¶
func (in *ImageContentPolicySpec) DeepCopy() *ImageContentPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentPolicySpec.
func (*ImageContentPolicySpec) DeepCopyInto ¶
func (in *ImageContentPolicySpec) DeepCopyInto(out *ImageContentPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageContentPolicySpec) SwaggerDoc ¶
func (ImageContentPolicySpec) SwaggerDoc() map[string]string
type ImageDigestMirrorSet ¶
type ImageDigestMirrorSet struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ImageDigestMirrorSetSpec `json:"spec"` // status contains the observed state of the resource. // +optional Status ImageDigestMirrorSetStatus `json:"status,omitempty"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/1126 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=imagedigestmirrorsets,scope=Cluster,shortName=idms +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*ImageDigestMirrorSet) DeepCopy ¶
func (in *ImageDigestMirrorSet) DeepCopy() *ImageDigestMirrorSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageDigestMirrorSet.
func (*ImageDigestMirrorSet) DeepCopyInto ¶
func (in *ImageDigestMirrorSet) DeepCopyInto(out *ImageDigestMirrorSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageDigestMirrorSet) DeepCopyObject ¶
func (in *ImageDigestMirrorSet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageDigestMirrorSet) SwaggerDoc ¶
func (ImageDigestMirrorSet) SwaggerDoc() map[string]string
type ImageDigestMirrorSetList ¶
type ImageDigestMirrorSetList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []ImageDigestMirrorSet `json:"items"` }
ImageDigestMirrorSetList lists the items in the ImageDigestMirrorSet CRD.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ImageDigestMirrorSetList) DeepCopy ¶
func (in *ImageDigestMirrorSetList) DeepCopy() *ImageDigestMirrorSetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageDigestMirrorSetList.
func (*ImageDigestMirrorSetList) DeepCopyInto ¶
func (in *ImageDigestMirrorSetList) DeepCopyInto(out *ImageDigestMirrorSetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageDigestMirrorSetList) DeepCopyObject ¶
func (in *ImageDigestMirrorSetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageDigestMirrorSetList) SwaggerDoc ¶
func (ImageDigestMirrorSetList) SwaggerDoc() map[string]string
type ImageDigestMirrorSetSpec ¶
type ImageDigestMirrorSetSpec struct { // 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. // // If 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. // // If the "mirrors" is not specified, the image will continue to be pulled from the specified // repository in the pull spec. // // When 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. // +optional // +listType=atomic ImageDigestMirrors []ImageDigestMirrors `json:"imageDigestMirrors"` }
ImageDigestMirrorSetSpec is the specification of the ImageDigestMirrorSet CRD.
func (*ImageDigestMirrorSetSpec) DeepCopy ¶
func (in *ImageDigestMirrorSetSpec) DeepCopy() *ImageDigestMirrorSetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageDigestMirrorSetSpec.
func (*ImageDigestMirrorSetSpec) DeepCopyInto ¶
func (in *ImageDigestMirrorSetSpec) DeepCopyInto(out *ImageDigestMirrorSetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageDigestMirrorSetSpec) SwaggerDoc ¶
func (ImageDigestMirrorSetSpec) SwaggerDoc() map[string]string
type ImageDigestMirrorSetStatus ¶
type ImageDigestMirrorSetStatus struct{}
func (*ImageDigestMirrorSetStatus) DeepCopy ¶
func (in *ImageDigestMirrorSetStatus) DeepCopy() *ImageDigestMirrorSetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageDigestMirrorSetStatus.
func (*ImageDigestMirrorSetStatus) DeepCopyInto ¶
func (in *ImageDigestMirrorSetStatus) DeepCopyInto(out *ImageDigestMirrorSetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageDigestMirrors ¶
type ImageDigestMirrors struct { // 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 // +required // +kubebuilder:validation:Pattern=`^\*(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+$|^((?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?)(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?$` Source string `json:"source"` // 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 // +optional // +listType=set Mirrors []ImageMirror `json:"mirrors,omitempty"` // 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. // +optional MirrorSourcePolicy MirrorSourcePolicy `json:"mirrorSourcePolicy,omitempty"` }
ImageDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.
func (*ImageDigestMirrors) DeepCopy ¶
func (in *ImageDigestMirrors) DeepCopy() *ImageDigestMirrors
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageDigestMirrors.
func (*ImageDigestMirrors) DeepCopyInto ¶
func (in *ImageDigestMirrors) DeepCopyInto(out *ImageDigestMirrors)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageDigestMirrors) SwaggerDoc ¶
func (ImageDigestMirrors) SwaggerDoc() map[string]string
type ImageLabel ¶
type ImageLabel struct { // name defines the name of the label. It must have non-zero length. Name string `json:"name"` // value defines the literal value of the label. // +optional Value string `json:"value,omitempty"` }
func (*ImageLabel) DeepCopy ¶
func (in *ImageLabel) DeepCopy() *ImageLabel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageLabel.
func (*ImageLabel) DeepCopyInto ¶
func (in *ImageLabel) DeepCopyInto(out *ImageLabel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageLabel) SwaggerDoc ¶
func (ImageLabel) SwaggerDoc() map[string]string
type ImageList ¶
type ImageList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Image `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ImageList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageList.
func (*ImageList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageList) SwaggerDoc ¶
type ImageMirror ¶
type ImageMirror string
+kubebuilder:validation:Pattern=`^((?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?)(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?$`
type ImageSpec ¶
type ImageSpec struct { // 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. // +optional // +listType=atomic AllowedRegistriesForImport []RegistryLocation `json:"allowedRegistriesForImport,omitempty"` // 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. // +optional // +listType=atomic ExternalRegistryHostnames []string `json:"externalRegistryHostnames,omitempty"` // 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. // +optional AdditionalTrustedCA ConfigMapNameReference `json:"additionalTrustedCA"` // 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. // +optional RegistrySources RegistrySources `json:"registrySources"` // imageStreamImportMode controls the import mode behaviour of imagestreams. // It can be set to `Legacy` or `PreserveOriginal` or the empty string. If this value // is specified, this setting is applied to all newly created imagestreams which do not have the // value set. `Legacy` indicates that the legacy behaviour should be used. // For manifest lists, the legacy behaviour will discard the manifest list and import a single // sub-manifest. In this case, the platform is chosen in the following order of priority: // 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. // `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, // the manifest list and all its sub-manifests will be imported. When empty, the behaviour will be // decided based on the payload type advertised by the ClusterVersion status, i.e single arch payload // implies the import mode is Legacy and multi payload implies PreserveOriginal. // +openshift:enable:FeatureGate=ImageStreamImportMode // +optional ImageStreamImportMode ImportModeType `json:"imageStreamImportMode"` }
func (*ImageSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSpec.
func (*ImageSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageSpec) SwaggerDoc ¶
type ImageStatus ¶
type ImageStatus struct { // 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. // +optional InternalRegistryHostname string `json:"internalRegistryHostname,omitempty"` // 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. // +optional // +listType=atomic ExternalRegistryHostnames []string `json:"externalRegistryHostnames,omitempty"` // imageStreamImportMode controls the import mode behaviour of imagestreams. It can be // `Legacy` or `PreserveOriginal`. `Legacy` indicates that the legacy behaviour should be used. // For manifest lists, the legacy behaviour will discard the manifest list and import a single // sub-manifest. In this case, the platform is chosen in the following order of priority: // 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. // `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, // the manifest list and all its sub-manifests will be imported. This value will be reconciled based // on either the spec value or if no spec value is specified, the image registry operator would look // at the ClusterVersion status to determine the payload type and set the import mode accordingly, // i.e single arch payload implies the import mode is Legacy and multi payload implies PreserveOriginal. // +openshift:enable:FeatureGate=ImageStreamImportMode // +optional ImageStreamImportMode ImportModeType `json:"imageStreamImportMode,omitempty"` }
func (*ImageStatus) DeepCopy ¶
func (in *ImageStatus) DeepCopy() *ImageStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageStatus.
func (*ImageStatus) DeepCopyInto ¶
func (in *ImageStatus) DeepCopyInto(out *ImageStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageStatus) SwaggerDoc ¶
func (ImageStatus) SwaggerDoc() map[string]string
type ImageTagMirrorSet ¶
type ImageTagMirrorSet struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ImageTagMirrorSetSpec `json:"spec"` // status contains the observed state of the resource. // +optional Status ImageTagMirrorSetStatus `json:"status,omitempty"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/1126 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=imagetagmirrorsets,scope=Cluster,shortName=itms +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*ImageTagMirrorSet) DeepCopy ¶
func (in *ImageTagMirrorSet) DeepCopy() *ImageTagMirrorSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTagMirrorSet.
func (*ImageTagMirrorSet) DeepCopyInto ¶
func (in *ImageTagMirrorSet) DeepCopyInto(out *ImageTagMirrorSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageTagMirrorSet) DeepCopyObject ¶
func (in *ImageTagMirrorSet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageTagMirrorSet) SwaggerDoc ¶
func (ImageTagMirrorSet) SwaggerDoc() map[string]string
type ImageTagMirrorSetList ¶
type ImageTagMirrorSetList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []ImageTagMirrorSet `json:"items"` }
ImageTagMirrorSetList lists the items in the ImageTagMirrorSet CRD.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ImageTagMirrorSetList) DeepCopy ¶
func (in *ImageTagMirrorSetList) DeepCopy() *ImageTagMirrorSetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTagMirrorSetList.
func (*ImageTagMirrorSetList) DeepCopyInto ¶
func (in *ImageTagMirrorSetList) DeepCopyInto(out *ImageTagMirrorSetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageTagMirrorSetList) DeepCopyObject ¶
func (in *ImageTagMirrorSetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageTagMirrorSetList) SwaggerDoc ¶
func (ImageTagMirrorSetList) SwaggerDoc() map[string]string
type ImageTagMirrorSetSpec ¶
type ImageTagMirrorSetSpec struct { // 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. // // If 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. // // If the "mirrors" is not specified, the image will continue to be pulled from the specified // repository in the pull spec. // // When 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. // +optional // +listType=atomic ImageTagMirrors []ImageTagMirrors `json:"imageTagMirrors"` }
ImageTagMirrorSetSpec is the specification of the ImageTagMirrorSet CRD.
func (*ImageTagMirrorSetSpec) DeepCopy ¶
func (in *ImageTagMirrorSetSpec) DeepCopy() *ImageTagMirrorSetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTagMirrorSetSpec.
func (*ImageTagMirrorSetSpec) DeepCopyInto ¶
func (in *ImageTagMirrorSetSpec) DeepCopyInto(out *ImageTagMirrorSetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageTagMirrorSetSpec) SwaggerDoc ¶
func (ImageTagMirrorSetSpec) SwaggerDoc() map[string]string
type ImageTagMirrorSetStatus ¶
type ImageTagMirrorSetStatus struct{}
func (*ImageTagMirrorSetStatus) DeepCopy ¶
func (in *ImageTagMirrorSetStatus) DeepCopy() *ImageTagMirrorSetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTagMirrorSetStatus.
func (*ImageTagMirrorSetStatus) DeepCopyInto ¶
func (in *ImageTagMirrorSetStatus) DeepCopyInto(out *ImageTagMirrorSetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageTagMirrors ¶
type ImageTagMirrors struct { // 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 // +required // +kubebuilder:validation:Pattern=`^\*(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+$|^((?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?)(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?$` Source string `json:"source"` // 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 // +optional // +listType=set Mirrors []ImageMirror `json:"mirrors,omitempty"` // 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. // +optional MirrorSourcePolicy MirrorSourcePolicy `json:"mirrorSourcePolicy,omitempty"` }
ImageTagMirrors holds cluster-wide information about how to handle mirrors in the registries config.
func (*ImageTagMirrors) DeepCopy ¶
func (in *ImageTagMirrors) DeepCopy() *ImageTagMirrors
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTagMirrors.
func (*ImageTagMirrors) DeepCopyInto ¶
func (in *ImageTagMirrors) DeepCopyInto(out *ImageTagMirrors)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageTagMirrors) SwaggerDoc ¶
func (ImageTagMirrors) SwaggerDoc() map[string]string
type ImportModeType ¶
type ImportModeType string
ImportModeType describes how to import an image manifest. +enum +kubebuilder:validation:Enum:="";Legacy;PreserveOriginal
const ( // ImportModeLegacy indicates that the legacy behaviour should be used. // For manifest lists, the legacy behaviour will discard the manifest list and import a single // sub-manifest. In this case, the platform is chosen in the following order of priority: // 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. // This mode is the default. ImportModeLegacy ImportModeType = "Legacy" // ImportModePreserveOriginal indicates that the original manifest will be preserved. // For manifest lists, the manifest list and all its sub-manifests will be imported. ImportModePreserveOriginal ImportModeType = "PreserveOriginal" )
type IncludeSubDomainsPolicy ¶
type IncludeSubDomainsPolicy string
IncludeSubDomainsPolicy contains a value for specifying a compliant HSTS includeSubdomains policy for the enclosing RequiredHSTSPolicy +kubebuilder:validation:Enum=RequireIncludeSubDomains;RequireNoIncludeSubDomains;NoOpinion
const ( // RequireIncludeSubDomains means HSTS "includeSubDomains" is required by the RequiredHSTSPolicy RequireIncludeSubDomains IncludeSubDomainsPolicy = "RequireIncludeSubDomains" // RequireNoIncludeSubDomains means HSTS "includeSubDomains" is forbidden by the RequiredHSTSPolicy RequireNoIncludeSubDomains IncludeSubDomainsPolicy = "RequireNoIncludeSubDomains" // NoOpinionIncludeSubDomains means HSTS "includeSubDomains" doesn't matter to the RequiredHSTSPolicy NoOpinionIncludeSubDomains IncludeSubDomainsPolicy = "NoOpinion" )
type Infrastructure ¶
type Infrastructure struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec InfrastructureSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status InfrastructureStatus `json:"status"` }
Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=infrastructures,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Infrastructure) DeepCopy ¶
func (in *Infrastructure) DeepCopy() *Infrastructure
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Infrastructure.
func (*Infrastructure) DeepCopyInto ¶
func (in *Infrastructure) DeepCopyInto(out *Infrastructure)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Infrastructure) DeepCopyObject ¶
func (in *Infrastructure) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Infrastructure) SwaggerDoc ¶
func (Infrastructure) SwaggerDoc() map[string]string
type InfrastructureList ¶
type InfrastructureList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Infrastructure `json:"items"` }
InfrastructureList is
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*InfrastructureList) DeepCopy ¶
func (in *InfrastructureList) DeepCopy() *InfrastructureList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfrastructureList.
func (*InfrastructureList) DeepCopyInto ¶
func (in *InfrastructureList) DeepCopyInto(out *InfrastructureList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*InfrastructureList) DeepCopyObject ¶
func (in *InfrastructureList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (InfrastructureList) SwaggerDoc ¶
func (InfrastructureList) SwaggerDoc() map[string]string
type InfrastructureSpec ¶
type InfrastructureSpec struct { // 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. // // cloudConfig 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. // // +optional CloudConfig ConfigMapFileReference `json:"cloudConfig"` // platformSpec holds desired information specific to the underlying // infrastructure provider. PlatformSpec PlatformSpec `json:"platformSpec,omitempty"` }
InfrastructureSpec contains settings that apply to the cluster infrastructure.
func (*InfrastructureSpec) DeepCopy ¶
func (in *InfrastructureSpec) DeepCopy() *InfrastructureSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfrastructureSpec.
func (*InfrastructureSpec) DeepCopyInto ¶
func (in *InfrastructureSpec) DeepCopyInto(out *InfrastructureSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (InfrastructureSpec) SwaggerDoc ¶
func (InfrastructureSpec) SwaggerDoc() map[string]string
type InfrastructureStatus ¶
type InfrastructureStatus struct { // 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. InfrastructureName string `json:"infrastructureName"` // platform is the underlying infrastructure provider for the cluster. // // Deprecated: Use platformStatus.type instead. Platform PlatformType `json:"platform,omitempty"` // platformStatus holds status information specific to the underlying // infrastructure provider. // +optional PlatformStatus *PlatformStatus `json:"platformStatus,omitempty"` // 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. EtcdDiscoveryDomain string `json:"etcdDiscoveryDomain"` // 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. APIServerURL string `json:"apiServerURL"` // 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. APIServerInternalURL string `json:"apiServerInternalURI"` // 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. // +kubebuilder:default=HighlyAvailable // +openshift:validation:FeatureGateAwareEnum:featureGate="",enum=HighlyAvailable;SingleReplica;External // +openshift:validation:FeatureGateAwareEnum:featureGate=HighlyAvailableArbiter,enum=HighlyAvailable;HighlyAvailableArbiter;SingleReplica;External ControlPlaneTopology TopologyMode `json:"controlPlaneTopology"` // 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. // +kubebuilder:default=HighlyAvailable // +kubebuilder:validation:Enum=HighlyAvailable;SingleReplica InfrastructureTopology TopologyMode `json:"infrastructureTopology"` // 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. // +kubebuilder:default=None // +default="None" // +kubebuilder:validation:Enum=None;AllNodes // +optional CPUPartitioning CPUPartitioningMode `json:"cpuPartitioning,omitempty"` }
InfrastructureStatus describes the infrastructure the cluster is leveraging.
func (*InfrastructureStatus) DeepCopy ¶
func (in *InfrastructureStatus) DeepCopy() *InfrastructureStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfrastructureStatus.
func (*InfrastructureStatus) DeepCopyInto ¶
func (in *InfrastructureStatus) DeepCopyInto(out *InfrastructureStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (InfrastructureStatus) SwaggerDoc ¶
func (InfrastructureStatus) SwaggerDoc() map[string]string
type Ingress ¶
type Ingress struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec IngressSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status IngressStatus `json:"status"` }
Ingress holds cluster-wide information about ingress, including the default ingress domain used for routes. The canonical name is `cluster`.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=ingresses,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Ingress) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ingress.
func (*Ingress) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Ingress) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Ingress) SwaggerDoc ¶
type IngressList ¶
type IngressList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Ingress `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +openshift:compatibility-gen:level=1
func (*IngressList) DeepCopy ¶
func (in *IngressList) DeepCopy() *IngressList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressList.
func (*IngressList) DeepCopyInto ¶
func (in *IngressList) DeepCopyInto(out *IngressList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressList) DeepCopyObject ¶
func (in *IngressList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (IngressList) SwaggerDoc ¶
func (IngressList) SwaggerDoc() map[string]string
type IngressPlatformSpec ¶
type IngressPlatformSpec struct { // 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. // // +unionDiscriminator Type PlatformType `json:"type"` // aws contains settings specific to the Amazon Web Services infrastructure provider. // +optional AWS *AWSIngressSpec `json:"aws,omitempty"` }
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. +union
func (*IngressPlatformSpec) DeepCopy ¶
func (in *IngressPlatformSpec) DeepCopy() *IngressPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressPlatformSpec.
func (*IngressPlatformSpec) DeepCopyInto ¶
func (in *IngressPlatformSpec) DeepCopyInto(out *IngressPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IngressPlatformSpec) SwaggerDoc ¶
func (IngressPlatformSpec) SwaggerDoc() map[string]string
type IngressSpec ¶
type IngressSpec struct { // 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>". // // It is also used as the default wildcard domain suffix for ingress. The // default ingresscontroller domain will follow this pattern: "*.<domain>". // // Once set, changing domain is not currently supported. Domain string `json:"domain"` // 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. // +optional AppsDomain string `json:"appsDomain,omitempty"` // 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. // // To 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. // +optional // +listType=map // +listMapKey=namespace // +listMapKey=name ComponentRoutes []ComponentRouteSpec `json:"componentRoutes,omitempty"` // 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. // // A 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 // // - 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. // // The 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. // // Note that if there are no RequiredHSTSPolicies, any HSTS Policy annotation on the route is valid. // +optional RequiredHSTSPolicies []RequiredHSTSPolicy `json:"requiredHSTSPolicies,omitempty"` // 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. // +optional LoadBalancer LoadBalancer `json:"loadBalancer,omitempty"` }
func (*IngressSpec) DeepCopy ¶
func (in *IngressSpec) DeepCopy() *IngressSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressSpec.
func (*IngressSpec) DeepCopyInto ¶
func (in *IngressSpec) DeepCopyInto(out *IngressSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IngressSpec) SwaggerDoc ¶
func (IngressSpec) SwaggerDoc() map[string]string
type IngressStatus ¶
type IngressStatus struct { // componentRoutes is where participating operators place the current route status for routes whose // hostnames and serving certificates can be customized by the cluster-admin. // +optional // +listType=map // +listMapKey=namespace // +listMapKey=name ComponentRoutes []ComponentRouteStatus `json:"componentRoutes,omitempty"` // 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. // // This field works by dictating how the Cluster Ingress Operator will // consider unset replicas and nodePlacement fields in IngressController // resources when creating the corresponding Deployments. // // See the documentation for the IngressController replicas and nodePlacement // fields for more information. // // When omitted, the default value is Workers // // +kubebuilder:validation:Enum:="ControlPlane";"Workers";"" // +optional DefaultPlacement DefaultPlacement `json:"defaultPlacement"` }
func (*IngressStatus) DeepCopy ¶
func (in *IngressStatus) DeepCopy() *IngressStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressStatus.
func (*IngressStatus) DeepCopyInto ¶
func (in *IngressStatus) DeepCopyInto(out *IngressStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IngressStatus) SwaggerDoc ¶
func (IngressStatus) SwaggerDoc() map[string]string
type IntermediateTLSProfile ¶
type IntermediateTLSProfile struct{}
IntermediateTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29
func (*IntermediateTLSProfile) DeepCopy ¶
func (in *IntermediateTLSProfile) DeepCopy() *IntermediateTLSProfile
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntermediateTLSProfile.
func (*IntermediateTLSProfile) DeepCopyInto ¶
func (in *IntermediateTLSProfile) DeepCopyInto(out *IntermediateTLSProfile)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (IntermediateTLSProfile) SwaggerDoc ¶
func (IntermediateTLSProfile) SwaggerDoc() map[string]string
type KeystoneIdentityProvider ¶
type KeystoneIdentityProvider struct { // OAuthRemoteConnectionInfo contains information about how to connect to the keystone server OAuthRemoteConnectionInfo `json:",inline"` // domainName is required for keystone v3 DomainName string `json:"domainName"` }
KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials
func (*KeystoneIdentityProvider) DeepCopy ¶
func (in *KeystoneIdentityProvider) DeepCopy() *KeystoneIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeystoneIdentityProvider.
func (*KeystoneIdentityProvider) DeepCopyInto ¶
func (in *KeystoneIdentityProvider) DeepCopyInto(out *KeystoneIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (KeystoneIdentityProvider) SwaggerDoc ¶
func (KeystoneIdentityProvider) SwaggerDoc() map[string]string
type KubeClientConfig ¶
type KubeClientConfig struct { // kubeConfig is a .kubeconfig filename for going to the owning kube-apiserver. Empty uses an in-cluster-config KubeConfig string `json:"kubeConfig"` // connectionOverrides specifies client overrides for system components to loop back to this master. ConnectionOverrides ClientConnectionOverrides `json:"connectionOverrides"` }
func (*KubeClientConfig) DeepCopy ¶
func (in *KubeClientConfig) DeepCopy() *KubeClientConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeClientConfig.
func (*KubeClientConfig) DeepCopyInto ¶
func (in *KubeClientConfig) DeepCopyInto(out *KubeClientConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (KubeClientConfig) SwaggerDoc ¶
func (KubeClientConfig) SwaggerDoc() map[string]string
type KubevirtPlatformSpec ¶
type KubevirtPlatformSpec struct{}
KubevirtPlatformSpec holds the desired state of the kubevirt infrastructure provider. This only includes fields that can be modified in the cluster.
func (*KubevirtPlatformSpec) DeepCopy ¶
func (in *KubevirtPlatformSpec) DeepCopy() *KubevirtPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubevirtPlatformSpec.
func (*KubevirtPlatformSpec) DeepCopyInto ¶
func (in *KubevirtPlatformSpec) DeepCopyInto(out *KubevirtPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (KubevirtPlatformSpec) SwaggerDoc ¶
func (KubevirtPlatformSpec) SwaggerDoc() map[string]string
type KubevirtPlatformStatus ¶
type KubevirtPlatformStatus struct { // 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. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. IngressIP string `json:"ingressIP,omitempty"` }
KubevirtPlatformStatus holds the current status of the kubevirt infrastructure provider.
func (*KubevirtPlatformStatus) DeepCopy ¶
func (in *KubevirtPlatformStatus) DeepCopy() *KubevirtPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubevirtPlatformStatus.
func (*KubevirtPlatformStatus) DeepCopyInto ¶
func (in *KubevirtPlatformStatus) DeepCopyInto(out *KubevirtPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (KubevirtPlatformStatus) SwaggerDoc ¶
func (KubevirtPlatformStatus) SwaggerDoc() map[string]string
type LDAPAttributeMapping ¶
type LDAPAttributeMapping struct { // 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" ID []string `json:"id"` // preferredUsername is the list of attributes whose values should be used as the preferred username. // LDAP standard login attribute is "uid" // +optional PreferredUsername []string `json:"preferredUsername,omitempty"` // 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" // +optional Name []string `json:"name,omitempty"` // 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 // +optional Email []string `json:"email,omitempty"` }
LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields
func (*LDAPAttributeMapping) DeepCopy ¶
func (in *LDAPAttributeMapping) DeepCopy() *LDAPAttributeMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPAttributeMapping.
func (*LDAPAttributeMapping) DeepCopyInto ¶
func (in *LDAPAttributeMapping) DeepCopyInto(out *LDAPAttributeMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (LDAPAttributeMapping) SwaggerDoc ¶
func (LDAPAttributeMapping) SwaggerDoc() map[string]string
type LDAPIdentityProvider ¶
type LDAPIdentityProvider struct { // 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 URL string `json:"url"` // bindDN is an optional DN to bind with during the search phase. // +optional BindDN string `json:"bindDN"` // 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. // +optional BindPassword SecretNameReference `json:"bindPassword"` // 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 // attempt to connect using TLS, even when `insecure` is set to `true` // When `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. Insecure bool `json:"insecure"` // 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. // +optional CA ConfigMapNameReference `json:"ca"` // attributes maps LDAP attributes to identities Attributes LDAPAttributeMapping `json:"attributes"` }
LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials
func (*LDAPIdentityProvider) DeepCopy ¶
func (in *LDAPIdentityProvider) DeepCopy() *LDAPIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPIdentityProvider.
func (*LDAPIdentityProvider) DeepCopyInto ¶
func (in *LDAPIdentityProvider) DeepCopyInto(out *LDAPIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (LDAPIdentityProvider) SwaggerDoc ¶
func (LDAPIdentityProvider) SwaggerDoc() map[string]string
type LeaderElection ¶
type LeaderElection struct { // disable allows leader election to be suspended while allowing a fully defaulted "normal" startup case. Disable bool `json:"disable,omitempty"` // namespace indicates which namespace the resource is in Namespace string `json:"namespace,omitempty"` // name indicates what name to use for the resource Name string `json:"name,omitempty"` // 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. // +nullable LeaseDuration metav1.Duration `json:"leaseDuration"` // 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. // +nullable RenewDeadline metav1.Duration `json:"renewDeadline"` // 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. // +nullable RetryPeriod metav1.Duration `json:"retryPeriod"` }
LeaderElection provides information to elect a leader
func (*LeaderElection) DeepCopy ¶
func (in *LeaderElection) DeepCopy() *LeaderElection
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaderElection.
func (*LeaderElection) DeepCopyInto ¶
func (in *LeaderElection) DeepCopyInto(out *LeaderElection)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (LeaderElection) SwaggerDoc ¶
func (LeaderElection) SwaggerDoc() map[string]string
type LoadBalancer ¶
type LoadBalancer struct { // 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. // +optional Platform IngressPlatformSpec `json:"platform,omitempty"` }
func (*LoadBalancer) DeepCopy ¶
func (in *LoadBalancer) DeepCopy() *LoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LoadBalancer.
func (*LoadBalancer) DeepCopyInto ¶
func (in *LoadBalancer) DeepCopyInto(out *LoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (LoadBalancer) SwaggerDoc ¶
func (LoadBalancer) SwaggerDoc() map[string]string
type LogFormatType ¶
type LogFormatType string
type MTUMigration ¶
type MTUMigration struct { // network contains MTU migration configuration for the default network. // +optional Network *MTUMigrationValues `json:"network,omitempty"` // machine contains MTU migration configuration for the machine's uplink. // +optional Machine *MTUMigrationValues `json:"machine,omitempty"` }
MTUMigration contains infomation about MTU migration.
func (*MTUMigration) DeepCopy ¶
func (in *MTUMigration) DeepCopy() *MTUMigration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MTUMigration.
func (*MTUMigration) DeepCopyInto ¶
func (in *MTUMigration) DeepCopyInto(out *MTUMigration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (MTUMigration) SwaggerDoc ¶
func (MTUMigration) SwaggerDoc() map[string]string
type MTUMigrationValues ¶
type MTUMigrationValues struct { // to is the MTU to migrate to. // +kubebuilder:validation:Minimum=0 To *uint32 `json:"to"` // from is the MTU to migrate from. // +kubebuilder:validation:Minimum=0 // +optional From *uint32 `json:"from,omitempty"` }
MTUMigrationValues contains the values for a MTU migration.
func (*MTUMigrationValues) DeepCopy ¶
func (in *MTUMigrationValues) DeepCopy() *MTUMigrationValues
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MTUMigrationValues.
func (*MTUMigrationValues) DeepCopyInto ¶
func (in *MTUMigrationValues) DeepCopyInto(out *MTUMigrationValues)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (MTUMigrationValues) SwaggerDoc ¶
func (MTUMigrationValues) SwaggerDoc() map[string]string
type MappingMethodType ¶
type MappingMethodType string
MappingMethodType specifies how new identities should be mapped to users when they log in
const ( // MappingMethodClaim provisions a user with the identity’s preferred user name. Fails if a user // with that user name is already mapped to another identity. // Default. MappingMethodClaim MappingMethodType = "claim" // MappingMethodLookup looks up existing users already mapped to an identity but does not // automatically provision users or identities. Requires identities and users be set up // manually or using an external process. MappingMethodLookup MappingMethodType = "lookup" // MappingMethodAdd provisions a user with the identity’s preferred user name. If a user with // that user name already exists, the identity is mapped to the existing user, adding to any // existing identity mappings for the user. MappingMethodAdd MappingMethodType = "add" )
type MaxAgePolicy ¶
type MaxAgePolicy struct { // 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. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=2147483647 LargestMaxAge *int32 `json:"largestMaxAge,omitempty"` // 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. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=2147483647 SmallestMaxAge *int32 `json:"smallestMaxAge,omitempty"` }
MaxAgePolicy contains a numeric range for specifying a compliant HSTS max-age for the enclosing RequiredHSTSPolicy
func (*MaxAgePolicy) DeepCopy ¶
func (in *MaxAgePolicy) DeepCopy() *MaxAgePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MaxAgePolicy.
func (*MaxAgePolicy) DeepCopyInto ¶
func (in *MaxAgePolicy) DeepCopyInto(out *MaxAgePolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (MaxAgePolicy) SwaggerDoc ¶
func (MaxAgePolicy) SwaggerDoc() map[string]string
type Mirror ¶
type Mirror string
+kubebuilder:validation:Pattern=`^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])(:[0-9]+)?(\/[^\/:\n]+)*(\/[^\/:\n]+((:[^\/:\n]+)|(@[^\n]+)))?$`
type MirrorSourcePolicy ¶
type MirrorSourcePolicy string
MirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. +kubebuilder:validation:Enum=NeverContactSource;AllowContactingSource
const ( // NeverContactSource prevents image pull from the specified repository in the pull spec if the image pull from the mirror list fails. NeverContactSource MirrorSourcePolicy = "NeverContactSource" // AllowContactingSource allows falling back to the specified repository in the pull spec if the image pull from the mirror list fails. AllowContactingSource MirrorSourcePolicy = "AllowContactingSource" )
type ModernTLSProfile ¶
type ModernTLSProfile struct{}
ModernTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility
func (*ModernTLSProfile) DeepCopy ¶
func (in *ModernTLSProfile) DeepCopy() *ModernTLSProfile
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModernTLSProfile.
func (*ModernTLSProfile) DeepCopyInto ¶
func (in *ModernTLSProfile) DeepCopyInto(out *ModernTLSProfile)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ModernTLSProfile) SwaggerDoc ¶
func (ModernTLSProfile) SwaggerDoc() map[string]string
type NamedCertificate ¶
type NamedCertificate struct { // 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. Names []string `json:"names,omitempty"` // CertInfo is the TLS cert info for serving secure traffic CertInfo `json:",inline"` }
NamedCertificate specifies a certificate/key, and the names it should be served for
func (*NamedCertificate) DeepCopy ¶
func (in *NamedCertificate) DeepCopy() *NamedCertificate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamedCertificate.
func (*NamedCertificate) DeepCopyInto ¶
func (in *NamedCertificate) DeepCopyInto(out *NamedCertificate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NamedCertificate) SwaggerDoc ¶
func (NamedCertificate) SwaggerDoc() map[string]string
type Network ¶
type Network struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // 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. // +required Spec NetworkSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status NetworkStatus `json:"status"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:compatibility-gen:level=1 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=networks,scope=Cluster +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Network) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Network.
func (*Network) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Network) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Network) SwaggerDoc ¶
type NetworkDiagnostics ¶
type NetworkDiagnostics struct { // mode controls the network diagnostics mode // // 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. // The current default is All. // // +optional Mode NetworkDiagnosticsMode `json:"mode"` // sourcePlacement controls the scheduling of network diagnostics source deployment // // See NetworkDiagnosticsSourcePlacement for more details about default values. // // +optional SourcePlacement NetworkDiagnosticsSourcePlacement `json:"sourcePlacement"` // targetPlacement controls the scheduling of network diagnostics target daemonset // // See NetworkDiagnosticsTargetPlacement for more details about default values. // // +optional TargetPlacement NetworkDiagnosticsTargetPlacement `json:"targetPlacement"` }
func (*NetworkDiagnostics) DeepCopy ¶
func (in *NetworkDiagnostics) DeepCopy() *NetworkDiagnostics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkDiagnostics.
func (*NetworkDiagnostics) DeepCopyInto ¶
func (in *NetworkDiagnostics) DeepCopyInto(out *NetworkDiagnostics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkDiagnostics) SwaggerDoc ¶
func (NetworkDiagnostics) SwaggerDoc() map[string]string
type NetworkDiagnosticsMode ¶
type NetworkDiagnosticsMode string
NetworkDiagnosticsMode is an enumeration of the available network diagnostics modes Valid values are "", "All", "Disabled". +kubebuilder:validation:Enum:="";All;Disabled
const ( // NetworkDiagnosticsNoOpinion means that the user has no opinion and the platform is left // to choose reasonable default. The current default is All and is a subject to change over time. NetworkDiagnosticsNoOpinion NetworkDiagnosticsMode = "" // NetworkDiagnosticsAll means that all network diagnostics checks are enabled NetworkDiagnosticsAll NetworkDiagnosticsMode = "All" // NetworkDiagnosticsDisabled means that network diagnostics is disabled NetworkDiagnosticsDisabled NetworkDiagnosticsMode = "Disabled" )
type NetworkDiagnosticsSourcePlacement ¶
type NetworkDiagnosticsSourcePlacement struct { // nodeSelector is the node selector applied to network diagnostics components // // 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. // The current default is `kubernetes.io/os: linux`. // // +optional NodeSelector map[string]string `json:"nodeSelector"` // tolerations is a list of tolerations applied to network diagnostics components // // 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. // The current default is an empty list. // // +optional // +listType=atomic Tolerations []corev1.Toleration `json:"tolerations"` }
NetworkDiagnosticsSourcePlacement defines node scheduling configuration network diagnostics source components
func (*NetworkDiagnosticsSourcePlacement) DeepCopy ¶
func (in *NetworkDiagnosticsSourcePlacement) DeepCopy() *NetworkDiagnosticsSourcePlacement
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkDiagnosticsSourcePlacement.
func (*NetworkDiagnosticsSourcePlacement) DeepCopyInto ¶
func (in *NetworkDiagnosticsSourcePlacement) DeepCopyInto(out *NetworkDiagnosticsSourcePlacement)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkDiagnosticsSourcePlacement) SwaggerDoc ¶
func (NetworkDiagnosticsSourcePlacement) SwaggerDoc() map[string]string
type NetworkDiagnosticsTargetPlacement ¶
type NetworkDiagnosticsTargetPlacement struct { // nodeSelector is the node selector applied to network diagnostics components // // 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. // The current default is `kubernetes.io/os: linux`. // // +optional NodeSelector map[string]string `json:"nodeSelector"` // tolerations is a list of tolerations applied to network diagnostics components // // 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. // The current default is `- operator: "Exists"` which means that all taints are tolerated. // // +optional // +listType=atomic Tolerations []corev1.Toleration `json:"tolerations"` }
NetworkDiagnosticsTargetPlacement defines node scheduling configuration network diagnostics target components
func (*NetworkDiagnosticsTargetPlacement) DeepCopy ¶
func (in *NetworkDiagnosticsTargetPlacement) DeepCopy() *NetworkDiagnosticsTargetPlacement
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkDiagnosticsTargetPlacement.
func (*NetworkDiagnosticsTargetPlacement) DeepCopyInto ¶
func (in *NetworkDiagnosticsTargetPlacement) DeepCopyInto(out *NetworkDiagnosticsTargetPlacement)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkDiagnosticsTargetPlacement) SwaggerDoc ¶
func (NetworkDiagnosticsTargetPlacement) SwaggerDoc() map[string]string
type NetworkList ¶
type NetworkList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Network `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*NetworkList) DeepCopy ¶
func (in *NetworkList) DeepCopy() *NetworkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkList.
func (*NetworkList) DeepCopyInto ¶
func (in *NetworkList) DeepCopyInto(out *NetworkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NetworkList) DeepCopyObject ¶
func (in *NetworkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (NetworkList) SwaggerDoc ¶
func (NetworkList) SwaggerDoc() map[string]string
type NetworkMigration ¶
type NetworkMigration struct { // networkType is the target plugin that is being deployed. // DEPRECATED: network type migration is no longer supported, // so this should always be unset. // +optional NetworkType string `json:"networkType,omitempty"` // mtu is the MTU configuration that is being deployed. // +optional MTU *MTUMigration `json:"mtu,omitempty"` }
NetworkMigration represents the network migration status.
func (*NetworkMigration) DeepCopy ¶
func (in *NetworkMigration) DeepCopy() *NetworkMigration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkMigration.
func (*NetworkMigration) DeepCopyInto ¶
func (in *NetworkMigration) DeepCopyInto(out *NetworkMigration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkMigration) SwaggerDoc ¶
func (NetworkMigration) SwaggerDoc() map[string]string
type NetworkSpec ¶
type NetworkSpec struct { // IP address pool to use for pod IPs. // This field is immutable after installation. // +listType=atomic ClusterNetwork []ClusterNetworkEntry `json:"clusterNetwork"` // IP address pool for services. // Currently, we only support a single entry here. // This field is immutable after installation. // +listType=atomic ServiceNetwork []string `json:"serviceNetwork"` // networkType is the plugin that is to be deployed (e.g. OVNKubernetes). // This should match a value that the cluster-network-operator understands, // or else no networking will be installed. // Currently supported values are: // - OVNKubernetes // This field is immutable after installation. NetworkType string `json:"networkType"` // externalIP defines configuration for controllers that // affect Service.ExternalIP. If nil, then ExternalIP is // not allowed to be set. // +optional ExternalIP *ExternalIPConfig `json:"externalIP,omitempty"` // 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. // +kubebuilder:validation:Pattern=`^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])-([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$` ServiceNodePortRange string `json:"serviceNodePortRange,omitempty"` // networkDiagnostics defines network diagnostics configuration. // // Takes precedence over spec.disableNetworkDiagnostics in network.operator.openshift.io. // If networkDiagnostics is not specified or is empty, // and the spec.disableNetworkDiagnostics flag in network.operator.openshift.io is set to true, // the network diagnostics feature will be disabled. // // +optional // +openshift:enable:FeatureGate=NetworkDiagnosticsConfig NetworkDiagnostics NetworkDiagnostics `json:"networkDiagnostics"` }
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. +openshift:validation:FeatureGateAwareXValidation:featureGate=NetworkDiagnosticsConfig,rule="!has(self.networkDiagnostics) || !has(self.networkDiagnostics.mode) || self.networkDiagnostics.mode!='Disabled' || !has(self.networkDiagnostics.sourcePlacement) && !has(self.networkDiagnostics.targetPlacement)",message="cannot set networkDiagnostics.sourcePlacement and networkDiagnostics.targetPlacement when networkDiagnostics.mode is Disabled"
func (*NetworkSpec) DeepCopy ¶
func (in *NetworkSpec) DeepCopy() *NetworkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkSpec.
func (*NetworkSpec) DeepCopyInto ¶
func (in *NetworkSpec) DeepCopyInto(out *NetworkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkSpec) SwaggerDoc ¶
func (NetworkSpec) SwaggerDoc() map[string]string
type NetworkStatus ¶
type NetworkStatus struct { // IP address pool to use for pod IPs. // +listType=atomic ClusterNetwork []ClusterNetworkEntry `json:"clusterNetwork,omitempty"` // IP address pool for services. // Currently, we only support a single entry here. // +listType=atomic ServiceNetwork []string `json:"serviceNetwork,omitempty"` // networkType is the plugin that is deployed (e.g. OVNKubernetes). NetworkType string `json:"networkType,omitempty"` // clusterNetworkMTU is the MTU for inter-pod networking. ClusterNetworkMTU int `json:"clusterNetworkMTU,omitempty"` // migration contains the cluster network migration configuration. Migration *NetworkMigration `json:"migration,omitempty"` // conditions represents the observations of a network.config current state. // Known .status.conditions.type are: "NetworkDiagnosticsAvailable" // +optional // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type // +openshift:enable:FeatureGate=NetworkDiagnosticsConfig Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` }
NetworkStatus is the current network configuration.
func (*NetworkStatus) DeepCopy ¶
func (in *NetworkStatus) DeepCopy() *NetworkStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkStatus.
func (*NetworkStatus) DeepCopyInto ¶
func (in *NetworkStatus) DeepCopyInto(out *NetworkStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NetworkStatus) SwaggerDoc ¶
func (NetworkStatus) SwaggerDoc() map[string]string
type Node ¶
type Node struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec NodeSpec `json:"spec"` // status holds observed values. // +optional Status NodeStatus `json:"status"` }
Node holds cluster-wide information about node specific features.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/1107 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=nodes,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Node) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Node.
func (*Node) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Node) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Node) SwaggerDoc ¶
type NodeList ¶
type NodeList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Node `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*NodeList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeList.
func (*NodeList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NodeList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (NodeList) SwaggerDoc ¶
type NodeSpec ¶
type NodeSpec struct { // cgroupMode determines the cgroups version on the node // +optional CgroupMode CgroupMode `json:"cgroupMode,omitempty"` // workerLatencyProfile determins the how fast the kubelet is updating // the status and corresponding reaction of the cluster // +optional WorkerLatencyProfile WorkerLatencyProfileType `json:"workerLatencyProfile,omitempty"` // minimumKubeletVersion is the lowest version of a kubelet that can join the cluster. // Specifically, the apiserver will deny most authorization requests of kubelets that are older // than the specified version, only allowing the kubelet to get and update its node object, and perform // subjectaccessreviews. // This means any kubelet that attempts to join the cluster will not be able to run any assigned workloads, // and will eventually be marked as not ready. // Its max length is 8, so maximum version allowed is either "9.999.99" or "99.99.99". // Since the kubelet reports the version of the kubernetes release, not Openshift, this field references // the underlying kubernetes version this version of Openshift is based off of. // In other words: if an admin wishes to ensure no nodes run an older version than Openshift 4.17, then // they should set the minimumKubeletVersion to 1.30.0. // When comparing versions, the kubelet's version is stripped of any contents outside of major.minor.patch version. // Thus, a kubelet with version "1.0.0-ec.0" will be compatible with minimumKubeletVersion "1.0.0" or earlier. // +kubebuilder:validation:XValidation:rule="self == \"\" || self.matches('^[0-9]*.[0-9]*.[0-9]*$')",message="minmumKubeletVersion must be in a semver compatible format of x.y.z, or empty" // +kubebuilder:validation:MaxLength:=8 // +openshift:enable:FeatureGate=MinimumKubeletVersion // +optional MinimumKubeletVersion string `json:"minimumKubeletVersion"` }
func (*NodeSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeSpec.
func (*NodeSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NodeSpec) SwaggerDoc ¶
type NodeStatus ¶
type NodeStatus struct { // conditions contain the details and the current state of the nodes.config object // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type // +optional Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` }
func (*NodeStatus) DeepCopy ¶
func (in *NodeStatus) DeepCopy() *NodeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeStatus.
func (*NodeStatus) DeepCopyInto ¶
func (in *NodeStatus) DeepCopyInto(out *NodeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NodeStatus) SwaggerDoc ¶
func (NodeStatus) SwaggerDoc() map[string]string
type NutanixFailureDomain ¶
type NutanixFailureDomain struct { // name defines the unique name of a failure domain. // Name is required and must be at most 64 characters in length. // It must consist of only lower case alphanumeric characters and hyphens (-). // It must start and end with an alphanumeric character. // This value is arbitrary and is used to identify the failure domain within the platform. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 // +kubebuilder:validation:Pattern=`[a-z0-9]([-a-z0-9]*[a-z0-9])?` Name string `json:"name"` // cluster is to identify the cluster (the Prism Element under management of the Prism Central), // in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained // from the Prism Central console or using the prism_central API. // +required Cluster NutanixResourceIdentifier `json:"cluster"` // subnets holds a list of identifiers (one or more) of the cluster's network subnets // If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured. // for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be // obtained from the Prism Central console or using the prism_central API. // +required // +kubebuilder:validation:MinItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate="",maxItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate=NutanixMultiSubnets,maxItems=32 // +openshift:validation:FeatureGateAwareXValidation:featureGate=NutanixMultiSubnets,rule="self.all(x, self.exists_one(y, x == y))",message="each subnet must be unique" // +listType=atomic Subnets []NutanixResourceIdentifier `json:"subnets"` }
NutanixFailureDomain configures failure domain information for the Nutanix platform.
func (*NutanixFailureDomain) DeepCopy ¶
func (in *NutanixFailureDomain) DeepCopy() *NutanixFailureDomain
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixFailureDomain.
func (*NutanixFailureDomain) DeepCopyInto ¶
func (in *NutanixFailureDomain) DeepCopyInto(out *NutanixFailureDomain)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixFailureDomain) SwaggerDoc ¶
func (NutanixFailureDomain) SwaggerDoc() map[string]string
type NutanixIdentifierType ¶
type NutanixIdentifierType string
NutanixIdentifierType is an enumeration of different resource identifier types. +kubebuilder:validation:Enum:=UUID;Name
const ( // NutanixIdentifierUUID is a resource identifier identifying the object by UUID. NutanixIdentifierUUID NutanixIdentifierType = "UUID" // NutanixIdentifierName is a resource identifier identifying the object by Name. NutanixIdentifierName NutanixIdentifierType = "Name" )
type NutanixPlatformLoadBalancer ¶
type NutanixPlatformLoadBalancer struct { // 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. // +default="OpenShiftManagedDefault" // +kubebuilder:default:="OpenShiftManagedDefault" // +kubebuilder:validation:Enum:="OpenShiftManagedDefault";"UserManaged" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="type is immutable once set" // +optional // +unionDiscriminator Type PlatformLoadBalancerType `json:"type,omitempty"` }
NutanixPlatformLoadBalancer defines the load balancer used by the cluster on Nutanix platform. +union
func (*NutanixPlatformLoadBalancer) DeepCopy ¶
func (in *NutanixPlatformLoadBalancer) DeepCopy() *NutanixPlatformLoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixPlatformLoadBalancer.
func (*NutanixPlatformLoadBalancer) DeepCopyInto ¶
func (in *NutanixPlatformLoadBalancer) DeepCopyInto(out *NutanixPlatformLoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixPlatformLoadBalancer) SwaggerDoc ¶
func (NutanixPlatformLoadBalancer) SwaggerDoc() map[string]string
type NutanixPlatformSpec ¶
type NutanixPlatformSpec struct { // 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. // +required PrismCentral NutanixPrismEndpoint `json:"prismCentral"` // 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. // +required // +listType=map // +listMapKey=name PrismElements []NutanixPrismElementEndpoint `json:"prismElements"` // failureDomains configures failure domains information for the Nutanix platform. // When set, the failure domains defined here may be used to spread Machines across // prism element clusters to improve fault tolerance of the cluster. // +openshift:validation:FeatureGateAwareMaxItems:featureGate=NutanixMultiSubnets,maxItems=32 // +listType=map // +listMapKey=name // +optional FailureDomains []NutanixFailureDomain `json:"failureDomains"` }
NutanixPlatformSpec holds the desired state of the Nutanix infrastructure provider. This only includes fields that can be modified in the cluster.
func (*NutanixPlatformSpec) DeepCopy ¶
func (in *NutanixPlatformSpec) DeepCopy() *NutanixPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixPlatformSpec.
func (*NutanixPlatformSpec) DeepCopyInto ¶
func (in *NutanixPlatformSpec) DeepCopyInto(out *NutanixPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixPlatformSpec) SwaggerDoc ¶
func (NutanixPlatformSpec) SwaggerDoc() map[string]string
type NutanixPlatformStatus ¶
type NutanixPlatformStatus struct { // 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. // // Deprecated: Use APIServerInternalIPs instead. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=set APIServerInternalIPs []string `json:"apiServerInternalIPs"` // 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. // // Deprecated: Use IngressIPs instead. IngressIP string `json:"ingressIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=set IngressIPs []string `json:"ingressIPs"` // loadBalancer defines how the load balancer used by the cluster is configured. // +default={"type": "OpenShiftManagedDefault"} // +kubebuilder:default={"type": "OpenShiftManagedDefault"} // +openshift:enable:FeatureGate=BareMetalLoadBalancer // +optional LoadBalancer *NutanixPlatformLoadBalancer `json:"loadBalancer,omitempty"` }
NutanixPlatformStatus holds the current status of the Nutanix infrastructure provider.
func (*NutanixPlatformStatus) DeepCopy ¶
func (in *NutanixPlatformStatus) DeepCopy() *NutanixPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixPlatformStatus.
func (*NutanixPlatformStatus) DeepCopyInto ¶
func (in *NutanixPlatformStatus) DeepCopyInto(out *NutanixPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixPlatformStatus) SwaggerDoc ¶
func (NutanixPlatformStatus) SwaggerDoc() map[string]string
type NutanixPrismElementEndpoint ¶
type NutanixPrismElementEndpoint struct { // 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). // +required // +kubebuilder:validation:MaxLength=256 Name string `json:"name"` // 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. // +required Endpoint NutanixPrismEndpoint `json:"endpoint"` }
NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)
func (*NutanixPrismElementEndpoint) DeepCopy ¶
func (in *NutanixPrismElementEndpoint) DeepCopy() *NutanixPrismElementEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixPrismElementEndpoint.
func (*NutanixPrismElementEndpoint) DeepCopyInto ¶
func (in *NutanixPrismElementEndpoint) DeepCopyInto(out *NutanixPrismElementEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixPrismElementEndpoint) SwaggerDoc ¶
func (NutanixPrismElementEndpoint) SwaggerDoc() map[string]string
type NutanixPrismEndpoint ¶
type NutanixPrismEndpoint struct { // address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster) // +required // +kubebuilder:validation:MaxLength=256 Address string `json:"address"` // port is the port number to access the Nutanix Prism Central or Element (cluster) // +required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 Port int32 `json:"port"` }
NutanixPrismEndpoint holds the endpoint address and port to access the Nutanix Prism Central or Element (cluster)
func (*NutanixPrismEndpoint) DeepCopy ¶
func (in *NutanixPrismEndpoint) DeepCopy() *NutanixPrismEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixPrismEndpoint.
func (*NutanixPrismEndpoint) DeepCopyInto ¶
func (in *NutanixPrismEndpoint) DeepCopyInto(out *NutanixPrismEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixPrismEndpoint) SwaggerDoc ¶
func (NutanixPrismEndpoint) SwaggerDoc() map[string]string
type NutanixResourceIdentifier ¶
type NutanixResourceIdentifier struct { // type is the identifier type to use for this resource. // +unionDiscriminator // +required Type NutanixIdentifierType `json:"type"` // uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID. // +optional UUID *string `json:"uuid,omitempty"` // name is the resource name in the PC. It cannot be empty if the type is Name. // +optional Name *string `json:"name,omitempty"` }
NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.) +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'UUID' ? has(self.uuid) : !has(self.uuid)",message="uuid configuration is required when type is UUID, and forbidden otherwise" +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Name' ? has(self.name) : !has(self.name)",message="name configuration is required when type is Name, and forbidden otherwise" +union
func (*NutanixResourceIdentifier) DeepCopy ¶
func (in *NutanixResourceIdentifier) DeepCopy() *NutanixResourceIdentifier
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NutanixResourceIdentifier.
func (*NutanixResourceIdentifier) DeepCopyInto ¶
func (in *NutanixResourceIdentifier) DeepCopyInto(out *NutanixResourceIdentifier)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NutanixResourceIdentifier) SwaggerDoc ¶
func (NutanixResourceIdentifier) SwaggerDoc() map[string]string
type OAuth ¶
type OAuth struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` // spec holds user settable values for configuration // +required Spec OAuthSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status OAuthStatus `json:"status"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=oauths,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*OAuth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth.
func (*OAuth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (OAuth) SwaggerDoc ¶
type OAuthList ¶
type OAuthList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []OAuth `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*OAuthList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthList.
func (*OAuthList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuthList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (OAuthList) SwaggerDoc ¶
type OAuthRemoteConnectionInfo ¶
type OAuthRemoteConnectionInfo struct { // url is the remote URL to connect to URL string `json:"url"` // 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. // +optional CA ConfigMapNameReference `json:"ca"` // 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. // +optional TLSClientCert SecretNameReference `json:"tlsClientCert"` // 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. // +optional TLSClientKey SecretNameReference `json:"tlsClientKey"` }
OAuthRemoteConnectionInfo holds information necessary for establishing a remote connection
func (*OAuthRemoteConnectionInfo) DeepCopy ¶
func (in *OAuthRemoteConnectionInfo) DeepCopy() *OAuthRemoteConnectionInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthRemoteConnectionInfo.
func (*OAuthRemoteConnectionInfo) DeepCopyInto ¶
func (in *OAuthRemoteConnectionInfo) DeepCopyInto(out *OAuthRemoteConnectionInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OAuthRemoteConnectionInfo) SwaggerDoc ¶
func (OAuthRemoteConnectionInfo) SwaggerDoc() map[string]string
type OAuthSpec ¶
type OAuthSpec struct { // identityProviders is an ordered list of ways for a user to identify themselves. // When this list is empty, no identities are provisioned for users. // +optional // +listType=atomic IdentityProviders []IdentityProvider `json:"identityProviders,omitempty"` // tokenConfig contains options for authorization and access tokens TokenConfig TokenConfig `json:"tokenConfig"` // templates allow you to customize pages like the login page. // +optional Templates OAuthTemplates `json:"templates"` }
OAuthSpec contains desired cluster auth configuration
func (*OAuthSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthSpec.
func (*OAuthSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OAuthSpec) SwaggerDoc ¶
type OAuthStatus ¶
type OAuthStatus struct { }
OAuthStatus shows current known state of OAuth server in the cluster
func (*OAuthStatus) DeepCopy ¶
func (in *OAuthStatus) DeepCopy() *OAuthStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthStatus.
func (*OAuthStatus) DeepCopyInto ¶
func (in *OAuthStatus) DeepCopyInto(out *OAuthStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OAuthStatus) SwaggerDoc ¶
func (OAuthStatus) SwaggerDoc() map[string]string
type OAuthTemplates ¶
type OAuthTemplates struct { // 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. // +optional Login SecretNameReference `json:"login"` // 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. // +optional ProviderSelection SecretNameReference `json:"providerSelection"` // 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. // +optional Error SecretNameReference `json:"error"` }
OAuthTemplates allow for customization of pages like the login page
func (*OAuthTemplates) DeepCopy ¶
func (in *OAuthTemplates) DeepCopy() *OAuthTemplates
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthTemplates.
func (*OAuthTemplates) DeepCopyInto ¶
func (in *OAuthTemplates) DeepCopyInto(out *OAuthTemplates)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OAuthTemplates) SwaggerDoc ¶
func (OAuthTemplates) SwaggerDoc() map[string]string
type OIDCClientConfig ¶
type OIDCClientConfig struct { // componentName is the name of the component that is supposed to consume this // client configuration // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +required ComponentName string `json:"componentName"` // componentNamespace is the namespace of the component that is supposed to consume this // client configuration // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +required ComponentNamespace string `json:"componentNamespace"` // clientID is the identifier of the OIDC client from the OIDC provider // // +kubebuilder:validation:MinLength=1 // +required ClientID string `json:"clientID"` // clientSecret refers to a secret in the `openshift-config` namespace that // contains the client secret in the `clientSecret` key of the `.data` field ClientSecret SecretNameReference `json:"clientSecret"` // extraScopes is an optional set of scopes to request tokens with. // // +listType=set ExtraScopes []string `json:"extraScopes"` }
func (*OIDCClientConfig) DeepCopy ¶
func (in *OIDCClientConfig) DeepCopy() *OIDCClientConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCClientConfig.
func (*OIDCClientConfig) DeepCopyInto ¶
func (in *OIDCClientConfig) DeepCopyInto(out *OIDCClientConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OIDCClientConfig) SwaggerDoc ¶
func (OIDCClientConfig) SwaggerDoc() map[string]string
type OIDCClientReference ¶
type OIDCClientReference struct { // OIDCName refers to the `name` of the provider from `oidcProviders` // // +kubebuilder:validation:MinLength=1 // +required OIDCProviderName string `json:"oidcProviderName"` // URL is the serving URL of the token issuer. // Must use the https:// scheme. // // +kubebuilder:validation:Pattern=`^https:\/\/[^\s]` // +required IssuerURL string `json:"issuerURL"` // clientID is the identifier of the OIDC client from the OIDC provider // // +kubebuilder:validation:MinLength=1 // +required ClientID string `json:"clientID"` }
func (*OIDCClientReference) DeepCopy ¶
func (in *OIDCClientReference) DeepCopy() *OIDCClientReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCClientReference.
func (*OIDCClientReference) DeepCopyInto ¶
func (in *OIDCClientReference) DeepCopyInto(out *OIDCClientReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OIDCClientReference) SwaggerDoc ¶
func (OIDCClientReference) SwaggerDoc() map[string]string
type OIDCClientStatus ¶
type OIDCClientStatus struct { // componentName is the name of the component that will consume a client configuration. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +required ComponentName string `json:"componentName"` // componentNamespace is the namespace of the component that will consume a client configuration. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +required ComponentNamespace string `json:"componentNamespace"` // currentOIDCClients is a list of clients that the component is currently using. // // +listType=map // +listMapKey=issuerURL // +listMapKey=clientID CurrentOIDCClients []OIDCClientReference `json:"currentOIDCClients"` // consumingUsers is a slice of ServiceAccounts that need to have read // permission on the `clientSecret` secret. // // +kubebuilder:validation:MaxItems=5 // +listType=set ConsumingUsers []ConsumingUser `json:"consumingUsers"` // conditions are used to communicate the state of the `oidcClients` entry. // // Supported conditions include Available, Degraded and Progressing. // // If Available is true, the component is successfully using the configured client. // If Degraded is true, that means something has gone wrong trying to handle the client configuration. // If Progressing is true, that means the component is taking some action related to the `oidcClients` entry. // // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty"` }
func (*OIDCClientStatus) DeepCopy ¶
func (in *OIDCClientStatus) DeepCopy() *OIDCClientStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCClientStatus.
func (*OIDCClientStatus) DeepCopyInto ¶
func (in *OIDCClientStatus) DeepCopyInto(out *OIDCClientStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OIDCClientStatus) SwaggerDoc ¶
func (OIDCClientStatus) SwaggerDoc() map[string]string
type OIDCProvider ¶
type OIDCProvider struct { // name of the OIDC provider // // +kubebuilder:validation:MinLength=1 // +required Name string `json:"name"` // issuer describes atributes of the OIDC token issuer // // +required Issuer TokenIssuer `json:"issuer"` // oidcClients contains configuration for the platform's clients that // need to request tokens from the issuer // // +listType=map // +listMapKey=componentNamespace // +listMapKey=componentName // +kubebuilder:validation:MaxItems=20 OIDCClients []OIDCClientConfig `json:"oidcClients"` // claimMappings describes rules on how to transform information from an // ID token into a cluster identity ClaimMappings TokenClaimMappings `json:"claimMappings"` // claimValidationRules are rules that are applied to validate token claims to authenticate users. // // +listType=atomic ClaimValidationRules []TokenClaimValidationRule `json:"claimValidationRules,omitempty"` }
func (*OIDCProvider) DeepCopy ¶
func (in *OIDCProvider) DeepCopy() *OIDCProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCProvider.
func (*OIDCProvider) DeepCopyInto ¶
func (in *OIDCProvider) DeepCopyInto(out *OIDCProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OIDCProvider) SwaggerDoc ¶
func (OIDCProvider) SwaggerDoc() map[string]string
type ObjectReference ¶
type ObjectReference struct { // group of the referent. // +required Group string `json:"group"` // resource of the referent. // +required Resource string `json:"resource"` // namespace of the referent. // +optional Namespace string `json:"namespace,omitempty"` // name of the referent. // +required Name string `json:"name"` }
ObjectReference contains enough information to let you inspect or modify the referred object.
func (*ObjectReference) DeepCopy ¶
func (in *ObjectReference) DeepCopy() *ObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.
func (*ObjectReference) DeepCopyInto ¶
func (in *ObjectReference) DeepCopyInto(out *ObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ObjectReference) SwaggerDoc ¶
func (ObjectReference) SwaggerDoc() map[string]string
type OldTLSProfile ¶
type OldTLSProfile struct{}
OldTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility
func (*OldTLSProfile) DeepCopy ¶
func (in *OldTLSProfile) DeepCopy() *OldTLSProfile
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OldTLSProfile.
func (*OldTLSProfile) DeepCopyInto ¶
func (in *OldTLSProfile) DeepCopyInto(out *OldTLSProfile)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OldTLSProfile) SwaggerDoc ¶
func (OldTLSProfile) SwaggerDoc() map[string]string
type OpenIDClaim ¶
type OpenIDClaim string
OpenIDClaim represents a claim retrieved from an OpenID provider's tokens or userInfo responses +kubebuilder:validation:MinLength=1
type OpenIDClaims ¶
type OpenIDClaims struct { // 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 // +listType=atomic // +optional PreferredUsername []string `json:"preferredUsername,omitempty"` // 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 // +listType=atomic // +optional Name []string `json:"name,omitempty"` // 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 // +listType=atomic // +optional Email []string `json:"email,omitempty"` // 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. // +listType=atomic // +optional Groups []OpenIDClaim `json:"groups,omitempty"` }
OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider
func (*OpenIDClaims) DeepCopy ¶
func (in *OpenIDClaims) DeepCopy() *OpenIDClaims
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDClaims.
func (*OpenIDClaims) DeepCopyInto ¶
func (in *OpenIDClaims) DeepCopyInto(out *OpenIDClaims)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OpenIDClaims) SwaggerDoc ¶
func (OpenIDClaims) SwaggerDoc() map[string]string
type OpenIDIdentityProvider ¶
type OpenIDIdentityProvider struct { // clientID is the oauth client ID ClientID string `json:"clientID"` // 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. ClientSecret SecretNameReference `json:"clientSecret"` // 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. // +optional CA ConfigMapNameReference `json:"ca"` // extraScopes are any scopes to request in addition to the standard "openid" scope. // +optional ExtraScopes []string `json:"extraScopes,omitempty"` // extraAuthorizeParameters are any custom parameters to add to the authorize request. // +optional ExtraAuthorizeParameters map[string]string `json:"extraAuthorizeParameters,omitempty"` // 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. Issuer string `json:"issuer"` // claims mappings Claims OpenIDClaims `json:"claims"` }
OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials
func (*OpenIDIdentityProvider) DeepCopy ¶
func (in *OpenIDIdentityProvider) DeepCopy() *OpenIDIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDIdentityProvider.
func (*OpenIDIdentityProvider) DeepCopyInto ¶
func (in *OpenIDIdentityProvider) DeepCopyInto(out *OpenIDIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OpenIDIdentityProvider) SwaggerDoc ¶
func (OpenIDIdentityProvider) SwaggerDoc() map[string]string
type OpenStackPlatformLoadBalancer ¶
type OpenStackPlatformLoadBalancer struct { // 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. // +default="OpenShiftManagedDefault" // +kubebuilder:default:="OpenShiftManagedDefault" // +kubebuilder:validation:Enum:="OpenShiftManagedDefault";"UserManaged" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="type is immutable once set" // +optional // +unionDiscriminator Type PlatformLoadBalancerType `json:"type,omitempty"` }
OpenStackPlatformLoadBalancer defines the load balancer used by the cluster on OpenStack platform. +union
func (*OpenStackPlatformLoadBalancer) DeepCopy ¶
func (in *OpenStackPlatformLoadBalancer) DeepCopy() *OpenStackPlatformLoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenStackPlatformLoadBalancer.
func (*OpenStackPlatformLoadBalancer) DeepCopyInto ¶
func (in *OpenStackPlatformLoadBalancer) DeepCopyInto(out *OpenStackPlatformLoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OpenStackPlatformLoadBalancer) SwaggerDoc ¶
func (OpenStackPlatformLoadBalancer) SwaggerDoc() map[string]string
type OpenStackPlatformSpec ¶
type OpenStackPlatformSpec struct { // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.apiServerInternalIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional APIServerInternalIPs []IP `json:"apiServerInternalIPs"` // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.ingressIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional IngressIPs []IP `json:"ingressIPs"` // machineNetworks are IP networks used to connect all the OpenShift cluster // nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, // for example "10.0.0.0/8" or "fd00::/8". // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
OpenStackPlatformSpec holds the desired state of the OpenStack infrastructure provider. This only includes fields that can be modified in the cluster. +kubebuilder:validation:XValidation:rule="!has(oldSelf.apiServerInternalIPs) || has(self.apiServerInternalIPs)",message="apiServerInternalIPs list is required once set" +kubebuilder:validation:XValidation:rule="!has(oldSelf.ingressIPs) || has(self.ingressIPs)",message="ingressIPs list is required once set"
func (*OpenStackPlatformSpec) DeepCopy ¶
func (in *OpenStackPlatformSpec) DeepCopy() *OpenStackPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenStackPlatformSpec.
func (*OpenStackPlatformSpec) DeepCopyInto ¶
func (in *OpenStackPlatformSpec) DeepCopyInto(out *OpenStackPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OpenStackPlatformSpec) SwaggerDoc ¶
func (OpenStackPlatformSpec) SwaggerDoc() map[string]string
type OpenStackPlatformStatus ¶
type OpenStackPlatformStatus struct { // 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. // // Deprecated: Use APIServerInternalIPs instead. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic APIServerInternalIPs []string `json:"apiServerInternalIPs"` // cloudName is the name of the desired OpenStack cloud in the // client configuration file (`clouds.yaml`). CloudName string `json:"cloudName,omitempty"` // 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. // // Deprecated: Use IngressIPs instead. IngressIP string `json:"ingressIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic IngressIPs []string `json:"ingressIPs"` // 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. NodeDNSIP string `json:"nodeDNSIP,omitempty"` // loadBalancer defines how the load balancer used by the cluster is configured. // +default={"type": "OpenShiftManagedDefault"} // +kubebuilder:default={"type": "OpenShiftManagedDefault"} // +optional LoadBalancer *OpenStackPlatformLoadBalancer `json:"loadBalancer,omitempty"` // machineNetworks are IP networks used to connect all the OpenShift cluster nodes. // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
OpenStackPlatformStatus holds the current status of the OpenStack infrastructure provider.
func (*OpenStackPlatformStatus) DeepCopy ¶
func (in *OpenStackPlatformStatus) DeepCopy() *OpenStackPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenStackPlatformStatus.
func (*OpenStackPlatformStatus) DeepCopyInto ¶
func (in *OpenStackPlatformStatus) DeepCopyInto(out *OpenStackPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OpenStackPlatformStatus) SwaggerDoc ¶
func (OpenStackPlatformStatus) SwaggerDoc() map[string]string
type OperandVersion ¶
type OperandVersion struct { // name is the name of the particular operand this version is for. It usually matches container images, not operators. // +required Name string `json:"name"` // 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 // +required Version string `json:"version"` }
func (*OperandVersion) DeepCopy ¶
func (in *OperandVersion) DeepCopy() *OperandVersion
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperandVersion.
func (*OperandVersion) DeepCopyInto ¶
func (in *OperandVersion) DeepCopyInto(out *OperandVersion)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OperandVersion) SwaggerDoc ¶
func (OperandVersion) SwaggerDoc() map[string]string
type OperatorHub ¶
type OperatorHub struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` Spec OperatorHubSpec `json:"spec"` Status OperatorHubStatus `json:"status"` }
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.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +kubebuilder:object:root=true +kubebuilder:resource:path=operatorhubs,scope=Cluster +kubebuilder:subresource:status +genclient +genclient:nonNamespaced +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_03,operatorName=marketplace,operatorOrdering=01 +openshift:capability=marketplace +openshift:compatibility-gen:level=1
func (*OperatorHub) DeepCopy ¶
func (in *OperatorHub) DeepCopy() *OperatorHub
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorHub.
func (*OperatorHub) DeepCopyInto ¶
func (in *OperatorHub) DeepCopyInto(out *OperatorHub)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OperatorHub) DeepCopyObject ¶
func (in *OperatorHub) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (OperatorHub) SwaggerDoc ¶
func (OperatorHub) SwaggerDoc() map[string]string
type OperatorHubList ¶
type OperatorHubList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []OperatorHub `json:"items"` }
OperatorHubList contains a list of OperatorHub
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*OperatorHubList) DeepCopy ¶
func (in *OperatorHubList) DeepCopy() *OperatorHubList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorHubList.
func (*OperatorHubList) DeepCopyInto ¶
func (in *OperatorHubList) DeepCopyInto(out *OperatorHubList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OperatorHubList) DeepCopyObject ¶
func (in *OperatorHubList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (OperatorHubList) SwaggerDoc ¶
func (OperatorHubList) SwaggerDoc() map[string]string
type OperatorHubSpec ¶
type OperatorHubSpec struct { // 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. // +optional DisableAllDefaultSources bool `json:"disableAllDefaultSources,omitempty"` // 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. // +optional Sources []HubSource `json:"sources,omitempty"` }
OperatorHubSpec defines the desired state of OperatorHub
func (*OperatorHubSpec) DeepCopy ¶
func (in *OperatorHubSpec) DeepCopy() *OperatorHubSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorHubSpec.
func (*OperatorHubSpec) DeepCopyInto ¶
func (in *OperatorHubSpec) DeepCopyInto(out *OperatorHubSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OperatorHubSpec) SwaggerDoc ¶
func (OperatorHubSpec) SwaggerDoc() map[string]string
type OperatorHubStatus ¶
type OperatorHubStatus struct { // sources encapsulates the result of applying the configuration for each // hub source Sources []HubSourceStatus `json:"sources,omitempty"` }
OperatorHubStatus defines the observed state of OperatorHub. The current state of the default hub sources will always be reflected here.
func (*OperatorHubStatus) DeepCopy ¶
func (in *OperatorHubStatus) DeepCopy() *OperatorHubStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorHubStatus.
func (*OperatorHubStatus) DeepCopyInto ¶
func (in *OperatorHubStatus) DeepCopyInto(out *OperatorHubStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OperatorHubStatus) SwaggerDoc ¶
func (OperatorHubStatus) SwaggerDoc() map[string]string
type OvirtPlatformLoadBalancer ¶
type OvirtPlatformLoadBalancer struct { // 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. // +default="OpenShiftManagedDefault" // +kubebuilder:default:="OpenShiftManagedDefault" // +kubebuilder:validation:Enum:="OpenShiftManagedDefault";"UserManaged" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="type is immutable once set" // +optional // +unionDiscriminator Type PlatformLoadBalancerType `json:"type,omitempty"` }
OvirtPlatformLoadBalancer defines the load balancer used by the cluster on Ovirt platform. +union
func (*OvirtPlatformLoadBalancer) DeepCopy ¶
func (in *OvirtPlatformLoadBalancer) DeepCopy() *OvirtPlatformLoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OvirtPlatformLoadBalancer.
func (*OvirtPlatformLoadBalancer) DeepCopyInto ¶
func (in *OvirtPlatformLoadBalancer) DeepCopyInto(out *OvirtPlatformLoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OvirtPlatformLoadBalancer) SwaggerDoc ¶
func (OvirtPlatformLoadBalancer) SwaggerDoc() map[string]string
type OvirtPlatformSpec ¶
type OvirtPlatformSpec struct{}
OvirtPlatformSpec holds the desired state of the oVirt infrastructure provider. This only includes fields that can be modified in the cluster.
func (*OvirtPlatformSpec) DeepCopy ¶
func (in *OvirtPlatformSpec) DeepCopy() *OvirtPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OvirtPlatformSpec.
func (*OvirtPlatformSpec) DeepCopyInto ¶
func (in *OvirtPlatformSpec) DeepCopyInto(out *OvirtPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OvirtPlatformSpec) SwaggerDoc ¶
func (OvirtPlatformSpec) SwaggerDoc() map[string]string
type OvirtPlatformStatus ¶
type OvirtPlatformStatus struct { // 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. // // Deprecated: Use APIServerInternalIPs instead. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=set APIServerInternalIPs []string `json:"apiServerInternalIPs"` // 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. // // Deprecated: Use IngressIPs instead. IngressIP string `json:"ingressIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=set IngressIPs []string `json:"ingressIPs"` // deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release. NodeDNSIP string `json:"nodeDNSIP,omitempty"` // loadBalancer defines how the load balancer used by the cluster is configured. // +default={"type": "OpenShiftManagedDefault"} // +kubebuilder:default={"type": "OpenShiftManagedDefault"} // +openshift:enable:FeatureGate=BareMetalLoadBalancer // +optional LoadBalancer *OvirtPlatformLoadBalancer `json:"loadBalancer,omitempty"` }
OvirtPlatformStatus holds the current status of the oVirt infrastructure provider.
func (*OvirtPlatformStatus) DeepCopy ¶
func (in *OvirtPlatformStatus) DeepCopy() *OvirtPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OvirtPlatformStatus.
func (*OvirtPlatformStatus) DeepCopyInto ¶
func (in *OvirtPlatformStatus) DeepCopyInto(out *OvirtPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (OvirtPlatformStatus) SwaggerDoc ¶
func (OvirtPlatformStatus) SwaggerDoc() map[string]string
type PlatformLoadBalancerType ¶
type PlatformLoadBalancerType string
PlatformLoadBalancerType defines the type of load balancer used by the cluster.
const ( // LoadBalancerTypeUserManaged is a load balancer with control-plane VIPs managed outside of the cluster by the customer. LoadBalancerTypeUserManaged PlatformLoadBalancerType = "UserManaged" // LoadBalancerTypeOpenShiftManagedDefault is the default load balancer with control-plane VIPs managed by the OpenShift cluster. LoadBalancerTypeOpenShiftManagedDefault PlatformLoadBalancerType = "OpenShiftManagedDefault" )
type PlatformSpec ¶
type PlatformSpec struct { // 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. // // +unionDiscriminator Type PlatformType `json:"type"` // aws contains settings specific to the Amazon Web Services infrastructure provider. // +optional AWS *AWSPlatformSpec `json:"aws,omitempty"` // azure contains settings specific to the Azure infrastructure provider. // +optional Azure *AzurePlatformSpec `json:"azure,omitempty"` // gcp contains settings specific to the Google Cloud Platform infrastructure provider. // +optional GCP *GCPPlatformSpec `json:"gcp,omitempty"` // baremetal contains settings specific to the BareMetal platform. // +optional BareMetal *BareMetalPlatformSpec `json:"baremetal,omitempty"` // openstack contains settings specific to the OpenStack infrastructure provider. // +optional OpenStack *OpenStackPlatformSpec `json:"openstack,omitempty"` // ovirt contains settings specific to the oVirt infrastructure provider. // +optional Ovirt *OvirtPlatformSpec `json:"ovirt,omitempty"` // vsphere contains settings specific to the VSphere infrastructure provider. // +optional VSphere *VSpherePlatformSpec `json:"vsphere,omitempty"` // ibmcloud contains settings specific to the IBMCloud infrastructure provider. // +optional IBMCloud *IBMCloudPlatformSpec `json:"ibmcloud,omitempty"` // kubevirt contains settings specific to the kubevirt infrastructure provider. // +optional Kubevirt *KubevirtPlatformSpec `json:"kubevirt,omitempty"` // equinixMetal contains settings specific to the Equinix Metal infrastructure provider. // +optional EquinixMetal *EquinixMetalPlatformSpec `json:"equinixMetal,omitempty"` // powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. // +optional PowerVS *PowerVSPlatformSpec `json:"powervs,omitempty"` // alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. // +optional AlibabaCloud *AlibabaCloudPlatformSpec `json:"alibabaCloud,omitempty"` // nutanix contains settings specific to the Nutanix infrastructure provider. // +optional Nutanix *NutanixPlatformSpec `json:"nutanix,omitempty"` // ExternalPlatformType represents generic infrastructure provider. // Platform-specific components should be supplemented separately. // +optional External *ExternalPlatformSpec `json:"external,omitempty"` }
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. +kubebuilder:validation:XValidation:rule="!has(oldSelf.vsphere) && has(self.vsphere) ? size(self.vsphere.vcenters) < 2 : true",message="vcenters can have at most 1 item when configured post-install"
func (*PlatformSpec) DeepCopy ¶
func (in *PlatformSpec) DeepCopy() *PlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformSpec.
func (*PlatformSpec) DeepCopyInto ¶
func (in *PlatformSpec) DeepCopyInto(out *PlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PlatformSpec) SwaggerDoc ¶
func (PlatformSpec) SwaggerDoc() map[string]string
type PlatformStatus ¶
type PlatformStatus struct { // 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. // // This value will be synced with to the `status.platform` and `status.platformStatus.type`. // Currently this value cannot be changed once set. Type PlatformType `json:"type"` // aws contains settings specific to the Amazon Web Services infrastructure provider. // +optional AWS *AWSPlatformStatus `json:"aws,omitempty"` // azure contains settings specific to the Azure infrastructure provider. // +optional Azure *AzurePlatformStatus `json:"azure,omitempty"` // gcp contains settings specific to the Google Cloud Platform infrastructure provider. // +optional GCP *GCPPlatformStatus `json:"gcp,omitempty"` // baremetal contains settings specific to the BareMetal platform. // +optional BareMetal *BareMetalPlatformStatus `json:"baremetal,omitempty"` // openstack contains settings specific to the OpenStack infrastructure provider. // +optional OpenStack *OpenStackPlatformStatus `json:"openstack,omitempty"` // ovirt contains settings specific to the oVirt infrastructure provider. // +optional Ovirt *OvirtPlatformStatus `json:"ovirt,omitempty"` // vsphere contains settings specific to the VSphere infrastructure provider. // +optional VSphere *VSpherePlatformStatus `json:"vsphere,omitempty"` // ibmcloud contains settings specific to the IBMCloud infrastructure provider. // +optional IBMCloud *IBMCloudPlatformStatus `json:"ibmcloud,omitempty"` // kubevirt contains settings specific to the kubevirt infrastructure provider. // +optional Kubevirt *KubevirtPlatformStatus `json:"kubevirt,omitempty"` // equinixMetal contains settings specific to the Equinix Metal infrastructure provider. // +optional EquinixMetal *EquinixMetalPlatformStatus `json:"equinixMetal,omitempty"` // powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. // +optional PowerVS *PowerVSPlatformStatus `json:"powervs,omitempty"` // alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. // +optional AlibabaCloud *AlibabaCloudPlatformStatus `json:"alibabaCloud,omitempty"` // nutanix contains settings specific to the Nutanix infrastructure provider. // +optional Nutanix *NutanixPlatformStatus `json:"nutanix,omitempty"` // external contains settings specific to the generic External infrastructure provider. // +optional External *ExternalPlatformStatus `json:"external,omitempty"` }
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.
func (*PlatformStatus) DeepCopy ¶
func (in *PlatformStatus) DeepCopy() *PlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformStatus.
func (*PlatformStatus) DeepCopyInto ¶
func (in *PlatformStatus) DeepCopyInto(out *PlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PlatformStatus) SwaggerDoc ¶
func (PlatformStatus) SwaggerDoc() map[string]string
type PlatformType ¶
type PlatformType string
PlatformType is a specific supported infrastructure provider. +kubebuilder:validation:Enum="";AWS;Azure;BareMetal;GCP;Libvirt;OpenStack;None;VSphere;oVirt;IBMCloud;KubeVirt;EquinixMetal;PowerVS;AlibabaCloud;Nutanix;External
const ( // AWSPlatformType represents Amazon Web Services infrastructure. AWSPlatformType PlatformType = "AWS" // AzurePlatformType represents Microsoft Azure infrastructure. AzurePlatformType PlatformType = "Azure" // BareMetalPlatformType represents managed bare metal infrastructure. BareMetalPlatformType PlatformType = "BareMetal" // GCPPlatformType represents Google Cloud Platform infrastructure. GCPPlatformType PlatformType = "GCP" // LibvirtPlatformType represents libvirt infrastructure. LibvirtPlatformType PlatformType = "Libvirt" // OpenStackPlatformType represents OpenStack infrastructure. OpenStackPlatformType PlatformType = "OpenStack" // NonePlatformType means there is no infrastructure provider. NonePlatformType PlatformType = "None" // VSpherePlatformType represents VMWare vSphere infrastructure. VSpherePlatformType PlatformType = "VSphere" // OvirtPlatformType represents oVirt/RHV infrastructure. OvirtPlatformType PlatformType = "oVirt" // IBMCloudPlatformType represents IBM Cloud infrastructure. IBMCloudPlatformType PlatformType = "IBMCloud" // KubevirtPlatformType represents KubeVirt/Openshift Virtualization infrastructure. KubevirtPlatformType PlatformType = "KubeVirt" // EquinixMetalPlatformType represents Equinix Metal infrastructure. EquinixMetalPlatformType PlatformType = "EquinixMetal" // PowerVSPlatformType represents IBM Power Systems Virtual Servers infrastructure. PowerVSPlatformType PlatformType = "PowerVS" // AlibabaCloudPlatformType represents Alibaba Cloud infrastructure. AlibabaCloudPlatformType PlatformType = "AlibabaCloud" // NutanixPlatformType represents Nutanix infrastructure. NutanixPlatformType PlatformType = "Nutanix" // ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately. ExternalPlatformType PlatformType = "External" )
type PowerVSPlatformSpec ¶
type PowerVSPlatformSpec struct { // serviceEndpoints is a list of custom endpoints which will override the default // service endpoints of a Power VS service. // +listType=map // +listMapKey=name // +optional ServiceEndpoints []PowerVSServiceEndpoint `json:"serviceEndpoints,omitempty"` }
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.
func (*PowerVSPlatformSpec) DeepCopy ¶
func (in *PowerVSPlatformSpec) DeepCopy() *PowerVSPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PowerVSPlatformSpec.
func (*PowerVSPlatformSpec) DeepCopyInto ¶
func (in *PowerVSPlatformSpec) DeepCopyInto(out *PowerVSPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PowerVSPlatformSpec) SwaggerDoc ¶
func (PowerVSPlatformSpec) SwaggerDoc() map[string]string
type PowerVSPlatformStatus ¶
type PowerVSPlatformStatus struct { // region holds the default Power VS region for new Power VS resources created by the cluster. Region string `json:"region"` // zone holds the default zone for the new Power VS resources created by the cluster. // Note: Currently only single-zone OCP clusters are supported Zone string `json:"zone"` // 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. // // +kubebuilder:validation:Pattern=^[a-zA-Z0-9-_ ]+$ // +kubebuilder:validation:MaxLength=40 // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="resourceGroup is immutable once set" // +optional ResourceGroup string `json:"resourceGroup"` // serviceEndpoints is a list of custom endpoints which will override the default // service endpoints of a Power VS service. // +listType=map // +listMapKey=name // +optional ServiceEndpoints []PowerVSServiceEndpoint `json:"serviceEndpoints,omitempty"` // cisInstanceCRN is the CRN of the Cloud Internet Services instance managing // the DNS zone for the cluster's base domain CISInstanceCRN string `json:"cisInstanceCRN,omitempty"` // dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone // for the cluster's base domain DNSInstanceCRN string `json:"dnsInstanceCRN,omitempty"` }
PowerVSPlatformStatus holds the current status of the IBM Power Systems Virtual Servers infrastrucutre provider. +kubebuilder:validation:XValidation:rule="!has(oldSelf.resourceGroup) || has(self.resourceGroup)",message="cannot unset resourceGroup once set"
func (*PowerVSPlatformStatus) DeepCopy ¶
func (in *PowerVSPlatformStatus) DeepCopy() *PowerVSPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PowerVSPlatformStatus.
func (*PowerVSPlatformStatus) DeepCopyInto ¶
func (in *PowerVSPlatformStatus) DeepCopyInto(out *PowerVSPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PowerVSPlatformStatus) SwaggerDoc ¶
func (PowerVSPlatformStatus) SwaggerDoc() map[string]string
type PowerVSServiceEndpoint ¶
type PowerVSServiceEndpoint struct { // 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 // // +required // +kubebuilder:validation:Enum=CIS;COS;COSConfig;DNSServices;GlobalCatalog;GlobalSearch;GlobalTagging;HyperProtect;IAM;KeyProtect;Power;ResourceController;ResourceManager;VPC Name string `json:"name"` // 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. // // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:Format=uri // +kubebuilder:validation:Pattern=`^https://` URL string `json:"url"` }
PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.
func (*PowerVSServiceEndpoint) DeepCopy ¶
func (in *PowerVSServiceEndpoint) DeepCopy() *PowerVSServiceEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PowerVSServiceEndpoint.
func (*PowerVSServiceEndpoint) DeepCopyInto ¶
func (in *PowerVSServiceEndpoint) DeepCopyInto(out *PowerVSServiceEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PowerVSServiceEndpoint) SwaggerDoc ¶
func (PowerVSServiceEndpoint) SwaggerDoc() map[string]string
type PrefixedClaimMapping ¶
type PrefixedClaimMapping struct { TokenClaimMapping `json:",inline"` // prefix is a string to prefix the value from the token in the result of the // claim mapping. // // By default, no prefixing occurs. // // Example: if `prefix` is set to "myoidc:"" and the `claim` in JWT contains // an array of strings "a", "b" and "c", the mapping will result in an // array of string "myoidc:a", "myoidc:b" and "myoidc:c". Prefix string `json:"prefix"` }
func (*PrefixedClaimMapping) DeepCopy ¶
func (in *PrefixedClaimMapping) DeepCopy() *PrefixedClaimMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrefixedClaimMapping.
func (*PrefixedClaimMapping) DeepCopyInto ¶
func (in *PrefixedClaimMapping) DeepCopyInto(out *PrefixedClaimMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PrefixedClaimMapping) SwaggerDoc ¶
func (PrefixedClaimMapping) SwaggerDoc() map[string]string
type PreloadPolicy ¶
type PreloadPolicy string
PreloadPolicy contains a value for specifying a compliant HSTS preload policy for the enclosing RequiredHSTSPolicy +kubebuilder:validation:Enum=RequirePreload;RequireNoPreload;NoOpinion
const ( // RequirePreloadPolicy means HSTS "preload" is required by the RequiredHSTSPolicy RequirePreloadPolicy PreloadPolicy = "RequirePreload" // RequireNoPreloadPolicy means HSTS "preload" is forbidden by the RequiredHSTSPolicy RequireNoPreloadPolicy PreloadPolicy = "RequireNoPreload" // NoOpinionPreloadPolicy means HSTS "preload" doesn't matter to the RequiredHSTSPolicy NoOpinionPreloadPolicy PreloadPolicy = "NoOpinion" )
type ProfileCustomizations ¶
type ProfileCustomizations struct { // dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler. // Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod. // Third-party resource drivers are responsible for tracking and allocating resources. // Different kinds of resources support arbitrary parameters for defining requirements and initialization. // Valid values are Enabled, Disabled and omitted. // When omitted, this means no opinion and the platform is left to choose a reasonable default, // which is subject to change over time. // The current default is Disabled. // +optional DynamicResourceAllocation DRAEnablement `json:"dynamicResourceAllocation"` }
ProfileCustomizations contains various parameters for modifying the default behavior of certain profiles
func (*ProfileCustomizations) DeepCopy ¶
func (in *ProfileCustomizations) DeepCopy() *ProfileCustomizations
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProfileCustomizations.
func (*ProfileCustomizations) DeepCopyInto ¶
func (in *ProfileCustomizations) DeepCopyInto(out *ProfileCustomizations)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ProfileCustomizations) SwaggerDoc ¶
func (ProfileCustomizations) SwaggerDoc() map[string]string
type Project ¶
type Project struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec ProjectSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status ProjectStatus `json:"status"` }
Project holds cluster-wide information about Project. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=projects,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Project) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Project.
func (*Project) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Project) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Project) SwaggerDoc ¶
type ProjectList ¶
type ProjectList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Project `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ProjectList) DeepCopy ¶
func (in *ProjectList) DeepCopy() *ProjectList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectList.
func (*ProjectList) DeepCopyInto ¶
func (in *ProjectList) DeepCopyInto(out *ProjectList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProjectList) DeepCopyObject ¶
func (in *ProjectList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ProjectList) SwaggerDoc ¶
func (ProjectList) SwaggerDoc() map[string]string
type ProjectSpec ¶
type ProjectSpec struct { // projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint // +optional ProjectRequestMessage string `json:"projectRequestMessage"` // 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. // // +optional ProjectRequestTemplate TemplateReference `json:"projectRequestTemplate"` }
ProjectSpec holds the project creation configuration.
func (*ProjectSpec) DeepCopy ¶
func (in *ProjectSpec) DeepCopy() *ProjectSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectSpec.
func (*ProjectSpec) DeepCopyInto ¶
func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ProjectSpec) SwaggerDoc ¶
func (ProjectSpec) SwaggerDoc() map[string]string
type ProjectStatus ¶
type ProjectStatus struct { }
func (*ProjectStatus) DeepCopy ¶
func (in *ProjectStatus) DeepCopy() *ProjectStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectStatus.
func (*ProjectStatus) DeepCopyInto ¶
func (in *ProjectStatus) DeepCopyInto(out *ProjectStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PromQLClusterCondition ¶
type PromQLClusterCondition struct { // 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. // +required PromQL string `json:"promql"` }
PromQLClusterCondition represents a cluster condition based on PromQL.
func (*PromQLClusterCondition) DeepCopy ¶
func (in *PromQLClusterCondition) DeepCopy() *PromQLClusterCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PromQLClusterCondition.
func (*PromQLClusterCondition) DeepCopyInto ¶
func (in *PromQLClusterCondition) DeepCopyInto(out *PromQLClusterCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PromQLClusterCondition) SwaggerDoc ¶
func (PromQLClusterCondition) SwaggerDoc() map[string]string
type Proxy ¶
type Proxy struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user-settable values for the proxy configuration // +required Spec ProxySpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status ProxyStatus `json:"status"` }
Proxy holds cluster-wide information on how to configure default proxies for the cluster. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_03,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=proxies,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Proxy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Proxy.
func (*Proxy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Proxy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Proxy) SwaggerDoc ¶
type ProxyList ¶
type ProxyList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Proxy `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*ProxyList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProxyList.
func (*ProxyList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProxyList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ProxyList) SwaggerDoc ¶
type ProxySpec ¶
type ProxySpec struct { // httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var. // +optional HTTPProxy string `json:"httpProxy,omitempty"` // httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var. // +optional HTTPSProxy string `json:"httpsProxy,omitempty"` // 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. // +optional NoProxy string `json:"noProxy,omitempty"` // readinessEndpoints is a list of endpoints used to verify readiness of the proxy. // +optional ReadinessEndpoints []string `json:"readinessEndpoints,omitempty"` // 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. // // The namespace for the ConfigMap referenced by trustedCA is // "openshift-config". Here is an example ConfigMap (in yaml): // // apiVersion: v1 // kind: ConfigMap // metadata: // name: user-ca-bundle // namespace: openshift-config // data: // ca-bundle.crt: | // -----BEGIN CERTIFICATE----- // Custom CA certificate bundle. // -----END CERTIFICATE----- // // +optional TrustedCA ConfigMapNameReference `json:"trustedCA,omitempty"` }
ProxySpec contains cluster proxy creation configuration.
func (*ProxySpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProxySpec.
func (*ProxySpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ProxySpec) SwaggerDoc ¶
type ProxyStatus ¶
type ProxyStatus struct { // httpProxy is the URL of the proxy for HTTP requests. // +optional HTTPProxy string `json:"httpProxy,omitempty"` // httpsProxy is the URL of the proxy for HTTPS requests. // +optional HTTPSProxy string `json:"httpsProxy,omitempty"` // noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. // +optional NoProxy string `json:"noProxy,omitempty"` }
ProxyStatus shows current known state of the cluster proxy.
func (*ProxyStatus) DeepCopy ¶
func (in *ProxyStatus) DeepCopy() *ProxyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProxyStatus.
func (*ProxyStatus) DeepCopyInto ¶
func (in *ProxyStatus) DeepCopyInto(out *ProxyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ProxyStatus) SwaggerDoc ¶
func (ProxyStatus) SwaggerDoc() map[string]string
type RegistryLocation ¶
type RegistryLocation struct { // 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. DomainName string `json:"domainName"` // insecure indicates whether the registry is secure (https) or insecure (http) // By default (if not specified) the registry is assumed as secure. // +optional Insecure bool `json:"insecure,omitempty"` }
RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.
func (*RegistryLocation) DeepCopy ¶
func (in *RegistryLocation) DeepCopy() *RegistryLocation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegistryLocation.
func (*RegistryLocation) DeepCopyInto ¶
func (in *RegistryLocation) DeepCopyInto(out *RegistryLocation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RegistryLocation) SwaggerDoc ¶
func (RegistryLocation) SwaggerDoc() map[string]string
type RegistrySources ¶
type RegistrySources struct { // insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections. // +optional // +listType=atomic InsecureRegistries []string `json:"insecureRegistries,omitempty"` // blockedRegistries cannot be used for image pull and push actions. All other registries are permitted. // // Only one of BlockedRegistries or AllowedRegistries may be set. // +optional // +listType=atomic BlockedRegistries []string `json:"blockedRegistries,omitempty"` // allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied. // // Only one of BlockedRegistries or AllowedRegistries may be set. // +optional // +listType=atomic AllowedRegistries []string `json:"allowedRegistries,omitempty"` // 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. // +optional // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:Format=hostname // +listType=set ContainerRuntimeSearchRegistries []string `json:"containerRuntimeSearchRegistries,omitempty"` }
RegistrySources holds cluster-wide information about how to handle the registries config.
func (*RegistrySources) DeepCopy ¶
func (in *RegistrySources) DeepCopy() *RegistrySources
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegistrySources.
func (*RegistrySources) DeepCopyInto ¶
func (in *RegistrySources) DeepCopyInto(out *RegistrySources)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RegistrySources) SwaggerDoc ¶
func (RegistrySources) SwaggerDoc() map[string]string
type Release ¶
type Release struct { // architecture is an optional field that indicates the // value of the cluster architecture. In this context cluster // architecture means either a single architecture or a multi // architecture. // Valid values are 'Multi' and empty. // // +openshift:enable:FeatureGate=ImageStreamImportMode // +optional Architecture ClusterVersionArchitecture `json:"architecture,omitempty"` // version is a semantic version identifying the update version. When this // field is part of spec, version is optional if image is specified. // +required Version string `json:"version"` // 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. // +required Image string `json:"image"` // 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. // +optional URL URL `json:"url,omitempty"` // channels is the set of Cincinnati channels to which the release // currently belongs. // +listType=set // +optional Channels []string `json:"channels,omitempty"` }
Release represents an OpenShift release image and associated metadata. +k8s:deepcopy-gen=true
func (*Release) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Release.
func (*Release) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Release) SwaggerDoc ¶
type RemoteConnectionInfo ¶
type RemoteConnectionInfo struct { // url is the remote URL to connect to URL string `json:"url"` // ca is the CA for verifying TLS connections CA string `json:"ca"` // CertInfo is the TLS client cert information to present // this is anonymous so that we can inline it for serialization CertInfo `json:",inline"` }
RemoteConnectionInfo holds information necessary for establishing a remote connection
func (*RemoteConnectionInfo) DeepCopy ¶
func (in *RemoteConnectionInfo) DeepCopy() *RemoteConnectionInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RemoteConnectionInfo.
func (*RemoteConnectionInfo) DeepCopyInto ¶
func (in *RemoteConnectionInfo) DeepCopyInto(out *RemoteConnectionInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RemoteConnectionInfo) SwaggerDoc ¶
func (RemoteConnectionInfo) SwaggerDoc() map[string]string
type RepositoryDigestMirrors ¶
type RepositoryDigestMirrors struct { // source is the repository that users refer to, e.g. in image pull specifications. // +required // +kubebuilder:validation:Pattern=`^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])(:[0-9]+)?(\/[^\/:\n]+)*(\/[^\/:\n]+((:[^\/:\n]+)|(@[^\n]+)))?$` Source string `json:"source"` // 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. // +optional AllowMirrorByTags bool `json:"allowMirrorByTags,omitempty"` // 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. // +optional // +listType=set Mirrors []Mirror `json:"mirrors,omitempty"` }
RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.
func (*RepositoryDigestMirrors) DeepCopy ¶
func (in *RepositoryDigestMirrors) DeepCopy() *RepositoryDigestMirrors
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryDigestMirrors.
func (*RepositoryDigestMirrors) DeepCopyInto ¶
func (in *RepositoryDigestMirrors) DeepCopyInto(out *RepositoryDigestMirrors)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RepositoryDigestMirrors) SwaggerDoc ¶
func (RepositoryDigestMirrors) SwaggerDoc() map[string]string
type RequestHeaderIdentityProvider ¶
type RequestHeaderIdentityProvider struct { // 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 // https://www.example.com/sso-login?then=${url} // ${query} is replaced with the current query string // https://www.example.com/auth-proxy/oauth/authorize?${query} // Required when login is set to true. LoginURL string `json:"loginURL"` // 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 // https://www.example.com/sso-login?then=${url} // ${query} is replaced with the current query string // https://www.example.com/auth-proxy/oauth/authorize?${query} // Required when challenge is set to true. ChallengeURL string `json:"challengeURL"` // 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. ClientCA ConfigMapNameReference `json:"ca"` // 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. // +optional ClientCommonNames []string `json:"clientCommonNames,omitempty"` // headers is the set of headers to check for identity information Headers []string `json:"headers"` // preferredUsernameHeaders is the set of headers to check for the preferred username PreferredUsernameHeaders []string `json:"preferredUsernameHeaders"` // nameHeaders is the set of headers to check for the display name NameHeaders []string `json:"nameHeaders"` // emailHeaders is the set of headers to check for the email address EmailHeaders []string `json:"emailHeaders"` }
RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials
func (*RequestHeaderIdentityProvider) DeepCopy ¶
func (in *RequestHeaderIdentityProvider) DeepCopy() *RequestHeaderIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestHeaderIdentityProvider.
func (*RequestHeaderIdentityProvider) DeepCopyInto ¶
func (in *RequestHeaderIdentityProvider) DeepCopyInto(out *RequestHeaderIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RequestHeaderIdentityProvider) SwaggerDoc ¶
func (RequestHeaderIdentityProvider) SwaggerDoc() map[string]string
type RequiredHSTSPolicy ¶
type RequiredHSTSPolicy struct { // 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. // +optional NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"` // 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. // // The 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*. // +kubebuilder:validation:MinItems=1 // +required DomainPatterns []string `json:"domainPatterns"` // 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. MaxAge MaxAgePolicy `json:"maxAge"` // 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). // +optional PreloadPolicy PreloadPolicy `json:"preloadPolicy,omitempty"` // 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 // +optional IncludeSubDomainsPolicy IncludeSubDomainsPolicy `json:"includeSubDomainsPolicy,omitempty"` }
func (*RequiredHSTSPolicy) DeepCopy ¶
func (in *RequiredHSTSPolicy) DeepCopy() *RequiredHSTSPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequiredHSTSPolicy.
func (*RequiredHSTSPolicy) DeepCopyInto ¶
func (in *RequiredHSTSPolicy) DeepCopyInto(out *RequiredHSTSPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RequiredHSTSPolicy) SwaggerDoc ¶
func (RequiredHSTSPolicy) SwaggerDoc() map[string]string
type Scheduler ¶
type Scheduler struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration // +required Spec SchedulerSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status SchedulerStatus `json:"status"` }
Scheduler holds cluster-wide config information to run the Kubernetes Scheduler and influence its placement decisions. The canonical name for this config is `cluster`.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1 +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/470 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=config-operator,operatorOrdering=01 +kubebuilder:object:root=true +kubebuilder:resource:path=schedulers,scope=Cluster +kubebuilder:subresource:status +kubebuilder:metadata:annotations=release.openshift.io/bootstrap-required=true
func (*Scheduler) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Scheduler.
func (*Scheduler) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Scheduler) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Scheduler) SwaggerDoc ¶
type SchedulerList ¶
type SchedulerList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` Items []Scheduler `json:"items"` }
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1
func (*SchedulerList) DeepCopy ¶
func (in *SchedulerList) DeepCopy() *SchedulerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchedulerList.
func (*SchedulerList) DeepCopyInto ¶
func (in *SchedulerList) DeepCopyInto(out *SchedulerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SchedulerList) DeepCopyObject ¶
func (in *SchedulerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (SchedulerList) SwaggerDoc ¶
func (SchedulerList) SwaggerDoc() map[string]string
type SchedulerProfile ¶
type SchedulerProfile string
+kubebuilder:validation:Enum="";LowNodeUtilization;HighNodeUtilization;NoScoring
var ( // LowNodeUtililization is the default, and defines a scheduling profile which prefers to // spread pods evenly among nodes targeting low resource consumption on each node. LowNodeUtilization SchedulerProfile = "LowNodeUtilization" // HighNodeUtilization defines a scheduling profile which packs as many pods as possible onto // as few nodes as possible targeting a small node count but high resource usage on each node. HighNodeUtilization SchedulerProfile = "HighNodeUtilization" // NoScoring defines a scheduling profile which tries to provide lower-latency scheduling // at the expense of potentially less optimal pod placement decisions. NoScoring SchedulerProfile = "NoScoring" )
type SchedulerSpec ¶
type SchedulerSpec struct { // 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. // +optional Policy ConfigMapNameReference `json:"policy,omitempty"` // profile sets which scheduling profile should be set in order to configure scheduling // decisions for new pods. // // Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring" // Defaults to "LowNodeUtilization" // +optional Profile SchedulerProfile `json:"profile,omitempty"` // profileCustomizations contains configuration for modifying the default behavior of existing scheduler profiles. // +openshift:enable:FeatureGate=DynamicResourceAllocation // +optional ProfileCustomizations ProfileCustomizations `json:"profileCustomizations"` // 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. // +optional DefaultNodeSelector string `json:"defaultNodeSelector,omitempty"` // 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. // +optional MastersSchedulable bool `json:"mastersSchedulable"` }
func (*SchedulerSpec) DeepCopy ¶
func (in *SchedulerSpec) DeepCopy() *SchedulerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchedulerSpec.
func (*SchedulerSpec) DeepCopyInto ¶
func (in *SchedulerSpec) DeepCopyInto(out *SchedulerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (SchedulerSpec) SwaggerDoc ¶
func (SchedulerSpec) SwaggerDoc() map[string]string
type SchedulerStatus ¶
type SchedulerStatus struct { }
func (*SchedulerStatus) DeepCopy ¶
func (in *SchedulerStatus) DeepCopy() *SchedulerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchedulerStatus.
func (*SchedulerStatus) DeepCopyInto ¶
func (in *SchedulerStatus) DeepCopyInto(out *SchedulerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretNameReference ¶
type SecretNameReference struct { // name is the metadata.name of the referenced secret // +required Name string `json:"name"` }
SecretNameReference references a secret in a specific namespace. The namespace must be specified at the point of use.
func (*SecretNameReference) DeepCopy ¶
func (in *SecretNameReference) DeepCopy() *SecretNameReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretNameReference.
func (*SecretNameReference) DeepCopyInto ¶
func (in *SecretNameReference) DeepCopyInto(out *SecretNameReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (SecretNameReference) SwaggerDoc ¶
func (SecretNameReference) SwaggerDoc() map[string]string
type ServingInfo ¶
type ServingInfo struct { // bindAddress is the ip:port to serve on BindAddress string `json:"bindAddress"` // bindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", // "tcp4", and "tcp6" BindNetwork string `json:"bindNetwork"` // CertInfo is the TLS cert info for serving secure traffic. // this is anonymous so that we can inline it for serialization CertInfo `json:",inline"` // clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates // +optional ClientCA string `json:"clientCA,omitempty"` // namedCertificates is a list of certificates to use to secure requests to specific hostnames NamedCertificates []NamedCertificate `json:"namedCertificates,omitempty"` // minTLSVersion is the minimum TLS version supported. // Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants MinTLSVersion string `json:"minTLSVersion,omitempty"` // 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 CipherSuites []string `json:"cipherSuites,omitempty"` }
ServingInfo holds information about serving web pages
func (*ServingInfo) DeepCopy ¶
func (in *ServingInfo) DeepCopy() *ServingInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServingInfo.
func (*ServingInfo) DeepCopyInto ¶
func (in *ServingInfo) DeepCopyInto(out *ServingInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ServingInfo) SwaggerDoc ¶
func (ServingInfo) SwaggerDoc() map[string]string
type SignatureStore ¶
type SignatureStore struct { // url contains the upstream custom signature store URL. // url should be a valid absolute http/https URI of an upstream signature store as per rfc1738. // This must be provided and cannot be empty. // // +kubebuilder:validation:Type=string // +kubebuilder:validation:XValidation:rule="isURL(self)",message="url must be a valid absolute URL" // +required URL string `json:"url"` // 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 signature store is not honored. // If the specified ca data is not valid, the signature store is not honored. // If empty, we fall back to the CA configured via Proxy, which is appended to the default system roots. // The namespace for this config map is openshift-config. // +optional CA ConfigMapNameReference `json:"ca"` }
SignatureStore represents the URL of custom Signature Store
func (*SignatureStore) DeepCopy ¶
func (in *SignatureStore) DeepCopy() *SignatureStore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SignatureStore.
func (*SignatureStore) DeepCopyInto ¶
func (in *SignatureStore) DeepCopyInto(out *SignatureStore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (SignatureStore) SwaggerDoc ¶
func (SignatureStore) SwaggerDoc() map[string]string
type StringSource ¶
type StringSource struct { // StringSourceSpec specifies the string value, or external location StringSourceSpec `json:",inline"` }
StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.
func (*StringSource) DeepCopy ¶
func (in *StringSource) DeepCopy() *StringSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StringSource.
func (*StringSource) DeepCopyInto ¶
func (in *StringSource) DeepCopyInto(out *StringSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StringSource) MarshalJSON ¶
func (s *StringSource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface. If the StringSource contains only a string Value (or is empty), it is marshaled as a JSON string. Otherwise, the StringSourceSpec struct is marshaled as a JSON object.
func (StringSource) SwaggerDoc ¶
func (StringSource) SwaggerDoc() map[string]string
func (*StringSource) UnmarshalJSON ¶
func (s *StringSource) UnmarshalJSON(value []byte) error
UnmarshalJSON implements the json.Unmarshaller interface. If the value is a string, it sets the Value field of the StringSource. Otherwise, it is unmarshaled into the StringSourceSpec struct
type StringSourceSpec ¶
type StringSourceSpec struct { // value specifies the cleartext value, or an encrypted value if keyFile is specified. Value string `json:"value"` // env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified. Env string `json:"env"` // file references a file containing the cleartext value, or an encrypted value if a keyFile is specified. File string `json:"file"` // keyFile references a file containing the key to use to decrypt the value. KeyFile string `json:"keyFile"` }
StringSourceSpec specifies a string value, or external location
func (*StringSourceSpec) DeepCopy ¶
func (in *StringSourceSpec) DeepCopy() *StringSourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StringSourceSpec.
func (*StringSourceSpec) DeepCopyInto ¶
func (in *StringSourceSpec) DeepCopyInto(out *StringSourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (StringSourceSpec) SwaggerDoc ¶
func (StringSourceSpec) SwaggerDoc() map[string]string
type TLSProfileSpec ¶
type TLSProfileSpec struct { // 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): // // ciphers: // - DES-CBC3-SHA // // +listType=atomic Ciphers []string `json:"ciphers"` // 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): // // minTLSVersion: VersionTLS11 // // NOTE: currently the highest minTLSVersion allowed is VersionTLS12 // MinTLSVersion TLSProtocolVersion `json:"minTLSVersion"` }
TLSProfileSpec is the desired behavior of a TLSSecurityProfile.
func (*TLSProfileSpec) DeepCopy ¶
func (in *TLSProfileSpec) DeepCopy() *TLSProfileSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSProfileSpec.
func (*TLSProfileSpec) DeepCopyInto ¶
func (in *TLSProfileSpec) DeepCopyInto(out *TLSProfileSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TLSProfileSpec) SwaggerDoc ¶
func (TLSProfileSpec) SwaggerDoc() map[string]string
type TLSProfileType ¶
type TLSProfileType string
TLSProfileType defines a TLS security profile type. +kubebuilder:validation:Enum=Old;Intermediate;Modern;Custom
const ( // Old is a TLS security profile based on: // https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility TLSProfileOldType TLSProfileType = "Old" // Intermediate is a TLS security profile based on: // https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29 TLSProfileIntermediateType TLSProfileType = "Intermediate" // Modern is a TLS security profile based on: // https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility TLSProfileModernType TLSProfileType = "Modern" // Custom is a TLS security profile that allows for user-defined parameters. TLSProfileCustomType TLSProfileType = "Custom" )
type TLSProtocolVersion ¶
type TLSProtocolVersion string
TLSProtocolVersion is a way to specify the protocol version used for TLS connections. Protocol versions are based on the following most common TLS configurations:
https://ssl-config.mozilla.org/
Note that SSLv3.0 is not a supported protocol version due to well known vulnerabilities such as POODLE: https://en.wikipedia.org/wiki/POODLE +kubebuilder:validation:Enum=VersionTLS10;VersionTLS11;VersionTLS12;VersionTLS13
const ( // VersionTLSv10 is version 1.0 of the TLS security protocol. VersionTLS10 TLSProtocolVersion = "VersionTLS10" // VersionTLSv11 is version 1.1 of the TLS security protocol. VersionTLS11 TLSProtocolVersion = "VersionTLS11" // VersionTLSv12 is version 1.2 of the TLS security protocol. VersionTLS12 TLSProtocolVersion = "VersionTLS12" // VersionTLSv13 is version 1.3 of the TLS security protocol. VersionTLS13 TLSProtocolVersion = "VersionTLS13" )
type TLSSecurityProfile ¶
type TLSSecurityProfile struct { // 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: // // https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations // // The 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. // // Note that the Modern profile is currently not supported because it is not // yet well adopted by common software libraries. // // +unionDiscriminator // +optional Type TLSProfileType `json:"type"` // old is a TLS security profile based on: // // https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility // // and looks like this (yaml): // // ciphers: // // - TLS_AES_128_GCM_SHA256 // // - TLS_AES_256_GCM_SHA384 // // - TLS_CHACHA20_POLY1305_SHA256 // // - ECDHE-ECDSA-AES128-GCM-SHA256 // // - ECDHE-RSA-AES128-GCM-SHA256 // // - ECDHE-ECDSA-AES256-GCM-SHA384 // // - ECDHE-RSA-AES256-GCM-SHA384 // // - ECDHE-ECDSA-CHACHA20-POLY1305 // // - ECDHE-RSA-CHACHA20-POLY1305 // // - DHE-RSA-AES128-GCM-SHA256 // // - DHE-RSA-AES256-GCM-SHA384 // // - DHE-RSA-CHACHA20-POLY1305 // // - ECDHE-ECDSA-AES128-SHA256 // // - ECDHE-RSA-AES128-SHA256 // // - ECDHE-ECDSA-AES128-SHA // // - ECDHE-RSA-AES128-SHA // // - ECDHE-ECDSA-AES256-SHA384 // // - ECDHE-RSA-AES256-SHA384 // // - ECDHE-ECDSA-AES256-SHA // // - ECDHE-RSA-AES256-SHA // // - DHE-RSA-AES128-SHA256 // // - DHE-RSA-AES256-SHA256 // // - AES128-GCM-SHA256 // // - AES256-GCM-SHA384 // // - AES128-SHA256 // // - AES256-SHA256 // // - AES128-SHA // // - AES256-SHA // // - DES-CBC3-SHA // // minTLSVersion: VersionTLS10 // // +optional // +nullable Old *OldTLSProfile `json:"old,omitempty"` // intermediate is a TLS security profile based on: // // https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 // // and looks like this (yaml): // // ciphers: // // - TLS_AES_128_GCM_SHA256 // // - TLS_AES_256_GCM_SHA384 // // - TLS_CHACHA20_POLY1305_SHA256 // // - ECDHE-ECDSA-AES128-GCM-SHA256 // // - ECDHE-RSA-AES128-GCM-SHA256 // // - ECDHE-ECDSA-AES256-GCM-SHA384 // // - ECDHE-RSA-AES256-GCM-SHA384 // // - ECDHE-ECDSA-CHACHA20-POLY1305 // // - ECDHE-RSA-CHACHA20-POLY1305 // // - DHE-RSA-AES128-GCM-SHA256 // // - DHE-RSA-AES256-GCM-SHA384 // // minTLSVersion: VersionTLS12 // // +optional // +nullable Intermediate *IntermediateTLSProfile `json:"intermediate,omitempty"` // modern is a TLS security profile based on: // // https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility // // and looks like this (yaml): // // ciphers: // // - TLS_AES_128_GCM_SHA256 // // - TLS_AES_256_GCM_SHA384 // // - TLS_CHACHA20_POLY1305_SHA256 // // minTLSVersion: VersionTLS13 // // +optional // +nullable Modern *ModernTLSProfile `json:"modern,omitempty"` // 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: // // ciphers: // // - ECDHE-ECDSA-CHACHA20-POLY1305 // // - ECDHE-RSA-CHACHA20-POLY1305 // // - ECDHE-RSA-AES128-GCM-SHA256 // // - ECDHE-ECDSA-AES128-GCM-SHA256 // // minTLSVersion: VersionTLS11 // // +optional // +nullable Custom *CustomTLSProfile `json:"custom,omitempty"` }
TLSSecurityProfile defines the schema for a TLS security profile. This object is used by operators to apply TLS security settings to operands. +union
func (*TLSSecurityProfile) DeepCopy ¶
func (in *TLSSecurityProfile) DeepCopy() *TLSSecurityProfile
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSSecurityProfile.
func (*TLSSecurityProfile) DeepCopyInto ¶
func (in *TLSSecurityProfile) DeepCopyInto(out *TLSSecurityProfile)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TLSSecurityProfile) SwaggerDoc ¶
func (TLSSecurityProfile) SwaggerDoc() map[string]string
type TemplateReference ¶
type TemplateReference struct { // name is the metadata.name of the referenced project request template Name string `json:"name"` }
TemplateReference references a template in a specific namespace. The namespace must be specified at the point of use.
func (*TemplateReference) DeepCopy ¶
func (in *TemplateReference) DeepCopy() *TemplateReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateReference.
func (*TemplateReference) DeepCopyInto ¶
func (in *TemplateReference) DeepCopyInto(out *TemplateReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TemplateReference) SwaggerDoc ¶
func (TemplateReference) SwaggerDoc() map[string]string
type TestDetails ¶
type TestDetails struct { // testName is the name of the test as it appears in junit XMLs. // It does not include the suite name since the same test can be executed in many suites. TestName string `json:"testName"` }
func (*TestDetails) DeepCopy ¶
func (in *TestDetails) DeepCopy() *TestDetails
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestDetails.
func (*TestDetails) DeepCopyInto ¶
func (in *TestDetails) DeepCopyInto(out *TestDetails)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TestDetails) SwaggerDoc ¶
func (TestDetails) SwaggerDoc() map[string]string
type TestReporting ¶
type TestReporting struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // +required Spec TestReportingSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional Status TestReportingStatus `json:"status"` }
TestReporting is used for origin (and potentially others) to report the test names for a given FeatureGate into the payload for later analysis on a per-payload basis. This doesn't need any CRD because it's never stored in the cluster.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:internal
func (*TestReporting) DeepCopy ¶
func (in *TestReporting) DeepCopy() *TestReporting
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestReporting.
func (*TestReporting) DeepCopyInto ¶
func (in *TestReporting) DeepCopyInto(out *TestReporting)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TestReporting) SwaggerDoc ¶
func (TestReporting) SwaggerDoc() map[string]string
type TestReportingSpec ¶
type TestReportingSpec struct { // testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing. TestsForFeatureGates []FeatureGateTests `json:"testsForFeatureGates"` }
func (*TestReportingSpec) DeepCopy ¶
func (in *TestReportingSpec) DeepCopy() *TestReportingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestReportingSpec.
func (*TestReportingSpec) DeepCopyInto ¶
func (in *TestReportingSpec) DeepCopyInto(out *TestReportingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TestReportingSpec) SwaggerDoc ¶
func (TestReportingSpec) SwaggerDoc() map[string]string
type TestReportingStatus ¶
type TestReportingStatus struct { }
func (*TestReportingStatus) DeepCopy ¶
func (in *TestReportingStatus) DeepCopy() *TestReportingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestReportingStatus.
func (*TestReportingStatus) DeepCopyInto ¶
func (in *TestReportingStatus) DeepCopyInto(out *TestReportingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TokenClaimMapping ¶
type TokenClaimMapping struct { // claim is a JWT token claim to be used in the mapping // // +required Claim string `json:"claim"` }
func (*TokenClaimMapping) DeepCopy ¶
func (in *TokenClaimMapping) DeepCopy() *TokenClaimMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenClaimMapping.
func (*TokenClaimMapping) DeepCopyInto ¶
func (in *TokenClaimMapping) DeepCopyInto(out *TokenClaimMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenClaimMapping) SwaggerDoc ¶
func (TokenClaimMapping) SwaggerDoc() map[string]string
type TokenClaimMappings ¶
type TokenClaimMappings struct { // username is a name of the claim that should be used to construct // usernames for the cluster identity. // // Default value: "sub" Username UsernameClaimMapping `json:"username,omitempty"` // groups is a name of the claim that should be used to construct // groups for the cluster identity. // The referenced claim must use array of strings values. Groups PrefixedClaimMapping `json:"groups,omitempty"` }
func (*TokenClaimMappings) DeepCopy ¶
func (in *TokenClaimMappings) DeepCopy() *TokenClaimMappings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenClaimMappings.
func (*TokenClaimMappings) DeepCopyInto ¶
func (in *TokenClaimMappings) DeepCopyInto(out *TokenClaimMappings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenClaimMappings) SwaggerDoc ¶
func (TokenClaimMappings) SwaggerDoc() map[string]string
type TokenClaimValidationRule ¶
type TokenClaimValidationRule struct { // type sets the type of the validation rule // // +kubebuilder:validation:Enum={"RequiredClaim"} // +kubebuilder:default="RequiredClaim" Type TokenValidationRuleType `json:"type"` // requiredClaim allows configuring a required claim name and its expected // value RequiredClaim *TokenRequiredClaim `json:"requiredClaim"` }
func (*TokenClaimValidationRule) DeepCopy ¶
func (in *TokenClaimValidationRule) DeepCopy() *TokenClaimValidationRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenClaimValidationRule.
func (*TokenClaimValidationRule) DeepCopyInto ¶
func (in *TokenClaimValidationRule) DeepCopyInto(out *TokenClaimValidationRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenClaimValidationRule) SwaggerDoc ¶
func (TokenClaimValidationRule) SwaggerDoc() map[string]string
type TokenConfig ¶
type TokenConfig struct { // accessTokenMaxAgeSeconds defines the maximum age of access tokens AccessTokenMaxAgeSeconds int32 `json:"accessTokenMaxAgeSeconds,omitempty"` // accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect. // +optional AccessTokenInactivityTimeoutSeconds int32 `json:"accessTokenInactivityTimeoutSeconds,omitempty"` // 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. // // WARNING: existing tokens' timeout will not be affected (lowered) by changing this value // +optional AccessTokenInactivityTimeout *metav1.Duration `json:"accessTokenInactivityTimeout,omitempty"` }
TokenConfig holds the necessary configuration options for authorization and access tokens
func (*TokenConfig) DeepCopy ¶
func (in *TokenConfig) DeepCopy() *TokenConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenConfig.
func (*TokenConfig) DeepCopyInto ¶
func (in *TokenConfig) DeepCopyInto(out *TokenConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenConfig) SwaggerDoc ¶
func (TokenConfig) SwaggerDoc() map[string]string
type TokenIssuer ¶
type TokenIssuer struct { // URL is the serving URL of the token issuer. // Must use the https:// scheme. // // +kubebuilder:validation:Pattern=`^https:\/\/[^\s]` // +required URL string `json:"issuerURL"` // audiences is an array of audiences that the token was issued for. // Valid tokens must include at least one of these values in their // "aud" claim. // Must be set to exactly one value. // // +listType=set // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=10 // +required Audiences []TokenAudience `json:"audiences"` // CertificateAuthority is a reference to a config map in the // configuration namespace. The .data of the configMap must contain // the "ca-bundle.crt" key. // If unset, system trust is used instead. CertificateAuthority ConfigMapNameReference `json:"issuerCertificateAuthority"` }
func (*TokenIssuer) DeepCopy ¶
func (in *TokenIssuer) DeepCopy() *TokenIssuer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenIssuer.
func (*TokenIssuer) DeepCopyInto ¶
func (in *TokenIssuer) DeepCopyInto(out *TokenIssuer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenIssuer) SwaggerDoc ¶
func (TokenIssuer) SwaggerDoc() map[string]string
type TokenRequiredClaim ¶
type TokenRequiredClaim struct { // claim is a name of a required claim. Only claims with string values are // supported. // // +kubebuilder:validation:MinLength=1 // +required Claim string `json:"claim"` // requiredValue is the required value for the claim. // // +kubebuilder:validation:MinLength=1 // +required RequiredValue string `json:"requiredValue"` }
func (*TokenRequiredClaim) DeepCopy ¶
func (in *TokenRequiredClaim) DeepCopy() *TokenRequiredClaim
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenRequiredClaim.
func (*TokenRequiredClaim) DeepCopyInto ¶
func (in *TokenRequiredClaim) DeepCopyInto(out *TokenRequiredClaim)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TokenRequiredClaim) SwaggerDoc ¶
func (TokenRequiredClaim) SwaggerDoc() map[string]string
type TokenValidationRuleType ¶
type TokenValidationRuleType string
type TopologyMode ¶
type TopologyMode string
TopologyMode defines the topology mode of the control/infra nodes. NOTE: Enum validation is specified in each field that uses this type, given that External value is not applicable to the InfrastructureTopology field.
const ( // "HighlyAvailable" is for operators to configure high-availability as much as possible. HighlyAvailableTopologyMode TopologyMode = "HighlyAvailable" // "HighlyAvailableArbiter" is for operators to configure for an arbiter HA deployment. HighlyAvailableArbiterMode TopologyMode = "HighlyAvailableArbiter" // "SingleReplica" is for operators to avoid spending resources for high-availability purpose. SingleReplicaTopologyMode TopologyMode = "SingleReplica" // "External" indicates that the component is running externally to the cluster. When specified // as the control plane topology, operators should avoid scheduling workloads to masters or assume // that any of the control plane components such as kubernetes API server or etcd are visible within // the cluster. ExternalTopologyMode TopologyMode = "External" )
type URL ¶
type URL string
URL is a thin wrapper around string that ensures the string is a valid URL.
type Update ¶
type Update struct { // 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. // // +optional Architecture ClusterVersionArchitecture `json:"architecture"` // version is a semantic version identifying the update version. // version is ignored if image is specified and required if // architecture is specified. // // +optional Version string `json:"version"` // 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. // // +optional Image string `json:"image"` // 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. // // +optional Force bool `json:"force"` }
Update represents an administrator update request. +kubebuilder:validation:XValidation:rule="has(self.architecture) && has(self.image) ? (self.architecture == \"\" || self.image == \"\") : true",message="cannot set both Architecture and Image" +kubebuilder:validation:XValidation:rule="has(self.architecture) && self.architecture != \"\" ? self.version != \"\" : true",message="Version must be set if Architecture is set" +k8s:deepcopy-gen=true
func (*Update) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Update.
func (*Update) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Update) SwaggerDoc ¶
type UpdateHistory ¶
type UpdateHistory struct { // 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). // +required State UpdateState `json:"state"` // startedTime is the time at which the update was started. // +required StartedTime metav1.Time `json:"startedTime"` // 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). // +required // +nullable CompletionTime *metav1.Time `json:"completionTime"` // 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. // // +optional Version string `json:"version"` // image is a container image location that contains the update. This value // is always populated. // +required Image string `json:"image"` // 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. // +required Verified bool `json:"verified"` // 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. // +optional AcceptedRisks string `json:"acceptedRisks,omitempty"` }
UpdateHistory is a single attempted update to the cluster.
func (*UpdateHistory) DeepCopy ¶
func (in *UpdateHistory) DeepCopy() *UpdateHistory
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpdateHistory.
func (*UpdateHistory) DeepCopyInto ¶
func (in *UpdateHistory) DeepCopyInto(out *UpdateHistory)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (UpdateHistory) SwaggerDoc ¶
func (UpdateHistory) SwaggerDoc() map[string]string
type UpdateState ¶
type UpdateState string
UpdateState is a constant representing whether an update was successfully applied to the cluster or not.
const ( // CompletedUpdate indicates an update was successfully applied // to the cluster (all resource updates were successful). CompletedUpdate UpdateState = "Completed" // PartialUpdate indicates an update was never completely applied // or is currently being applied. PartialUpdate UpdateState = "Partial" )
type UsernameClaimMapping ¶
type UsernameClaimMapping struct { TokenClaimMapping `json:",inline"` // prefixPolicy specifies how a prefix should apply. // // By default, claims other than `email` will be prefixed with the issuer URL to // prevent naming clashes with other plugins. // // Set to "NoPrefix" to disable prefixing. // // Example: // (1) `prefix` is set to "myoidc:" and `claim` is set to "username". // If the JWT claim `username` contains value `userA`, the resulting // mapped value will be "myoidc:userA". // (2) `prefix` is set to "myoidc:" and `claim` is set to "email". If the // JWT `email` claim contains value "userA@myoidc.tld", the resulting // mapped value will be "myoidc:userA@myoidc.tld". // (3) `prefix` is unset, `issuerURL` is set to `https://myoidc.tld`, // the JWT claims include "username":"userA" and "email":"userA@myoidc.tld", // and `claim` is set to: // (a) "username": the mapped value will be "https://myoidc.tld#userA" // (b) "email": the mapped value will be "userA@myoidc.tld" // // +kubebuilder:validation:Enum={"", "NoPrefix", "Prefix"} PrefixPolicy UsernamePrefixPolicy `json:"prefixPolicy"` Prefix *UsernamePrefix `json:"prefix"` }
+kubebuilder:validation:XValidation:rule="has(self.prefixPolicy) && self.prefixPolicy == 'Prefix' ? (has(self.prefix) && size(self.prefix.prefixString) > 0) : !has(self.prefix)",message="prefix must be set if prefixPolicy is 'Prefix', but must remain unset otherwise"
func (*UsernameClaimMapping) DeepCopy ¶
func (in *UsernameClaimMapping) DeepCopy() *UsernameClaimMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UsernameClaimMapping.
func (*UsernameClaimMapping) DeepCopyInto ¶
func (in *UsernameClaimMapping) DeepCopyInto(out *UsernameClaimMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (UsernameClaimMapping) SwaggerDoc ¶
func (UsernameClaimMapping) SwaggerDoc() map[string]string
type UsernamePrefix ¶
type UsernamePrefix struct { // +kubebuilder:validation:MinLength=1 // +required PrefixString string `json:"prefixString"` }
func (*UsernamePrefix) DeepCopy ¶
func (in *UsernamePrefix) DeepCopy() *UsernamePrefix
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UsernamePrefix.
func (*UsernamePrefix) DeepCopyInto ¶
func (in *UsernamePrefix) DeepCopyInto(out *UsernamePrefix)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UsernamePrefixPolicy ¶
type UsernamePrefixPolicy string
var ( // NoOpinion let's the cluster assign prefixes. If the username claim is email, there is no prefix // If the username claim is anything else, it is prefixed by the issuerURL NoOpinion UsernamePrefixPolicy = "" // NoPrefix means the username claim value will not have any prefix NoPrefix UsernamePrefixPolicy = "NoPrefix" // Prefix means the prefix value must be specified. It cannot be empty Prefix UsernamePrefixPolicy = "Prefix" )
type VSphereFailureDomainHostGroup ¶
type VSphereFailureDomainHostGroup struct { // vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain. // vmGroup is limited to 80 characters. // This field is required when the VSphereFailureDomain ZoneType is HostGroup // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +required VMGroup string `json:"vmGroup"` // hostGroup is the name of the vm-host group of type host within vCenter for this failure domain. // hostGroup is limited to 80 characters. // This field is required when the VSphereFailureDomain ZoneType is HostGroup // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +required HostGroup string `json:"hostGroup"` // vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain. // vmHostRule is limited to 80 characters. // This field is required when the VSphereFailureDomain ZoneType is HostGroup // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +required VMHostRule string `json:"vmHostRule"` }
VSphereFailureDomainHostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.
func (*VSphereFailureDomainHostGroup) DeepCopy ¶
func (in *VSphereFailureDomainHostGroup) DeepCopy() *VSphereFailureDomainHostGroup
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSphereFailureDomainHostGroup.
func (*VSphereFailureDomainHostGroup) DeepCopyInto ¶
func (in *VSphereFailureDomainHostGroup) DeepCopyInto(out *VSphereFailureDomainHostGroup)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSphereFailureDomainHostGroup) SwaggerDoc ¶
func (VSphereFailureDomainHostGroup) SwaggerDoc() map[string]string
type VSphereFailureDomainRegionAffinity ¶
type VSphereFailureDomainRegionAffinity struct { // type determines the vSphere object type for a region within this failure domain. // Available types are Datacenter and ComputeCluster. // When set to Datacenter, this means the vCenter Datacenter defined is the region. // When set to ComputeCluster, this means the vCenter cluster defined is the region. // +kubebuilder:validation:Enum:=ComputeCluster;Datacenter // +required // +unionDiscriminator Type VSphereFailureDomainRegionType `json:"type"` }
VSphereFailureDomainRegionAffinity contains the region type which is the string representation of the VSphereFailureDomainRegionType with available options of Datacenter and ComputeCluster. +union
func (*VSphereFailureDomainRegionAffinity) DeepCopy ¶
func (in *VSphereFailureDomainRegionAffinity) DeepCopy() *VSphereFailureDomainRegionAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSphereFailureDomainRegionAffinity.
func (*VSphereFailureDomainRegionAffinity) DeepCopyInto ¶
func (in *VSphereFailureDomainRegionAffinity) DeepCopyInto(out *VSphereFailureDomainRegionAffinity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSphereFailureDomainRegionAffinity) SwaggerDoc ¶
func (VSphereFailureDomainRegionAffinity) SwaggerDoc() map[string]string
type VSphereFailureDomainRegionType ¶
type VSphereFailureDomainRegionType string
The VSphereFailureDomainRegionType is a string representation of a failure domain region type. There are two supportable types ComputeCluster and Datacenter +enum
type VSphereFailureDomainZoneAffinity ¶
type VSphereFailureDomainZoneAffinity struct { // type determines the vSphere object type for a zone within this failure domain. // Available types are ComputeCluster and HostGroup. // When set to ComputeCluster, this means the vCenter cluster defined is the zone. // When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and // this means the zone is defined by the grouping of those fields. // +kubebuilder:validation:Enum:=HostGroup;ComputeCluster // +required // +unionDiscriminator Type VSphereFailureDomainZoneType `json:"type"` // hostGroup holds the vmGroup and the hostGroup names in vCenter // corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also // contains the vmHostRule which is an affinity vm-host rule in vCenter. // +unionMember // +optional HostGroup *VSphereFailureDomainHostGroup `json:"hostGroup,omitempty"` }
VSphereFailureDomainZoneAffinity contains the vCenter cluster vm-host group (virtual machine and host types) and the vm-host affinity rule that together creates an affinity configuration for vm-host based zonal. This configuration within vCenter creates the required association between a failure domain, virtual machines and ESXi hosts to create a vm-host based zone. +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'HostGroup' ? has(self.hostGroup) : !has(self.hostGroup)",message="hostGroup is required when type is HostGroup, and forbidden otherwise" +union
func (*VSphereFailureDomainZoneAffinity) DeepCopy ¶
func (in *VSphereFailureDomainZoneAffinity) DeepCopy() *VSphereFailureDomainZoneAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSphereFailureDomainZoneAffinity.
func (*VSphereFailureDomainZoneAffinity) DeepCopyInto ¶
func (in *VSphereFailureDomainZoneAffinity) DeepCopyInto(out *VSphereFailureDomainZoneAffinity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSphereFailureDomainZoneAffinity) SwaggerDoc ¶
func (VSphereFailureDomainZoneAffinity) SwaggerDoc() map[string]string
type VSphereFailureDomainZoneType ¶
type VSphereFailureDomainZoneType string
The VSphereFailureDomainZoneType is a string representation of a failure domain zone type. There are two supportable types HostGroup and ComputeCluster +enum
type VSpherePlatformFailureDomainSpec ¶
type VSpherePlatformFailureDomainSpec struct { // name defines the arbitrary but unique name // of a failure domain. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 Name string `json:"name"` // 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. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +required Region string `json:"region"` // 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. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +required Zone string `json:"zone"` // regionAffinity holds the type of region, Datacenter or ComputeCluster. // When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology. // When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology. // +openshift:validation:featureGate=VSphereHostVMGroupZonal // +optional RegionAffinity *VSphereFailureDomainRegionAffinity `json:"regionAffinity,omitempty"` // zoneAffinity holds the type of the zone and the hostGroup which // vmGroup and the hostGroup names in vCenter corresponds to // a vm-host group of type Virtual Machine and Host respectively. Is also // contains the vmHostRule which is an affinity vm-host rule in vCenter. // +openshift:validation:featureGate=VSphereHostVMGroupZonal // +optional ZoneAffinity *VSphereFailureDomainZoneAffinity `json:"zoneAffinity,omitempty"` // server is the fully-qualified domain name or the IP address of the vCenter server. // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 // --- // + Validation is applied via a patch, we validate the format as either ipv4, ipv6 or hostname Server string `json:"server"` // topology describes a given failure domain using vSphere constructs // +required Topology VSpherePlatformTopology `json:"topology"` }
VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain. +openshift:validation:FeatureGateAwareXValidation:featureGate=VSphereHostVMGroupZonal,rule="has(self.zoneAffinity) && self.zoneAffinity.type == 'HostGroup' ? has(self.regionAffinity) && self.regionAffinity.type == 'ComputeCluster' : true",message="when zoneAffinity type is HostGroup, regionAffinity type must be ComputeCluster" +openshift:validation:FeatureGateAwareXValidation:featureGate=VSphereHostVMGroupZonal,rule="has(self.zoneAffinity) && self.zoneAffinity.type == 'ComputeCluster' ? has(self.regionAffinity) && self.regionAffinity.type == 'Datacenter' : true",message="when zoneAffinity type is ComputeCluster, regionAffinity type must be Datacenter"
func (*VSpherePlatformFailureDomainSpec) DeepCopy ¶
func (in *VSpherePlatformFailureDomainSpec) DeepCopy() *VSpherePlatformFailureDomainSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformFailureDomainSpec.
func (*VSpherePlatformFailureDomainSpec) DeepCopyInto ¶
func (in *VSpherePlatformFailureDomainSpec) DeepCopyInto(out *VSpherePlatformFailureDomainSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformFailureDomainSpec) SwaggerDoc ¶
func (VSpherePlatformFailureDomainSpec) SwaggerDoc() map[string]string
type VSpherePlatformLoadBalancer ¶
type VSpherePlatformLoadBalancer struct { // 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. // +default="OpenShiftManagedDefault" // +kubebuilder:default:="OpenShiftManagedDefault" // +kubebuilder:validation:Enum:="OpenShiftManagedDefault";"UserManaged" // +kubebuilder:validation:XValidation:rule="oldSelf == ” || self == oldSelf",message="type is immutable once set" // +optional // +unionDiscriminator Type PlatformLoadBalancerType `json:"type,omitempty"` }
VSpherePlatformLoadBalancer defines the load balancer used by the cluster on VSphere platform. +union
func (*VSpherePlatformLoadBalancer) DeepCopy ¶
func (in *VSpherePlatformLoadBalancer) DeepCopy() *VSpherePlatformLoadBalancer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformLoadBalancer.
func (*VSpherePlatformLoadBalancer) DeepCopyInto ¶
func (in *VSpherePlatformLoadBalancer) DeepCopyInto(out *VSpherePlatformLoadBalancer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformLoadBalancer) SwaggerDoc ¶
func (VSpherePlatformLoadBalancer) SwaggerDoc() map[string]string
type VSpherePlatformNodeNetworking ¶
type VSpherePlatformNodeNetworking struct { // external represents the network configuration of the node that is externally routable. // +optional External VSpherePlatformNodeNetworkingSpec `json:"external"` // internal represents the network configuration of the node that is routable only within the cluster. // +optional Internal VSpherePlatformNodeNetworkingSpec `json:"internal"` }
VSpherePlatformNodeNetworking holds the external and internal node networking spec.
func (*VSpherePlatformNodeNetworking) DeepCopy ¶
func (in *VSpherePlatformNodeNetworking) DeepCopy() *VSpherePlatformNodeNetworking
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformNodeNetworking.
func (*VSpherePlatformNodeNetworking) DeepCopyInto ¶
func (in *VSpherePlatformNodeNetworking) DeepCopyInto(out *VSpherePlatformNodeNetworking)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformNodeNetworking) SwaggerDoc ¶
func (VSpherePlatformNodeNetworking) SwaggerDoc() map[string]string
type VSpherePlatformNodeNetworkingSpec ¶
type VSpherePlatformNodeNetworkingSpec struct { // networkSubnetCidr IP address on VirtualMachine's network interfaces included in the fields' CIDRs // that will be used in respective status.addresses fields. // --- // + Validation is applied via a patch, we validate the format as cidr // +listType=set // +optional NetworkSubnetCIDR []string `json:"networkSubnetCidr,omitempty"` // 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/*'` // +optional Network string `json:"network,omitempty"` // 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. // --- // + Validation is applied via a patch, we validate the format as cidr // +listType=atomic // +optional ExcludeNetworkSubnetCIDR []string `json:"excludeNetworkSubnetCidr,omitempty"` }
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.
func (*VSpherePlatformNodeNetworkingSpec) DeepCopy ¶
func (in *VSpherePlatformNodeNetworkingSpec) DeepCopy() *VSpherePlatformNodeNetworkingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformNodeNetworkingSpec.
func (*VSpherePlatformNodeNetworkingSpec) DeepCopyInto ¶
func (in *VSpherePlatformNodeNetworkingSpec) DeepCopyInto(out *VSpherePlatformNodeNetworkingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformNodeNetworkingSpec) SwaggerDoc ¶
func (VSpherePlatformNodeNetworkingSpec) SwaggerDoc() map[string]string
type VSpherePlatformSpec ¶
type VSpherePlatformSpec struct { // vcenters holds the connection details for services to communicate with vCenter. // Currently, only a single vCenter is supported, but in tech preview 3 vCenters are supported. // Once the cluster has been installed, you are unable to change the current number of defined // vCenters except in the case where the cluster has been upgraded from a version of OpenShift // where the vsphere platform spec was not present. You may make modifications to the existing // vCenters that are defined in the vcenters list in order to match with any added or modified // failure domains. // --- // + If VCenters is not defined use the existing cloud-config configmap defined // + in openshift-config. // +kubebuilder:validation:MinItems=0 // +openshift:validation:FeatureGateAwareMaxItems:featureGate="",maxItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate=VSphereMultiVCenters,maxItems=3 // +kubebuilder:validation:XValidation:rule="size(self) != size(oldSelf) ? size(oldSelf) == 0 && size(self) < 2 : true",message="vcenters cannot be added or removed once set" // +listType=atomic // +optional VCenters []VSpherePlatformVCenterSpec `json:"vcenters,omitempty"` // failureDomains contains the definition of region, zone and the vCenter topology. // If this is omitted failure domains (regions and zones) will not be used. // +listType=map // +listMapKey=name // +optional FailureDomains []VSpherePlatformFailureDomainSpec `json:"failureDomains,omitempty"` // 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. // +optional NodeNetworking VSpherePlatformNodeNetworking `json:"nodeNetworking,omitempty"` // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.apiServerInternalIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional APIServerInternalIPs []IP `json:"apiServerInternalIPs"` // 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 IP addresses, one from IPv4 // family and one from IPv6. // In single stack clusters a single IP address is expected. // When omitted, values from the status.ingressIPs will be used. // Once set, the list cannot be completely removed (but its second entry can). // // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic // +optional IngressIPs []IP `json:"ingressIPs"` // machineNetworks are IP networks used to connect all the OpenShift cluster // nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, // for example "10.0.0.0/8" or "fd00::/8". // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
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. +kubebuilder:validation:XValidation:rule="!has(oldSelf.apiServerInternalIPs) || has(self.apiServerInternalIPs)",message="apiServerInternalIPs list is required once set" +kubebuilder:validation:XValidation:rule="!has(oldSelf.ingressIPs) || has(self.ingressIPs)",message="ingressIPs list is required once set" +kubebuilder:validation:XValidation:rule="!has(oldSelf.vcenters) && has(self.vcenters) ? size(self.vcenters) < 2 : true",message="vcenters can have at most 1 item when configured post-install"
func (*VSpherePlatformSpec) DeepCopy ¶
func (in *VSpherePlatformSpec) DeepCopy() *VSpherePlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformSpec.
func (*VSpherePlatformSpec) DeepCopyInto ¶
func (in *VSpherePlatformSpec) DeepCopyInto(out *VSpherePlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformSpec) SwaggerDoc ¶
func (VSpherePlatformSpec) SwaggerDoc() map[string]string
type VSpherePlatformStatus ¶
type VSpherePlatformStatus struct { // 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. // // Deprecated: Use APIServerInternalIPs instead. APIServerInternalIP string `json:"apiServerInternalIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="apiServerInternalIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic APIServerInternalIPs []string `json:"apiServerInternalIPs"` // 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. // // Deprecated: Use IngressIPs instead. IngressIP string `json:"ingressIP,omitempty"` // 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. // // +kubebuilder:validation:Format=ip // +kubebuilder:validation:MaxItems=2 // +kubebuilder:validation:XValidation:rule="self == oldSelf || (size(self) == 2 && isIP(self[0]) && isIP(self[1]) ? ip(self[0]).family() != ip(self[1]).family() : true)",message="ingressIPs must contain at most one IPv4 address and at most one IPv6 address" // +listType=atomic IngressIPs []string `json:"ingressIPs"` // 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. NodeDNSIP string `json:"nodeDNSIP,omitempty"` // loadBalancer defines how the load balancer used by the cluster is configured. // +default={"type": "OpenShiftManagedDefault"} // +kubebuilder:default={"type": "OpenShiftManagedDefault"} // +openshift:enable:FeatureGate=BareMetalLoadBalancer // +optional LoadBalancer *VSpherePlatformLoadBalancer `json:"loadBalancer,omitempty"` // machineNetworks are IP networks used to connect all the OpenShift cluster nodes. // +listType=atomic // +kubebuilder:validation:MaxItems=32 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" // +optional MachineNetworks []CIDR `json:"machineNetworks"` }
VSpherePlatformStatus holds the current status of the vSphere infrastructure provider.
func (*VSpherePlatformStatus) DeepCopy ¶
func (in *VSpherePlatformStatus) DeepCopy() *VSpherePlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformStatus.
func (*VSpherePlatformStatus) DeepCopyInto ¶
func (in *VSpherePlatformStatus) DeepCopyInto(out *VSpherePlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformStatus) SwaggerDoc ¶
func (VSpherePlatformStatus) SwaggerDoc() map[string]string
type VSpherePlatformTopology ¶
type VSpherePlatformTopology struct { // datacenter is the name of vCenter datacenter in which virtual machines will be located. // The maximum length of the datacenter name is 80 characters. // +required // +kubebuilder:validation:MaxLength=80 Datacenter string `json:"datacenter"` // 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. // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/host/.*?` ComputeCluster string `json:"computeCluster"` // networks is the list of port group network names within this failure domain. // If feature gate VSphereMultiNetworks is enabled, up to 10 network adapters may be defined. // 10 is the maximum number of virtual network devices which may be attached to a VM as defined by: // https://configmax.esp.vmware.com/guest?vmwareproduct=vSphere&release=vSphere%208.0&categories=1-0 // The available networks (port groups) can be listed using // `govc ls 'network/*'` // Networks should be in the form of an absolute path: // /<datacenter>/network/<portgroup>. // +required // +openshift:validation:FeatureGateAwareMaxItems:featureGate="",maxItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate=VSphereMultiNetworks,maxItems=10 // +kubebuilder:validation:MinItems=1 // +listType=atomic Networks []string `json:"networks"` // 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. // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/datastore/.*?` Datastore string `json:"datastore"` // 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. // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/host/.*?/Resources.*` // +optional ResourcePool string `json:"resourcePool,omitempty"` // 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. // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/vm/.*?` // +optional Folder string `json:"folder,omitempty"` // template is the full inventory path of the virtual machine or template // that will be cloned when creating new machines in this failure domain. // The maximum length of the path is 2048 characters. // // When omitted, the template will be calculated by the control plane // machineset operator based on the region and zone defined in // VSpherePlatformFailureDomainSpec. // For example, for zone=zonea, region=region1, and infrastructure name=test, // the template path would be calculated as /<datacenter>/vm/test-rhcos-region1-zonea. // +openshift:enable:FeatureGate=VSphereControlPlaneMachineSet // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/vm/.*?` // +optional Template string `json:"template,omitempty"` }
VSpherePlatformTopology holds the required and optional vCenter objects - datacenter, computeCluster, networks, datastore and resourcePool - to provision virtual machines.
func (*VSpherePlatformTopology) DeepCopy ¶
func (in *VSpherePlatformTopology) DeepCopy() *VSpherePlatformTopology
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformTopology.
func (*VSpherePlatformTopology) DeepCopyInto ¶
func (in *VSpherePlatformTopology) DeepCopyInto(out *VSpherePlatformTopology)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformTopology) SwaggerDoc ¶
func (VSpherePlatformTopology) SwaggerDoc() map[string]string
type VSpherePlatformVCenterSpec ¶
type VSpherePlatformVCenterSpec struct { // server is the fully-qualified domain name or the IP address of the vCenter server. // +required // +kubebuilder:validation:MaxLength=255 // --- // + Validation is applied via a patch, we validate the format as either ipv4, ipv6 or hostname Server string `json:"server"` // 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. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=32767 // +optional Port int32 `json:"port,omitempty"` // 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. // +required // +kubebuilder:validation:MinItems=1 // +listType=set Datacenters []string `json:"datacenters"` }
VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.
func (*VSpherePlatformVCenterSpec) DeepCopy ¶
func (in *VSpherePlatformVCenterSpec) DeepCopy() *VSpherePlatformVCenterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VSpherePlatformVCenterSpec.
func (*VSpherePlatformVCenterSpec) DeepCopyInto ¶
func (in *VSpherePlatformVCenterSpec) DeepCopyInto(out *VSpherePlatformVCenterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (VSpherePlatformVCenterSpec) SwaggerDoc ¶
func (VSpherePlatformVCenterSpec) SwaggerDoc() map[string]string
type WebHookModeType ¶
type WebHookModeType string
type WebhookTokenAuthenticator ¶
type WebhookTokenAuthenticator struct { // 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. // // 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. // +required KubeConfig SecretNameReference `json:"kubeConfig"` }
webhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator
func (*WebhookTokenAuthenticator) DeepCopy ¶
func (in *WebhookTokenAuthenticator) DeepCopy() *WebhookTokenAuthenticator
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhookTokenAuthenticator.
func (*WebhookTokenAuthenticator) DeepCopyInto ¶
func (in *WebhookTokenAuthenticator) DeepCopyInto(out *WebhookTokenAuthenticator)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (WebhookTokenAuthenticator) SwaggerDoc ¶
func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string
type WorkerLatencyProfileType ¶
type WorkerLatencyProfileType string
+kubebuilder:validation:Enum=Default;MediumUpdateAverageReaction;LowUpdateSlowReaction
const ( // Medium Kubelet Update Frequency (heart-beat) and Average Reaction Time to unresponsive Node MediumUpdateAverageReaction WorkerLatencyProfileType = "MediumUpdateAverageReaction" // Low Kubelet Update Frequency (heart-beat) and Slow Reaction Time to unresponsive Node LowUpdateSlowReaction WorkerLatencyProfileType = "LowUpdateSlowReaction" // Default values of relavent Kubelet, Kube Controller Manager and Kube API Server DefaultUpdateDefaultReaction WorkerLatencyProfileType = "Default" )
Source Files ¶
- doc.go
- register.go
- stringsource.go
- types.go
- types_apiserver.go
- types_authentication.go
- types_build.go
- types_cluster_operator.go
- types_cluster_version.go
- types_console.go
- types_dns.go
- types_feature.go
- types_image.go
- types_image_content_policy.go
- types_image_digest_mirror_set.go
- types_image_tag_mirror_set.go
- types_infrastructure.go
- types_ingress.go
- types_network.go
- types_node.go
- types_oauth.go
- types_operatorhub.go
- types_project.go
- types_proxy.go
- types_scheduling.go
- types_testreporting.go
- types_tlssecurityprofile.go
- zz_generated.deepcopy.go
- zz_generated.swagger_doc_generated.go