move the example cluster to use helm

Author: timjohncurtis

README.md

@@ -6,8 +6,7 @@ align="right">
 # Tarantool Kubernetes operator
 
 The Tarantool Operator provides automation that simplifies the administration
-of [Tarantool Cartridge](https://github.com/tarantool/cartridge)-based clusters
-on Kubernetes.
+of [Tarantool Cartridge](https://github.com/tarantool/cartridge)-based cluster on Kubernetes.
 
 The Operator introduces new API version `tarantool.io/v1alpha1` and installs
 custom resources for objects of three custom types: Cluster, Role, and
@@ -45,71 +44,61 @@ will be removed.
 
 ## Deploying the Tarantool operator on minikube
 
-1. Install the required software:
+1. Install the required deployment utilities:
 
-    - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
+    * [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
+    * [helm](https://helm.sh/docs/intro/install/)
 
-    - [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
+    Pick one of these to run a local kubernetes cluster
+    * [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
+    * [Windows Docker Desktop](https://docs.docker.com/docker-for-windows/#kubernetes)
+    * [OSX Docker Desktop](https://docs.docker.com/docker-for-mac/#kubernetes)
 
-1. Create a `minikube` cluster:
+    To install and configure a local minikube installation:
 
-    ```shell
-    minikube start --memory=4096
-    ```
+    1. Create a `minikube` cluster:
 
-    You will need 4Gb of RAM allocated to the `minikube` cluster to run examples.
+        ```shell
+        minikube start --memory=4096
+        ```
 
-    Ensure `minikube` is up and running:
+        You will need 4Gb of RAM allocated to the `minikube` cluster to run examples.
 
-    ```shell
-    minikube status
-    ```
+        Ensure `minikube` is up and running:
 
-    In case of success you will see this output:
+        ```shell
+        minikube status
+        ```
 
-    ```shell
-    host: Running
-    kubelet: Running
-    apiserver: Running
-    ```
+        In case of success you will see this output:
 
-1. Enable Ingress add-on:
+        ```shell
+        host: Running
+        kubelet: Running
+        apiserver: Running
+        ```
 
-    ```shell
-    minikube addons enable ingress
-    ```
+    2. Enable minikube Ingress add-on:
 
-1. Create operator resources:
-
-    ```shell
-    kubectl create -f deploy/service_account.yaml
-    kubectl create -f deploy/role.yaml
-    kubectl create -f deploy/role_binding.yaml
-    ```
-
-1. Create Tarantool Operator CRD's (Custom Resource Definitions):
-
-    ```shell
-    kubectl create -f deploy/crds/tarantool_v1alpha1_cluster_crd.yaml
-    kubectl create -f deploy/crds/tarantool_v1alpha1_role_crd.yaml
-    kubectl create -f deploy/crds/tarantool_v1alpha1_replicasettemplate_crd.yaml
-    ```
+        ```shell
+        minikube addons enable ingress
+        ```
 
-1. Start the operator:
+2. Install the operator
 
     ```shell
-    kubectl create -f deploy/operator.yaml
+    helm install tarantool-operator ci/helm-chart --namespace tarantool --create-namespace
     ```
 
     Ensure the operator is up:
 
     ```shell
-    kubectl get pods --watch
+    watch kubectl get pods -n tarantool
     ```
 
     Wait for `tarantool-operator-xxxxxx-xx` Pod's status to become `Running`.
 
-## Example: key-value storage
+## Example Application: key-value storage
 
 `examples/kv` contains a Tarantool-based distributed key-value storage.
 Data are accessed via HTTP REST API.
@@ -126,19 +115,19 @@ Tarantool Operator is up and running.
 1. Create a cluster:
 
     ```shell
-    kubectl create -f examples/kv/deployment.yaml
+    helm install examples-kv-cluster examples/kv/helm-chart --namespace tarantool
     ```
 
-   Wait until all the cluster Pods are up (status becomes `Running`):
+    Wait until all the cluster Pods are up (status becomes `Running`):
 
-     ```shell
-     kubectl get pods --watch
-     ```
+    ```shell
+    watch kubectl -n tarantool get pods
+    ```
 
-1.  Ensure cluster became operational:
+2. Ensure cluster became operational:
 
     ```shell
-    kubectl describe clusters.tarantool.io examples-kv-cluster
+    kubectl -n tarantool describe clusters.tarantool.io examples-kv-cluster
     ```
 
     wait until Status.State is Ready:
@@ -150,25 +139,35 @@ Tarantool Operator is up and running.
     ...
     ```
 
-1. Access the cluster web UI:
+3. Access the cluster web UI:
 
-   1. Get `minikube` vm IP-address:
+    * If using minikube:
 
-       ```shell
-       minikube ip
-       ```
+        * Get `minikube` vm IP-address:
+
+        ```shell
+        minikube ip
+        ```
+
+        * Open **http://MINIKUBE_IP** in your browser.
+        Replace MINIKUBE_IP with the IP-address reported by the previous command.
+
+        ![Web UI](./assets/kv_web_ui.png)
+
+        > **_NOTE:_** Due to a recent
+        > [bug in Ingress](https://github.com/kubernetes/minikube/issues/2840),
+        > web UI may be inaccessible. If needed, you can try this
+        > [workaround](https://github.com/kubernetes/minikube/issues/2840#issuecomment-492454708).
 
-   1. Open **http://MINIKUBE_IP** in your browser.
-      Replace MINIKUBE_IP with the IP-address reported by the previous command.
+    * If using kubernetes in docker-desktop
 
-      ![Web UI](./assets/kv_web_ui.png)
+        Run: (MINIKUBE_IP will be localhost:8081 in this case)
 
-> **_NOTE:_** Due to a recent
-> [bug in Ingress](https://github.com/kubernetes/minikube/issues/2840),
-> web UI may be inaccessible. If needed, you can try this
-> [workaround](https://github.com/kubernetes/minikube/issues/2840#issuecomment-492454708).
+        ```shell
+        kc port-forward -n tarantool routers-0-0 8081:8081
+        ````
 
-1. Access the key-value API:
+4. Access the key-value API:
 
    1. Store some value:
 
@@ -182,7 +181,7 @@ Tarantool Operator is up and running.
        {"info":"Successfully created"}
        ```
 
-   1. Access stored values:
+   2. Access stored values:
 
        ```shell
        curl http://MINIKUBE_IP/kv_dump
@@ -198,49 +197,45 @@ Tarantool Operator is up and running.
 
 1. Increase the number of replica sets in Storages Role:
 
-    ```shell
-    kubectl edit roles.tarantool.io storage
+    in the examples-kv helm chart, edit the `examples/kv/helm-chart/values.yaml` file to be
+
+    ```yaml
+    - RoleName: storage
+      ReplicaCount: 1
+      ReplicaSetCount: 2
     ```
 
-    This will open the resource in a text editor.
-    Change `spec.numReplicasets` field value to 3:
+    Then run:
 
     ```shell
-    spec:
-      numReplicasets: 3
+    helm upgrade examples-kv-cluster examples/kv/helm-chart --namespace tarantool
     ```
 
-    Save your changes and exit the editor.
+    This will add another storage role replica set to the existing cluster. View the new cluster topology via the cluster web UI.
 
-    This will add new replica sets to the existing cluster.
+2. Increase the number of replicas across all Storages Role replica sets:
 
-    View the new cluster topology via the cluster web UI.
+    in the examples-kv helm chart, edit the `examples/kv/helm-chart/values.yaml` file to be
 
-1. Increase the number of replicas across all Storages Role replica sets:
-
-    ```shell
-    kubectl edit replicasettemplates.tarantool.io storage-template
+    ```yaml
+    - RoleName: storage
+      ReplicaCount: 2
+      ReplicaSetCount: 2
     ```
 
-    This will open the resource in a text editor.
-    Change `spec.replicas` field value to 3:
+    Then run:
 
     ```shell
-    spec:
-      replicas: 3
+    helm upgrade examples-kv-cluster examples/kv/helm-chart --namespace tarantool
     ```
 
-    Save your changes and exit the editor.
+    This will add one more replica to each Storages Role replica set. View the new cluster topology via the cluster web UI.
 
-    This will add one more replica to each Storages Role replica set.
+### Building tarantool-operator docker image
 
-    View the new cluster topology via the cluster web UI.
-
-> **_NOTE:_** When `kubectl` 1.16 is out, you will be able to scale the
-> application with a single `kubectl scale` command, for example
-> `kubectl scale roles.tarantool.io storage --replicas=3`.
-> With younger versions of `kubectl` this is impossible due to
-> [this bug](https://github.com/kubernetes/kubernetes/issues/80515).
+```shell
+docker build -f build/Dockerfile -t tarantool-operator .
+```
 
 ### Running tests
 

assets/kv_web_ui.png

@@ -0,0 +1,63 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: clusters.tarantool.io
+spec:
+  additionalPrinterColumns:
+    - JSONPath: .status.state
+      name: State
+      type: string
+    - JSONPath: .metadata.creationTimestamp
+      name: Age
+      type: date
+  group: tarantool.io
+  names:
+    kind: Cluster
+    listKind: ClusterList
+    plural: clusters
+    singular: cluster
+  scope: Namespaced
+  subresources:
+    status: {}
+  validation:
+    openAPIV3Schema:
+      properties:
+        apiVersion:
+          description:
+            "APIVersion defines the versioned schema of this representation
+            of an object. Servers should convert recognized schemas to the latest
+            internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
+          type: string
+        kind:
+          description:
+            "Kind is a string value representing the REST resource this
+            object represents. Servers may infer this from the endpoint the client
+            submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
+          type: string
+        metadata:
+          type: object
+        spec:
+          properties:
+            selector:
+              description:
+                'INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+                Important: Run "operator-sdk generate k8s" to regenerate code after
+                modifying this file Add custom validation using kubebuilder tags:
+                https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html'
+              type: object
+          type: object
+        status:
+          properties:
+            state:
+              description:
+                'INSERT ADDITIONAL STATUS FIELD - define observed state
+                of cluster Important: Run "operator-sdk generate k8s" to regenerate
+                code after modifying this file Add custom validation using kubebuilder
+                tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html'
+              type: string
+          type: object
+  version: v1alpha1
+  versions:
+    - name: v1alpha1
+      served: true
+      storage: true

ci/helm-chart/templates/crds/tarantool_v1alpha1_cluster_crd.yaml

@@ -0,0 +1,42 @@
+---
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: replicasettemplates.tarantool.io
+spec:
+  group: tarantool.io
+  names:
+    kind: ReplicasetTemplate
+    listKind: ReplicasetTemplateList
+    plural: replicasettemplates
+    singular: replicasettemplate
+  scope: Namespaced
+  subresources:
+    status: {}
+  validation:
+    openAPIV3Schema:
+      properties:
+        apiVersion:
+          description:
+            "APIVersion defines the versioned schema of this representation
+            of an object. Servers should convert recognized schemas to the latest
+            internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
+          type: string
+        kind:
+          description:
+            "Kind is a string value representing the REST resource this
+            object represents. Servers may infer this from the endpoint the client
+            submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
+          type: string
+        metadata:
+          type: object
+        spec:
+          type: object
+        status:
+          type: object
+  version: v1alpha1
+  versions:
+    - name: v1alpha1
+      served: true
+      storage: true
+---