Skip to content

Commit 679e6ce

Browse files
committed
update the README.md
1 parent 16bd4b6 commit 679e6ce

File tree

2 files changed

+64
-2
lines changed

2 files changed

+64
-2
lines changed

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,63 @@
11
# Terraform Modules Template
2+
3+
<!-- BEGIN_TF_DOCS -->
4+
## Requirements
5+
6+
| Name | Version |
7+
|------|---------|
8+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
9+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.5 |
10+
11+
## Providers
12+
13+
| Name | Version |
14+
|------|---------|
15+
| <a name="provider_helm"></a> [helm](#provider\_helm) | 2.6.0 |
16+
17+
## Modules
18+
19+
No modules.
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [helm_release.kube_prometheus_stack](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_chart_name"></a> [chart\_name](#input\_chart\_name) | Helm chart name to provision | `string` | `"kube-prometheus-stack"` | no |
32+
| <a name="input_chart_namespace"></a> [chart\_namespace](#input\_chart\_namespace) | Namespace to install the chart into | `string` | `"monitoring"` | no |
33+
| <a name="input_chart_repository"></a> [chart\_repository](#input\_chart\_repository) | Helm repository for the chart | `string` | `"https://prometheus-community.github.io/helm-charts"` | no |
34+
| <a name="input_chart_timeout"></a> [chart\_timeout](#input\_chart\_timeout) | Timeout to wait for the Chart to be deployed. | `number` | `300` | no |
35+
| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Version of Chart to install. Set to empty to install the latest version | `string` | `"36.2.1"` | no |
36+
| <a name="input_grafana_admin_password"></a> [grafana\_admin\_password](#input\_grafana\_admin\_password) | Grafana Admin Password | `string` | n/a | yes |
37+
| <a name="input_grafana_host_url"></a> [grafana\_host\_url](#input\_grafana\_host\_url) | Grafana Host URL | `string` | `""` | no |
38+
| <a name="input_grafana_image_repository"></a> [grafana\_image\_repository](#input\_grafana\_image\_repository) | Grafana Image repository on Dockerhub | `string` | `"grafana/grafana"` | no |
39+
| <a name="input_grafana_image_tag"></a> [grafana\_image\_tag](#input\_grafana\_image\_tag) | Grafana Image tag | `string` | `"9.0.2"` | no |
40+
| <a name="input_grafana_okta_api_url"></a> [grafana\_okta\_api\_url](#input\_grafana\_okta\_api\_url) | OKTA API URL for Grafana | `string` | `""` | no |
41+
| <a name="input_grafana_okta_auth_url"></a> [grafana\_okta\_auth\_url](#input\_grafana\_okta\_auth\_url) | OKTA Auth URL for Grafana | `string` | `""` | no |
42+
| <a name="input_grafana_okta_client_id"></a> [grafana\_okta\_client\_id](#input\_grafana\_okta\_client\_id) | OKTA Client ID for Grafana | `string` | n/a | yes |
43+
| <a name="input_grafana_okta_client_secret"></a> [grafana\_okta\_client\_secret](#input\_grafana\_okta\_client\_secret) | OKTA Client Secret for Grafana | `string` | n/a | yes |
44+
| <a name="input_grafana_okta_token_url"></a> [grafana\_okta\_token\_url](#input\_grafana\_okta\_token\_url) | OKTA Token URL for Grafana | `string` | `""` | no |
45+
| <a name="input_grafana_s3_image_bucket"></a> [grafana\_s3\_image\_bucket](#input\_grafana\_s3\_image\_bucket) | Grafana S3 image bucket | `string` | `""` | no |
46+
| <a name="input_grafana_s3_image_bucket_region"></a> [grafana\_s3\_image\_bucket\_region](#input\_grafana\_s3\_image\_bucket\_region) | Region of the Grafana S3 image bucket | `string` | `""` | no |
47+
| <a name="input_grafana_server_root_url"></a> [grafana\_server\_root\_url](#input\_grafana\_server\_root\_url) | Grafana Server Root URL | `string` | `""` | no |
48+
| <a name="input_max_history"></a> [max\_history](#input\_max\_history) | Max History for Helm | `number` | `20` | no |
49+
| <a name="input_prometheus_host_url"></a> [prometheus\_host\_url](#input\_prometheus\_host\_url) | Prometheus Host URL | `string` | `""` | no |
50+
| <a name="input_prometheus_image_repository"></a> [prometheus\_image\_repository](#input\_prometheus\_image\_repository) | Prometheus Image repository | `string` | `"quay.io/prometheus/prometheus"` | no |
51+
| <a name="input_prometheus_image_tag"></a> [prometheus\_image\_tag](#input\_prometheus\_image\_tag) | Prometheus Image tag | `string` | `"v2.36.2"` | no |
52+
| <a name="input_prometheus_operator_image_repository"></a> [prometheus\_operator\_image\_repository](#input\_prometheus\_operator\_image\_repository) | Prometheus Operator Image repository | `string` | `"quay.io/prometheus-operator/prometheus-operator"` | no |
53+
| <a name="input_prometheus_operator_image_tag"></a> [prometheus\_operator\_image\_tag](#input\_prometheus\_operator\_image\_tag) | Prometheus Operator Image Tag | `string` | `"v0.57.0"` | no |
54+
| <a name="input_release_name"></a> [release\_name](#input\_release\_name) | Helm release name | `string` | `"kube-prometheus-stack"` | no |
55+
| <a name="input_smtp_from_address"></a> [smtp\_from\_address](#input\_smtp\_from\_address) | From Address which want to send emails | `string` | `""` | no |
56+
| <a name="input_smtp_host"></a> [smtp\_host](#input\_smtp\_host) | SMTP Server Host Address | `string` | `""` | no |
57+
| <a name="input_smtp_password"></a> [smtp\_password](#input\_smtp\_password) | SMTP Password | `string` | n/a | yes |
58+
| <a name="input_smtp_user"></a> [smtp\_user](#input\_smtp\_user) | SMTP User | `string` | n/a | yes |
59+
60+
## Outputs
61+
62+
No outputs.
63+
<!-- END_TF_DOCS -->

templates/values.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1865,9 +1865,9 @@ prometheus:
18651865

18661866
# Service for thanos service discovery on sidecar
18671867
# Enable this can make Thanos Query can use
1868-
# `--store=dnssrv+_grpc._tcp.${kube-prometheus-stack.fullname}-thanos-discovery.${namespace}.svc.cluster.local` to discovery
1868+
18691869
# Thanos sidecar on prometheus nodes
1870-
# (Please remember to change ${kube-prometheus-stack.fullname} and ${namespace}. Not just copy and paste!)
1870+
18711871
thanosService:
18721872
enabled: false
18731873
annotations: {}

0 commit comments

Comments
 (0)