Skip to content

Commit

Permalink
Merge pull request #124 from RADAR-base/document-kube-prometheus-stack
Browse files Browse the repository at this point in the history
Added chart documentation for kube-prometheus-stack
  • Loading branch information
keyvaann authored Aug 16, 2021
2 parents 5282eb4 + e87e465 commit 6f98041
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 2 deletions.
1 change: 0 additions & 1 deletion .helmdocsignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
charts/kafka-manager/
charts/kube-prometheus-stack/
charts/radar-backend/
charts/radar-integration/
charts/smtp/
7 changes: 6 additions & 1 deletion charts/kube-prometheus-stack/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
apiVersion: v1
appVersion: "1.0"
description: A Helm chart for Kubernetes
description: A Helm chart for Prometheus operator stack. This chart is an overlay for original kube-prometheus-stack chart. It defines some the default values for namespaces to monitor, alert templates, Nginx configuration and authentication and a few extra charts for Grafana. For more details on how to customize those values refer to original chart.
name: kube-prometheus-stack
version: 0.1.0
engine: gotpl
sources: ["https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack"]
deprecated: false
type: application
home: "https://prometheus-operator.dev"
dependencies:
- name: kube-prometheus-stack
version: 12.2.0
Expand Down
Empty file.
20 changes: 20 additions & 0 deletions charts/kube-prometheus-stack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@


# kube-prometheus-stack

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0](https://img.shields.io/badge/AppVersion-1.0-informational?style=flat-square)

A Helm chart for Prometheus operator stack. This chart is an overlay for original kube-prometheus-stack chart. It defines some the default values for namespaces to monitor, alert templates, Nginx configuration and authentication and a few extra charts for Grafana. For more details on how to customize those values refer to original chart.

**Homepage:** <https://prometheus-operator.dev>

## Source Code

* <https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack>

## Prerequisites
* Kubernetes 1.17+
* Kubectl 1.17+
* Helm 3.1.0+
* PV provisioner support in the underlying infrastructure

16 changes: 16 additions & 0 deletions charts/kube-prometheus-stack/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}

{{ template "chart.badgesSection" . }}

{{ template "chart.description" . }}

{{ template "chart.homepageLine" . }}

{{ template "chart.maintainersSection" . }}

{{ template "chart.sourcesSection" . }}

{{ template "common.prerequisiteswithpv" . }}

{{ template "chart.requirementsSection" . }}

0 comments on commit 6f98041

Please sign in to comment.