Merge pull request #104 from arangodb/title-case-enums

BREAKING CHANGE: Renamed all enum values to title case

Author: ewoutp

docs/Manual/GettingStarted/kube-arangodb/README.md

@@ -61,7 +61,7 @@ kind: "ArangoDeployment"
 metadata:
   name: "single-server"
 spec:
-  mode: single
+  mode: Single
 ```
 
 Now insert this resource in your Kubernetes cluster using:
@@ -164,7 +164,7 @@ kind: "ArangoDeployment"
 metadata:
   name: "cluster"
 spec:
-  mode: cluster
+  mode: Cluster
 ```
 
 Now insert this resource in your Kubernetes cluster using:

docs/Manual/Programs/kube-arangodb/config_and_secrets.md

@@ -34,7 +34,7 @@ kind: "Cluster"
 metadata:
   name: "example-arangodb-cluster"
 spec:
-  mode: cluster
+  mode: Cluster
   auth:
     jwtSecretName: <name-of-JWT-token-secret>
 ```

docs/Manual/Programs/kube-arangodb/deployment_resource.md

@@ -13,7 +13,7 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-arangodb-cluster"
 spec:
-  mode: cluster
+  mode: Cluster
 ```
 
 Example more elaborate deployment definition:
@@ -24,7 +24,8 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-arangodb-cluster"
 spec:
-  mode: cluster
+  mode: Cluster
+  environment: Production
   agents:
     count: 3
     args:
@@ -50,21 +51,21 @@ Below you'll find all settings of the `ArangoDeployment` custom resource.
 Several settings are for various groups of servers. These are indicated
 with `<group>` where `<group>` can be any of:
 
-- `agents` for all agents of a `cluster` or `resilientsingle` pair.
-- `dbservers` for all dbservers of a `cluster`.
-- `coordinators` for all coordinators of a `cluster`.
-- `single` for all single servers of a `single` instance or `resilientsingle` pair.
-- `syncmasters` for all syncmasters of a `cluster`.
-- `syncworkers` for all syncworkers of a `cluster`.
+- `agents` for all agents of a `Cluster` or `ResilientSingle` pair.
+- `dbservers` for all dbservers of a `Cluster`.
+- `coordinators` for all coordinators of a `Cluster`.
+- `single` for all single servers of a `Single` instance or `ResilientSingle` pair.
+- `syncmasters` for all syncmasters of a `Cluster`.
+- `syncworkers` for all syncworkers of a `Cluster`.
 
 ### `spec.mode: string`
 
 This setting specifies the type of deployment you want to create.
 Possible values are:
 
-- `cluster` (default) Full cluster. Defaults to 3 agents, 3 dbservers & 3 coordinators.
-- `resilientsingle` Resilient single pair. Defaults to 3 agents and 2 single servers.
-- `single` Single server only (note this does not provide high availability or reliability).
+- `Cluster` (default) Full cluster. Defaults to 3 agents, 3 dbservers & 3 coordinators.
+- `ResilientSingle` Resilient single pair. Defaults to 3 agents and 2 single servers.
+- `Single` Single server only (note this does not provide high availability or reliability).
 
 This setting cannot be changed after the deployment has been created.
 
@@ -73,9 +74,9 @@ This setting cannot be changed after the deployment has been created.
 This setting specifies the type of environment in which the deployment is created.
 Possible values are:
 
-- `development` (default) This value optimizes the deployment for development
+- `Development` (default) This value optimizes the deployment for development
   use. It is possible to run a deployment on a small number of nodes (e.g. minikube).
-- `production` This value optimizes the deployment for production use.
+- `Production` This value optimizes the deployment for production use.
   It puts required affinity constraints on all pods to avoid agents & dbservers
   from running on the same machine.
 
@@ -101,8 +102,8 @@ This setting specifies the type of storage engine used for all servers
 in the cluster.
 Possible values are:
 
-- `mmfiles` To use the MMfiles storage engine.
-- `rocksdb` (default) To use the RocksDB storage engine.
+- `MMFiles` To use the MMfiles storage engine.
+- `RocksDB` (default) To use the RocksDB storage engine.
 
 This setting cannot be changed after the cluster has been created.
 
@@ -211,7 +212,7 @@ The default value is empty.
 This setting sets the type of message queue used by ArangoSync.
 Possible values are:
 
-- `direct` (default) for direct HTTP connections between the 2 data centers.
+- `Direct` (default) for direct HTTP connections between the 2 data centers.
 
 ### `spec.sync.tls.caSecretName: string`
 

docs/Manual/Programs/kube-arangodb/storage.md

@@ -24,7 +24,7 @@ SSD storage.
 
 To accomplish this, one must create `PersistentVolumes` for all servers that
 need persistent storage (single, agents & dbservers).
-E.g. for a `cluster` with 3 agents and 5 dbservers, you must create 8 volumes.
+E.g. for a `Cluster` with 3 agents and 5 dbservers, you must create 8 volumes.
 
 Note that each volume must have a capacity that is equal to or higher than the
 capacity needed for each server.

examples/simple-cluster-no-tls.yaml

@@ -3,6 +3,6 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-simple-cluster-no-tls"
 spec:
-  mode: cluster
+  mode: Cluster
   tls:
     caSecretName: None

examples/simple-cluster.yaml

@@ -3,7 +3,7 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-simple-cluster"
 spec:
-  mode: cluster
+  mode: Cluster
   image: arangodb/arangodb:3.3.4
   tls:
     altNames: ["kube-01", "kube-02", "kube-03"]

examples/single-server-no-auth.yaml

@@ -3,7 +3,7 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-simple-single-no-auth"
 spec:
-  mode: single
+  mode: Single
   auth:
     jwtSecretName: None
 

examples/single-server.yaml

@@ -3,6 +3,6 @@ kind: "ArangoDeployment"
 metadata:
   name: "example-simple-single"
 spec:
-  mode: single
+  mode: Single
   single:
     storageClassName: my-local-ssd

pkg/apis/deployment/v1alpha/deployment_mode.go

@@ -31,11 +31,11 @@ type DeploymentMode string
 
 const (
 	// DeploymentModeSingle yields a single server
-	DeploymentModeSingle DeploymentMode = "single"
+	DeploymentModeSingle DeploymentMode = "Single"
 	// DeploymentModeResilientSingle yields an agency and a resilient-single server pair
-	DeploymentModeResilientSingle DeploymentMode = "resilientsingle"
+	DeploymentModeResilientSingle DeploymentMode = "ResilientSingle"
 	// DeploymentModeCluster yields an full cluster (agency, dbservers & coordinators)
-	DeploymentModeCluster DeploymentMode = "cluster"
+	DeploymentModeCluster DeploymentMode = "Cluster"
 )
 
 // Validate the mode.
@@ -49,22 +49,22 @@ func (m DeploymentMode) Validate() error {
 	}
 }
 
-// HasSingleServers returns true when the given mode is "single" or "resilientsingle".
+// HasSingleServers returns true when the given mode is "Single" or "ResilientSingle".
 func (m DeploymentMode) HasSingleServers() bool {
 	return m == DeploymentModeSingle || m == DeploymentModeResilientSingle
 }
 
-// HasAgents returns true when the given mode is "resilientsingle" or "cluster".
+// HasAgents returns true when the given mode is "ResilientSingle" or "Cluster".
 func (m DeploymentMode) HasAgents() bool {
 	return m == DeploymentModeResilientSingle || m == DeploymentModeCluster
 }
 
-// HasDBServers returns true when the given mode is "cluster".
+// HasDBServers returns true when the given mode is "Cluster".
 func (m DeploymentMode) HasDBServers() bool {
 	return m == DeploymentModeCluster
 }
 
-// HasCoordinators returns true when the given mode is "cluster".
+// HasCoordinators returns true when the given mode is "Cluster".
 func (m DeploymentMode) HasCoordinators() bool {
 	return m == DeploymentModeCluster
 }

pkg/apis/deployment/v1alpha/deployment_mode_test.go

@@ -30,17 +30,17 @@ import (
 
 func TestDeploymentModeValidate(t *testing.T) {
 	// Valid
-	assert.Nil(t, DeploymentMode("single").Validate())
-	assert.Nil(t, DeploymentMode("resilientsingle").Validate())
-	assert.Nil(t, DeploymentMode("cluster").Validate())
+	assert.Nil(t, DeploymentMode("Single").Validate())
+	assert.Nil(t, DeploymentMode("ResilientSingle").Validate())
+	assert.Nil(t, DeploymentMode("Cluster").Validate())
 
 	// Not valid
 	assert.Error(t, DeploymentMode("").Validate())
 	assert.Error(t, DeploymentMode(" cluster").Validate())
 	assert.Error(t, DeploymentMode("singles").Validate())
-	assert.Error(t, DeploymentMode("Single").Validate())
-	assert.Error(t, DeploymentMode("Resilientsingle").Validate())
-	assert.Error(t, DeploymentMode("Cluster").Validate())
+	assert.Error(t, DeploymentMode("single").Validate())
+	assert.Error(t, DeploymentMode("resilientsingle").Validate())
+	assert.Error(t, DeploymentMode("cluster").Validate())
 }
 
 func TestDeploymentModeHasX(t *testing.T) {