-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from librenms/develop
Release librenms chart
- Loading branch information
Showing
10 changed files
with
303 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| name: Lint and Test Charts | ||
|
|
||
| on: pull_request | ||
|
|
||
| jobs: | ||
| lint-test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Helm | ||
| uses: azure/[email protected] | ||
| with: | ||
| version: v3.14.4 | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.x' | ||
| check-latest: true | ||
|
|
||
| - name: Set up chart-testing | ||
| uses: helm/[email protected] | ||
|
|
||
| - name: Add repositories | ||
| run: | | ||
| for dir in $(ls -d charts/*/); do | ||
| helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done | ||
| done | ||
| - name: Run chart-testing (list-changed) | ||
| id: list-changed | ||
| run: | | ||
| changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }}) | ||
| if [[ -n "$changed" ]]; then | ||
| echo "changed=true" >> "$GITHUB_OUTPUT" | ||
| fi | ||
| - name: Run chart-testing (lint) | ||
| if: steps.list-changed.outputs.changed == 'true' && github.ref != 'refs/heads/develop' | ||
| run: ct lint --target-branch ${{ github.event.repository.default_branch }} --check-version-increment=false | ||
|
|
||
| - name: Run chart-testing (lint & version) | ||
| if: github.event.pull_request.base.ref == 'main' | ||
| run: ct lint --target-branch main | ||
|
|
||
| - name: Create kind cluster | ||
| if: steps.list-changed.outputs.changed == 'true' || github.event.pull_request.base.ref == 'main' | ||
| uses: helm/[email protected] | ||
|
|
||
| - name: Run chart-testing (install) | ||
| if: steps.list-changed.outputs.changed == 'true' && github.ref != 'refs/heads/develop' | ||
| run: ct install --target-branch ${{ github.event.repository.default_branch }} --skip-clean-up | ||
|
|
||
| - name: Run chart-testing (install & upgrades) | ||
| if: github.event.pull_request.base.ref == 'main' | ||
| run: ct install --target-branch main --upgrade |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ jobs: | |
| git config user.email "[email protected]" | ||
| - name: Install Helm | ||
| uses: azure/setup-helm@v3 | ||
| uses: azure/setup-helm@v4 | ||
|
|
||
| - name: Add repositories | ||
| run: | | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| DOCS_IMAGE_VERSION="v1.14.2" | ||
|
|
||
| LINT_IMAGE_VERSION="v3.8.0" | ||
|
|
||
| # Charts's path relative to the current directory. | ||
| CHARTS := $(wildcard ./charts/*) | ||
|
|
||
| CHARTS_NAMES := $(notdir $(CHARTS)) | ||
|
|
||
| .PHONY: lint | ||
| lint: helm-deps-update $(addprefix lint-, $(CHARTS_NAMES)) | ||
|
|
||
| lint-%: | ||
| @docker run \ | ||
| -it \ | ||
| -e HOME=/home/ct \ | ||
| --mount type=tmpfs,destination=/home/ct \ | ||
| --workdir=/data \ | ||
| --volume $$(pwd):/data \ | ||
| -u $$(id -u) \ | ||
| quay.io/helmpack/chart-testing:$(LINT_IMAGE_VERSION) \ | ||
| ct lint --config ./ct.yaml --charts ./charts/$* | ||
|
|
||
| .PHONY: docs | ||
| docs: $(addprefix docs-, $(CHARTS_NAMES)) | ||
|
|
||
| docs-%: | ||
| @docker run \ | ||
| --rm \ | ||
| --workdir=/helm-docs \ | ||
| --volume "$$(pwd):/helm-docs" \ | ||
| -u $$(id -u) \ | ||
| jnorwood/helm-docs:$(DOCS_IMAGE_VERSION) \ | ||
| helm-docs -c ./charts/$* -t ./README.gotmpl -o ./README.md | ||
|
|
||
| .PHONY: helm-deps-update | ||
| helm-deps-update: $(addprefix helm-deps-update-, $(CHARTS_NAMES)) | ||
|
|
||
| helm-deps-update-%: | ||
| helm dependency update ./charts/$* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # LibreNMS | ||
| {{ template "chart.badgesSection" . }} | ||
|
|
||
| ## TL;DR | ||
|
|
||
| ```shell | ||
| $ helm repo add librenms https://www.librenms.org/helm-charts | ||
| $ helm install my-release librenms/librenms --set appkey=<LibreNMS Application key> | ||
| ``` | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - This chart has only been tested on Kubernetes 1.18+, but should work on 1.14+ | ||
| - Recent versions of Helm 3 are supported | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| To install the chart with the release name `my-release` and default configuration: | ||
|
|
||
| ```shell | ||
| $ helm repo add librenms https://www.librenms.org/helm-charts | ||
| $ helm install my-release librenms/librenms --set appkey=<LibreNMS Application key> | ||
| ``` | ||
|
|
||
| ## Values | ||
| Check the [values.yaml](./values.yaml) file for the available settings for this chart and its | ||
| dependencies. | ||
|
|
||
| ### Required values: | ||
| ``` | ||
| librenms: | ||
| appkey: | ||
| ``` | ||
|
|
||
| This should be filled with a laravel appkey, this can be generated using the laravel artisan command: | ||
| ``` | ||
| php artisan key:generate | ||
| ``` | ||
| The value should look like: | ||
| ``` | ||
| librenms: | ||
| appkey: base64:RTMmh+i10E2RMcDxookMu47BTzJQy87hOU+k/zcuPnA= | ||
| ``` | ||
| ### Recommendations | ||
|
|
||
| * `librenms.poller.replicas`: Depending on the scale of your installation, the amount of poller pods needs to b scaled up. Use the poller page in the LibreNMS interface to check for scaling issues. | ||
|
|
||
| ### Available values | ||
|
|
||
| The following table lists the main configurable parameters of the {{ template "chart.name" . }} chart v{{ template "chart.version" . }} and their default values. Please, refer to [values.yaml](./values.yaml) for the full list of configurable parameters. | ||
|
|
||
| {{ template "chart.valuesSection" . }} | ||
|
|
||
| ## Uninstalling the Chart | ||
|
|
||
| To delete the chart: | ||
|
|
||
| ```shell | ||
| $ helm delete my-release | ||
| ``` | ||
|
|
||
| {{ template "chart.requirementsSection" . }} | ||
|
|
||
| {{ template "chart.maintainersSection" . }} | ||
|
|
||
| {{ template "helm-docs.versionFooter" . }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| librenms: | ||
| appkey: base64:RTMmh+i10E2RMcDxookMu47BTzJQy87hOU+k/zcuPnA= |
Oops, something went wrong.