Skip to content

Commit cfdbc18

Browse files
📖 Upgrade controller-gen used to generated the docs and remove redirects for artefact images
This PR update the deps used to generate the data in the docs. It should update the markers to address #4009 Furthermore, for we are able to move forward here we need to remove the redirect for `https://go.kubebuilder.io/images` and `gcr.io/kubebuilder/thirdparty` which are deprecated and/or no longer used. We are either adding a note in the in the Artefacts page to clarify that ENV TEST binaries are no longer produced by Kubebuilder and its build and promotion was moved to controller-gen. Close: #4009
1 parent c8f4c5f commit cfdbc18

File tree

4 files changed

+44
-33
lines changed

4 files changed

+44
-33
lines changed

‎docs/book/install-and-build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ chmod +x /tmp/mdbook
7171

7272
echo "grabbing the latest released controller-gen"
7373
go version
74-
go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.12.1
74+
go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.15.0
7575

7676
# make sure we add the go bin directory to our path
7777
gobin=$(go env GOBIN)
Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,44 @@
11
# Artifacts
22

3+
# Artifacts
4+
5+
<aside class="note warning">
6+
<h1>IMPORTANT: Kubebuilder no longer produces artifacts</h1>
7+
8+
Kubebuilder has been building those artifacts binaries to allow users
9+
to use the [ENV TEST][env-test-doc] functionality provided by [controller-runtime][controller-runtime]
10+
for several years. However, Google Cloud Platform has [deprecated the Container Registry](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr),
11+
which has been used to build and promote these binaries tarballs.
12+
13+
Additionally, ongoing changes and the phase-out of the previous GCP infrastructure mean
14+
that **Kubebuilder maintainers are no longer able to build or ensure the promotion of these binaries.**
15+
16+
Therefore, since those have been building to allow the controller-runtime
17+
[ENV TEST][env-test-doc] library to work, it has been started to be built by [controller-runtime][controller-runtime] itself
18+
under the [controller-gen releases page][controller-gen]. From [controller-runtime][controller-runtime]
19+
release `v0.19.0` the binaries will begin to be pulled out from this page instead.
20+
For more information, see the PR that introduces this change [here](https://github.com/kubernetes-sigs/controller-runtime/pull/2811).
21+
22+
</aside>
23+
24+
325
Kubebuilder publishes test binaries and container images in addition
426
to the main binary releases.
527

6-
## Test Binaries
28+
## **(Deprecated)** - Test Binaries (Used by ENV TEST)
729

830
You can find test binary tarballs for all Kubernetes versions and host platforms at `https://go.kubebuilder.io/test-tools`.
931
You can find a test binary tarball for a particular Kubernetes version and host platform at `https://go.kubebuilder.io/test-tools/${version}/${os}/${arch}`.
1032

11-
## Container Images
33+
<aside class="note">
34+
<h1>Setup ENV TEST tool</h1>
35+
To know more about the tooling used to configure ENVTEST which is used in the setup-envtest target in the Makefile
36+
of the projects build with Kubebuilder see the [README][readme]
37+
of its tooling.
38+
</aside>
39+
1240

13-
You can find all container image versions for a particular platform at `https://go.kubebuilder.io/images/${os}/${arch}`
14-
or at `gcr.io/kubebuilder/thirdparty-${os}-${arch}`.
15-
You can find the container image for a particular Kubernetes version and host platform at `https://go.kubebuilder.io/images/${os}/${arch}/${version}`
16-
or at `gcr.io/kubebuilder/thirdparty-${os}-${arch}:${version}`.
41+
[env-test-doc]: ./envtest.md
42+
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
43+
[controller-gen]: https://github.com/kubernetes-sigs/controller-tools/releases
44+
[readme]: https://github.com/kubernetes-sigs/controller-runtime/blob/main/tools/setup-envtest/README.md

‎docs/book/src/reference/envtest.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,17 @@ testEnv = &envtest.Environment{
318318
}
319319
```
320320
321+
<aside class="note">
322+
<h1>Setup ENV TEST tool</h1>
323+
To know more about the tooling used to configure ENVTEST which is used in the setup-envtest target in the Makefile
324+
of the projects build with Kubebuilder see the [README][readme]
325+
of its tooling.
326+
</aside>
327+
321328
[metrics]: https://book.kubebuilder.io/reference/metrics.html
322329
[envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
323330
[setup-envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest
324331
[cert-manager]: https://book.kubebuilder.io/cronjob-tutorial/cert-manager.html
325332
[sdk-e2e-sample-example]: https://github.com/operator-framework/operator-sdk/tree/master/testdata/go/v4/memcached-operator/test/e2e
326333
[sdk]: https://github.com/operator-framework/operator-sdk
334+
[readme]: https://github.com/kubernetes-sigs/controller-runtime/blob/main/tools/setup-envtest/README.md

‎netlify.toml

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[build]
22
base = "docs/book"
3-
command = "GO_VERSION=1.20 ./install-and-build.sh"
3+
command = "GO_VERSION=1.22.0 ./install-and-build.sh"
44
publish = "docs/book/book"
55
functions = "docs/book/functions"
66

@@ -121,31 +121,6 @@
121121
status = 302
122122
force = true
123123

124-
# Image redirects.
125-
[[redirects]]
126-
from = "https://go.kubebuilder.io/images"
127-
to = "gcr.io/kubebuilder"
128-
status = 302
129-
force = true
130-
131-
[[redirects]]
132-
from = "https://go.kubebuilder.io/images/:os"
133-
to = "https://go.kubebuilder.io/images/:os/amd64"
134-
status = 302
135-
force = true
136-
137-
[[redirects]]
138-
from = "https://go.kubebuilder.io/images/:os/:arch"
139-
to = "gcr.io/kubebuilder/thirdparty-:os-:arch"
140-
status = 302
141-
force = true
142-
143-
[[redirects]]
144-
from = "https://go.kubebuilder.io/images/:os/:arch/:k8sversion"
145-
to = "gcr.io/kubebuilder/thirdparty-:os-:arch::k8sversion"
146-
status = 302
147-
force = true
148-
149124
# custom 404 handling -- this may need to be last -- netlify docs are unclear
150125
[[redirects]]
151126
from = "/*"

0 commit comments

Comments
 (0)