Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Beekhof <[email protected]>
  • Loading branch information
beekhof authored Jun 23, 2020
1 parent 0756412 commit c3dfcf0
Showing 1 changed file with 2 additions and 52 deletions.
54 changes: 2 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,3 @@
# Machine Remediation
# Machine Remediation has Moved

## Remediation Flow

![Remediation Flow](docs/remediation-flow.png)

## Architecture

The machine remediation contains components to monitor and remediate unhealthy machines for different platforms, it works on top of [machine-api-operator](https://github.com/openshift/machine-api-operator) controllers.

It contains:

* [machine-remediation](docs/machine-remediation.md) controller
* [node-reboot](docs/node-reboot.md)

## How to deploy

You can check the [GitHub releases](https://github.com/kubevirt/machine-remediation/releases) to get latest `yaml` file, that includes CRD's, RBAC rules and deployment and apply it to your cluster.

```bash
kubectl apply -f https://github.com/kubevirt/machine-remediation/releases/download/v0.4.3/machine-remediation.v0.4.3.yaml
```

Once the deployment finishes, create a `MachineHealthCheck` object and be sure to give it the `healthchecking.openshift.io/strategy: reboot` annotation that instructs the Machine Healthcheck controller to delegate remediation to us.

An example `MachineHealthCheck` object that covers all nodes in the cluster is as follows:

```yaml
apiVersion: machine.openshift.io/v1beta1
kind: MachineHealthCheck
metadata:
name: simple-example
namespace: openshift-machine-api
annotations:
healthchecking.openshift.io/strategy: reboot
spec:
selector:
matchLabels:
machine.openshift.io/cluster-api-machine-role: worker
unhealthyConditions:
- type: Ready
status: Unknown
timeout: 60s
```
## How to run e2e tests
You should have k8s or OpenShift environment with at least two worker nodes and run:
```bash
export KUBECONFIG=/dir/cluster/kubeconfig
make e2e-tests-run
```
See the [general documentation](https://github.com/openshift/cluster-api-provider-baremetal/blob/master/README.md#machine-remediation) and [in-depth details](https://github.com/openshift/cluster-api-provider-baremetal/blob/master/docs/remediation.md)

0 comments on commit c3dfcf0

Please sign in to comment.