use helm chart repo, added CONTRIBUTING, documentation fixes, minor flow fixes

Author: OriHoch

.travis.sh

@@ -22,7 +22,7 @@ elif [ "${1}" == "deploy" ]; then
     [ "$?" != "0" ] && exit 1
     if ! [ -z "${SLACK_TAG_NOTIFICATION_CHANNEL}" ] && ! [ -z "${SLACK_TAG_NOTIFICATION_WEBHOOK_URL}" ]; then
         ! curl -X POST \
-               --data-urlencode "payload={\"channel\": \"#${SLACK_TAG_NOTIFICATION_CHANNEL}\", \"username\": \"CKAN Cloud\", \"text\": \"Released ckan-cloud-helm ${TAG}\nhttps://github.com/ViderumGlobal/ckan-cloud-helm/releases/tag/${TAG}\", \"icon_emoji\": \":female-technologist:\"}" \
+               --data-urlencode "payload={\"channel\": \"#${SLACK_TAG_NOTIFICATION_CHANNEL}\", \"username\": \"CKAN Cloud\", \"text\": \"Released ckan-cloud-helm ${TRAVIS_TAG}\nhttps://github.com/ViderumGlobal/ckan-cloud-helm/releases/tag/${TRAVIS_TAG}\", \"icon_emoji\": \":female-technologist:\"}" \
                ${SLACK_TAG_NOTIFICATION_WEBHOOK_URL} && exit 1
     fi
     exit 0

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to CKAN Cloud Helm
+
+* Welcome to CKAN Cloud!
+* Contributions of any kind are welcome.
+* Please [Search for issues across the different CKAN Cloud repositories](https://github.com/search?q=repo%3AViderumGlobal%2Fckan-cloud-docker+repo%3AViderumGlobal%2Fckan-cloud-helm+repo%3AViderumGlobal%2Fckan-cloud-cluster&type=Issues)
+
+## Suggested development flow
+
+You want to make some changes to the helm charts? Great!
+
+Please follow this suggested flow:
+
+* Changes to Docker images should be done in ViderumGlobal/ckan-cloud-docker repo
+  * Test changes to the Docker images using the `ckan-cloud-docker` docker compose environment
+* Use the [Minikube environment](QUICKSTART_MINIKUBE.md) to test and modify the Helm templates
+* Finally, test on a [Production environment](QUICKSTART_PRODUCTION.md)
+
+## CI/CD
+
+* Helm chart repository is hosted on the same GitHub branch as the helm charts
+* The repository is updated when a new release is published on GitHub

QUICKSTART_DEVELOPMENT.md

@@ -111,6 +111,7 @@ kubectl --context minikube --namespace "${CKAN_NAMESPACE}" \
 ```
 export CCA_HELM_FUNCTIONS_KUBECTL_ARGS="--context minikube"
 export CCA_HELM_FUNCTIONS_HELM_ARGS="--kube-context minikube"
+export CKAN_CHART=ckan
 source cca_helm_functions.sh
 ```
 

QUICKSTART_PRODUCTION.md

@@ -19,22 +19,32 @@ helm version &&\
 helm list
 ```
 
+## Register the CKAN Cloud Helm charts repository
+
+```
+helm repo add ckan-cloud https://raw.githubusercontent.com/ViderumGlobal/ckan-cloud-helm/master/charts_repository
+```
+
 ## Get the code
 
 Clone from Git or download the source zip.
 
-All the following commands and scripts should run from current working directory: `datagov-ckan-multi/multi-tenant-helm`
+All the following commands and scripts should run from the `ckan-cloud-helm` project directory
 
-## Define utility functions
+## Define shortcut functions
 
 ```
+export KUBECONFIG=/etc/ckan-cloud/.kube-config
+export CCA_HELM_FUNCTIONS_KUBECTL_ARGS=""
+export CCA_HELM_FUNCTIONS_HELM_ARGS=""
+export CKAN_CHART=ckan-cloud/ckan
 source cca_helm_functions.sh
 ```
 
 ## Create CKAN namespace and RBAC
 
 ```
-export CKAN_NAMESPACE="test1"
+export CKAN_NAMESPACE="test2"
 
 cca_kubectl create ns "${CKAN_NAMESPACE}" &&\
 cca_kubectl create serviceaccount "ckan-${CKAN_NAMESPACE}-operator" &&\
@@ -48,7 +58,7 @@ cca_kubectl create rolebinding "ckan-${CKAN_NAMESPACE}-operator-rolebinding" \
 
 ## Deploy
 
-Save the values yaml file:
+Copy the values yaml file and (optionally) modify:
 
 ```
 sudo cp aws-values.yaml /etc/ckan-cloud/${CKAN_NAMESPACE}_values.yaml
@@ -86,31 +96,71 @@ cca_helm_upgrade --install --values /etc/ckan-cloud/${CKAN_NAMESPACE}_values.yam
 
 ## Login to CKAN
 
-Create an admin user
+ensure all pods are running
 
 ```
-cca_kubectl exec -it $(cca_pod_name ckan) -- bash -c "ckan-paster --plugin=ckan sysadmin -c /etc/ckan/production.ini \
-    add admin password=12345678 email=admin@localhost"
+cca_kubectl get pods
 ```
 
 Start port forward to the nginx pod
 
 ```
-cca_kubectl port-forward $(cca_pod_name nginx) 8080:80
+cca_kubectl port-forward $(cca_pod_name nginx) 8080
+```
+
+Add a hosts entry mapping domain `nginx` to `127.0.0.1`:
+
+```
+127.0.0.1 nginx
+```
+
+Ensure CKAN availability:
+
+```
+curl http://nginx:8080/api/3
+```
+
+Create an admin user
+
+```
+cca_kubectl exec -it $(cca_pod_name ckan) -- bash -c "ckan-paster --plugin=ckan sysadmin -c /etc/ckan/production.ini \
+    add admin password=12345678 email=admin@localhost"
 ```
 
-Login to CKAN at http://localhost:8080 with username `admin` password `12345678`
+Login to CKAN at http://nginx:8080 with username `admin` password `12345678`
 
 ## Expose via load balancer
 
 see [multi-tenant-cluster](../multi-tenant-cluster/README.md) for creating and configuring the load balancer
 
 Configure the load balancer to direct traffic to `http://nginx.<CKAN_NAMESPACE>:8080`
 
-Duplicate and modify `aws-values.yaml` and set the siteUrl to the relevant external domain.
+Modify the instance values and set the siteUrl to the relevant external domain.
 
 Deploy with the modified values:
 
 ```
 cca_helm_upgrade --install --values /etc/ckan-cloud/${CKAN_NAMESPACE}_values.yaml
 ```
+
+## Testing different CKAN helm chart releases
+
+The default deploy uses the latest released CKAN Helm chart.
+
+The `cca_helm_upgrade` function uses the `CKAN_CHART` environment variable to determine the chart to install.
+
+Check available chart versions from the repository:
+
+```
+helm repo update
+helm search ckan-cloud/ckan
+```
+
+* Use a specific chart release: `export CKAN_CHART="ckan-cloud/ckan --version v0.0.2"`
+* Use the chart from local directory `ckan` for testing local chart changes: `export CKAN_CHART=ckan`
+
+Deploy normally:
+
+```
+cca_helm_upgrade --install --values /etc/ckan-cloud/${CKAN_NAMESPACE}_values.yaml
+```

aws-values.yaml

@@ -16,7 +16,7 @@ registerSubdomain: "cloud-demo5"
 # These values are used to populate the CKAN Helm chart values
 
 # Main URL to the CKAN web-app and API
-siteUrl: http://localhost:8080
+siteUrl: http://nginx:8080
 
 # CKAN pods
 replicas: 2

cca_helm_functions.sh

@@ -15,6 +15,6 @@ cca_helm() {
 
 cca_helm_upgrade() {
   [ -z "${CKAN_NAMESPACE}" ] && echo missing CKAN_NAMESPACE env var && return 1
-  cca_helm upgrade --namespace $CKAN_NAMESPACE "ckan-cloud-${CKAN_NAMESPACE}" ckan --dry-run "$@" &&\
-  cca_helm upgrade --namespace $CKAN_NAMESPACE "ckan-cloud-${CKAN_NAMESPACE}" ckan "$@"
+  cca_helm upgrade --namespace $CKAN_NAMESPACE "ckan-cloud-${CKAN_NAMESPACE}" $CKAN_CHART --dry-run "$@" &&\
+  cca_helm upgrade --namespace $CKAN_NAMESPACE "ckan-cloud-${CKAN_NAMESPACE}" $CKAN_CHART "$@"
 }