From bd3ab8028d80c18868b33a8e161c3487992cc6e6 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 10 Jun 2024 16:08:07 -0600 Subject: [PATCH 1/7] #2524 update readme and add api files --- README.adoc | 8 ++++---- modules/ROOT/nav.adoc | 2 ++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index e95326d1..c6779b68 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -= Redpanda Documentation += Redpanda Cloud Documentation :url-playbook: https://github.com/redpanda-data/docs-site image:https://img.shields.io/badge/slack-purple[Slack, link="https://redpanda.com/slack"] @@ -14,7 +14,7 @@ image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f

++++ -This repository hosts the documentation content for Redpanda Platform and Redpanda Cloud. +This repository hosts the documentation content for Redpanda Cloud. == Contribute @@ -96,8 +96,8 @@ Versioned content is stored in branches that track the version of Redpanda Platf The production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches: -- `main`: Content for the latest version of Redpanda. -- `v/*`: Content for previous versions of Redpanda. +- `main`: Content for the latest version of Redpanda Enterprise. +- `redpanda-cloud`: Content for the latest version of Redpanda Cloud. - `shared`: Content that is shared across all versions (asciidoc attributes and terms) - `api`: API docs as well as the source OpenAPI spec files. - `site-search`: The global site search page. diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 2415ec14..f77b16dc 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -66,10 +66,12 @@ *** xref:ROOT:get-started:rpk-install.adoc[] *** xref:ROOT:get-started:config-rpk-profile.adoc[] ** xref:manage:api/index.adoc[Cloud API] +*** xref:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart] *** xref:manage:api/cloud-api-overview.adoc[Cloud API Overview] *** xref:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] *** xref:manage:api/cloud-controlplane-api.adoc[Use the Control Plane API] *** xref:manage:api/cloud-dataplane-api.adoc[Use the Data Plane APIs] +*** xref:manage:api/cloud-api-errors.adoc[Errors and Status Codes] ** xref:manage:schema-reg/index.adoc[Schema Registry] *** xref:ROOT:manage:schema-reg/schema-reg-overview.adoc[] *** xref:ROOT:manage:schema-reg/schema-reg-ui.adoc[Use Schema Registry in the Cloud UI] From 3cea543896de93ed94eac394cf1ac38c690cd3aa Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 14:33:22 -0600 Subject: [PATCH 2/7] add new RRR content --- README.adoc | 1 - modules/ROOT/nav.adoc | 1 + .../get-started/pages/whats-new-cloud.adoc | 10 ++++ modules/manage/pages/api/index.adoc | 1 + .../manage/pages/remote-read-replicas.adoc | 59 +++++++++++++++++++ 5 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 modules/manage/pages/remote-read-replicas.adoc diff --git a/README.adoc b/README.adoc index c6779b68..7cdef593 100644 --- a/README.adoc +++ b/README.adoc @@ -97,7 +97,6 @@ Versioned content is stored in branches that track the version of Redpanda Platf The production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches: - `main`: Content for the latest version of Redpanda Enterprise. -- `redpanda-cloud`: Content for the latest version of Redpanda Cloud. - `shared`: Content that is shared across all versions (asciidoc attributes and terms) - `api`: API docs as well as the source OpenAPI spec files. - `site-search`: The global site search page. diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index f77b16dc..99d4398f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -80,6 +80,7 @@ *** xref:ROOT:reference:console/record-deserialization.adoc[Deserialization] *** xref:ROOT:reference:console/programmable-push-filters.adoc[Programmable Push Filters] *** xref:ROOT:manage:console/edit-topic-configuration.adoc[Edit Topic Configuration] +** xref:manage:remote-read-replicas.adoc[] ** xref:manage:managed-connectors/index.adoc[Managed Connectors] *** xref:manage:managed-connectors/converters-and-serialization.adoc[Converters and serialization] *** xref:manage:managed-connectors/monitor-connectors.adoc[Monitor Connectors] diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index 1b8f2c93..b5baf3b1 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -5,6 +5,16 @@ This page lists new features added in Redpanda Cloud. +== June 2024 + +=== Remote read replica topics on BYOC: beta + +You can now create xref:manage:remote-read-replicas.adoc[remote read replica topics] on a BYOC cluster with the Cloud API. A remote read replica topic is a read-only topic that mirrors a topic on a different cluster. It can serve any consumer, without increasing the load on the source cluster. + +=== Higher connection limits in usage tiers + +Redpanda has increased the number of client connections in all xref:reference:tiers/byoc-tiers.adoc[tiers]. For example, tier 1 now supports up to 9,000 maximum connections, and tier 9 supports up to 450,000 maximum connections. Connections are regulated per broker for best performance. + == May 2024 === Cloud API: beta diff --git a/modules/manage/pages/api/index.adoc b/modules/manage/pages/api/index.adoc index 6d80db70..f121b5ca 100644 --- a/modules/manage/pages/api/index.adoc +++ b/modules/manage/pages/api/index.adoc @@ -2,4 +2,5 @@ :description: Use REST APIs to manage Redpanda Cloud resources. :page-layout: index :page-cloud: true +:page-beta: true //:page-categories: \ No newline at end of file diff --git a/modules/manage/pages/remote-read-replicas.adoc b/modules/manage/pages/remote-read-replicas.adoc new file mode 100644 index 00000000..71724c1b --- /dev/null +++ b/modules/manage/pages/remote-read-replicas.adoc @@ -0,0 +1,59 @@ += Remote Read Replicas +:description: Learn how to create a remote read replica topic, which is a read-only topic that mirrors a topic on a different cluster. +:page-cloud: true +:page-beta: true + +A remote read replica topic is a read-only topic that mirrors a topic on a different cluster. You can create a separate remote cluster just for consumers of this topic and populate its topics from object storage. A read-only topic on a remote cluster can serve any consumer, without increasing the load on the source cluster. Because these read-only topics access data directly from object storage, there's no impact to the performance of the cluster. + +Redpanda Cloud supports remote read replicas with ephemeral BYOC clusters (not with a customer-managed VPC). Ephemeral clusters are temporary clusters created to handle specific, transient workloads or tasks. After processing, the cluster is terminated to free up resources and reduce costs. + +== Prerequisites + +* A BYOC source cluster in Ready state. +* A BYOC reader cluster in Ready state. This separate reader cluster must exist in the same Redpanda organization and the same cloud provider account and region as the source cluster. + +== Configure remote read replicas + +You can add or remove reader clusters to a source cluster in Redpanda Cloud with the xref:api:ROOT:cloud-api.adoc[Cloud API]. For information on accessing the Cloud API, see xref:manage:api/cloud-api-authentication.adoc[]. + +. To update your source cluster to add one or more reader cluster IDs, make a xref:api:ROOT:cloud-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/\{cluster.id}`] request. The full list of clusters is expected on every call. If an ID is removed from the list, it will be removed as a reader cluster. ++ +```bash +export SOURCE_CLUSTER_ID=....... +export READER_CLUSTER_ID=....... + +curl -X PATCH $API_HOST/v1beta2/clusters/$SOURCE_CLUSTER_ID \ +-H "Content-Type: application/json" \ +-H "Authorization: Bearer $API_TOKEN" \ +-d @- << EOF +{ + "read_replica_cluster_ids": ["$READER_CLUSTER_ID"] +} +EOF +``` + +. To create a remote read replica topic, run: ++ +```bash +rpk topic create my-topic -c redpanda.remote.readreplica=redpanda-cloud-storage-${SOURCE_CLUSTER_ID} +``` + +. Optional: To see the list of reader clusters on a given source cluster, make a xref:api:ROOT:cloud-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`] request: ++ +```bash +export SOURCE_CLUSTER_ID=....... + +curl -X GET $API_HOST/v1beta2/clusters/$SOURCE_CLUSTER_ID \ +-H "Content-Type: application/json" \ +-H "Authorization: Bearer $API_TOKEN" +``` + +. Optional: For remote read replicas reading from a live topic (that is, a topic that's being actively written to by a source cluster), it may be advantageous to control how often segments are flushed to object storage. By default, this is set to 60 minutes. To tune `cloud_storage_segment_max_upload_interval_sec` on the source cluster, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^]. (For cold topics, where segments are closed and older than 60 minutes, this configuration is unnecessary: the data is already uploaded to object storage.) + +[NOTE] +==== +A source cluster cannot be deleted if it has remote read replica topics. When you delete a reader cluster, that cluster's ID is removed from any existing source cluster `read_replica_cluster_ids` lists. + +==== + + From 10abfa6c1dcd00d11f61f7ad69a20da836f973ff Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 14:38:05 -0600 Subject: [PATCH 3/7] update new connection limits for tiers --- modules/reference/partials/tiers.adoc | 60 ++++++++++++++++----------- 1 file changed, 35 insertions(+), 25 deletions(-) diff --git a/modules/reference/partials/tiers.adoc b/modules/reference/partials/tiers.adoc index 5b97d579..be22c981 100644 --- a/modules/reference/partials/tiers.adoc +++ b/modules/reference/partials/tiers.adoc @@ -1,24 +1,29 @@ ifdef::env-byoc[] -== BYOC supported tiers +== BYOC usage tiers -When you create a BYOC cluster, you select your usage tier. Each tier provides tested and guaranteed workload configurations for throughput, logical partitions, and connections. - -The following table lists the supported tiers for BYOC clusters. +When you create a BYOC cluster, you select your usage tier. Each tier provides tested workload configurations for maximum throughput, partitions, and connections. |=== -| Tier | Maximum ingress | Maximum egress | Maximum logical partitions | Maximum connections - -| Tier 1 | 20 MBps | 60 MBps | 1,000 | 1,500 -| Tier 2 | 50 MBps | 150 MBps | 2,800 | 3,750 -| Tier 3 | 100 MBps | 200 MBps | 5,600 | 7,500 -| Tier 4 | 200 MBps | 400 MBps | 11,300 | 15,000 -| Tier 5 | 400 MBps | 800 MBps | 22,800 | 30,000 -| Tier 6 | 800 MBps | 1,600 MBps | 45,000 | 60,000 -| Tier 7 | 1,200 MBps | 2,400 MBps | 67,500 | 90,000 -| Tier 8 | 1,600 MBps | 3,200 MBps | 90,000 | 120,000 -| Tier 9 | 2,000 MBps | 4,000 MBps | 112,500 | 150,000 +| Tier | Ingress | Egress | Logical partitions | Connections + +| Tier 1 | 20 MBps | 60 MBps | 1,000 | 9,000 +| Tier 2 | 50 MBps | 150 MBps | 2,800 | 22,500 +| Tier 3 | 100 MBps | 200 MBps | 5,600 | 45,000 +| Tier 4 | 200 MBps | 400 MBps | 11,300 | 90,000 +| Tier 5 | 400 MBps | 800 MBps | 22,800 | 180,000 +| Tier 6 | 800 MBps | 1,600 MBps | 45,000 | 180,000 +| Tier 7 | 1,200 MBps | 2,400 MBps | 67,500 | 270,000 +| Tier 8 | 1,600 MBps | 3,200 MBps | 90,000 | 360,000 +| Tier 9 | 2,000 MBps | 4,000 MBps | 112,500 | 450,000 |=== +[NOTE] +==== +* Depending on the workload, it may not be possible to achieve all maximum values. For example, a high number of partitions may make it more difficult to reach the maximum value in throughput. +* Logical partition counts assume the Redpanda Cloud default replication factor of 3. If you set a higher replication factor, the maximum value for partitions will be lower. +* Connections are regulated per broker for best performance. For example, in a tier 1 cluster with 3 brokers, there could be up to 3,000 connections per broker. + +==== == BYOC supported regions @@ -67,22 +72,27 @@ Amazon Web Services (AWS):: endif::[] ifndef::env-byoc[] -== Dedicated supported tiers +== Dedicated usage tiers -When you create a Dedicated cluster, you select your usage tier. Each tier provides tested and guaranteed workload configurations for throughput, logical partitions, and connections. - -The following table lists the tiers for Dedicated clusters. +When you create a Dedicated cluster, you select your usage tier. Each tier provides tested workload configurations for maximum throughput, partitions, and connections. |=== -| Tier | Maximum ingress | Maximum egress | Maximum logical partitions | Maximum connections +| Tier | Ingress | Egress | Logical partitions | Connections -| Tier 1 | 20 MBps | 60 MBps | 1,000 | 1,500 -| Tier 2 | 50 MBps | 150 MBps | 2,800 | 3,750 -| Tier 3 | 100 MBps | 200 MBps | 5,600 | 7,500 -| Tier 4 | 200 MBps | 400 MBps | 11,300 | 15,000 -| Tier 5 | 400 MBps | 800 MBps | 22,800 | 30,000 +| Tier 1 | 20 MBps | 60 MBps | 1,000 | 9,000 +| Tier 2 | 50 MBps | 150 MBps | 2,800 | 22,500 +| Tier 3 | 100 MBps | 200 MBps | 5,600 | 45,000 +| Tier 4 | 200 MBps | 400 MBps | 11,300 | 90,000 +| Tier 5 | 400 MBps | 800 MBps | 22,800 | 180,000 |=== +[NOTE] +==== +* Depending on the workload, it may not be possible to achieve all maximum values. For example, a high number of partitions may make it more difficult to reach the maximum value in throughput. +* Logical partition counts assume the Redpanda Cloud default replication factor of 3. If you set a higher replication factor, the maximum value for partitions will be lower. +* Connections are regulated per broker for best performance. For example, in a tier 1 cluster with 3 brokers, there could be up to 3,000 connections per broker. + +==== == Dedicated supported regions From 46ac9aedd489c70279ba0265c9385aaa269a39c7 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 14:46:08 -0600 Subject: [PATCH 4/7] update Readme --- README.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 7cdef593..bb0591b1 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -= Redpanda Cloud Documentation += Redpanda Documentation :url-playbook: https://github.com/redpanda-data/docs-site image:https://img.shields.io/badge/slack-purple[Slack, link="https://redpanda.com/slack"] @@ -14,7 +14,7 @@ image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f

++++ -This repository hosts the documentation content for Redpanda Cloud. +This repository hosts the documentation content for Redpanda. == Contribute @@ -96,7 +96,7 @@ Versioned content is stored in branches that track the version of Redpanda Platf The production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches: -- `main`: Content for the latest version of Redpanda Enterprise. +- `main`: Content for the latest version of Redpanda. - `shared`: Content that is shared across all versions (asciidoc attributes and terms) - `api`: API docs as well as the source OpenAPI spec files. - `site-search`: The global site search page. From 8e5cbda70a7f26eade1328e1e96843d86d8fa807 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 15:13:16 -0600 Subject: [PATCH 5/7] move managed connectors into Develop --- modules/ROOT/nav.adoc | 56 +++++++++---------- .../converters-and-serialization.adoc | 0 .../create-gcp-bigquery-connector.adoc | 0 .../create-gcs-connector.adoc | 0 .../create-http-source-connector.adoc | 0 .../create-iceberg-sink-connector.adoc | 0 .../create-jdbc-sink-connector.adoc | 0 .../create-jdbc-source-connector.adoc | 0 .../create-mmaker-checkpoint-connector.adoc | 0 .../create-mmaker-heartbeat-connector.adoc | 0 .../create-mmaker-source-connector.adoc | 0 .../create-mongodb-sink-connector.adoc | 0 .../create-mongodb-source-connector.adoc | 0 .../create-mysql-source-connector.adoc | 0 .../create-postgresql-connector.adoc | 0 .../create-s3-sink-connector.adoc | 0 .../create-snowflake-connector.adoc | 0 .../pages/managed-connectors/index.adoc | 0 .../monitor-connectors.adoc | 0 .../managed-connectors/sizing-connectors.adoc | 0 .../pages/managed-connectors/transforms.adoc | 0 21 files changed, 28 insertions(+), 28 deletions(-) rename modules/{manage => develop}/pages/managed-connectors/converters-and-serialization.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-gcp-bigquery-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-gcs-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-http-source-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-iceberg-sink-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-jdbc-sink-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-jdbc-source-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mmaker-checkpoint-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mmaker-heartbeat-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mmaker-source-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mongodb-sink-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mongodb-source-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-mysql-source-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-postgresql-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-s3-sink-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/create-snowflake-connector.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/index.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/monitor-connectors.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/sizing-connectors.adoc (100%) rename modules/{manage => develop}/pages/managed-connectors/transforms.adoc (100%) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 99d4398f..23c8cb85 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -57,21 +57,34 @@ ** xref:ROOT:develop:config-topics.adoc[] ** xref:ROOT:develop:http-proxy.adoc[] ** xref:ROOT:develop:transactions.adoc[] +** xref:develop:managed-connectors/index.adoc[Managed Connectors] +*** xref:develop:managed-connectors/converters-and-serialization.adoc[Converters and serialization] +*** xref:develop:managed-connectors/monitor-connectors.adoc[Monitor Connectors] +*** xref:develop:managed-connectors/transforms.adoc[Single Message Transforms] +*** xref:develop:managed-connectors/sizing-connectors.adoc[Sizing Connectors] +*** xref:develop:managed-connectors/create-s3-sink-connector.adoc[AWS S3 Sink Connector] +*** xref:develop:managed-connectors/create-gcp-bigquery-connector.adoc[Google BigQuery Sink Connector] +*** xref:develop:managed-connectors/create-gcs-connector.adoc[GCS Sink Connector] +*** xref:develop:managed-connectors/create-http-source-connector.adoc[HTTP Source Connector] +*** xref:develop:managed-connectors/create-iceberg-sink-connector.adoc[Iceberg Sink Connector] +*** xref:develop:managed-connectors/create-jdbc-sink-connector.adoc[JDBC Sink Connector] +*** xref:develop:managed-connectors/create-jdbc-source-connector.adoc[JDBC Source Connector] +*** xref:develop:managed-connectors/create-mmaker-source-connector.adoc[MirrorMaker2 Source Connector] +*** xref:develop:managed-connectors/create-mmaker-checkpoint-connector.adoc[MirrorMaker2 Checkpoint Connector] +*** xref:develop:managed-connectors/create-mmaker-heartbeat-connector.adoc[MirrorMaker2 Heartbeat Connector] +*** xref:develop:managed-connectors/create-mongodb-sink-connector.adoc[MongoDB Sink Connector] +*** xref:develop:managed-connectors/create-mongodb-source-connector.adoc[MongoDB Source Connector] +*** xref:develop:managed-connectors/create-mysql-source-connector.adoc[MySQL (Debezium) Source Connector] +*** xref:develop:managed-connectors/create-postgresql-connector.adoc[PostgreSQL (Debezium) Source Connector] +*** xref:develop:managed-connectors/create-snowflake-connector.adoc[Snowflake Sink Connector] * xref:manage:index.adoc[Manage] ** xref:manage:monitor-cloud.adoc[] ** xref:ROOT:get-started:rpk/index.adoc[Redpanda CLI] -** xref:ROOT:get-started:intro-to-rpk.adoc[] +*** xref:ROOT:get-started:intro-to-rpk.adoc[] *** xref:ROOT:get-started:broker-admin.adoc[] *** xref:ROOT:get-started:rpk-install.adoc[] *** xref:ROOT:get-started:config-rpk-profile.adoc[] -** xref:manage:api/index.adoc[Cloud API] -*** xref:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart] -*** xref:manage:api/cloud-api-overview.adoc[Cloud API Overview] -*** xref:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] -*** xref:manage:api/cloud-controlplane-api.adoc[Use the Control Plane API] -*** xref:manage:api/cloud-dataplane-api.adoc[Use the Data Plane APIs] -*** xref:manage:api/cloud-api-errors.adoc[Errors and Status Codes] ** xref:manage:schema-reg/index.adoc[Schema Registry] *** xref:ROOT:manage:schema-reg/schema-reg-overview.adoc[] *** xref:ROOT:manage:schema-reg/schema-reg-ui.adoc[Use Schema Registry in the Cloud UI] @@ -80,27 +93,14 @@ *** xref:ROOT:reference:console/record-deserialization.adoc[Deserialization] *** xref:ROOT:reference:console/programmable-push-filters.adoc[Programmable Push Filters] *** xref:ROOT:manage:console/edit-topic-configuration.adoc[Edit Topic Configuration] +** xref:manage:api/index.adoc[Cloud API] +*** xref:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart] +*** xref:manage:api/cloud-api-overview.adoc[Cloud API Overview] +*** xref:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] +*** xref:manage:api/cloud-controlplane-api.adoc[Use the Control Plane API] +*** xref:manage:api/cloud-dataplane-api.adoc[Use the Data Plane APIs] +*** xref:manage:api/cloud-api-errors.adoc[Errors and Status Codes] ** xref:manage:remote-read-replicas.adoc[] -** xref:manage:managed-connectors/index.adoc[Managed Connectors] -*** xref:manage:managed-connectors/converters-and-serialization.adoc[Converters and serialization] -*** xref:manage:managed-connectors/monitor-connectors.adoc[Monitor Connectors] -*** xref:manage:managed-connectors/transforms.adoc[Single Message Transforms] -*** xref:manage:managed-connectors/sizing-connectors.adoc[Sizing Connectors] -*** xref:manage:managed-connectors/create-s3-sink-connector.adoc[AWS S3 Sink Connector] -*** xref:manage:managed-connectors/create-gcp-bigquery-connector.adoc[Google BigQuery Sink Connector] -*** xref:manage:managed-connectors/create-gcs-connector.adoc[GCS Sink Connector] -*** xref:manage:managed-connectors/create-http-source-connector.adoc[HTTP Source Connector] -*** xref:manage:managed-connectors/create-iceberg-sink-connector.adoc[Iceberg Sink Connector] -*** xref:manage:managed-connectors/create-jdbc-sink-connector.adoc[JDBC Sink Connector] -*** xref:manage:managed-connectors/create-jdbc-source-connector.adoc[JDBC Source Connector] -*** xref:manage:managed-connectors/create-mmaker-source-connector.adoc[MirrorMaker2 Source Connector] -*** xref:manage:managed-connectors/create-mmaker-checkpoint-connector.adoc[MirrorMaker2 Checkpoint Connector] -*** xref:manage:managed-connectors/create-mmaker-heartbeat-connector.adoc[MirrorMaker2 Heartbeat Connector] -*** xref:manage:managed-connectors/create-mongodb-sink-connector.adoc[MongoDB Sink Connector] -*** xref:manage:managed-connectors/create-mongodb-source-connector.adoc[MongoDB Source Connector] -*** xref:manage:managed-connectors/create-mysql-source-connector.adoc[MySQL (Debezium) Source Connector] -*** xref:manage:managed-connectors/create-postgresql-connector.adoc[PostgreSQL (Debezium) Source Connector] -*** xref:manage:managed-connectors/create-snowflake-connector.adoc[Snowflake Sink Connector] * xref:billing:index.adoc[Billing] ** xref:billing:billing.adoc[] diff --git a/modules/manage/pages/managed-connectors/converters-and-serialization.adoc b/modules/develop/pages/managed-connectors/converters-and-serialization.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/converters-and-serialization.adoc rename to modules/develop/pages/managed-connectors/converters-and-serialization.adoc diff --git a/modules/manage/pages/managed-connectors/create-gcp-bigquery-connector.adoc b/modules/develop/pages/managed-connectors/create-gcp-bigquery-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-gcp-bigquery-connector.adoc rename to modules/develop/pages/managed-connectors/create-gcp-bigquery-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-gcs-connector.adoc b/modules/develop/pages/managed-connectors/create-gcs-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-gcs-connector.adoc rename to modules/develop/pages/managed-connectors/create-gcs-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-http-source-connector.adoc b/modules/develop/pages/managed-connectors/create-http-source-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-http-source-connector.adoc rename to modules/develop/pages/managed-connectors/create-http-source-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-iceberg-sink-connector.adoc b/modules/develop/pages/managed-connectors/create-iceberg-sink-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-iceberg-sink-connector.adoc rename to modules/develop/pages/managed-connectors/create-iceberg-sink-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-jdbc-sink-connector.adoc b/modules/develop/pages/managed-connectors/create-jdbc-sink-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-jdbc-sink-connector.adoc rename to modules/develop/pages/managed-connectors/create-jdbc-sink-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-jdbc-source-connector.adoc b/modules/develop/pages/managed-connectors/create-jdbc-source-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-jdbc-source-connector.adoc rename to modules/develop/pages/managed-connectors/create-jdbc-source-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mmaker-checkpoint-connector.adoc b/modules/develop/pages/managed-connectors/create-mmaker-checkpoint-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mmaker-checkpoint-connector.adoc rename to modules/develop/pages/managed-connectors/create-mmaker-checkpoint-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mmaker-heartbeat-connector.adoc b/modules/develop/pages/managed-connectors/create-mmaker-heartbeat-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mmaker-heartbeat-connector.adoc rename to modules/develop/pages/managed-connectors/create-mmaker-heartbeat-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mmaker-source-connector.adoc b/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mmaker-source-connector.adoc rename to modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mongodb-sink-connector.adoc b/modules/develop/pages/managed-connectors/create-mongodb-sink-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mongodb-sink-connector.adoc rename to modules/develop/pages/managed-connectors/create-mongodb-sink-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mongodb-source-connector.adoc b/modules/develop/pages/managed-connectors/create-mongodb-source-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mongodb-source-connector.adoc rename to modules/develop/pages/managed-connectors/create-mongodb-source-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-mysql-source-connector.adoc b/modules/develop/pages/managed-connectors/create-mysql-source-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-mysql-source-connector.adoc rename to modules/develop/pages/managed-connectors/create-mysql-source-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-postgresql-connector.adoc b/modules/develop/pages/managed-connectors/create-postgresql-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-postgresql-connector.adoc rename to modules/develop/pages/managed-connectors/create-postgresql-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-s3-sink-connector.adoc b/modules/develop/pages/managed-connectors/create-s3-sink-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-s3-sink-connector.adoc rename to modules/develop/pages/managed-connectors/create-s3-sink-connector.adoc diff --git a/modules/manage/pages/managed-connectors/create-snowflake-connector.adoc b/modules/develop/pages/managed-connectors/create-snowflake-connector.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/create-snowflake-connector.adoc rename to modules/develop/pages/managed-connectors/create-snowflake-connector.adoc diff --git a/modules/manage/pages/managed-connectors/index.adoc b/modules/develop/pages/managed-connectors/index.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/index.adoc rename to modules/develop/pages/managed-connectors/index.adoc diff --git a/modules/manage/pages/managed-connectors/monitor-connectors.adoc b/modules/develop/pages/managed-connectors/monitor-connectors.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/monitor-connectors.adoc rename to modules/develop/pages/managed-connectors/monitor-connectors.adoc diff --git a/modules/manage/pages/managed-connectors/sizing-connectors.adoc b/modules/develop/pages/managed-connectors/sizing-connectors.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/sizing-connectors.adoc rename to modules/develop/pages/managed-connectors/sizing-connectors.adoc diff --git a/modules/manage/pages/managed-connectors/transforms.adoc b/modules/develop/pages/managed-connectors/transforms.adoc similarity index 100% rename from modules/manage/pages/managed-connectors/transforms.adoc rename to modules/develop/pages/managed-connectors/transforms.adoc From a1867d1eb7de54beec55fa8191a357fa1367fa34 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 15:29:09 -0600 Subject: [PATCH 6/7] fix rpk index page --- modules/reference/pages/rpk/index.adoc | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/modules/reference/pages/rpk/index.adoc b/modules/reference/pages/rpk/index.adoc index dc5057fb..b7b57b02 100644 --- a/modules/reference/pages/rpk/index.adoc +++ b/modules/reference/pages/rpk/index.adoc @@ -1,5 +1,12 @@ = rpk Commands -:description: This page contains an alphabetized list of `rpk` commands. Each command includes a table of flags and their descriptions. +:description: pass:q[Index page of `rpk` commands for Redpanda Cloud in alphabetical order.] +:page-layout: index -You can also get descriptions for each flag by running `rpk --help` in your locally-installed Redpanda, and you can get descriptions of all rpk-specific options by running `rpk -X help`. -:page-layout: index \ No newline at end of file +This page contains an alphabetized list of `rpk` commands. Each command includes a table of flags and their descriptions. + +You can also get descriptions for each flag by running `rpk --help`, and you can get descriptions of all `rpk`-specific options by running `rpk -X help`. + +[NOTE] +==== +All `rpk` commands feature autocompletion. To use the feature, press tab. See xref:ROOT:reference:rpk/rpk-generate/rpk-generate-shell-completion.adoc[`rpk generate shell-completion`]. +==== \ No newline at end of file From 5c4264da4700f86acc831976c97b1aa91d0e9a08 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 20 Jun 2024 15:55:00 -0600 Subject: [PATCH 7/7] removing index page --- modules/reference/pages/rpk/index.adoc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/modules/reference/pages/rpk/index.adoc b/modules/reference/pages/rpk/index.adoc index b7b57b02..cca40563 100644 --- a/modules/reference/pages/rpk/index.adoc +++ b/modules/reference/pages/rpk/index.adoc @@ -1,10 +1,7 @@ = rpk Commands :description: pass:q[Index page of `rpk` commands for Redpanda Cloud in alphabetical order.] -:page-layout: index -This page contains an alphabetized list of `rpk` commands. Each command includes a table of flags and their descriptions. - -You can also get descriptions for each flag by running `rpk --help`, and you can get descriptions of all `rpk`-specific options by running `rpk -X help`. +Each `rpk` command includes a table of flags and their descriptions. You can also get descriptions for each flag by running `rpk --help`, and you can get descriptions of all `rpk`-specific options by running `rpk -X help`. [NOTE] ====