ArangoDeployment Custom Resource
- Specification reference
- Deprecated Fields
  - spec.<group>.resources.requests.storage: storageUnit
  - spec.<group>.storageClassName: string

ArangoDeployment Custom Resource

The ArangoDB Deployment Operator creates and maintains ArangoDB deploymentsin a Kubernetes cluster, given a deployment specification.This deployment specification is a CustomResource followinga CustomResourceDefinition created by the operator.

Example minimal deployment definition of an ArangoDB database cluster:

apiVersion: "database.arangodb.com/v1alpha"
kind: "ArangoDeployment"
metadata:
  name: "example-arangodb-cluster"
spec:
  mode: Cluster

Example more elaborate deployment definition:

apiVersion: "database.arangodb.com/v1alpha"
kind: "ArangoDeployment"
metadata:
  name: "example-arangodb-cluster"
spec:
  mode: Cluster
  environment: Production
  agents:
    count: 3
    args:
      - --log.level=debug
    resources:
      requests:
        storage: 8Gi
    storageClassName: ssd
  dbservers:
    count: 5
    resources:
      requests:
        storage: 80Gi
    storageClassName: ssd
  coordinators:
    count: 3
  image: "arangodb/arangodb:3.3.4"

Specification reference

Below you’ll find all settings of the ArangoDeployment custom resource.Several settings are for various groups of servers. These are indicatedwith <group> where <group> can be any of:

agents for all agents of a Cluster or ActiveFailover pair.
dbservers for all dbservers of a Cluster.
coordinators for all coordinators of a Cluster.
single for all single servers of a Single instance or ActiveFailover pair.
syncmasters for all syncmasters of a Cluster.
syncworkers for all syncworkers of a Cluster.

spec.mode: string

This setting specifies the type of deployment you want to create.Possible values are:

Cluster (default) Full cluster. Defaults to 3 agents, 3 dbservers & 3 coordinators.
ActiveFailover Active-failover single pair. Defaults to 3 agents and 2 single servers.
Single Single server only (note this does not provide high availability or reliability).This setting cannot be changed after the deployment has been created.

spec.environment: string

This setting specifies the type of environment in which the deployment is created.Possible values are:

Development (default) This value optimizes the deployment for developmentuse. It is possible to run a deployment on a small number of nodes (e.g. minikube).
Production This value optimizes the deployment for production use.It puts required affinity constraints on all pods to avoid agents & dbserversfrom running on the same machine.

spec.image: string

This setting specifies the docker image to use for all ArangoDB servers.In a development environment this setting defaults to arangodb/arangodb:latest.For production environments this is a required setting without a default value.It is highly recommend to use explicit version (not latest) for productionenvironments.

spec.imagePullPolicy: string

This setting specifies the pull policy for the docker image to use for all ArangoDB servers.Possible values are:

IfNotPresent (default) to pull only when the image is not found on the node.
Always to always pull the image before using it.

spec.storageEngine: string

This setting specifies the type of storage engine used for all serversin the cluster.Possible values are:

MMFiles To use the MMFiles storage engine.
RocksDB (default) To use the RocksDB storage engine.This setting cannot be changed after the cluster has been created.

spec.downtimeAllowed: bool

This setting is used to allow automatic reconciliation actions that yieldsome downtime of the ArangoDB deployment.When this setting is set to false (the default), no automatic action thatmay result in downtime is allowed.If the need for such an action is detected, an event is added to the ArangoDeployment.

Once this setting is set to true, the automatic action is executed.

Operations that may result in downtime are:

Rotating TLS CA certificateNote: It is still possible that there is some downtime when the Kubernetescluster is down, or in a bad state, irrespective of the value of this setting.

spec.rocksdb.encryption.keySecretName

This setting specifies the name of a Kubernetes Secret that containsan encryption key used for encrypting all data stored by ArangoDB servers.When an encryption key is used, encryption of the data in the cluster is enabled,without it encryption is disabled.The default value is empty.

This requires the Enterprise version.

The encryption key cannot be changed after the cluster has been created.

The secret specified by this setting, must have a data field named ‘key’ containingan encryption key that is exactly 32 bytes long.

spec.externalAccess.type: string

This setting specifies the type of Service that will be created to provideaccess to the ArangoDB deployment from outside the Kubernetes cluster.Possible values are:

None To limit access to application running inside the Kubernetes cluster.
LoadBalancer To create a Service of type LoadBalancer for the ArangoDB deployment.
NodePort To create a Service of type NodePort for the ArangoDB deployment.
Auto (default) To create a Service of type LoadBalancer and fallback to a Service or type NodePort when theLoadBalancer is not assigned an IP address.

spec.externalAccess.loadBalancerIP: string

This setting specifies the IP used to for the LoadBalancer to expose the ArangoDB deployment on.This setting is used when spec.externalAccess.type is set to LoadBalancer or Auto.

If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner.

spec.externalAccess.nodePort: int

This setting specifies the port used to expose the ArangoDB deployment on.This setting is used when spec.externalAccess.type is set to NodePort or Auto.

If you do not specify this setting, a random port will be chosen automatically.

spec.externalAccess.advertisedEndpoint: string

This setting specifies the advertised endpoint for all coordinators.

spec.auth.jwtSecretName: string

This setting specifies the name of a kubernetes Secret that containsthe JWT token used for accessing all ArangoDB servers.When no name is specified, it defaults to <deployment-name>-jwt.To disable authentication, set this value to None.

If you specify a name of a Secret, that secret must have the tokenin a data field named token.

If you specify a name of a Secret that does not exist, a random token is createdand stored in a Secret with given name.

Changing a JWT token results in stopping the entire clusterand restarting it.

spec.tls.caSecretName: string

This setting specifies the name of a kubernetes Secret that containsa standard CA certificate + private key used to sign certificates for individualArangoDB servers.When no name is specified, it defaults to <deployment-name>-ca.To disable authentication, set this value to None.

If you specify a name of a Secret that does not exist, a self-signed CA certificate + key is createdand stored in a Secret with given name.

The specified Secret, must contain the following data fields:

ca.crt PEM encoded public key of the CA certificate
ca.key PEM encoded private key of the CA certificate

spec.tls.altNames: []string

This setting specifies a list of alternate names that will be added to all generatedcertificates. These names can be DNS names or email addresses.The default value is empty.

spec.tls.ttl: duration

This setting specifies the time to live of all generatedserver certificates.The default value is 2160h (about 3 month).

When the server certificate is about to expire, it will be automatically replacedby a new one and the affected server will be restarted.

Note: The time to live of the CA certificate (when created automatically)will be set to 10 years.

spec.sync.enabled: bool

This setting enables/disables support for data center 2 data centerreplication in the cluster. When enabled, the cluster will containa number of syncmaster & syncworker servers.The default value is false.

spec.sync.externalAccess.type: string

This setting specifies the type of Service that will be created to provideaccess to the ArangoSync syncMasters from outside the Kubernetes cluster.Possible values are:

None To limit access to applications running inside the Kubernetes cluster.
LoadBalancer To create a Service of type LoadBalancer for the ArangoSync SyncMasters.
NodePort To create a Service of type NodePort for the ArangoSync SyncMasters.
Auto (default) To create a Service of type LoadBalancer and fallback to a Service or type NodePort when theLoadBalancer is not assigned an IP address.Note that when you specify a value of None, a Service will still be created, but of type ClusterIP.

spec.sync.externalAccess.loadBalancerIP: string

This setting specifies the IP used for the LoadBalancer to expose the ArangoSync SyncMasters on.This setting is used when spec.sync.externalAccess.type is set to LoadBalancer or Auto.

If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner.

spec.sync.externalAccess.nodePort: int

This setting specifies the port used to expose the ArangoSync SyncMasters on.This setting is used when spec.sync.externalAccess.type is set to NodePort or Auto.

If you do not specify this setting, a random port will be chosen automatically.

spec.sync.externalAccess.masterEndpoint: []string

This setting specifies the master endpoint(s) advertised by the ArangoSync SyncMasters.If not set, this setting defaults to:

If spec.sync.externalAccess.loadBalancerIP is set, it defaults to https://<load-balancer-ip>:<8629>.
Otherwise it defaults to https://<sync-service-dns-name>:<8629>.

spec.sync.externalAccess.accessPackageSecretNames: []string

This setting specifies the names of zero of more Secrets that will be created by the deploymentoperator containing “access packages”. An access package contains those Secrets that are neededto access the SyncMasters of this ArangoDeployment.

By removing a name from this setting, the corresponding Secret is also deleted.Note that to remove all access packages, leave an empty array in place ([]).Completely removing the setting results in not modifying the list.

See the ArangoDeploymentReplication specification for more informationon access packages.

spec.sync.auth.jwtSecretName: string

This setting specifies the name of a kubernetes Secret that containsthe JWT token used for accessing all ArangoSync master servers.When not specified, the spec.auth.jwtSecretName value is used.

If you specify a name of a Secret that does not exist, a random token is createdand stored in a Secret with given name.

spec.sync.auth.clientCASecretName: string

This setting specifies the name of a kubernetes Secret that containsa PEM encoded CA certificate used for client certificate verificationin all ArangoSync master servers.This is a required setting when spec.sync.enabled is true.The default value is empty.

spec.sync.mq.type: string

This setting sets the type of message queue used by ArangoSync.Possible values are:

Direct (default) for direct HTTP connections between the 2 data centers.

spec.sync.tls.caSecretName: string

This setting specifies the name of a kubernetes Secret that containsa standard CA certificate + private key used to sign certificates for individualArangoSync master servers.

When no name is specified, it defaults to <deployment-name>-sync-ca.

If you specify a name of a Secret that does not exist, a self-signed CA certificate + key is createdand stored in a Secret with given name.

The specified Secret, must contain the following data fields:

ca.crt PEM encoded public key of the CA certificate
ca.key PEM encoded private key of the CA certificate

spec.sync.tls.altNames: []string

This setting specifies a list of alternate names that will be added to all generatedcertificates. These names can be DNS names or email addresses.The default value is empty.

spec.sync.monitoring.tokenSecretName: string

This setting specifies the name of a kubernetes Secret that containsthe bearer token used for accessing all monitoring endpoints of all ArangoSyncservers.When not specified, no monitoring token is used.The default value is empty.

spec.disableIPv6: bool

This setting prevents the use of IPv6 addresses by ArangoDB servers.The default is false.

This setting cannot be changed after the deployment has been created.

spec.license.secretName: string

This setting specifies the name of a kubernetes Secret that containsthe license key token used for enterprise images. This value is not used forthe community edition.

spec.bootstrap.passwordSecretNames.root: string

This setting specifies a secret name for the credentials of the root user.

When a deployment is created the operator will setup the root user account according to the credentials given by the secret. If the secret doesn’t existthe operator creates a secret with a random password.

There are two magic values for the secret name:

None specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
Auto specifies automatic name generation, which is <deploymentname>-root-password.

spec.<group>.count: number

This setting specifies the number of servers to start for the given group.For the agent group, this value must be a positive, odd number.The default value is 3 for all groups except single (there the default is 1for spec.mode: Single and 2 for spec.mode: ActiveFailover).

For the syncworkers group, it is highly recommended to use the same numberas for the dbservers group.

spec.<group>.minCount: number

Specifies a minimum for the count of servers. If set, a specification is invalid if count < minCount.

spec.<group>.maxCount: number

Specifies a maximum for the count of servers. If set, a specification is invalid if count > maxCount.

spec.<group>.args: []string

This setting specifies additional commandline arguments passed to all servers of this group.The default value is an empty array.

spec.<group>.resources: ResourceRequirements

This setting specifies the resources required by pods of this group. This includes requests and limits.

See Kubernetes documentation for details.

spec.<group>.volumeClaimTemplate.Spec: PersistentVolumeClaimSpec

Specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.This setting is not available for group coordinators, syncmasters & syncworkers.

The default value describes a volume with 8Gi storage, ReadWriteOnce access mode and volume mode set to PersistentVolumeFilesystem.

If this field is not set and spec.<group>.resources.requests.storage is set, then a default volume claimwith size as specified by spec.<group>.resources.requests.storage will be created. In that case storageand iops is not forwarded to the pods resource requirements.

spec.<group>.serviceAccountName: string

This setting specifies the serviceAccountName for the Pods createdfor each server of this group.

Using an alternative ServiceAccount is typically used to separate access rights.The ArangoDB deployments do not require any special rights.

spec.<group>.priorityClassName: string

Priority class name for pods of this group. Will be forwarded to the pod spec. Kubernetes documentation

spec.<group>.probes.livenessProbeDisabled: bool

If set to true, the operator does not generate a liveness probe for new pods belonging to this group.

spec.<group>.probes.readinessProbeDisabled: bool

If set to true, the operator does not generate a readiness probe for new pods belonging to this group.

spec.<group>.tolerations: []Toleration

This setting specifies the tolerations for the Pods createdfor each server of this group.

By default, suitable tolerations are set for the following keys with the NoExecute effect:

node.kubernetes.io/not-ready
node.kubernetes.io/unreachable
node.alpha.kubernetes.io/unreachable (will be removed in future version)For more information on tolerations, consult the Kubernetes documentation.

spec.<group>.nodeSelector: map[string]string

This setting specifies a set of labels to be used as nodeSelector for Pods of this node.

For more information on node selectors, consult the Kubernetes documentation.

Deprecated Fields

spec.<group>.resources.requests.storage: storageUnit

This setting specifies the amount of storage required for each server of this group.The default value is 8Gi.

This setting is not available for group coordinators, syncmasters & syncworkersbecause servers in these groups do not need persistent storage.

Please use VolumeClaimTemplate from now on. This field is not considered if VolumeClaimTemplate is set. Note however, that the information in requests is completely handed over to the pod in this case.

spec.<group>.storageClassName: string

This setting specifies the storageClass for the PersistentVolumes createdfor each server of this group.