11.5. Troubleshooting clusters that use the Cluster API
To help avoid or recover from issues in a cluster that supports migrating resources to use a different authoritative API, you can learn how to recognize these issues. Generally, troubleshooting steps for problems with the Cluster API are similar to those steps for problems with the Machine API.
Managing machines with the Cluster API is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
The Cluster CAPI Operator and its operands are provisioned in the openshift-cluster-api namespace, whereas the Machine API uses the openshift-machine-api namespace. When using oc commands that reference a namespace, be sure to reference the correct one.
For clusters that use the Cluster API, OpenShift CLI (oc) commands prioritize Cluster API objects over Machine API objects.
This behavior impacts any oc command that acts upon any object that is represented in both the Cluster API and the Machine API. This explanation uses the oc delete machine command, which deletes a machine, as an example.
- Cause
When you run an
occommand,occommunicates with the Kube API server to determine which objects to act upon. The Kube API server uses the first installed custom resource definition (CRD) it encounters alphabetically when anoccommand is run.CRDs for Cluster API objects are in the
cluster.x-k8s.iogroup, while CRDs for Machine API objects are in themachine.openshift.iogroup. Because the lettercprecedes the lettermalphabetically, the Kube API server matches on the Cluster API object CRD. As a result, theoccommand acts upon Cluster API objects.- Consequence
Due to this behavior, the following unintended outcomes can occur on a cluster that uses the Cluster API:
-
For namespaces that contain both types of objects, commands such as
oc get machinereturn only Cluster API objects. -
For namespaces that contain only Machine API objects, commands such as
oc get machinereturn no results.
-
For namespaces that contain both types of objects, commands such as
- Workaround
-
You can ensure that
occommands act on the type of objects you intend by using the corresponding fully qualified name.
Prerequisites
-
You have access to the cluster using an account with
cluster-adminpermissions. -
You have installed the OpenShift CLI (
oc).
Procedure
To delete a Machine API machine, use the fully qualified name
machine.machine.openshift.iowhen running theoc delete machinecommand:$ oc delete machine.machine.openshift.io <machine_name>To delete a Cluster API machine, use the fully qualified name
machine.cluster.x-k8s.iowhen running theoc delete machinecommand:$ oc delete machine.cluster.x-k8s.io <machine_name>