From f86156a656bc8a3833fa9d3fb498c8c85de33902 Mon Sep 17 00:00:00 2001 From: Alexander Onnikov Date: Mon, 3 Feb 2025 10:07:30 +0400 Subject: [PATCH] Update self-host kube example to Huly v424 (#126) Signed-off-by: Alexander Onnikov --- .template.huly.conf | 2 +- MIGRATION.md | 24 ++++++++++ README.md | 47 ++++++++++--------- kube/account/account-deployment.yaml | 2 +- .../collaborator/collaborator-deployment.yaml | 2 +- kube/front/front-deployment.yaml | 2 +- kube/fulltext/fulltext-deployment.yaml | 2 +- kube/rekoni/rekoni-deployment.yaml | 2 +- kube/stats/stats-deployment.yaml | 2 +- kube/transactor/transactor-deployment.yaml | 2 +- kube/workspace/workspace-deployment.yaml | 2 +- setup.sh | 2 +- traefik/setup.sh | 2 +- 13 files changed, 60 insertions(+), 33 deletions(-) diff --git a/.template.huly.conf b/.template.huly.conf index d35505a..7db993b 100644 --- a/.template.huly.conf +++ b/.template.huly.conf @@ -1,4 +1,4 @@ -HULY_VERSION=v0.6.411 +HULY_VERSION=v0.6.424 DOCKER_NAME=huly # The address of the host or server from which you will access your Huly instance. diff --git a/MIGRATION.md b/MIGRATION.md index 6268584..34e2dd6 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,5 +1,29 @@ # Huly Migration +This document describes the changes required to update Huly from one version to another. Most of updates require updating Docker containers versions. +Though, some updates may require updating other configuration options. In this case, you should review the updated configuration options and update them accordingly. + +## v0.6.424 + +Web-push keys have been moved from the `front` service to the `ses` service. If you are using the `ses` service, you will need to update the configuration: + +```yaml + front: + ... + environment: + ... + # Remove the following lines + # - PUSH_PUBLIC_KEY=your public key + # - PUSH_PRIVATE_KEY=your private key + ses: + ... + environment: + ... + # Add the following lines + - PUSH_PUBLIC_KEY=your public key + - PUSH_PRIVATE_KEY=your private key +``` + ## v0.6.411 No changes required. diff --git a/README.md b/README.md index 98db7ec..50f60ff 100644 --- a/README.md +++ b/README.md @@ -66,19 +66,19 @@ sudo apt-get install npm Install web-push using npm -``` +```bash sudo npm install -g web-push ``` Generate VAPID Keys. Run the following command to generate a VAPID key pair: -``` +```bash web-push generate-vapid-keys ``` It will generate both keys that looks like this: -``` +```bash ======================================= Public Key: @@ -92,9 +92,9 @@ asdfsadfasdfsfd Keep these keys secure, as you will need them to set up your push notification service on the server. -Add these keys into `compose.yaml` in section `services:front:environment`: +Add these keys into `compose.yaml` in section `services:ses:environment`: -``` +```yaml - PUSH_PUBLIC_KEY=your public key - PUSH_PRIVATE_KEY=your private key ``` @@ -105,21 +105,22 @@ Add these keys into `compose.yaml` in section `services:front:environment`: 2. [Create new policy](https://us-east-1.console.aws.amazon.com/iam/home?region=eu-central-1#/policies/create) with following permissions: - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ses:SendEmail", - "ses:SendRawEmail" - ], - "Resource": "*" - } - ] - } - ``` + + ```yaml + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "ses:SendEmail", + "ses:SendRawEmail" + ], + "Resource": "*" + } + ] + } + ``` 3. [Create separate IAM user](https://us-east-1.console.aws.amazon.com/iam/home?region=eu-central-1#/users/create) for SES API access. Assign previously created policy to this user during creation. @@ -128,7 +129,7 @@ Add these keys into `compose.yaml` in section `services:front:environment`: ```yaml ses: - image: hardcoreeng/ses:v0.6.411 + image: hardcoreeng/ses:v0.6.424 container_name: ses expose: - 3335 @@ -136,6 +137,8 @@ Add these keys into `compose.yaml` in section `services:front:environment`: - SOURCE= - ACCESS_KEY= - SECRET_KEY= + - PUSH_PUBLIC_KEY= + - PUSH_PRIVATE_KEY= - REGION= - PORT=3335 restart: unless-stopped @@ -169,7 +172,7 @@ self-hosted Huly, perform the following steps: ```yaml love: - image: hardcoreeng/love:v0.6.411 + image: hardcoreeng/love:v0.6.424 container_name: love ports: - 8096:8096 diff --git a/kube/account/account-deployment.yaml b/kube/account/account-deployment.yaml index d368336..d0e84b7 100644 --- a/kube/account/account-deployment.yaml +++ b/kube/account/account-deployment.yaml @@ -57,7 +57,7 @@ spec: configMapKeyRef: name: huly-config key: TRANSACTOR_URL - image: hardcoreeng/account:v0.6.411 + image: hardcoreeng/account:v0.6.424 name: account ports: - containerPort: 3000 diff --git a/kube/collaborator/collaborator-deployment.yaml b/kube/collaborator/collaborator-deployment.yaml index 3c8b057..dee5dda 100644 --- a/kube/collaborator/collaborator-deployment.yaml +++ b/kube/collaborator/collaborator-deployment.yaml @@ -32,7 +32,7 @@ spec: secretKeyRef: name: huly-secret key: SERVER_SECRET - image: hardcoreeng/collaborator:v0.6.411 + image: hardcoreeng/collaborator:v0.6.424 name: collaborator ports: - containerPort: 3078 diff --git a/kube/front/front-deployment.yaml b/kube/front/front-deployment.yaml index b09931f..0e195c6 100644 --- a/kube/front/front-deployment.yaml +++ b/kube/front/front-deployment.yaml @@ -69,7 +69,7 @@ spec: value: http://stats - name: DESKTOP_UPDATES_CHANNEL value: selfhost - image: hardcoreeng/front:v0.6.411 + image: hardcoreeng/front:v0.6.424 name: front ports: - containerPort: 8080 diff --git a/kube/fulltext/fulltext-deployment.yaml b/kube/fulltext/fulltext-deployment.yaml index 287cf99..7e7356d 100644 --- a/kube/fulltext/fulltext-deployment.yaml +++ b/kube/fulltext/fulltext-deployment.yaml @@ -47,7 +47,7 @@ spec: value: http://account - name: STATS_URL value: http://stats - image: hardcoreeng/fulltext:v0.6.411 + image: hardcoreeng/fulltext:v0.6.424 name: fulltext ports: - containerPort: 4700 diff --git a/kube/rekoni/rekoni-deployment.yaml b/kube/rekoni/rekoni-deployment.yaml index 4d4e468..10fc332 100644 --- a/kube/rekoni/rekoni-deployment.yaml +++ b/kube/rekoni/rekoni-deployment.yaml @@ -15,7 +15,7 @@ spec: app: rekoni spec: containers: - - image: hardcoreeng/rekoni-service:v0.6.411 + - image: hardcoreeng/rekoni-service:v0.6.424 name: rekoni env: - name: SECRET diff --git a/kube/stats/stats-deployment.yaml b/kube/stats/stats-deployment.yaml index e847725..0cecc99 100644 --- a/kube/stats/stats-deployment.yaml +++ b/kube/stats/stats-deployment.yaml @@ -15,7 +15,7 @@ spec: app: stats spec: containers: - - image: hardcoreeng/stats:v0.6.411 + - image: hardcoreeng/stats:v0.6.424 name: stats env: - name: PORT diff --git a/kube/transactor/transactor-deployment.yaml b/kube/transactor/transactor-deployment.yaml index 899b06d..9e63e95 100644 --- a/kube/transactor/transactor-deployment.yaml +++ b/kube/transactor/transactor-deployment.yaml @@ -51,7 +51,7 @@ spec: secretKeyRef: name: huly-secret key: SERVER_SECRET - image: hardcoreeng/transactor:v0.6.411 + image: hardcoreeng/transactor:v0.6.424 name: transactor ports: - containerPort: 3333 diff --git a/kube/workspace/workspace-deployment.yaml b/kube/workspace/workspace-deployment.yaml index 7bac4af..04e775e 100644 --- a/kube/workspace/workspace-deployment.yaml +++ b/kube/workspace/workspace-deployment.yaml @@ -47,7 +47,7 @@ spec: secretKeyRef: name: huly-secret key: SERVER_SECRET - image: hardcoreeng/workspace:v0.6.411 + image: hardcoreeng/workspace:v0.6.424 name: workspace resources: limits: diff --git a/setup.sh b/setup.sh index 435315a..66f9e95 100755 --- a/setup.sh +++ b/setup.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -HULY_VERSION="v0.6.411" +HULY_VERSION="v0.6.424" DOCKER_NAME="huly" CONFIG_FILE="huly.conf" diff --git a/traefik/setup.sh b/traefik/setup.sh index 5bda94a..8f7ed7b 100755 --- a/traefik/setup.sh +++ b/traefik/setup.sh @@ -14,7 +14,7 @@ if [ -z "$LETSENCRYPT_EMAIL" ]; then exit 1 fi -export HULY_VERSION="v0.6.411" +export HULY_VERSION="v0.6.424" export HULY_SECRET="secret" export SERVER_ADDRESS=$DOMAIN_NAME export LETSENCRYPT_EMAIL=$LETSENCRYPT_EMAIL