Helm chart, GitHub deploy workflow, and Kubernetes/Compose parity by aprilrieger · Pull Request #2 · notch8/dataverseup

aprilrieger · 2026-04-03T08:04:42Z

Summary

Repository: github.com/notch8/dataverseup · Live demo (active): demo-dataverseup.notch8.cloud

Delivers Kubernetes support for DataverseUp while keeping Compose as the lab default: a Helm chart, deploy automation, one deployment runbook, a cleaner scripts/ layout, and working SMTP wiring for the demo environment (SendGrid + Dataverse 6.2+ MicroProfile mail settings).

What’s included

Helm (`charts/dataverseup`)

GDCC Dataverse Deployment/Service, optional PVCs (data + docroot), Ingress, HPA, ServiceAccount.
Optional internal Solr 9 + solrInit initContainer (standalone default; SolrCloud path documented).
Bootstrap Job: post-install hook; bootstrapJob.mode: compose mirrors local flow (wait → configbaker → apply-branding.sh → seed-content.sh via ConfigMap-backed fixtures).
Optional AWS S3 (awsS3.*) and mail relay script via ConfigMap; initdFromChart can ship the full Payara scripts/init.d/*.sh bundle.
Chart files/ uses symlinks into the repo (especially files/init.d/ → scripts/init.d/) so helm package inlines real content without duplicating scripts.

SMTP / email (demo deploy + docs)

Dataverse 6.2+ sends mail via MicroProfile dataverse.mail.*, exposed as pod env DATAVERSE_MAIL_* (installation guide — SMTP/Email). ops/demo-deploy.tmpl.yaml sets DATAVERSE_MAIL_SYSTEM_EMAIL, DATAVERSE_MAIL_SUPPORT_EMAIL (support@notch8.com), DATAVERSE_MAIL_MTA_* for SendGrid (host, 587, STARTTLS, user apikey, password from secret), and DATAVERSE_MAIL_DEBUG (false by default; flip to true for troubleshooting).
010-mailrelay-set.sh (Payara JavaMail + :SystemEmail) remains for legacy/parity but is not sufficient alone for outbound mail on current Dataverse; the DATAVERSE_MAIL_* block is required for verification/password email.
GitHub Actions deploy: envsubst injects only DB_PASSWORD, SMTP_PASSWORD, and GITHUB_RUN_ID into the demo template; SMTP host/ports/addresses are literals in the template. Removed unused MAIL_SMTP_PASSWORD and redundant SMTP_* workflow env vars that did not feed envsubst.
docs/DEPLOYMENT.md: SMTP checklist, SendGrid + SendGrid Activity, DATAVERSE_MAIL_DEBUG, Payara log path /opt/payara/appserver/glassfish/domains/domain1/logs, pod restart after mail secret changes (MTA session cached). .env.example: commented Compose SMTP variables for local testing.

Operations & CI

bin/helm_deploy: opinionated helm upgrade --install wrapper (--atomic, default timeout, HELM_EXTRA_ARGS).
.github/workflows/deploy.yaml: environment-driven deploy (kubeconfig, rendered values, rollout + optional bootstrap job wait).
ops/demo-deploy.tmpl.yaml: example values pattern for a named environment (literals for URLs/hosts/mail; envsubst for DB + SendGrid API key + rollout nonce).

Documentation

docs/DEPLOYMENT.md: single runbook — Helm, SMTP/Dataverse mail, S3, Ingress, GitHub Actions secrets, upgrades, learnings.
README.md: Helm + deployment pointer; repo + demo links; scripts/ layout.

Repo layout (scripts)

init.d/ → scripts/init.d/ (Compose still mounts to /opt/payara/init.d).
triggers/ → scripts/triggers/ (Compose: /triggers, /opt/payara/triggers).
config/update-fields.sh → scripts/solr/update-fields.sh (config/ keeps Solr XML only).

Behavior & quality

scripts/init.d/006-s3-aws-storage.sh: DRY/KISS; Amazon S3: leave endpointUrl empty when using real AWS.
Seed / API: JSON booleans and hints aligned with Dataverse Native API expectations; branding path fixes for K8s docroot.

How to test

helm lint charts/dataverseup and helm template with your values (e.g. demo template).
Mail: GitHub Environment secret SMTP_PASSWORD (SendGrid API key); deploy and roll Dataverse pods; trigger signup/verify or password reset; confirm in SendGrid Activity. Optionally set DATAVERSE_MAIL_DEBUG=true in the template briefly and inspect kubectl logs / server.log.
Local Compose: docker compose after pull; .env.example SMTP block for 010-mailrelay parity.
Optional: run the deploy workflow against a non-prod cluster.

Risks / follow-ups

Chart does not install PostgreSQL; DB and Solr conf ConfigMap are operator-owned.
Some scripts/init.d scripts assume Compose-only resources (MinIO, scripts/triggers). Review before initdFromChart everywhere.
Mail: SendGrid must verify the From/support addresses; DATAVERSE_MAIL_MTA_PASSWORD changes require Payara restart (cached session).
scripts/init.d/vendor-solr/update-fields.sh vs scripts/solr/update-fields.sh — see README for IQSS refresh.

Stats

~87+ files touched; net addition mostly chart templates, deployment doc, ops template, and SMTP env wiring.

- Port chart from internal reference; rename templates to dataverseup - Chart version 0.1.0; scrub internal ops path references from values/messages - Fix helm test hook to wget /api/info/version over HTTP - docs/HELM.md install order, docs/DEPLOYMENT.md ticket context - values-examples/internal-solr-starter.yaml skeleton - README: Helm quick start and layout Made-with: Cursor

Made-with: Cursor

- Single source of truth under init.d/; Helm follows symlinks and helm package inlines file contents for portable tarballs - Align 010-mailrelay-set.sh header comments for Compose + Helm - Document in charts/dataverseup/README.md and docs/HELM.md Made-with: Cursor

… path) Made-with: Cursor

…r k3d cluster

…t deploy for fine-tuning later

…ues files instaed for user config

…RIPT_REVISION to see if it sets the correct one

aprilrieger added 13 commits April 1, 2026 22:24

Helm: remove remaining script name from solr-init error text

6f11ebb

Made-with: Cursor

init.d: clarify 010-mailrelay header for Compose + Helm (remove stale…

d3cafc5

… path) Made-with: Cursor

Update documentation and pull unecessary local testing values file fo…

6e0e241

…r k3d cluster

Bring in changes from containerize-dataverse

32020e4

Update to add jobs for apply branding and seeding the demo collection

def61e8

add github actions deploy and besties deploy values files from curren…

b2d6973

…t deploy for fine-tuning later

uncomment the values file :face-palm:

1f6c03e

Add to gitignore

ad4698b

Remove local guardrails -- not needed in ci deploys

1bf1ca5

Make it friends for demo

659fcea

Draw back on the smartness of the dynamic env vars - put into the val…

51982a2

…ues files instaed for user config

aprilrieger had a problem deploying to demo April 3, 2026 22:46 — with GitHub Actions Error

Update env vars for internal solr

ad734c8

aprilrieger had a problem deploying to demo April 3, 2026 23:00 — with GitHub Actions Error

Automate the solr conf since we dont build images yet

60c6f6e

aprilrieger had a problem deploying to demo April 3, 2026 23:34 — with GitHub Actions Error

aprilrieger added 2 commits April 3, 2026 16:39

Update the postgers host name correctly

07aaf43

add init setup to charts for automation

86f074b

aprilrieger temporarily deployed to demo April 3, 2026 23:47 — with GitHub Actions Inactive

automate the application of the branded elements

21a7927

aprilrieger temporarily deployed to demo April 3, 2026 23:56 — with GitHub Actions Inactive

aprilrieger temporarily deployed to demo April 4, 2026 00:26 — with GitHub Actions Inactive

Update script for applying branding to correct location on k8

2403a5f

aprilrieger temporarily deployed to demo April 4, 2026 00:40 — with GitHub Actions Inactive

aprilrieger added 2 commits April 3, 2026 17:55

update the brandin.env to have correct info

e064650

Update to compose to apply branding step each time

c7f6d99

aprilrieger temporarily deployed to demo April 4, 2026 01:01 — with GitHub Actions Inactive

aprilrieger had a problem deploying to demo April 4, 2026 01:16 — with GitHub Actions Error

Allow optional

7f9b4d2

aprilrieger had a problem deploying to demo April 4, 2026 01:39 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 01:45 — with GitHub Actions Failure

Update the script to add the token to pass correctly and the CHAIN_SC…

2b74989

…RIPT_REVISION to see if it sets the correct one

aprilrieger had a problem deploying to demo April 4, 2026 01:59 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 03:17 — with GitHub Actions Failure

Update seeded content script, dataverse is expecting JSON booleans

c0b651e

aprilrieger had a problem deploying to demo April 4, 2026 03:27 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 03:32 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 03:48 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 03:54 — with GitHub Actions Failure

Amazon SDk doesnt play nice

167da7a

aprilrieger had a problem deploying to demo April 4, 2026 04:04 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 04:11 — with GitHub Actions Failure

aprilrieger had a problem deploying to demo April 4, 2026 05:06 — with GitHub Actions Failure

aprilrieger temporarily deployed to demo April 4, 2026 05:15 — with GitHub Actions Inactive

aprilrieger added 3 commits April 3, 2026 22:38

Update documentatin

ce4591e

dry the code and refactor t condese docs

4178738

dry the code and refactor scripts

b50b2bd

aprilrieger temporarily deployed to demo April 4, 2026 05:52 — with GitHub Actions Inactive

Resolve merge conflicts

d2a53bd

aprilrieger changed the title ~~Add Helm chart, bin/helm_deploy, k3d local path, and GitHub Actions deploy for shared “besties” values~~ Add Helm chart, bin/helm_deploy, k3d local path, and GitHub Actions deploy Apr 4, 2026

aprilrieger changed the title ~~Add Helm chart, bin/helm_deploy, k3d local path, and GitHub Actions deploy~~ Add Helm chart, bin/helm_deploy, k3d local path, and GitHub Actions deploy to friends cluster Apr 4, 2026

aprilrieger changed the title ~~Add Helm chart, bin/helm_deploy, k3d local path, and GitHub Actions deploy to friends cluster~~ Helm chart, GitHub deploy workflow, and Kubernetes/Compose parity Apr 4, 2026

Smtp mail setup

4158b46

aprilrieger temporarily deployed to demo April 4, 2026 06:40 — with GitHub Actions Inactive

align smtp

9483b28

aprilrieger temporarily deployed to demo April 4, 2026 07:04 — with GitHub Actions Inactive

Update footer and add correct env vrs for smtp mail

e1a04cc

aprilrieger deployed to demo April 4, 2026 07:27 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Helm chart, GitHub deploy workflow, and Kubernetes/Compose parity#2

Helm chart, GitHub deploy workflow, and Kubernetes/Compose parity#2
aprilrieger wants to merge 33 commits intomainfrom
add-helm-charts

aprilrieger commented Apr 3, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

aprilrieger commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What’s included

Helm (charts/dataverseup)

SMTP / email (demo deploy + docs)

Operations & CI

Documentation

Repo layout (scripts)

Behavior & quality

How to test

Risks / follow-ups

Stats

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

aprilrieger commented Apr 3, 2026 •

edited

Loading

Helm (`charts/dataverseup`)