Skip to content

Commit 51e7f40

Browse files
Add release workflow for Helm Chart, basic documentation about installing it
1 parent e83e1ca commit 51e7f40

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

.github/workflows/release.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,28 @@ jobs:
136136
platforms: linux/amd64,linux/arm64
137137
tags: ${{ steps.meta.outputs.tags }}
138138
labels: ${{ steps.meta.outputs.labels }}
139+
140+
publish-chart:
141+
name: 🚀 Build and push Helm Chart
142+
permissions:
143+
contents: write
144+
needs: [release]
145+
runs-on: ubuntu-latest
146+
env:
147+
CHART_DIR: install/kubernetes
148+
steps:
149+
- name: Checkout
150+
uses: actions/checkout@v4
151+
with:
152+
ref: master
153+
154+
- name: Configure Git
155+
run: |
156+
git config user.name "$GITHUB_ACTOR"
157+
git config user.email "[email protected]"
158+
159+
- name: Run chart-releaser
160+
uses: helm/[email protected]
161+
env:
162+
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
163+
charts_dir: "${{ env.CHART_DIR }}"

docs/content/1.getting-started/1.index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ The cache server is available as a Docker image and can be deployed via Docker C
77

88
## 1. Deploying the Cache Server
99

10+
### Using Docker Compose
11+
1012
```yaml [docker-compose.yml]
1113
services:
1214
cache-server:
@@ -22,6 +24,55 @@ volumes:
2224
cache-data:
2325
```
2426
27+
### Using Kubernetes with Helm
28+
29+
You can deploy the cache server in Kubernetes using the Helm chart hosted in a OCI repository.
30+
31+
#### Prerequisites
32+
33+
- Helm version 3.8.0 or later (required for OCI support).
34+
- A running Kubernetes cluster.
35+
36+
#### Steps
37+
38+
1. Add the Helm repository (if not already added):
39+
40+
```bash
41+
helm repo add falcondev-oss oci://ghcr.io/falcondev-oss/charts
42+
helm repo update
43+
```
44+
45+
2. Install the Helm chart:
46+
47+
```bash
48+
helm install <release-name> falcondev-oss/github-actions-cache-server
49+
```
50+
51+
Replace `<release-name>` with your desired release name (e.g., `cache-server`). This will deploy the cache server with all default values.
52+
53+
3. Verify the deployment:
54+
55+
```bash
56+
kubectl get deployments
57+
kubectl get svc
58+
```
59+
60+
Ensure the deployment `<release-name>-github-actions-cache-server` is running and the service is accessible.
61+
62+
#### Customizing the Deployment
63+
64+
To customize the deployment, you can override the default values by creating a `values.yaml` file.
65+
66+
For all possible configuration options, refer to the [values.yaml file](https://github.com/falcondev-oss/github-actions-cache-server/blob/master/install/kubernetes/github-actions-cache-server/values.yaml).
67+
68+
For more details on customizing Helm charts, see the [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
69+
70+
Then install the chart with your custom values:
71+
72+
```bash
73+
helm install <release-name> falcondev-oss/github-actions-cache-server -f values.yaml
74+
```
75+
2576
### Environment Variables
2677

2778
#### `API_BASE_URL`

0 commit comments

Comments
 (0)