From 71cd271bbc037add87a1d0b2812f061f10a64915 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Mart=C3=ADn=20Garc=C3=ADa?= <49920382+amartingarcia@users.noreply.github.com> Date: Wed, 28 Jun 2023 08:55:43 +0200 Subject: [PATCH] feat(helm): change readmes (#23) --- charts/azure-prometheus-config/Chart.yaml | 2 +- charts/azure-prometheus-config/README.md | 69 ++++++++++++++ .../azure-prometheus-config/README.md.gotmpl | 49 ++++++++++ charts/ssl-exporter/Chart.yaml | 2 +- charts/ssl-exporter/README.md | 89 +++++++++++++++++++ charts/ssl-exporter/README.md.gotmpl | 49 ++++++++++ 6 files changed, 258 insertions(+), 2 deletions(-) create mode 100644 charts/azure-prometheus-config/README.md create mode 100644 charts/azure-prometheus-config/README.md.gotmpl create mode 100644 charts/ssl-exporter/README.md create mode 100644 charts/ssl-exporter/README.md.gotmpl diff --git a/charts/azure-prometheus-config/Chart.yaml b/charts/azure-prometheus-config/Chart.yaml index 69236c3..e7c2904 100644 --- a/charts/azure-prometheus-config/Chart.yaml +++ b/charts/azure-prometheus-config/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: azure-prometheus-config description: A Helm chart to configure Azure Managed Prometheus type: application -version: 0.1.0 +version: 0.1.1 appVersion: "1.0.0" home: https://github.com/devops-ia/helm-charts/tree/main/charts/azure-prometheus-config sources: diff --git a/charts/azure-prometheus-config/README.md b/charts/azure-prometheus-config/README.md new file mode 100644 index 0000000..f0dbe7b --- /dev/null +++ b/charts/azure-prometheus-config/README.md @@ -0,0 +1,69 @@ +# azure-prometheus-config + +A Helm chart to configure Azure Managed Prometheus + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| amartingarcia | | | + +## Prerequisites + +* Helm 3+ + +## Add repository + +```console +helm repo add devops-ia https://devops-ia.github.io/helm-charts +helm repo update +``` + +## Install Helm chart + +```console +helm install [RELEASE_NAME] devops-ia/azure-prometheus-config +``` + +This install all the Kubernetes components associated with the chart and creates the release. + +_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ + +## Uninstall Helm chart + +```console +# Helm +helm uninstall [RELEASE_NAME] +``` + +This removes all the Kubernetes components associated with the chart and deletes the release. + +_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ + +## Configuration + +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: + +```console +helm show values devops-ia/azure-prometheus-config +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| amaMetricsPrometheusConfig.config | string | `"global:\n scrape_interval: 15s\nscrape_configs:\n- job_name: \n- job_name: \n"` | | +| amaMetricsPrometheusConfig.enabled | bool | `false` | | +| amaMetricsPrometheusConfigNode.config | string | `"global:\n scrape_interval: 15s\nscrape_configs:\n- job_name: \n- job_name: \n"` | | +| amaMetricsPrometheusConfigNode.enabled | bool | `false` | | +| 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"` | | +| amaMetricsPrometheusConfigNodeWindows.enabled | bool | `false` | | +| amaMetricsSettingsConfigmap.config.config-version | string | `"ver1"` | | +| amaMetricsSettingsConfigmap.config.debug-mode | string | `"enabled = false"` | | +| 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"` | | +| amaMetricsSettingsConfigmap.config.default-targets-metrics-keep-list | string | `"kubelet = \"\"\ncoredns = \"\"\ncadvisor = \"\"\nkubeproxy = \"\"\napiserver = \"\"\nkubestate = \"\"\nnodeexporter = \"\"\nwindowsexporter = \"\"\nwindowskubeproxy = \"\"\npodannotations = \"\"\nkappiebasic = \"\"\nminimalingestionprofile = true"` | | +| 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\""` | | +| amaMetricsSettingsConfigmap.config.pod-annotation-based-scraping | string | `"podannotationnamespaceregex = \"\""` | | +| amaMetricsSettingsConfigmap.config.prometheus-collector-settings | string | `"cluster_alias = \"\""` | | +| amaMetricsSettingsConfigmap.config.schema-version | string | `"v1"` | | +| amaMetricsSettingsConfigmap.enabled | bool | `false` | | \ No newline at end of file diff --git a/charts/azure-prometheus-config/README.md.gotmpl b/charts/azure-prometheus-config/README.md.gotmpl new file mode 100644 index 0000000..c5d3cff --- /dev/null +++ b/charts/azure-prometheus-config/README.md.gotmpl @@ -0,0 +1,49 @@ +# {{ template "chart.name" . }} + +{{ template "chart.description" . }} + +{{ template "chart.maintainersSection" . }} + +## Prerequisites + +* Helm 3+ + +{{ template "chart.requirementsSection" . }} + +## Add repository + +```console +helm repo add devops-ia https://devops-ia.github.io/helm-charts +helm repo update +``` + +## Install Helm chart + +```console +helm install [RELEASE_NAME] devops-ia/{{ template "chart.name" . }} +``` + +This install all the Kubernetes components associated with the chart and creates the release. + +_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ + +## Uninstall Helm chart + +```console +# Helm +helm uninstall [RELEASE_NAME] +``` + +This removes all the Kubernetes components associated with the chart and deletes the release. + +_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ + +## Configuration + +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: + +```console +helm show values devops-ia/{{ template "chart.name" . }} +``` + +{{ template "chart.valuesSection" . }} \ No newline at end of file diff --git a/charts/ssl-exporter/Chart.yaml b/charts/ssl-exporter/Chart.yaml index dff2879..f705ae7 100644 --- a/charts/ssl-exporter/Chart.yaml +++ b/charts/ssl-exporter/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: ssl-exporter description: A Helm Chart to SSL Certificate Exporter for Prometheus type: application -version: 0.1.0 +version: 0.1.1 appVersion: "2.4.2" home: https://github.com/devops-ia/helm-charts/tree/main/charts/ssl-exporter sources: diff --git a/charts/ssl-exporter/README.md b/charts/ssl-exporter/README.md new file mode 100644 index 0000000..9b095b9 --- /dev/null +++ b/charts/ssl-exporter/README.md @@ -0,0 +1,89 @@ +# ssl-exporter + +A Helm Chart to SSL Certificate Exporter for Prometheus + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| amartingarcia | | | + +## Prerequisites + +* Helm 3+ + +## Add repository + +```console +helm repo add devops-ia https://devops-ia.github.io/helm-charts +helm repo update +``` + +## Install Helm chart + +```console +helm install [RELEASE_NAME] devops-ia/ssl-exporter +``` + +This install all the Kubernetes components associated with the chart and creates the release. + +_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ + +## Uninstall Helm chart + +```console +# Helm +helm uninstall [RELEASE_NAME] +``` + +This removes all the Kubernetes components associated with the chart and deletes the release. + +_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ + +## Configuration + +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: + +```console +helm show values devops-ia/ssl-exporter +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| 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"` | | +| config.enabled | bool | `false` | | +| extraVolumeMounts | list | `[]` | | +| extraVolumes | list | `[]` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ribbybibby/ssl-exporter"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| logLevel | string | `"info"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext.fsGroup | int | `100` | | +| rbac.enabled | bool | `true` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `1000` | | +| service.port | int | `9219` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | \ No newline at end of file diff --git a/charts/ssl-exporter/README.md.gotmpl b/charts/ssl-exporter/README.md.gotmpl new file mode 100644 index 0000000..c5d3cff --- /dev/null +++ b/charts/ssl-exporter/README.md.gotmpl @@ -0,0 +1,49 @@ +# {{ template "chart.name" . }} + +{{ template "chart.description" . }} + +{{ template "chart.maintainersSection" . }} + +## Prerequisites + +* Helm 3+ + +{{ template "chart.requirementsSection" . }} + +## Add repository + +```console +helm repo add devops-ia https://devops-ia.github.io/helm-charts +helm repo update +``` + +## Install Helm chart + +```console +helm install [RELEASE_NAME] devops-ia/{{ template "chart.name" . }} +``` + +This install all the Kubernetes components associated with the chart and creates the release. + +_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ + +## Uninstall Helm chart + +```console +# Helm +helm uninstall [RELEASE_NAME] +``` + +This removes all the Kubernetes components associated with the chart and deletes the release. + +_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ + +## Configuration + +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: + +```console +helm show values devops-ia/{{ template "chart.name" . }} +``` + +{{ template "chart.valuesSection" . }} \ No newline at end of file