Issue 324: Added testmode flag in charts (#331)

* Added testmode flag in charts Signed-off-by: anisha.kj <[email protected]> * Addressed comments Signed-off-by: anisha.kj <[email protected]> * addressed comments Signed-off-by: anisha.kj <[email protected]> * Fixed typo Signed-off-by: anisha.kj <[email protected]> * Fixed typo Signed-off-by: anisha.kj <[email protected]> * Fixed typo Signed-off-by: anisha.kj <[email protected]>
pravega · Mar 3, 2020 · 3250498 · 3250498
1 parent 3eac292
commit 3250498
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ The project is currently alpha. While no breaking API changes are currently plan
  * [Requirements](#requirements)
  * [Quickstart](#quickstart)    
     * [Install the Operator](#install-the-operator)
+       * [Deploying in Test Mode](#deploying-in-test-mode)
     * [Upgrade the Operator](#upgrade-the-operator)
     * [Install a sample Pravega Cluster](#install-a-sample-pravega-cluster)
     * [Scale a Pravega Cluster](#scale-a-pravega-cluster)
@@ -60,6 +61,9 @@ NAME                     DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
 foo-pravega-operator     1         1         1            1           17s
 ```
 
+#### Deploying in Test Mode
+ The Operator can be run in a "test" mode if we want to create pravega on minikube or on a cluster with very limited resources by  enabling `testmode: true` in `values.yaml` file. Operator running in test mode skips minimum replica requirement checks on Pravega components. "Test" mode ensures a bare minimum setup of pravega and is not recommended to be used in production environments.
+
 ### Upgrade the Operator
 Pravega operator can be upgraded by modifying the image tag using
 ```

diff --git a/charts/pravega-operator/templates/operator.yaml b/charts/pravega-operator/templates/operator.yaml
@@ -23,6 +23,9 @@ spec:
           name: metrics
         command:
         - pravega-operator
+        {{- if .Values.testmode }}
+        args: [-test]
+        {{- end }}
         env:
         - name: WATCH_NAMESPACE
           valueFrom:

diff --git a/charts/pravega-operator/values.yaml b/charts/pravega-operator/values.yaml
@@ -19,3 +19,6 @@ serviceAccount:
 # Whether to create custom resource
 crd:
   create: true
+
+# whether to enable test mode
+testmode: false
diff --git a/doc/manual-installation.md b/doc/manual-installation.md
@@ -30,6 +30,22 @@ Install the operator.
 $ kubectl create -f deploy/operator.yaml
 ```
 
+### Deploying in Test Mode
+ We can enable test mode on operator by passing an argument `-test` in `operator.yaml` file.
+ Check out [test mode](../README.md#deploying-in-test-mode)
+
+```
+containers:
+  - name: pravega-operator
+    image: pravega/pravega-operator:0.4.3-rc1
+    ports:
+    - containerPort: 60000
+      name: metrics
+    command:
+    - pravega-operator
+    imagePullPolicy: Always
+    args: [-test]
+```
 ### Set up Tier 2 Storage
 
 Pravega requires a long term storage provider known as Tier 2 storage.