Skip to content

Commit

Permalink
📝 Helm install docs and changelog
Browse files Browse the repository at this point in the history
Signed-off-by: Muhammed Hussein Karimi <[email protected]>
  • Loading branch information
mhkarimi1383 committed Oct 30, 2024
1 parent 8bc5929 commit 2f049a0
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 2 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/changelog.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
on:
release:
types: [created]

permissions:
contents: write
packages: write

jobs:
changelog-builder:
name: Build Changelog
runs-on: ubuntu-latest
steps:
- name: Build Changelog
uses: mikepenz/release-changelog-builder-action@v5
id: builder
with:
mode: "COMMIT"
configurationJson: |
{
"template": "\n#{{UNCATEGORIZED}}\n"
}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Add Test Report to Release
uses: irongut/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
id: ${{ github.event.release.id }}
replacebody: true
body: |
Downlaod binary according to your needs or use Container image from GitHub packages
## Changelog
${{ steps.builder.outputs.changelog }}
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# HAProxy Redis Sentinel

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/haproxy-redis-sentinel)](https://artifacthub.io/packages/search?repo=haproxy-redis-sentinel)
[![Latest release](https://img.shields.io/github/release/ParminCloud/haproxy-redis-sentinel.svg)](https://github.com/ParminCloud/haproxy-redis-sentinel/releases)


Python pub/sub based Sentinel master change notifier that updates HAProxy using it's [Runtime API](https://www.haproxy.com/documentation/haproxy-runtime-api/)

Just create a simple HAProxy config and it will handle everything for you
Expand Down Expand Up @@ -71,6 +75,19 @@ Set/Change env vars and run it or add this project as a service to your existing

> You need HAProxy in a seperated Container/Server
### K8s

```shell
helm repo add haproxy-redis-sentinel https://parmincloud.github.io/haproxy-redis-sentinel/
helm repo update
```

Create a file names `values.yaml` and customize values (according to [defualt values](./charts/haproxy-redis-sentinel/values.yaml))

```
helm install haproxy-redis-sentinel haproxy-redis-sentinel/haproxy-redis-sentinel --values ./values.yaml
```

## Why?

HAProxy is a great TCP Proxy and LoadBalancer with high performance
Expand Down
6 changes: 6 additions & 0 deletions artifacthub-repo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
repositoryID: 2cf4ef56-48f7-4b22-92f7-9923b5d0d6d1
owners:
- name: ParminCloud
email: [email protected]
- name: Muhammed Hussein Karimi
email: [email protected]
4 changes: 2 additions & 2 deletions charts/haproxy-redis-sentinel/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: haproxy-redis-sentinel
description: A Helm chart for HAProxy with Redis Sentinel
version: 0.0.0
appVersion: "0.0.0"
version: 0.0.1
appVersion: "0.0.1"

3 changes: 3 additions & 0 deletions charts/haproxy-redis-sentinel/values.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
replicaCount: 1

fullnameOverride: ""
nameOverride: ""

haproxy:
image:
repository: docker.io/library/haproxy
Expand Down

0 comments on commit 2f049a0

Please sign in to comment.