Skip to content

Commit 9e11b10

Browse files
authored
DOC-1565 Disable KC with Cloud API (#381)
* DOC-1565 Disable KC with Cloud API * minor edit * minor edits * update What's New * incorporate review comments * review comments * update text for authenticating to API * add steps to verify if KC is enabled * Masa's example * update to ${AUTH_TOKEN} * gah, updated to $AUTH_TOKEN
1 parent ae2d15f commit 9e11b10

File tree

8 files changed

+76
-11
lines changed

8 files changed

+76
-11
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,7 @@
379379
** xref:develop:managed-connectors/index.adoc[Kafka Connect]
380380
*** xref:develop:managed-connectors/converters-and-serialization.adoc[Converters and serialization]
381381
*** xref:develop:managed-connectors/monitor-connectors.adoc[Monitor Connectors]
382+
*** xref:develop:managed-connectors/disable-kc.adoc[]
382383
*** xref:develop:managed-connectors/transforms.adoc[Single Message Transforms]
383384
*** xref:develop:managed-connectors/sizing-connectors.adoc[Sizing Connectors]
384385
*** xref:develop:managed-connectors/create-s3-sink-connector.adoc[AWS S3 Sink Connector]

modules/develop/pages/managed-connectors/converters-and-serialization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= Converters and Serialization
2-
:description: Use converters to handle the serialization and deserialization of data between a Redpanda topic and a managed connector.
2+
:description: Use converters to handle the serialization and deserialization of data between a Redpanda topic and an external system with Kafka Connect.
33
:page-aliases: deploy:deployment-option/cloud/managed-connectors/converters-and-serialization.adoc
44

55
include::shared:partial$kafka-connect.adoc[]
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
= Disable Kafka Connect
2+
:description: Learn how to disable Kafka Connect using the Cloud API.
3+
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].
5+
6+
NOTE: Redpanda Support does not manage or monitor Kafka Connect, but Support can enable the feature for your account.
7+
8+
== Verify Kafka Connect is enabled
9+
10+
If Kafka Connect is enabled on your cluster, you will see it configured on the *Connect* page in the Redpanda Cloud UI.
11+
12+
You can also verify with the Cloud API:
13+
14+
[,bash]
15+
----
16+
curl -sX GET "https://api.redpanda.com/v1/clusters/{cluster.id}" \
17+
-H "Authorization: Bearer $AUTH_TOKEN" \
18+
-H 'accept: application/json' | jq -r '.cluster.kafka_connect'
19+
----
20+
21+
Replace `{cluster.id}` with your actual cluster ID. You can find the cluster ID in the Redpanda Cloud UI. Look in the **Details** section of the cluster overview.
22+
23+
If Kafka Connect is enabled, the response will show:
24+
25+
[,bash]
26+
----
27+
"enabled": true
28+
----
29+
30+
== Prerequisites
31+
32+
- 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].
34+
35+
IMPORTANT: Make sure to stop any active connectors gracefully before disabling Kafka Connect to avoid data loss or incomplete processing.
36+
37+
== Disable Kafka Connect
38+
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.
40+
41+
[,bash]
42+
----
43+
curl -X PATCH "https://api.redpanda.com/v1/clusters/{cluster.id}" \
44+
-H "Authorization: Bearer $AUTH_TOKEN" \
45+
-H "Content-Type: application/json" \
46+
-d '{"kafka_connect":{"enabled":false}}'
47+
----
48+
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:
50+
51+
[,bash]
52+
----
53+
curl -X GET "https://api.redpanda.com/v1/operations/{operation.id}" \
54+
-H "Authorization: Bearer $AUTH_TOKEN" \
55+
-H "Content-Type: application/json"
56+
----
57+
58+
When the operation is complete, the status will show `"state": "STATE_COMPLETED"`. You can verify that Kafka Connect has been disabled by running the verification command from the previous section. The response should show:
59+
60+
[,bash]
61+
----
62+
"enabled": false
63+
----
64+

modules/develop/pages/managed-connectors/index.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
Use Kafka Connect to integrate your Redpanda data with different
77
data systems. As managed solutions, connectors offer a simpler way to integrate
88
your data than manually creating a solution with the Kafka API. You can set up
9-
and manage these connectors for BYOC and Dedicated clusters in the Redpanda Cloud UI or Cloud API. Note that you remain responsible
10-
for monitoring, alerting, and restarting Kafka Connect connectors, as these tasks
11-
are not managed or monitored by Redpanda Support.
9+
and manage these connectors for BYOC and Dedicated clusters in the Redpanda Cloud UI or Cloud API.
1210

1311
include::shared:partial$kafka-connect.adoc[]
1412

@@ -18,7 +16,7 @@ Each connector is either a source or a sink:
1816
The source connector's main task is to fetch data from these sources and convert
1917
them into a format suitable for Redpanda.
2018
* A sink connector exports data from a Redpanda cluster and pushes it into a
21-
target system. Sink connectors read the data from Redpanda and transform it into
19+
target system. Sink connectors read the data from Redpanda and transform it into
2220
a format that the target system can use.
2321
2422
These sources and sinks work together to create a data pipeline that can move and transform data from one system to another.

modules/develop/pages/managed-connectors/monitor-connectors.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
= Monitor Connectors
1+
= Monitor Kafka Connect
2+
:description: Use metrics to monitor the health of Kafka Connect.
23
:page-aliases: deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc
3-
:description: Use metrics to monitor the health of your Redpanda managed connectors.
4+
:description: Use metrics to monitor the health of Kafka Connect.
45

56
include::shared:partial$kafka-connect.adoc[]
67

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ xref:get-started:cluster-types/byoc/azure/create-byoc-cluster-azure.adoc[BYOC fo
2727

2828
=== Kafka Connect disabled on new clusters
2929

30-
xref:develop:managed-connectors/index.adoc[Kafka Connect] is now disabled by default on all new clusters. To unlock this feature for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]. Note that when Kafka Connect is enabled, there is a node running for Kafka Connect, even if connectors are not used.
30+
xref:develop:managed-connectors/index.adoc[Kafka Connect] is now disabled by default on all new clusters. To unlock this feature for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]. If you previously enabled Kafka Connect on a cluster and want to xref:develop:managed-connectors/disable-kc.adoc[disable it], you can use the Cloud API.
3131

3232
=== Allowlist NAT gateway IP
3333

modules/security/pages/cloud-authentication.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ dynamic and short-lived credentials to interact with cloud provider APIs:
144144
* Data plane agent
145145
* Tiered Storage
146146
* Redpanda Console
147-
* Managed connectors
147+
* Kafka Connect
148148

149149
xref:security:authorization/cloud-iam-policies.adoc[IAM policies] have constrained permissions so that each service can only
150150
access or manage its own data plane-scoped resources, following the principle of
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[IMPORTANT]
22
====
3-
- To unlock this feature for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
4-
- When Kafka Connect is enabled, there is a node running for Kafka Connect even if connectors are not used.
3+
- To enable this feature, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]. To disable this feature, see xref:develop:managed-connectors/disable-kc.adoc[].
4+
- Redpanda Support does not manage or monitor Kafka Connect. For fully-supported connectors, consider xref:develop:connect/about.adoc[Redpanda Connect].
5+
- When Kafka Connect is enabled, there is a dedicated node running even when no connectors are deployed.
56
====

0 commit comments

Comments
 (0)