Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5669daf771 | |||
| 2aecdb373d | |||
| e9b699a881 | |||
| 84e1bf7e51 | |||
| fe234fdf8f | |||
| 0199d06001 | |||
| 2866c3983b | |||
| bb6706d1a0 | |||
| dc62bc4e6a | |||
| d7d914ca4a | |||
| 5982457d82 | |||
| 2d3fc7613a | |||
| 269cf7adf4 | |||
| af7cbdf12b | |||
| 86b398278f | |||
| f9ac1e8589 | |||
| 7993842765 |
@@ -1,19 +0,0 @@
|
|||||||
name: Extract chart name from repo name
|
|
||||||
description: Extracts the chart name from the repo name, based on the convention of helm-<chart-name>
|
|
||||||
inputs:
|
|
||||||
repo:
|
|
||||||
description: The full repository name (e.g., "helm-my-chart")
|
|
||||||
required: true
|
|
||||||
outputs:
|
|
||||||
chart-name:
|
|
||||||
description: The extracted chart name
|
|
||||||
value: ${{ steps.extract.outputs.suffix }}
|
|
||||||
runs:
|
|
||||||
using: "composite"
|
|
||||||
steps:
|
|
||||||
- id: extract
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
full_repo="${{ inputs.repo }}"
|
|
||||||
suffix="${full_repo##*helm-}"
|
|
||||||
echo "suffix=$suffix" >> $GITHUB_OUTPUT
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
name: "Extract namespace from repo name"
|
|
||||||
description: "Extracts the namespace name from the repo name, based on the convention of k_<namespace-name>"
|
|
||||||
inputs:
|
|
||||||
repo:
|
|
||||||
description: 'The repo name, get it from "github.repository"'
|
|
||||||
required: true
|
|
||||||
outputs:
|
|
||||||
namespace:
|
|
||||||
description: "The namespace name"
|
|
||||||
value: ${{ steps.extract.outputs.suffix }}
|
|
||||||
runs:
|
|
||||||
using: "composite"
|
|
||||||
steps:
|
|
||||||
- id: extract
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
full_repo="${{ inputs.repo }}"
|
|
||||||
suffix="${full_repo##*k_}"
|
|
||||||
echo "suffix=$suffix" >> $GITHUB_OUTPUT
|
|
||||||
@@ -3,35 +3,30 @@ name: Deploy
|
|||||||
on:
|
on:
|
||||||
workflow_call:
|
workflow_call:
|
||||||
inputs:
|
inputs:
|
||||||
# Optional: Override the default k8s directory path
|
|
||||||
k8s_dir:
|
k8s_dir:
|
||||||
description: "Path to Kubernetes manifests directory"
|
description: "Override the default k8s directory path (k8s/)"
|
||||||
required: false
|
required: false
|
||||||
default: "k8s/"
|
default: "k8s/"
|
||||||
type: string
|
type: string
|
||||||
# Optional: Override the default helmfile path
|
|
||||||
helmfile_path:
|
helmfile_path:
|
||||||
description: "Path to helmfile.yaml"
|
description: "Override the default helmfile path (hemfile.yaml)"
|
||||||
required: false
|
required: false
|
||||||
default: "helmfile.yaml"
|
default: "helmfile.yaml"
|
||||||
type: string
|
type: string
|
||||||
# Optional: Skip Helm deployment even if helmfile exists
|
|
||||||
skip_helm_deployment:
|
skip_helm_deployment:
|
||||||
description: "Skip Helm deployment even if helmfile.yaml exists"
|
description: "Skip Helm deployment even if helmfile.yaml exists"
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
# Optional: Custom secrets to create (JSON array of secret objects)
|
skip_shared_secrets_deployment:
|
||||||
custom_secrets:
|
description: "Skip shared secrets deployment (e.g. restic backup secret)"
|
||||||
description: "JSON array of secrets to create. Each secret should have: name, type, data"
|
|
||||||
required: false
|
required: false
|
||||||
default: "[]"
|
default: false
|
||||||
type: string
|
type: boolean
|
||||||
# Optional: Branch to deploy from
|
helmfile_env:
|
||||||
deploy_branch:
|
description: "Optional JSON object string of environment variables for Helmfile"
|
||||||
description: "Branch to deploy from"
|
|
||||||
required: false
|
required: false
|
||||||
default: "main"
|
default: "{}"
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -63,48 +58,52 @@ jobs:
|
|||||||
echo "No k8s directory found at ${{ inputs.k8s_dir }}"
|
echo "No k8s directory found at ${{ inputs.k8s_dir }}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
deploy-shared-secrets:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: detect-service-type
|
||||||
|
if: inputs.skip_shared_secrets_deployment != 'true'
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
|
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@244a64884838c35a5fc0dc42e0b82bb70b253dfc # 0.0.1
|
||||||
|
id: namespace
|
||||||
|
with:
|
||||||
|
repo: ${{ github.repository }}
|
||||||
|
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||||
|
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||||
|
with:
|
||||||
|
method: kubeconfig
|
||||||
|
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||||
|
- name: Set restic backup secret
|
||||||
|
uses: azure/k8s-create-secret@5e49ad902ac755e0815974a44904c728da961747 # v6.0.0
|
||||||
|
with:
|
||||||
|
namespace: ${{ steps.namespace.outputs.namespace }}
|
||||||
|
secret-name: backupsidecar-secret
|
||||||
|
secret-type: generic
|
||||||
|
data: |
|
||||||
|
{
|
||||||
|
"restic_password": "${{ secrets.RESTIC_PASSWORD }}",
|
||||||
|
"restic_rest_username": "${{ secrets.RESTIC_REST_USERNAME }}",
|
||||||
|
"restic_rest_password": "${{ secrets.RESTIC_REST_PASSWORD }}",
|
||||||
|
"gotify_token": "${{ secrets.GOTIFY_TOKEN }}"
|
||||||
|
}
|
||||||
|
|
||||||
deploy-k8s:
|
deploy-k8s:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: detect-service-type
|
needs: detect-service-type
|
||||||
if: needs.detect-service-type.outputs.has_k8s == 'true'
|
if: needs.detect-service-type.outputs.has_k8s == 'true'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
with:
|
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@244a64884838c35a5fc0dc42e0b82bb70b253dfc # 0.0.1
|
||||||
ref: ${{ inputs.deploy_branch }}
|
|
||||||
- uses: ./.gitea/actions/extract-namespace-from-repo-name
|
|
||||||
id: namespace
|
id: namespace
|
||||||
with:
|
with:
|
||||||
repo: ${{ github.repository }}
|
repo: ${{ github.repository }}
|
||||||
- uses: azure/setup-kubectl@15650b3ad78fff148532a140b8a4c821796b2d7b # v5.0.0
|
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||||
- uses: azure/k8s-set-context@ae59a723ba9abe7a9655538854a025448dbab4aa # v4.0.2
|
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||||
with:
|
with:
|
||||||
method: kubeconfig
|
method: kubeconfig
|
||||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||||
- name: Create custom secrets
|
|
||||||
id: create-secrets
|
|
||||||
run: |
|
|
||||||
# Parse custom secrets from input
|
|
||||||
SECRETS='${{ inputs.custom_secrets }}'
|
|
||||||
if [ "$SECRETS" != "[]" ]; then
|
|
||||||
echo "Creating custom secrets..."
|
|
||||||
echo "$SECRETS" | jq -c '.[]' | while read -r secret; do
|
|
||||||
SECRET_NAME=$(echo "$secret" | jq -r '.name')
|
|
||||||
SECRET_TYPE=$(echo "$secret" | jq -r '.type // "generic"')
|
|
||||||
SECRET_DATA=$(echo "$secret" | jq -r '.data')
|
|
||||||
|
|
||||||
echo "Creating secret: $SECRET_NAME (type: $SECRET_TYPE)"
|
|
||||||
|
|
||||||
# Create the secret using kubectl
|
|
||||||
echo "$SECRET_DATA" | kubectl create secret $SECRET_TYPE $SECRET_NAME \
|
|
||||||
--from-literal=secret.json="$SECRET_DATA" \
|
|
||||||
--namespace=${{ steps.namespace.outputs.namespace }} \
|
|
||||||
--dry-run=client -o yaml | kubectl apply -f -
|
|
||||||
done
|
|
||||||
else
|
|
||||||
echo "No custom secrets to create"
|
|
||||||
fi
|
|
||||||
- name: Deploy Kubernetes manifests
|
- name: Deploy Kubernetes manifests
|
||||||
uses: azure/k8s-deploy@c8cfec839dc09896b3b8cc40cd13d04792680771 # v5.1.0
|
uses: azure/k8s-deploy@c7ebd0d5f39477a23f1b5dea0f52e6db04adf28e # v6.0.0
|
||||||
with:
|
with:
|
||||||
action: deploy
|
action: deploy
|
||||||
manifests: "${{ inputs.k8s_dir }}"
|
manifests: "${{ inputs.k8s_dir }}"
|
||||||
@@ -120,50 +119,26 @@ jobs:
|
|||||||
inputs.skip_helm_deployment != 'true'
|
inputs.skip_helm_deployment != 'true'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
with:
|
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@244a64884838c35a5fc0dc42e0b82bb70b253dfc # 0.0.1
|
||||||
ref: ${{ inputs.deploy_branch }}
|
|
||||||
- uses: ./.gitea/actions/extract-namespace-from-repo-name
|
|
||||||
id: namespace
|
id: namespace
|
||||||
with:
|
with:
|
||||||
repo: ${{ github.repository }}
|
repo: ${{ github.repository }}
|
||||||
- uses: azure/setup-kubectl@15650b3ad78fff148532a140b8a4c821796b2d7b # v5.0.0
|
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||||
- uses: azure/setup-helm@dda3372f752e03dde6b3237bc9431cdc2f7a02a2 # v5
|
- uses: azure/setup-helm@dda3372f752e03dde6b3237bc9431cdc2f7a02a2 # v5
|
||||||
- uses: azure/k8s-set-context@ae59a723ba9abe7a9655538854a025448dbab4aa # v4.0.2
|
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||||
with:
|
with:
|
||||||
method: kubeconfig
|
method: kubeconfig
|
||||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||||
- name: Create custom secrets
|
|
||||||
id: create-secrets
|
|
||||||
run: |
|
|
||||||
# Parse custom secrets from input
|
|
||||||
SECRETS='${{ inputs.custom_secrets }}'
|
|
||||||
if [ "$SECRETS" != "[]" ]; then
|
|
||||||
echo "Creating custom secrets..."
|
|
||||||
echo "$SECRETS" | jq -c '.[]' | while read -r secret; do
|
|
||||||
SECRET_NAME=$(echo "$secret" | jq -r '.name')
|
|
||||||
SECRET_TYPE=$(echo "$secret" | jq -r '.type // "generic"')
|
|
||||||
SECRET_DATA=$(echo "$secret" | jq -r '.data')
|
|
||||||
|
|
||||||
echo "Creating secret: $SECRET_NAME (type: $SECRET_TYPE)"
|
|
||||||
|
|
||||||
# Create the secret using kubectl
|
|
||||||
echo "$SECRET_DATA" | kubectl create secret $SECRET_TYPE $SECRET_NAME \
|
|
||||||
--from-literal=secret.json="$SECRET_DATA" \
|
|
||||||
--namespace=${{ steps.namespace.outputs.namespace }} \
|
|
||||||
--dry-run=client -o yaml | kubectl apply -f -
|
|
||||||
done
|
|
||||||
else
|
|
||||||
echo "No custom secrets to create"
|
|
||||||
fi
|
|
||||||
- name: Deploy Helm
|
- name: Deploy Helm
|
||||||
uses: helmfile/helmfile-action@d9fefe29b0d07e9ab187ecfe1d63eff91e0a070c # v2.4.1
|
uses: helmfile/helmfile-action@02671705b1dda1dc4b0a4ddd4f9f1ea8f4568c6f # v2.4.3
|
||||||
with:
|
with:
|
||||||
helmfile-args: apply
|
helmfile-args: apply
|
||||||
|
env: ${{ fromJSON(inputs.helmfile_env) }}
|
||||||
|
|
||||||
# Summary job that always runs to show what was deployed
|
# Summary job that always runs to show what was deployed
|
||||||
deployment-summary:
|
deployment-summary:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [ detect-service-type, deploy-k8s, deploy-helm ]
|
needs: [detect-service-type, deploy-k8s, deploy-helm]
|
||||||
if: always()
|
if: always()
|
||||||
steps:
|
steps:
|
||||||
- name: Deployment Summary
|
- name: Deployment Summary
|
||||||
@@ -187,11 +162,3 @@ jobs:
|
|||||||
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
echo "" >> $GITHUB_STEP_SUMMARY
|
||||||
echo "**Service Type**: ${{ needs.detect-service-type.outputs.has_helmfile == 'true' && 'Helm + Kubernetes' || 'Kubernetes Only' }}" >> $GITHUB_STEP_SUMMARY
|
echo "**Service Type**: ${{ needs.detect-service-type.outputs.has_helmfile == 'true' && 'Helm + Kubernetes' || 'Kubernetes Only' }}" >> $GITHUB_STEP_SUMMARY
|
||||||
|
|
||||||
# Show custom secrets info
|
|
||||||
SECRETS='${{ inputs.custom_secrets }}'
|
|
||||||
if [ "$SECRETS" != "[]" ]; then
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "**Custom Secrets Created**: $(echo "$SECRETS" | jq length)" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "$SECRETS" | jq -r '.[] | "- " + .name + " (" + (.type // "generic") + ")"' >> $GITHUB_STEP_SUMMARY
|
|
||||||
fi
|
|
||||||
@@ -5,8 +5,9 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- ".gitea/workflows/cd.yaml"
|
- ".gitea/workflows/deploy.yaml"
|
||||||
- ".gitea/workflows/ci.yaml"
|
- ".gitea/workflows/validate.yaml"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
@@ -18,10 +19,10 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Increment tag
|
- name: Increment tag
|
||||||
id: tag
|
id: tag
|
||||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@11c694022eefab5876ac346fc9ffc0464b2548c7 # 0.1.30
|
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@ef0c23189db33220a73022d8c29a27709d0df440 # 0.1.32
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITEA_TOKEN }}
|
token: ${{ secrets.GITEA_TOKEN }}
|
||||||
- name: Push tag
|
- name: Push tag
|
||||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@f386e2570df6a796ba0a69865c89ea0c1a7109ab # 0.2.2
|
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@38c1bbd8bad3e7965744d03de85faa4a5b808d1b # 0.2.4
|
||||||
with:
|
with:
|
||||||
tag: ${{ steps.tag.outputs.new-tag }}
|
tag: ${{ steps.tag.outputs.new-tag }}
|
||||||
|
|||||||
@@ -18,6 +18,11 @@ on:
|
|||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
|
helmfile_env:
|
||||||
|
description: "Optional JSON object string of environment variables for Helmfile"
|
||||||
|
required: false
|
||||||
|
default: "{}"
|
||||||
|
type: string
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
detect-service-type:
|
detect-service-type:
|
||||||
@@ -54,17 +59,17 @@ jobs:
|
|||||||
if: needs.detect-service-type.outputs.has_k8s == 'true'
|
if: needs.detect-service-type.outputs.has_k8s == 'true'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- uses: ./.gitea/actions/extract-namespace-from-repo-name
|
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@244a64884838c35a5fc0dc42e0b82bb70b253dfc # 0.0.1
|
||||||
id: namespace
|
id: namespace
|
||||||
with:
|
with:
|
||||||
repo: ${{ github.repository }}
|
repo: ${{ github.repository }}
|
||||||
- uses: azure/setup-kubectl@15650b3ad78fff148532a140b8a4c821796b2d7b # v5.0.0
|
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||||
- uses: azure/k8s-set-context@ae59a723ba9abe7a9655538854a025448dbab4aa # v4.0.2
|
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||||
with:
|
with:
|
||||||
method: kubeconfig
|
method: kubeconfig
|
||||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||||
- name: Validate k8s manifests
|
- name: Validate k8s manifests
|
||||||
uses: azure/k8s-lint@6aefe5066f95e73d2b140d8835cc95583b886989 # v3.0.1
|
uses: azure/k8s-lint@e4234c50ea835112e72b145bdecd00a94bad42fd # v4.0.0
|
||||||
with:
|
with:
|
||||||
namespace: ${{ steps.namespace.outputs.namespace }}
|
namespace: ${{ steps.namespace.outputs.namespace }}
|
||||||
lintType: dryrun
|
lintType: dryrun
|
||||||
@@ -79,25 +84,26 @@ jobs:
|
|||||||
inputs.skip_helm_validation != 'true'
|
inputs.skip_helm_validation != 'true'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- uses: ./.gitea/actions/extract-namespace-from-repo-name
|
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@244a64884838c35a5fc0dc42e0b82bb70b253dfc # 0.0.1
|
||||||
id: namespace
|
id: namespace
|
||||||
with:
|
with:
|
||||||
repo: ${{ github.repository }}
|
repo: ${{ github.repository }}
|
||||||
- uses: azure/setup-kubectl@15650b3ad78fff148532a140b8a4c821796b2d7b # v5.0.0
|
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||||
- uses: azure/setup-helm@dda3372f752e03dde6b3237bc9431cdc2f7a02a2 # v5
|
- uses: azure/setup-helm@dda3372f752e03dde6b3237bc9431cdc2f7a02a2 # v5
|
||||||
- uses: azure/k8s-set-context@ae59a723ba9abe7a9655538854a025448dbab4aa # v4.0.2
|
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||||
with:
|
with:
|
||||||
method: kubeconfig
|
method: kubeconfig
|
||||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||||
- name: Validate Helm
|
- name: Validate Helm
|
||||||
uses: helmfile/helmfile-action@d9fefe29b0d07e9ab187ecfe1d63eff91e0a070c # v2.4.1
|
uses: helmfile/helmfile-action@02671705b1dda1dc4b0a4ddd4f9f1ea8f4568c6f # v2.4.3
|
||||||
with:
|
with:
|
||||||
helmfile-args: diff
|
helmfile-args: diff
|
||||||
|
env: ${{ fromJSON(inputs.helmfile_env) }}
|
||||||
|
|
||||||
# Summary job that always runs to show what was validated
|
# Summary job that always runs to show what was validated
|
||||||
ci-summary:
|
ci-summary:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [ detect-service-type, validate-k8s, validate-helm ]
|
needs: [detect-service-type, validate-k8s, validate-helm]
|
||||||
if: always()
|
if: always()
|
||||||
steps:
|
steps:
|
||||||
- name: CI Summary
|
- name: CI Summary
|
||||||
@@ -1,79 +1,75 @@
|
|||||||
> [!WARNING]
|
# Reusable CI/CD Workflows for k\_ Services
|
||||||
> Repo is currently not in use and not tested.
|
|
||||||
> We are waiting for proper shared workflow UI support in gitea. Otherwise errors are hard to identify.
|
|
||||||
> Follow https://github.com/go-gitea/gitea/issues/24604
|
|
||||||
|
|
||||||
# Reusable CI Workflow for Kubernetes Services
|
This repository contains reusable CI and CD workflows that automatically detect Kubernetes service type (Kubernetes-only vs Helm + Kubernetes) and execute the relevant steps.
|
||||||
|
|
||||||
This directory contains a reusable CI workflow that automatically detects and validates your Kubernetes services, whether they use Helm + Kubernetes or just Kubernetes manifests.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Automatic Detection**: Automatically detects if your service uses Helm (helmfile.yaml) or just Kubernetes manifests
|
- **Reusable CI and CD**: Separate reusable workflows for validation and deployment
|
||||||
- **Conditional Validation**: Only runs Helm validation when helmfile.yaml exists
|
- **Automatic Detection**: Detects whether `helmfile.yaml` exists and whether `k8s/` exists
|
||||||
- **Flexible Paths**: Configurable paths for k8s directory and helmfile
|
- **Conditional Execution**: Runs Helm steps only when applicable
|
||||||
- **Comprehensive Validation**: Validates both Kubernetes manifests and Helm charts
|
- **Flexible Inputs**: Supports custom `k8s_dir` and `helmfile_path`
|
||||||
- **CI Summary**: Provides a clear summary of what was validated
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Basic Usage (Recommended)
|
### Basic CI Usage
|
||||||
|
|
||||||
Simply call the workflow without any parameters - it will automatically detect your service type:
|
Call the reusable CI workflow:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
ci:
|
ci:
|
||||||
uses: ./.gitea/workflows/ci.yaml
|
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/ci.yaml@main
|
||||||
|
secrets: inherit
|
||||||
```
|
```
|
||||||
|
|
||||||
### Advanced Usage with Custom Paths
|
### Basic CD Usage
|
||||||
|
|
||||||
If your service uses non-standard directory names:
|
Call the reusable CD workflow:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/cd.yaml@main
|
||||||
|
secrets: inherit
|
||||||
|
```
|
||||||
|
|
||||||
|
### Advanced Usage with Custom Paths and Flags
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
ci:
|
ci:
|
||||||
uses: ./.gitea/workflows/ci.yaml
|
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/ci.yaml@main
|
||||||
with:
|
with:
|
||||||
k8s_dir: "kubernetes/"
|
k8s_dir: "kubernetes/"
|
||||||
helmfile_path: "helm/helmfile.yaml"
|
helmfile_path: "helm/helmfile.yaml"
|
||||||
```
|
|
||||||
|
|
||||||
### Force Skip Helm Validation
|
|
||||||
|
|
||||||
If you want to skip Helm validation even when helmfile.yaml exists:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
jobs:
|
|
||||||
ci:
|
|
||||||
uses: ./.gitea/workflows/ci.yaml
|
|
||||||
with:
|
|
||||||
skip_helm_validation: true
|
skip_helm_validation: true
|
||||||
|
secrets: inherit
|
||||||
```
|
```
|
||||||
|
|
||||||
## Input Parameters
|
## Inputs
|
||||||
|
|
||||||
|
### CI (`.gitea/workflows/ci.yaml`)
|
||||||
|
|
||||||
| Parameter | Description | Default | Required |
|
| Parameter | Description | Default | Required |
|
||||||
| ---------------------- | -------------------------------------------- | --------------- | -------- |
|
| ---------------------- | -------------------------------------------- | --------------- | -------- |
|
||||||
| `k8s_dir` | Path to Kubernetes manifests directory | `k8s/` | No |
|
| `k8s_dir` | Path to Kubernetes manifests directory | `k8s/` | No |
|
||||||
| `helmfile_path` | Path to helmfile.yaml | `helmfile.yaml` | No |
|
| `helmfile_path` | Path to helmfile.yaml | `helmfile.yaml` | No |
|
||||||
| `skip_helm_validation` | Skip Helm validation even if helmfile exists | `false` | No |
|
| `skip_helm_validation` | Skip Helm validation even if helmfile exists | `false` | No |
|
||||||
|
| `helmfile_env` | JSON object string passed as env to helmfile | `{}` | No |
|
||||||
|
|
||||||
|
### CD (`.gitea/workflows/cd.yaml`)
|
||||||
|
|
||||||
|
| Parameter | Description | Default | Required |
|
||||||
|
| -------------------------------- | -------------------------------------------- | --------------- | -------- |
|
||||||
|
| `k8s_dir` | Path to Kubernetes manifests directory | `k8s/` | No |
|
||||||
|
| `helmfile_path` | Path to helmfile.yaml | `helmfile.yaml` | No |
|
||||||
|
| `skip_helm_deployment` | Skip Helm deployment even if helmfile exists | `false` | No |
|
||||||
|
| `skip_shared_secrets_deployment` | Skip shared secrets deployment | `false` | No |
|
||||||
|
| `helmfile_env` | JSON object string passed as env to helmfile | `{}` | No |
|
||||||
|
|
||||||
## Directory Structure Requirements
|
## Directory Structure Requirements
|
||||||
|
|
||||||
### For Kubernetes-only services:
|
### Full example structure (Helm + Kubernetes):
|
||||||
|
|
||||||
```
|
|
||||||
your-service/
|
|
||||||
├── k8s/
|
|
||||||
│ ├── deployment.yaml
|
|
||||||
│ ├── service.yaml
|
|
||||||
│ └── ...
|
|
||||||
└── .gitea/workflows/your-workflow.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
### For Helm + Kubernetes services:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
your-service/
|
your-service/
|
||||||
@@ -84,79 +80,3 @@ your-service/
|
|||||||
├── helmfile.yaml
|
├── helmfile.yaml
|
||||||
└── .gitea/workflows/your-workflow.yaml
|
└── .gitea/workflows/your-workflow.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## What Gets Validated
|
|
||||||
|
|
||||||
### Always (if k8s/ directory exists):
|
|
||||||
|
|
||||||
- Kubernetes manifest validation using `kubectl --dry-run`
|
|
||||||
- Namespace extraction from repository name
|
|
||||||
- Basic Kubernetes syntax and schema validation
|
|
||||||
|
|
||||||
### Conditionally (if helmfile.yaml exists and Helm validation not skipped):
|
|
||||||
|
|
||||||
- Helm chart validation using `helmfile diff`
|
|
||||||
- Kubernetes manifests in Helm context
|
|
||||||
- Helm-specific configurations and values
|
|
||||||
|
|
||||||
## Example Workflows
|
|
||||||
|
|
||||||
See `example-usage.yaml` for complete examples of how to use this workflow in different scenarios.
|
|
||||||
|
|
||||||
## Available Actions
|
|
||||||
|
|
||||||
### Extract Chart Name from Repository Name
|
|
||||||
|
|
||||||
The `extract-chart-name-from-repo-name` action extracts the chart name from repository names following the `helm-<chart-name>` convention.
|
|
||||||
|
|
||||||
#### Usage
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Extract chart name
|
|
||||||
uses: ./.gitea/actions/extract-chart-name-from-repo-name
|
|
||||||
with:
|
|
||||||
repo: ${{ github.repository_name }} # e.g., "helm-my-service"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Inputs
|
|
||||||
|
|
||||||
| Parameter | Description | Required |
|
|
||||||
| --------- | ------------------------------------------------ | -------- |
|
|
||||||
| `repo` | The full repository name (e.g., "helm-my-chart") | Yes |
|
|
||||||
|
|
||||||
#### Outputs
|
|
||||||
|
|
||||||
| Output | Description |
|
|
||||||
| ------------ | ---------------------------------------------------------------- |
|
|
||||||
| `chart-name` | The extracted chart name (e.g., "my-chart" from "helm-my-chart") |
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
For a repository named `helm-user-service`, this action will extract `user-service` as the chart name.
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
This workflow requires:
|
|
||||||
|
|
||||||
- `./.gitea/actions/extract-namespace-from-repo-name` action
|
|
||||||
- `./.gitea/actions/extract-chart-name-from-repo-name` action
|
|
||||||
- `KUBECONFIG` secret configured in your repository
|
|
||||||
- Access to your Kubernetes cluster
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Helm validation skipped unexpectedly
|
|
||||||
|
|
||||||
- Check if `helmfile.yaml` exists in the expected location
|
|
||||||
- Verify the `skip_helm_validation` parameter is not set to `true`
|
|
||||||
- Ensure the file path is correct if using custom paths
|
|
||||||
|
|
||||||
### Kubernetes validation skipped
|
|
||||||
|
|
||||||
- Verify the `k8s/` directory (or custom path) exists
|
|
||||||
- Check the directory contains valid Kubernetes manifests
|
|
||||||
|
|
||||||
### Permission issues
|
|
||||||
|
|
||||||
- Ensure the `KUBECONFIG` secret is properly configured
|
|
||||||
- Verify the workflow has access to your Kubernetes cluster
|
|
||||||
|
|||||||
+1
-4
@@ -1,7 +1,4 @@
|
|||||||
{
|
{
|
||||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||||
"extends": [
|
"extends": ["local>t.behrendt/renovate-configs:action"]
|
||||||
"local>t.behrendt/renovate-configs:common",
|
|
||||||
"local>t.behrendt/renovate-configs:action"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user