1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
kube-arangodb/docs/integration-sidecar.md
2024-12-13 10:13:58 +01:00

2.4 KiB

layout has_children title parent has_toc
page true Integration Sidecars ArangoDBPlatform false

Integration

Profile

Sidecar

Resource Types

Integration Sidecar is supported in a few resources managed by Operator:

  • ArangoSchedulerDeployment (scheduler.arangodb.com/v1beta1)
  • ArangoSchedulerBatchJob (scheduler.arangodb.com/v1beta1)
  • ArangoSchedulerCronJob (scheduler.arangodb.com/v1beta1)
  • ArangoSchedulerPod (scheduler.arangodb.com/v1beta1)

To enable integration sidecar 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 >>

Integrations

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

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

Authentication V1

Authentication Integration Sidecar

To enable:

metadata:
  labels:
    integration.profiles.arangodb.com/authn: v1

Authorization V0

Authorization Integration Sidecar

To enable:

metadata:
  labels:
    integration.profiles.arangodb.com/authz: v0

Scheduler V2

Scheduler Integration Sidecar

To enable:

metadata:
  labels:
    integration.profiles.arangodb.com/sched: v2

Storage V2

Storage Integration Sidecar

To enable:

metadata:
  labels:
    integration.profiles.arangodb.com/storage: v2

Shutdown V1

Shutdown Integration Sidecar

To enable:

metadata:
  labels:
    integration.profiles.arangodb.com/shutdown: v1

Envs

INTEGRATION_API_ADDRESS

Integration Service API Address

Example: localhost:1234

INTEGRATION_SERVICE_ADDRESS

Integration Service API Address

Example: localhost:1234

ARANGO_DEPLOYMENT_NAME

ArangoDeployment name.

Example: deployment

ARANGO_DEPLOYMENT_ENDPOINT

HTTP/S Endpoint of the ArangoDeployment Internal Service.

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