2024-11-25 13:20:21 +00:00
|
|
|
---
|
|
|
|
layout: page
|
|
|
|
has_children: true
|
|
|
|
title: Integration Sidecars
|
|
|
|
parent: ArangoDBPlatform
|
|
|
|
has_toc: false
|
|
|
|
---
|
|
|
|
|
2024-10-23 09:42:32 +00:00
|
|
|
# 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)
|
|
|
|
|
2024-11-25 13:20:21 +00:00
|
|
|
To enable integration sidecar for specific deployment label needs to be defined:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
profiles.arangodb.com/deployment: << deployment name >>
|
|
|
|
```
|
|
|
|
|
2024-12-13 09:13:58 +00:00
|
|
|
### 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:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
apiVersion: v1
|
|
|
|
kind: Pod
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
profiles.arangodb.com/deployment: << deployment name >>
|
|
|
|
```
|
|
|
|
|
2024-11-25 13:20:21 +00:00
|
|
|
### Integrations
|
|
|
|
|
|
|
|
To enable integration in specific version, labels needs to be added:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/<< integration name >>: << integration version >>
|
|
|
|
```
|
|
|
|
|
|
|
|
#### [Authentication V1](/docs/integration/authentication.v1.md)
|
|
|
|
|
|
|
|
Authentication Integration Sidecar
|
|
|
|
|
|
|
|
To enable:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/authn: v1
|
|
|
|
```
|
|
|
|
|
|
|
|
#### [Authorization V0](/docs/integration/authorization.v0.md)
|
|
|
|
|
|
|
|
Authorization Integration Sidecar
|
|
|
|
|
|
|
|
To enable:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/authz: v0
|
|
|
|
```
|
|
|
|
|
|
|
|
#### [Scheduler V2](/docs/integration/scheduler.v2.md)
|
|
|
|
|
|
|
|
Scheduler Integration Sidecar
|
|
|
|
|
|
|
|
To enable:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/sched: v2
|
|
|
|
```
|
|
|
|
|
|
|
|
#### [Storage V2](/docs/integration/storage.v2.md)
|
|
|
|
|
|
|
|
Storage Integration Sidecar
|
|
|
|
|
|
|
|
To enable:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/storage: v2
|
|
|
|
```
|
|
|
|
|
2024-12-06 11:16:20 +00:00
|
|
|
#### [Shutdown V1](/docs/integration/shutdown.v1.md)
|
|
|
|
|
|
|
|
Shutdown Integration Sidecar
|
|
|
|
|
|
|
|
To enable:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
metadata:
|
|
|
|
labels:
|
|
|
|
integration.profiles.arangodb.com/shutdown: v1
|
|
|
|
```
|
|
|
|
|
2024-10-23 09:42:32 +00:00
|
|
|
### Envs
|
|
|
|
|
2024-11-25 13:20:21 +00:00
|
|
|
#### INTEGRATION_API_ADDRESS
|
|
|
|
|
|
|
|
Integration Service API Address
|
|
|
|
|
|
|
|
Example: `localhost:1234`
|
|
|
|
|
|
|
|
#### INTEGRATION_SERVICE_ADDRESS
|
|
|
|
|
|
|
|
Integration Service API Address
|
|
|
|
|
|
|
|
Example: `localhost:1234`
|
|
|
|
|
2024-10-23 09:42:32 +00:00
|
|
|
#### ARANGO_DEPLOYMENT_NAME
|
|
|
|
|
|
|
|
ArangoDeployment name.
|
|
|
|
|
|
|
|
Example: `deployment`
|
|
|
|
|
|
|
|
#### ARANGO_DEPLOYMENT_ENDPOINT
|
|
|
|
|
|
|
|
HTTP/S Endpoint of the ArangoDeployment Internal Service.
|
|
|
|
|
2024-11-25 13:20:21 +00:00
|
|
|
Example: `https://deployment.default.svc:8529`
|