Sitelet https://github.com/rifelpet/kops/commit/f569953a9f544505a7d0037753fcf24db662c87f
Skip to content

Commit f569953

Browse files
rifelpetrifelpet
committed
docs: address review feedback on the dependency docs
Three changes, one per review comment: Say "dropping support for the oldest minor" rather than "dropping the oldest minor", since "dropping" now also reads as release terminology. Applied to the heading and to the reference's summary as well as the flagged line, so the doc stays consistent with itself. Record why the AWS cloud controller manager is no longer keyed on the Kubernetes minor. It was deliberately flattened in kubernetes#18649 because the provider is stable enough that one 1.x build works across every Kubernetes version kOps supports. That is a compatibility judgement, not something forced by the provider's backport policy. Also correct the claim while here: Azure carries a single pin but was never per-minor, so only AWS changed. Make the boundary between the two documents self-evident. Each now opens by saying what it is for and what it deliberately does not cover, so a reader landing on either one can tell immediately whether it is the page they want.
1 parent 38dcd8d commit f569953

3 files changed

Lines changed: 18 additions & 18 deletions

File tree

‎docs/contributing/new_kubernetes_version.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ kOps minor.
77

88
So "adding support" is not a single change. It is a handful of independent pull requests, each
99
landing when the upstream artifact it depends on actually exists — historically spread over several
10-
months. Dropping the oldest minor, by contrast, is one coherent pull request.
10+
months. Dropping support for the oldest minor, by contrast, is one coherent pull request.
1111

1212
Find the most recent example of whichever operation you are doing and mirror it:
1313

@@ -87,8 +87,11 @@ upstream component ships:
8787
| `pkg/model/components/etcdmanager/options.go` | feature-gate guards keyed on the minor |
8888
| `pkg/model/components/gcpcloudcontrollermanager.go` | a `switch` on the minor that currently has only a `default:` — it reads like dead code but is the intended hook |
8989

90-
The cloud controller managers for AWS and Azure are **no longer** keyed on the minor; they carry a
91-
single pinned image, so bump the string rather than adding a case.
90+
The AWS and Azure cloud controller managers are not keyed on the minor; they carry a single pinned
91+
image, so bump the string rather than adding a case. AWS used to have a per-minor `switch` and was
92+
deliberately flattened in #18649: the provider has been stable enough that a single 1.x build is
93+
compatible with every Kubernetes version kOps supports, which is a compatibility judgement rather
94+
than anything forced by the provider's backport policy. Azure has never been per-minor.
9295

9396
OpenStack is different again: its CCM and CSI image tags are *computed* from the cluster's
9497
Kubernetes minor in `upup/pkg/fi/cloudup/template_functions.go`. A new minor therefore produces new
@@ -107,7 +110,7 @@ is not out yet points back at the previous stable kOps.
107110

108111
Add a line to `docs/releases/1.NN-NOTES.md` under `## Kubernetes`.
109112

110-
## Dropping the oldest minor
113+
## Dropping support for the oldest minor
111114

112115
This is one pull request, and a large one — recent examples touched 90 to 276 files.
113116

‎docs/contributing/updating-dependencies.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Updating dependencies
22

3-
kOps pins third-party versions in a lot of places: Go modules, addon manifests, the binaries nodeup
4-
downloads onto nodes, GitHub Actions, e2e scenario charts, and the OS images in the channels. This
5-
page covers how to go about a dependency update and how to get the pull request merged.
3+
> **Read this if you are doing a dependency update.** It covers how to approach one and what is
4+
> expected of the change. It does not list the individual pins — for *where a given version lives
5+
> and what must be regenerated with it*, see the
6+
> [third-party dependency reference](../dependency-updates.md).
67
7-
For the mechanics of an individual pin — which file holds it, what else must change with it, and how
8-
to regenerate and verify — see the
9-
[third-party dependency reference](../dependency-updates.md), which enumerates every surface.
8+
kOps pins third-party versions in a lot of places: Go modules, addon manifests, the binaries nodeup
9+
downloads onto nodes, GitHub Actions, e2e scenario charts, and the OS images in the channels.
1010

1111
## Almost none of this is automated
1212

‎docs/dependency-updates.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# Updating Third-Party Dependencies
22

3-
A reference for every place kOps pins a third-party version. Each section names the file that holds
4-
the version, the files coupled to it, the regeneration command, and the verification command.
5-
6-
The contributor-facing companion,
7-
[updating dependencies](contributing/updating-dependencies.md), covers the surrounding workflow —
8-
how to structure the commits, what to say about the change, and the mistakes that have cost pull
9-
requests before.
3+
> **A lookup table, one entry per pin.** For each surface it names the file holding the version, the
4+
> files coupled to it, the regeneration command, and the verification command. It says nothing about
5+
> how to approach an update or what is expected of the change — that is
6+
> [updating dependencies](contributing/updating-dependencies.md).
107
118
Two mechanisms cut across almost every surface below. Read these first.
129

@@ -483,7 +480,7 @@ The etcd-manager tag also appears in checked-in expected output under
483480

484481
Adding or dropping a Kubernetes minor is a release-cycle activity rather than a dependency bump, and
485482
is not symmetric: adding support is several independent pull requests landing over months as each
486-
upstream artifact appears, while dropping the oldest minor is one large sweep. Both are described in
483+
upstream artifact appears, while dropping support for the oldest minor is one large sweep. Both are described in
487484
[Supporting a new Kubernetes version](contributing/new_kubernetes_version.md).
488485

489486
## OS images and AMIs

0 commit comments

Comments
 (0)