mirror of
https://github.com/arangodb/kube-arangodb.git
synced 2024-12-14 11:57:37 +00:00
206 lines
No EOL
3.9 KiB
Markdown
206 lines
No EOL
3.9 KiB
Markdown
# Introduction
|
|
|
|
Kubernetes ArangoDB Operator.
|
|
|
|
# Chart Details
|
|
|
|
Chart will install fully operational ArangoDB Kubernetes Operator.
|
|
|
|
# Resources Required
|
|
|
|
In default installation deployment with 1 pod will be created. The operator pod require 256MB of ram and 250m of CPU.
|
|
|
|
# Installing the Chart
|
|
|
|
Chart can be installed in two methods:
|
|
- With all Operators in single Helm Release
|
|
- One Helm Release per Operator
|
|
|
|
Possible Operators:
|
|
- `ArangoDeployment` - enabled by default
|
|
- `ArangoDeploymentReplications` - enabled by default
|
|
- `ArangoLocalStorage` - disabled by default
|
|
- `ArangoBackup` - disabled by default
|
|
- `ArangoJob` - disabled by default
|
|
- `ArangoClusterSynchronization` - disabled by default
|
|
|
|
To install Operators in mode "One per Helm Release" we can use:
|
|
|
|
```
|
|
helm install --name arango-deployment kube-arangodb.tar.gz \
|
|
--set operator.features.deployment=true \
|
|
--set operator.features.deploymentReplications=false \
|
|
--set operator.features.storage=false \
|
|
--set operator.features.backup=false \
|
|
--set operator.features.apps=false \
|
|
--set operator.features.k8sToK8sClusterSync=false
|
|
```
|
|
|
|
|
|
# Configuration
|
|
|
|
### `operator.image`
|
|
|
|
Image used for the ArangoDB Operator.
|
|
|
|
Default: `arangodb/kube-arangodb:latest`
|
|
|
|
### `operator.imagePullPolicy`
|
|
|
|
Image pull policy for Operator images.
|
|
|
|
Default: `IfNotPresent`
|
|
|
|
### `operator.imagePullSecrets`
|
|
|
|
List of the Image Pull Secrets for Operator images.
|
|
|
|
Default: `[]string`
|
|
|
|
### `operator.scope`
|
|
|
|
Scope on which Operator will be configured.
|
|
|
|
Default: `legacy`
|
|
|
|
Supported modes:
|
|
- `legacy` - mode with limited cluster scope access
|
|
- `namespaced` - mode with namespace access only
|
|
|
|
### `operator.service.type`
|
|
|
|
Type of the Operator service.
|
|
|
|
Default: `ClusterIP`
|
|
|
|
### `operator.annotations`
|
|
|
|
Annotations passed to the Operator Deployment definition.
|
|
|
|
Default: `[]string`
|
|
|
|
### `operator.resources.limits.cpu`
|
|
|
|
CPU limits for operator pods.
|
|
|
|
Default: `1`
|
|
|
|
### `operator.resources.limits.memory`
|
|
|
|
Memory limits for operator pods.
|
|
|
|
Default: `256Mi`
|
|
|
|
### `operator.resources.requested.cpu`
|
|
|
|
Requested CPI by Operator pods.
|
|
|
|
Default: `250m`
|
|
|
|
### `operator.resources.requested.memory`
|
|
|
|
Requested memory for operator pods.
|
|
|
|
Default: `256Mi`
|
|
|
|
### `operator.nodeSelector`
|
|
|
|
NodeSelector for Deployment pods.
|
|
|
|
Default: `{}`
|
|
|
|
### `operator.tolerations`
|
|
|
|
Tolerations for Deployment pods.
|
|
|
|
There is built in configuration (can not be changed):
|
|
```yaml
|
|
tolerations:
|
|
- key: "node.kubernetes.io/unreachable"
|
|
operator: "Exists"
|
|
effect: "NoExecute"
|
|
tolerationSeconds: 5
|
|
- key: "node.kubernetes.io/not-ready"
|
|
operator: "Exists"
|
|
effect: "NoExecute"
|
|
tolerationSeconds: 5
|
|
```
|
|
|
|
which can be extended by additional entries e.g.:
|
|
```yaml
|
|
tolerations:
|
|
- key: devops
|
|
operator: Exists
|
|
effect: NoSchedule
|
|
```
|
|
Default (empty): `[]`
|
|
|
|
### `operator.securityContext.runAsUser`
|
|
|
|
Controls which user ID the containers are run with.
|
|
|
|
Default: `1000`
|
|
|
|
### `operator.replicaCount`
|
|
|
|
Replication count for Operator deployment.
|
|
|
|
Default: `1`
|
|
|
|
### `operator.updateStrategy`
|
|
|
|
Update strategy for operator pod.
|
|
|
|
Default: `Recreate`
|
|
|
|
### `operator.features.deployment`
|
|
|
|
Define if ArangoDeployment Operator should be enabled.
|
|
|
|
Default: `true`
|
|
|
|
### `operator.features.deploymentReplications`
|
|
|
|
Define if ArangoDeploymentReplications Operator should be enabled.
|
|
|
|
Default: `true`
|
|
|
|
### `operator.features.storage`
|
|
|
|
Define if ArangoLocalStorage Operator should be enabled.
|
|
|
|
Default: `false`
|
|
|
|
### `operator.features.backup`
|
|
|
|
Define if ArangoBackup Operator should be enabled.
|
|
|
|
Default: `false`
|
|
|
|
### `operator.features.apps`
|
|
|
|
Define if ArangoJob Operator should be enabled.
|
|
|
|
Default: `false`
|
|
|
|
### `operator.features.k8sToK8sClusterSync`
|
|
|
|
Define if ArangoClusterSynchronization Operator should be enabled.
|
|
|
|
Default: `false`
|
|
|
|
### `rbac.enabled`
|
|
|
|
Define if RBAC should be enabled.
|
|
|
|
Default: `true`
|
|
|
|
### `operator.architectures`
|
|
|
|
List of supported architectures.
|
|
|
|
Default: `[]string{"amd64"}`
|
|
|
|
# Limitations
|
|
|
|
N/A |