Skip to content

Commit

Permalink
Merge pull request #788 from topolvm/add-lvmd-config-doc
Browse files Browse the repository at this point in the history 
docs: add note about loading lvmd config file
  • Loading branch information
@satoru-takeuchi
satoru-takeuchi committed Nov 28, 2023
2 parents b377e96 + eddaecf commit 47ee5b4
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/lvmd.md
View file
Expand Up @@ -46,15 +46,15 @@ device-classes:

The device-class settings can be specified in the following fields:

| Name | Type | Default | Description |
| ------------------- | ------ | ------- | ---------------------------------------------------------------------------------- |
| `name` | string | - | The name of a device-class. |
| `volume-group` | string | - | The group where this device-class creates the logical volumes. |
| `spare-gb` | uint64 | `10` | Storage capacity in GiB to be spared. |
| `default` | bool | `false` | A flag to indicate that this device-class is used by default. |
| `stripe` | uint | - | The number of stripes in the logical volume. |
| `stripe-size` | string | - | The amount of data that is written to one device before moving to the next device. |
| `lvcreate-options` | []string | - | Extra arguments to pass to `lvcreate`, e.g. `["--type=raid1"]`. |
| Name | Type | Default | Description |
| ------------------ | -------- | ------- | ---------------------------------------------------------------------------------- |
| `name` | string | - | The name of a device-class. |
| `volume-group` | string | - | The group where this device-class creates the logical volumes. |
| `spare-gb` | uint64 | `10` | Storage capacity in GiB to be spared. |
| `default` | bool | `false` | A flag to indicate that this device-class is used by default. |
| `stripe` | uint | - | The number of stripes in the logical volume. |
| `stripe-size` | string | - | The amount of data that is written to one device before moving to the next device. |
| `lvcreate-options` | []string | - | Extra arguments to pass to `lvcreate`, e.g. `["--type=raid1"]`. |

Note that striping can be configured both using the dedicated options (`stripe` and `stripe-size`) and `lvcreate-options`.
Either one can be used but not together since this would lead to duplicate arguments to `lvcreate`.
Expand All @@ -65,6 +65,8 @@ stripe: 2
lvcreate-options: ["--mirrors=1"]
```

After changing the configuration file, you need to restart lvmd to reflect this change. If lvmd is deployed as a DaemonSet, pod restart is needed after changing the corresponding ConfigMap. If you want to restart lvmd automatically after changing configuration, please use 3rd party tools like [Reloader](https://github.com/stakater/Reloader).

Spare capacity
--------------

Expand Down

0 comments on commit 47ee5b4

Please sign in to comment.