Skip to content

Commit 7b36fd4

Browse files
committed
More helm docs
1 parent 9435689 commit 7b36fd4

File tree

1 file changed

+47
-3
lines changed
  • docs/Manual/Deployment/Kubernetes

1 file changed

+47
-3
lines changed

docs/Manual/Deployment/Kubernetes/Helm.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,33 @@ For example you can install the operator in a namespace other than
1111

1212
## Charts
1313

14+
The ArangoDB Kubernetes Operator is contained in two `helm` charts:
15+
16+
- `kube-arangodb` which contains the operator for the `ArangoDeployment`
17+
and `ArangoDeploymentReplication` resource types.
18+
- `kube-arangodb-storage` which contains the operator for the `ArangoLocalStorage`
19+
resource type.
20+
21+
The `kube-arangodb-storage` only has to be installed if your Kubernetes cluster
22+
does not already provide `StorageClasses` that use locally attached SSDs.
23+
1424
## Configurable values for ArangoDB Kubernetes Operator
1525

1626
The following values can be configured when installing the
1727
ArangoDB Kubernetes Operator with `helm`.
1828

19-
### Both charts
29+
Values are passed to `helm` using an `--set=<key>=<value>` argument passed
30+
to the `helm install` or `helm upgrade` command.
31+
32+
### Values applicable to both charts
2033

2134
| Key | Type | Description
2235
|-------------------|--------|-----|
2336
| Image | string | Override the docker image used by the operators
2437
| ImagePullPolicy | string | Override the image pull policy used by the operators. See [Updating Images](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for details.
2538
| RBAC.Create | bool | Set to `true` (default) to create roles & role bindings.
2639

27-
### `kube-arangodb` chart
40+
### Values applicable to the `kube-arangodb` chart
2841

2942
| Key | Type | Description
3043
|-------------------|--------|-----|
@@ -38,10 +51,41 @@ ArangoDB Kubernetes Operator with `helm`.
3851
| DeploymentReplication.Operator.ServiceAccountName | string | Name of the `ServiceAccount` used to run the `ArangoDeploymentReplication` operator
3952
| DeploymentReplication.Operator.ServiceType | string | Type of `Service` created for the dashboard of the `ArangoDeploymentReplication` operator
4053

41-
### `kube-arangodb-storage` chart
54+
### Values applicable to the `kube-arangodb-storage` chart
4255

4356
| Key | Type | Description
4457
|-------------------|--------|-----|
4558
| Storage.User.ServiceAccountName | string | Name of the `ServiceAccount` that is the subject of the `RoleBinding` of users of the `ArangoLocalStorage` operator
4659
| Storage.Operator.ServiceAccountName | string | Name of the `ServiceAccount` used to run the `ArangoLocalStorage` operator
4760
| Storage.Operator.ServiceType | string | Type of `Service` created for the dashboard of the `ArangoLocalStorage` operator
61+
62+
## Alternate namespaces
63+
64+
The `kube-arangodb` chart supports deployment into a non-default namespace.
65+
66+
To install the `kube-arangodb` chart is a non-default namespace, use the `--namespace`
67+
argument like this.
68+
69+
```bash
70+
helm install --namespace=mynamespace kube-arangodb.tgz
71+
```
72+
73+
Note that since the operators claim exclusive access to a namespace, you can
74+
install the `kube-arangodb` chart in a namespace once.
75+
You can install the `kube-arangodb` chart in multiple namespaces. To do so, run:
76+
77+
```bash
78+
helm install --namespace=namespace1 kube-arangodb.tgz
79+
helm install --namespace=namespace2 kube-arangodb.tgz
80+
```
81+
82+
The `kube-arangodb-storage` chart is always installed in the `kube-system` namespace.
83+
84+
## Common problems
85+
86+
### Error: no available release name found
87+
88+
This error is given by `helm install ...` in some cases where it has
89+
insufficient permissions to install charts.
90+
91+
For various ways to work around this problem go to [this Stackoverflow article](https://stackoverflow.com/questions/43499971/helm-error-no-available-release-name-found).

0 commit comments

Comments
 (0)