From 44f2bf61e214da231d299640160e90883cd68946 Mon Sep 17 00:00:00 2001
From: Adam Janikowski <12255597+ajanikow@users.noreply.github.com>
Date: Mon, 25 Nov 2024 14:20:21 +0100
Subject: [PATCH] [Documentation] Integration Services (#1770)

---
 docs/integration-sidecar.md           | 88 ++++++++++++++++++++++++++-
 docs/integration/authentication.v1.md | 11 ++++
 docs/integration/authorization.v0.md  | 12 ++++
 docs/integration/scheduler.v2.md      | 12 ++++
 docs/integration/storage.v2.md        | 12 ++++
 docs/platform.md                      |  6 ++
 6 files changed, 140 insertions(+), 1 deletion(-)
 create mode 100644 docs/integration/authentication.v1.md
 create mode 100644 docs/integration/authorization.v0.md
 create mode 100644 docs/integration/scheduler.v2.md
 create mode 100644 docs/integration/storage.v2.md
 create mode 100644 docs/platform.md

diff --git a/docs/integration-sidecar.md b/docs/integration-sidecar.md
index 671483eed..a02658d3d 100644
--- a/docs/integration-sidecar.md
+++ b/docs/integration-sidecar.md
@@ -1,3 +1,11 @@
+---
+layout: page
+has_children: true
+title: Integration Sidecars
+parent: ArangoDBPlatform
+has_toc: false
+---
+
 # Integration 
 
 ## Profile
@@ -13,8 +21,86 @@ Integration Sidecar is supported in a few resources managed by Operator:
 - ArangoSchedulerCronJob (scheduler.arangodb.com/v1beta1)
 - ArangoSchedulerPod (scheduler.arangodb.com/v1beta1)
 
+To enable integration sidecar for specific deployment label needs to be defined:
+
+```yaml
+metadata:
+  labels:
+    profiles.arangodb.com/deployment: << deployment name >>
+```
+
+### 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
+```
+
 ### 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.
@@ -25,4 +111,4 @@ Example: `deployment`
 
 HTTP/S Endpoint of the ArangoDeployment Internal Service.
 
-Example: `https://deployment.default.svc:8529`
+Example: `https://deployment.default.svc:8529`
\ No newline at end of file
diff --git a/docs/integration/authentication.v1.md b/docs/integration/authentication.v1.md
new file mode 100644
index 000000000..0840ab907
--- /dev/null
+++ b/docs/integration/authentication.v1.md
@@ -0,0 +1,11 @@
+---
+layout: page
+title: Authentication V1
+parent: ArangoDBPlatform
+---
+
+# Authentication V1
+
+Definitions:
+
+- [Service](../../integrations/authentication/v1/definition/definition.proto)
diff --git a/docs/integration/authorization.v0.md b/docs/integration/authorization.v0.md
new file mode 100644
index 000000000..9c8877d56
--- /dev/null
+++ b/docs/integration/authorization.v0.md
@@ -0,0 +1,12 @@
+---
+layout: page
+title: Authentication V1
+parent: ArangoDBPlatform
+---
+
+# Authorization V0
+
+Definitions:
+
+- [Service](../../integrations/authorization/v0/definition/definition.proto)
+
diff --git a/docs/integration/scheduler.v2.md b/docs/integration/scheduler.v2.md
new file mode 100644
index 000000000..a92e39413
--- /dev/null
+++ b/docs/integration/scheduler.v2.md
@@ -0,0 +1,12 @@
+---
+layout: page
+title: Authentication V1
+parent: ArangoDBPlatform
+---
+
+# Scheduler V2
+
+Definitions:
+
+- [Service](../../integrations/scheduler/v2/definition/definition.proto)
+
diff --git a/docs/integration/storage.v2.md b/docs/integration/storage.v2.md
new file mode 100644
index 000000000..1cdafd5eb
--- /dev/null
+++ b/docs/integration/storage.v2.md
@@ -0,0 +1,12 @@
+---
+layout: page
+title: Authentication V1
+parent: ArangoDBPlatform
+---
+
+# Storage V2
+
+Definitions:
+
+- [Service](./definition.proto)
+
diff --git a/docs/platform.md b/docs/platform.md
new file mode 100644
index 000000000..8c4ede722
--- /dev/null
+++ b/docs/platform.md
@@ -0,0 +1,6 @@
+---
+layout: page
+has_children: true
+title: ArangoDBPlatform
+has_toc: false
+---
\ No newline at end of file