package
0.0.1
Repository: https://github.com/openshift/api.git
Documentation: pkg.go.dev

# Functions

Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED.

# Constants

AWSEFANetworkInterfaceType is the Elastic Fabric Adapter network interface type.
AWSENANetworkInterfaceType is the default network interface type, the EC2 Elastic Network Adapter commonly used with EC2 instances.
AzureImageTypeID specifies that the image should be referenced by its resource ID.
AzureImageTypeMarketplaceNoPlan are images available from the marketplace that do not require a purchase plan.
AzureImageTypeMarketplaceWithPlan require a purchase plan.
AzureManagedAzureDiagnosticsStorage is used to determine that the diagnostics storage account should be provisioned by Azure.
"AzureUltraSSDCapabilityDisabled" means the Azure UltraSSDCapability is Disabled.
"AzureUltraSSDCapabilityEnabled" means the Azure UltraSSDCapability is Enabled.
CachingTypeNone means the CachingType is "None".
CachingTypeReadOnly means the CachingType is "ReadOnly".
CachingTypeReadWrite means the CachingType is "ReadWrite".
AWS classic ELB.
ConditionSeverityError specifies that a condition with `Status=False` is an error.
ConditionSeverityInfo specifies that a condition with `Status=False` is informative.
ConditionSeverityNone should apply only to conditions with `Status=True`.
ConditionSeverityWarning specifies that a condition with `Status=False` is a warning.
ConfidentialComputePolicyDisabled disables confidential compute for the GCP machine.
ConfidentialComputePolicyEnabled enables confidential compute for the GCP machine.
CreateClusterError indicates that an error was encountered when trying to create the cluster.
There was an error while trying to create a Node to match this Machine.
CustomerManagedAzureDiagnosticsStorage is used to determine that the diagnostics storage account should be provisioned by the Customer.
DedicatedTenancy instance runs on single-tenant hardware.
DefaultTenancy instance runs on shared hardware.
DeleteClusterError indicates that an error was encountered when trying to delete the cluster.
An error was encountered while trying to delete the Node that this Machine represents.
DiskDeletionPolicyTypeDelete means the DiskDeletionPolicyType is "Delete".
DiskDeletionPolicyTypeDetach means the DiskDeletionPolicyType is "Detach".
ErrorCheckingProviderReason is the reason used when the exist operation fails.
ExternalRemediationRequestAvailable is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
ExternalRemediationRequestCreationFailed is the reason used when a machine health check fails to create external remediation request.
ExternalRemediationTemplateAvailable is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
ExternalRemediationTemplateNotFound is the reason used when a machine health check fails to find external remediation template.
FullClone indicates a VM will have no relationship to the source of the clone operation once the operation is complete.
HostTenancy instance runs on a Dedicated Host, which is an isolated server with configurations that you can control.
InstanceExistsCondition is set on the Machine to show whether a virtual mahcine has been created by the cloud provider.
InstanceMissingReason is the reason used when the machine was provisioned, but the instance has gone missing.
InstanceNotCreatedReason is the reason used when the machine has not yet been provisioned.
This generally refers to exceeding one's quota in a cloud provider, or running out of physical machines in an on-premise environment.
IntegrityMonitoringPolicyDisabled disables integrity monitoring for the GCP machine.
IntegrityMonitoringPolicyEnabled enables integrity monitoring for the GCP machine.
InvalidConfigurationClusterError indicates that the cluster configuration is invalid.
Represents that the combination of configuration in the MachineSpec is not supported by this cluster.
Represents that the combination of configuration in the MachineTemplateSpec is not supported by this cluster.
IPAddressClaimedCondition is set to indicate that a machine has a claimed an IP address.
IPAddressInvalidReason is set to indicate that the claimed IP address is not valid.
IPClaimProtectionFinalizer is placed on an IPAddressClaim by the machine reconciler when an IPAddressClaim associated with a machine is created.
This error indicates that the machine did not join the cluster as a new node within the expected timeframe after instance creation at the provider succeeded Example use case: A controller that deletes Machines which do not result in a Node joining the cluster within a given timeout and that are managed by a MachineSet.
LinkedClone means resulting VMs will be dependent upon the snapshot of the source VM/template from which the VM was cloned.
MachineClusterIDLabel is the label that a machine must have to identify the cluster to which it belongs.
MachineClusterLabelName is the label set on machines linked to a cluster.
MachineCreated indicates whether the machine has been created or not.
MachineCreated indicates whether the machine has been created or not.
MachineCreationFailed indicates machine creation failure.
MachineCreationSucceeded indicates machine creation success.
MachineDrainable is set on a machine to indicate whether or not the machine can be drained, or, whether some deletion hook is blocking the drain operation.
MachineDrained is set on a machine to indicate that the machine has been drained.
MachineDrainError indicates an error occurred when draining the machine.
MachineFinalizer is set on PrepareForCreate callback.
MachineHookPresent indicates that a machine lifecycle hook is blocking part of the lifecycle of the machine.
MachineTerminable is set on a machine to indicate whether or not the machine can be terminated, or, whether some deletion hook is blocking the termination operation.
MetadataServiceAuthenticationOptional allows IMDSv1 usage along with IMDSv2.
MetadataServiceAuthenticationRequired enforces sending of a signed token header with any instance metadata retrieval (GET) requests.
MigrateHostMaintenanceType [default] - causes Compute Engine to live migrate an instance when there is a maintenance event.
AWS Network Load Balancer (NLB).
NewestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
OldestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
PhaseDeleting indicates the machine has a deletion timestamp and that the Machine API is now in the process of removing the machine from the cluster.
PhaseFailed indicates a state that will need to be fixed before progress can be made.
PhaseProvisioned indicates the instance exists.
PhaseProvisioning indicates the instance does NOT exist.
PhaseRunning indicates the instance exists and the node has joined the cluster.
RandomMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
RemediationAllowedCondition is set on MachineHealthChecks to show the status of whether the MachineHealthCheck is allowed to remediate any Machines or whether it is blocked from remediating any further.
Restart an instance if an instance crashes or the underlying infrastructure provider stops the instance as part of a maintenance event.
Do not restart an instance if an instance crashes or the underlying infrastructure provider stops the instance as part of a maintenance event.
Replace the old MachineSet by new one using rolling update i.e.
SecureBootPolicyDisabled disables the secure boot configuration for the GCP machine.
SecureBootPolicyEnabled enables the secure boot configuration for the GCP machine.
"StorageAccountPremiumLRS" means the Premium_LRS storage type.
"StorageAccountStandardLRS" means the Standard_LRS storage type.
"StorageAccountUltraSSDLRS" means the UltraSSD_LRS storage type.
TemplateClonedFromGroupKindAnnotation is the infrastructure machine annotation that stores the group-kind of the infrastructure template resource that was cloned for the machine.
TemplateClonedFromNameAnnotation is the infrastructure machine annotation that stores the name of the infrastructure template resource that was cloned for the machine.
TerminateHostMaintenanceType - stops an instance instead of migrating it.
TooManyUnhealthy is the reason used when too many Machines are unhealthy and the MachineHealthCheck is blocked from making any further remediations.
UnsupportedChangeClusterError indicates that the cluster spec has been updated in an unsupported way.
This indicates that the MachineSpec has been updated in a way that is not supported for reconciliation on this cluster.
UpdateClusterError indicates that an error was encountered when trying to update the cluster.
There was an error while trying to update a Node that this Machine represents.
VirtualizedTrustedPlatformModulePolicyDisabled disables the virtualized trusted platform module configuration for the GCP machine.
VirtualizedTrustedPlatformModulePolicyEnabled enables the virtualized trusted platform module configuration for the GCP machine.
ProvisioningState related values VMStateCreating ...
VMStateDeallocated ...
VMStateDeallocating ...
VMStateDeleting ...
VMStateFailed ...
VMStateMigrating ...
VMStateRunning ...
PowerState related values VMStateStarting ...
VMStateStopped ...
VMStateStopping ...
VMStateSucceeded ...
VMStateUnknown ...
VMStateUpdating ...
WaitingForIPAddressReason is set to indicate that a machine is currently waiting for an IP address to be provisioned.

# Variables

AddToScheme exists solely to keep the old generators creating valid code DEPRECATED.
No description provided by the author
No description provided by the author
Install is a function which adds this version to a scheme.
SchemeGroupVersion generated code relies on this name Deprecated.

# Structs

AddressesFromPool is an IPAddressPool that will be used to create IPAddressClaims for fulfillment by an external controller.
AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
AWSMachineProviderConfigList contains a list of AWSMachineProviderConfig Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
AWSMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field.
AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters.
AzureBootDiagnostics configures the boot diagnostics settings for the virtual machine.
AzureCustomerManagedBootDiagnostics provides reference to a customer managed storage account.
AzureDiagnostics is used to configure the diagnostic settings of the virtual machine.
AzureMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an Azure virtual machine.
AzureMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field.
BlockDeviceMappingSpec describes a block device mapping.
Condition defines an observation of a Machine API resource operational state.
DataDisk specifies the parameters that are used to add one or more data disks to the machine.
DataDiskManagedDiskParameters is the parameters of a DataDisk managed disk.
DiskEncryptionSetParameters is the disk encryption set properties.
DiskSettings describe ephemeral disk settings for the os disk.
EBSBlockDeviceSpec describes a block device for an EBS volume.
Filter is a filter used to identify an AWS resource.
GCPDisk describes disks for GCP.
GCPEncryptionKeyReference describes the encryptionKey to use for a disk's encryption.
GCPGPUConfig describes type and count of GPUs attached to the instance on GCP.
GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key.
GCPMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an GCP virtual machine.
GCPMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field.
GCPMetadata describes metadata for GCP.
GCPNetworkInterface describes network interfaces for GCP.
GCPServiceAccount describes service accounts for GCP.
GCPShieldedInstanceConfig describes the shielded VM configuration of the instance on GCP.
Image is a mirror of azure sdk compute.ImageReference.
LastOperation represents the detail of the last performed operation on the MachineObject.
LifecycleHook represents a single instance of a lifecycle hook.
LifecycleHooks allow users to pause operations on the machine at certain prefedined points within the machine lifecycle.
LoadBalancerReference is a reference to a load balancer on AWS.
Machine is the Schema for the machines API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Phase of machine" +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".metadata.labels['machine\\.openshift\\.io/instance-type']",description="Type of instance" +kubebuilder:printcolumn:name="Region",type="string",JSONPath=".metadata.labels['machine\\.openshift\\.io/region']",description="Region associated with machine" +kubebuilder:printcolumn:name="Zone",type="string",JSONPath=".metadata.labels['machine\\.openshift\\.io/zone']",description="Zone associated with machine" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Machine age" +kubebuilder:printcolumn:name="Node",type="string",JSONPath=".status.nodeRef.name",description="Node associated with machine",priority=1 +kubebuilder:printcolumn:name="ProviderID",type="string",JSONPath=".spec.providerID",description="Provider ID of machine created in cloud provider",priority=1 +kubebuilder:printcolumn:name="State",type="string",JSONPath=".metadata.annotations['machine\\.openshift\\.io/instance-state']",description="State of instance",priority=1 Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
MachineHealthCheck is the Schema for the machinehealthchecks API +kubebuilder:subresource:status +kubebuilder:resource:shortName=mhc;mhcs +k8s:openapi-gen=true +kubebuilder:printcolumn:name="MaxUnhealthy",type="string",JSONPath=".spec.maxUnhealthy",description="Maximum number of unhealthy machines allowed" +kubebuilder:printcolumn:name="ExpectedMachines",type="integer",JSONPath=".status.expectedMachines",description="Number of machines currently monitored" +kubebuilder:printcolumn:name="CurrentHealthy",type="integer",JSONPath=".status.currentHealthy",description="Current observed healthy machines" Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
MachineHealthCheckList contains a list of MachineHealthCheck Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
MachineHealthCheckSpec defines the desired state of MachineHealthCheck.
MachineHealthCheckStatus defines the observed state of MachineHealthCheck.
MachineList contains a list of Machine Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
MachineSet ensures that a specified number of machines replicas are running at any given time.
MachineSetList contains a list of MachineSet Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
MachineSetSpec defines the desired state of MachineSet.
MachineSetStatus defines the observed state of MachineSet.
MachineSpec defines the desired state of Machine.
MachineStatus defines the observed state of Machine.
MachineTemplateSpec describes the data needed to create a Machine from a template.
MetadataServiceOptions defines the options available to a user when configuring Instance Metadata Service (IMDS) Options.
NetworkDeviceSpec defines the network configuration for a virtual machine's network device.
NetworkSpec defines the virtual machine's network configuration.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
No description provided by the author
OSDiskManagedDiskParameters is the parameters of a OSDisk managed disk.
Placement indicates where to create the instance in AWS.
ProviderSpec defines the configuration to use during node creation.
SecurityProfile specifies the Security profile settings for a virtual machine or virtual machine scale set.
SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances.
SpotVMOptions defines the options relevant to running the Machine on Spot VMs.
TagSpecification is the name/value pair for a tag.
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration.
VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
VSphereMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field.
WorkspaceConfig defines a workspace configuration for the vSphere cloud provider.

# Type aliases

AWSLoadBalancerType is the type of LoadBalancer to use when registering an instance with load balancers specified in LoadBalancerNames.
AWSNetworkInterfaceType defines the network interface type of the the AWS EC2 network interface.
AzureBootDiagnosticsStorageAccountType defines the list of valid storage account types for the boot diagnostics.
AzureImageType provides an enumeration for the valid image types.
AzureUltraSSDCapabilityState defines the different states of an UltraSSDCapability.
VMState describes the state of an Azure virtual machine.
CachingTypeOption defines the different values for a CachingType.
CloneMode is the type of clone operation used to clone a VM from a template.
No description provided by the author
Conditions provide observations of the operational state of a Machine API resource.
ConditionSeverity expresses the severity of a Condition Type failing.
ConditionType is a valid value for Condition.Type.
ConfidentialComputePolicy represents the confidential compute configuration for the GCP machine.
DiskDeletionPolicyType defines the possible values for DeletionPolicy.
GCPHostMaintenanceType is a type representing acceptable values for OnHostMaintenance field in GCPMachineProviderSpec.
GCPHostMaintenanceType is a type representing acceptable values for RestartPolicy field in GCPMachineProviderSpec.
InstanceTenancy indicates if instance should run on shared or single-tenant hardware.
IntegrityMonitoringPolicy represents the integrity monitoring configuration for the GCP machine.
No description provided by the author
MachineSetDeletePolicy defines how priority is assigned to nodes to delete when downscaling a MachineSet.
No description provided by the author
No description provided by the author
No description provided by the author
RemediationStrategyType contains remediation strategy type.
SecureBootPolicy represents the secure boot configuration for the GCP machine.
StorageAccountType defines the different storage types to use for a ManagedDisk.
VirtualizedTrustedPlatformModulePolicy represents the virtualized trusted platform module configuration for the GCP machine.