Arango logo

Install and upgrade the data platform

How to set up and upgrade a self-managed Contextual Data Platform online or offline

Requirements for self-hosting

  • ArangoDB Enterprise Edition: The multi-model database system for graph, document, key-value, search, and vector.

  • Kubernetes: Orchestrates the selected services that comprise the Arango Contextual Data Platform, running them in containers for safety and scalability.

    Set up a Kubernetes  cluster if you don’t have one available yet.

  • kubectl: A command line tool for communicating with a Kubernetes cluster’s control plane.

    Install kubectl  for applying specifications such as for creating the ArangoDB core deployment, as well as for checking pods, logs, etc.

  • Helm: A package manager for Kubernetes.

    You need to have helm  installed in order to install the ArangoDB Kubernetes Operator as part of the Contextual Data Platform setup.

  • Container registry: A repository for storing and accessing container images.

    For offline installation such as for air-gapped environments, you need to have a container registry that available in your environment. It can be a local registry. It is needed for importing and installing the images of the Platform Suite.

    In environments with internet access, you don’t need your own container registry but you can optionally use one.

  • x86-64 CPU: The processor(s) must support the x86-64 architecture. See the Supported platforms and architectures of ArangoDB for details.

    Arango is fully committed to supporting the ARM architecture and infrastructure for all products (ArangoDB, Arango Contextual Data Platform, and Arango Agentic AI Suite) and tests them before each release. As Arango develops new services and components for the data platform, some of them may be under validation and QA. If you have a specific request for a new feature, especially around AI services, please reach out to your sales/service/support team to confirm.

Version compatibility

The Arango Contextual Data Platform is versioned independent of its core database system (ArangoDB) and the operator for Kubernetes.

The minimally required versions of ArangoDB and the operator for a given data platform version are listed below.

Arango Contextual Data PlatformArangoDBOperator (kube-arangodb)
4.0.x3.12.9+1.4.3+
4.1.x3.12.11+1.4.5+

The Agentic AI Suite and the Platform Suite have no separate versions. A data platform release defines the versions of all services that the suites are composed of. Upgrading the data platform inherently upgrades these services, but they are guaranteed to be compatible with each other.

Install the Contextual Data Platform

Follow the guide for deploying the Arango Contextual Data Platform that matches your needs:

Upgrade the Contextual Data Platform

  • Upgrade version: Upgrade to a newer version of the Arango Contextual Data Platform.

Interfaces

The Arango Contextual Data Platform uses a gateway to make all its services available via a single port at the external address of the deployment. The service port of the Data Platform is 8529 inside Kubernetes, but outside it can be different depending on the configuration.

For a local deployment, you can use temporary port forwarding to access the Data Platform from your host machine. You can select the gateway pod (deployment-example-gway-*) via the higher-level service resource for external access (-ea) and specify the ports like targetPort:servicePort:

kubectl port-forward --namespace arango \
  service/deployment-example-ea 8529:8529

In this case, the base URL to access the Contextual Data Platform is https://127.0.0.1:8529.

You can stop the port forwarding in the command-line with the key combination Ctrl + C .

Unified web interface

You can access the Arango Contextual Data Platform web interface with a browser by appending /ui/ to the base URL, e.g. https://127.0.0.1:8529/ui/.

For a local deployment without further certificate configuration, your browser will show a warning because a self-signed certificate is used. Continue anyway to access the web interface. Depending on your browser, the option to continue may require that you click a button for advanced options.

ArangoDB

The HTTP API of the ArangoDB core database system is available at the base URL. For example, the URL of the Cursor API for running AQL queries (in the _system database) is https://127.0.0.1:8529/_db/_system/_api/cursor.

For a local deployment without further certificate configuration, you may need to explicitly allow self-signed certificates in drivers or tools to access the Data Platform. For example, cURL requires that you specify the -k / --insecure option:

curl -k -u root: -d '{"query":"RETURN 42"}' https://127.0.0.1:8529/_db/_system/_api/cursor