Skip to content

Commit 3caaa1c

Browse files
docs: cockroach helm install without wait (#155)
* cockroach helm install without wait Do not use the "--wait" option because the init is done by a post-install hook and without the init done the PODs will not start, so you would find yourself locked inside an infinite loop (db pods not working because of missing init and init job not starting because of db pods not working) * improve readability * improve readability * consistent naming --------- Co-authored-by: Elio Bischof <[email protected]>
1 parent 2ef2c6e commit 3caaa1c

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

examples/3-cockroach-insecure/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,19 @@ Also, you deploy [a correctly configured ZITADEL](https://artifacthub.io/package
1111
```bash
1212
# Install Cockroach
1313
helm repo add cockroachdb https://charts.cockroachdb.com/
14-
helm install --wait db cockroachdb/cockroachdb --version 11.2.1 --values https://raw.githubusercontent.com/zitadel/zitadel-charts/main/examples/3-cockroach-insecure/cockroach-values.yaml
14+
# Beware that the "--wait" option doesn't work with the CockroachDB chart (read more in note below).
15+
helm install db cockroachdb/cockroachdb --version 11.2.1 --values https://raw.githubusercontent.com/zitadel/zitadel-charts/main/examples/3-cockroach-insecure/cockroach-values.yaml
1516

1617
# Install ZITADEL
1718
helm repo add zitadel https://charts.zitadel.com
1819
helm install my-zitadel zitadel/zitadel --values https://raw.githubusercontent.com/zitadel/zitadel-charts/main/examples/3-cockroach-insecure/zitadel-values.yaml
1920
```
2021

22+
> [!NOTE]
23+
> The --wait option doesn't work with the Cockroach chart, because its init job is done by a post-install hook.
24+
> With --wait, the installation is only done when the Cockroach pods are ready and the init job only starts when the installation is done.
25+
> This is a deadlock, because the Cockroach pods don't become ready without the Cockroach init job having completed.
26+
2127
When ZITADEL is ready, you can access the GUI via port-forwarding:
2228

2329
```bash

0 commit comments

Comments
 (0)