Skip to content

Commit 85d0991

Browse files
kbatuigasmicheleRP
andauthored
Add deprecation notice for Cloud API (#306)
* Add deprecation notice for Cloud API * Add deprecation timeline dates * Apply suggestion from automated review * Update modules/get-started/pages/whats-new-cloud.adoc Co-authored-by: Michele Cyran <[email protected]> --------- Co-authored-by: Michele Cyran <[email protected]>
1 parent 7e7199b commit 85d0991

File tree

3 files changed

+48
-1
lines changed

3 files changed

+48
-1
lines changed

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ This page lists new features added to Redpanda Cloud.
99

1010
== May 2025
1111

12+
=== Cloud API beta versions: deprecated
13+
14+
The Cloud Control Plane API versions v1beta1 and v1beta2, and Data Plane API versions v1alpha1 and v1alpha2 are deprecated. These Cloud API versions will be removed in a future release and are not recommended for use.
15+
16+
The deprecation timeline is:
17+
18+
- Announcement date: May 27, 2025
19+
- End-of-support date: November 28, 2025
20+
- Retirement date: May 28, 2026
21+
22+
See xref:manage:api/cloud-api-deprecation-policy.adoc[] for more information.
23+
1224
=== Read-only cluster configuration properties
1325

1426
You can now xref:manage:cluster-maintenance/config-cluster.adoc#view-cluster-property-values[view the value of read-only cluster configuration properties] with `rpk cluster config` or with the Cloud API. Available properties are listed in xref:reference:properties/cluster-properties.adoc[Cluster Properties] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties].

modules/manage/pages/api/cloud-api-overview.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,19 @@ https://api.redpanda.com/v1/clusters
4949

5050
The current Control Plane API version is *v1*.
5151

52+
[IMPORTANT]
53+
====
54+
The Control Plane API versions v1beta1 and v1beta2 are deprecated. v1beta1 and v1beta2 are still available, but they will be removed in a future release and are not recommended for use.
55+
56+
The deprecation timeline is:
57+
58+
- Announcement date: May 27, 2025
59+
- End-of-support date: November 28, 2025
60+
- Retirement date: May 28, 2026
61+
62+
See xref:manage:api/cloud-api-deprecation-policy.adoc[] for more information.
63+
====
64+
5265
=== Data Plane APIs URL
5366

5467
The Data Plane API base URL is unique to the individual target cluster. It is different for each cluster. When making requests to the Data Plane API endpoints, the request URL is the base URL, plus the API version, plus the resource path. For example:
@@ -60,6 +73,19 @@ https://api-aeb32d9b.cn20bu40d061nvem7sv0.fmc.prd.cloud.redpanda.com/v1/users
6073

6174
The current Data Plane API version is *v1*.
6275

76+
[IMPORTANT]
77+
====
78+
The Data Plane API versions v1alpha1 and v1alpha2 are deprecated. v1alpha1 and v1alpha2 are still available, but they will be removed in a future release and are not recommended for use.
79+
80+
The deprecation timeline is:
81+
82+
- Announcement date: May 27, 2025
83+
- End-of-support date: November 28, 2025
84+
- Retirement date: May 28, 2026
85+
86+
See xref:manage:api/cloud-api-deprecation-policy.adoc[] for more information.
87+
====
88+
6389
== Pagination
6490

6591
When an endpoint returns a list containing more items than can be returned in a single response, the response object includes a `next_page_token`. You can pass the token value as a parameter in the next request. When the full list has been returned, `next_page_token` is an empty string.

modules/manage/pages/maintenance.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,15 @@ See also: xref:manage:api/cloud-api-deprecation-policy.adoc[]
115115
|===
116116
| Deprecated in | Feature | Details
117117

118+
| May 2025 | Cloud API beta versions a| The Cloud Control Plane API versions v1beta1 and v1beta2, and Data Plane API versions v1alpha1 and v1alpha2 are deprecated. These Cloud API versions will be removed in a future release and are not recommended for use.
119+
120+
The deprecation timeline is:
121+
122+
- Announcement date: May 27, 2025
123+
- End-of-support date: November 28, 2025
124+
- Retirement date: May 28, 2026
125+
126+
See xref:manage:api/cloud-api-deprecation-policy.adoc[] for more information.
118127
| March 2025 | Serverless Standard | For a better customer experience, the Serverless Standard and Serverless Pro products merged into a single offering. xref:get-started:cluster-types/serverless.adoc[Serverless clusters] include the higher usage limits, 99.9% SLA, additional regions, and the free trial.
119-
| February 2025 | Private Service Connect v1 | The Redpanda xref:networking:gcp-private-service-connect.adoc[GCP Private Service Connect v2] service provides the ability to allow requests from Private Service Connect endpoints to stay within the same availability zone, avoiding additional networking costs. To upgrade, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
128+
| February 2025 | Private Service Connect v1 | The Redpanda xref:networking:gcp-private-service-connect.adoc[GCP Private Service Connect v2] service provides the ability to allow requests from Private Service Connect endpoints to stay within the same availability zone, avoiding additional networking costs. To upgrade, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
120129
|===

0 commit comments

Comments
 (0)