From 0af588f8addf14077de03cc2e5ad33f64073907c Mon Sep 17 00:00:00 2001
From: Ewout Prangsma <ewout@prangsma.net>
Date: Fri, 2 Mar 2018 14:51:40 +0100
Subject: [PATCH 1/4] Spec for ArangoLocalStorage resource

---
 docs/user/storage_resource.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 docs/user/storage_resource.md

diff --git a/docs/user/storage_resource.md b/docs/user/storage_resource.md
new file mode 100644
index 000000000..15aa99ba4
--- /dev/null
+++ b/docs/user/storage_resource.md
@@ -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.

From 745ab7a4247fb1086dc564f83f759c3fe3736993 Mon Sep 17 00:00:00 2001
From: Ewout Prangsma <ewout@prangsma.net>
Date: Fri, 2 Mar 2018 14:58:02 +0100
Subject: [PATCH 2/4] Added field ref

---
 docs/user/storage_resource.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/docs/user/storage_resource.md b/docs/user/storage_resource.md
index 15aa99ba4..313fd6780 100644
--- a/docs/user/storage_resource.md
+++ b/docs/user/storage_resource.md
@@ -13,7 +13,8 @@ kind: "ArangoLocalStorage"
 metadata:
   name: "example-arangodb-storage"
 spec:
-  storageClassName: my-local-ssd
+  storageClass:
+    name: my-local-ssd
   localPath:
   - /mnt/big-ssd-disk
 ```
@@ -26,3 +27,33 @@ This definition results in:
   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.

From 1de26534fd9accb702bc6d1276b59c4d1477b899 Mon Sep 17 00:00:00 2001
From: Ewout Prangsma <ewout@prangsma.net>
Date: Tue, 6 Mar 2018 11:19:29 +0100
Subject: [PATCH 3/4] Typo

---
 docs/user/storage_resource.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/user/storage_resource.md b/docs/user/storage_resource.md
index 313fd6780..25803398d 100644
--- a/docs/user/storage_resource.md
+++ b/docs/user/storage_resource.md
@@ -35,7 +35,7 @@ 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.
+created `PersistentVolume` will use.
 
 If empty, this field defaults to the name of the `ArangoLocalStorage`
 object.

From 5cb31b42b47877963f8e018eac044fdfa1dcd764 Mon Sep 17 00:00:00 2001
From: Ewout Prangsma <ewout@prangsma.net>
Date: Tue, 6 Mar 2018 11:20:56 +0100
Subject: [PATCH 4/4] Added note about capacity

---
 docs/user/storage_resource.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/user/storage_resource.md b/docs/user/storage_resource.md
index 25803398d..362c0b729 100644
--- a/docs/user/storage_resource.md
+++ b/docs/user/storage_resource.md
@@ -28,6 +28,9 @@ This definition results in:
 - the dynamic cleanup of PersistentVolume's (created by
   the operator) after one is released.
 
+The provisioned volumes will have a capacity that matches
+the requested capacity of volume claims.
+
 ## Specification reference
 
 Below you'll find all settings of the `ArangoLocalStorage` custom resource.