Skip to content

Commit

Permalink
📖 add note to clarify that envtest binaries are no longer produced by…
Browse files Browse the repository at this point in the history
… Kubebuilder
  • Loading branch information
camilamacedo86 committed Jul 11, 2024
1 parent 8154896 commit 1248eee
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
33 changes: 32 additions & 1 deletion docs/book/src/reference/artifacts.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,40 @@
# Artifacts

<aside class="note warning">
<h1>IMPORTANT: Kubebuilder no longer produces artifacts</h1>

Kubebuilder has been building those artifacts binaries to allow users
uses [ENV TEST][env-test-doc] functionality provided by [controller-runtime][controller-runtime]
for several years. However, Google Cloud Platform has [deprecated the Container Registry](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr),
which has been used to build and promote these tar of binaries.

Additionally, ongoing changes and the phase-out of the previous GCP infrastructure mean
that **Kubebuilder maintainers are no longer able to support, build, or ensure the promotion of these binaries.**

Therefore, since those has been building to allow the controller-runtime
[ENV TEST][env-test-doc] libary work it has been started to be build by [controller-runtime][controller-runtime] itself
under [controller-gen releases page][controller-gen]. From [controller-runtime][controller-runtime]
release `v0.19.0` the binaries will began to be pulled out from this page instead.
For more information see the PR that introduces this change [here](https://github.com/kubernetes-sigs/controller-runtime/pull/2811).

</aside>

Kubebuilder publishes test binaries and container images in addition
to the main binary releases.

## Test Binaries
## **(Deprecated)** - Test Binaries (Used by ENV TEST)

You can find test binary tarballs for all Kubernetes versions and host platforms at `https://go.kubebuilder.io/test-tools`.
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}`.

<aside class="note">
<h1>Setup ENV TEST tool</h1>
To know more about the tooling used to configure ENVTEST which is used in the setup-envtest target in the Makefile
of the projects build with Kubebuilder see the [README](https://github.com/kubernetes-sigs/controller-runtime/blob/main/tools/setup-envtest/README.md)
of its tooling.
</aside>


[env-test-doc]: ./envtest.md
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
[controller-gen]: https://github.com/kubernetes-sigs/controller-tools/releases
7 changes: 7 additions & 0 deletions docs/book/src/reference/envtest.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,13 @@ testEnv = &envtest.Environment{
}
```
<aside class="note">
<h1>Setup ENV TEST tool</h1>
To know more about the tooling used to configure ENVTEST which is used in the setup-envtest target in the Makefile
of the projects build with Kubebuilder see the [README](https://github.com/kubernetes-sigs/controller-runtime/blob/main/tools/setup-envtest/README.md)
of its tooling.
</aside>
[metrics]: https://book.kubebuilder.io/reference/metrics.html
[envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
[setup-envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest
Expand Down

0 comments on commit 1248eee

Please sign in to comment.