[Documentation] Add ArangoPlatformStorage Docs & Examples (#1951)

ajanikow · web-flow · commit 1d7f01a0ff72 · 2025-08-11T12:16:50.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Change Log
 
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
+- (Documentation) Add ArangoPlatformStorage Docs & Examples
 
 ## [1.3.0](https://github.com/arangodb/kube-arangodb/tree/1.3.0) (2025-08-01)
 - (Feature) (Platform) Storage Debug
diff --git a/docs/integration/authentication.v1.md b/docs/integration/authentication.v1.md
@@ -9,4 +9,4 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/authentication/v1/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/authentication/v1/definition/definition.proto)
diff --git a/docs/integration/authorization.v0.md b/docs/integration/authorization.v0.md
@@ -9,5 +9,5 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/authorization/v0/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/authorization/v0/definition/definition.proto)
 
diff --git a/docs/integration/meta.v1.md b/docs/integration/meta.v1.md
@@ -9,4 +9,4 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/meta/v1/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/meta/v1/definition/definition.proto)
diff --git a/docs/integration/scheduler.v1.md b/docs/integration/scheduler.v1.md
@@ -9,5 +9,5 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/scheduler/v1/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/scheduler/v1/definition/definition.proto)
 
diff --git a/docs/integration/scheduler.v2.md b/docs/integration/scheduler.v2.md
@@ -9,5 +9,5 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/scheduler/v2/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/scheduler/v2/definition/definition.proto)
 
diff --git a/docs/integration/shutdown.v1.md b/docs/integration/shutdown.v1.md
@@ -9,7 +9,7 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/shutdown/v1/definition/shutdown.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/shutdown/v1/definition/shutdown.proto)
 
 Operator will send shutdown request once all containers marked with annotation are stopped.
 
diff --git a/docs/integration/storage.v2.md b/docs/integration/storage.v2.md
@@ -9,5 +9,8 @@ parent: Integration Sidecars
 
 Definitions:
 
-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/storage/v2/definition/storage.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/storage/v2/definition/storage.proto)
 
+## Configuration
+
+In order to configure Platform Storage, refer to the [documentation](../platform.storage.md).
diff --git a/docs/platform.helm.md b/docs/platform.helm.md
@@ -2,7 +2,7 @@
 layout: page
 title: Helm
 parent: ArangoDBPlatform
-nav_order: 3
+nav_order: 4
 ---
 
 # Helm Details
diff --git a/docs/platform.sso.md b/docs/platform.sso.md
@@ -3,7 +3,7 @@ layout: page
 has_children: true
 title: SSO
 parent: ArangoDBPlatform
-nav_order: 4
+nav_order: 5
 ---
 
 # Platform SSO
diff --git a/docs/platform.sso.openid.md b/docs/platform.sso.openid.md
@@ -9,7 +9,7 @@ parent: SSO
 
 ## OpenID Configuration
 
-[Full Configuration reference ->](./api/ArangoPlatform.V1Alpha1.Authentication.OpenID.md)
+[Full Configuration reference ->](./api/ArangoPlatform.V1Beta1.Authentication.OpenID.md)
 
 Example:
 
diff --git a/docs/platform/storage.md b/docs/platform/storage.md
@@ -0,0 +1,15 @@
+---
+layout: page
+has_children: true
+title: Storage
+parent: ArangoDBPlatform
+nav_order: 3
+---
+
+# Platform Storage
+
+Enables Storage Integration within the Arango Platform.
+
+Used for Object Storage, like Models.
+
+Storage Object needs to have same name as ArangoDeployment.
diff --git a/docs/platform/storage/gcs.md b/docs/platform/storage/gcs.md
@@ -0,0 +1,40 @@
+---
+layout: page
+title: Google Cloud Storage
+parent: Storage
+nav_order: 2
+---
+
+# Integration
+
+In order to connect to the GCS (Google Cloud Storage):
+
+## GCP ServiceAccount
+
+ServiceAccount with access to the storage needs to be saved in the secret.
+
+```shell
+kubectl create secret generic ca --from-file 'serviceAccount=<ServiceAccount JSON File>'
+```
+
+## Object
+
+Once the Secret is created, we are able to create ArangoPlatformStorage.
+
+```
+echo "---
+apiVersion: platform.arangodb.com/v1beta1
+kind: ArangoPlatformStorage
+metadata:
+  name: deployment
+  namespace: namespace
+spec:
+  backend:
+    gcs:
+      bucketName: <Bucket Name>
+      bucketPath: <Bucket Path>
+      credentialsSecret:
+        name: credentials
+      projectID: gcr-for-testing
+" | kubectl apply -f -
+```
diff --git a/docs/platform/storage/minio.md b/docs/platform/storage/minio.md
@@ -0,0 +1,48 @@
+---
+layout: page
+title: MinIO
+parent: Storage
+nav_order: 3
+---
+
+# Integration
+
+In order to connect to the MinIO, or any other S3 Compatible storage in the ArangoPlatform:
+
+## MinIO Access Keys
+
+Storage Integration requires static credentials in order to access MinIO API. Credentials can be provided via the Kubernetes Secret.
+
+```shell
+kubectl create secret generic credentials --from-literal 'accessKey=<MinIO Access Key ID>' --from-literal 'secretKey=<MinIO Secret Access Key>'
+```
+
+## MinIO TLS Certificate
+
+```shell
+kubectl create secret generic ca --from-file 'ca.crt=<Certificate Path>'
+```
+
+## Object
+
+Once the Secret is created, we are able to create ArangoPlatformStorage.
+
+```
+echo "---
+apiVersion: platform.arangodb.com/v1beta1
+kind: ArangoPlatformStorage
+metadata:
+  name: deployment
+  namespace: namespace
+spec:
+  backend:
+    s3:
+      bucketName: <Bucket Name>
+      bucketPath: <Bucket Path>
+      credentialsSecret:
+        name: credentials
+      caSecret:
+        name: ca
+      endpoint: https://minio.namespace.svc # Minio Endpoint
+" | kubectl apply -f -
+```
diff --git a/docs/platform/storage/s3.md b/docs/platform/storage/s3.md
@@ -0,0 +1,42 @@
+---
+layout: page
+title: AWS S3
+parent: Storage
+nav_order: 1
+---
+
+# Integration
+
+In order to connect to the AWS S3 storage in the ArangoPlatform:
+
+## AWS S3 Access Keys
+
+Storage Integration requires static credentials in order to access AWS S3 API. Credentials can be provided via the Kubernetes Secret.
+
+```shell
+kubectl create secret generic credentials --from-literal 'accessKey=<AWS Access Key ID>' --from-literal 'secretKey=<AWS Secret Access Key>'
+```
+
+## Object
+
+Once the Secret is created, we are able to create ArangoPlatformStorage.
+
+```
+echo "---
+apiVersion: platform.arangodb.com/v1beta1
+kind: ArangoPlatformStorage
+metadata:
+  name: deployment
+  namespace: namespace
+spec:
+  backend:
+    s3:
+      allowInsecure: true # If public certs are not installed, this needs to be set to false
+      bucketName: <Bucket Name>
+      bucketPath: <Bucket Path>
+      credentialsSecret:
+        name: credentials 
+      endpoint: https://s3.eu-central-1.amazonaws.com # AWS S3 Region Endpoint
+      region: eu-central-1 # AWS Region
+" | kubectl apply -f -
+```

Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@ parent: Integration Sidecars`
`9`	`9`
`10`	`10`	`Definitions:`
`11`	`11`
`12`		`-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/authentication/v1/definition/definition.proto)`
	`12`	`+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/authentication/v1/definition/definition.proto)`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,5 @@ parent: Integration Sidecars`
`9`	`9`
`10`	`10`	`Definitions:`
`11`	`11`
`12`		`-- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.49/integrations/authorization/v0/definition/definition.proto)`
	`12`	`+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.3.0/integrations/authorization/v0/definition/definition.proto)`
`13`	`13`