You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/book/src/reference/versions.md
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,6 +80,41 @@ The table below documents support matrix for Cluster API versions (versions olde
80
80
| v1.1.x | EOL | EOL since 2023-03-28 - v1.4.0 release date |
81
81
| v1.0.x | EOL | EOL since 2022-12-01 - v1.3.0 release date |
82
82
83
+
<asideclass="note warning">
84
+
85
+
<h1>Warning</h1>
86
+
87
+
When importing Cluster API go modules as a dependency, you MUST consider any Cluster API behaviour that is not defined
88
+
by an API field or by a well-defined extension point, as a Cluster API internal implementation detail, and internal
89
+
implementation details can change at any time.
90
+
91
+
Accordingly, in order to not expose users of projects importing Cluster API go modules as a dependency to the risk
92
+
that issue arises when one of the Cluster API internal behavior changes, you MUST NOT rely on any Cluster API
93
+
internal behaviours.
94
+
95
+
Please note that this applies to any public go func or types; As a only and notable exception, maintainers
96
+
are committed to avoid as much as possible breaking changes within the same minor release for the following packages:
97
+
- /util/*
98
+
- /cmd/clusterctl/client
99
+
100
+
The Cluster API maintainers welcome feedback and contributions to improve project's extensibility point,
101
+
please [open an issue](https://github.com/kubernetes-sigs/cluster-api/issues/new?assignees=&labels=&template=feature_request.md) on the Cluster API repo or add an item to the agenda in the [Cluster API community meeting](https://git.k8s.io/community/sig-cluster-lifecycle/README.md#cluster-api).
102
+
103
+
</aside>
104
+
105
+
<asideclass="note warning">
106
+
107
+
<h1>Warning</h1>
108
+
109
+
Forks of the CLuster API project are not recommended, instead, Cluster API maintainers welcome feedback and contributions
110
+
to improve project's extensibility point, please [open an issue](https://github.com/kubernetes-sigs/cluster-api/issues/new?assignees=&labels=&template=feature_request.md) on the Cluster API repo or add an item
111
+
to the agenda in the [Cluster API community meeting](https://git.k8s.io/community/sig-cluster-lifecycle/README.md#cluster-api).
112
+
113
+
If a user still wants to fork this project, please note that it is up to the user to validate if the fork works
114
+
properly and maintainers will not provide any support or guarantee on these kind of integrations/usage.
115
+
116
+
</aside>
117
+
83
118
#### Skip upgrades
84
119
85
120
Cluster API supports at maximum n-3 minor version skip upgrades.
@@ -286,6 +321,17 @@ See [Cluster API release support](#cluster-api-release-support) and [Kubernetes
286
321
287
322
See also [Kubernetes version specific notes](#kubernetes-version-specific-notes).
288
323
324
+
<asideclass="note warning">
325
+
326
+
<h1>Warning</h1>
327
+
328
+
Cluster API is tested with upstream, fully conformant, Kubernetes releases.
329
+
330
+
It might be possible to use Cluster API also with non conformant Kubernetes releases, but it is up to users
331
+
to validate if this works and the project does not provide any support or guarantees for these kind of deployments.
0 commit comments