Helm public repo

helm-ct.yml → .github/helm-ct.yml

@@ -3,3 +3,6 @@ chart-dirs:
   - helm
 chart-repos:
   - bitnami=https://charts.bitnami.com/bitnami
+debug: true
+helm-extra-args: --timeout 600s
+check-version-increment: false

.github/workflows/bootzooka-helm-ci.yaml

@@ -0,0 +1,112 @@
+name: Bootzooka Helm Chart CI
+
+on:
+  push:
+    paths:
+      - "helm/**"
+      - ".github/**"
+  pull_request:
+    paths:
+      - "helm/**"
+      - ".github/**"
+
+jobs:
+  lint-chart:
+    # run on external PRs, but not on internal PRs since those will be run by push to branch
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    name: Lint Helm Chart
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Check-out repository
+        id: repo-checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Run chart-testing (lint)
+        id: ct-lint
+        uses: helm/chart-testing-action@v1.1.0
+        with:
+          command: lint
+          config: .github/helm-ct.yml
+
+  install-test-chart:
+    needs:
+      - lint-chart
+    name: Install & Test Helm Chart
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:
+        k8s:
+          - v1.15.12
+          - v1.16.15
+          - v1.17.11
+          - v1.18.8
+          - v1.19.4
+    steps:
+      - name: Check-out repository
+        id: repo-checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Create kind ${{ matrix.k8s }} cluster
+        id: kind-cluster-setup
+        uses: helm/kind-action@v1.1.0
+        with:
+          node_image: kindest/node:${{ matrix.k8s }}
+          wait: "120s"
+
+      - name: Run chart-testing (install)
+        id: ct-install
+        uses: helm/chart-testing-action@v1.1.0
+        with:
+          command: install
+          config: .github/helm-ct.yml
+
+  validate-chart-docs:
+    needs:
+      - lint-chart
+      - install-test-chart
+    name: Validate Helm Chart Docs
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Check-out repository
+        id: repo-checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Run helm-docs
+        id: helm-docs-run
+        uses: ideas-into-software/helm-docs-action@main
+
+      - name: Validate there's no diff
+        id: git-no-diff
+        run: git diff --exit-code
+
+  publish-chart:
+    needs:
+      - lint-chart
+      - install-test-chart
+      - validate-chart-docs
+    name: Publish Helm Chart
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Check-out repository
+        id: repo-checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Publish Helm Chart
+        id: helm-publish-chart
+        uses: stefanprodan/helm-gh-pages@v1.2.0
+        with:
+          token: ${{ secrets.CR_TOKEN }}
+          charts_dir: helm
+          charts_url: https://softwaremill.github.io/sml-helm-public-repo
+          owner: softwaremill
+          repository: sml-helm-public-repo
+          helm_version: 3.4.1
+          linting: off

.github/workflows/bootzooka-scala-ts-ci.yml

@@ -0,0 +1,41 @@
+name: Bootzooka CI
+
+on:
+  push:
+    paths-ignore:
+      - "helm/**"
+  pull_request:
+    paths-ignore:
+      - "helm/**"
+
+jobs:
+  scala-ts-tests:
+    # run on external PRs, but not on internal PRs since those will be run by push to branch
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    name: Scala and TypeScript testing
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Check-out repository
+      id: repo-checkout
+      uses: actions/checkout@v2
+
+    - name: Set up JDK 11
+      id: jdk-setup
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+
+    - name: Cache SBT
+      id: cache-sbt
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.sbt
+          ~/.ivy2/cache
+          ~/.coursier
+        key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
+
+    - name: Run tests
+      id: run-tests
+      run: sbt test

docs/production.md

@@ -17,6 +17,33 @@ To build a docker image, run `backend/docker:publishLocal`. This will create the
 
 You can test the image by using the provided `docker-compose.yml` file.
 
+
+## Kubernetes
+
+Use [Helm](https://helm.sh/) to easily deploy Bootzooka into [Kubernetes](https://kubernetes.io/) cluster.
+
+### Add SoftwareMill Helm repository
+
+```
+helm repo add softwaremill https://charts.softwaremill.com/
+helm repo update
+```
+
+### Fetch and Customize Bootzooka chart
+
+```
+helm fetch softwaremill/bootzooka --untar
+```
+
+### Install Bootzooka chart
+
+```
+helm install --generate-name bootzooka
+```
+
+Please see [Bootzooka Helm Chart documentation](https://github.com/softwaremill/bootzooka/blob/master/helm/bootzooka/README.md) for more information, including configuration options.
+
+
 ## Heroku
 
 Bootzooka-based applications can be easily deployed to [Heroku](https://www.heroku.com).

helm/bootzooka/.helmignore

@@ -0,0 +1,26 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+
+# Helm-Docs template
+README.md.gotmpl

helm/bootzooka/Chart.yaml

@@ -2,17 +2,35 @@ apiVersion: v2
 appVersion: "1.0"
 description: "A Helm chart for Bootzooka"
 name: bootzooka
-version: 0.1.0
+version: 0.1.2
 type: application
-home: https://github.com/softwaremill/bootzooka
+keywords:
+ - scala
+ - microservice
+ - postgresql
+ - angular
+ - bootstrap
+home: https://softwaremill.github.io/bootzooka/
+sources:
+ - https://github.com/softwaremill/bootzooka
 maintainers:
-  - name: tomusheq
-    url: https://github.com/tomusheq
-  - name: ideas-into-software
-    url: https://github.com/ideas-into-software
-icon: https://raw.githubusercontent.com/softwaremill/bootzooka/master/banner.png
+ - name: tomusheq
+   url: https://github.com/tomusheq
+ - name: ideas-into-software
+   url: https://github.com/ideas-into-software
+icon: https://raw.githubusercontent.com/softwaremill/bootzooka/master/banner.svg
 dependencies:
-  - name: postgresql
-    version: ^9
-    repository: https://charts.bitnami.com/bitnami
-    condition: postgresql.enabled
+ - name: postgresql
+   version: ^9
+   repository: https://charts.bitnami.com/bitnami
+   condition: postgresql.enabled
+annotations:
+ artifacthub.io/links: |
+  - name: Docs
+    url: https://softwaremill.github.io/bootzooka/
+  - name: Source
+    url: https://github.com/softwaremill/bootzooka
+  - name: Demo
+    url: https://bootzooka.softwaremill.com/
+  - name: Home
+    url: https://softwaremill.com/