chore(cloudprem): bump to 0.4.1 with multi-cloud docs + kubeVersion enforcement#2686
Draft
Mallets wants to merge 2 commits into
Draft
chore(cloudprem): bump to 0.4.1 with multi-cloud docs + kubeVersion enforcement#2686Mallets wants to merge 2 commits into
Mallets wants to merge 2 commits into
Conversation
…nforcement - Add `kubeVersion: ">= 1.25.0-0"` to Chart.yaml so `helm install` rejects clusters older than 1.25 with a clear error, instead of installing successfully and failing at runtime. The `-0` suffix accepts cloud-vendor pre-release tags like `1.25.0-eks-abc`. Matches the prerequisite already documented in both the public install page and this README. - Rewrite the README Prerequisites section to reflect the chart's actual multi-cloud support. The chart's `values.yaml` has had `azure.*` config for a while, and the public docs at https://docs.datadoghq.com/byoc-logs/ cover EKS/GKE/AKS/self-managed; the README's AWS-only Prereqs framing was out of sync with both. - Fix the `image.tag` default documented in the values table: when unset, helm uses the chart's `appVersion` (`v0.1.26`), not the literal string `devel`. Customers reading the README expected one tag and got another. - Add the existing `azure.*` keys to the README values table so the Azure configuration surface is discoverable without grepping `values.yaml`. Surfaced by an audit of the public BYOC Logs docs against the chart and the pomsky storage layer; full evidence at: DataDog/claude-marketplace#2216 (comment) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
`helm-docs` auto-expands `{{ template "chart.requirementsSection" . }}`
in `README.md.gotmpl` (line 14) into a `## Requirements` section now
that `Chart.yaml` declares `kubeVersion`. Adding the expanded section
to the committed `README.md` so the `lint-docs` CI check passes.
The `.gotmpl` itself was already correct — no template change needed,
just the rendered output.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Author
CI status — initial runPushed
On the pre-1.25 kubeconform failuresI deliberately did not soften the
Happy to open a follow-up PR for either, but it touches the workflow file ( |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Doc-audit follow-up surfaced by an audit of the public BYOC Logs docs against the chart and the pomsky storage layer. Bundles four changes to the
cloudpremchart so the README + Chart.yaml match the chart's actual multi-cloud support and the public docs.Audit evidence: https://github.com/DataDog/claude-marketplace/pull/2216#issuecomment-4543572562
Changes
kubeVersion: ">= 1.25.0-0"added toChart.yaml. Today the K8s 1.25+ requirement is documented in two places (README Prereqs and the public install page) but not enforced —helm installaccepts older clusters and customers hit obscure runtime failures. The-0suffix accepts cloud-vendor variants like1.25.0-eks-abc.README Prerequisites section rewritten from AWS-only to multi-cloud:
values.yamlhas had a fullazure:block; the public install docs cover EKS / GKE / AKS / self-managed K8s;quickwit-storageregisters S3 + Azure + GCS + S3-compat factories.image.tagdefault in the values table — was documented asdevel, actually defaults to the chart'sappVersionwhen unset (currentlyv0.1.26). Customers reading the README expected one tag and got another.azure.*rows added to the values table so the Azure configuration surface is discoverable from the README. (Nogcp.*rows because GCP uses Workload Identity, wired viaserviceAccount.extraAnnotations— no chart-key gap there.)Both
README.mdandREADME.md.gotmplare edited so the change survives whichever path future regeneration takes.Test plan
helm lint charts/cloudprempasses locally.helm installagainst a K8s 1.24 cluster now fails withchart requires kubeVersion ">= 1.25.0-0".helm installagainst a K8s 1.25+ cluster still installs cleanly with noimage.tagoverride.README.md(e.g. via artifacthub preview) matches the values-table additions.0.4.1reads cleanly to the chart-team reviewer.🤖 Generated with Claude Code