From bc87d3dc4c6f189cda67c1797caa30fecfa13bb2 Mon Sep 17 00:00:00 2001 From: enxebre Date: Tue, 25 Jun 2024 16:09:14 +0200 Subject: [PATCH] Deprecate obsolete errors pkg The /errors package has its origin in when capi providers were machineActuators that needed to vendor core capi to function. There's no usage recommendations and value is questionable since we moved to CRDs and conditions for interoperability between core and providers. I think we should deprecate it and if there's any use case relying on it we should support it via conditions --- docs/book/src/SUMMARY.md | 1 + .../providers/migrations/v1.8-to-v1.9.md | 22 +++++++++++++++++++ errors/doc.go | 2 ++ 3 files changed, 25 insertions(+) create mode 100644 docs/book/src/developer/providers/migrations/v1.8-to-v1.9.md diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 24c09d956358..6b0ea44aaa80 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -98,6 +98,7 @@ - [v1.5 to v1.6](./developer/providers/migrations/v1.5-to-v1.6.md) - [v1.6 to v1.7](./developer/providers/migrations/v1.6-to-v1.7.md) - [v1.7 to v1.8](./developer/providers/migrations/v1.7-to-v1.8.md) + - [v1.8 to v1.9](./developer/providers/migrations/v1.8-to-v1.9.md) - [Provider contracts](./developer/providers/contracts.md) - [Cluster Infrastructure](./developer/providers/cluster-infrastructure.md) - [Machine Infrastructure](./developer/providers/machine-infrastructure.md) diff --git a/docs/book/src/developer/providers/migrations/v1.8-to-v1.9.md b/docs/book/src/developer/providers/migrations/v1.8-to-v1.9.md new file mode 100644 index 000000000000..45f500ff0886 --- /dev/null +++ b/docs/book/src/developer/providers/migrations/v1.8-to-v1.9.md @@ -0,0 +1,22 @@ +# Cluster API v1.8 compared to v1.9 + +This document provides an overview over relevant changes between Cluster API v1.8 and v1.9 for +maintainers of providers and consumers of our Go API. + +## Go version + +- The Go version used by Cluster API is Go 1.22.x + +## Changes by Kind + +### Deprecation + +### Removals + +### API Changes + +### Other + +### Suggested changes for providers + +- The Errors package was created when capi provider implementation was running as machineActuators that needed to vendor core capi to function. There is no usage recommendations today and its value is questionable since we moved to CRDs that inter-operate mostly via conditions. Instead we plan to drop the dedicated semantic for terminal failure and keep improving Machine lifecycle signal through conditions. Therefore the Errors package [has been deprecated in v1.8](https://github.com/kubernetes-sigs/cluster-api/issues/10784). It's recommented to remove any usage of the currently exported variables. diff --git a/errors/doc.go b/errors/doc.go index 3cecc22a2da7..bbe4e9a40b43 100644 --- a/errors/doc.go +++ b/errors/doc.go @@ -15,4 +15,6 @@ limitations under the License. */ // Package errors makes a set of error message handlers available for use by Cluster API Providers. +// +// Deprecated: This package will be removed in one of the next releases. package errors