Us aecio 4 (#16)

* Adjust in commands of chart installation * Adjust in content of CONTRIBUTING * bump version chart and change dependency repo of postgresql * Update README after bump version of chart * Update README after bump version of chart [2] * Update README after bump version of chart [3] * Update README after bump version of chart [4]
zabbix-community · Nov 9, 2020 · 157e489 · 157e489
1 parent 6efeb7b
commit 157e489
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 129 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -45,9 +45,9 @@ git branch
 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 `develop` 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, update your local clone:
+* After your pull request is merged to the `develop` and `master` branches, update your local clone:
 
 ```bash
 git checkout master

diff --git a/Chart.yaml b/Chart.yaml
@@ -1,7 +1,7 @@
 ---
 apiVersion: v2
 name: zabbix
-version: 0.2.0
+version: 0.2.1
 appVersion: 5.0.4
 description: Zabbix is a mature and effortless enterprise-class open source monitoring solution for network monitoring and application monitoring of millions of metrics.
 keywords:
@@ -25,5 +25,5 @@ maintainers:
 dependencies:
   - name: postgresql
     version: ~8.3.0
-    repository: https://kubernetes-charts.storage.googleapis.com/
+    repository: https://charts.bitnami.com/bitnami
     condition: postgresql.enabled
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Helm Chart For Zabbix.
 
-[![CircleCI](https://circleci.com/gh/cetic/helm-zabbix.svg?style=svg)](https://circleci.com/gh/cetic/helm-zabbix/tree/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![version](https://img.shields.io/github/tag/cetic/helm-zabbix.svg?label=release) ![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
+[![CircleCI](https://circleci.com/gh/cetic/helm-zabbix.svg?style=svg)](https://circleci.com/gh/cetic/helm-zabbix/tree/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![version](https://img.shields.io/github/tag/cetic/helm-zabbix.svg?label=release) ![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square)
 
 Zabbix is a mature and effortless enterprise-class open source monitoring solution for network monitoring and application monitoring of millions of metrics.
 
@@ -81,16 +81,30 @@ Update the list helm chart available for installation (like ``apt-get update``).
 helm repo update
 ```
 
-Install dependences of ``helm-zabbix`` chart:
+Export default values of chart ``helm-zabbix`` to file ``$HOME/zabbix_values.yaml``:
 
 ```bash
-helm dependency update
+helm show values cetic/zabbix > $HOME/zabbix_values.yaml
 ```
 
-Install the Zabbix helm chart with a release name `my-release` in the monitoring namespace:
+Change the values according to the environment in the file ``$HOME/zabbix_values.yaml``.
+
+Install the Zabbix helm chart with a release name `my-release`:
+
+```bash
+helm install zabbix cetic/zabbix --dependency-update -f $HOME/zabbix_values.yaml -n monitoring
+```
+
+View the pods.
+
+```bash
+kubectl get pods -n monitoring
+```
+
+View the logs container of pods.
 
 ```bash
-helm install --name my-release cetic/zabbix -n monitoring
+kubectl logs -f pods/POD_NAME -n monitoring
 ```
 
 See the example of installation in minikube in this [tutorial](docs/example/README.md).
@@ -99,21 +113,29 @@ See section [Basic Commands of Helm 3](docs/basics-helmv3.md) for more informati
 
 # Uninstallation
 
-To uninstall/delete the `my-release` deployment:
+To uninstall/delete the ``zabbix`` deployment:
 
 ```bash
-helm delete my-release
+helm delete zabbix -n monitoring
 ```
 
 # How to access Zabbix
 
 After deploying the chart in your cluster, you can use the following command to access the zabbix frontend service:
 
+View informations of ``zabbix`` services.
+
+```bash
+kubectl describe services zabbix-web -n monitoring
+```
+
+Listen on port 8888 locally, forwarding to 80 in the service ``zabbix-web``.
+
 ```bash
-minikube service <release-name>-zabbix-web
+kubectl port-forward service/zabbix-web 8888:80 -n monitoring
 ```
 
-The default username/password are `Admin`/`zabbix`
+Access Zabbix in http://localhost:8888. Login ``Admin`` and password ``zabbix``.
 
 # License
 
@@ -205,4 +227,4 @@ The following tables lists the configurable parameters of the chart and their de
 | zabbixweb.image.tag | string | `"ubuntu-5.0.4"` | Tag of Docker image of Zabbix web |
 | zabbixweb.service.port | int | `80` | Port to expose service |
 | zabbixweb.service.targetPort | int | `8080` | Port of application pod |
-| zabbixweb.service.type | string | `"NodePort"` | Type of service for Zabbix web |
+| zabbixweb.service.type | string | `"NodePort"` | Type of service for Zabbix web |
diff --git a/README.md.gotmpl b/README.md.gotmpl
@@ -1,13 +1,9 @@
 # Helm Chart For Zabbix.
 
-[![CircleCI](https://circleci.com/gh/cetic/helm-zabbix.svg?style=svg)](https://circleci.com/gh/cetic/helm-zabbix/tree/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![version](https://img.shields.io/github/tag/cetic/helm-zabbix.svg?label=release)
-
-{{ template "chart.typeBadge" . }} {{ template "chart.versionBadge" . }}
+[![CircleCI](https://circleci.com/gh/cetic/helm-zabbix.svg?style=svg)](https://circleci.com/gh/cetic/helm-zabbix/tree/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![version](https://img.shields.io/github/tag/cetic/helm-zabbix.svg?label=release) {{ template "chart.versionBadge" . }}
 
 {{ template "chart.description" . }}
 
-=======
-
 # Introduction
 
 This [Helm](https://github.com/cetic/helm-zabbix) chart installs [Zabbix](https://www.zabbix.com) in a Kubernetes cluster.
@@ -85,146 +81,61 @@ Update the list helm chart available for installation (like ``apt-get update``).
 helm repo update
 ```
 
-Install dependences of ``helm-zabbix`` chart:
-
-```bash
-helm dependency update
-```
-
-Install the Zabbix helm chart with a release name `my-release`:
-
-```bash
-helm install --name my-release cetic/zabbix
-```
-
-See the example of installation in minikube in this [tutorial](docs/example/README.md).
-
-See section [Basic Commands of Helm 3](#basic-commands-of-helm-3) for more information about commands of helm.
-
-# Uninstallation
-
-To uninstall/delete the `my-release` deployment:
+Export default values of chart ``helm-zabbix`` to file ``$HOME/zabbix_values.yaml``:
 
 ```bash
-helm delete my-release
+helm show values cetic/zabbix > $HOME/zabbix_values.yaml
 ```
 
-# How to access Zabbix
+Change the values according to the environment in the file ``$HOME/zabbix_values.yaml``.
 
-After deploying the chart in your cluster, you can use the following command to access the zabbix frontend service: 
-
-```bash
-minikube service <release-name>-zabbix-web
-```
-
-The default username/password are `Admin`/`zabbix`
-
-# Basic Commands of Helm 3
-
-Help of ``helm`` command:
-
-```bash
-helm --help
-```
-
-Add Helm repo official stable charts:
-
-```bash
-helm repo add stable https://kubernetes-charts.storage.googleapis.com/
-```
-
-Update the list helm chart available for installation (like ``apt-get update``). This is recommend before install/upgrade a helm chart:
-
-```bash
-helm repo update
-```
-
-List the helm repositories installed in your local environment:
-
-```bash
-helm repo list
-```
-
-Repositories can be removed with command:
-
-```bash
-helm repo remove
-```
-
-Once this is installed, you will be able to list the charts you can install:
-
-```bash
-helm search repo stable
-```
-
-Searches in the Helm Hub, which comprises helm charts from dozens of different repositories.
-
-```bash
-helm search hub
-```
-
-Searches the repositories that you have added to your local environment. This search is done over local data and no network connection is needed.
-
-```bash
-helm search repo
-```
-
-Use the command to see informations of chart :
+Install the Zabbix helm chart with a release name `my-release`:
 
 ```bash
-helm show chart HELM_REPO_NAME/CHART_NAME
+helm install zabbix cetic/zabbix --dependency-update -f $HOME/zabbix_values.yaml -n monitoring
 ```
 
-Use the command to see documentation of chart:
+View the pods.
 
 ```bash
-helm show readme HELM_REPO_NAME/CHART_NAME
+kubectl get pods -n monitoring
 ```
 
-Use the command to see what default options of a chart:
+View the logs container of pods.
 
 ```bash
-helm show values HELM_REPO_NAME/CHART_NAME
+kubectl logs -f pods/POD_NAME -n monitoring
 ```
 
-List installed charts in Kubernetes cluster:
-
-```bash
-helm list --all-namespaces
+See the example of installation in minikube in this [tutorial](docs/example/README.md).
 
-# or
+See section [Basic Commands of Helm 3](docs/basics-helmv3.md) for more information about commands of helm.
 
-helm list -n NAMESPACE
-```
+# Uninstallation
 
-Use the command if you want to see what the default values were used for this installation:
+To uninstall/delete the ``zabbix`` deployment:
 
 ```bash
-helm get values APPLICATION_NAME -n NAMESPACE
+helm delete zabbix -n monitoring
 ```
 
-View the change history of the application installed with ``helm``. You will see revision number for each change/upgrade of application:
+# How to access Zabbix
 
-```bash
-helm history APPLICATION_NAME -n NAMESPACE
-```
+After deploying the chart in your cluster, you can use the following command to access the zabbix frontend service: 
 
-Use the commando to do rollback of application to specific revision number:
+View informations of ``zabbix`` services.
 
 ```bash
-helm rollback APPLICATION_NAME REVISION_NUMBER -n NAMESPACE
+kubectl describe services zabbix-web -n monitoring
 ```
 
-Remove a application installed with ``helm`` in Kubernetes cluster:
+Listen on port 8888 locally, forwarding to 80 in the service ``zabbix-web``.
 
 ```bash
-helm uninstall APPLICATION_NAME -n NAMESPACE
+kubectl port-forward service/zabbix-web 8888:80 -n monitoring
 ```
 
-More informations and commands about helm:
-
-* https://helm.sh/docs/intro/quickstart
-* https://helm.sh/docs/intro/using_helm
+Access Zabbix in http://localhost:8888. Login ``Admin`` and password ``zabbix``.
 
 # License
 
@@ -234,4 +145,4 @@ More informations and commands about helm:
 
 The following tables lists the configurable parameters of the chart and their default values.
 
-{{ template "chart.valuesTable" . }}
+{{ template "chart.valuesTable" . }}
diff --git a/docs/example/README.md b/docs/example/README.md
@@ -19,14 +19,14 @@ Clone this repository:
 ```bash
 cd ~
 git clone https://github.com/cetic/helm-zabbix
+cd helm-zabbix
 ```
 
 Edit ``helm-zabbix/docs/example/minikube/values.yaml`` file.
 
 Download the dependences charts.
 
 ```bash
-helm repo add stable https://kubernetes-charts-incubator.storage.googleapis.com
 helm repo add cetic https://cetic.github.io/helm-charts
 helm repo update
 ```
@@ -78,7 +78,7 @@ kubectl get pods POD_NAME -n monitoring -o jsonpath='{.spec.containers[*].name}*
 View the logs container of pods.
 
 ```bash
-kubectl logs -f pods/POD_NAME-c CONTAINER_NAME -n monitoring
+kubectl logs -f pods/POD_NAME -c CONTAINER_NAME -n monitoring
 ```
 
 Access prompt of container.
@@ -90,7 +90,7 @@ kubectl exec -it pods/POD_NAME -c CONTAINER_NAME -n monitoring -- sh
 View informations of service Zabbix.
 
 ```bash
-kubectl get svc
+kubectl get svc -n monitoring
 kubectl get pods --output=wide -n monitoring
 kubectl describe services zabbix -n monitoring
 ```