Skip to content

Commit 2618342

Browse files
fix example + docs
1 parent ccbf457 commit 2618342

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,37 @@ The [eks-https-loadbalancer](examples/eks-https-loadbalancer) example also shows
9999

100100
Profiles are a Kubeflow abstraction that lets you securely isolate users from each other. See the [Kubeflow docs on profiles](https://www.kubeflow.org/docs/components/central-dash/profiles/)
101101

102+
### Manage your instance with GitOps
103+
104+
Lots of the config used to define your Kubeflow instance has has no dependency on
105+
Terraform resource outputs such as role ARNs.
106+
107+
These may best be stored in a git repo and referenced using Argo's [multiple sources feature](https://argo-cd.readthedocs.io/en/stable/user-guide/multiple_sources/)
108+
109+
Using this approach you can invoke this terraform module (or the underlying bootstrap helm chart) with config like the following that combines injected values with values from a git repo:
110+
111+
```yaml
112+
sources:
113+
# - repoURL: 'https://github.com/treebeardtech/gitops-bridge-argocd-control-plane-template'
114+
# targetRevision: dev
115+
# ref: values
116+
- repoURL: ghcr.io/treebeardtech
117+
targetRevision: 0.1-2024-03-08-T12-25-15
118+
chart: kubeflow-argo-apps
119+
helm:
120+
ignoreMissingValueFiles: true
121+
# valueFiles:
122+
# - $values/some-dir/my-values-file.yaml # use your own gitops values file
123+
values: |
124+
# pass in terraform outputs from cloud resources
125+
# e.g. ARNs, node labels, etc.
126+
```
127+
102128
### Teardown
103129
104130
1. Manually remove any manually created Kubeflow resources, e.g. Notebook Servers and Volumes
105131
2. Remove the terraform module, e.g. with `terraform destroy` if you have installed directly from CLI
106-
3. Clean up remaining resources, e.g. Istio leaves behind some secrets that can prevent successful re-installation.
132+
3. Clean up remaining resources, e.g. Istio leaves behind some secrets that can prevent successful re-installation. You may also want to clear out CRDs, persistent volumes and namespaces
107133

108134
## Troubleshooting
109135

examples/k3s-existing-istio/main.tf

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,13 @@ module "treebeardkf" {
104104
source = "../.."
105105
kubeflow_values = [
106106
<<EOF
107+
sources:
108+
- repoURL: ghcr.io/treebeardtech
109+
targetRevision: 0.1-2024-03-08-T12-25-15
110+
chart: kubeflow-argo-apps
111+
helm:
112+
ignoreMissingValueFiles: true
113+
values: |
107114
certManager:
108115
enabled: false
109116
istioBase:

0 commit comments

Comments
 (0)