Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/comp matrix #46

Merged
merged 6 commits into from
Nov 18, 2024
Merged

Docs/comp matrix #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e8e669
docs: added compatibility matrix
puffitos Nov 14, 2024
b547311
chore: restored files
puffitos Nov 14, 2024
19cd839
docs: fixed variables and versions
puffitos Nov 14, 2024
1a22d5d
docs: fixed variables and versions
puffitos Nov 14, 2024
35969a9
chore: resolved merge conflicts
puffitos Nov 14, 2024
1f46222
docs: corrected compatibility
puffitos Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: "v1.11.3"
rev: "v1.14.2"
hooks:
- id: helm-docs
args:
Expand Down
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ Or install the chart by using the packaged chart:
helm -n mynamespace upgrade -i project-monitoring -f values.yaml --repo oci://mtr.devops.telekom.de/caas/charts/caas-project-monitoring --version 1.3.0
```

## Compatibility matrix

The following table shows the compatibility between the CaaS Cluster Monitoring chart and the CaaS Project Monitoring versions:

| CaaS Project Monitoring | compatible with CaaS Cluster Monitoring | used kube-prometheus-stack |
| ----------------------- | --------------------------------------- | -------------------------- |
| < 1.0.0 | < 0.0.6 | 40.1.2 - 51.0.3 |
| 1.0.0 <= x < 1.4.0 | 0.0.6 <= y < 1.0.0 | 58.4.0 |

where `x` is the CaaS Project Monitoring Version and `y` is the CaaS Cluster Monitoring Version.

## Values

| Key | Type | Default | Description |
Expand Down Expand Up @@ -218,5 +229,4 @@ helm -n mynamespace upgrade -i project-monitoring -f values.yaml --repo oci://mt
| kube-prometheus-stack.thanosRuler.enabled | bool | `false` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
14 changes: 12 additions & 2 deletions README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,17 @@ Or install the chart by using the packaged chart:
helm -n mynamespace upgrade -i project-monitoring -f values.yaml --repo oci://mtr.devops.telekom.de/caas/charts/caas-project-monitoring --version 1.3.0
```

{{ template "chart.valuesSection" . }}
## Compatibility matrix

The following table shows the compatibility between the CaaS Cluster Monitoring chart and the CaaS Project Monitoring versions:

| CaaS Project Monitoring | compatible with CaaS Cluster Monitoring | used kube-prometheus-stack |
| ----------------------- | --------------------------------------- | -------------------------- |
| < 1.0.0 | < 0.0.6 | 40.1.2 - 51.0.3 |
| 1.0.0 <= x < 1.4.0 | 0.0.6 <= y < 1.0.0 | 58.4.0 |

{{ template "helm-docs.versionFooter" . }}
where `x` is the CaaS Project Monitoring Version and `y` is the CaaS Cluster Monitoring Version.

{{ template "chart.valuesSection" . }}

{{ template "helm-docs.versionFooter" . }}
Loading