publish helm chart on release (fixes #1114) (#1117) (#1123)

- no longer using :latest by default in values.yaml, instead updating version with each release
- set chart version to match app version in Chart.yaml
- update version in helm chart and values.yaml as part of update-version.sh script
- update test.yaml and local-config.yaml to enable using :latest tag images
- ci: add ci script for packaging current helm chart
- docs: updates docs to indicate deploying directly from GitHub release
- docs: add script to fill in latest version for 'VERSION' using custom script
- chart: set local_service_port to 30870 by default, but use only if no ingress.
- default values.yaml set up for local deployment, local-config.yaml contains additional commented out examples
- ci draft: add deployment info to draft with helm install command for current version
- test: fix password check test

.github/workflows/publish-helm-chart.yaml

@@ -0,0 +1,47 @@
+name: Publish Helm Chart
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  package_chart:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Install Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: 3.10.2
+
+      - name: Package Chart
+        run: |
+          mkdir .chart-out
+          helm package chart/ --destination .chart-out
+
+      - name: Get Version
+        run: |
+          echo "version=$(cat version.txt)" >> "$GITHUB_ENV"
+
+      - name: Upload Chart To GitHub
+        uses: softprops/action-gh-release@v1
+        with:
+          body: |
+            ## Deployment
+
+            This release can be deployed with Helm by running:
+
+            ```
+            helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/v${{ env.version }}/browsertrix-cloud-${{ env.version }}.tgz
+            ```
+
+            See [the development guide](https://docs.browsertrix.cloud/deploy/) for more info how to deploy Browsertrix Cloud.
+
+          files: .chart-out/browsertrix-cloud-${{ env.version }}.tgz
+          tag_name: v${{ env.version }}
+          fail_on_unmatched_files: true
+          draft: true

chart/Chart.yaml

@@ -4,15 +4,8 @@ description: A chart for running the Webrecorder Browsertrix System
 type: application
 icon: https://webrecorder.net/assets/icon.png
 
-# This is the chart version. This version number should be incremented each time you make changes
+# Browsertrix Cloud and Chart Version
-# to the chart and its templates, including the app version.
+version: 1.7.0-beta.0
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
-
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 0.1.0
 
 dependencies:
   - name: btrix-admin-logging

chart/examples/local-config.yaml

@@ -4,12 +4,18 @@
 # This config is designed for local (non-hosted) use, with either Docker Desktop, minikube or local microk8s.
 # With this setup, the cluster should be accessed locally via 'localhost'
 
-# run service on localhost on port
+# use custom port for local access, default is localhost:30870
-local_service_port: 30870
+# uncomment and change below
+# local_service_port: 30870
 
-default_org: "My Local Organization"
+# Uncomment to set custom organization name
+# default_org: "My Local Organization"
 
-# overrides to use existing images in local Docker, otherwise will pull from latest
+# use version specified in values.yaml, uncomment to use :latest release instead
+# backend_image: docker.io/webrecorder/browsertrix-backend:latest
+# frontend_image: docker.io/webrecorder/browsertrix-frontend:latest
+
+# overrides to use existing images in local Docker, otherwise will pull from repository
 # backend_pull_policy: "Never"
 # frontend_pull_policy: "Never"
 # crawler_pull_policy: "Never"

chart/templates/frontend.yaml

@@ -95,15 +95,16 @@ spec:
     app: {{ .Values.name }}
     role: frontend
 
-  {{- if .Values.local_service_port }}
-  type: NodePort
-  {{- end }}
-
   ports:
     - protocol: TCP
       port: 80
       name: frontend
-      {{- if .Values.local_service_port }}
+
+  {{- if and .Values.local_service_port (not .Values.ingress.host) }}
       nodePort: {{ .Values.local_service_port }}
+
+  type: NodePort
   {{- end }}
 
+
+

chart/test/test.yaml

@@ -1,6 +1,10 @@
 # test overrides
 # --------------
 
+# use local images built to :latest tag
+backend_image: docker.io/webrecorder/browsertrix-backend:latest
+frontend_image: docker.io/webrecorder/browsertrix-frontend:latest
+
 backend_pull_policy: "Never"
 frontend_pull_policy: "Never"
 

chart/values.yaml

@@ -88,7 +88,7 @@ default_org: "My Organization"
 
 # API Image
 # =========================================
-backend_image: "docker.io/webrecorder/browsertrix-backend:latest"
+backend_image: "docker.io/webrecorder/browsertrix-backend:1.7.0-beta.0"
 backend_pull_policy: "Always"
 
 backend_password_secret: "PASSWORD!"
@@ -114,7 +114,7 @@ profile_browser_idle_seconds: 60
 
 # Nginx Image
 # =========================================
-frontend_image: "docker.io/webrecorder/browsertrix-frontend:latest"
+frontend_image: "docker.io/webrecorder/browsertrix-frontend:1.7.0-beta.0"
 frontend_pull_policy: "Always"
 
 frontend_cpu: "5m"
@@ -124,7 +124,8 @@ frontend_memory: "36Mi"
 # if set, maps nginx to a fixed port on host machine
 # must be between 30000 - 32767
 # use for deployments on localhost when not using ingress
-# local_service_port: 30870
+# if using ingress, this value is ignored
+local_service_port: 30870
 
 
 # MongoDB Image

docs/deploy/local.md

@@ -8,7 +8,10 @@ Before running Browsertrix Cloud, you'll need to set up a running [Kubernetes](h
 
 Today, there are numerous ways to deploy Kubernetes fairly easily, and we recommend trying one of the single-node options, which include Docker Desktop, microk8s, minikube and k3s.
 
-The instructions below assume you have cloned the [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud) repository locally, and have local package managers for your platform (eg. `brew` for macOS, `choco` for Windows, etc...) already installed.
+The instructions below assume you have the local package managers for your platform (eg. `brew` for macOS, `choco` for Windows, etc...) already installed.
+
+Cloning the repository at [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud) is only needed
+to access additional configuration files.
 
 Here are some environment specific instructions for setting up a local cluster from different Kubernetes vendors:
 
@@ -54,34 +57,53 @@ Here are some environment specific instructions for setting up a local cluster f
 
 ## Launching Browsertrix Cloud with Helm
 
-Once you have a running Kubernetes cluster with one of the options above, and Helm 3 installed, you can then run from the Browsertrix Cloud repo directory:
+Once you have a running Kubernetes cluster with one of the options above, and Helm 3 installed, you can install the latest release of Browsertrix Cloud
+directly from the latest GitHub release.
 
-```shell
+<insert-version></insert-version>
-helm upgrade --install -f ./chart/values.yaml \
+
--f ./chart/examples/local-config.yaml btrix ./chart/
+
+```
+helm upgrade --install btrix \
+https://github.com/webrecorder/browsertrix-cloud/releases/download/VERSION/browsertrix-cloud-VERSION.tgz
 ```
 
 ??? info "MicroK8S"
 
     If using microk8s, the command will be:
 
+    <insert-version></insert-version>
+
     ```sh
-    microk8s helm3 upgrade --install -f ./chart/values.yaml \
+    microk8s helm3 upgrade --install btrix \
-    -f ./chart/examples/local-config.yaml btrix ./chart/
+    https://github.com/webrecorder/browsertrix-cloud/releases/download/VERSION/browsertrix-cloud-VERSION.tgz
     ```
 
     Subsequent commands will also use `microk8s helm3` instead of `helm`.
 
 
-The local setup includes the full Browsertrix Cloud system, with frontend, backend api, db (via MongoDB) and storage (via Minio)
+The default setup includes the full Browsertrix Cloud system, with frontend, backend api, db (via MongoDB) and storage (via Minio)
 
 An admin user with name `admin@example.com` and password `PASSW0RD!` will be automatically created.
 
-This config uses the standard config (`./chart/values.yaml`) with a couple additional settings for local deployment (`./chart/examples/local-config.yaml`). With Helm, additional YAML files can be added to further override previous settings.
+With Helm, additional YAML files can be added to further override previous settings.
 
-These settings can be changed in [charts/examples/local-config.yaml](https://github.com/webrecorder/browsertrix-cloud/blob/main/chart/examples/local-config.yaml).
+Some possible settings can be changed are found in [chart/examples/local-config.yaml](https://github.com/webrecorder/browsertrix-cloud/blob/main/chart/examples/local-config.yaml).
+
+For example, to change the default superadmin, uncomment the `superadmin` block in `local-config.yaml`, and then change the username (`admin@example.com`) and password (`PASSW0RD!`) to different values. (The admin username and password will be updated with each deployment).
+To change the local port, change `local_service_port` setting.
+
+You can then redeploy with these additional settings by running:
+
+<insert-version></insert-version>
+
+```
+helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/VERSION/browsertrix-cloud-VERSION.tgz \
+-f ./chart/examples/local-config.yaml
+```
+
+The above examples assumes running from a cloned Browsertrix Cloud repo, however the config file can be saved anywhere and specified with `-f <extra-config.yaml>`.
 
-For example, to change the default superadmin, uncomment the `superadmin` block in `local-config.yaml`, and then change the username (`admin@example.com`) and password (`PASSW0RD!`) to different values. (The admin username and password will be updated with each deployment)
 
 ## Waiting for Cluster to Start
 
@@ -128,10 +150,11 @@ The outputs of these commands will be helpful if you'd like to report an issue [
 
 ## Updating the Cluster
 
-To update the cluster, re-run the same command again, which will pull the latest images. In this way, you can upgrade to the latest release of Browsertrix Cloud. The upgrade will preserve the database and current archives.
+To update the cluster, for example to update to new version `NEWVERSION`, re-run the same command again, which will pull the latest images. In this way, you can upgrade to the latest release of Browsertrix Cloud. The upgrade will preserve the database and current archives.
 
 ```shell
-helm upgrade --install -f ./chart/values.yaml -f ./chart/examples/local-config.yaml btrix ./chart/
+helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/NEWVERSION/browsertrix-cloud-NEWVERSION.tgz
+
 ```
 
 ## Uninstalling
@@ -148,4 +171,4 @@ To fully delete all persistent data (db + archives) created in the cluster, also
 
 ## Deploying for Local Development
 
-These instructions are intended for deploying the cluster from the latest release. See [setting up cluster for local development](../develop/local-dev-setup.md) for additional customizations related to developing Browsertrix Cloud and deploying from local images.
+These instructions are intended for deploying the cluster from the latest releases published on GitHub. See [setting up cluster for local development](../develop/local-dev-setup.md) for additional customizations related to developing Browsertrix Cloud and deploying from local images.

docs/js/insertversion.js

@@ -0,0 +1,36 @@
+const KEY = "/.__source";
+let retries = 0;
+
+function loadVersion() {
+  const value = self.sessionStorage.getItem(KEY);
+  if (value) {
+    parseVersion(value);
+  } else if (retries++ < 10) {
+    setTimeout(loadVersion, 500);
+  }
+}
+
+function parseVersion(string) {
+  const version = JSON.parse(string).version;
+  if (!version) {
+    return;
+  }
+
+  const elems = document.querySelectorAll("insert-version");
+  for (const elem of elems) {
+    try {
+      const code = elem.parentElement.nextElementSibling.querySelector("code");
+      code.childNodes.forEach((node) => {
+        if (node.nodeType === Node.TEXT_NODE) {
+          node.nodeValue = node.nodeValue.replaceAll("VERSION", version);
+        }
+      });
+    } catch (e) {
+
+    }
+  }
+}
+
+if (window.location.pathname.startsWith("/deploy/local")) {
+  window.addEventListener("load", () => loadVersion());
+}

mkdocs.yml

@@ -4,6 +4,8 @@ repo_name: Browsertrix Cloud
 edit_uri: edit/main/docs/
 extra_css:
     - stylesheets/extra.css
+extra_javascript:
+    - js/insertversion.js
 theme:
   name: material
   custom_dir: docs/overrides

scripts/check_passwords.py

@@ -1,6 +1,7 @@
 "A small dirty script to check that none of the password config options have been set to real passwords"
 from collections.abc import Generator
 import yaml
+from yaml.parser import ParserError
 from yaml.scanner import ScannerError
 from yaml.constructor import ConstructorError
 import sys
@@ -45,7 +46,7 @@ for file in changed_files:
                     else:
                         print(f"top level key '{password_keys[0]}' with subkey '{password_keys[1]}' in {file} contains a real password!")
                     WE_DUN_GOOFED = True
-        except ScannerError:
+        except (ScannerError, ParserError):
             print(f"Couldn't parse yaml file for: {file}")
             pass
         except ConstructorError:

update-version.sh

@@ -6,3 +6,8 @@ mv ./tmp-package.json ./frontend/package.json
 
 echo '""" current version """' > ./backend/btrixcloud/version.py
 echo "__version__ = \"$version\"" >> ./backend/btrixcloud/version.py
+
+sed -E -i "" "s/^version:.*$/version: $version/" chart/Chart.yaml
+
+sed -E -i "" "s/\/browsertrix-backend:[[:alnum:].-]+/\/browsertrix-backend:$version/" chart/values.yaml
+sed -E -i "" "s/\/browsertrix-frontend:[[:alnum:].-]+/\/browsertrix-frontend:$version/" chart/values.yaml