DOC-774 | New license management using credentials to activate deployments or generate license keys #843
Conversation
…enerate license keys
|
Deploy Preview Available Via |
The setup steps are moved to the installation page and the deployment options to the parent page
maxkernbach
left a comment
maxkernbach
left a comment
There was a problem hiding this comment.
@Simran-B Overall this looks good to me.
My feedback is mainly regarding the platform installation section, which I was able to test. I have added a few comments for your consideration.
|
|
||
| ```sh | ||
| # User credentials | ||
| curl -uroot: http://localhost:8529/_admin/deployment/id |
There was a problem hiding this comment.
Minor typo:
| curl -uroot: http://localhost:8529/_admin/deployment/id | |
| curl -u root: http://localhost:8529/_admin/deployment/id |
| ```yaml | ||
| apiVersion: "database.arangodb.com/v1" | ||
| kind: "ArangoDeployment" | ||
| metadata: | ||
| name: "deployment-example" | ||
| spec: | ||
| mode: Cluster | ||
| image: "arangodb/enterprise:3.12.7" | ||
| gateway: | ||
| enabled: true | ||
| dynamic: true | ||
| gateways: | ||
| count: 1 | ||
| dbservers: | ||
| count: 3 | ||
| coordinators: | ||
| count: 2 | ||
| license: | ||
| secretName: arango-license-key | ||
| # ... | ||
| ``` |
There was a problem hiding this comment.
This sample Arangodeployment does not mention the vector index option, which is quite important when running GraphRAG. I'm not sure whether vector indexes are enabled by default in 3.12.7 (no default is displayed in the vector index documentation)?
| package configuration file. | ||
|
|
||
| ```sh | ||
| arangodb_operator_platform --context arangodb package install \ |
There was a problem hiding this comment.
I'm unsure whether --context arangodb is supported? I have always been using -n arangodb \.
| arangodb_operator_platform --context arangodb package install \ | ||
| --license.client.id "<license-client-id>" \ | ||
| --license.client.secret "<license-client-secret>" \ | ||
| --platform.name deployment-example \ |
There was a problem hiding this comment.
Suggestion: Clarify that deployment-example refers to the name of the Arangodeployment.
|
|
||
| ### Step 9: Set up object storage | ||
|
|
||
| Features like GraphML require an additional storage system to save model |
There was a problem hiding this comment.
| Features like GraphML require an additional storage system to save model | |
| Features like MLflow or GraphML require an additional storage system to save model |
| mountPath: /data | ||
| volumes: | ||
| - name: data | ||
| emptyDir: {} |
There was a problem hiding this comment.
When I setup the minio service locally, I wasn't able to successfully upload any file to minio using emptyDir. Instead, I had to create a PersitentVolumeClaim in addition, and configured the volumes section as follows:
volumes:
- name: data
persistentVolumeClaim:
claimName: minio-data-pvc
minio-pvc.yaml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: minio-data-pvc
namespace: minio
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
| ## Interfaces | ||
|
|
||
| The Arango Data Platform uses a gateway to make all its services available via a | ||
| single port at the external address of the deployment. For a local deployment, | ||
| the base URL is `https://127.0.0.1:8529`. | ||
|
|
||
| ### Unified web interface | ||
|
|
||
| You can access the Arango Data Platform web interface with a browser by appending | ||
| `/ui/` to the base URL, e.g. `https://127.0.0.1:8529/ui/`. |
There was a problem hiding this comment.
Even if the Data Platform is deployed in a local environment, we need to port-forward to the gateway pod in order to access the UI. I would suggest to add the kubectl command to enable the port-forwarding. Usually I'm performing the port-forwarding via k9s (not sure if we want to mention k9s as an optional tool to monitor our platform?).
There was a problem hiding this comment.
I don't see any issues with this documentation. But at the same time I have not validated these steps myself.
Description
Open tasks and questions:
-e ARANGO_LICENSE_KEYunless for e.g. air-gapped environments and link to the license management page for how to activate a deployment using the Platform CLI tool?Upstream PRs
Note
Documents the new deployment ID API, overhauls Enterprise license management (activation/keys), updates 3.12 release notes, and adds/expands Arango Data Platform installation docs.
GET /_admin/deployment/idendpoint (3.12 & 4.0) with schema and curl example.db._setLicense).Written by Cursor Bugbot for commit 559dd84. This will update automatically on new commits. Configure here.