docs: autogenerate tested k8s versions and centralize config #14176

MasonM · 2025-02-11T02:15:41Z

Motivation

The Kubernetes Compatibility Matrix table at https://argo-workflows.readthedocs.io/en/latest/releases/ is misleading, since it isn't actually representing what versions are being tested (Slack conversation).

ArgoCD autogenerates the corresponding table for released versions, and includes a message for latest telling the user to switch to a release:

Modifications

The original version of this PR was based on argoproj/argo-cd#14180, but I subsequently rewrote it to get rid of the table and only show a single sentence with the tested Kubernetes versions.

I also updated .devcontainer/pre-build.sh to use the same hack/k8s-versions.sh script for determining the k3d version, which eliminates the need to update that file when upgrading Kubernetes.

Verification

$ . hack/k8s-versions.sh; echo "${K8S_VERSIONS[*]}"
v1.32.1 v1.29.13

$ ./hack/docs/tested-versions.sh 
This version is tested under Kubernetes v1.29.13 and v1.32.1.

Documentation

Verified this works on release branches by running git tag v3.6.9, then running make docs-serve and visiting http://127.0.0.1:8000/en/latest/releases/#tested-versions:

The `Kubernetes Compatibility Matrix` table at https://argo-workflows.readthedocs.io/en/latest/releases/ is misleading, since it isn't actually representing what versions are being tested ([Slack conversation](https://cloud-native.slack.com/archives/C0510EUH90V/p1732621744050569)). This makes it so that table is autogenerated for every release branch, while for `latest` it'll show a message telling the user to switch to a version. That's identical to what ArgoCD is currently doing, e.g.: * https://argo-cd.readthedocs.io/en/latest/operator-manual/installation/#tested-versions * https://argo-cd.readthedocs.io/en/release-2.9/operator-manual/installation/#tested-versions See argoproj/argo-cd#14180 for the corresponding PR on Argo CD, which is what I based this on, but I made several simplifications (e.g. instead of using switching to old release branches in `supported-versions.sh`, I had it just use `git grep` to directly extract the relevant version data). I also updated `.devcontainer/pre-build.sh` to use the same `hack/k8s-versions.sh` script for determining the k3d version, which eliminates the need to update that file when upgrading Kubernetes. Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com>

MasonM · 2025-02-11T02:43:47Z

/retest

rohankmr414 · 2025-02-12T05:02:49Z

docs/tested-kubernetes-versions.md

@@ -0,0 +1 @@
+This page is populated for released Argo Workflows versions. Use the version selector to view this table for a specific version.


Does this mean that we will only generate the table on releases? If that's the case should we manually add the matrix here until the next release is made?

Correct, this file will be only be replaced with the table when the Docs workflow is run on release branches. But that doesn't make this message inaccurate, because the release branches will still have old docs containing the Kubernetes Compatibility Matrix table.

Also, using the cherry-pick bot that @Joibel just added (#14151), it should be easy to cherry-pick this onto release-3.6.

rohankmr414

LGTM

Joibel

I like this, but question the table containing "other" versions than the one we're looking at.

I believe this will need manually running when we cherry-pick backwards otherwise docs linting will fail, but that's fine.

Joibel · 2025-02-14T08:47:57Z

hack/docs/supported-versions.sh

+echo "| Argo Workflows version | Kubernetes versions |"
+echo "|------------------------|---------------------|"
+
+for n in 0 1 2; do


Why iterate back like this at all? Why not force the user to look at the page for the version they are using instead?

The table for other release numbers may be wrong as an update to k8s version may have occurred on their branch but a release not happened. If we cherry-pick this back to 3.5 then it will iterate back to 3.3 which is even more unsupported than 3.4, and at some point this breaks with a 4.0 release. And at 3.7 release 3.6 will continue to want to document 3.4.

I'd rather we always displayed the "version selector" sentence, and just showed the current branch.

We do lose the version information for main/latest which is probably a healthy thing, so I agree with that.

If a user is on an older Kubernetes version and they want to determine what version(s) of Argo Workflows they can use, then a table provides a better user experience than manually switching between versions. But that's probably not common enough to be worth the extra complexity, so I went ahead and rewrote this to only print a single sentence with the tested Kubernetes versions for the current version. That means hack/k8s-versions.sh no longer needs to be compatible with old release branches, so I updated it to be a simple config file that defines the minimum and maximum Kubernetes versions, which is cleaner.

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com>

MasonM · 2025-02-15T05:57:04Z

/retest

Joibel · 2025-02-17T10:44:31Z

hack/k8s-versions.sh

Nice, I like this

Joibel · 2025-02-17T10:44:56Z

/cherry-pick release-3.6

Joibel · 2025-02-17T10:45:04Z

/cherry-pick release-3.5

gcp-cherry-pick-bot · 2025-02-17T10:45:14Z

Cherry-pick failed with Merge error f5d59e9a69460196545652f89b351ee60107db0e into temp-cherry-pick-2eab32-release-3.6

gcp-cherry-pick-bot · 2025-02-17T10:45:18Z

Cherry-pick failed with Merge error f5d59e9a69460196545652f89b351ee60107db0e into temp-cherry-pick-2eab32-release-3.5

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> (cherry picked from commit f5d59e9)

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> (cherry picked from commit f5d59e9) Signed-off-by: Alan Clucas <alan@clucas.org>

… (release-3.6) (#14262) Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: Mason Malone <651224+MasonM@users.noreply.github.com>

Accidental bump from #14176 cherry-pick Signed-off-by: Alan Clucas <alan@clucas.org>

…abilities fixes (Cr 28355) (#358) * fix: bump deps for k8schain to fix ecr-login (argoproj#14008) (release-3.6 cherry-pick) (argoproj#14174) * fix(ci): python sdk release process (release-3.6) (argoproj#14183) Signed-off-by: Alan Clucas <alan@clucas.org> * docs: clarify qps/burst on controller (cherry-pick argoproj#14190) (argoproj#14192) Signed-off-by: Tim Collins <tim@thecollins.team> Co-authored-by: Tim Collins <45351296+tico24@users.noreply.github.com> * fix(api/jsonschema): use unchanging JSON Schema version (cherry-pick argoproj#14092) (argoproj#14256) Signed-off-by: Roger Peppe <rogpeppe@gmail.com> Co-authored-by: Roger Peppe <rogpeppe@gmail.com> * fix(api/jsonschema): use working `$id` (cherry-pick argoproj#14257) (argoproj#14258) Signed-off-by: Roger Peppe <rogpeppe@gmail.com> Co-authored-by: Roger Peppe <rogpeppe@gmail.com> * docs: autogenerate tested k8s versions and centralize config (argoproj#14176) (release-3.6) (argoproj#14262) Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: Mason Malone <651224+MasonM@users.noreply.github.com> * chore(deps): bump minio-go to newer version (argoproj#14185) (release-3.6) (argoproj#14261) Co-authored-by: Vaibhav Kaushik <vaibhavkaushik@salesforce.com> * fix: split pod controller from workflow controller (argoproj#14129) (release-3.6) (argoproj#14263) * chore(deps): fix snyk (argoproj#14264) (release-3.6) (argoproj#14268) * chore: revert to correct k8s versions Accidental bump from argoproj#14176 cherry-pick Signed-off-by: Alan Clucas <alan@clucas.org> * chore(deps): bump github.com/go-jose/go-jose/v3 from 3.0.3 to 3.0.4 in the go_modules group (cherry-pick argoproj#14231) (argoproj#14269) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: wait for workflow informer to sync before pod informer (cherry-pick argoproj#14248) (argoproj#14266) Signed-off-by: Rohan K <rohankmr414@gmail.com> Co-authored-by: Rohan K <rohankmr414@gmail.com> * fix(cli): remove red from log colour selection. Fixes argoproj#6740 (cherry-pick argoproj#14215) (argoproj#14278) Signed-off-by: Prabakaran Kumaresshan <4676330+nixphix@users.noreply.github.com> Co-authored-by: Prabakaran Kumaresshan <4676330+nixphix@users.noreply.github.com> * fix: correct semaphore configmap keys for multiple semaphores (argoproj#14184) (release-3.6) (argoproj#14281) * fix: don't print help for non-validation errors. Fixes argoproj#14234 (cherry-pick argoproj#14249) (argoproj#14283) Signed-off-by: Koichi Shimada <jumpe1programming@gmail.com> Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> Co-authored-by: koichi <51446844+jumpe1@users.noreply.github.com> Co-authored-by: Mason Malone <651224+MasonM@users.noreply.github.com> * docs: fix kubernetes versions (release-3.6) (argoproj#14273) Signed-off-by: Alan Clucas <alan@clucas.org> * fix(workflow/sync): use RWMutex to prevent concurrent map access (cherry-pick argoproj#14321) (argoproj#14322) Signed-off-by: Ryan Currah <ryan@currah.ca> Co-authored-by: Ryan Currah <ryan@currah.ca> * chore(lint): update golangci-lint to 2.1.1 (argoproj#14390) (cherry-pick release-3.6) (argoproj#14417) * chore: bump golang 1.23->1.24 (argoproj#14385) (cherry-pick release-3.6) (argoproj#14418) * fix: gracefully handle invalid CronWorkflows and simplify logic. (cherry-pick argoproj#14197) (argoproj#14419) Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> * fix: prevent dfs sorter infinite recursion on cycle. Fixes argoproj#13395 (cherry-pick argoproj#14391) (argoproj#14420) Signed-off-by: Adrien Delannoy <a.delannoyfr@gmail.com> Co-authored-by: Adrien Delannoy <a.delannoyfr@gmail.com> * chore(deps): bump github.com/expr-lang/expr from 1.16.9 to 1.17.0 (argoproj#14307) (release-3.6) (argoproj#14421) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps)!: update k8s and argo-events (release-3.6) (argoproj#14424) Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: william.vanhevelingen <william.vanhevelingen@acquia.com> Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> Signed-off-by: William Van Hevelingen <william.vanhevelingen@acquia.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Van Hevelingen <William.VanHevelingen@acquia.com> Co-authored-by: Mason Malone <651224+MasonM@users.noreply.github.com> * fix: correct retry logic (argoproj#13734) (release-3.6) (argoproj#14428) Signed-off-by: isubasinghe <isitha@pipekit.io> Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: Isitha Subasinghe <isitha@pipekit.io> * fix: manual retries exit handler cleanup. Fixes argoproj#14180 (argoproj#14181) (release-3.6) (argoproj#14429) Signed-off-by: isubasinghe <isitha@pipekit.io> Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: Isitha Subasinghe <isitha@pipekit.io> * fix: correct manual retry logic. Fixes argoproj#14124 (argoproj#14328) (release-3.6) (argoproj#14430) Signed-off-by: oninowang <oninowang@tencent.com> Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: jswxstw <jswxstw@gmail.com> * fix: disable ALPN in argo-server as a workaround (argoproj#14433) Signed-off-by: Alan Clucas <alan@clucas.org> * result of codegen Signed-off-by: Kim <kim.aharfi@codefresh.io> * fix:lint Signed-off-by: Kim <kim.aharfi@codefresh.io> --------- Signed-off-by: Alan Clucas <alan@clucas.org> Signed-off-by: Tim Collins <tim@thecollins.team> Signed-off-by: Roger Peppe <rogpeppe@gmail.com> Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Rohan K <rohankmr414@gmail.com> Signed-off-by: Prabakaran Kumaresshan <4676330+nixphix@users.noreply.github.com> Signed-off-by: Koichi Shimada <jumpe1programming@gmail.com> Signed-off-by: Ryan Currah <ryan@currah.ca> Signed-off-by: Adrien Delannoy <a.delannoyfr@gmail.com> Signed-off-by: william.vanhevelingen <william.vanhevelingen@acquia.com> Signed-off-by: William Van Hevelingen <william.vanhevelingen@acquia.com> Signed-off-by: isubasinghe <isitha@pipekit.io> Signed-off-by: oninowang <oninowang@tencent.com> Signed-off-by: Kim <kim.aharfi@codefresh.io> Co-authored-by: Alan Clucas <alan@clucas.org> Co-authored-by: gcp-cherry-pick-bot[bot] <98988430+gcp-cherry-pick-bot[bot]@users.noreply.github.com> Co-authored-by: Tim Collins <45351296+tico24@users.noreply.github.com> Co-authored-by: Roger Peppe <rogpeppe@gmail.com> Co-authored-by: Mason Malone <651224+MasonM@users.noreply.github.com> Co-authored-by: Vaibhav Kaushik <vaibhavkaushik@salesforce.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rohan K <rohankmr414@gmail.com> Co-authored-by: Prabakaran Kumaresshan <4676330+nixphix@users.noreply.github.com> Co-authored-by: koichi <51446844+jumpe1@users.noreply.github.com> Co-authored-by: Ryan Currah <ryan@currah.ca> Co-authored-by: Adrien Delannoy <a.delannoyfr@gmail.com> Co-authored-by: William Van Hevelingen <William.VanHevelingen@acquia.com> Co-authored-by: Isitha Subasinghe <isitha@pipekit.io> Co-authored-by: jswxstw <jswxstw@gmail.com>

MasonM marked this pull request as ready for review February 11, 2025 02:58

MasonM requested review from Joibel and blkperl February 11, 2025 02:58

rohankmr414 reviewed Feb 12, 2025

View reviewed changes

rohankmr414 added the area/docs Incorrect, missing, or mistakes in docs label Feb 12, 2025

MasonM requested a review from rohankmr414 February 13, 2025 04:42

rohankmr414 approved these changes Feb 13, 2025

View reviewed changes

Joibel reviewed Feb 14, 2025

View reviewed changes

docs: get rid of the table and simplify code

d1cb3e4

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com>

MasonM changed the title ~~docs: autogenerate tested k8s version table~~ docs: autogenerate tested k8s versions and centralize config Feb 15, 2025

MasonM added 2 commits February 14, 2025 21:15

ci: typo

736b16c

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com>

ci: fix

334ea59

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com>

MasonM requested a review from Joibel February 15, 2025 06:10

MasonM mentioned this pull request Feb 15, 2025

ci: drop support for k8s 1.29 and centralize config #14196

Merged

Joibel approved these changes Feb 17, 2025

View reviewed changes

hack/k8s-versions.sh

Copy link

Member

Joibel Feb 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I like this

Joibel merged commit f5d59e9 into argoproj:main Feb 17, 2025
32 checks passed

Joibel mentioned this pull request Mar 6, 2025

Release v3.6 patch releases discussion #14259

Open

Joibel pushed a commit that referenced this pull request Mar 6, 2025

docs: autogenerate tested k8s versions and centralize config (#14176)

a8cfb94

Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> (cherry picked from commit f5d59e9)

Joibel added a commit that referenced this pull request Mar 7, 2025

chore: revert to correct k8s versions

f8a39ef

Accidental bump from #14176 cherry-pick Signed-off-by: Alan Clucas <alan@clucas.org>

This was referenced Mar 7, 2025

docs: fix kubernetes versions #14274

Merged

docs: fix kubernetes versions (release-3.6) #14273

Merged

		@@ -0,0 +1 @@
		This page is populated for released Argo Workflows versions. Use the version selector to view this table for a specific version.

docs: autogenerate tested k8s versions and centralize config #14176

docs: autogenerate tested k8s versions and centralize config #14176

Uh oh!

Conversation

MasonM commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Modifications

Verification

Documentation

Uh oh!

MasonM commented Feb 11, 2025

Uh oh!

rohankmr414 Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

MasonM Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

rohankmr414 left a comment

Choose a reason for hiding this comment

Uh oh!

Joibel left a comment

Choose a reason for hiding this comment

Uh oh!

Joibel Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

MasonM Feb 15, 2025

Choose a reason for hiding this comment

Uh oh!

MasonM commented Feb 15, 2025

Uh oh!

Joibel Feb 17, 2025

Choose a reason for hiding this comment

Uh oh!

Joibel commented Feb 17, 2025

Uh oh!

Joibel commented Feb 17, 2025

Uh oh!

Uh oh!

gcp-cherry-pick-bot bot commented Feb 17, 2025

Uh oh!

gcp-cherry-pick-bot bot commented Feb 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MasonM commented Feb 11, 2025 •

edited

Loading