feat!: Relocate repository

This commit is contained in:
Bernd Schorgers 2025-05-01 11:21:18 +02:00
parent d3bd21cf8a
commit ad087dee99
No known key found for this signature in database
40 changed files with 107 additions and 445 deletions

View file

@ -1,30 +0,0 @@
# 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
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
# OWNERS file for Kubernetes
OWNERS
# helm-docs templates
*.gotmpl
# helm unit tests
tests/

View file

@ -1,30 +0,0 @@
---
apiVersion: v2
description: Kubernetes admission controller to remove CPU limits from Pods.
name: k8s-ycl
version: 1.3.3
appVersion: v0.2.0
kubeVersion: ">=1.22.0-0"
sources:
- https://github.com/bjw-s/k8s-ycl
keywords:
- cpu
- resources
- limits
- admission
- controller
maintainers:
- name: bjw-s
email: me@bjw-s.dev
dependencies:
- name: common
repository: https://bjw-s.github.io/helm-charts
version: 3.6.1
annotations:
artifacthub.io/changes: |-
- kind: changed
description: |
Update common library to 3.6.1
artifacthub.io/links: |
- name: "source"
url: "https://github.com/bjw-s/k8s-ycl"

View file

@ -1,71 +0,0 @@
# k8s-ycl
![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![AppVersion: v0.2.0](https://img.shields.io/badge/AppVersion-v0.2.0-informational?style=flat-square)
Kubernetes admission controller to remove CPU limits from Pods.
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| bjw-s | <me@bjw-s.dev> | |
## Source Code
* <https://github.com/bjw-s/k8s-ycl>
## Requirements
Kubernetes: `>=1.22.0-0`
| Repository | Name | Version |
|------------|------|---------|
| https://bjw-s.github.io/helm-charts | common | 3.6.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controllers.main.containers.main.image.pullPolicy | string | `"Always"` | |
| controllers.main.containers.main.image.repository | string | `"ghcr.io/bjw-s/k8s-ycl"` | |
| controllers.main.containers.main.image.tag | string | `"{{ .Chart.AppVersion }}"` | |
| controllers.main.containers.main.probes.liveness.custom | bool | `true` | |
| controllers.main.containers.main.probes.liveness.enabled | bool | `true` | |
| controllers.main.containers.main.probes.liveness.spec.failureThreshold | int | `3` | |
| controllers.main.containers.main.probes.liveness.spec.httpGet.path | string | `"/healthz"` | |
| controllers.main.containers.main.probes.liveness.spec.httpGet.port | int | `8081` | |
| controllers.main.containers.main.probes.liveness.spec.initialDelaySeconds | int | `0` | |
| controllers.main.containers.main.probes.liveness.spec.periodSeconds | int | `10` | |
| controllers.main.containers.main.probes.liveness.spec.timeoutSeconds | int | `1` | |
| controllers.main.containers.main.probes.readiness.custom | bool | `true` | |
| controllers.main.containers.main.probes.readiness.enabled | bool | `true` | |
| controllers.main.containers.main.probes.readiness.spec.failureThreshold | int | `3` | |
| controllers.main.containers.main.probes.readiness.spec.httpGet.path | string | `"/readyz"` | |
| controllers.main.containers.main.probes.readiness.spec.httpGet.port | int | `8081` | |
| controllers.main.containers.main.probes.readiness.spec.initialDelaySeconds | int | `0` | |
| controllers.main.containers.main.probes.readiness.spec.periodSeconds | int | `10` | |
| controllers.main.containers.main.probes.readiness.spec.timeoutSeconds | int | `1` | |
| controllers.main.containers.main.probes.startup.custom | bool | `true` | |
| controllers.main.containers.main.probes.startup.enabled | bool | `true` | |
| controllers.main.containers.main.probes.startup.spec.failureThreshold | int | `30` | |
| controllers.main.containers.main.probes.startup.spec.httpGet.path | string | `"/healthz"` | |
| controllers.main.containers.main.probes.startup.spec.httpGet.port | int | `8081` | |
| controllers.main.containers.main.probes.startup.spec.initialDelaySeconds | int | `0` | |
| controllers.main.containers.main.probes.startup.spec.periodSeconds | int | `5` | |
| controllers.main.containers.main.probes.startup.spec.timeoutSeconds | int | `1` | |
| controllers.main.strategy | string | `"RollingUpdate"` | |
| persistence.certs.globalMounts[0].path | string | `"/tls"` | |
| persistence.certs.name | string | `"{{ include \"k8s-ycl.servingCertificate\" . }}"` | |
| persistence.certs.type | string | `"secret"` | |
| service.main.controller | string | `"main"` | |
| service.main.nameOverride | string | `"webhook"` | |
| service.main.ports.http.port | int | `9443` | |
| service.main.ports.metrics.port | int | `8080` | |
| service.main.ports.probe.port | int | `8081` | |
| serviceAccount.create | bool | `true` | |
| webhook.ignoreOwnNamespace | bool | `true` | |
| webhook.ignoredNamespaces[0] | string | `"kube-system"` | |
| webhook.path | string | `"/mutate--v1-pod"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)

View file

@ -1,2 +0,0 @@
{{- define "k8s-ycl.hardcodedValues" -}}
{{- end -}}

View file

@ -1,44 +0,0 @@
{{- define "k8s-ycl.init" -}}
{{/* Make sure all variables are set properly */}}
{{- include "bjw-s.common.loader.init" . }}
{{- $_ := include "k8s-ycl.hardcodedValues" . | fromYaml | merge .Values -}}
{{- end -}}
{{- define "k8s-ycl.webhookPort" -}}
9443
{{- end -}}
{{- define "k8s-ycl.webhookPath" -}}
/mutate--v1-pod
{{- end -}}
{{- define "k8s-ycl.ignoredNamespaces" -}}
{{- $ownNamespace := $.Release.Namespace -}}
{{- $ignoredNamespaces := list -}}
{{- if $.Values.webhook.ignoreOwnNamespace -}}
{{- $ignoredNamespaces = append $ignoredNamespaces $ownNamespace -}}
{{- end -}}
{{- with $.Values.webhook.ignoredNamespaces -}}
{{- range . -}}
{{- $ignoredNamespaces = append $ignoredNamespaces . -}}
{{- end -}}
{{- end -}}
{{- $ignoredNamespaces | uniq | toYaml -}}
{{- end -}}
{{- define "k8s-ycl.selfSignedIssuer" -}}
{{ printf "%s-webhook-selfsign" (include "bjw-s.common.lib.chart.names.fullname" .) }}
{{- end -}}
{{- define "k8s-ycl.rootCAIssuer" -}}
{{ printf "%s-webhook-ca" (include "bjw-s.common.lib.chart.names.fullname" .) }}
{{- end -}}
{{- define "k8s-ycl.rootCACertificate" -}}
{{ printf "%s-webhook-ca" (include "bjw-s.common.lib.chart.names.fullname" .) }}
{{- end -}}
{{- define "k8s-ycl.servingCertificate" -}}
{{ printf "%s-webhook-tls" (include "bjw-s.common.lib.chart.names.fullname" .) }}
{{- end -}}

View file

@ -1,39 +0,0 @@
{{/* Make sure all variables are set properly */}}
{{- include "k8s-ycl.init" . -}}
---
apiVersion: admissionregistration.k8s.io/v1
kind: MutatingWebhookConfiguration
metadata:
name: {{ include "bjw-s.common.lib.chart.names.fullname" . | quote }}
{{- with (include "bjw-s.common.lib.metadata.allLabels" $ | fromYaml) }}
labels: {{- toYaml . | nindent 4 }}
{{- end }}
annotations:
cert-manager.io/inject-ca-from: "{{ .Release.Namespace }}/{{ include "k8s-ycl.servingCertificate" . }}"
webhooks:
- name: "{{ include "bjw-s.common.lib.chart.names.fullname" . }}.svc.cluster.local"
namespaceSelector:
matchExpressions:
- key: kubernetes.io/metadata.name
operator: NotIn
values: {{ include "k8s-ycl.ignoredNamespaces" . | nindent 10 }}
clientConfig:
service:
namespace: {{ .Release.Namespace | quote }}
name: {{ include "bjw-s.common.lib.chart.names.fullname" . }}-webhook
path: {{ include "k8s-ycl.webhookPath" . }}
port: {{ include "k8s-ycl.webhookPort" . }}
failurePolicy: Fail
admissionReviewVersions: ["v1", "v1beta1"]
sideEffects: None
timeoutSeconds: 5
rules:
- apiGroups:
- ""
apiVersions:
- v1
operations:
- CREATE
- UPDATE
resources:
- pods

View file

@ -1,6 +0,0 @@
---
{{/* Make sure all variables are set properly */}}
{{- include "k8s-ycl.init" . }}
{{/* Render the templates */}}
{{- include "bjw-s.common.loader.all" . }}

View file

@ -1,62 +0,0 @@
{{/* Make sure all variables are set properly */}}
{{- include "k8s-ycl.init" . -}}
---
# Create a selfsigned Issuer, in order to create a root CA certificate for
# signing webhook serving certificates
apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
name: {{ include "k8s-ycl.selfSignedIssuer" . }}
namespace: {{ .Release.Namespace | quote }}
labels:
{{- include "bjw-s.common.lib.metadata.allLabels" . | nindent 4 }}
spec:
selfSigned: {}
---
# Generate a CA Certificate used to sign certificates for the webhook
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: {{ include "k8s-ycl.rootCACertificate" . }}
namespace: {{ .Release.Namespace | quote }}
labels:
{{- include "bjw-s.common.lib.metadata.allLabels" . | nindent 4 }}
spec:
secretName: {{ include "k8s-ycl.rootCACertificate" . }}
duration: 43800h # 5y
issuerRef:
name: {{ include "k8s-ycl.selfSignedIssuer" . }}
kind: Issuer
commonName: "ca.k8s-ycl.cert-manager"
isCA: true
---
# Create an Issuer that uses the above generated CA certificate to issue certs
apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
name: {{ include "k8s-ycl.rootCAIssuer" . }}
namespace: {{ .Release.Namespace | quote }}
labels:
{{- include "bjw-s.common.lib.metadata.allLabels" . | nindent 4 }}
spec:
ca:
secretName: {{ include "k8s-ycl.rootCACertificate" . }}
---
# Finally, generate a serving certificate for the webhook to use
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: {{ include "k8s-ycl.servingCertificate" . }}
namespace: {{ .Release.Namespace | quote }}
labels:
{{- include "bjw-s.common.lib.metadata.allLabels" . | nindent 4 }}
spec:
secretName: {{ include "k8s-ycl.servingCertificate" . }}
duration: 8760h # 1y
issuerRef:
name: {{ include "k8s-ycl.rootCAIssuer" . }}
kind: Issuer
dnsNames:
- {{ include "bjw-s.common.lib.chart.names.fullname" . }}-webhook
- {{ include "bjw-s.common.lib.chart.names.fullname" . }}-webhook.{{ .Release.Namespace }}
- {{ include "bjw-s.common.lib.chart.names.fullname" . }}-webhook.{{ .Release.Namespace }}.svc

View file

@ -1,3 +0,0 @@
{
"$ref": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.6.1/charts/library/common/values.schema.json"
}

View file

@ -1,75 +0,0 @@
---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.0.3/charts/other/app-template/schemas/helmrelease-helm-v2beta2.schema.json
controllers:
main:
strategy: RollingUpdate
containers:
main:
image:
repository: ghcr.io/bjw-s/k8s-ycl
tag: "{{ .Chart.AppVersion }}"
pullPolicy: Always
probes:
liveness:
enabled: true
custom: true
spec:
httpGet:
path: /healthz
port: 8081
initialDelaySeconds: 0
periodSeconds: 10
timeoutSeconds: 1
failureThreshold: 3
readiness:
enabled: true
custom: true
spec:
httpGet:
path: /readyz
port: 8081
initialDelaySeconds: 0
periodSeconds: 10
timeoutSeconds: 1
failureThreshold: 3
startup:
enabled: true
custom: true
spec:
httpGet:
path: /healthz
port: 8081
initialDelaySeconds: 0
failureThreshold: 30
periodSeconds: 5
timeoutSeconds: 1
persistence:
certs:
type: secret
name: >-
{{ include "k8s-ycl.servingCertificate" . }}
globalMounts:
- path: /tls
service:
main:
controller: main
nameOverride: webhook
ports:
http:
port: 9443
metrics:
port: 8080
probe:
port: 8081
serviceAccount:
create: true
webhook:
path: /mutate--v1-pod
ignoreOwnNamespace: true
ignoredNamespaces:
- kube-system

View file

@ -12,4 +12,4 @@ chart-dirs:
- charts/other - charts/other
chart-repos: chart-repos:
- bjw-s=https://bjw-s.github.io/helm-charts - bjw-s=https://bjw-s-labs.github.io/helm-charts

View file

@ -1,12 +1,12 @@
--- ---
# Project information # Project information
site_name: bjw-s Helm Charts site_name: bjw-s Helm Charts
site_url: https://bjw-s.github.io/helm-charts/ site_url: https://bjw-s-labs.github.io/helm-charts/
site_author: bjw-s site_author: bjw-s
# Repository # Repository
repo_name: bjw-s/helm-charts repo_name: bjw-s-labs/helm-charts
repo_url: https://github.com/bjw-s/helm-charts repo_url: https://github.com/bjw-s-labs/helm-charts
# Configuration # Configuration
docs_dir: ../../docs docs_dir: ../../docs

View file

@ -2,6 +2,6 @@
extends: [ extends: [
"github>bjw-s/renovate-config", "github>bjw-s/renovate-config",
"github>bjw-s/renovate-config:automerge-github-actions", "github>bjw-s/renovate-config:automerge-github-actions",
"github>bjw-s/helm-charts//.github/renovate/custom-managers.json5" "github>bjw-s-labs/helm-charts//.github/renovate/custom-managers.json5"
], ],
} }

View file

@ -6,12 +6,12 @@
description: "Process common lib json schema references", description: "Process common lib json schema references",
fileMatch: ["\\.json$"], fileMatch: ["\\.json$"],
matchStrings: [ matchStrings: [
// https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.0.3/charts/library/common/values.schema.json // https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.0.3/charts/library/common/values.schema.json
"https:\\/\\/raw.githubusercontent.com\\/bjw-s\\/helm-charts\\/(?<depName>\\S+?)-(?<currentValue>[\\d\\.]+?)\\/\\S+", "https:\\/\\/raw.githubusercontent.com\\/bjw-s-labs\\/helm-charts\\/(?<depName>\\S+?)-(?<currentValue>[\\d\\.]+?)\\/\\S+",
], ],
datasourceTemplate: "helm", datasourceTemplate: "helm",
versioningTemplate: "semver", versioningTemplate: "semver",
registryUrlTemplate: "https://bjw-s.github.io/helm-charts" registryUrlTemplate: "https://bjw-s-labs.github.io/helm-charts"
}, },
], ],
} }

View file

@ -82,7 +82,7 @@ jobs:
# ---------------------------- # ----------------------------
- name: Get chart details - name: Get chart details
id: chart-details id: chart-details
uses: bjw-s-labs/helm-charts-actions/get-chart-details@main uses: bjw-s-labs/helm-charts-actions/get-chart-details@2025.2.0
with: with:
path: src/charts/${{ inputs.chart }} path: src/charts/${{ inputs.chart }}
validateChartYaml: true validateChartYaml: true
@ -131,7 +131,7 @@ jobs:
# Package Helm chart # Package Helm chart
# ---------------------------- # ----------------------------
- name: Dereference JSON schema before packaging - name: Dereference JSON schema before packaging
uses: bjw-s-labs/helm-charts-actions/dereference-json-schema@main uses: bjw-s-labs/helm-charts-actions/dereference-json-schema@2025.2.0
with: with:
schemaFile: "src/charts/${{ inputs.chart }}/values.schema.json" schemaFile: "src/charts/${{ inputs.chart }}/values.schema.json"
outputFile: "src/charts/${{ inputs.chart }}/values.schema.json" outputFile: "src/charts/${{ inputs.chart }}/values.schema.json"
@ -182,7 +182,7 @@ jobs:
shell: bash shell: bash
working-directory: gh-pages working-directory: gh-pages
run: | run: |
helm repo index . --url https://bjw-s.github.io/helm-charts/ helm repo index . --url https://bjw-s-labs.github.io/helm-charts/
- name: Commit Changes - name: Commit Changes
if: ${{ inputs.publishToGhPages }} if: ${{ inputs.publishToGhPages }}
@ -235,8 +235,8 @@ jobs:
PACKAGE_FILE: ${{ steps.package-chart.outputs.result }} PACKAGE_FILE: ${{ steps.package-chart.outputs.result }}
CHART_NAME: ${{ steps.chart-details.outputs.name }} CHART_NAME: ${{ steps.chart-details.outputs.name }}
CHART_VERSION: ${{ steps.chart-details.outputs.version }} CHART_VERSION: ${{ steps.chart-details.outputs.version }}
CHART_TAG_BASE: ghcr.io/bjw-s/helm CHART_TAG_BASE: ghcr.io/bjw-s-labs/helm
CHART_TAG: ${{ steps.chart-details.outputs.name }}:${{ inputs.steps.chart-details.outputs.version }} CHART_TAG: ${{ steps.chart-details.outputs.name }}:${{ steps.chart-details.outputs.version }}
run: | run: |
helm push "${PACKAGE_FILE}" oci://${CHART_TAG_BASE} &> push-metadata.txt helm push "${PACKAGE_FILE}" oci://${CHART_TAG_BASE} &> push-metadata.txt
cat push-metadata.txt cat push-metadata.txt

View file

@ -47,7 +47,7 @@ jobs:
- name: Get chart details for PR - name: Get chart details for PR
id: chart-details-pr id: chart-details-pr
uses: bjw-s-labs/helm-charts-actions/get-chart-details@main uses: bjw-s-labs/helm-charts-actions/get-chart-details@2025.2.0
with: with:
path: pull/charts/${{ matrix.chart }} path: pull/charts/${{ matrix.chart }}
validateChartYaml: true validateChartYaml: true
@ -55,7 +55,7 @@ jobs:
- name: Get chart details for default branch - name: Get chart details for default branch
id: chart-details-default id: chart-details-default
uses: bjw-s-labs/helm-charts-actions/get-chart-details@main uses: bjw-s-labs/helm-charts-actions/get-chart-details@2025.2.0
with: with:
path: default/charts/${{ matrix.chart }} path: default/charts/${{ matrix.chart }}
allowChartToNotExist: true allowChartToNotExist: true
@ -127,8 +127,8 @@ jobs:
COMMON_LIBRARY_LOCATION: ${{ github.workspace }}/charts/library/common COMMON_LIBRARY_LOCATION: ${{ github.workspace }}/charts/library/common
working-directory: charts/${{ matrix.chart }} working-directory: charts/${{ matrix.chart }}
run: | run: |
yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s.github.io/helm-charts").version = ">0.0.0-0")' Chart.yaml yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s-labs.github.io/helm-charts").version = ">0.0.0-0")' Chart.yaml
yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s.github.io/helm-charts").repository = "file://${{ env.COMMON_LIBRARY_LOCATION }}")' Chart.yaml yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s-labs.github.io/helm-charts").repository = "file://${{ env.COMMON_LIBRARY_LOCATION }}")' Chart.yaml
echo "::group::Modified Chart.yaml" echo "::group::Modified Chart.yaml"
cat Chart.yaml cat Chart.yaml
echo "::endgroup::" echo "::endgroup::"

View file

@ -86,8 +86,8 @@ jobs:
COMMON_LIBRARY_LOCATION: ${{ github.workspace }}/charts/library/common COMMON_LIBRARY_LOCATION: ${{ github.workspace }}/charts/library/common
working-directory: charts/${{ matrix.chart }} working-directory: charts/${{ matrix.chart }}
run: | run: |
yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s.github.io/helm-charts").version = ">0.0.0-0")' Chart.yaml yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s-labs.github.io/helm-charts").version = ">0.0.0-0")' Chart.yaml
yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s.github.io/helm-charts").repository = "file://${{ env.COMMON_LIBRARY_LOCATION }}")' Chart.yaml yq -i '. |= .dependencies |= map(select(.name == "common" and .repository == "https://bjw-s-labs.github.io/helm-charts").repository = "file://${{ env.COMMON_LIBRARY_LOCATION }}")' Chart.yaml
echo "::group::Modified Chart.yaml" echo "::group::Modified Chart.yaml"
cat Chart.yaml cat Chart.yaml
echo "::endgroup::" echo "::endgroup::"
@ -145,7 +145,7 @@ jobs:
helm: "${{ inputs.helmVersion }}" helm: "${{ inputs.helmVersion }}"
- name: Dereference JSON schema - name: Dereference JSON schema
uses: bjw-s-labs/helm-charts-actions/dereference-json-schema@main uses: bjw-s-labs/helm-charts-actions/dereference-json-schema@2025.2.0
with: with:
schemaFile: "charts/${{ matrix.chart }}/values.schema.json" schemaFile: "charts/${{ matrix.chart }}/values.schema.json"
outputFile: "charts/${{ matrix.chart }}/values.schema.json" outputFile: "charts/${{ matrix.chart }}/values.schema.json"

View file

@ -13,12 +13,13 @@ on:
permissions: permissions:
contents: read contents: read
jobs: concurrency:
release-docs:
name: Release documentation
runs-on: ubuntu-22.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
jobs:
build-docs:
name: Build documentation
runs-on: ubuntu-22.04
permissions: permissions:
contents: write contents: write
steps: steps:
@ -26,8 +27,8 @@ jobs:
uses: actions/create-github-app-token@3ff1caaa28b64c9cc276ce0a02e2ff584f3900c5 # v2.0.2 uses: actions/create-github-app-token@3ff1caaa28b64c9cc276ce0a02e2ff584f3900c5 # v2.0.2
id: app-token id: app-token
with: with:
app-id: "${{ secrets.BJWS_APP_ID }}" app-id: ${{ secrets.LAB_ASSISTANT_APP_ID }}
private-key: "${{ secrets.BJWS_APP_PRIVATE_KEY }}" private-key: ${{ secrets.LAB_ASSISTANT_APP_KEY }}
- name: Checkout main branch - name: Checkout main branch
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@ -52,5 +53,33 @@ jobs:
github_token: ${{ steps.app-token.outputs.token }} github_token: ${{ steps.app-token.outputs.token }}
publish_dir: ./site publish_dir: ./site
destination_dir: docs destination_dir: docs
user_name: "bjw-s-bot[bot]"
user_email: "bjw-s-bot <87358111+bjw-s-bot[bot]@users.noreply.github.com>" publish-docs:
name: Publish documentation
runs-on: ubuntu-22.04
needs:
- build-docs
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout main branch
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
path: src
- name: Checkout gh-pages branch
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: gh-pages
path: gh-pages
- name: Deploy changes to GitHub Pages
uses: ./src/.github/actions/publish-folder-to-pages
with:
path: gh-pages/
deleteArtifactAfterPublish: true

View file

@ -14,14 +14,9 @@
<br><br> <br><br>
👋 Welcome to my Helm Charts repository. This repo contains Helm charts that I have developed to run applications in my [home Kubernetes cluster](https://github.com/bjw-s/home-ops/). 👋 Welcome to my Helm Charts repository. This repo contains Helm charts that I have developed to run applications in my [home Kubernetes cluster](https://github.com/bjw-s-labs/home-ops/).
This repo is **not** intended to be a replacement for any of the large collections of Helm charts that are out there. This repo is **not** intended to be a replacement for any of the large collections of Helm charts that are out there.
# 🚨 Notification 🚨
This repository is scheduled to move to a new location on May 1st 2025. See https://github.com/bjw-s/helm-charts/issues/378 for more details.
--- ---
## Installation ## Installation
@ -31,7 +26,7 @@ This repository is scheduled to move to a new location on May 1st 2025. See http
The Helm repository can be installed as follows: The Helm repository can be installed as follows:
```console ```console
helm repo add bjw-s https://bjw-s.github.io/helm-charts helm repo add bjw-s https://bjw-s-labs.github.io/helm-charts
``` ```
You can then run `helm search repo bjw-s` to search the charts. You can then run `helm search repo bjw-s` to search the charts.
@ -40,7 +35,7 @@ You can then run `helm search repo bjw-s` to search the charts.
### 📖 Docs ### 📖 Docs
The documentation that goes along with this repo can be found [over here](https://bjw-s.github.io/helm-charts/). The documentation that goes along with this repo can be found [over here](https://bjw-s-labs.github.io/helm-charts/).
--- ---
@ -69,4 +64,4 @@ repositories containing any application you might wish to run.
### 🔏 License ### 🔏 License
See [LICENSE](https://github.com/bjw-s/helm-charts/blob/main/LICENSE) See [LICENSE](https://github.com/bjw-s-labs/helm-charts/blob/main/LICENSE)

View file

@ -8,12 +8,12 @@ kubeVersion: ">=1.22.0-0"
keywords: keywords:
- common - common
- library - library
home: https://github.com/bjw-s/helm-charts/tree/main/charts/library/common home: https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common
maintainers: maintainers:
- name: bjw-s - name: bjw-s
email: me@bjw-s.dev email: me@bjw-s.dev
sources: sources:
- https://github.com/bjw-s/helm-charts - https://github.com/bjw-s-labs/helm-charts
annotations: annotations:
artifacthub.io/changes: |- artifacthub.io/changes: |-
- kind: fixed - kind: fixed

View file

@ -28,10 +28,10 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
dependencies: dependencies:
- name: common - name: common
version: 3.7.3 version: 3.7.3
repository: https://bjw-s.github.io/helm-charts/ repository: https://bjw-s-labs.github.io/helm-charts/
``` ```
For more information, take a look at the [Docs](http://bjw-s.github.io/helm-charts/docs/common-library/introduction/). For more information, take a look at the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/common-library/introduction/).
## Configuration ## Configuration
@ -39,14 +39,14 @@ Read through the [values.yaml](./values.yaml) file. It has several commented out
## Values ## Values
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) **Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common/values.yaml)
These values will be validated by a JSON schema which can be found [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.schema.json) These values will be validated by a JSON schema which can be found [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common/values.schema.json)
## Support ## Support
- See the [Docs](http://bjw-s.github.io/helm-charts/docs/) - See the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/)
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose) - Open an [issue](https://github.com/bjw-s-labs/helm-charts/issues/new/choose)
- Join the home-operations [Discord](https://discord.gg/home-operations) community - Join the home-operations [Discord](https://discord.gg/home-operations) community
---------------------------------------------- ----------------------------------------------

View file

@ -1,5 +1,5 @@
{{- define "custom.helm.url" -}} {{- define "custom.helm.url" -}}
https://bjw-s.github.io/helm-charts/ https://bjw-s-labs.github.io/helm-charts/
{{- end -}} {{- end -}}
{{ template "chart.header" . }} {{ template "chart.header" . }}
@ -36,7 +36,7 @@ dependencies:
repository: {{template "custom.helm.url"}} repository: {{template "custom.helm.url"}}
``` ```
For more information, take a look at the [Docs](http://bjw-s.github.io/helm-charts/docs/common-library/introduction/). For more information, take a look at the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/common-library/introduction/).
## Configuration ## Configuration
@ -44,14 +44,14 @@ Read through the [values.yaml](./values.yaml) file. It has several commented out
## Values ## Values
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) **Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common/values.yaml)
These values will be validated by a JSON schema which can be found [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.schema.json) These values will be validated by a JSON schema which can be found [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common/values.schema.json)
## Support ## Support
- See the [Docs](http://bjw-s.github.io/helm-charts/docs/) - See the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/)
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose) - Open an [issue](https://github.com/bjw-s-labs/helm-charts/issues/new/choose)
- Join the home-operations [Discord](https://discord.gg/home-operations) community - Join the home-operations [Discord](https://discord.gg/home-operations) community
{{ template "helm-docs.versionFooter" . }} {{ template "helm-docs.versionFooter" . }}

View file

@ -1,6 +1,6 @@
{ {
"$schema": "http://json-schema.org/draft-07/schema", "$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.7.3/charts/library/common/values.schema.json", "$id": "https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.7.3/charts/library/common/values.schema.json",
"type": "object", "type": "object",
"properties": { "properties": {
"global": { "global": {

View file

@ -734,7 +734,7 @@ route:
# -- Configure persistence for the chart here. # -- Configure persistence for the chart here.
# Additional items can be added by adding a dictionary key similar to the 'config' key. # Additional items can be added by adding a dictionary key similar to the 'config' key.
# [[ref]](https://bjw-s.github.io/helm-charts/docs/common-library/common-library-storage) # [[ref]](https://bjw-s-labs.github.io/helm-charts/docs/common-library/common-library-storage)
# @default -- See below # @default -- See below
persistence: persistence:
{} {}

View file

@ -9,10 +9,10 @@ maintainers:
email: me@bjw-s.dev email: me@bjw-s.dev
dependencies: dependencies:
- name: common - name: common
repository: https://bjw-s.github.io/helm-charts repository: https://bjw-s-labs.github.io/helm-charts
version: 3.7.3 version: 3.7.3
sources: sources:
- https://github.com/bjw-s/helm-charts - https://github.com/bjw-s-labs/helm-charts
annotations: annotations:
artifacthub.io/changes: |- artifacthub.io/changes: |-
- kind: fixed - kind: fixed

View file

@ -12,13 +12,13 @@ Kubernetes: `>=1.22.0-0`
| Repository | Name | Version | | Repository | Name | Version |
|------------|------|---------| |------------|------|---------|
| https://bjw-s.github.io/helm-charts | common | 3.7.3 | | https://bjw-s-labs.github.io/helm-charts | common | 3.7.3 |
## Installing the Chart ## Installing the Chart
```bash ```bash
# Add the repository # Add the repository
helm repo add bjw-s https://bjw-s.github.io/helm-charts/ helm repo add bjw-s https://bjw-s-labs.github.io/helm-charts/
# Install the chart # Install the chart
helm install bjw-s app-template -f values.yaml helm install bjw-s app-template -f values.yaml
@ -31,12 +31,12 @@ The [CI tests](../../library/common-test/ci) contain a number of scenarios that
## Upgrade instructions ## Upgrade instructions
Upgrade instructions can be found in the [documentation](https://bjw-s.github.io/helm-charts/docs/app-template/#upgrade-instructions). Upgrade instructions can be found in the [documentation](https://bjw-s-labs.github.io/helm-charts/docs/app-template/#upgrade-instructions).
## Support ## Support
- See the [Docs](http://bjw-s.github.io/helm-charts/docs/) - See the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/)
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose) - Open an [issue](https://github.com/bjw-s-labs/helm-charts/issues/new/choose)
- Join the home-operations [Discord](https://discord.gg/home-operations) community - Join the home-operations [Discord](https://discord.gg/home-operations) community
---------------------------------------------- ----------------------------------------------

View file

@ -1,5 +1,5 @@
{{- define "custom.helm.url" -}} {{- define "custom.helm.url" -}}
https://bjw-s.github.io/helm-charts/ https://bjw-s-labs.github.io/helm-charts/
{{- end -}} {{- end -}}
{{ template "chart.header" . }} {{ template "chart.header" . }}
@ -35,12 +35,12 @@ The [CI tests](../../library/common-test/ci) contain a number of scenarios that
## Upgrade instructions ## Upgrade instructions
Upgrade instructions can be found in the [documentation](https://bjw-s.github.io/helm-charts/docs/app-template/#upgrade-instructions). Upgrade instructions can be found in the [documentation](https://bjw-s-labs.github.io/helm-charts/docs/app-template/#upgrade-instructions).
## Support ## Support
- See the [Docs](http://bjw-s.github.io/helm-charts/docs/) - See the [Docs](http://bjw-s-labs.github.io/helm-charts/docs/)
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose) - Open an [issue](https://github.com/bjw-s-labs/helm-charts/issues/new/choose)
- Join the home-operations [Discord](https://discord.gg/home-operations) community - Join the home-operations [Discord](https://discord.gg/home-operations) community
{{ template "helm-docs.versionFooter" . }} {{ template "helm-docs.versionFooter" . }}

View file

@ -726,7 +726,7 @@
"values": { "values": {
"description": "Values holds the values for this Helm release.", "description": "Values holds the values for this Helm release.",
"x-kubernetes-preserve-unknown-fields": true, "x-kubernetes-preserve-unknown-fields": true,
"$ref": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.7.3/charts/library/common/values.schema.json" "$ref": "https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.7.3/charts/library/common/values.schema.json"
}, },
"valuesFrom": { "valuesFrom": {
"description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease,\nand information about how they should be merged.", "description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease,\nand information about how they should be merged.",

View file

@ -727,7 +727,7 @@
"values": { "values": {
"description": "Values holds the values for this Helm release.", "description": "Values holds the values for this Helm release.",
"x-kubernetes-preserve-unknown-fields": true, "x-kubernetes-preserve-unknown-fields": true,
"$ref": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.7.3/charts/library/common/values.schema.json" "$ref": "https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.7.3/charts/library/common/values.schema.json"
}, },
"valuesFrom": { "valuesFrom": {
"description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.", "description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.",

View file

@ -1,3 +1,3 @@
{ {
"$ref": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.7.3/charts/library/common/values.schema.json" "$ref": "https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.7.3/charts/library/common/values.schema.json"
} }

View file

@ -15,13 +15,13 @@ In order to use this template chart, you would deploy it as you would any other
By setting the desired values, the common library chart will render the desired resources. By setting the desired values, the common library chart will render the desired resources.
Be sure to check out the [common library docs](../common-library/index.md) Be sure to check out the [common library docs](../common-library/index.md)
and its [`values.yaml`](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) for and its [`values.yaml`](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common/values.yaml) for
more information about the available configuration options. more information about the available configuration options.
#### Examples #### Examples
This is an example `values.yaml` file that would deploy the [vaultwarden](https://github.com/dani-garcia/vaultwarden) This is an example `values.yaml` file that would deploy the [vaultwarden](https://github.com/dani-garcia/vaultwarden)
application. For more deployment examples, check out the [`examples` folder](https://github.com/bjw-s/helm-charts/tree/main/examples/). application. For more deployment examples, check out the [`examples` folder](https://github.com/bjw-s-labs/helm-charts/tree/main/examples/).
```yaml linenums="1" ```yaml linenums="1"
--8<-- --8<--
@ -38,7 +38,7 @@ The main changes from v2.x to v3.x are the removal of the default `main` objects
!!! warning !!! warning
**IMPORTANT** The introduction of the json schema adds additional validations and restrictions on the contents of your chart values. **IMPORTANT** The introduction of the json schema adds additional validations and restrictions on the contents of your chart values.
Things may have been missed during the initial schema creation, so if you run in to any unexpected validation errors please [raise an issue](https://github.com/bjw-s/helm-charts/issues/new?assignees=bjw-s&labels=bug&projects=&template=bug-report.md&title=) Things may have been missed during the initial schema creation, so if you run in to any unexpected validation errors please [raise an issue](https://github.com/bjw-s-labs/helm-charts/issues/new?assignees=bjw-s&labels=bug&projects=&template=bug-report.md&title=)
Given the following real-life example values.yaml for app-template v2: Given the following real-life example values.yaml for app-template v2:
@ -96,7 +96,7 @@ The values for app-template v3.x would become this:
```yaml ```yaml
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.2.0/charts/library/common/values.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.2.0/charts/library/common/values.schema.json
defaultPodOptions: defaultPodOptions:
enableServiceLinks: true enableServiceLinks: true
securityContext: securityContext:
@ -162,7 +162,7 @@ persistence:
+++ new +++ new
@@ -1,42 +1,55 @@ @@ -1,42 +1,55 @@
--- ---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.2.0/charts/library/common/values.schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/common-3.2.0/charts/library/common/values.schema.json
defaultPodOptions: defaultPodOptions:
+ enableServiceLinks: true + enableServiceLinks: true
securityContext: securityContext:
@ -247,7 +247,7 @@ This is not meant as an exhaustive list of changes, but rather a "most common" e
!!! info !!! info
Some items (Ingress, ports, persistence items, etc) now default to being enabled by default. However, this is not always the case for some of the `items due to overrides in the default `values.yaml`. Some items (Ingress, ports, persistence items, etc) now default to being enabled by default. However, this is not always the case for some of the `items due to overrides in the default `values.yaml`.
[More background](https://github.com/bjw-s/helm-charts/issues/205) [More background](https://github.com/bjw-s-labs/helm-charts/issues/205)
Given the following real-life example values.yaml for app-template v1: Given the following real-life example values.yaml for app-template v1:
@ -371,4 +371,4 @@ This is not meant as an exhaustive list of changes, but rather a "most common" e
## Source code ## Source code
The source code for the app template chart can be found The source code for the app template chart can be found
[here](https://github.com/bjw-s/helm-charts/tree/main/charts/other/app-template). [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/other/app-template).

View file

@ -40,4 +40,4 @@ dependency on what I call the `common` library.
## Source code ## Source code
The source code for the common library chart can be found The source code for the common library chart can be found
[here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common). [here](https://github.com/bjw-s-labs/helm-charts/tree/main/charts/library/common).

View file

@ -1,5 +1,5 @@
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.2.0/charts/other/app-template/schemas/helmrelease-helm-v2beta2.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/app-template-3.2.0/charts/other/app-template/schemas/helmrelease-helm-v2beta2.schema.json
apiVersion: helm.toolkit.fluxcd.io/v2beta1 apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease kind: HelmRelease
metadata: metadata:

View file

@ -6,5 +6,5 @@ metadata:
namespace: flux-system namespace: flux-system
spec: spec:
interval: 30m interval: 30m
url: https://bjw-s.github.io/helm-charts/ url: https://bjw-s-labs.github.io/helm-charts/
timeout: 3m timeout: 3m

View file

@ -5,7 +5,7 @@
Makre sure the Helm repository is installed as follows: Makre sure the Helm repository is installed as follows:
```console ```console
helm repo add bjw-s https://bjw-s.github.io/helm-charts helm repo add bjw-s https://bjw-s-labs.github.io/helm-charts
helm repo update helm repo update
``` ```

View file

@ -1,5 +1,5 @@
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json
# Configure options applied to all pods # Configure options applied to all pods
defaultPodOptions: defaultPodOptions:

View file

@ -1,5 +1,5 @@
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json
# Configure options applied to all pods # Configure options applied to all pods
defaultPodOptions: defaultPodOptions:

View file

@ -1,5 +1,5 @@
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json
controllers: controllers:
main: main:

View file

@ -3,7 +3,7 @@ apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization kind: Kustomization
helmCharts: helmCharts:
- name: app-template - name: app-template
repo: https://bjw-s.github.io/helm-charts/ repo: https://bjw-s-labs.github.io/helm-charts/
# this example is not automatically updated, so be sure to use the latest chart version # this example is not automatically updated, so be sure to use the latest chart version
version: 3.2.0 version: 3.2.0
releaseName: &releaseName vaultwarden releaseName: &releaseName vaultwarden

View file

@ -1,5 +1,5 @@
--- ---
# yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/bjw-s-labs/helm-charts/app-template-3.2.0/charts/other/app-template/values.schema.json
controllers: controllers:
main: main: