Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add note about loading lvmd config file #788

Merged
merged 2 commits into from Nov 28, 2023
Merged

docs: add note about loading lvmd config file #788

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dedee96
docs: add note about loading lvmd config file
llamerada-jp Nov 28, 2023
eddaecf
Update docs/lvmd.md
llamerada-jp Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/lvmd.md
View file
Open in desktop
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