Merge pull request #16 from axoflow/releaser

Release packages

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

README.md

@@ -12,25 +12,24 @@ This repository contains various [Helm charts](https://helm.sh/docs/topics/chart
 
 ## How to use
 
-[Helm](https://helm.sh) must be installed to use these charts.
-Please refer to the [official documentation](https://helm.sh/docs/intro/install/) to get started.
+[Helm](https://helm.sh) must be installed to use the charts.  Please refer to
+Helm's [documentation](https://helm.sh/docs) to get started.
 
-Currently the charts are only available through this git repositoy.
-You can install charts using the following commands:
+Once Helm has been set up correctly, add the repo as follows:
 
-```bash
-git clone [email protected]:axoflow/axosyslog-charts.git
-cd axosyslog-charts
-helm install --generate-name charts/axosyslog-collector
-```
+    helm repo add axosyslog https://axoflow.github.io/axosyslog-charts
 
-> **Tip**: List all installed releases using `helm list`.
+If you had already added this repo earlier, run `helm repo update` to retrieve
+the latest versions of the packages.  You can then run `helm search repo
+axosyslog` to see the charts.
 
-To uninstall a chart release, run:
+To install the axosyslog-collector chart:
 
-```bash
-helm delete my-release
-```
+    helm install my-axosyslog-collector axosyslog/axosyslog-collector
+
+To uninstall the chart:
+
+    helm delete my-axosyslog-collector
 
 ## Contact and support
 

charts/axosyslog-collector/README.md

@@ -1,6 +1,6 @@
-# Syslog-ng Collector
+# AxoSyslog Collector
 
-Syslog-ng kubernetes log collector.
+AxoSyslog Kubernetes log collector.
 
 ## Prerequisites
 
@@ -9,7 +9,7 @@ Syslog-ng kubernetes log collector.
 
 
 ## Configuration
-The following table lists the configurable parameters of the Syslog-ng Collector chart and their default values:
+The following table lists the configurable parameters of the AxoSyslog Collector chart and their default values:
 
 
 | Parameter | Description | Default |
@@ -20,7 +20,7 @@ The following table lists the configurable parameters of the Syslog-ng Collector
 |  imagePullSecrets  | The names of secrets containing private registry credentials |  []  |
 |  nameOverride  | Override the chart name |  ""  |
 |  fullnameOverride  | Override the full chart name |  ""  |
-|  daemonset.enabled  | Deploy Syslog-ng as a DaemonSet |  true  |
+|  daemonset.enabled  | Deploy AxoSyslog as a DaemonSet |  true  |
 |  daemonset.labels  | Additional labels to apply to the DaemonSet |  {}  |
 |  daemonset.annotations  | Additional annotations to apply to the DaemonSet |  {}  |
 |  daemonset.affinity  | Pod affinity |  {}  |