diff --git a/.gitea/workflows/ci.yaml b/.gitea/workflows/ci.yaml index 162035b..b09fdb0 100644 --- a/.gitea/workflows/ci.yaml +++ b/.gitea/workflows/ci.yaml @@ -37,8 +37,8 @@ jobs: - uses: actions/checkout@v4 - name: Lint and render the chart run: | - helm lint charts/musicmanager - helm template musicmanager charts/musicmanager --set users.existingSecret=test > /dev/null + helm lint charts/audiomanager + helm template audiomanager charts/audiomanager --set users.existingSecret=test > /dev/null chart-push: needs: diff --git a/README.md b/README.md index 97a66fb..58586d7 100644 --- a/README.md +++ b/README.md @@ -651,10 +651,10 @@ scripts/release.sh --deploy # also apply the users secret and helm upgrad ### 9.2 Helm chart -`charts/musicmanager` renders: +`charts/audiomanager` renders: - image repository/tag (defaults to `:latest` with `pullPolicy: Always`) and `imagePullSecrets` -- `library.folders` into a ConfigMap (`/etc/musicmanager/library.yaml`) +- `library.folders` into a ConfigMap (`/etc/audiomanager/library.yaml`) - `users.existingSecret` + key (Vault-managed; never put passwords in values) - ingress host `subsonic.tap-tap.win`, ingress class, annotations and TLS secret; cert-manager issues the certificate with the `letsencrypt-issuer` ClusterIssuer @@ -677,20 +677,20 @@ scripts/release.sh --tag latest --deploy To deploy by hand: ```bash -kubectl create namespace musicmanager +kubectl create namespace audiomanager -kubectl -n musicmanager create secret generic musicmanager-users \ +kubectl -n audiomanager create secret generic audiomanager-users \ --from-file=users.yaml=config/users.yaml -kubectl -n musicmanager create secret generic musicmanager-registry \ +kubectl -n audiomanager create secret generic audiomanager-registry \ --type=kubernetes.io/dockerconfigjson \ --from-file=.dockerconfigjson="$HOME/.docker/config.json" -helm upgrade --install musicmanager charts/musicmanager \ - --namespace musicmanager \ +helm upgrade --install audiomanager charts/audiomanager \ + --namespace audiomanager \ --set image.tag=latest \ - --set users.existingSecret=musicmanager-users \ - --set imagePullSecrets[0].name=musicmanager-registry + --set users.existingSecret=audiomanager-users \ + --set imagePullSecrets[0].name=audiomanager-registry ``` Pin a specific build with `--set image.tag=sha-`; CI publishes that tag for @@ -710,12 +710,12 @@ CI packages the chart and pushes it to the Gitea OCI registry after the `chart` job passes. The package is available at: ```text -oci://gitea.tap-tap.win/taptap/charts/musicmanager +oci://gitea.tap-tap.win/taptap/charts/audiomanager ``` Versions published by CI: -- `main`: `-sha.`, for example `0.1.1-sha.441fa05` +- `main`: `-sha.`, for example `0.1.2-sha.441fa05` - `v*` tag: the tag without the leading `v`, for example `v0.2.0` -> `0.2.0` The registry is private, and Helm keeps its own credentials (a Docker login is @@ -728,12 +728,12 @@ helm registry login gitea.tap-tap.win -u TapTap Install a published chart: ```bash -helm upgrade --install musicmanager \ - oci://gitea.tap-tap.win/taptap/charts/musicmanager \ - --version 0.1.1-sha.441fa05 \ - --namespace musicmanager \ - --set users.existingSecret=musicmanager-users \ - --set imagePullSecrets[0].name=musicmanager-registry +helm upgrade --install audiomanager \ + oci://gitea.tap-tap.win/taptap/charts/audiomanager \ + --version 0.1.2-sha.441fa05 \ + --namespace audiomanager \ + --set users.existingSecret=audiomanager-users \ + --set imagePullSecrets[0].name=audiomanager-registry ``` To package and push from a workstation, run `helm registry login` first and then: diff --git a/charts/musicmanager/Chart.yaml b/charts/audiomanager/Chart.yaml similarity index 75% rename from charts/musicmanager/Chart.yaml rename to charts/audiomanager/Chart.yaml index 3db4a6f..fd62e47 100644 --- a/charts/musicmanager/Chart.yaml +++ b/charts/audiomanager/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 -name: musicmanager +name: audiomanager description: Self-hosted OpenSubsonic music server type: application -version: 0.1.1 +version: 0.1.2 appVersion: "0.1.0" diff --git a/charts/musicmanager/templates/_helpers.tpl b/charts/audiomanager/templates/_helpers.tpl similarity index 74% rename from charts/musicmanager/templates/_helpers.tpl rename to charts/audiomanager/templates/_helpers.tpl index efc2171..c7a2dc8 100644 --- a/charts/musicmanager/templates/_helpers.tpl +++ b/charts/audiomanager/templates/_helpers.tpl @@ -1,8 +1,8 @@ -{{- define "musicmanager.name" -}} +{{- define "audiomanager.name" -}} {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} {{- end -}} -{{- define "musicmanager.fullname" -}} +{{- define "audiomanager.fullname" -}} {{- if .Values.fullnameOverride -}} {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} {{- else -}} @@ -15,19 +15,19 @@ {{- end -}} {{- end -}} -{{- define "musicmanager.labels" -}} +{{- define "audiomanager.labels" -}} helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" }} -app.kubernetes.io/name: {{ include "musicmanager.name" . }} +app.kubernetes.io/name: {{ include "audiomanager.name" . }} app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} app.kubernetes.io/managed-by: {{ .Release.Service }} {{- end -}} -{{- define "musicmanager.selectorLabels" -}} -app.kubernetes.io/name: {{ include "musicmanager.name" . }} +{{- define "audiomanager.selectorLabels" -}} +app.kubernetes.io/name: {{ include "audiomanager.name" . }} app.kubernetes.io/instance: {{ .Release.Name }} {{- end -}} -{{- define "musicmanager.image" -}} +{{- define "audiomanager.image" -}} {{- printf "%s:%s" .Values.image.repository (default .Chart.AppVersion .Values.image.tag) -}} {{- end -}} diff --git a/charts/musicmanager/templates/configmap-library.yaml b/charts/audiomanager/templates/configmap-library.yaml similarity index 71% rename from charts/musicmanager/templates/configmap-library.yaml rename to charts/audiomanager/templates/configmap-library.yaml index 94465cc..b926742 100644 --- a/charts/musicmanager/templates/configmap-library.yaml +++ b/charts/audiomanager/templates/configmap-library.yaml @@ -1,9 +1,9 @@ apiVersion: v1 kind: ConfigMap metadata: - name: {{ include "musicmanager.fullname" . }}-library + name: {{ include "audiomanager.fullname" . }}-library labels: - {{- include "musicmanager.labels" . | nindent 4 }} + {{- include "audiomanager.labels" . | nindent 4 }} data: library.yaml: | library: diff --git a/charts/musicmanager/templates/deployment.yaml b/charts/audiomanager/templates/deployment.yaml similarity index 82% rename from charts/musicmanager/templates/deployment.yaml rename to charts/audiomanager/templates/deployment.yaml index ba3f297..f79f72a 100644 --- a/charts/musicmanager/templates/deployment.yaml +++ b/charts/audiomanager/templates/deployment.yaml @@ -1,20 +1,20 @@ apiVersion: apps/v1 kind: Deployment metadata: - name: {{ include "musicmanager.fullname" . }} + name: {{ include "audiomanager.fullname" . }} labels: - {{- include "musicmanager.labels" . | nindent 4 }} + {{- include "audiomanager.labels" . | nindent 4 }} spec: replicas: {{ .Values.replicaCount }} strategy: type: Recreate selector: matchLabels: - {{- include "musicmanager.selectorLabels" . | nindent 6 }} + {{- include "audiomanager.selectorLabels" . | nindent 6 }} template: metadata: labels: - {{- include "musicmanager.selectorLabels" . | nindent 8 }} + {{- include "audiomanager.selectorLabels" . | nindent 8 }} annotations: checksum/library: {{ include (print $.Template.BasePath "/configmap-library.yaml") . | sha256sum }} spec: @@ -25,8 +25,8 @@ spec: securityContext: {{- toYaml .Values.podSecurityContext | nindent 8 }} containers: - - name: musicmanager - image: "{{ include "musicmanager.image" . }}" + - name: audiomanager + image: "{{ include "audiomanager.image" . }}" imagePullPolicy: {{ .Values.image.pullPolicy }} securityContext: {{- toYaml .Values.securityContext | nindent 12 }} @@ -36,9 +36,9 @@ spec: - name: DATA_DIR value: /data - name: LIBRARY_CONFIG - value: /etc/musicmanager/library.yaml + value: /etc/audiomanager/library.yaml - name: USERS_FILE - value: /etc/musicmanager/users.yaml + value: /etc/audiomanager/users.yaml - name: FFMPEG_PATH value: ffmpeg {{- with .Values.env }} @@ -63,11 +63,11 @@ spec: {{- toYaml .Values.resources | nindent 12 }} volumeMounts: - name: library - mountPath: /etc/musicmanager/library.yaml + mountPath: /etc/audiomanager/library.yaml subPath: library.yaml readOnly: true - name: users - mountPath: /etc/musicmanager/users.yaml + mountPath: /etc/audiomanager/users.yaml subPath: {{ .Values.users.key }} readOnly: true - name: data @@ -83,14 +83,14 @@ spec: volumes: - name: library configMap: - name: {{ include "musicmanager.fullname" . }}-library + name: {{ include "audiomanager.fullname" . }}-library - name: users secret: secretName: {{ required "users.existingSecret is required" .Values.users.existingSecret }} - name: data {{- if .Values.data.persistence.enabled }} persistentVolumeClaim: - claimName: {{ include "musicmanager.fullname" . }}-data + claimName: {{ include "audiomanager.fullname" . }}-data {{- else }} emptyDir: {} {{- end }} diff --git a/charts/musicmanager/templates/ingress.yaml b/charts/audiomanager/templates/ingress.yaml similarity index 81% rename from charts/musicmanager/templates/ingress.yaml rename to charts/audiomanager/templates/ingress.yaml index 2819fe3..29437b9 100644 --- a/charts/musicmanager/templates/ingress.yaml +++ b/charts/audiomanager/templates/ingress.yaml @@ -2,9 +2,9 @@ apiVersion: networking.k8s.io/v1 kind: Ingress metadata: - name: {{ include "musicmanager.fullname" . }} + name: {{ include "audiomanager.fullname" . }} labels: - {{- include "musicmanager.labels" . | nindent 4 }} + {{- include "audiomanager.labels" . | nindent 4 }} {{- with .Values.ingress.annotations }} annotations: {{- toYaml . | nindent 4 }} @@ -27,7 +27,7 @@ spec: pathType: {{ .Values.ingress.pathType }} backend: service: - name: {{ include "musicmanager.fullname" . }} + name: {{ include "audiomanager.fullname" . }} port: name: http {{- end }} diff --git a/charts/musicmanager/templates/pvc.yaml b/charts/audiomanager/templates/pvc.yaml similarity index 78% rename from charts/musicmanager/templates/pvc.yaml rename to charts/audiomanager/templates/pvc.yaml index af8def7..795cc43 100644 --- a/charts/musicmanager/templates/pvc.yaml +++ b/charts/audiomanager/templates/pvc.yaml @@ -2,9 +2,9 @@ apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: {{ include "musicmanager.fullname" . }}-data + name: {{ include "audiomanager.fullname" . }}-data labels: - {{- include "musicmanager.labels" . | nindent 4 }} + {{- include "audiomanager.labels" . | nindent 4 }} spec: accessModes: {{- toYaml .Values.data.persistence.accessModes | nindent 4 }} diff --git a/charts/musicmanager/templates/service.yaml b/charts/audiomanager/templates/service.yaml similarity index 55% rename from charts/musicmanager/templates/service.yaml rename to charts/audiomanager/templates/service.yaml index da1e268..774d289 100644 --- a/charts/musicmanager/templates/service.yaml +++ b/charts/audiomanager/templates/service.yaml @@ -1,13 +1,13 @@ apiVersion: v1 kind: Service metadata: - name: {{ include "musicmanager.fullname" . }} + name: {{ include "audiomanager.fullname" . }} labels: - {{- include "musicmanager.labels" . | nindent 4 }} + {{- include "audiomanager.labels" . | nindent 4 }} spec: type: {{ .Values.service.type }} selector: - {{- include "musicmanager.selectorLabels" . | nindent 4 }} + {{- include "audiomanager.selectorLabels" . | nindent 4 }} ports: - name: http port: {{ .Values.service.port }} diff --git a/charts/musicmanager/values.yaml b/charts/audiomanager/values.yaml similarity index 94% rename from charts/musicmanager/values.yaml rename to charts/audiomanager/values.yaml index 7f13f23..9508503 100644 --- a/charts/musicmanager/values.yaml +++ b/charts/audiomanager/values.yaml @@ -10,7 +10,7 @@ imagePullSecrets: [] nameOverride: "" fullnameOverride: "" -# Rendered into a ConfigMap as /etc/musicmanager/library.yaml. +# Rendered into a ConfigMap as /etc/audiomanager/library.yaml. # Keep folder IDs stable: they are part of song IDs. library: folders: @@ -25,7 +25,7 @@ library: # Vault-managed users.yaml. The secret must already exist and contain the key below. users: - existingSecret: musicmanager-users + existingSecret: audiomanager-users key: users.yaml data: diff --git a/scripts/push-chart.sh b/scripts/push-chart.sh index d25fdf3..9ea15db 100755 --- a/scripts/push-chart.sh +++ b/scripts/push-chart.sh @@ -14,7 +14,7 @@ ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" REGISTRY="${REGISTRY:-gitea.tap-tap.win}" CHART_REPO="${CHART_REPO:-taptap/charts}" -CHART_DIR="${CHART_DIR:-$ROOT/charts/musicmanager}" +CHART_DIR="${CHART_DIR:-$ROOT/charts/audiomanager}" OUTPUT_DIR="${OUTPUT_DIR:-$ROOT/dist}" VERSION="${VERSION:-}" @@ -22,7 +22,7 @@ usage() { cat <<'EOF' Usage: scripts/push-chart.sh [options] -Push the chart to oci:////musicmanager. +Push the chart to oci:////audiomanager. Options: -h, --help Show this help @@ -30,7 +30,7 @@ Options: Environment: REGISTRY OCI registry (default: gitea.tap-tap.win) CHART_REPO Repository path below the registry (default: taptap/charts) - CHART_DIR Chart directory (default: charts/musicmanager) + CHART_DIR Chart directory (default: charts/audiomanager) OUTPUT_DIR Directory for the packaged chart (default: dist) VERSION Chart version to package (overrides auto-detection) diff --git a/scripts/release.sh b/scripts/release.sh index 4801c04..960dd4a 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -10,11 +10,11 @@ set -euo pipefail ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" IMAGE="${IMAGE:-gitea.tap-tap.win/taptap/audiomanager}" -NAMESPACE="${NAMESPACE:-musicmanager}" -RELEASE="${RELEASE:-musicmanager}" -USERS_SECRET="${USERS_SECRET:-musicmanager-users}" +NAMESPACE="${NAMESPACE:-audiomanager}" +RELEASE="${RELEASE:-audiomanager}" +USERS_SECRET="${USERS_SECRET:-audiomanager-users}" USERS_FILE="${USERS_FILE:-$ROOT/config/users.yaml}" -PULL_SECRET="${PULL_SECRET:-musicmanager-registry}" +PULL_SECRET="${PULL_SECRET:-audiomanager-registry}" DOCKER_CONFIG_FILE="${DOCKER_CONFIG_FILE:-$HOME/.docker/config.json}" TAG="" @@ -33,11 +33,11 @@ Options: Environment: IMAGE Image repository (default: gitea.tap-tap.win/taptap/audiomanager) - NAMESPACE Kubernetes namespace (default: musicmanager) - RELEASE Helm release name (default: musicmanager) - USERS_SECRET Secret holding users.yaml (default: musicmanager-users) + NAMESPACE Kubernetes namespace (default: audiomanager) + RELEASE Helm release name (default: audiomanager) + USERS_SECRET Secret holding users.yaml (default: audiomanager-users) USERS_FILE Path to users.yaml for --deploy (default: config/users.yaml) - PULL_SECRET Image pull secret name (default: musicmanager-registry) + PULL_SECRET Image pull secret name (default: audiomanager-registry) DOCKER_CONFIG_FILE Docker config used for the pull secret (default: ~/.docker/config.json) EOF @@ -92,7 +92,7 @@ if [[ $DEPLOY -eq 1 ]]; then echo "No Docker config at $DOCKER_CONFIG_FILE; assuming an image pull secret is configured." fi - helm upgrade --install "$RELEASE" "$ROOT/charts/musicmanager" \ + helm upgrade --install "$RELEASE" "$ROOT/charts/audiomanager" \ --namespace "$NAMESPACE" \ "${helm_args[@]}" fi