Integration

Sidecar

Resource Types

Integration Sidecar is supported in a basic resources managed by Kubernetes:

  • Pod

To enable integrations for specific deployment label needs to be defined:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>

Webhooks

When Webhook support is enabled Integration Sidecar is supported in Kubernetes Pod resources.

To inject integration sidecar for specific deployment label needs to be defined:

apiVersion: v1
kind: Pod
metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>

Arango Token

Enables the token in the all Containers and InitContainers in the Pod.

Label can be on the ServiceAccount or Pod.

Pod:

apiVersion: v1
kind: Pod
metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    permissions.arangodb.com/token: << ArangoPermissionToken name >>

ServiceAccount:

apiVersion: v1
kind: ServiceAccount
metadata:
  name: sa
  labels:
    permissions.arangodb.com/token: << ArangoPermissionToken name >>

---

apiVersion: v1
kind: Pod
metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
spec:
  serviceAccountName: sa

Integrations

To enable integration in specific version, labels needs to be added:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/<< integration name >>: << integration version >>

Authentication V1

Authentication Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/authn: v1

Scheduler V2

Scheduler Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/sched: v2

Storage V2

Storage Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/storage: v2

Shutdown V1

Shutdown Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/shutdown: v1

Meta V1

Meta Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/meta: v1

Events V1

Events Integration Sidecar

To enable:

metadata:
  labels:
    profiles.arangodb.com/deployment: << deployment name >>
    integration.profiles.arangodb.com/events: v1

Envs

INTEGRATION_API_ADDRESS

Integration Service API Address

Example: localhost:1234

INTEGRATION_API_UNIX

Integration Service API Unix Handler File Address

Example: /var/run/sidecar/socket/api.sock

INTEGRATION_SERVICE_ADDRESS

Integration Service API Address

Example: localhost:1234

INTEGRATION_HTTP_ADDRESS

Integration Service HTTP Address

Example: localhost:1234

INTEGRATION_HTTP_UNIX

Integration Service HTTP Unix Handler File Address

Example: /var/run/sidecar/socket/http.sock

INTEGRATION_HTTP_ADDRESS_FULL

Integration Service HTTP Address with protocol

Example: http://localhost:1234

CENTRAL_INTEGRATION_API_ADDRESS

Integration Service API Address via the Serving Sidecar

Example: localhost:1234

CENTRAL_INTEGRATION_HTTP_ADDRESS

Integration Service HTTP Address via the Serving Sidecar

Example: localhost:1234

CENTRAL_INTEGRATION_HTTP_ADDRESS_FULL

Integration Service HTTP Address via the Serving Sidecar with protocol

Example: http://localhost:1234

ARANGO_DEPLOYMENT_NAME

ArangoDeployment name.

Example: deployment

ARANGO_DEPLOYMENT_ENDPOINT / ARANGODB_ENDPOINT

HTTP/S Endpoint of the ArangoDeployment Internal Service.

Example: https://deployment.default.svc:8529

ARANGO_TOKEN (optional)

Optional path to the ArangoToken mounted into the Pod.

File is updated in the runtime, with short, predefined, TTL.

Example: /var/run/secrets/arango/token/token

ARANGO_DEPLOYMENT_CA (optional)

Path to the CA in the PEM format. If not set, TLS is disabled.

Example: /etc/deployment-int/ca/ca.pem

KUBERNETES_NAMESPACE

Kubernetes Namespace.

Example: default

KUBERNETES_POD_NAME

Kubernetes Pod Name.

Example: example

KUBERNETES_POD_IP

Kubernetes Pod IP.

Example: 127.0.0.1

KUBERNETES_SERVICE_ACCOUNT

Kubernetes Service Account mounted for the Pod.

Example: sa-example

CONTAINER_CPU_REQUESTS

Kubernetes Pod Container CPU Requests (1000 = 1CPU).

Example: 500

CONTAINER_MEMORY_REQUESTS

Kubernetes Pod Container Memory Requests in Megabytes.

Example: 128

CONTAINER_CPU_LIMITS

Kubernetes Pod Container CPU Limits (1000 = 1CPU).

Example: 500

CONTAINER_MEMORY_LIMITS

Kubernetes Pod Container Memory Limits in Megabytes.

Example: 128

Table of contents