-
Notifications
You must be signed in to change notification settings - Fork 73
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
+62
−0
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
created
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed