Skip to content

Commit 71cd271

Browse files
amartingarciaamartingarcia
authored
feat(helm): change readmes (#23)
1 parent f85a4d0 commit 71cd271

File tree

6 files changed

+258
-2
lines changed

6 files changed

+258
-2
lines changed

‎charts/azure-prometheus-config/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: azure-prometheus-config
33
description: A Helm chart to configure Azure Managed Prometheus
44
type: application
5-
version: 0.1.0
5+
version: 0.1.1
66
appVersion: "1.0.0"
77
home: https://github.com/devops-ia/helm-charts/tree/main/charts/azure-prometheus-config
88
sources:

‎charts/azure-prometheus-config/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# azure-prometheus-config
2+
3+
A Helm chart to configure Azure Managed Prometheus
4+
5+
## Maintainers
6+
7+
| Name | Email | Url |
8+
| ---- | ------ | --- |
9+
| amartingarcia | | <https://github.com/devops-ia> |
10+
11+
## Prerequisites
12+
13+
* Helm 3+
14+
15+
## Add repository
16+
17+
```console
18+
helm repo add devops-ia https://devops-ia.github.io/helm-charts
19+
helm repo update
20+
```
21+
22+
## Install Helm chart
23+
24+
```console
25+
helm install [RELEASE_NAME] devops-ia/azure-prometheus-config
26+
```
27+
28+
This install all the Kubernetes components associated with the chart and creates the release.
29+
30+
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
31+
32+
## Uninstall Helm chart
33+
34+
```console
35+
# Helm
36+
helm uninstall [RELEASE_NAME]
37+
```
38+
39+
This removes all the Kubernetes components associated with the chart and deletes the release.
40+
41+
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
42+
43+
## Configuration
44+
45+
See [Customizing the chart before installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with comments:
46+
47+
```console
48+
helm show values devops-ia/azure-prometheus-config
49+
```
50+
51+
## Values
52+
53+
| Key | Type | Default | Description |
54+
|-----|------|---------|-------------|
55+
| amaMetricsPrometheusConfig.config | string | `"global:\n scrape_interval: 15s\nscrape_configs:\n- job_name: <your scrape job here>\n- job_name: <your scrape job here>\n"` | |
56+
| amaMetricsPrometheusConfig.enabled | bool | `false` | |
57+
| amaMetricsPrometheusConfigNode.config | string | `"global:\n scrape_interval: 15s\nscrape_configs:\n- job_name: <your scrape job here>\n- job_name: <your scrape job here>\n"` | |
58+
| amaMetricsPrometheusConfigNode.enabled | bool | `false` | |
59+
| amaMetricsPrometheusConfigNodeWindows.config | string | `"global:\n scrape_interval: 15s\nscrape_configs:\n- job_name: kubelet\n scheme: https\n metrics_path: /metrics\n scrape_interval: 30s\n label_limit: 63\n label_name_length_limit: 511\n label_value_length_limit: 1023\n tls_config:\n ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt\n insecure_skip_verify: true\n bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token\n relabel_configs:\n - source_labels: [__metrics_path__]\n regex: (.*)\n target_label: metrics_path\n - source_labels: [__address__]\n replacement: '$NODE_NAME'\n target_label: instance\n - source_labels: [__address__]\n replacement: '$OS_TYPE'\n target_label: \"kubernetes_io_os\"\n static_configs:\n - targets: ['$NODE_IP:10250']\n"` | |
60+
| amaMetricsPrometheusConfigNodeWindows.enabled | bool | `false` | |
61+
| amaMetricsSettingsConfigmap.config.config-version | string | `"ver1"` | |
62+
| amaMetricsSettingsConfigmap.config.debug-mode | string | `"enabled = false"` | |
63+
| amaMetricsSettingsConfigmap.config.default-scrape-settings-enabled | string | `"kubelet = true\ncoredns = false\ncadvisor = true\nkubeproxy = false\napiserver = false\nkubestate = true\nnodeexporter = true\nwindowsexporter = false\nwindowskubeproxy = false\nkappiebasic = true\nprometheuscollectorhealth = false"` | |
64+
| amaMetricsSettingsConfigmap.config.default-targets-metrics-keep-list | string | `"kubelet = \"\"\ncoredns = \"\"\ncadvisor = \"\"\nkubeproxy = \"\"\napiserver = \"\"\nkubestate = \"\"\nnodeexporter = \"\"\nwindowsexporter = \"\"\nwindowskubeproxy = \"\"\npodannotations = \"\"\nkappiebasic = \"\"\nminimalingestionprofile = true"` | |
65+
| amaMetricsSettingsConfigmap.config.default-targets-scrape-interval-settings | string | `"kubelet = \"30s\"\ncoredns = \"30s\"\ncadvisor = \"30s\"\nkubeproxy = \"30s\"\napiserver = \"30s\"\nkubestate = \"30s\"\nnodeexporter = \"30s\"\nwindowsexporter = \"30s\"\nwindowskubeproxy = \"30s\"\nkappiebasic = \"30s\"\nprometheuscollectorhealth = \"30s\"\npodannotations = \"30s\""` | |
66+
| amaMetricsSettingsConfigmap.config.pod-annotation-based-scraping | string | `"podannotationnamespaceregex = \"\""` | |
67+
| amaMetricsSettingsConfigmap.config.prometheus-collector-settings | string | `"cluster_alias = \"\""` | |
68+
| amaMetricsSettingsConfigmap.config.schema-version | string | `"v1"` | |
69+
| amaMetricsSettingsConfigmap.enabled | bool | `false` | |

‎charts/azure-prometheus-config/README.md.gotmpl

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# {{ template "chart.name" . }}
2+
3+
{{ template "chart.description" . }}
4+
5+
{{ template "chart.maintainersSection" . }}
6+
7+
## Prerequisites
8+
9+
* Helm 3+
10+
11+
{{ template "chart.requirementsSection" . }}
12+
13+
## Add repository
14+
15+
```console
16+
helm repo add devops-ia https://devops-ia.github.io/helm-charts
17+
helm repo update
18+
```
19+
20+
## Install Helm chart
21+
22+
```console
23+
helm install [RELEASE_NAME] devops-ia/{{ template "chart.name" . }}
24+
```
25+
26+
This install all the Kubernetes components associated with the chart and creates the release.
27+
28+
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
29+
30+
## Uninstall Helm chart
31+
32+
```console
33+
# Helm
34+
helm uninstall [RELEASE_NAME]
35+
```
36+
37+
This removes all the Kubernetes components associated with the chart and deletes the release.
38+
39+
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
40+
41+
## Configuration
42+
43+
See [Customizing the chart before installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with comments:
44+
45+
```console
46+
helm show values devops-ia/{{ template "chart.name" . }}
47+
```
48+
49+
{{ template "chart.valuesSection" . }}

‎charts/ssl-exporter/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: ssl-exporter
33
description: A Helm Chart to SSL Certificate Exporter for Prometheus
44
type: application
5-
version: 0.1.0
5+
version: 0.1.1
66
appVersion: "2.4.2"
77
home: https://github.com/devops-ia/helm-charts/tree/main/charts/ssl-exporter
88
sources:

‎charts/ssl-exporter/README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# ssl-exporter
2+
3+
A Helm Chart to SSL Certificate Exporter for Prometheus
4+
5+
## Maintainers
6+
7+
| Name | Email | Url |
8+
| ---- | ------ | --- |
9+
| amartingarcia | | <https://github.com/devops-ia> |
10+
11+
## Prerequisites
12+
13+
* Helm 3+
14+
15+
## Add repository
16+
17+
```console
18+
helm repo add devops-ia https://devops-ia.github.io/helm-charts
19+
helm repo update
20+
```
21+
22+
## Install Helm chart
23+
24+
```console
25+
helm install [RELEASE_NAME] devops-ia/ssl-exporter
26+
```
27+
28+
This install all the Kubernetes components associated with the chart and creates the release.
29+
30+
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
31+
32+
## Uninstall Helm chart
33+
34+
```console
35+
# Helm
36+
helm uninstall [RELEASE_NAME]
37+
```
38+
39+
This removes all the Kubernetes components associated with the chart and deletes the release.
40+
41+
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
42+
43+
## Configuration
44+
45+
See [Customizing the chart before installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with comments:
46+
47+
```console
48+
helm show values devops-ia/ssl-exporter
49+
```
50+
51+
## Values
52+
53+
| Key | Type | Default | Description |
54+
|-----|------|---------|-------------|
55+
| affinity | object | `{}` | |
56+
| config.data | string | `"modules:\n https:\n prober: https\n https_insecure:\n prober: https\n tls_config:\n insecure_skip_verify: true\n https_proxy:\n prober: https\n https:\n proxy_url: \"socks5://localhost:8123\"\n https_timeout:\n prober: https\n timeout: 3s\n tcp:\n prober: tcp\n tcp_servername:\n prober: tcp\n tls_config:\n server_name: example.com\n tcp_client_auth:\n prober: tcp\n tls_config:\n ca_file: /etc/tls/ca.crt\n cert_file: /etc/tls/tls.crt\n key_file: /etc/tls/tls.key\n tcp_smtp_starttls:\n prober: tcp\n tcp:\n starttls: smtp\n file:\n prober: file\n kubernetes:\n prober: kubernetes\n kubernetes_kubeconfig:\n prober: kubernetes\n kubernetes:\n kubeconfig: /root/.kube/config\n kubeconfig:\n prober: kubeconfig\n"` | |
57+
| config.enabled | bool | `false` | |
58+
| extraVolumeMounts | list | `[]` | |
59+
| extraVolumes | list | `[]` | |
60+
| fullnameOverride | string | `""` | |
61+
| image.pullPolicy | string | `"IfNotPresent"` | |
62+
| image.repository | string | `"ribbybibby/ssl-exporter"` | |
63+
| image.tag | string | `""` | |
64+
| imagePullSecrets | list | `[]` | |
65+
| ingress.annotations | object | `{}` | |
66+
| ingress.className | string | `""` | |
67+
| ingress.enabled | bool | `false` | |
68+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
69+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
70+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
71+
| ingress.tls | list | `[]` | |
72+
| logLevel | string | `"info"` | |
73+
| nameOverride | string | `""` | |
74+
| nodeSelector | object | `{}` | |
75+
| podAnnotations | object | `{}` | |
76+
| podSecurityContext.fsGroup | int | `100` | |
77+
| rbac.enabled | bool | `true` | |
78+
| replicaCount | int | `1` | |
79+
| resources | object | `{}` | |
80+
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
81+
| securityContext.readOnlyRootFilesystem | bool | `true` | |
82+
| securityContext.runAsNonRoot | bool | `true` | |
83+
| securityContext.runAsUser | int | `1000` | |
84+
| service.port | int | `9219` | |
85+
| service.type | string | `"ClusterIP"` | |
86+
| serviceAccount.annotations | object | `{}` | |
87+
| serviceAccount.create | bool | `true` | |
88+
| serviceAccount.name | string | `""` | |
89+
| tolerations | list | `[]` | |

‎charts/ssl-exporter/README.md.gotmpl

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# {{ template "chart.name" . }}
2+
3+
{{ template "chart.description" . }}
4+
5+
{{ template "chart.maintainersSection" . }}
6+
7+
## Prerequisites
8+
9+
* Helm 3+
10+
11+
{{ template "chart.requirementsSection" . }}
12+
13+
## Add repository
14+
15+
```console
16+
helm repo add devops-ia https://devops-ia.github.io/helm-charts
17+
helm repo update
18+
```
19+
20+
## Install Helm chart
21+
22+
```console
23+
helm install [RELEASE_NAME] devops-ia/{{ template "chart.name" . }}
24+
```
25+
26+
This install all the Kubernetes components associated with the chart and creates the release.
27+
28+
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
29+
30+
## Uninstall Helm chart
31+
32+
```console
33+
# Helm
34+
helm uninstall [RELEASE_NAME]
35+
```
36+
37+
This removes all the Kubernetes components associated with the chart and deletes the release.
38+
39+
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
40+
41+
## Configuration
42+
43+
See [Customizing the chart before installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with comments:
44+
45+
```console
46+
helm show values devops-ia/{{ template "chart.name" . }}
47+
```
48+
49+
{{ template "chart.valuesSection" . }}

0 commit comments

Comments
 (0)