Skip to content

Commit 0705559

Browse files
committed
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
1 parent 703cc70 commit 0705559

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Cluster API v1.8 compared to v1.9
2+
3+
This document provides an overview over relevant changes between Cluster API v1.8 and v1.9 for
4+
maintainers of providers and consumers of our Go API.
5+
6+
## Go version
7+
8+
- The Go version used by Cluster API is Go 1.22.x
9+
10+
## Changes by Kind
11+
12+
### Deprecation
13+
14+
### Removals
15+
16+
### API Changes
17+
18+
### Other
19+
20+
### Suggested changes for providers
21+
22+
- 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.

errors/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,6 @@ limitations under the License.
1515
*/
1616

1717
// Package errors makes a set of error message handlers available for use by Cluster API Providers.
18+
//
19+
// Deprecated: This package will be removed in one of the next releases.
1820
package errors

0 commit comments

Comments
 (0)