Skip to content

Commit b4eacc0

Browse files
trainer: Add Helm chart installation instructions for data cache (#4281)
* docs: add Helm chart installation instructions for data cache. Signed-off-by: Khushi Agrawal <[email protected]> * docs: address review feedback for data-cache installation Signed-off-by: khushiiagrawal <[email protected]> --------- Signed-off-by: Khushi Agrawal <[email protected]> Signed-off-by: khushiiagrawal <[email protected]>
1 parent fb5cfa5 commit b4eacc0

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

content/en/docs/components/trainer/user-guides/data-cache.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,33 @@ For the latest changes run:
6868
kubectl apply --server-side -k "https://github.com/kubeflow/trainer.git/manifests/overlays/data-cache?ref=master"
6969
```
7070

71+
### Install with Helm Charts
72+
73+
Alternatively, you can install the data cache resources using Helm charts:
74+
75+
```bash
76+
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer \
77+
--set dataCache.enabled=true \
78+
--namespace kubeflow-system \
79+
--create-namespace \
80+
--version ${VERSION#v}
81+
```
82+
83+
For the available Helm values to configure data cache, see the
84+
[kubeflow-trainer Helm chart documentation](https://github.com/kubeflow/trainer/tree/master/charts/kubeflow-trainer).
85+
7186
{{% alert title="Note" color="info" %}}
7287

73-
The above command will install RBAC in the `default` namespace. If you want to create TrainJobs
74-
in other Kubernetes namespace, run this:
88+
When `dataCache.lws.install` is set to `true` (the default), LeaderWorkerSet will be installed
89+
automatically. Set it to `false` if LeaderWorkerSet controller/webhook is already installed
90+
in your cluster.
91+
92+
{{% /alert %}}
93+
94+
{{% alert title="Warning" color="warning" %}}
95+
96+
Helm charts don't install RBAC in the user namespace. You have to deploy RBAC separately
97+
in each namespace where you want to create TrainJobs:
7598

7699
```bash
77100
kubectl apply --server-side -n <NAMESPACE> -k "https://github.com/kubeflow/trainer.git/manifests/overlays/data-cache/namespace-rbac"

0 commit comments

Comments
 (0)