Chapter 3. Using Fence Agents Remediation
Chapter 3. Using Fence Agents Remediation You can use the Fence Agents Remediation Operator to automatically remediate unhealthy nodes, similar to the Self Node Remediation Operator. FAR is designed to run an existing set of upstream fencing agents on environments with a traditional API end-point, for example, IPMI, for power cycling cluster nodes, while their pods are quickly evicted based on the remediation strategy . The Fence Agents Remediation Operator is a "Rolling Stream" Operator, meaning updates are available asynchronously of OpenShift Container Platform releases. For more information, see OpenShift Operator Life Cycles on the Red Hat Customer Portal. 3.1. About the Fence Agents Remediation Operator The Fence Agents Remediation (FAR) Operator uses external tools to fence unhealthy nodes. These tools are a set of fence agents, where each fence agent can be used for different environments to fence a node, and using a traditional Application Programming Interface (API) call that reboots a node. By doing so, FAR can minimize downtime for stateful applications, restores compute capacity if transient failures occur, and increases the availability of workloads. FAR not only fences a node when it becomes unhealthy, it also tries to remediate the node from being unhealthy to healthy. It adds a taint to evict stateless pods, fences the node with a fence agent, and after a reboot, it completes the remediation with resource deletion to remove any remaining workloads (mostly stateful workloads). Adding the taint and deleting the workloads accelerates the workload rescheduling. The Operator watches for new or deleted custom resources (CRs) called FenceAgentsRemediation which trigger a fence agent to remediate a node, based on the CR's name. FAR uses the NodeHealthCheck controller to detect the health of a node in the cluster. When a node is identified as unhealthy, the NodeHealthCheck resource creates the FenceAgentsRemediation CR, based on the FenceAgentsRemediationTemplate CR, which then triggers the Fence Agents Remediation Operator. FAR uses a fence agent to fence a Kubernetes node. Generally, fencing is the process of taking unresponsive/unhealthy computers into a safe state, and isolating the computer. Fence agent is a software code that uses a management interface to perform fencing, mostly power-based fencing which enables power-cycling, reset, or turning off the computer. An example fence agent is fence_ipmilan which is used for Intelligent Platform Management Interface (IPMI) environments. apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediation metadata: name: node-name 1 namespace: openshift-workload-availability spec: remediationStrategy: <remediation_strategy> 2 1 The node-name should match the name of the unhealthy cluster node. 2 Specifies the remediation strategy for the nodes. For more information on the remediation strategies available, see the Understanding the Fence Agents Remediation Template configuration topic. The Operator includes a set of fence agents, that are also available in the Red Hat High Availability Add-On, which use a management interface, such as IPMI or an API, to provision/reboot a node for bare metal servers, virtual machines, and cloud platforms. 3.2. Installing the Fence Agents Remediation Operator by using the web console You can use the Red Hat OpenShift web console to install the Fence Agents Remediation Operator. Prerequisites Log in as a user with cluster-admin privileges. Procedure In the Red Hat OpenShift web console, navigate to Operators OperatorHub . Select the Fence Agents Remediation Operator, or FAR, from the list of available Operators, and then click Install . Keep the default selection of Installation mode and namespace to ensure that the Operator is installed to the openshift-workload-availability namespace. Click Install . Verification To confirm that the installation is successful: Navigate to the Operators Installed Operators page. Check that the Operator is installed in the openshift-workload-availability namespace and its status is Succeeded . If the Operator is not installed successfully: Navigate to the Operators Installed Operators page and inspect the Status column for any errors or failures. Navigate to the Workloads Pods page and check the log of the fence-agents-remediation-controller-manager pod for any reported issues. 3.3. Installing the Fence Agents Remediation Operator by using the CLI You can use the OpenShift CLI ( oc ) to install the Fence Agents Remediation Operator. You can install the Fence Agents Remediation Operator in your own namespace or in the openshift-workload-availability namespace. Prerequisites Install the OpenShift CLI ( oc ). Log in as a user with cluster-admin privileges. Procedure Create a Namespace custom resource (CR) for the Fence Agents Remediation Operator: Define the Namespace CR and save the YAML file, for example, workload-availability-namespace.yaml : apiVersion: v1 kind: Namespace metadata: name: openshift-workload-availability To create the Namespace CR, run the following command: USD oc create -f workload-availability-namespace.yaml Create an OperatorGroup CR: Define the OperatorGroup CR and save the YAML file, for example, workload-availability-operator-group.yaml : apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: workload-availability-operator-group namespace: openshift-workload-availability To create the OperatorGroup CR, run the following command: USD oc create -f workload-availability-operator-group.yaml Create a Subscription CR: Define the Subscription CR and save the YAML file, for example, fence-agents-remediation-subscription.yaml : apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: fence-agents-remediation-subscription namespace: openshift-workload-availability 1 spec: channel: stable name: fence-agents-remediation source: redhat-operators sourceNamespace: openshift-marketplace package: fence-agents-remediation 1 Specify the Namespace where you want to install the Fence Agents Remediation Operator, for example, the openshift-workload-availability outlined earlier in this procedure. You can install the Subscription CR for the Fence Agents Remediation Operator in the openshift-workload-availability namespace where there is already a matching OperatorGroup CR. To create the Subscription CR, run the following command: USD oc create -f fence-agents-remediation-subscription.yaml Verification Verify that the installation succeeded by inspecting the CSV resource: USD oc get csv -n openshift-workload-availability Example output NAME DISPLAY VERSION REPLACES PHASE fence-agents-remediation.v0.3.0 Fence Agents Remediation Operator 0.3.0 fence-agents-remediation.v0.2.1 Succeeded Verify that the Fence Agents Remediation Operator is up and running: USD oc get deployment -n openshift-workload-availability Example output NAME READY UP-TO-DATE AVAILABLE AGE fence-agents-remediation-controller-manager 2/2 2 2 110m 3.4. Configuring the Fence Agents Remediation Operator You can use the Fence Agents Remediation Operator to create the FenceAgentsRemediationTemplate Custom Resource (CR), which is used by the Node Health Check Operator (NHC). This CR defines the fence agent to be used in the cluster with all the required parameters for remediating the nodes. There may be many FenceAgentsRemediationTemplate CRs, at most one for each fence agent, and when NHC is being used it can choose the FenceAgentsRemediationTemplate as the remediationTemplate to be used for power-cycling the node. The FenceAgentsRemediationTemplate CR resembles the following YAML file: apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediationTemplate metadata: name: fence-agents-remediation-template-fence-ipmilan namespace: openshift-workload-availability spec: template: spec: agent: fence_ipmilan 1 nodeparameters: 2 --ipport: master-0-0: '6230' master-0-1: '6231' master-0-2: '6232' worker-0-0: '6233' worker-0-1: '6234' worker-0-2: '6235' sharedparameters: 3 '--action': reboot '--ip': 192.168.123.1 '--lanplus': '' '--password': password '--username': admin retryCount: '5' 4 retryInterval: '5s' 5 timeout: '60s' 6 1 Displays the name of the fence agent to be executed, for example, fence_ipmilan . 2 Displays the node-specific parameters for executing the fence agent, for example, ipport . 3 Displays the cluster-wide parameters for executing the fence agent, for example, username . 4 Displays the number of times to retry the fence agent command in case of failure. The default number of attempts is 5. 5 Displays the interval between retries in seconds. The default is 5 seconds. 6 Displays the timeout for the fence agent command. The default is 60 seconds. For values of 60 seconds or greater, the timeout value is expressed in both minutes and seconds in the YAML file. 3.4.1. Understanding the Fence Agents Remediation Template configuration The Fence Agents Remediation Operator also creates the FenceAgentsRemediationTemplate Custom Resource Definition (CRD). This CRD defines the remediation strategy for the nodes that is aimed to recover workloads faster. The following remediation strategies are available: ResourceDeletion This remediation strategy removes the pods on the node. This strategy recovers workloads faster. OutOfServiceTaint This remediation strategy implicitly causes the removal of the pods and associated volume attachments on the node. It achieves this by placing the OutOfServiceTaint taint on the node. The OutOfServiceTaint strategy also represents a non-graceful node shutdown. A non-graceful node shutdown occurs when a node is shut down and not detected, instead of triggering an in-operating system shutdown. This strategy has been supported on technology preview since OpenShift Container Platform version 4.13, and on general availability since OpenShift Container Platform version 4.15. The FenceAgentsRemediationTemplate CR resembles the following YAML file: apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediationTemplate metadata: name: fence-agents-remediation-<remediation_object>-deletion-template 1 namespace: openshift-workload-availability spec: template: spec: remediationStrategy: <remediation_strategy> 2 1 Specifies the type of remediation template based on the remediation strategy. Replace <remediation_object> with either resource or taint ; for example, fence-agents-remediation-resource-deletion-template . 2 Specifies the remediation strategy. The remediation strategy can either be ResourceDeletion or OutOfServiceTaint . 3.5. Troubleshooting the Fence Agents Remediation Operator 3.5.1. General troubleshooting Issue You want to troubleshoot issues with the Fence Agents Remediation Operator. Resolution Check the Operator logs. USD oc logs <fence-agents-remediation-controller-manager-name> -c manager -n <namespace-name> 3.5.2. Unsuccessful remediation Issue An unhealthy node was not remediated. Resolution Verify that the FenceAgentsRemediation CR was created by running the following command: USD oc get far -A If the NodeHealthCheck controller did not create the FenceAgentsRemediation CR when the node turned unhealthy, check the logs of the NodeHealthCheck controller. Additionally, ensure that the NodeHealthCheck CR includes the required specification to use the remediation template. If the FenceAgentsRemediation CR was created, ensure that its name matches the unhealthy node object. 3.5.3. Fence Agents Remediation Operator resources exist after uninstalling the Operator Issue The Fence Agents Remediation Operator resources, such as the remediation CR and the remediation template CR, exist after uninstalling the Operator. Resolution To remove the Fence Agents Remediation Operator resources, you can delete the resources by selecting the "Delete all operand instances for this operator" checkbox before uninstalling. This checkbox feature is only available in Red Hat OpenShift since version 4.13. For all versions of Red Hat OpenShift, you can delete the resources by running the following relevant command for each resource type: USD oc delete far <fence-agents-remediation> -n <namespace> USD oc delete fartemplate <fence-agents-remediation-template> -n <namespace> The remediation CR far must be created and deleted by the same entity, for example, NHC. If the remediation CR far is still present, it is deleted, together with the FAR operator. The remediation template CR fartemplate only exists if you use FAR with NHC. When the FAR operator is deleted using the web console, the remediation template CR fartemplate is also deleted. 3.6. Gathering data about the Fence Agents Remediation Operator To collect debugging information about the Fence Agents Remediation Operator, use the must-gather tool. For information about the must-gather image for the Fence Agents Remediation Operator, see Gathering data about specific features . 3.7. Agents supported by the Fence Agents Remediation Operator This section describes the agents currently supported by the Fence Agents Remediation Operator. Most of the supported agents can be grouped by the node's hardware proprietary and usage, as follows: BareMetal Virtualization Intel HP IBM VMware Cisco APC Dell Other Table 3.1. BareMetal - Using the Redfish management interface is recommended, unless it is not supported. Agent Description fence_redfish An I/O Fencing agent that can be used with Out-of-Band controllers that support Redfish APIs. fence_ipmilan [a] An I/O Fencing agent that can be used with machines controlled by IPMI . [a] This description also applies for the agents fence_ilo3 , fence_ilo4 , fence_ilo5 , fence_imm , fence_idrac , and fence_ipmilanplus . Table 3.2. Virtualization Agent Description fence_rhevm An I/O Fencing agent that can be used with RHEV-M REST API to fence virtual machines. Table 3.3. Intel Agent Description fence_amt_ws An I/O Fencing agent that can be used with Intel AMT (WS). fence_intelmodular An I/O Fencing agent that can be used with Intel Modular device (tested on Intel MFSYS25, should also work with MFSYS35). Table 3.4. HP - agents for the iLO management interface or BladeSystem. Agent Description fence_ilo [a] An I/O Fencing agent that can be used for HP servers with the Integrated Light Out ( iLO ) PCI card. [a] This description also applies for the agent fence_ilo2 . Table 3.5. IBM Agent Description fence_ibmblade An I/O Fencing agent that can be used with IBM BladeCenter chassis. fence_ipdu An I/O Fencing agent that can be used with the IBM iPDU network power switch. Table 3.6. VMware Agent Description fence_vmware_rest An I/O Fencing agent that can be used with VMware API to fence virtual machines. fence_vmware_soap An I/O Fencing agent that can be used with the virtual machines managed by VMWare products that have SOAP API v4.1+. Table 3.7. Cisco Agent Description fence_cisco_mds An I/O Fencing agent that can be used with any Cisco MDS 9000 series with SNMP enabled device. fence_cisco_ucs An I/O Fencing agent that can be used with Cisco UCS to fence machines. Table 3.8. APC Agent Description fence_apc_snmp [a] An I/O Fencing agent that can be used with the APC network power switch or Tripplite PDU devices. [a] This description also applies for the fence_tripplite_snmp agent. Table 3.9. Other - agents for usage not listed in the tables. Agent Description fence_compute A resource that can be used to tell Nova that compute nodes are down and to reschedule flagged instances. fence_eaton_snmp An I/O Fencing agent that can be used with the Eaton network power switch. fence_emerson An I/O Fencing agent that can be used with MPX and MPH2 managed rack PDU. fence_epsr2 [a] An I/O Fencing agent that can be used with the ePowerSwitch 8M+ power switch to fence connected machines. fence_evacuate A resource that can be used to reschedule flagged instances. fence_heuristics_ping A resource that can be used with ping-heuristics to control execution of another fence agent on the same fencing level. fence_ifmib An I/O Fencing agent that can be used with any SNMP IF-MIB capable device. fence_kdump An I/O Fencing agent that can be used with the kdump crash recovery service. fence_mpath An I/O Fencing agent that can be used with SCSI-3 persistent reservations to control access multipath devices. fence_sbd An I/O Fencing agent that can be used in environments where sbd can be used (shared storage). fence_scsi An I/O Fencing agent that can be used with SCSI-3 persistent reservations to control access to shared storage devices. [a] This description also applies for the fence_eps agent. 3.8. Additional resources Using Operator Lifecycle Manager on restricted networks . Deleting Operators from a cluster
apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediation metadata: name: node-name 1 namespace: openshift-workload-availability spec: remediationStrategy: <remediation_strategy> 2 apiVersion: v1 kind: Namespace metadata: name: openshift-workload-availability oc create -f workload-availability-namespace.yaml apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: workload-availability-operator-group namespace: openshift-workload-availability oc create -f workload-availability-operator-group.yaml apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: fence-agents-remediation-subscription namespace: openshift-workload-availability 1 spec: channel: stable name: fence-agents-remediation source: redhat-operators sourceNamespace: openshift-marketplace package: fence-agents-remediation oc create -f fence-agents-remediation-subscription.yaml oc get csv -n openshift-workload-availability NAME DISPLAY VERSION REPLACES PHASE fence-agents-remediation.v0.3.0 Fence Agents Remediation Operator 0.3.0 fence-agents-remediation.v0.2.1 Succeeded oc get deployment -n openshift-workload-availability NAME READY UP-TO-DATE AVAILABLE AGE fence-agents-remediation-controller-manager 2/2 2 2 110m apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediationTemplate metadata: name: fence-agents-remediation-template-fence-ipmilan namespace: openshift-workload-availability spec: template: spec: agent: fence_ipmilan 1 nodeparameters: 2 --ipport: master-0-0: '6230' master-0-1: '6231' master-0-2: '6232' worker-0-0: '6233' worker-0-1: '6234' worker-0-2: '6235' sharedparameters: 3 '--action': reboot '--ip': 192.168.123.1 '--lanplus': '' '--password': password '--username': admin retryCount: '5' 4 retryInterval: '5s' 5 timeout: '60s' 6 apiVersion: fence-agents-remediation.medik8s.io/v1alpha1 kind: FenceAgentsRemediationTemplate metadata: name: fence-agents-remediation-<remediation_object>-deletion-template 1 namespace: openshift-workload-availability spec: template: spec: remediationStrategy: <remediation_strategy> 2 oc logs <fence-agents-remediation-controller-manager-name> -c manager -n <namespace-name> oc get far -A oc delete far <fence-agents-remediation> -n <namespace> oc delete fartemplate <fence-agents-remediation-template> -n <namespace>