ClickPipes: Postgres scaling

docs/integrations/data-ingestion/clickpipes/postgres/scaling.md

@@ -0,0 +1,93 @@
+---
+title: 'Scaling CDC ClickPipes via OpenAPI'
+description: 'Doc for scaling CDC ClickPipes via OpenAPI'
+slug: /integrations/clickpipes/postgres/scaling
+sidebar_label: 'Scaling'
+---
+
+:::caution Most users won't need this API
+Default configuration of CDC ClickPipes is designed to handle the majority of workloads out of the box. If you think your workload requires scaling, open a [support case](https://clickhouse.com/support/program) and we'll guide you through the optimal settings for the use case.
+:::
+
+Scaling API may be useful for:
+- Large initial loads (over 4 TB)
+- Migrating a moderate amount of data at a very high speed (sub-1 hour)
+- Supporting over 8 CDC ClickPipes under the same service
+
+Other signs that scaling may be necessary:
+- Initial load is taking longer than 24 hours while the load on the source DB is low
+  - First consider adjusting the [initial load parallelism and partitioning](/integrations/data-ingestion/clickpipes/postgres/parallel_initial_load) when creating the ClickPipe
+- The new rows taking more than 2× the sync interval to appear on the destination table
+  - As long as there are no [long-running transactions](/integrations/clickpipes/postgres/sync_control#transactions-pg-sync) on the source
+
+Increasing the CDC scale will proportionally increase your ClickPipes compute costs. If you're scaling up just for the initial loads, it's important to scale down after the snapshot is finished to avoid unexpected charges. For more details on pricing, see [Postgres CDC Pricing](/cloud/manage/billing/overview#clickpipes-for-postgres-cdc).
+
+## Prerequisites for this process {#prerequisites}
+
+Before you get started you will need:
+
+1. [ClickHouse API key](/cloud/manage/openapi) with Admin permissions on the target ClickHouse Cloud service.
+2. A CDC ClickPipe (Postgres, MySQL or MongoDB) provisioned in the service at some point in time. CDC infrastructure gets created along with the first ClickPipe, and the scaling endpoints become available from that point onwards.
+
+## Steps to scale CDC ClickPipes {#cdc-scaling-steps}
+
+Set the following environment variables before running any commands:
+
+```bash
+ORG_ID=<Your ClickHouse organization ID>
+SERVICE_ID=<Your ClickHouse service ID>
+KEY_ID=<Your ClickHouse key ID>
+KEY_SECRET=<Your ClickHouse key secret>
+```
+
+Fetch the current scaling configuration (optional):
+
+```bash
+curl --silent --user $KEY_ID:$KEY_SECRET \
+https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
+| jq
+
+# example result:
+{
+  "result": {
+    "replicaCpuMillicores": 2000,
+    "replicaMemoryGb": 8
+  },
+  "requestId": "04310d9e-1126-4c03-9b05-2aa884dbecb7",
+  "status": 200
+}
+```
+
+Set the desired scaling. Supported configurations include 1..16 CPU cores and memory GB that is 4× the core count:
+
+```bash
+cat <<EOF | tee cdc_scaling.json
+{
+  "replicaCpuMillicores": 16000,
+  "replicaMemoryGb": 64
+}
+EOF
+
+curl --silent --user $KEY_ID:$KEY_SECRET \
+-X PATCH -H "Content-Type: application/json" \
+https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
+-d @cdc_scaling.json | jq
+```
+
+Wait for the command to propagate - this usually takes 3-5 minutes. After the scaling is finished, the GET endpoint will reflect the new values:
+
+```bash
+curl --silent --user $KEY_ID:$KEY_SECRET \
+https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
+| jq
+
+# example result:
+{
+  "result": {
+    "replicaCpuMillicores": 16000,
+    "replicaMemoryGb": 64
+  },
+  "requestId": "5a76d642-d29f-45af-a857-8c4d4b947bf0",
+  "status": 200
+}
+```

sidebars.js

@@ -746,7 +746,8 @@ const sidebars = {
                 "integrations/data-ingestion/clickpipes/postgres/remove_table",
                 "integrations/data-ingestion/clickpipes/postgres/table_resync",
                 "integrations/data-ingestion/clickpipes/postgres/resync",
-                "integrations/data-ingestion/clickpipes/postgres/controlling_sync"
+                "integrations/data-ingestion/clickpipes/postgres/controlling_sync",
+                "integrations/data-ingestion/clickpipes/postgres/scaling",
               ],
             },
             {