Skip to content

Commit

Permalink
docs: add a note explaining the need for topolvm.io/webhook=ignore
Browse files Browse the repository at this point in the history
In getting started, it is not clear why `topolvm.io/webhook=ignore` is
needed. Add a note explaining it.

Closes: #907

Signed-off-by: Yuma Ogami <yuma-ogami@cybozu.co.jp>
  • Loading branch information
cupnes committed May 23, 2024
1 parent bfecbf4 commit 2275580
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ kubectl label namespace topolvm-system topolvm.io/webhook=ignore
kubectl label namespace kube-system topolvm.io/webhook=ignore
```

> [!NOTE]
> The label `topolvm.io/webhook=ignore` is set here to prevent the triggering of TopoLVM's mutating webhooks when pods and pvcs are created in the topolvm-system and kube-system namespaces. These webhooks depend on the topolvm-controller. Therefore, the webhooks should not be activated during TopoLVM's startup process to avoid causing it to become stuck.
Then, install TopoLVM with the release name `topolvm`.

```sh
Expand Down

0 comments on commit 2275580

Please sign in to comment.