package
2.0.0-20230208192055-6241090b1050
Repository: https://github.com/mirantis/mcc-api.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
BoolValue returns the value of the bool pointer passed in or false if the pointer is nil.
ClusterNameFromSecret returns the NamespacedName of the cluster for the specified cluster secret.
No description provided by the author
IsClusterSecret returns true if the specified secret refers to a kubeconfig or deployment secret.
No description provided by the author
No description provided by the author
ProxyStateItemParams gets proxy related Params from LCMStateItem list proxy params are present in all LCMStateItem items in current implementation, so just taking first.
ProxyStateItemParamsWithKeys gets proxy related Params and keys map from LCMStateItem list proxy params are present in all LCMStateItem items in current implementation, so just taking first.
Resource is required by pkg/client/listers/...
No description provided by the author

# Constants

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
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
No description provided by the author
the duration of the token to be considered "reliable" (i.e.
default token TTL.
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
LCMClusterStateReasonAnnotation denotes the reason the LCMClusterState was created.
LCMCLusterStateReasonMaintenance denotes maintenance cause of LCMClusterState creation.
LCMClusterStateReasonUpgrade denotes upgrade cause of LCMClusterState creation.
LCMClusterStateTypeCordonDrain denotes cordon&drain of a node, if it's registered with child apiserver.
LCMClusterStateTypeHelmDeployed denotes the deployment of helm-controller on the child cluster.
LCMClusterStateTypeSwarmDrain denotes cordon&drain of a Swarm node.
LCMClusterStateValueFalse denotes a false value for LCMClusterState.
LCMClusterStateValueTrue denotes a true value for LCMClusterState.
No description provided by the author
No description provided by the author
LCMMachineIndexAnnotation names an annotation that stores the index used for the ordering of LCMMachines.
The agent did return an IP address, and the state items are set for the phases up to and including the Deploy phase (also possibly for Reconfigure phase, but this isn't checked), but Prepare and/or Deploy phases didn't finish yet.
The agent did set the IP address, but there aren't any state items set for this machine.
The agent did return an IP address, and the state items are only set for Prepare phase.
The agent did return an IP address, all of the state items for the machine are set and fully processed by the agent.
The agent is going to proceed with a node reboot.
The agent did return an IP address, and the state items are set for the phases up to and including the Reconfigure phase, and the Prepare and Deploy phases are fully processed, but Reconfigure phase isn't processed yet.
The agent didn't set the address yet.
The agent did return an IP address, all of the state items for the machine are set and fully processed by the agent, but the desired UCP version doesn't match the actual one.
LCMMachineTypeBastion denotes a machine that's a bastion node.
LCMMachineTypeControl denotes a machine that belongs to the control plane.
LCMMachineTypeUnassigned denotes a machine that's doesn't have an assigned role yet.
LCMMachineTypeControl denotes a machine that's a worker node.
LCMMachineWasDeployedAnnotation names an annotation that is present if this machine's agent ever started processing StateItems of the "deploy" phase.
LCMMachineWasReadyAnnotation names an annotation that is present if the machine has ever reached Ready state, meaning that it no longer requires kubeadm token for updating.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MaintenanceScopeDrain is set when a node is scheduled to be drained.
MaintenanceScopeOS is set when a node is scheduled for maintenance via maintenance api or will be rebooted after upgrade.
NameLength denotes the maximum length of LCMClusterState object name.
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
No description provided by the author
No description provided by the author
No description provided by the author
Node is not ready to maintenance when lock state is "active".
Workload controller must set lock to "failed" when it is unable to gracefully shutdown workload.
Lock object is inactive when workload is turned off and it's safe to put the node offline.

# Variables

AddToScheme is required by pkg/client/...
No description provided by the author
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.
No description provided by the author

# Structs

No description provided by the author
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=clustermaintenancerequests,scope=Cluster.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
No description provided by the author
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=clusterworkloadlocks,scope=Cluster +kubebuilder:subresource:status.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HardwareDetails collects all of the information about hardware discovered on the host.
HelmBundle specifies several Helm releases to be installed +k8s:openapi-gen=true +kubebuilder:subresource:status.
HelmBundleList contains a list of HelmBundle objects.
HelmBundleSpec describes a set of Helm releases and repositories that they use.
HelmBundleStatus describes a status of a HelmBundle.
HelmReleaseSpec specifies a Helm release.
HelmReleaseStatus describes a status of a release.
HelmRepositorySpec describes a repository used by a HelmBundle.
No description provided by the author
LCMAgentUpgradeStatus defines a status of LCM Agent upgrade.
LCMCluster is the Schema for the lcmclusters API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="requested",type="integer",JSONPath=".status.requestedNodes",description="Requested Nodes",priority=0 +kubebuilder:printcolumn:name="ready",type="integer",JSONPath=".status.readyNodes",description="Ready Nodes",priority=0 +kubebuilder:printcolumn:name="helmCtlDeployed",type="boolean",JSONPath=".status.helmControllerDeployed",description="Helm Ctl Deployed",priority=0.
LCMClusterEndpoint specifies the host and port of a cluster's apiserver.
LCMClusterImages specifies the images to use in the child cluster.
LCMClusterList contains a list of LCMCluster objects.
LCMClusterMKEUpgradeStatus is the Schema for the LCMMachineMKEUpgradeStatuses API +k8s:openapi-gen=true.
LCMClusterMKEUpgradeStatusList contains a list of LCMClusterMKEUpgradeStatus.
LCMClusterSpec defines the desired state of LCMCluster.
LCMClusterState is the Schema for the lcmclusterstate API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="clusterName",type="string",JSONPath=".spec.clusterName",description="Cluster Name",priority=0 +kubebuilder:printcolumn:name="type",type="string",JSONPath=".spec.type",description="Type",priority=0 +kubebuilder:printcolumn:name="arg",type="string",JSONPath=".spec.arg",description="Arg",priority=1 +kubebuilder:printcolumn:name="value",type="string",JSONPath=".spec.value",description="Arg",priority=1 +kubebuilder:printcolumn:name="actualValue",type="string",JSONPath=".status.value",description="Actual Value",priority=2 +kubebuilder:printcolumn:name="attempt",type="integer",JSONPath=".status.attempt",description="Attempt",priority=2 +kubebuilder:printcolumn:name="message",type="string",JSONPath=".status.message",description="Message",priority=2.
LCMClusterStateList contains a list of LCMClusterState objects.
LCMClusterStateSpec defines a desired state of a child cluster.
LCMClusterStateStatus defines the desired state of a child cluster.
LCMClusterStatus defines the observed state of LCMCluster.
LCMClusterUpgradeStatus is the Schema for the lcmclusterupgradestatuses API +k8s:openapi-gen=true.
LCMClusterUpgradeStatusList contains a list of LCMClusterUpgradeStatus.
No description provided by the author
No description provided by the author
LCMMachine is the Schema for the lcmmachines API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="clusterName",type="string",JSONPath=".spec.clusterName",description="Cluster Name",priority=0 +kubebuilder:printcolumn:name="type",type="string",JSONPath=".spec.type",description="Type",priority=0 +kubebuilder:printcolumn:name="state",type="string",JSONPath=".status.state",description="State",priority=0 +kubebuilder:printcolumn:name="internalIP",type="string",JSONPath=".status.addresses[?(@.type==\"InternalIP\")].address",description="Internal IP",priority=1 +kubebuilder:printcolumn:name="hostname",type="string",JSONPath=".status.addresses[?(@.type==\"Hostname\")].address",description="Hostname",priority=1 +kubebuilder:printcolumn:name="agentVersion",type="string",JSONPath=".status.agentVersion",description="Agent Version",priority=1.
LCMMachineAgentUpgradeStatus is the Schema for the LCMMachineAgentUpgradeStatuses API +k8s:openapi-gen=true.
LCMMachineAgentUpgradeStatusList contains a list of LCMMachineAgentUpgradeStatus.
LCMMachineList contains a list of LCMMachine objects.
LCMMachineSpec defines the desired state of LCMMachine.
LCMMachineStatus defines the observed state of LCMMachine.
LCMMachineUpgradeDrainStatus is the Schema for the LCMMachineUpgradeDrainStatus API +k8s:openapi-gen=true.
LCMMachineUpgradeDrainStatusList contains a list of LCMMachineUpgradeDrainStatus.
LCMOIDCSettings specifies settings for OpenID.
LCMStateItem defines a part of a machine state that can be represented e.g.
LCMStateItemStatus defines a status for LCMStateItem.
LicenseSecret -.
LicenseSecretItem -.
LicenseSubscriptionSpec defines the desired state of RHELLicenseSubscription.
LicenseSubscriptionStatus defines the observed state of RHELLicenseSubscription.
No description provided by the author
No description provided by the author
Network interface controller.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=nodemaintenancerequests,scope=Cluster.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=nodeworkloadlocks,scope=Cluster +kubebuilder:subresource:status.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
No description provided by the author
No description provided by the author
RHELLicenseSubscription the LCMMachine corresponded license object +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="type",type="string",JSONPath=".spec.type",description="Type",priority=0.
RHELLicenseSubscriptionList contains a list of RHELLicenseSubscription objects.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
LCMCLusterStateType denotes a type of the child cluster state.
No description provided by the author
No description provided by the author
LCMMachineType denotes a type of the machine.
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
No description provided by the author
No description provided by the author
No description provided by the author