-
Notifications
You must be signed in to change notification settings - Fork 76
/
README.md.gotmpl
79 lines (53 loc) · 1.98 KB
/
README.md.gotmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
vald-helm-operator
===
This is a Helm chart to install vald-helm-operator.
Current chart version is `{{ template "chart.version" . }}`
Table of Contents
---
- [Install](#install)
- [Custom Resources](#custom-resources)
- [ValdRelease](#valdrelease)
- [ValdHelmOperatorRelease](#valdhelmoperatorrelease)
- [Configuration](#configuration)
Install
---
Add Vald Helm repository
$ helm repo add vald https://vald.vdaas.org/charts
Run the following command to install the chart,
$ helm install vald-helm-operator-release vald/vald-helm-operator
Upgrading the version
---
Please upgrade the CRDs first because Helm doesn't have a support to upgrade CRDs.
$ kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/{{ template "chart.version" . }}/charts/vald-helm-operator/crds/valdrelease.yaml
$ kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/{{ template "chart.version" . }}/charts/vald-helm-operator/crds/valdhelmoperatorrelease.yaml
After upgrading CRDs, you can upgrade the operator.
If you're using `valdhelmoperatorrelease` (or `vhor`) resource, please update the `spec.image.tag` field of it.
$ kubectl patch vhor vhor-release -p '{"spec":{"image":{"tag":"{{ template "chart.version" . }}"}}}'
On the other hand, please update the operator's deployment manually.
Custom Resources
---
### ValdRelease
This is a custom resource that represents values of the Vald Helm chart.
Example:
```yaml
apiVersion: vald.vdaas.org/v1
kind: ValdRelease
metadata:
name: vald-cluster
# the values of Helm chart for Vald can be placed under the `spec` field.
spec: {}
```
### ValdHelmOperatorRelease
This is a custom resource that represents values of the vald-helm-operator Helm chart.
Example:
```yaml
apiVersion: vald.vdaas.org/v1
kind: ValdHelmOperatorRelease
metadata:
name: vald-helm-operator-release
# the values of Helm chart for vald-helm-operator can be placed under the `spec` field.
spec: {}
```
Configuration
---
{{ template "chart.valuesTable" . }}