Resources / GraphDatabase
GraphDatabase
A distributed graph database you query with openCypher over Bolt or HTTP, from a VPC. Its data is divided into regions kept in Etorm storage; its servers sleep when idle, so an idle database costs only its storage. You pay for the storage it holds and the processor time it uses. The password is shown once, when the database is created.
Overview
| API | graphdatabase.etorm.com/v1alpha1 |
| Resource | graphdatabases (cluster-scoped inside its cluster) |
| Short names | gdb |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: graphdatabase.etorm.com/v1alpha1
kind: GraphDatabase
metadata:
name: example
spec:
vpcRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
vpcRef | reference to VPC | yes | The VPC the database's endpoints are on. Cannot be changed. | ||
sizeClass | string (one of) | "auto" | auto, small, medium, large | How many servers the database may use at most: small 2 region servers and 1 query server, medium 8 and 4, large 32 and 16. auto starts small and grows with the data, up to large. | |
maxRegions | integer | 1024 | 1 to 100000 | The most regions (key ranges) the database may be divided into; it stops splitting there. | |
consistency | string (one of) | "strong" | strong, bounded | strong: every read sees the latest commit. bounded: reads may be served by followers up to staleSeconds old. | |
staleSeconds | integer | 1 to 3600 | With consistency bounded: how old a read may be, in seconds. | ||
replicas | integer | 0 | 0 to 2 | Read followers per region. Only 0 is accepted. | |
backup | object | Point-in-time snapshots. Reserved: no snapshots are taken. | |||
backup.retainSnapshots | integer | 0 | 0 to 64 | How many snapshots to keep. | |
backup.intervalSeconds | integer | at least 60 | Seconds between snapshots. | ||
user | string | up to 63 characters | The user for password sign-in. Defaults to app. Cannot be changed. | ||
passwordGeneration | integer | at least 0 | Raise it to set a new password for the user: the new password is shown once, in the response to that change, and the old one stops working. It cannot be lowered. | ||
identityAuth | boolean | true | Also accept an Etorm identity's token (needs the graphdatabase-user role on this database). | ||
resources | object | {} | What each server may use. | ||
resources.memoryPower | integer | 10 | 0 to 12 | Memory per server: 64 KiB times two to this power (10 is 64 MiB, 12 is 256 MiB, the most a process may have). | |
resources.cpuMillicores | integer | 250 | 1 to 1000 | Processor time per server on average, in thousandths of a core. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Pending, Ready, Degraded (serving, with a server down) or Failed. | |||
endpoints | object | Where to connect. | |||
endpoints.bolt | object | The Bolt endpoint. | |||
endpoints.bolt.address | string | Its IPv6 address on the VPC. | |||
endpoints.bolt.port | integer | The Bolt port, 7687. | |||
endpoints.http | object | The HTTP/JSON endpoint. | |||
endpoints.http.address | string | Its IPv6 address on the VPC. | |||
endpoints.http.port | integer | The HTTP port, 7474. | |||
regions | integer | How many regions the data is divided into now. | |||
servers | integer | Region servers running. | |||
executors | integer | Query servers running. | |||
storageBytes | integer | Bytes held in storage now. | |||
timestamp | integer | The newest transaction timestamp issued (for support). | |||
epoch | integer | Increases every time a new placement driver takes over. | |||
usage | object | What it has used, as billed: processor time and the bytes it holds now. | |||
usage.cpuSeconds | number | CPU time used since `since`, in seconds. | |||
usage.storageBytes | integer | Bytes it holds now (billed as GiB-seconds while they are held). | |||
usage.since | string | When metering started (RFC 3339). | |||
usage.fuelTotal | integer | Internal: all fuel counted so far (2 000 000 000 per CPU-second). | |||
usage.fuelSeen | object | Internal: the last fuel count seen per server. | |||
passwordVerifier | string | The salted verifier of the user's password (SCRAM-SHA-256), never the password. | |||
password | string | The user's password: present only in the response that created the database, never stored. | |||
conditions | list of object | Detailed state, one entry per aspect; Ready says whether the database accepts queries. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Size | .spec.sizeClass |
| Regions | .status.regions |
| Bolt | .status.endpoints.bolt.address |
| Phase | .status.phase |
| Detail | .status.conditions[0].message |