Skip to content

Commit 0792567

Browse files
committed
docs(v1): align migration guide with shipped k8s behavior and v1 deprecation policy
The overview claimed GetKubernetesClientFromOptionsContextE returns the load error on kubeconfig failure, but the shipped code at modules/k8s/client.go:75-85 still falls back to in-cluster auth (now logged instead of silent). Reword to match what actually shipped, and clarify the InClusterAuth opt-in. The azure migration guide said deprecated aliases stay "for one minor release", which contradicts the README and overview commitment to keep them for the entire v1 line. Aligned to the v1 line. OSS-3453.
1 parent 7518994 commit 0792567

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

docs/_docs/03_migrating-to-v1/azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Once imports are updated, expect three follow-on edits per file:
8484

8585
Four client factories were renamed to drop the redundant `New` (a
8686
`Create*New*Client` reads as redundant). The old names remain as deprecated
87-
aliases for one minor release; please update at your convenience.
87+
aliases for the v1 line; please update at your convenience.
8888

8989
| Old name | New name |
9090
| --- | --- |

docs/_docs/03_migrating-to-v1/overview.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,17 @@ can inject a pre-built SDK client. This parallels the Azure
133133

134134
### Kubernetes
135135

136-
`GetKubernetesClientFromOptionsContextE` no longer falls back silently
137-
to `rest.InClusterConfig()` when an explicit kubeconfig path or
138-
context fails to load. It now returns the load error.
136+
`GetKubernetesClientFromOptionsContextE` now logs the kubeconfig load
137+
error before falling back to `rest.InClusterConfig()`; previously the
138+
fallback was silent.
139139

140140
This was a silent-failure footgun: a typo in
141-
`KubectlOptions.ConfigPath` would cause tests to run against the test
142-
runner's in-cluster identity (potentially a different cluster) with no
143-
error returned. If you relied on the fallback, set
144-
`KubectlOptions.InClusterAuth = true` to opt in explicitly.
141+
`KubectlOptions.ConfigPath` would send tests against the test runner's
142+
in-cluster identity (potentially a different cluster) with no signal
143+
that anything had happened. v1 surfaces the error in the test log, and
144+
adds an explicit `KubectlOptions.InClusterAuth = true` opt-in that
145+
skips kubeconfig loading entirely for callers who want fully explicit
146+
auth.
145147

146148
## Other deprecations you can defer
147149

0 commit comments

Comments
 (0)