Merge branch 'main' of github.com:zabbix-community/helm-zabbix

zabbix-community · Jan 12, 2025 · ff09366 · ff09366
2 parents 714eac3 + 95cae83
commit ff09366
Show file tree

Hide file tree

Showing 10 changed files with 284 additions and 312 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,40 +8,40 @@
 
 # Contributing
 
-* Configure authentication on your Github account to use the SSH protocol instead of HTTP. Watch this tutorial to learn how to set up: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
-* Have the ``make`` and ``docker`` commands installed on your system. With this, you don't need the below mentioned ``helm`` and use containers for the needed steps instead. See this [tutorial](charts/zabbix/docs/requirements.md).
-* Create a fork this repository.
-* Clone the forked repository to your local system:
+- Configure authentication on your Github account to use the SSH protocol instead of HTTP. Watch this tutorial to learn how to set up: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
+- Have the ``make`` and ``docker`` commands installed on your system. With this, you don't need the below mentioned ``helm`` and use containers for the needed steps instead. See this [tutorial](charts/zabbix/docs/requirements.md).
+- Create a fork this repository.
+- Clone the forked repository to your local system:
 
 ```bash
 git clone FORKED_REPOSITORY
 ```
 
-* Add the address for the remote original repository:
+- Add the address for the remote original repository:
 
 ```bash
 git remote -v
 git remote add upstream [email protected]:zabbix-community/helm-zabbix.git
 git remote -v
 ```
 
-* Create a branch. Example:
+- Create a branch. Example:
 
 ```bash
 git checkout -b BRANCH_NAME
 ```
 
-* Make sure you are on the correct branch using the following command. The branch in use contains the '*' before the name.
+- Make sure you are on the correct branch using the following command. The branch in use contains the '*' before the name.
 
 ```bash
 git branch
 ```
 
-* Make your changes and tests to the new branch.
-* Keep the ``charts/zabbix/values.yaml`` file updated with working default values in case any variables are referenced in the helm chart template files
-* Verify your changes do not introduce syntactical/semantic errors:
-* Do NOT change ``version`` in ``charts/zabbix/chart.yaml`` nor in ``charts/zabbix/artifacthub-pkg.yml``, as this is now part of the release process issued by the code owners
-* Make any changes you want in ``charts/zabbix/README.md`` in ``charts/zabbix/README.md.gotmpl``, out of which ``charts/zabbix/README.md`` will be generated using ``helm-docs`` during the version release process by the code owners
+- Make your changes and tests to the new branch.
+- Keep the ``charts/zabbix/values.yaml`` file updated with working default values in case any variables are referenced in the helm chart template files
+- Verify your changes do not introduce syntactical/semantic errors:
+- Do NOT change ``version`` in ``charts/zabbix/chart.yaml`` nor in ``charts/zabbix/artifacthub-pkg.yml``, as this is now part of the release process issued by the code owners
+- Make any changes you want in ``charts/zabbix/README.md`` in ``charts/zabbix/README.md.gotmpl``, out of which ``charts/zabbix/README.md`` will be generated using ``helm-docs`` during the version release process by the code owners
 
 Method to check for syntactical/semantic errors using ``make`` and ``docker``:
 
@@ -50,48 +50,48 @@ cd charts/zabbix
 make lint
 ```
 
-* Method using locally installed ``helm`` command:
+- Method using locally installed ``helm`` command:
 
 ```bash
 cd charts/zabbix
 helm lint .
 ```
 
-* Commit the changes to the branch.
-* Push files to repository remote with command:
+- Commit the changes to the branch.
+- Push files to repository remote with command:
 
 ```bash
 git push --set-upstream origin BRANCH_NAME
 ```
 
-* Create Pull Request (PR) to the `main` branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
-* Update the content with the suggestions of the reviewer (if necessary).
-* After your pull request is merged to the `main` branch, update your local clone:
+- Create Pull Request (PR) to the `main` branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
+- Update the content with the suggestions of the reviewer (if necessary).
+- After your pull request is merged to the `main` branch, update your local clone:
 
 ```bash
 git checkout main
 git pull upstream main
 ```
 
-* Clean up after your pull request is merged with command:
+- Clean up after your pull request is merged with command:
 
 ```bash
 git branch -d BRANCH_NAME
 ```
 
-* Then you can update the ``main`` branch in your forked repository.
+- Then you can update the ``main`` branch in your forked repository.
 
 ```bash
 git push origin main
 ```
 
-* And push the deletion of the feature branch to your GitHub repository with command:
+- And push the deletion of the feature branch to your GitHub repository with command:
 
 ```bash
 git push --delete origin BRANCH_NAME
 ```
 
-* To keep your fork in sync with the original repository, use these commands:
+- To keep your fork in sync with the original repository, use these commands:
 
 ```bash
 git pull upstream main
@@ -103,15 +103,15 @@ git push origin main --tags
 
 References:
 
-* https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
+- https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
 
 ## For code mainteners only
 
 To generate a new release of the helm chart, follow these instructions:
 
-* Review and merge the opened PRs
-* Run local tests
-* Create a branch. Example:
+- Review and merge the opened PRs
+- Run local tests
+- Create a branch. Example:
 
 ```bash
 git checkout -b BRANCH_NAME
@@ -123,47 +123,47 @@ Make sure you are on the correct branch using the following command. The branch
 git branch
 ```
 
-* Make your changes and tests to the new branch
-* Verify the syntax errors using the follow commands:
+- Make your changes and tests to the new branch
+- Verify the syntax errors using the follow commands:
 
 ```bash
 cd charts/zabbix
 make lint
 ```
 
-* Analyse the changes of the PRs merged and set a new release using the follow approach:
+- Analyse the changes of the PRs merged and set a new release using the follow approach:
 
 A **major** version" should be the "dot-release". Example: *6.0.2* -> *6.1.0* is be a **major release update**. Users have to check whether they have to modify their values.yaml, and we need to write a short explanation of what has changed in the ``chart/zabbix/README.md.gotmpl``.
 
 A **minor** is the "dot-dot" release. Example: *6.0.2* -> *6.0.3* is **minor upgrade**, no changes in any APIs, interfaces etc. should be necessary.
 
-* Change the ``version`` and ``appVersion`` parameters (helm chart and Zabbix version, respectively) in ``charts/zabbix/Chart.yaml`` and ``charts/zabbix/artifacthub-pkg.yml`` files.
-* Change the ``createdAt`` parameter in ``charts/zabbix/artifacthub-pkg.yml`` file using the output of the command ``date +%Y-%m-%dT%TZ`` command.
-* Change the ``ZABBIX_CHART_VERSION`` variable in ``charts/zabbix/artifacthub-pkg.yml`` file.
-* Run the following commands to update the documentation of the helm chart.
+- Change the ``version`` and ``appVersion`` parameters (helm chart and Zabbix version, respectively) in ``charts/zabbix/Chart.yaml`` and ``charts/zabbix/artifacthub-pkg.yml`` files.
+- Change the ``createdAt`` parameter in ``charts/zabbix/artifacthub-pkg.yml`` file using the output of the command ``date +%Y-%m-%dT%TZ`` command.
+- Change the ``ZABBIX_CHART_VERSION`` variable in ``charts/zabbix/artifacthub-pkg.yml`` file.
+- Run the following commands to update the documentation of the helm chart.
 
 ```bash
 cd charts/zabbix
 make gen-docs
 ```
 
-* Commit the changes to the branch.
-* Push files to repository remote with command:
+- Commit the changes to the branch.
+- Push files to repository remote with command:
 
 ```bash
 git push --set-upstream origin BRANCH_NAME
 ```
 
-* Create Pull Request (PR) to the main branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
-* Update the content with the suggestions of the reviewer (if necessary).
-* After your pull request is merged to the main branch, update your local clone:
+- Create Pull Request (PR) to the main branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
+- Update the content with the suggestions of the reviewer (if necessary).
+- After your pull request is merged to the main branch, update your local clone:
 
 ```bash
 git checkout main
 git pull upstream main
 ```
 
-* Clean up after your pull request is merged with command:
+- Clean up after your pull request is merged with command:
 
 ```bash
 git branch -d BRANCH_NAME
@@ -181,15 +181,15 @@ And push the deletion of the feature branch to your GitHub repository with comma
 git push --delete origin BRANCH_NAME
 ```
 
-* Create a new tag to generate a new release of the helm chart using the following commands:
+- Create a new tag to generate a new release of the helm chart using the following commands:
 
 ```bash
-git tag -a 6.1.0 -m "New release" #example
+git tag -a 7.0.1 -m "New release" #example
 git push upstream --tags
 ```
 
-* The before commands will start the pipeline and will generate a new release and tag in standad ``zabbix-6.0.0``.
-* To keep your fork in sync with the original repository, use these commands:
+- The before commands will start the pipeline and will generate a new release and tag in standad ``zabbix-7.0.1``.
+- To keep your fork in sync with the original repository, use these commands:
 
 ```bash
 git pull upstream main
@@ -199,11 +199,11 @@ git push origin main
 git push origin main --tags
 ```
 
-* After this, edit and adjust the text generated automatically for new release and adjust the release notes follow the examples the other releases published in https://github.com/zabbix-community/helm-zabbix/releases
+- After this, edit and adjust the text generated automatically for new release and adjust the release notes follow the examples the other releases published in https://github.com/zabbix-community/helm-zabbix/releases
 
 References:
 
-* https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
+- https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
 
 # About Visual Code (VSCode)
 
@@ -213,18 +213,18 @@ VSCode (https://code.visualstudio.com), combined with the following plugins, hel
 
 Plugins to Visual Code:
 
-* docker: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker (require docker-ce package)
-* gitlens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens (require git package)
-* gotemplate-syntax: https://marketplace.visualstudio.com/items?itemName=casualjim.gotemplate
-* Markdown-all-in-one: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
-* Markdown-lint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
-* Markdown-toc: https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc
-* shellcheck: https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck (require shellcheck package)
-* YAML: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
-* Helm Intellisense: https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense
+- docker: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker (require docker-ce package)
+- gitlens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens (require git package)
+- gotemplate-syntax: https://marketplace.visualstudio.com/items?itemName=casualjim.gotemplate
+- Markdown-all-in-one: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
+- Markdown-lint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
+- Markdown-toc: https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc
+- shellcheck: https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck (require shellcheck package)
+- YAML: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
+- Helm Intellisense: https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense
 
 Theme for VSCode:
 
-* https://code.visualstudio.com/docs/getstarted/themes
-* https://dev.to/thegeoffstevens/50-vs-code-themes-for-2020-45cc
-* https://vscodethemes.com/
+- https://code.visualstudio.com/docs/getstarted/themes
+- https://dev.to/thegeoffstevens/50-vs-code-themes-for-2020-45cc
+- https://vscodethemes.com/
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ The structure of files and directories had to be changed to make the automatic p
 
 References:
 
-* <https://blog.bradmccoy.io/linking-helm-charts-in-github-pages-to-artifacthub-46e02e19abfe>
-* <https://github.com/helm/chart-releaser-action>
-* <https://helm.sh/docs/howto/chart_releaser_action/>
-* <https://github.com/helm/chart-releaser-action/issues/36>
+- <https://blog.bradmccoy.io/linking-helm-charts-in-github-pages-to-artifacthub-46e02e19abfe>
+- <https://github.com/helm/chart-releaser-action>
+- <https://helm.sh/docs/howto/chart_releaser_action/>
+- <https://github.com/helm/chart-releaser-action/issues/36>
diff --git a/charts/zabbix/Chart.yaml b/charts/zabbix/Chart.yaml
@@ -1,7 +1,7 @@
 ---
 apiVersion: v2  # Don't change this
 name: zabbix
-version: 7.0.0  # helm chart version
+version: 7.0.1  # helm chart version
 # LTS Zabbix version by default due to stability. See: https://www.zabbix.com/life_cycle_and_release_policy
 appVersion: 7.0.8  # zabbix version
 description: Zabbix is a mature and effortless enterprise-class open source monitoring solution for network monitoring and application monitoring of millions of metrics.