diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a9e12e7..1771d8b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,8 @@ Thank you for contributing to this repository. Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices: -* https://github.com/zabbix-community/helm-zabbix/blob/master/CONTRIBUTING.md -* https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/requirements.md +* https://github.com/zabbix-community/helm-zabbix/blob/main/CONTRIBUTING.md +* https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/requirements.md Following our best practices right from the start will accelerate the review process and help get your PR merged quicker. @@ -25,5 +25,5 @@ For fast feedback, please @-mention maintainers that are listed in the Chart.yam #### Checklist [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] -- [ ] [DCO](https://github.com/zabbix-community/helm-zabbix/blob/master/CONTRIBUTING.md) signed +- [ ] [DCO](https://github.com/zabbix-community/helm-zabbix/blob/main/CONTRIBUTING.md) signed - [ ] Variables are documented in values.yaml with [Helm-Docs](https://github.com/norwoodj/helm-docs) comments, as we build README.md using this utility diff --git a/.github/workflows/helm-chart-releaser.yml b/.github/workflows/helm-chart-releaser.yml index e5a256c..821a3e8 100644 --- a/.github/workflows/helm-chart-releaser.yml +++ b/.github/workflows/helm-chart-releaser.yml @@ -10,7 +10,7 @@ on: push: # Sequence of patterns matched against refs/heads #branches: - # - master + # - main # Sequence of patterns matched against refs/tags tags: - '*' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcaf02f..d54d5c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,13 +65,13 @@ helm lint . git push --set-upstream origin BRANCH_NAME ``` -* Create Pull Request (PR) to the `master` branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) +* 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 `master` branch, update your local clone: +* After your pull request is merged to the `main` branch, update your local clone: ```bash -git checkout master -git pull upstream master +git checkout main +git pull upstream main ``` * Clean up after your pull request is merged with command: @@ -80,10 +80,10 @@ git pull upstream master git branch -d BRANCH_NAME ``` -* Then you can update the ``master`` branch in your forked repository. +* Then you can update the ``main`` branch in your forked repository. ```bash -git push origin master +git push origin main ``` * And push the deletion of the feature branch to your GitHub repository with command: @@ -95,11 +95,11 @@ git push --delete origin BRANCH_NAME * To keep your fork in sync with the original repository, use these commands: ```bash -git pull upstream master -git pull upstream master --tags +git pull upstream main +git pull upstream main --tags -git push origin master -git push origin master --tags +git push origin main +git push origin main --tags ``` References: @@ -155,13 +155,13 @@ make gen-docs git push --set-upstream origin BRANCH_NAME ``` -* Create Pull Request (PR) to the master branch. See this [tutorial](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) +* 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 master branch, update your local clone: +* After your pull request is merged to the main branch, update your local clone: ```bash -git checkout master -git pull upstream master +git checkout main +git pull upstream main ``` * Clean up after your pull request is merged with command: @@ -170,10 +170,10 @@ git pull upstream master git branch -d BRANCH_NAME ``` -Then you can update the master branch in your forked repository. +Then you can update the main branch in your forked repository. ```bash -git push origin master +git push origin main ``` And push the deletion of the feature branch to your GitHub repository with command: @@ -193,11 +193,11 @@ git push upstream --tags * To keep your fork in sync with the original repository, use these commands: ```bash -git pull upstream master -git pull upstream master --tags +git pull upstream main +git pull upstream main --tags -git push origin master -git push origin master --tags +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 diff --git a/README.md b/README.md index 037838b..4726970 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Helm Zabbix -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Release Charts](https://github.com/zabbix-community/helm-zabbix/workflows/Release%20Charts/badge.svg?branch=master) [![Releases downloads](https://img.shields.io/github/downloads/zabbix-community/helm-zabbix/total.svg)](https://github.com/zabbix-community/helm-zabbix/releases) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Release Charts](https://github.com/zabbix-community/helm-zabbix/workflows/Release%20Charts/badge.svg?branch=main) [![Releases downloads](https://img.shields.io/github/downloads/zabbix-community/helm-zabbix/total.svg)](https://github.com/zabbix-community/helm-zabbix/releases) This is the new home of the Zabbix helm chart. It is a fork from the [cetic/helm-zabbix](https://github.com/cetic/helm-zabbix). diff --git a/charts/zabbix/README.md b/charts/zabbix/README.md index df2e279..f6e7e16 100644 --- a/charts/zabbix/README.md +++ b/charts/zabbix/README.md @@ -400,7 +400,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixAgent.deploymentLabels | object | `{}` | Labels to add to the deployment | | zabbixAgent.enabled | bool | `true` | Enables use of **Zabbix Agent** | | zabbixAgent.extraContainers | list | `[]` | Additional containers to start within the Zabbix Agent pod | -| zabbixAgent.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixAgent.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixAgent.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Agent pod | | zabbixAgent.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Agent pod | | zabbixAgent.extraVolumeMounts | list | `[]` | Additional volumeMounts to the zabbix Agent container | @@ -450,7 +450,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixJavaGateway.deploymentLabels | object | `{}` | Labels to add to the deployment | | zabbixJavaGateway.enabled | bool | `false` | Enables use of **Zabbix Java Gateway** | | zabbixJavaGateway.extraContainers | list | `[]` | Additional containers to start within the Zabbix Java Gateway pod | -| zabbixJavaGateway.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixJavaGateway.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixJavaGateway.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Java Gateway pod | | zabbixJavaGateway.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Java Gateway pod | | zabbixJavaGateway.extraVolumeMounts | list | `[]` | Additional volumeMounts to the Zabbix Java Gateway container | @@ -489,7 +489,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixProxy.containerLabels | object | `{}` | Labels to add to the containers | | zabbixProxy.enabled | bool | `false` | Enables use of **Zabbix Proxy** | | zabbixProxy.extraContainers | list | `[]` | Additional containers to start within the Zabbix Proxy pod | -| zabbixProxy.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/proxy-sqlite3/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixProxy.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/proxy-sqlite3/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixProxy.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Proxy pod | | zabbixProxy.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Proxy pod | | zabbixProxy.extraVolumeClaimTemplate | list | `[]` | Extra volumeClaimTemplate for zabbixProxy statefulset | @@ -523,7 +523,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixServer.deploymentLabels | object | `{}` | Labels to add to the deployment | | zabbixServer.enabled | bool | `true` | Enables use of **Zabbix Server** | | zabbixServer.extraContainers | list | `[]` | Additional containers to start within the Zabbix Server pod | -| zabbixServer.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/server-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixServer.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/server-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixServer.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Server pod | | zabbixServer.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Server pod | | zabbixServer.extraVolumeMounts | list | `[]` | Additional volumeMounts to the Zabbix Server container | @@ -600,7 +600,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixWeb.deploymentLabels | object | `{}` | Labels to add to the deployment | | zabbixWeb.enabled | bool | `true` | Enables use of **Zabbix Web** | | zabbixWeb.extraContainers | list | `[]` | Additional containers to start within the Zabbix Web pod | -| zabbixWeb.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-apache-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixWeb.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-apache-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixWeb.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Web pod | | zabbixWeb.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Web pod | | zabbixWeb.extraVolumeMounts | list | `[]` | Additional volumeMounts to the Zabbix Web container | @@ -644,7 +644,7 @@ The following tables lists the configurable parameters of the chart and their de | zabbixWebService.deploymentLabels | object | `{}` | Labels to add to the deployment | | zabbixWebService.enabled | bool | `true` | Enables use of **Zabbix Web Service** | | zabbixWebService.extraContainers | list | `[]` | Additional containers to start within the Zabbix Web Service pod | -| zabbixWebService.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-service/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml | +| zabbixWebService.extraEnv | list | `[]` | Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-service/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml | | zabbixWebService.extraInitContainers | list | `[]` | Additional init containers to start within the Zabbix Web Service pod | | zabbixWebService.extraPodSpecs | object | `{}` | Additional specifications to the Zabbix Web Service pod | | zabbixWebService.extraVolumeMounts | list | `[]` | Additional volumeMounts to the Zabbix Web Service container | diff --git a/charts/zabbix/values.yaml b/charts/zabbix/values.yaml index e3711df..78e6c36 100644 --- a/charts/zabbix/values.yaml +++ b/charts/zabbix/values.yaml @@ -233,7 +233,7 @@ zabbixServer: # -- Annotations for the zabbix-server service annotations: {} # metallb.universe.tf/address-pool: production-public-ips - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/server-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/server-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] #- name: ENABLE_TIMESCALEDB # value: "true" @@ -410,7 +410,7 @@ zabbixProxy: # -- Annotations for the zabbix-proxy service annotations: {} # metallb.universe.tf/address-pool: production-public-ips - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/proxy-sqlite3/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/proxy-sqlite3/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] # -- Annotations to add to the statefulset statefulSetAnnotations: {} @@ -520,7 +520,7 @@ zabbixAgent: # metallb.universe.tf/address-pool: production-public-ips # -- If true, agent pods mounts host / at /host/root hostRootFsMount: true - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] # -- Additional volumeMounts to the zabbix Agent container extraVolumeMounts: [] @@ -626,7 +626,7 @@ zabbixWeb: # -- Annotations for the Zabbix Web annotations: {} # metallb.universe.tf/address-pool: production-public-ips - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-apache-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-apache-pgsql/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] # - name: ZBX_SSO_SETTINGS # value: '{"baseurl": "https://zabbix.example.com"}' @@ -710,7 +710,7 @@ zabbixWebService: # -- Annotations for the Zabbix Web Service annotations: {} # metallb.universe.tf/address-pool: production-public-ips - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-service/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/web-service/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] # -- Annotations to add to the deployment deploymentAnnotations: {} @@ -808,7 +808,7 @@ zabbixJavaGateway: # -- Annotations for the zabbix-java-gateway service annotations: {} # metallb.universe.tf/address-pool: production-public-ips - # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/master/charts/zabbix/docs/example/kind/values.yaml + # -- Extra environment variables. A list of additional environment variables. List can be extended with other environment variables listed here: https://github.com/zabbix/zabbix-docker/tree/6.0/Dockerfiles/agent2/alpine#environment-variables. See example: https://github.com/zabbix-community/helm-zabbix/blob/main/charts/zabbix/docs/example/kind/values.yaml extraEnv: [] # -- Additional volumeMounts to the Zabbix Java Gateway container extraVolumeMounts: []