diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 33770f4..461d437 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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: diff --git a/README.md b/README.md index 8b7be06..b6c3d24 100644 --- a/README.md +++ b/README.md @@ -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 | @@ -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) \ No newline at end of file diff --git a/README.md.gotmpl b/README.md.gotmpl index 5443da4..90d1db0 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -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" . }} \ No newline at end of file