-
Notifications
You must be signed in to change notification settings - Fork 554
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add initial design notes for the Health Checker
Signed-off-by: Niels de Vos <[email protected]>
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Suport for CSI `VolumeCondition` aka Volume Health Checker | ||
|
||
## health-checker API | ||
|
||
Under `internal/health-checker` the Manager for health-checking is | ||
implemented. The Manager can start a checking process for a given path, return | ||
the (un)healthy state and stop the checking process when the volume is not | ||
needed anymore. | ||
|
||
The Manager is responsible for creating a suitble checker for the requested | ||
path. If the path a s block-device, the BlockChecker should be created. For a | ||
filesystem path (directory), the FileChecker is appropriate. | ||
|
||
## CephFS | ||
|
||
The health-checker writes to the file `csi-volume-condition.ts` in the root of | ||
the volume. This file containse a JSON formatted timestamp. | ||
|
||
A new `data` directory is introduced for newly created volumes. During the | ||
`NodeStageVolume` call the root of the volume is mounted, and the `data` | ||
directory is bind-mounted inside the container when `NodePublishVolume` is | ||
called. | ||
|
||
The `data` directory makes it possible to place Ceph-CSI internal files in the | ||
root of the volume, without that the user/application has access to it. |