Merge pull request #8 from Ocelot-Social-Community/7-refactor-build-of-docker-image-and-deployment

chore: 🍰 Implement Use Of package.json 'Version' Etc. For Build And Refine Helm Chart
2021-05-15 14:13:59 +02:00 · 2021-05-15 14:13:59 +02:00 · e587f88743
commit e587f88743
parent 682a7c3c5c 936743d8b5
11 changed files with 254 additions and 75 deletions
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@ -4,8 +4,51 @@ on:
  push:
    branches:
      - master
+# on: [push] # for testing while developing

 jobs:
+  ##############################################################################
+  # JOB: DOCKER BUILD COMMUNITY NEO4J ##########################################
+  ##############################################################################
+  build_branded_neo4j:
+    name: Docker Build Branded - Neo4j Community
+    runs-on: ubuntu-latest
+    #needs: [nothing]
+    steps:
+      ##########################################################################
+      # CHECKOUT CODE ##########################################################
+      ##########################################################################
+      - name: Checkout code
+        uses: actions/checkout@v2
+      ##########################################################################
+      # SET ENVS ###############################################################
+      ##########################################################################
+      - name: ENV - VERSION
+        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
+      - name: ENV - BUILD_DATE
+        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
+      - name: ENV - BUILD_VERSION
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
+      - name: ENV - BUILD_COMMIT
+        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
+      ##########################################################################
+      # BUILD NEO4J DOCKER IMAGE (community-branded) ###########################
+      ##########################################################################
+      - name: Neo4j | Build `community-branded` image
+        run: |
+          docker build --target community-branded -t "${DOCKER_ORGANISATION}/neo4j-community-branded:latest" -t "${DOCKER_ORGANISATION}/neo4j-community-branded:${VERSION}" -t "${DOCKER_ORGANISATION}/neo4j-community-branded:${BUILD_VERSION}" -f docker/neo4j.Dockerfile --build-arg APP_IMAGE=ocelotsocialnetwork/neo4j:${OCELOT_DOCKER_VERSION_TAG} .
+          docker save "${DOCKER_ORGANISATION}/neo4j-community-branded" > /tmp/neo4j-community-branded.tar
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: docker-neo4j-community-branded
+          path: /tmp/neo4j-community-branded.tar
+
  ##############################################################################
  # JOB: DOCKER BUILD BRANDED BACKEND ##########################################
  ##############################################################################
@ -26,8 +69,13 @@ jobs:
        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
      - name: ENV - BUILD_DATE
        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
      - name: ENV - BUILD_VERSION
-        run: echo "BUILD_VERSION=${VERSION}.${GITHUB_RUN_NUMBER}" >> $GITHUB_ENV
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
      - name: ENV - BUILD_COMMIT
        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
      ##########################################################################
@ -35,8 +83,8 @@ jobs:
      ##########################################################################
      - name: backend | Build `branded` image
        run: |
-          docker build --target branded -t "ocelotsocialnetwork/backend-branded:latest" -t "ocelotsocialnetwork/backend-branded:${VERSION}" -t "ocelotsocialnetwork/backend-branded:${BUILD_VERSION}" -f docker/backend.Dockerfile .
-          docker save "ocelotsocialnetwork/backend-branded" > /tmp/backend-branded.tar
+          docker build --target branded -t "${DOCKER_ORGANISATION}/backend-branded:latest" -t "${DOCKER_ORGANISATION}/backend-branded:${VERSION}" -t "${DOCKER_ORGANISATION}/backend-branded:${BUILD_VERSION}" -f docker/backend.Dockerfile --build-arg APP_IMAGE=ocelotsocialnetwork/backend:${OCELOT_DOCKER_VERSION_TAG} .
+          docker save "${DOCKER_ORGANISATION}/backend-branded" > /tmp/backend-branded.tar
      - name: Upload Artifact
        uses: actions/upload-artifact@v2
        with:
@ -63,8 +111,13 @@ jobs:
        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
      - name: ENV - BUILD_DATE
        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
      - name: ENV - BUILD_VERSION
-        run: echo "BUILD_VERSION=${VERSION}.${GITHUB_RUN_NUMBER}" >> $GITHUB_ENV
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
      - name: ENV - BUILD_COMMIT
        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
      ##########################################################################
@ -72,8 +125,8 @@ jobs:
      ##########################################################################
      - name: webapp | Build `branded` image
        run: |
-          docker build --target branded -t "ocelotsocialnetwork/webapp-branded:latest" -t "ocelotsocialnetwork/webapp-branded:${VERSION}" -t "ocelotsocialnetwork/webapp-branded:${BUILD_VERSION}" -f docker/webapp.Dockerfile .
-          docker save "ocelotsocialnetwork/webapp-branded" > /tmp/webapp-branded.tar
+          docker build --target branded -t "${DOCKER_ORGANISATION}/webapp-branded:latest" -t "${DOCKER_ORGANISATION}/webapp-branded:${VERSION}" -t "${DOCKER_ORGANISATION}/webapp-branded:${BUILD_VERSION}" -f docker/webapp.Dockerfile --build-arg APP_IMAGE=ocelotsocialnetwork/webapp:${OCELOT_DOCKER_VERSION_TAG} .
+          docker save "${DOCKER_ORGANISATION}/webapp-branded" > /tmp/webapp-branded.tar
      - name: Upload Artifact
        uses: actions/upload-artifact@v2
        with:
@ -100,8 +153,13 @@ jobs:
        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
      - name: ENV - BUILD_DATE
        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
      - name: ENV - BUILD_VERSION
-        run: echo "BUILD_VERSION=${VERSION}.${GITHUB_RUN_NUMBER}" >> $GITHUB_ENV
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
      - name: ENV - BUILD_COMMIT
        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
      ##########################################################################
@ -109,8 +167,8 @@ jobs:
      ##########################################################################
      - name: maintenance | Build `branded` image
        run: |
-          docker build --target branded -t "ocelotsocialnetwork/maintenance-branded:latest" -t "ocelotsocialnetwork/maintenance-branded:${VERSION}" -t "ocelotsocialnetwork/maintenance-branded:${BUILD_VERSION}" -f docker/maintenance.Dockerfile .
-          docker save "ocelotsocialnetwork/maintenance-branded" > /tmp/maintenance-branded.tar
+          docker build --target branded -t "${DOCKER_ORGANISATION}/maintenance-branded:latest" -t "${DOCKER_ORGANISATION}/maintenance-branded:${VERSION}" -t "${DOCKER_ORGANISATION}/maintenance-branded:${BUILD_VERSION}" -f docker/maintenance.Dockerfile --build-arg APP_IMAGE=ocelotsocialnetwork/maintenance:${OCELOT_DOCKER_VERSION_TAG} .
+          docker save "${DOCKER_ORGANISATION}/maintenance-branded" > /tmp/maintenance-branded.tar
      - name: Upload Artifact
        uses: actions/upload-artifact@v2
        with:
@ -123,7 +181,7 @@ jobs:
  upload_to_dockerhub:
    name: Upload to Dockerhub
    runs-on: ubuntu-latest
-    needs: [build_branded_backend,build_branded_webapp,build_branded_maintenance]
+    needs: [build_branded_neo4j,build_branded_backend,build_branded_webapp,build_branded_maintenance]
    env:
      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
@ -134,8 +192,33 @@ jobs:
      - name: Checkout code
        uses: actions/checkout@v2
      ##########################################################################
+      # SET ENVS ###############################################################
+      ##########################################################################
+      - name: ENV - VERSION
+        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
+      - name: ENV - BUILD_DATE
+        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
+      - name: ENV - BUILD_VERSION
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
+      - name: ENV - BUILD_COMMIT
+        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
+      ##########################################################################
      # DOWNLOAD DOCKER IMAGES #################################################
      ##########################################################################
+      # Neo4j Community
+      - name: Download Docker Image (Neo4j Community)
+        uses: actions/download-artifact@v2
+        with:
+          name: docker-neo4j-community-branded
+          path: /tmp
+      - name: Load Docker Image
+        run: docker load < /tmp/neo4j-community-branded.tar
+      # Backend
      - name: Download Docker Image (Backend)
        uses: actions/download-artifact@v2
        with:
@ -143,13 +226,15 @@ jobs:
          path: /tmp
      - name: Load Docker Image
        run: docker load < /tmp/backend-branded.tar
-      - name: Download Docker Image (WebApp)
+      # Webapp
+      - name: Download Docker Image (Webapp)
        uses: actions/download-artifact@v2
        with:
          name: docker-webapp-branded
          path: /tmp
      - name: Load Docker Image
        run: docker load < /tmp/webapp-branded.tar
+      # Maintenance
      - name: Download Docker Image (Maintenance)
        uses: actions/download-artifact@v2
        with:
@ -162,12 +247,14 @@ jobs:
      ##########################################################################
      - name: login to dockerhub
        run: echo "${DOCKERHUB_TOKEN}" | docker login -u "${DOCKERHUB_USERNAME}" --password-stdin
-      - name: Push backend
-        run: docker push --all-tags ocelotsocialnetwork/backend-branded
-      - name: Push webapp
-        run: docker push --all-tags ocelotsocialnetwork/webapp-branded
-      - name: Push maintenance
-        run: docker push --all-tags ocelotsocialnetwork/maintenance-branded
+      - name: Push Neo4j Community
+        run: docker push --all-tags ${DOCKER_ORGANISATION}/neo4j-community-branded
+      - name: Push Backend
+        run: docker push --all-tags ${DOCKER_ORGANISATION}/backend-branded
+      - name: Push Webapp
+        run: docker push --all-tags ${DOCKER_ORGANISATION}/webapp-branded
+      - name: Push Maintenance
+        run: docker push --all-tags ${DOCKER_ORGANISATION}/maintenance-branded

  ##############################################################################
  # JOB: GITHUB TAG LATEST VERSION #############################################
@ -191,8 +278,13 @@ jobs:
        run: echo "VERSION=$(node -p -e "require('./package.json').version")" >> $GITHUB_ENV
      - name: ENV - BUILD_DATE
        run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+      - name: ENV - OCELOT_DOCKER_VERSION_TAG
+        run: echo "OCELOT_DOCKER_VERSION_TAG=$(node -p -e "require('./package.json').ocelotDockerVersionTag")" >> $GITHUB_ENV
+      - name: ENV - DOCKER_ORGANISATION
+        run: echo "DOCKER_ORGANISATION=$(node -p -e "require('./package.json').dockerOrganisation")" >> $GITHUB_ENV
+      # this is oriented on the node docker version tag "node:12.19.0-alpine3.10" and looks like "app-branded:1.0.2-3-ocelot.social1.0.2-79"
      - name: ENV - BUILD_VERSION
-        run: echo "BUILD_VERSION=${VERSION}.${GITHUB_RUN_NUMBER}" >> $GITHUB_ENV
+        run: echo "BUILD_VERSION=${VERSION}-${GITHUB_RUN_NUMBER}-ocelot.social${OCELOT_DOCKER_VERSION_TAG}" >> $GITHUB_ENV
      - name: ENV - BUILD_COMMIT
        run: echo "BUILD_COMMIT=${GITHUB_SHA}" >> $GITHUB_ENV
      ##########################################################################
--- a/deployment/kubernetes/Chart.yaml
+++ b/deployment/kubernetes/Chart.yaml
@ -5,8 +5,8 @@ version: "1.0.0"
 # The appVersion defines which docker image is pulled.
 # Having it set to latest will pull the latest build on dockerhub.
 # You are free to define a specific version here tho.
-# e.g. appVersion: "0.6.10"
-# Be aware that this requires all dockers to have the same version available.
+# e.g. appVersion: "latest" or "1.0.2-3-ocelot.social1.0.2-79"
+# Be aware that this requires all your apps to have the same docker image version available.
 appVersion: "latest"
 description: The Helm chart for ocelot.social
 home: https://ocelot.social
--- a/deployment/kubernetes/README.md
+++ b/deployment/kubernetes/README.md
@ -1,40 +1,54 @@
-# Helm installation of Ocelot.social
+# Helm Installation Of Ocelot.Social

-Deploying Ocelot.social with Helm is very straight forward. All you have to do is to change certain parameters, like domain names and API keys, then you just install our provided Helm chart to your cluster.
+Deploying *ocelot.social* with Helm is very straight forward. All you have to do is to change certain parameters, like domain names and API keys, then you just install our provided Helm chart to your cluster.

 ## Configuration

-You can customize the network with your configuration by changing the `values.yaml`, all variables will be available as environment variables in your deployed kubernetes pods. For more details refer to the `values.yaml.dist` file.
+You can customize the network with your configuration by duplicate the `values.template.yaml` to a new `values.yaml` file and change it to your need. All included variables will be available as environment variables in your deployed kubernetes pods.

-Besides the `values.yaml.dist` file we provide a `nginx.values.yaml.dist` and `dns.values.yaml.dist`. The `nginx.values.yaml` is the configuration for the ingress-nginx helm chart, while the `dns.values.yaml` file is for automatically updating the dns values on digital ocean and therefore optional.
-
-As hinted above you should copy the given files and rename them accordingly. Then go ahead and modify the values in the newly created files accordingly.
+Besides the `values.template.yaml` file we provide a `nginx.values.template.yaml` and `dns.values.template.yaml` for a similar procedure. The new `nginx.values.yaml` is the configuration for the ingress-nginx Helm chart, while the `dns.values.yaml` file is for automatically updating the dns values on digital ocean and therefore optional.

 ## Installation

-Due to the many limitations of Helm you still have to do several manual steps. Those occur before you run the actual ocelot helm chart. Obviously it is expected of you to have `helm` and `kubectl` installed. For Digital Ocean you might require `doctl` aswell.
+Due to the many limitations of Helm you still have to do several manual steps. Those occur before you run the actual *ocelot.social* Helm chart. Obviously it is expected of you to have `helm` and `kubectl` installed. For Digital Ocean you might require `doctl` aswell.

 ### Cert Manager (https)

 Please refer to [cert-manager.io docs](https://cert-manager.io/docs/installation/kubernetes/) for more details.

+***ATTENTION:*** *Be with the Terminal in your repository in the folder of this README.*
+
 1. Create Namespace

 ```bash
-kubectl --kubeconfig=/../kubeconfig.yaml create namespace cert-manager
+# kubeconfig.yaml set globaly
+$ kubectl create namespace cert-manager
+# or kubeconfig.yaml in your repo, then adjust
+$ kubectl --kubeconfig=/../kubeconfig.yaml create namespace cert-manager
 ```

-2. Add Helm Repo & update
+2. Add Helm repository and update

 ```bash
-helm repo add jetstack https://charts.jetstack.io
-helm repo update
+$ helm repo add jetstack https://charts.jetstack.io
+$ helm repo update
 ```

 3. Install Cert-Manager Helm chart
+
 ```bash
-# this can not be included sine the CRDs cant be installed properly via helm...
-helm --kubeconfig=/../kubeconfig.yaml \
+# option 1
+# this can't be applied via kubectl to our cluster since the CRDs can't be installed properly this way ...
+# $ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.3.1/cert-manager.crds.yaml
+
+# option 2
+# kubeconfig.yaml set globaly
+$ helm install cert-manager jetstack/cert-manager \
+  --namespace cert-manager \
+  --version v1.1.0 \
+  --set installCRDs=true
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml \
  install cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --version v1.1.0 \
@ -43,15 +57,20 @@ helm --kubeconfig=/../kubeconfig.yaml \

 ### Ingress-Nginx

-1. Add Helm Repo & update
+1. Add Helm repository and update
+
 ```bash
-helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
-helm repo update
+$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+$ helm repo update
 ```

 2. Install ingress-nginx
+
 ```bash
-helm --kubeconfig=/../kubeconfig.yaml install ingress-nginx ingress-nginx/ingress-nginx -f nginx.values.yaml
+# kubeconfig.yaml set globaly
+$ helm install ingress-nginx ingress-nginx/ingress-nginx -f nginx.values.yaml
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml install ingress-nginx ingress-nginx/ingress-nginx -f nginx.values.yaml
 ```

 ### Digital Ocean Firewall
@ -61,56 +80,101 @@ This is only necessary if you run Digital Ocean without load balancer ([see here
 1. Authenticate towards DO with your local `doctl`

 You will need a DO token for that.
+
 ```bash
-doctl auth init
+# without doctl context
+$ doctl auth init
+# with doctl new context to be filled in
+$ doctl auth init --context <new-context-name>
 ```

+You will need an API token, which you can generate in the control panel at <https://cloud.digitalocean.com/account/api/tokens> .
+
 2. Generate DO firewall
+
+Fill in the `CLUSTER_UUID` and `your-domain` (Get the `CLUSTER_UUID` value from the dashboard or the ID column from doctl kubernetes cluster list.):
+
 ```bash
-doctl compute firewall create \
+# without doctl context
+$ doctl compute firewall create \
 --inbound-rules="protocol:tcp,ports:80,address:0.0.0.0/0,address:::/0 protocol:tcp,ports:443,address:0.0.0.0/0,address:::/0" \
--tag-names=k8s:1ebf0cdc-86c9-4384-936b-40010b71d049 \
--name=my-domain-http-https
+--tag-names=k8s:<CLUSTER_UUID> \
+--name=<your-domain>-http-https
+# with doctl context to be filled in
+$ doctl compute firewall create \
+--inbound-rules="protocol:tcp,ports:80,address:0.0.0.0/0,address:::/0 protocol:tcp,ports:443,address:0.0.0.0/0,address:::/0" \
+--tag-names=k8s:<CLUSTER_UUID> \
+--name=<your-domain>-http-https --context <context-name>
+```
+
+To get informations about your success use this command. (Fill in the `ID` you got at creation.):
+
+```bash
+# without doctl context
+$ doctl compute firewall get <ID>
+# with doctl context to be filled in
+$ doctl compute firewall get <ID> --context <context-name>
 ```

 ### DNS

 This chart is only necessary (recommended is more precise) if you run Digital Ocean without load balancer.
-You need to generate a token for the `dns.values.yaml`.
+You need to generate an access token with read + write for the `dns.values.yaml` at <https://cloud.digitalocean.com/account/api/tokens> and fill it in.
+
+1. Add Helm repository and update

-1. Add Helm Repo & update
 ```bash
-helm repo add bitnami https://charts.bitnami.com/bitnami
-helm repo update
+$ helm repo add bitnami https://charts.bitnami.com/bitnami
+$ helm repo update
 ```

 2. Install DNS
+
 ```bash
-helm --kubeconfig=/../kubeconfig.yaml install dns bitnami/external-dns -f dns.values.yaml
+# kubeconfig.yaml set globaly
+$ helm install dns bitnami/external-dns -f dns.values.yaml
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml install dns bitnami/external-dns -f dns.values.yaml
 ```

-### Ocelot.social
+### Ocelot.Social

 All commands for ocelot need to be executed in the kubernetes folder. Therefore `cd deployment/kubernetes/` is expected to be run before every command. Furthermore the given commands will install ocelot into the default namespace. This can be modified to by attaching `--namespace not.default`.

 #### Install
+
+Only run once for the first time of installation:
+
 ```bash
-helm --kubeconfig=/../kubeconfig.yaml install ocelot ./
+# kubeconfig.yaml set globaly
+$ helm install ocelot ./
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml install ocelot ./
 ```

-#### Upgrade
+#### Upgrade & Update
+
+Run for all upgrades and updates:
+
 ```bash
-helm --kubeconfig=/../kubeconfig.yaml upgrade ocelot ./
+# kubeconfig.yaml set globaly
+$ helm upgrade ocelot ./
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml upgrade ocelot ./
 ```

 #### Uninstall
+
 Be aware that if you uninstall ocelot the formerly bound volumes become unbound. Those volumes contain all data from uploads and database. You have to manually free their reference in order to bind them again when reinstalling. Once unbound from their former container references they should automatically be rebound (considering the sizes did not change)

 ```bash
-helm --kubeconfig=/../kubeconfig.yaml uninstall ocelot
+# kubeconfig.yaml set globaly
+$ helm uninstall ocelot
+# or kubeconfig.yaml in your repo, then adjust
+$ helm --kubeconfig=/../kubeconfig.yaml uninstall ocelot
 ```

-## Error reporting
+## Error Reporting

 We use [Sentry](https://github.com/getsentry/sentry) for error reporting in both
 our backend and web frontend. You can either use a hosted or a self-hosted
--- a/deployment/kubernetes/dns.values.template.yaml
+++ b/deployment/kubernetes/dns.values.template.yaml
@ -1,3 +1,5 @@
+# please duplicate template file and rename to "dns.values.yaml" and fill in your value
+
 provider: digitalocean
 digitalocean:
  # create the API token at https://cloud.digitalocean.com/account/api/tokens
--- a/deployment/kubernetes/nginx.values.template.yaml
+++ b/deployment/kubernetes/nginx.values.template.yaml
@ -1,3 +1,5 @@
+# please duplicate template file and rename to "nginx.values.yaml" and fill in your value
+
 controller:
  kind: DaemonSet
  hostNetwork: true
--- a/deployment/kubernetes/values.template.yaml
+++ b/deployment/kubernetes/values.template.yaml
@ -1,13 +1,16 @@
-# Change all the below if needed
+# please duplicate template file and rename to "values.yaml" and fill in your value
+
+# change all the below if needed
 PUBLIC_REGISTRATION: false
 INVITE_REGISTRATION: false

 BACKEND:
-  # Change all the below if needed
+  # change all the below if needed
  # DOCKER_IMAGE_REPO - change that to your branded docker image
-  #  Label is appended based on .Chart.appVersion
+  #  label is appended based on .Chart.appVersion
  DOCKER_IMAGE_REPO: "ocelotsocialnetwork/backend-branded"
  CLIENT_URI: "https://staging.ocelot.social"
+  # create a new one for your network
  JWT_SECRET: "b/&&7b78BF&fv/Vd"
  MAPBOX_TOKEN: "pk.eyJ1IjoiYnVzZmFrdG9yIiwiYSI6ImNraDNiM3JxcDBhaWQydG1uczhpZWtpOW4ifQ.7TNRTO-o9aK1Y6MyW_Nd4g"
  PRIVATE_KEY_PASSPHRASE: "a7dsf78sadg87ad87sfagsadg78"
@ -19,7 +22,7 @@ BACKEND:
  SMTP_IGNORE_TLS: 'true'
  SMTP_SECURE: 'false'

-  # Most likely you don't need to change this
+  # most likely you don't need to change this
  MIN_READY_SECONDS: "15"
  PROGRESS_DEADLINE_SECONDS: "60"
  REVISIONS_HISTORY_LIMIT: "25"
@ -29,9 +32,9 @@ BACKEND:
  STORAGE_UPLOADS: "25Gi"

 WEBAPP:
-  # Change all the below if needed
+  # change all the below if needed
  # DOCKER_IMAGE_REPO - change that to your branded docker image
-  #  Label is appended based on .Chart.appVersion
+  #  label is appended based on .Chart.appVersion
  DOCKER_IMAGE_REPO: "ocelotsocialnetwork/webapp-branded"
  WEBSOCKETS_URI: "wss://staging.ocelot.social/api/graphql"

@ -45,9 +48,9 @@ WEBAPP:
  DOCKER_IMAGE_PULL_POLICY: "Always"

 NEO4J:
-  # Most likely you don't need to change this
+  # most likely you don't need to change this
  REVISIONS_HISTORY_LIMIT: "25"
-  DOCKER_IMAGE_REPO: "ocelotsocialnetwork/neo4j"
+  DOCKER_IMAGE_REPO: "ocelotsocialnetwork/neo4j-community-branded"
  DOCKER_IMAGE_PULL_POLICY: "Always"
  CONTAINER_RESTART_POLICY: "Always"
  CONTAINER_TERMINATION_GRACE_PERIOD_SECONDS: "30"
@ -73,9 +76,9 @@ NEO4J:
  DBMS_SECURITY_PROCEDURES_UNRESTRICTED: "algo.*,apoc.*"

 MAINTENANCE:
-  # Change all the below if needed
+  # change all the below if needed
  # DOCKER_IMAGE_REPO - change that to your branded docker image
-  #  Label is appended based on .Chart.appVersion
+  #  label is appended based on .Chart.appVersion
  DOCKER_IMAGE_REPO: "ocelotsocialnetwork/maintenance-branded"

  # Most likely you don't need to change this
@ -85,7 +88,7 @@ MAINTENANCE:
  DOCKER_IMAGE_PULL_POLICY: "Always"

 LETSENCRYPT:
-  # Change all the below if needed
+  # change all the below if needed
  # ISSUER is used by cert-manager to set up certificates with the given provider.
  #  change it to "letsencrypt-production" once you are ready to have valid cetrificates.
  #  Be aware that the is an issuing limit with letsencrypt, so a dry run with staging might be wise
@ -96,14 +99,14 @@ LETSENCRYPT:
    - "www.staging.ocelot.social"

 NGINX:
-  # Most likely you don't need to change this
+  # most likely you don't need to change this
  PROXY_BODY_SIZE: "10m"

 STORAGE:
-  # Change all the below if needed
+  # change all the below if needed
  PROVISIONER: "dobs.csi.digitalocean.com"

-  # Most likely you don't need to change this
+  # most likely you don't need to change this
  RECLAIM_POLICY: "Retain"
  VOLUME_BINDING_MODE: "Immediate"
  ALLOW_VOLUME_EXPANSION: true
--- a/docker/backend.Dockerfile
+++ b/docker/backend.Dockerfile
@ -1,8 +1,9 @@
 ##################################################################################
 # BRANDED ########################################################################
 ##################################################################################
-FROM ocelotsocialnetwork/backend:latest as branded
+ARG APP_IMAGE=ocelotsocialnetwork/backend-branded:latest
+FROM $APP_IMAGE as branded

-# Copy public constants to the docker image branding it
+# copy public constants into the Docker image to brand it
 COPY branding/constants/links.js src/config/
 COPY branding/constants/metadata.js src/config/
--- a/docker/maintenance.Dockerfile
+++ b/docker/maintenance.Dockerfile
@ -1,8 +1,9 @@
 ##################################################################################
 # BRANDED ########################################################################
 ##################################################################################
-FROM ocelotsocialnetwork/maintenance:latest as branded
+ARG APP_IMAGE=ocelotsocialnetwork/maintenance-branded:latest
+FROM $APP_IMAGE as branded

-# Copy public constants to the docker image branding it
+# copy public constants into the Docker image to brand it
 COPY branding/static/ static/
 COPY branding/constants/ constants/
--- a/docker/neo4j.Dockerfile
+++ b/docker/neo4j.Dockerfile
@ -0,0 +1,11 @@
+ARG APP_IMAGE=ocelotsocialnetwork/neo4j-community-branded:latest
+
+##################################################################################
+# COMMUNITY ######################################################################
+##################################################################################
+FROM $APP_IMAGE as community-branded
+
+##################################################################################
+# ENTERPRISE #####################################################################
+##################################################################################
+FROM ocelotsocialnetwork/neo4j-enterprise:latest as enterprise-branded
--- a/docker/webapp.Dockerfile
+++ b/docker/webapp.Dockerfile
@ -1,8 +1,9 @@
 ##################################################################################
 # BRANDED ########################################################################
 ##################################################################################
-FROM ocelotsocialnetwork/webapp:latest as branded
+ARG APP_IMAGE=ocelotsocialnetwork/webapp-branded:latest
+FROM $APP_IMAGE as branded

-# Copy public constants to the docker image branding it
+# copy public constants into the Docker image to brand it
 COPY branding/static/ static/
 COPY branding/constants/ constants/
--- a/package.json
+++ b/package.json
@ -1,6 +1,8 @@
 {
  "name": "ocelot-social-branded",
-  "version": "0.0.6",
+  "version": "1.0.2",
+  "ocelotDockerVersionTag": "1.0.2-79",
+  "dockerOrganisation": "ocelotsocialnetwork",
  "description": "Ocelot Social Branded",
  "author": "ocelot.social Community",
  "license": "MIT",