arangodb v0.1.0

Databases

ArangoDB — a multi-model database combining documents, graphs and key/value in one engine with a single query language (AQL) and a built-in web UI. Deployed as a single host-networked Nomad service.

nomad-pack run arangodb --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- arangodb

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 14.3k ⚑ Report an issue

1 task http 8529 2 volumes image arangodb/arangodb:3.12.12 pinned :3.12.12 image bumped today

Variables 10

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run arangodb -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "arangodb"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The ArangoDB container image. Pin a tag in production.
image = "arangodb/arangodb:3.12.12"

# Host port for the ArangoDB server / web UI.
port = 8529

# Password for the root user. CHANGE THIS.
root_password = "arangodb_change_me"

# Named volume for database files (/var/lib/arangodb3).
data_volume = "arangodb_data"

# Named volume for Foxx apps (/var/lib/arangodb3-apps).
apps_volume = "arangodb_apps"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 1000
    memory = 2048
  }

Name	Type	Default	Description
job_name	string	"arangodb"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"arangodb/arangodb:3.12.12"	The ArangoDB container image. Pin a tag in production.
port	number	8529	Host port for the ArangoDB server / web UI.
root_password set me	string	"arangodb_change_me"	Password for the root user. CHANGE THIS.
data_volume	string	"arangodb_data"	Named volume for database files (/var/lib/arangodb3).
apps_volume	string	"arangodb_apps"	Named volume for Foxx apps (/var/lib/arangodb3-apps).
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 1000 memory = 2048 }	The task resources.

Back up this pack

This pack stores data in 2 Docker named volumes: arangodb_dataarangodb_apps

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/arangodb_data/_data \
  /var/lib/docker/volumes/arangodb_apps/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/arangodb_data/_data backup:<bucket>/arangodb_data
rclone sync /var/lib/docker/volumes/arangodb_apps/_data backup:<bucket>/arangodb_apps

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

arangodb

ArangoDB is a multi-model database that combines three data models — documents, graphs and key/value — in one engine, queried with a single declarative language (AQL). It ships with a polished web UI, graph traversals, full-text search (ArangoSearch) and Foxx microservices.

This pack runs a single ArangoDB instance as a host-networked Nomad service.

Deploy

nomad-pack run arangodb --registry=nomploy \
  --var root_password=$(openssl rand -hex 16)

Open http://<node-ip>:8529 and log in as root.

Configuration

Variable	Default	Description
`image`	`arangodb/arangodb:3.12.12`	Container image (pin a tag in production).
`port`	`8529`	Host port for the server / web UI.
`root_password`	`arangodb_change_me`	Root password — change this.
`data_volume`	`arangodb_data`	Volume for database files (`/var/lib/arangodb3`).
`apps_volume`	`arangodb_apps`	Volume for Foxx apps.
`resources`	1000 MHz / 2048 MB	CPU and memory for the task.

Data and Foxx apps persist across restarts and upgrades. The root password is set only on the first start (empty data directory).