Merge branch 'master' into add/ingress

Author: warrenvw

.circleci/config.yml

@@ -1,4 +1,12 @@
-version: 2
+version: 2.1
+
+# Add additional CircleCI Orbs dependencies
+orbs:
+  # https://circleci.com/orbs/registry/orb/circleci/kubernetes
+  kube: circleci/[email protected]
+  # https://circleci.com/orbs/registry/orb/circleci/helm
+  helm: circleci/[email protected]
+
 jobs:
   # Run Helm Lint checks
   helm-lint:
@@ -52,6 +60,48 @@ jobs:
           command: kubeval $(find . -type f)
           working_directory: enterprise/stackstorm-ha/templates/
 
+  # Spin up lightweight K8s cluster with 'KIND' and run Helm chart & e2e tests on it
+  helm-e2e:
+    machine:
+      # Available images https://circleci.com/docs/2.0/configuration-reference/#available-machine-images
+      image: ubuntu-1604:201903-01
+    steps:
+      - checkout
+      - kube/install
+      - helm/install-helm-client
+      - run:
+          name: Apply workaround for rabbitmq-ha chart DNS issue
+          command: |
+            # busybox image used in rabbitmq-ha chart timeouts on DNS resolution
+            # multiple 'search' domains in resolv.conf makes it even worse
+            # https://github.com/kubernetes/kubernetes/issues/66924
+            sudo sed -i '/^search/ d' /etc/resolv.conf
+      - run:
+          name: Install K8s in Docker (KinD)
+          command: sudo wget -O /usr/local/bin/kind https://github.com/kubernetes-sigs/kind/releases/download/v0.3.0/kind-linux-amd64 && sudo chmod +x /usr/local/bin/kind
+      - run:
+          name: Create new K8s cluster
+          command: |
+            kind create cluster
+            echo 'export KUBECONFIG="$(kind get kubeconfig-path)"' >> $BASH_ENV
+      - helm/install-helm-on-cluster:
+          enable-cluster-wide-admin-access: true
+      - run:
+          name: Update Helm repo dependencies
+          command: |
+            helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
+            helm dependency update
+      - run:
+          name: Helm install stackstorm-ha chart
+          command: |
+            # disable mongodb-ha chart persistent volumes as cluster can't start in CircleCI/KinD env
+            helm install --debug --name stackstorm-ha . \
+              --set mongodb-ha.persistentVolume.enabled=false
+      - run:
+          when: always
+          name: Show created K8s resources
+          command: kubectl get all
+
 workflows:
   version: 2
   helm:
@@ -60,6 +110,10 @@ workflows:
       - k8s-lint:
           requires:
             - helm-lint
+      - helm-e2e:
+          requires:
+            - helm-lint
+            - k8s-lint
 
 experimental:
   notify:

README.md

@@ -19,6 +19,7 @@ It's more than welcome to fine-tune each component settings to fit specific avai
 
 2) Pull 3rd party Helm dependencies:
 ```
+helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
 helm dependency update
 ```
 
@@ -253,3 +254,15 @@ Grab all logs only for stackstorm backend services, excluding st2web and DB/MQ/e
 ```
 kubectl logs -l release=<release-name>,tier=backend
 ```
+
+## Extending this chart
+If you have any suggestions or ideas about how to extend this chart functionality,
+we welcome you to collaborate in [Issues](https://github.com/stackstorm/stackstorm-ha/issues)
+and contribute via [Pull Requests](https://github.com/stackstorm/stackstorm-ha/pulls).  
+However if you need something very custom and specific to your infra that doesn't fit official chart plans,
+we strongly recommend you to create a parent Helm chart with custom K8s objects and referencing `stackstorm-ha` chart
+as a child dependency.
+This approach allows not only extending sub-chart with custom objects and templates within the same deployment,
+but also adds flexibility to include many sub-chart dependencies and pin versions as well as include all the sub-chart values in one single place.
+This approach is infra-as-code friendly and more reproducible. See official Helm documentation about
+[Subcharts](https://helm.sh/docs/chart_template_guide/#subcharts-and-global-values) and [Dependencies](https://helm.sh/docs/developing_charts/#managing-dependencies-manually-via-the-charts-directory).