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

Added custom resource spec for ArangoDB Storage operator. #30

Merged
merged 4 commits into from
Mar 6, 2018
Merged
Changes from 2 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
59 changes: 59 additions & 0 deletions docs/user/storage_resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 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:
storageClass:
name: 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.

## Specification reference

Below you'll find all settings of the `ArangoLocalStorage` custom resource.

### `spec.storageClass.name: string`

This setting specifies the name of the storage class that
creates `PersistentVolume` will use.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed


If empty, this field defaults to the name of the `ArangoLocalStorage`
object.

If a `StorageClass` with given name does not yet exist, it
will be created.

### `spec.storageClass.isDefault: bool`

This setting specifies if the created `StorageClass` will
be marked as default storage class. (default is `false`)

### `spec.localPath: stringList`

This setting specifies one of more local directories
(on the nodes) used to create persistent volumes in.

### `spec.nodeSelector: nodeSelector`

This setting specifies which nodes the operator will
provision persistent volumes on.