Skip to content

Commit 679423a

Browse files
committed
Elaborate on hostdefiner docs
1 parent a8b7eb5 commit 679423a

File tree

6 files changed

+39
-11
lines changed

6 files changed

+39
-11
lines changed

docs/content/configuration/configuring_hostdefiner.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,29 @@
55

66
Some of the parameters within the HostDefiner custom resource are configurable. Use this information to help decide whether the parameters for your storage system need to be updated.
77

8-
Starting from 1.13.0 the configuation parameters are saved in the config map ibm-csi-hostdefiner-config and remain persistent on CSI software upgrade. The config map should be created in the same namespace as the pod.
9-
Applying configuration changes still requires host definer restart.
8+
Starting from 1.13.0 the configuation parameters are saved in the config map ibm-csi-hostdefiner-config and remain persistent on CSI software upgrade.
9+
10+
The old way, of adding the parameters in the hostdefiner yaml is obsolete!{: important}
11+
12+
The config map should be created in the same namespace as the pod.
13+
For the configuration changes to take effect, the host definer must be restarted (by deleting the hostdefiner pod).
1014

1115
Because the configuration is saved in a config map - it can be defined even before the upgrade to 1.13.0
1216

1317
Use standard configmap CLIs to update the configuration, examples below.
1418
All CLIs accept an optional -n parameter to specify the namepsace
1519

16-
Create/update a configuration parameter (replace key value with actual parameter setting):
20+
Create configmap in order to update a configuration parameter (replace "key" and "value" with actual parameter setting):
1721
```
1822
kubectl create configmap ibm-csi-hostdefiner-config --from-literal=key=value
1923
```
2024
The key may be any key from the below table, under Field. The possible values are also specified in the table.
2125

26+
More than one value can be specified, as needed. For example:
27+
```
28+
kubectl create configmap ibm-csi-hostdefiner-config --from-literal=connectivityType=fc --from-literal=portSet=portset64
29+
```
30+
2231
Get a ConfigMap
2332
```
2433
kubectl get configmap ibm-csi-hostdefiner-config
@@ -31,7 +40,7 @@ Delete a ConfigMap:
3140

3241
Delete a ConfigMap entry:
3342

34-
There's no simple command to delete an entry. You can either use:
43+
In order to remove an entry or update the configmap, one can either use:
3544
```
3645
kubectl edit configmap ibm-csi-hostdefiner-config
3746
```

docs/content/installation/install_hostdefiner_github.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
2+
{{site.data.keyword.attribute-definition-list}}
3+
14
# Installing the host definer with GitHub
25

36
The host definer for IBM® block storage CSI driver can be installed directly with GitHub.
47

8+
Before installing or upgrading, if one wants non-default configuration settings, a configmap must be created See [Configuring the host definer](../configuration/configuring_hostdefiner.md). The old way of setting parameters in yaml is obsolete.{: important}
9+
10+
511
Use the following steps to install the HostDefiner custom resource, with [GitHub](https://github.com/IBM/ibm-block-csi-operator).
612

713
1. Download the custom resource manifest from [GitHub](https://github.com/IBM/ibm-block-csi-operator).
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
2+
{{site.data.keyword.attribute-definition-list}}
3+
14
# Installing the host definer with the OpenShift web console
25

36
When using the Red Hat® OpenShift® Container Platform, the HostDefiner custom resource can be installed directly from OpenShift Container Platform web console, through the OperatorHub.
47

8+
Before installing or upgrading, if one wants non-default configuration settings, a configmap must be created See [Configuring the host definer](../configuration/configuring_hostdefiner.md). The old way of setting parameters in yaml is obsolete.
9+
{: .important}
10+
511
1. From the web console, navigate to the **IBM block storage CSI driver operator** within your project namespace.
612

713
2. From the IBM block storage CSI Host Definer driver tab, click Create `HostDefiner`.
814

9-
A YAML file opens in the web console. This file can be left as-is, or edited as needed. For more information, see [Configuring the host definer](../configuration/configuring_hostdefiner.md).
10-
1115
3. After everything is created, wait until the **Status** is _Running_.

docs/content/installation/install_hostdefiner_operatorhub.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
# Installing the host definer with OperatorHub.io
55

6+
Before installing or upgrading, if one wants non-default configuration settings, a configmap must be created See [Configuring the host definer](../configuration/configuring_hostdefiner.md). The old way of setting parameters in yaml is obsolete.
7+
{: .important}
8+
9+
610
When using OperatorHub.io, the host definer can be installed directly from the OperatorHub.io website.
711

812
From [IBM block storage CSI driver operator](https://operatorhub.io/operator/ibm-block-csi-operator-community) on OperatorHub.io, apply the HostDefiner custom resource definition yaml provided. For more information, see [Configuring the host definer](../configuration/configuring_hostdefiner.md).

docs/content/release_notes/whats_new.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
{{site.data.keyword.attribute-definition-list}}
3+
14
# What's new in 1.13.0
25

36
IBM® block storage CSI driver 1.13.0 adds support for:
@@ -14,8 +17,4 @@ For information about the resolved issues in version 1.13.0, see [1.13.0](change
1417
If you have any configuration changes that you want saved over upgrade, notice the following.{: attention}
1518

1619
For configuration persistancy over upgrade, a config map procedure was added:
17-
Prior to upgrading to IBM® block storage CSI driver 1.13.0 (or above) from releases before 1.13.0, please create a configmap with your existing changes, for example:
18-
`kubectl create configmap ibm-csi-hostdefiner-config --from-literal=portSet=portset64`
19-
If you have more than one configuration change, you can add more `--from-literal=key=value` at the end of the above line. This configuration will be saved over upgrade.
20-
21-
More info regarding this configmap in [Configuring the host definer](../configuration/configuring_hostdefiner.md)
20+
Prior to upgrading to IBM® block storage CSI driver 1.13.0 (or above) from releases before 1.13.0, please create a configmap with your existing changes. Please refer to [Configuring the host definer](../configuration/configuring_hostdefiner.md)

docs/content/using/using_hostdefinition_labels.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Please refer to the host definer configuration page for more information.
1010

1111
Adding labels to nodes allows for greater control over the system nodes, when using dynamic host definition.
1212

13+
## Setting node to be managed by hostdefiner
14+
To set a node to be managed by hostdefiner, meaning that hosts will be created for this node, label the node with `hostdefiner.block.csi.ibm.com/manage-node=true`
15+
```
16+
kubectl label node <node-name1> <node-name2> hostdefiner.block.csi.ibm.com/manage-node=true
17+
```
18+
1319
## Blocking a specific node definition from being deleted
1420

1521
To block a specific host definition from being deleted by the host definer, you can add the following label to the node: `hostdefiner.block.csi.ibm.com/avoid-deletion=true`.

0 commit comments

Comments
 (0)