mirror of
https://github.com/arangodb/kube-arangodb.git
synced 2024-12-14 11:57:37 +00:00
Spec for ArangoLocalStorage resource
This commit is contained in:
parent
f1a4583f23
commit
0af588f8ad
1 changed files with 28 additions and 0 deletions
28
docs/user/storage_resource.md
Normal file
28
docs/user/storage_resource.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
# ArangoLocalStorage Custom Resource
|
||||
|
||||
The ArangoDB Storage operator creates and maintains ArangoDB
|
||||
storage resources in a Kubernetes cluster, given a storage specification.
|
||||
This storage specification is a CustomResource following
|
||||
a CustomResourceDefinition created by the operator.
|
||||
|
||||
Example minimal storage definition:
|
||||
|
||||
```yaml
|
||||
apiVersion: "storage.arangodb.com/v1alpha"
|
||||
kind: "ArangoLocalStorage"
|
||||
metadata:
|
||||
name: "example-arangodb-storage"
|
||||
spec:
|
||||
storageClassName: my-local-ssd
|
||||
localPath:
|
||||
- /mnt/big-ssd-disk
|
||||
```
|
||||
|
||||
This definition results in:
|
||||
|
||||
- a `StorageClass` called `my-local-ssd`
|
||||
- the dynamic provisioning of PersistentVolume's with
|
||||
a local volume on a node where the local volume starts
|
||||
in a sub-directory of `/mnt/big-ssd-disk`.
|
||||
- the dynamic cleanup of PersistentVolume's (created by
|
||||
the operator) after one is released.
|
Loading…
Reference in a new issue