package
1.0.0
Repository: https://github.com/kubesphere/kubeocean-api.git
Documentation: pkg.go.dev

# Functions

Resource takes an unqualified resource and returns a Group qualified GroupResource.

# Constants

ClusterFinalizer is the finalizer used by the cluster controller to cleanup the cluster resources when a Cluster is being deleted.
ClusterLabelName is the label set on machines linked to a cluster and external objects(bootstrap and infrastructure providers).
ClusterNameAnnotation is the annotation set on nodes identifying the name of the cluster the node belongs to.
ClusterNamespaceAnnotation is the annotation set on nodes identifying the namespace of the cluster the node belongs to.
ClusterPhaseDeleting is the Cluster state when a delete request has been sent to the API Server, but its infrastructure has not yet been fully deleted.
ClusterPhaseFailed is the Cluster state when the system might require user intervention.
ClusterPhasePending is the first state a Cluster is assigned by Cluster API Cluster controller after being created.
ClusterPhaseProvisioned is the state when its infrastructure has been created and configured.
ClusterPhaseProvisioning is the state when the Cluster has a provider infrastructure object associated and can start provisioning.
ClusterPhaseUnknown is returned if the Cluster state cannot be determined.
nolint:gosec.
ClusterTopologyMachineDeploymentLabelName is the label set on the generated MachineDeployment objects to track the name of the MachineDeployment topology it represents.
ClusterTopologyManagedFieldsAnnotation is the annotation used to store the list of paths managed by the topology controller; changes to those paths will be considered authoritative.
ClusterTopologyOwnedLabel is the label set on all the object which are managed as part of a ClusterTopology.
ClusterTopologyUnsafeUpdateClassNameAnnotation can be used to disable the webhook check on update that disallows a pre-existing Cluster to be populated with Topology information and Class.
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.
DeleteMachineAnnotation marks control plane and worker nodes that will be given priority for deletion when KCP or a machineset scales down.
DesiredReplicasAnnotation is the desired replicas for a machine deployment recorded as an annotation in its machine sets.
DisableMachineCreate is an annotation that can be used to signal a MachineSet to stop creating new machines.
Define the ClusterIPFamily constants.
ExcludeNodeDrainingAnnotation annotation explicitly skips node draining if set.
InterruptibleLabel is the label used to mark the nodes that run on interruptible instances.
Define the ClusterIPFamily constants.
Define the ClusterIPFamily constants.
Define the ClusterIPFamily constants.
MachineAnnotation is the annotation set on nodes identifying the machine the node belongs to.
MachineControlPlaneLabelName is the label set on machines or related objects that are part of a control plane.
MachineDeploymentLabelName is the label set on machines if they're controlled by MachineDeployment.
MachineDeploymentPhaseFailed indicates there was a problem scaling and user intervention might be required.
MachineDeploymentPhaseRunning indicates scaling has completed and all Machines are running.
MachineDeploymentPhaseScalingDown indicates the MachineDeployment is scaling down.
MachineDeploymentPhaseScalingUp indicates the MachineDeployment is scaling up.
MachineDeploymentPhaseUnknown indicates the state of the MachineDeployment cannot be determined.
MachineDeploymentTopologyFinalizer is the finalizer used by the topology MachineDeployment controller to clean up referenced template resources if necessary when a MachineDeployment is being deleted.
MachineDeploymentUniqueLabel is the label applied to Machines in a MachineDeployment containing the hash of the template.
Define the MachineAddressType constants.
Define the MachineAddressType constants.
MachineFinalizer is set on PrepareForCreate callback.
Define the MachineAddressType constants.
Define the MachineAddressType constants.
Define the MachineAddressType constants.
MachinePhaseDeleted is the Machine state when the object and the related infrastructure is deleted and ready to be garbage collected by the API Server.
MachinePhaseDeleting is the Machine state when a delete request has been sent to the API Server, but its infrastructure has not yet been fully deleted.
MachinePhaseFailed is the Machine state when the system might require user intervention.
MachinePhasePending is the first state a Machine is assigned by Cluster API Machine controller after being created.
MachinePhaseProvisioned is the state when its infrastructure has been created and configured.
MachinePhaseProvisioning is the state when the Machine infrastructure is being created.
MachinePhaseRunning is the Machine state when it has become a Kubernetes Node in a Ready state.
MachinePhaseUnknown is returned if the Machine state cannot be determined.
MachineSetLabelName is the label set on machines if they're controlled by MachineSet.
MachineSetTopologyFinalizer is the finalizer used by the topology MachineDeployment controller to clean up referenced template resources if necessary when a MachineSet is being deleted.
MachineSkipRemediationAnnotation is the annotation used to mark the machines that should not be considered for remediation by MachineHealthCheck reconciler.
ManagedByAnnotation is an annotation that can be applied to InfraCluster resources to signify that some external system is managing the cluster infrastructure.
MaxReplicasAnnotation is the maximum replicas a deployment can have at a given point, which is machinedeployment.spec.replicas + maxSurge.
NewestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
OldestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
OnDeleteMachineDeploymentStrategyType replaces old MachineSets when the deletion of the associated machines are completed.
OwnerKindAnnotation is the annotation set on nodes identifying the owner kind.
OwnerNameAnnotation is the annotation set on nodes identifying the owner name.
PausedAnnotation is an annotation that can be applied to any Cluster API object to prevent a controller from processing a resource.
PreDrainDeleteHookAnnotationPrefix annotation specifies the prefix we search each annotation for during the pre-drain.delete lifecycle hook to pause reconciliation of deletion.
PreTerminateDeleteHookAnnotationPrefix annotation specifies the prefix we search each annotation for during the pre-terminate.delete lifecycle hook to pause reconciliation of deletion.
ProviderLabelName is the label set on components in the provider manifest.
RandomMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
RevisionAnnotation is the revision annotation of a machine deployment's machine sets which records its rollout sequence.
RevisionHistoryAnnotation maintains the history of all old revisions that a machine set has served for a machine deployment.
RollingUpdateMachineDeploymentStrategyType replaces the old MachineSet by new one using rolling update i.e.
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.
TemplateSuffix is the object kind suffix used by template types.
WatchLabel is a label othat can be applied to any Cluster API object.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.
ZeroDuration is a zero value of the metav1.Duration type.

# Structs

APIEndpoint represents a reachable Kubernetes API endpoint.
Bootstrap encapsulates fields to configure the Machine’s bootstrapping mechanism.
Cluster is the Schema for the clusters API.
ClusterClass is a template which can be used to create managed topologies.
ClusterClassList contains a list of Cluster.
ClusterClassPatch defines a patch which is applied to customize the referenced templates.
ClusterClassSpec describes the desired state of the ClusterClass.
ClusterClassVariable defines a variable which can be configured in the Cluster topology and used in patches.
ClusterList contains a list of Cluster.
ClusterNetwork specifies the different networking parameters for a cluster.
ClusterSpec defines the desired state of Cluster.
ClusterStatus defines the observed state of Cluster.
ClusterVariable can be used to customize the Cluster through patches.
Condition defines an observation of a Cluster API resource operational state.
ControlPlaneClass defines the class for the control plane.
ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster.
FailureDomainSpec is the Schema for Cluster API failure domains.
JSONPatch defines a JSON patch.
JSONPatchValue defines the value of a patch.
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
LocalObjectTemplate defines a template for a topology Class.
Machine is the Schema for the machines API.
MachineAddress contains information for the node's address.
MachineDeployment is the Schema for the machinedeployments API.
MachineDeploymentClass serves as a template to define a set of worker nodes of the cluster provisioned using the `ClusterClass`.
MachineDeploymentClassTemplate defines how a MachineDeployment generated from a MachineDeploymentClass should look like.
MachineDeploymentList contains a list of MachineDeployment.
MachineDeploymentSpec defines the desired state of MachineDeployment.
MachineDeploymentStatus defines the observed state of MachineDeployment.
MachineDeploymentStrategy describes how to replace existing machines with new ones.
MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology.
MachineDeploymentVariables can be used to provide variables for a specific MachineDeployment.
MachineHealthCheck is the Schema for the machinehealthchecks API.
MachineHealthCheckClass defines a MachineHealthCheck for a group of Machines.
MachineHealthCheckList contains a list of MachineHealthCheck.
MachineHealthCheckSpec defines the desired state of MachineHealthCheck.
MachineHealthCheckStatus defines the observed state of MachineHealthCheck.
MachineList contains a list of Machine.
MachineRollingUpdateDeployment is used to control the desired behavior of rolling update.
MachineSet is the Schema for the machinesets API.
MachineSetList contains a list of MachineSet.
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.
NetworkRanges represents ranges of network addresses.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
PatchDefinition defines a patch which is applied to customize the referenced templates.
PatchSelector defines on which templates the patch should be applied.
PatchSelectorMatch selects templates based on where they are referenced.
PatchSelectorMatchMachineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments.
Topology encapsulates the information of the managed resources.
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration.
VariableSchema defines the schema of a variable.
WorkersClass is a collection of deployment classes.
WorkersTopology represents the different sets of worker nodes in the cluster.

# Type aliases

ClusterIPFamily defines the types of supported IP families.
ClusterPhase is a string representation of a Cluster Phase.
Conditions provide observations of the operational state of a Cluster API resource.
ConditionSeverity expresses the severity of a Condition Type failing.
ConditionType is a valid value for Condition.Type.
FailureDomains is a slice of FailureDomains.
MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.
MachineAddressType describes a valid MachineAddress type.
MachineDeploymentPhase indicates the progress of the machine deployment.
MachineDeploymentStrategyType defines the type of MachineDeployment rollout strategies.
MachinePhase is a string representation of a Machine Phase.
MachineSetDeletePolicy defines how priority is assigned to nodes to delete when downscaling a MachineSet.