Skip to content

Commit

Permalink
Adjust in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aeciopires committed Nov 26, 2024
1 parent 4213069 commit 68f2f84
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 29 deletions.
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- TOC -->

- [Contributing](#contributing)
- [For code mainteners only](#for-code-mainteners-only)
- [About Visual Code (VSCode)](#about-visual-code-vscode)

<!-- TOC -->
Expand Down Expand Up @@ -101,9 +102,9 @@ git push origin master
git push origin master --tags
```

Reference:
* https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
References:

* https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/

## For code mainteners only

Expand All @@ -113,20 +114,20 @@ To generate a new release of the helm chart, follow these instructions:
* Run local tests
* 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 will show with a '*' before the name.

```
```bash
git branch
```

* Make your changes and tests to the new branch
* Verify the syntax errors using the follow commands:

```
```bash
cd charts/zabbix
make lint
```
Expand All @@ -138,58 +139,60 @@ A **major** version" should be the "dot-release". Example: *6.0.2* -> *6.1.0* is
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.

```
```bash
cd charts/zabbix
make gen-docs
```

* 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 master 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:

```
```bash
git checkout master
git pull upstream master
```

* Clean up after your pull request is merged with command:

```
```bash
git branch -d BRANCH_NAME
```

Then you can update the master branch in your forked repository.

```
```bash
git push origin master
```

And push the deletion of the feature branch to your GitHub repository with command:

```
```bash
git push --delete origin BRANCH_NAME
```

* 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 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:

```
```bash
git pull upstream master
git pull upstream master --tags

Expand All @@ -199,11 +202,10 @@ git push origin master --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

# Reference:
References:

* https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/


# About Visual Code (VSCode)

Use a IDE (Integrated Development Environment) or text editor of your choice. By default, the use of VSCode is recommended.
Expand Down
6 changes: 2 additions & 4 deletions charts/zabbix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ helm search repo zabbix-community/zabbix -l
Set the helm chart version you want to use. Example:

```bash
export ZABBIX_CHART_VERSION='6.0.0'
export ZABBIX_CHART_VERSION='6.1.0'
```

Export default values of ``zabbix`` chart to ``$HOME/zabbix_values.yaml`` file:
Expand Down Expand Up @@ -142,6 +142,7 @@ helm uninstall zabbix -n monitoring
# Breaking changes of this helm chart

## Version 6.1.0

* Removing support for non-default Kubernetes features and Custom Resource objects: `IngressRoute`, `Route`, more info: #123
* Removing support for [karpenter](https://karpenter.sh) due to the more generalistic approach: #121
* Adding support to deploy any arbitrary manifests together with this Helm Chart by embedding them in the `.Values.extraManifests` list (#121)
Expand Down Expand Up @@ -733,9 +734,6 @@ postgresql:
## Configure the way how to expose Zabbix service
- **Ingress**: The ingress controller must be installed in the Kubernetes cluster.
- **IngressRoute**: The custom resource definition if you use the
[Traefik](https://traefik.io/traefik/) ingress controller.
- **Route**: The ingress controller used by Red Hat Openshift, based on HAProxy
- **ClusterIP**: Exposes the service on a cluster-internal IP. Choosing this value makes the
service only reachable from within the cluster.
- **NodePort**: Exposes the service on each Node's IP at a static port (the NodePort).
Expand Down
6 changes: 2 additions & 4 deletions charts/zabbix/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ helm search repo zabbix-community/zabbix -l
Set the helm chart version you want to use. Example:

```bash
export ZABBIX_CHART_VERSION='6.0.0'
export ZABBIX_CHART_VERSION='{{ template "chart.version" . }}'
```

Export default values of ``zabbix`` chart to ``$HOME/zabbix_values.yaml`` file:
Expand Down Expand Up @@ -143,6 +143,7 @@ helm uninstall zabbix -n monitoring
# Breaking changes of this helm chart

## Version 6.1.0

* Removing support for non-default Kubernetes features and Custom Resource objects: `IngressRoute`, `Route`, more info: #123
* Removing support for [karpenter](https://karpenter.sh) due to the more generalistic approach: #121
* Adding support to deploy any arbitrary manifests together with this Helm Chart by embedding them in the `.Values.extraManifests` list (#121)
Expand Down Expand Up @@ -396,9 +397,6 @@ postgresql:
## Configure the way how to expose Zabbix service

- **Ingress**: The ingress controller must be installed in the Kubernetes cluster.
- **IngressRoute**: The custom resource definition if you use the
[Traefik](https://traefik.io/traefik/) ingress controller.
- **Route**: The ingress controller used by Red Hat Openshift, based on HAProxy
- **ClusterIP**: Exposes the service on a cluster-internal IP. Choosing this value makes the
service only reachable from within the cluster.
- **NodePort**: Exposes the service on each Node's IP at a static port (the NodePort).
Expand Down
4 changes: 2 additions & 2 deletions charts/zabbix/artifacthub-pkg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ appVersion: 7.0.6 # zabbix version
name: zabbix
category: monitoring, networking, metrics
displayName: Zabbix - The Enterprise-Class Open Source Network Monitoring Solution
createdAt: 2024-11-18T10:11:55Z # Command Linux: date +%Y-%m-%dT%TZ
createdAt: 2024-11-26T07:23:30Z # Command Linux: date +%Y-%m-%dT%TZ
description: Zabbix is a mature and effortless enterprise-class open source monitoring solution for network monitoring and application monitoring of millions of metrics.
logoURL: https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png
license: Apache-2.0
Expand Down Expand Up @@ -53,7 +53,7 @@ install: |
Set the helm chart version you want to use. Example:
```bash
export ZABBIX_CHART_VERSION='6.0.0'
export ZABBIX_CHART_VERSION='6.1.0'
```
Export default values of ``zabbix`` chart to ``$HOME/zabbix_values.yaml`` file:
Expand Down
8 changes: 4 additions & 4 deletions charts/zabbix/docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ asdf update
Run the following commands:

```bash
ASDF_VERSION="v0.14.0"
ASDF_VERSION="v0.14.1"
git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch $ASDF_VERSION

echo ". \"\$HOME/.asdf/asdf.sh\"" >> ~/.bashrc
Expand All @@ -78,7 +78,7 @@ Reference: https://asdf-vm.com/guide/introduction.html
Execute these commands to install helm.

```bash
VERSION="3.15.1"
VERSION="3.16.3"

asdf plugin list all | grep helm
asdf plugin add helm https://github.com/Antiarchitect/asdf-helm.git
Expand All @@ -96,7 +96,7 @@ asdf list helm
Run the following commands to install ``helm-docs``.

```bash
VERSION="1.13.1"
VERSION="1.14.2"

asdf plugin list all | grep helm-docs
asdf plugin add helm-docs https://github.com/sudermanjr/asdf-helm-docs.git
Expand All @@ -118,7 +118,7 @@ The documentation generated by ``helm-docs`` is based on the contents of the ``v
Simple shell function for Kubectl installation in Linux 64 bits. Copy and paste this code:

```bash
VERSION_OPTION_1="1.30.1"
VERSION_OPTION_1="1.31.3"

asdf plugin list all | grep kubectl
asdf plugin add kubectl https://github.com/asdf-community/asdf-kubectl.git
Expand Down

0 comments on commit 68f2f84

Please sign in to comment.