package
0.2.0-alpha.14
Repository: https://github.com/onexstack/onex.git
Documentation: pkg.go.dev

# Packages

Package index provides indexes for the api.

# Functions

Convert_apps_Chain_To_v1beta1_Chain is an autogenerated conversion function.
Convert_apps_ChainList_To_v1beta1_ChainList is an autogenerated conversion function.
Convert_apps_ChainSpec_To_v1beta1_ChainSpec is an autogenerated conversion function.
Convert_apps_ChainStatus_To_v1beta1_ChainStatus is an autogenerated conversion function.
Convert_apps_Condition_To_v1beta1_Condition is an autogenerated conversion function.
Convert_apps_LocalObjectReference_To_v1beta1_LocalObjectReference is an autogenerated conversion function.
Convert_apps_Miner_To_v1beta1_Miner is an autogenerated conversion function.
Convert_apps_MinerAddress_To_v1beta1_MinerAddress is an autogenerated conversion function.
Convert_apps_MinerList_To_v1beta1_MinerList is an autogenerated conversion function.
Convert_apps_MinerSet_To_v1beta1_MinerSet is an autogenerated conversion function.
Convert_apps_MinerSetList_To_v1beta1_MinerSetList is an autogenerated conversion function.
Convert_apps_MinerSetSpec_To_v1beta1_MinerSetSpec is an autogenerated conversion function.
Convert_apps_MinerSetStatus_To_v1beta1_MinerSetStatus is an autogenerated conversion function.
Convert_apps_MinerSpec_To_v1beta1_MinerSpec is an autogenerated conversion function.
Convert_apps_MinerStatus_To_v1beta1_MinerStatus is an autogenerated conversion function.
Convert_apps_MinerTemplateSpec_To_v1beta1_MinerTemplateSpec is an autogenerated conversion function.
Convert_apps_ObjectMeta_To_v1beta1_ObjectMeta is an autogenerated conversion function.
Convert_apps_PodInfo_To_v1beta1_PodInfo is an autogenerated conversion function.
Convert_v1beta1_Chain_To_apps_Chain is an autogenerated conversion function.
Convert_v1beta1_ChainList_To_apps_ChainList is an autogenerated conversion function.
Convert_v1beta1_ChainSpec_To_apps_ChainSpec is an autogenerated conversion function.
Convert_v1beta1_ChainStatus_To_apps_ChainStatus is an autogenerated conversion function.
Convert_v1beta1_Condition_To_apps_Condition is an autogenerated conversion function.
Convert_v1beta1_LocalObjectReference_To_apps_LocalObjectReference is an autogenerated conversion function.
Convert_v1beta1_Miner_To_apps_Miner is an autogenerated conversion function.
Convert_v1beta1_MinerAddress_To_apps_MinerAddress is an autogenerated conversion function.
Convert_v1beta1_MinerList_To_apps_MinerList is an autogenerated conversion function.
Convert_v1beta1_MinerSet_To_apps_MinerSet is an autogenerated conversion function.
Convert_v1beta1_MinerSetList_To_apps_MinerSetList is an autogenerated conversion function.
Convert_v1beta1_MinerSetSpec_To_apps_MinerSetSpec is an autogenerated conversion function.
Convert_v1beta1_MinerSetStatus_To_apps_MinerSetStatus is an autogenerated conversion function.
Convert_v1beta1_MinerSpec_To_apps_MinerSpec is an autogenerated conversion function.
Convert_v1beta1_MinerStatus_To_apps_MinerStatus is an autogenerated conversion function.
Convert_v1beta1_MinerTemplateSpec_To_apps_MinerTemplateSpec is an autogenerated conversion function.
Convert_v1beta1_ObjectMeta_To_apps_ObjectMeta is an autogenerated conversion function.
Convert_v1beta1_PodInfo_To_apps_PodInfo is an autogenerated conversion function.
RegisterConversions adds conversion functions to the given scheme.
RegisterDefaults adds defaulters functions to the given scheme.
Resource takes an unqualified resource and returns a Group qualified GroupResource.
SetDefaults_Chain sets defaults for Chain.
SetDefaults_ChainSpec sets defaults for Chain spec.
SetDefaults_Miner sets defaults for Miner.
SetDefaults_MinerSpec sets defaults for Miner spec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

BootstrapReadyCondition reports a summary of current status of the bootstrap object defined for this miner.
BootstrapTemplateCloningFailedReason (Severity=Error) documents a MinerSet failing to clone the bootstrap template.
ChainFinalizer is the finalizer used by the Chain controller to clean up referenced template resources if necessary when a Chain is being deleted.
ChainNameLabel is the label set on miners linked to a chain.
Approved indicates the charge request was approved.
ChargeRequestFinalizer is the finalizer used by the ChargeRequest controller to clean up referenced template resources if necessary when a ChargeRequest is being deleted.
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.
No description provided by the author
No description provided by the author
ControlPlaneInitializedCondition reports if the cluster's control plane has been initialized such that the cluster's apiserver is reachable and at least one control plane Miner has a node reference.
ControlPlaneReadyCondition reports the ready condition from the control plane object defined for this cluster.
DeletedReason (Severity=Info) documents a condition not in Status=True because the underlying object was deleted.
DeleteMinerAnnotation marks control plane and worker nodes that will be given priority for deletion when KCP or a minerset scales down.
DeletingReason (Severity=Info) documents a condition not in Status=True because the underlying object it is currently being deleted.
DeletionFailedReason (Severity=Warning) documents a condition not in Status=True because the underlying object encountered problems during deletion.
DisableMinerCreate is an annotation that can be used to signal a MinerSet to stop creating new miners.
DrainingFailedReason (Severity=Warning) documents a miner node drain operation failed.
DrainingReason (Severity=Info) documents a miner node being drained.
DrainingSucceededCondition provide evidence of the status of the node drain operation which happens during the miner deletion process.
ExternalRemediationRequestAvailable is set on minerhealthchecks when MinerHealthCheck controller uses external remediation.
ExternalRemediationRequestCreationFailed is the reason used when a miner health check fails to create external remediation request.
ExternalRemediationTemplateAvailable is set on minerhealthchecks when MinerHealthCheck controller uses external remediation.
ExternalRemediationTemplateNotFound is the reason used when a miner health check fails to find external remediation template.
GroupName is the group name used in this package.
IncorrectExternalRefReason (Severity=Error) documents a CAPI object with an incorrect external object reference.
InfrastructureReadyCondition reports a summary of current status of the infrastructure object defined for this cluster/miner/minerpool.
InfrastructureTemplateCloningFailedReason (Severity=Error) documents a MinerSet failing to clone the infrastructure template.
MinerAnnotation is the annotation set on pods identifying the miner the pod belongs to.
MinerCreationFailedReason (Severity=Error) documents a MinerSet failing to generate a miner object.
MinerDeploymentAvailableCondition means the MinerDeployment is available, that is, at least the minimum available miners required (i.e.
MinerDeploymentNameLabel is the label set on miners if they're controlled by MinerDeployment.
Define the MinerAddressType constants.
Define the MinerAddressType constants.
MinerFinalizer is the finalizer used by the Miner controller to clean up referenced template resources if necessary when a Miner is being deleted.
MinerHasFailureReason is the reason used when a miner has either a FailureReason or a FailureMessage set on its status.
MinerHealthCheckSuccededCondition is set on miners that have passed a healthcheck by the MinerHealthCheck controller.
MinerHealthCheckSucceededCondition is set on miners that have passed a healthcheck by the MinerHealthCheck controller.
Define the MinerAddressType constants.
Define the MinerAddressType constants.
Define the MinerAddressType constants.
MinerNamespaceAnnotation is the annotation set on pods identifying the namespace of the miner the pod belongs to.
MinerOwnerRemediatedCondition is set on miners that have failed a healthcheck by the MinerHealthCheck controller.
MinerPhaseDeleting is the Miner state when a delete request has been sent to the API Server, but its infrastructure has not yet been fully deleted.
MinerPhaseFailed is the Miner state when the system might require user intervention.
MinerPhasePending is the first state a Miner is assigned by Cloud Miner controller after being created.
MinerPhaseProvisioning is the state when the Miner infrastructure is being created.
MinerPhaseRunning is the Miner state when it has become a running miner and ready to mine.
MinerPhaseUnknown is returned if the Miner state cannot be determined.
MinerPodHealthyCondition provides info about the operational state of the Kubernetes node hosted on the miner by summarizing node conditions.
MinersCreatedCondition documents that the miners controlled by the MinerSet are created.
MinerSetFinalizer is the finalizer used by the MinerSet controller to clean up referenced template resources if necessary when a MinerSet is being deleted.
MinerSetNameLabel is the label set on miners linked to a minerset.
MinerSkipRemediationAnnotation is the annotation used to mark the miners that should not be considered for remediation by MinerHealthCheck reconciler.
MinersReadyCondition reports an aggregate of current status of the miners controlled by the MinerSet.
MissingPodRefReason (Severity=Info) documents a cluster waiting for at least one control plane Miner to have its node reference populated.
NewestMinerSetDeletePolicy prioritizes both Miners that have the annotation "apps.onex.io/delete-miner=yes" and Miners that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
OldestMinerSetDeletePolicy prioritizes both Miners that have the annotation "apps.onex.io/delete-miner=yes" and Miners that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
OwnerKindAnnotation is the annotation set on pods identifying the owner kind.
OwnerNameAnnotation is the annotation set on pods identifying the owner name.
PausedAnnotation is an annotation that can be applied to any OneX API object to prevent a controller from processing a resource.
PodConditionsFailedReason (Severity=Warning) documents a node is not in a healthy state due to the failed state of at least 1 Kubelet condition.
PodNotFoundReason (Severity=Error) documents a miner's node has previously been observed but is now gone.
PodProvisioningReason (Severity=Info) documents miner in the process of provisioning a node.
PodStartupTimeoutReason is the reason used when a miner's node does not appear within the specified timeout.
PreDrainDeleteHookSucceededCondition reports a miner waiting for a PreDrainDeleteHook before being delete.
PreTerminateDeleteHookSucceededCondition reports a miner waiting for a PreDrainDeleteHook before being delete.
RandomMinerSetDeletePolicy prioritizes both Miners that have the annotation "apps.onex.io/delete-miner=yes" and Miners that are unhealthy (Status.ErrorReason or Status.ErrorMessage are set to a non-empty value).
ReadyCondition defines the Ready condition type that summarizes the operational state of a Cluster API object.
RemediationAllowedCondition is set on MinerHealthChecks to show the status of whether the MinerHealthCheck is allowed to remediate any Miners or whether it is blocked from remediating any further.
RemediationFailedReason is the reason used when a remediation owner fails to remediate an unhealthy miner.
RemediationInProgressReason is the reason used when an unhealthy miner is being remediated by the remediation owner.
ResizedCondition documents a MinerSet is resizing the set of controlled miners.
ScalingDownReason (Severity=Info) documents a MinerSet is decreasing the number of replicas.
ScalingUpReason (Severity=Info) documents a MinerSet is increasing the number of replicas.
TooManyUnhealthyReason is the reason used when too many Miners are unhealthy and the MinerHealthCheck is blocked from making any further remediations.
TopologyReconciledCondition provides evidence about the reconciliation of a Cluster topology into the managed objects of the Cluster.
TopologyReconciledControlPlaneUpgradePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because Control Plane is not yet updated to match the desired topology spec.
TopologyReconciledHookBlockingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the lifecycle hooks is blocking.
TopologyReconciledMinerDeploymentsUpgradePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the MinerDeployments is not yet updated to match the desired topology spec.
TopologyReconcileFailedReason (Severity=Error) documents the reconciliation of a Cluster topology failing due to an error.
UnhealthyPodConditionReason is the reason used when a miner's node has one of the MinerHealthCheck's unhealthy conditions.
VolumeDetachSucceededCondition reports a miner waiting for volumes to be detached.
WaitingExternalHookReason (Severity=Info) provide evidence that we are waiting for an external hook to complete.
WaitingForAvailableMinersReason (Severity=Warning) reflects the fact that the required minimum number of miners for a minerdeployment are not available.
WaitingForControlPlaneAvailableReason (Severity=Info) documents a Cluster API object waiting for the control plane miner to be available.
WaitingForControlPlaneFallbackReason (Severity=Info) documents a cluster waiting for the control plane to be available.
WaitingForControlPlaneProviderInitializedReason (Severity=Info) documents a cluster waiting for the control plane provider to report successful control plane initialization.
WaitingForDataSecretFallbackReason (Severity=Info) documents a miner waiting for the bootstrap data secret to be available.
WaitingForInfrastructureFallbackReason (Severity=Info) documents a cluster/miner/minerpool waiting for the underlying infrastructure to be available.
WaitingForPodRefReason (Severity=Info) documents a miner.spec.providerId is not assigned yet.
WaitingForRemediationReason is the reason used when a miner fails a health check and remediation is needed.
WaitingForVolumeDetachReason (Severity=Info) provide evidence that a miner node waiting for volumes to be attached.
WatchLabel is a label othat can be applied to any OneX API object.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
SchemeGroupVersion is group version used to register these objects.

# Structs

Chain is the Schema for the chains API.
ChainList is a list of Chain objects.
ChainSpec defines the desired state of Chain.
ChainStatus defines the observed state of Chain.
ChargeRequest is the Schema for the chargerequests API.
ChargeRequestList is a list of ChargeRequest objects.
ChargeRequestSpec defines the desired state of ChargeRequest.
ChargeRequestStatus defines the observed state of ChargeRequest.
Condition defines an observation of a cloud miner resource operational state.
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Miner is the Schema for the miners API.
MinerAddress contains information for the miner's address.
MinerList is a list of Miner objects.
MinerSet ensures that a specified number of miners replicas are running at any given time.
MinerSetList contains a list of MinerSet.
MinerSetSpec defines the desired state of MinerSet.
MinerSetStatus represents the current status of a MinerSet.
MinerSpec defines the desired state of Miner.
MinerStatus defines the observed state of Miner.
MinerTemplateSpec describes the data needed to create a Miner from a template.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
PodInfo is a set of ids/uuids to uniquely identify the pod.

# Type aliases

Conditions provide observations of the operational state of a cloud miner resource.
ConditionSeverity expresses the severity of a Condition Type failing.
ConditionType is a valid value for Condition.Type.
MinerAddresses is a slice of MinerAddress items to be used by infrastructure providers.
MinerAddressType describes a valid MinerAddress type.
MinerPhase is a string representation of a Miner Phase.
No description provided by the author