Skip to content

Commit 9fff985

Browse files
authored
Bump xref cleanup (#389)
* Continue URL migration batch - update cloud-api references, fix deprecation policy header * remaining updates * These topics are migrated to Bump * Missed edits * Missed edits
1 parent 0e55bbe commit 9fff985

30 files changed

+137
-621
lines changed

modules/ROOT/nav.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -431,16 +431,16 @@
431431
*** xref:manage:schema-reg/programmable-push-filters.adoc[Programmable Push Filters]
432432
*** xref:manage:schema-reg/edit-topic-configuration.adoc[Edit Topic Configuration]
433433
** xref:manage:api/index.adoc[Cloud API]
434-
*** xref:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart]
435-
*** xref:manage:api/cloud-api-overview.adoc[Cloud API Overview]
436-
*** xref:manage:api/cloud-api-authentication.adoc[Cloud API Authentication]
434+
*** link:/api/doc/cloud-controlplane/topic/topic-quickstart.adoc[Cloud API Quickstart]
435+
*** link:/api/doc/cloud-controlplane/topic/topic-cloud-api-overview.adoc[Cloud API Overview]
436+
*** link:/api/doc/cloud-controlplane/authentication.adoc[Cloud API Authentication]
437437
*** xref:manage:api/controlplane/index.adoc[Use the Control Plane API]
438438
**** xref:manage:api/cloud-byoc-controlplane-api.adoc[BYOC]
439439
**** xref:manage:api/cloud-dedicated-controlplane-api.adoc[Dedicated]
440440
**** xref:manage:api/cloud-serverless-controlplane-api.adoc[Serverless]
441441
*** xref:manage:api/cloud-dataplane-api.adoc[Use the Data Plane APIs]
442-
*** xref:manage:api/cloud-api-errors.adoc[Cloud API Errors and Status Codes]
443-
*** xref:manage:api/cloud-api-deprecation-policy.adoc[Cloud API Deprecation Policy]
442+
*** link:/api/doc/cloud-controlplane/topic/topic-error-and-status-codes.adoc[Cloud API Errors and Status Codes]
443+
*** link:/api/doc/cloud-controlplane/topic/topic-deprecation-policy.adoc[Cloud API Deprecation Policy]
444444
** xref:manage:terraform-provider.adoc[]
445445
446446
* xref:billing:index.adoc[Billing]
@@ -458,10 +458,10 @@
458458
*** xref:reference:tiers/byoc-tiers.adoc[]
459459
*** xref:reference:tiers/dedicated-tiers.adoc[]
460460
** xref:reference:api-reference.adoc[]
461-
*** xref:api:ROOT:cloud-controlplane-api.adoc[]
462-
*** xref:api:ROOT:cloud-dataplane-api.adoc[]
463-
*** xref:api:ROOT:pandaproxy-rest.adoc[]
464-
*** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
461+
*** link:/api/doc/cloud-controlplane/[Control Plane API]
462+
*** link:/api/doc/cloud-dataplane/[Data Plane APIs]
463+
*** link:/api/doc/http-proxy/[HTTP Proxy API]
464+
*** link:/api/doc/schema-registry/[Schema Registry API]
465465
** xref:reference:properties/index.adoc[]
466466
*** xref:reference:properties/cluster-properties.adoc[]
467467
*** xref:reference:properties/object-storage-properties.adoc[]

modules/develop/pages/connect/configuration/resource-management.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ Cloud UI::
139139
Data Plane API::
140140
+
141141
--
142-
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
143-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines[`GET /v1/redpanda-connect/pipelines`], which lists details of all pipelines on your cluster by ID.
142+
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API.
143+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-redpandaconnectservice_listpipelines[`GET /v1/redpanda-connect/pipelines`], which lists details of all pipelines on your cluster by ID.
144144
+
145145
* Memory (`memory_shares`) is displayed in megabytes. For example, `1` compute unit is `400M` or 400 MB.
146146
* CPU resources (`cpu_shares`) are displayed in milliCPU. For example, `1` compute unit is `100m` or 0.1 CPU.
@@ -167,9 +167,9 @@ Data Plane API::
167167
--
168168
You can only update CPU resources using the Data Plane API. For every 0.1 CPU that you allocate, Redpanda Cloud automatically reserves 400 MB of memory for the exclusive use of the pipeline.
169169
170-
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API, if you haven't already.
171-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines/-id-[`GET /v1/redpanda-connect/pipelines/\{id}`], including the ID of the pipeline you want to update. You'll use the returned values in the next step.
172-
. Now make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/redpanda-connect/pipelines/-id-[`PUT /v1/redpanda-connect/pipelines/\{id}`], to update the pipeline resources:
170+
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API, if you haven't already.
171+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-redpandaconnectservice_getpipeline[`GET /v1/redpanda-connect/pipelines/\{id}`], including the ID of the pipeline you want to update. You'll use the returned values in the next step.
172+
. Now make a request to link:/api/doc/cloud-dataplane/operation/operation-redpandaconnectservice_updatepipeline[`PUT /v1/redpanda-connect/pipelines/\{id}`], to update the pipeline resources:
173173
+
174174
* Reuse the values returned by your `GET` request to populate the request body.
175175
* Replace the `cpu_shares` value with the resources you want to allocate, and enter any valid value for `memory_shares`.
@@ -194,6 +194,6 @@ curl -X PUT "https://<data-plane-api-url>/v1/redpanda-connect/pipelines/xxx..."
194194
----
195195
+
196196
A successful response shows the updated resource allocations with the `cpu_shares` value returned in milliCPU.
197-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines[`GET /v1/redpanda-connect/pipelines`] to verify your pipeline resource updates.
197+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-redpandaconnectservice_listpipelines[`GET /v1/redpanda-connect/pipelines`] to verify your pipeline resource updates.
198198
--
199199
=====

modules/develop/pages/connect/configuration/secret-management.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Data Plane API::
3636
--
3737
You must use a Base64-encoded secret.
3838
39-
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
40-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/secrets[`POST /v1/secrets`].
39+
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API.
40+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-secretservice_createsecret[`POST /v1/secrets`].
4141
4242
[,bash]
4343
----
@@ -87,8 +87,8 @@ Data Plane API::
8787
--
8888
You must use a Base64-encoded secret.
8989
90-
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
91-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/secrets/-id-[`PUT /v1/secrets/\{id}`].
90+
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API.
91+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-secretservice_updatesecret[`PUT /v1/secrets/\{id}`].
9292
+
9393
[,bash]
9494
----
@@ -136,8 +136,8 @@ Data Plane API::
136136
+
137137
--
138138
139-
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
140-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#delete-/v1/secrets/-id-[`DELETE /v1/secrets/\{id}`].
139+
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API.
140+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-secretservice_deletesecret[`DELETE /v1/secrets/\{id}`].
141141
+
142142
[,bash]
143143
----

modules/develop/pages/managed-connectors/disable-kc.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Disable Kafka Connect
22
:description: Learn how to disable Kafka Connect using the Cloud API.
33

4-
Kafka Connect is disabled by default on new clusters. If you previously enabled Kafka Connect on a cluster and want to disable it, you can use the xref:manage:api/cloud-api-overview.adoc[Cloud API].
4+
Kafka Connect is disabled by default on new clusters. If you previously enabled Kafka Connect on a cluster and want to disable it, you can use the link:/api/doc/cloud-controlplane/topic/topic-cloud-api-overview[Cloud API].
55

66
NOTE: Redpanda Support does not manage or monitor Kafka Connect, but Support can enable the feature for your account.
77

@@ -30,13 +30,13 @@ If Kafka Connect is enabled, the response will show:
3030
== Prerequisites
3131

3232
- You have the cluster ID of a cluster that has Kafka Connect enabled.
33-
- You have a valid bearer token for the Cloud API. For details, see xref:manage:api/cloud-api-authentication.adoc[Authenticate to the API].
33+
- You have a valid bearer token for the Cloud API. For details, see link:/api/doc/cloud-controlplane/authentication[Authenticate to the API].
3434

3535
IMPORTANT: Make sure to stop any active connectors gracefully before disabling Kafka Connect to avoid data loss or incomplete processing.
3636

3737
== Disable Kafka Connect
3838

39-
After you are authenticated to the Cloud API, make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request, replacing `{cluster.id}` with your actual cluster ID.
39+
After you are authenticated to the Cloud API, make a link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/{cluster.id}`] request, replacing `{cluster.id}` with your actual cluster ID.
4040

4141
[,bash]
4242
----
@@ -46,7 +46,7 @@ curl -X PATCH "https://api.redpanda.com/v1/clusters/{cluster.id}" \
4646
-d '{"kafka_connect":{"enabled":false}}'
4747
----
4848

49-
The `PATCH` request returns the ID of a long-running operation. You can check the status of the operation by polling the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /operations/{id}`] endpoint:
49+
The `PATCH` request returns the ID of a long-running operation. You can check the status of the operation by polling the link:/api/doc/cloud-controlplane/operation/operation-operationservice_getoperation[`GET /operations/{id}`] endpoint:
5050

5151
[,bash]
5252
----

modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For existing BYOVPC clusters, contact https://support.redpanda.com/hc/en-us/requ
2828
* Access to an AWS project in which you create your cluster.
2929
* Minimum permissions in that AWS project. For the actions required by the user who will create the cluster with `rpk cloud byoc aws apply`, see https://github.com/redpanda-data/cloud-examples/blob/main/customer-managed/aws/terraform/iam_rpk_user.tf[`iam_rpk_user.tf`^].
3030
* Each BYOVPC cluster requires one allocated Elastic IP (EIP) address in AWS.
31-
* Familiarity with the Redpanda Cloud API. For example, you should be familiar with how to use the Cloud API to xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[authenticate] and xref:redpanda-cloud:manage:api/cloud-byoc-controlplane-api.adoc[create a cluster].
31+
* Familiarity with the Redpanda Cloud API. For example, you should be familiar with how to use the Cloud API to link:/api/doc/cloud-controlplane/authentication[authenticate] and xref:redpanda-cloud:manage:api/cloud-byoc-controlplane-api.adoc[create a cluster].
3232
* https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli[Terraform^] version 1.8.5 or later.
3333
* https://jqlang.org/download/[jq^], which is used to parse JSON values from API responses.
3434

@@ -139,7 +139,7 @@ export REDPANDA_RG_ID= #Retrieve the ID from the URL of the resource group when
139139
[TIP]
140140
====
141141
142-
* To get the Redpanda authentication credentials and resource group, follow the xref:manage:api/cloud-api-quickstart.adoc[].
142+
* To get the Redpanda authentication credentials, follow the link:/api/doc/cloud-controlplane/topic/authentication[Cloud API authentication guide]. You can link:/api/doc/cloud-controlplane/group/endpoint-resource-groups[use the API] to create a new resource group or use an existing one.
143143
* To see sample Terraform code of the expected provisioned resources, see the https://github.com/redpanda-data/cloud-examples/tree/main/customer-managed/aws[BYOVPC on AWS README^].
144144
====
145145

@@ -250,7 +250,7 @@ export CLOUD_STORAGE_BUCKET="$(terraform output -raw cloud_storage_bucket_arn)"
250250
export PERMISSIONS_BOUNDARY_POLICY="$(terraform output -raw permissions_boundary_policy_arn)"
251251
```
252252
+
253-
TIP: See the full list of zones and tiers available with each provider in the xref:api:ROOT:cloud-controlplane-api.adoc#api-description[Control Plane API reference].
253+
TIP: See the full list of zones and tiers available with each provider in the link:/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers[Control Plane API reference].
254254

255255
. Define a JSON file called `redpanda-cluster.json` that includes cluster information:
256256
+

modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ See the code for the complete list of resources required to create and deploy Re
2727

2828
* Access to an Azure subscription where you want to create your cluster
2929
* Knowledge of your internal VNet and subnet configuration
30-
* Permission to call the xref:manage:api/cloud-api-overview.adoc[Redpanda Cloud API]
30+
* Permission to call the link:/api/doc/cloud-controlplane/topic/topic-cloud-api-overview[Redpanda Cloud API]
3131
* Permission to create, modify, and delete the resources described by Terraform
3232
* https://developer.hashicorp.com/terraform/install[Terraform^] version 1.8.5 or later
3333
* https://jqlang.org/download/[jq^], which is used to parse JSON values from API responses
@@ -315,7 +315,7 @@ export BEARER_TOKEN=$(curl --request POST \
315315
--data audience=cloudv2-production.redpanda.cloud | jq -r '.access_token')
316316
```
317317

318-
TIP: To get the Redpanda authentication credentials, follow the xref:manage:api/cloud-api-quickstart.adoc[].
318+
TIP: To get the Redpanda authentication credentials, follow the link:/api/doc/cloud-controlplane/topic/authentication[authentication guide].
319319

320320
== Create network
321321

@@ -444,7 +444,7 @@ EOF
444444
```
445445
====
446446
+
447-
TIP: See the full list of zones and tiers available with each provider in the xref:api:ROOT:cloud-controlplane-api.adoc#api-description[Control Plane API reference].
447+
TIP: See the full list of zones and tiers available with each provider in the link:/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers[Control Plane API reference].
448448

449449
. Make a Cloud API call to create a Redpanda cluster and get the network ID from the response in JSON `.operation.metadata.network_id`.
450450
+

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ gcloud iam service-accounts add-iam-policy-binding <redpanda_connect-gcp-sa-acco
8787
```
8888
====
8989

90-
. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/\{cluster-id}`] request to update the cluster configuration.
90+
. Make a link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/\{cluster-id}`] request to update the cluster configuration.
9191
+
9292
.Show request
9393
[%collapsible]

modules/get-started/pages/cluster-types/byoc/gcp/enable-secrets-byovpc-gcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ gcloud iam service-accounts add-iam-policy-binding <redpanda_operator-gcp-sa-acc
8484
```
8585
====
8686

87-
. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/\{cluster-id}`] request to update the cluster configuration.
87+
. Make a link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/\{cluster-id}`] request to update the cluster configuration.
8888
+
8989
.Show request
9090
[%collapsible]

modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ This should be done in the Terraform of the reader cluster.
5151

5252
== Configure remote read replica
5353

54-
Add or remove reader clusters to a source cluster in Redpanda Cloud with the xref:redpanda-cloud:manage:api/controlplane/index.adoc[Cloud Control Plane API]. For information on accessing the Cloud API, see xref:manage:api/cloud-api-authentication.adoc[].
54+
Add or remove reader clusters to a source cluster in Redpanda Cloud with the xref:redpanda-cloud:manage:api/controlplane/index.adoc[Cloud Control Plane API]. For information on accessing the Cloud API, see the link:/api/doc/cloud-controlplane/authentication[authentication guide].
5555

56-
. To update your source cluster to add one or more reader cluster IDs, make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request. The full list of clusters is expected on every call. If an ID is removed from the list, it is removed as a reader cluster.
56+
. To update your source cluster to add one or more reader cluster IDs, make a link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/{cluster.id}`] request. The full list of clusters is expected on every call. If an ID is removed from the list, it is removed as a reader cluster.
5757
+
5858
```bash
5959
export SOURCE_CLUSTER_ID=.......
@@ -69,7 +69,7 @@ curl -X PATCH $API_HOST/v1/clusters/$SOURCE_CLUSTER_ID \
6969
EOF
7070
```
7171

72-
. Optional: To see the list of reader clusters on a given source cluster, make a xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`] request:
72+
. Optional: To see the list of reader clusters on a given source cluster, make a link:/api/doc/cloud-controlplane/operation/operation-clusterservice_getcluster[`GET /v1/clusters/\{id}`] request:
7373
+
7474
```bash
7575
export SOURCE_CLUSTER_ID=.......

0 commit comments

Comments
 (0)