Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-730 | Platform overview #671

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions site/content/3.12/deploy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ on a single DB-Server node for better performance and with transactional
guarantees similar to a single server deployment. OneShard is primarily intended
for multi-tenant use cases.

### ArangoDB Platform

The ArangoDB Platform is the umbrella for deploying and operating the entire
ArangoDB product offering with a unified interface in a Kubernetes cluster.
It is offered for self-hosting on-prem or in the cloud and as a managed service,
superseding the ArangoGraph Insights Platform.

See [The ArangoDB Platform](../platform/_index.md) for details.

## How to deploy

There are different ways to set up and operate ArangoDB.
Expand Down
71 changes: 71 additions & 0 deletions site/content/3.12/platform/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: The ArangoDB Platform
menuTitle: Platform
weight: 67
description: >-
The ArangoDB Platform brings everything ArangoDB offers together to a single
solution that you can deploy on-prem or use as a managed service
---
The ArangoDB Platform is a technical infrastructure that acts as the umbrella
for hosting the entire ArangoDB offering of products. The Platform makes it easy
to deploy and operate the core ArangoDB database system along with any additional
ArangoDB products for machine learning, data explorations, and more. You can
run it on-premise or in the cloud yourself on top of Kubernetes, as well as use
ArangoDB's managed service, the [ArangoGraph Insights Platform](../arangograph/_index.md)
to access all of the platform features.

## Requirements for self-hosting

- **Kubernetes**: Orchestrates the selected services that comprise the
ArangoDB Platform, running them in containers for safety and scalability.
- **Licenses**: If you want to use any paid features, you need to purchase the
respective packages.

## Products available in the ArangoDB Platform

- **Core database system**: The ArangoDB graph database system for storing
interconnected data. You can use the free Community Edition or the commercial
Enterprise Edition.
- **Graph visualizer**: A web-based tool for exploring your graph data with an
intuitive interface and sophisticated querying capabilities.
- **Data-science suite**: A set of paid machine learning services, APIs, and
user interfaces that are available as a package as well as individual products.
- **Vector embeddings**: You can train machine learning models for later use
in vector search in conjunction with the core database system's `vector`
index type. It allows you to find similar items in your dataset. <!-- TODO: GraphRAG importer/retriever -->
- **GraphRAG solutions**: Leverage ArangoDB's Graph, Document, Key-Value,
Full-Text Search, and Vector Search features to streamline knowledge
extraction and retrieval.
- **Txt2AQL**: Unlock natural language querying with a service that converts
user input into ArangoDB Query Language (AQL), powered by fine-tuned
private or public LLMs. <!-- TODO: GenAI -->
- **GraphRAG Importer**: Extract entities and relationships from large
text-based files, converting unstructured data into a knowledge graph
stored in ArangoDB.
- **GraphRAG Retriever**: Perform semantic similarity searches or aggregate
insights from graph communities with global and local queries.
- **GraphML**: A turnkey solution for graph machine learning for prediction
use cases such as fraud detection, supply chain, healthcare, retail, and
cyber security.
- **Graph Analytics**: A suite of graph algorithms including PageRank,
community detection, and centrality measures with support for GPU
acceleration thanks to Nvidia cuGraph.
- **Jupyter notebooks**: Run a Jupyter kernel in the platform for hosting
interactive notebooks for experimentation and development of applications
that use ArangoDB as their backend.

<!-- TODO: Which product requires what license, free trial -->

## Get started with the ArangoDB Platform

### Use the ArangoDB Platform as a managed service

<!-- TODO: Sign up at https://dashboard.arangodb.cloud -->

### Self-host the ArangoDB Platform

<!-- TODO: Adam's installer -->

## Interfaces

<!-- TODO: UIs, APIs (with links to generated docs) -->
21 changes: 21 additions & 0 deletions site/content/3.12/platform/graph-visualizer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: The Graph Visualizer
menuTitle: Graph Visualizer
weight: 5
description: >-
The Graph Visualizer is a web-based tool for exploring graph data with an
intuitive interface and sophisticated querying capabilities
---
{{< tag "ArangoDB Platform" >}}

## Features

- View nodes and edges of graphs
- View the attributes of node and edge documents
- Dynamically expand nodes to show more of their neighborhood
- Filter based on attributes
- ...

## Overview of the graphical interface

## Usage example