Skip to content

Commit 8e59158

Browse files
Nate Thorntonbdevcich
andauthored
Finalize NNF Fencing documentation (#23)
* Finalize NNF Fencing documentation Signed-off-by: Nate Thornton <nate.thornton@hpe.com> Co-authored-by: Blake Devcich <89158881+bdevcich-hpe@users.noreply.github.com>
1 parent 4af2b60 commit 8e59158

2 files changed

Lines changed: 23 additions & 221 deletions

File tree

docs/guides/ha-cluster/fence_nnf.py

Lines changed: 0 additions & 218 deletions
This file was deleted.

docs/guides/ha-cluster/readme.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,30 @@ The [Redfish fencing agent](https://github.com/ClusterLabs/fence-agents/tree/mai
3030
| -------- | ---------- |
3131
| `ip=[ADDRESS]` | The IP address or hostname of the HSS controller |
3232
| `port=80` | The Port of the HSS controller. Must be `80` |
33-
| `systems-uri=/redfish/v1/Systems/Node0` | The URI of the Systems object. Must be `/redfish/v1/Systems/Node0` |
33+
| `systems-uri=/redfish/v1/Systems/1` | The URI of the Systems object. Must be `/redfish/v1/Systems/1` |
3434
| `ssl-insecure=true` | Instructs the use of an insecure SSL exchange. Must be `true` |
3535
| `username=[USER]` | The user name for connecting to the HSS controller |
3636
| `password=[PASSWORD]` | the password for connecting to the HSS controller |
3737

38+
For example, setting up the Redfish fencing agent on `rabbit-compute-2` with the redfish service at `192.168.0.1`
39+
40+
```shell
41+
pcs stonith create rabbit-compute-2 fence_redfish pcmk_host_list=rabbit-compute-2 ip=192.168.0.1 systems-uri=/redfish/v1/Systems/1 username=root password=password ssl_insecure=true
42+
```
3843

3944
### NNF Fencing
4045

41-
!!! info
42-
NNF fencing agent is in active development; the description below is subject to change.
46+
#### Source
47+
The NNF Fencing agent is available at https://github.com/NearNodeFlash/fence-agents under the `nnf` branch.
48+
49+
```shell
50+
git clone https://github.com/NearNodeFlash/fence-agents --branch nnf
51+
```
52+
#### Build
53+
54+
Refer to the `NNF.md file` at the root directory of the fence-agents repository.
4355

56+
#### Setup
4457
Configure the NNF agent with the following parameters:
4558

4659
| Argument | Definition |
@@ -52,6 +65,13 @@ Configure the NNF agent with the following parameters:
5265
| `nnf-node-name=[NNF-NODE-NAME]` | Name of the NNF node as it is appears in the System Configuration |
5366
| `api-version=[VERSION]` | The API Version of the NNF Node resource. Defaults to "v1alpha1" |
5467

68+
For example, setting up the NNF fencing agent on `rabbit-node-1` with a kubernetes service API running at `192.168.0.1:6443` and the service token and certificate copied to `/etc/nnf/fence/`.
69+
70+
```
71+
pcs stonith create rabbit-node-1 fence_nnf pcmk_host_list=rabbit-node-1 kubernetes-service-host=192.168.0.1 kubernetes-service-port=6443 service-token-file=/etc/nnf/fence/service.token service-cert-file=/etc/nnf/fence/service.cert nnf-node-name=rabbit-node-1
72+
```
73+
74+
#### Recovery
5575
Since the NNF node is connected to 16 compute blades, careful coordination around fencing of a NNF node is required to minimize the impact of the outage. When a Rabbit node is fenced, the corresponding DWS Storage resource (`storages.dws.cray.hpe.com`) status changes. The workload manager must observe this change and follow the procedure below to recover from the fencing status.
5676

5777
1. Observed the `storage.Status` changed and that `storage.Status.RequiresReboot == True`

0 commit comments

Comments
 (0)