[Documentation] Add ArangoPlatformStorage Docs & Examples #1951
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for ArangoPlatformStorage, covering integration with multiple cloud storage providers and updating version references across integration documentation.
- Adds documentation for AWS S3, Google Cloud Storage, and MinIO storage integrations
- Updates navigation order and version references in existing documentation
- Creates a new platform storage documentation section with setup examples
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/platform.storage.s3.md | New documentation for AWS S3 integration with credentials and configuration examples |
| docs/platform.storage.minio.md | New documentation for MinIO integration including TLS certificate setup |
| docs/platform.storage.gcs.md | New documentation for Google Cloud Storage integration with service account configuration |
| docs/platform.storage.md | Main platform storage documentation page with overview and requirements |
| docs/platform.sso.openid.md | Updates API reference link from v1alpha1 to v1beta1 |
| docs/platform.sso.md | Updates navigation order from 4 to 5 |
| docs/platform.helm.md | Updates navigation order from 3 to 4 |
| docs/integration/storage.v2.md | Updates version reference and adds configuration link |
| docs/integration/*.md | Updates GitHub links from version 1.2.49 to 1.3.0 |
| CHANGELOG.md | Adds entry for this documentation update |
docs/platform.storage.s3.md
Outdated
| spec: | ||
| backend: | ||
| s3: | ||
| allowInsecure: true # In case of public certs are not installed needs to be set to false |
There was a problem hiding this comment.
The comment contains a grammatical error. It should read 'In case public certs are not installed, this needs to be set to false' or 'If public certs are not installed, this needs to be set to false'.
| allowInsecure: true # In case of public certs are not installed needs to be set to false | |
| allowInsecure: true # If public certs are not installed, this needs to be set to false |
Copilot uses AI. Check for mistakes.
docs/platform.storage.minio.md
Outdated
| 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=<AWS Access Key ID>' --from-literal 'secretKey=<AWS Secret Access Key>' |
There was a problem hiding this comment.
The documentation refers to 'AWS Access Key ID' and 'AWS Secret Access Key' in the MinIO context, which could be confusing. Consider updating to 'MinIO Access Key' and 'MinIO Secret Key' or generic terms like 'Access Key' and 'Secret Key'.
| kubectl create secret generic credentials --from-literal 'accessKey=<AWS Access Key ID>' --from-literal 'secretKey=<AWS Secret Access Key>' | |
| kubectl create secret generic credentials --from-literal 'accessKey=<MinIO Access Key>' --from-literal 'secretKey=<MinIO Secret Key>' |
Copilot uses AI. Check for mistakes.
| bucketName: <Bucket Name> | ||
| bucketPath: <Bucket Path> | ||
| credentialsSecret: | ||
| name: credentials |
There was a problem hiding this comment.
The credentialsSecret name 'credentials' doesn't match the secret name 'ca' created in line 17. This will cause the configuration to reference a non-existent secret.
| name: credentials | |
| name: ca |
Copilot uses AI. Check for mistakes.
ajanikow
force-pushed
the
documentation/aps_docs
branch
from
f5d4b38 to
a244744
Compare
ajanikow
force-pushed
the
documentation/aps_docs
branch
from
a244744 to
ef53f77
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the ArangoPlatformStorage feature, including guides for different storage backends and reference links updates.
- Added new documentation files for AWS S3, MinIO, and Google Cloud Storage integration with ArangoPlatformStorage
- Updated navigation order for platform documentation sections
- Updated version references from 1.2.49 to 1.3.0 across integration documentation
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/platform/storage.md | Main storage documentation page with overview |
| docs/platform/storage/s3.md | AWS S3 integration guide with credentials and configuration |
| docs/platform/storage/minio.md | MinIO integration guide with TLS certificate setup |
| docs/platform/storage/gcs.md | Google Cloud Storage integration guide with service account setup |
| docs/platform.sso.md | Updated navigation order from 4 to 5 |
| docs/platform.helm.md | Updated navigation order from 3 to 4 |
| docs/platform.sso.openid.md | Updated API reference link from V1Alpha1 to V1Beta1 |
| docs/integration/*.md | Updated GitHub links from version 1.2.49 to 1.3.0 |
| CHANGELOG.md | Added entry for this documentation update |
| spec: | ||
| backend: | ||
| s3: | ||
| allowInsecure: true # If public certs are not installed, this needs to be set to false |
There was a problem hiding this comment.
The comment is confusing - it states to set allowInsecure: true when public certs are not installed, but then says 'this needs to be set to false'. The logic should be clarified: set to true to allow insecure connections when certificates are not properly configured, or false for secure connections with valid certificates.
| allowInsecure: true # If public certs are not installed, this needs to be set to false | |
| allowInsecure: true # Set to true if public certs are not installed (insecure), or false to require valid certificates (secure) |
Copilot uses AI. Check for mistakes.
| bucketName: <Bucket Name> | ||
| bucketPath: <Bucket Path> | ||
| credentialsSecret: | ||
| name: credentials |
There was a problem hiding this comment.
The secret reference name 'credentials' doesn't match the secret created in line 17, which is named 'ca'. This will cause the configuration to fail. The secret name should be 'ca' to match the kubectl command.
| name: credentials | |
| name: ca |
Copilot uses AI. Check for mistakes.
2 participants
No description provided.