Merge branch 'main' into add-dataflow-docs

Author: BentsiLeviav

.github/workflows/build-search.yml

@@ -15,8 +15,7 @@ env:
 
 jobs:
   update-search:
-    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'update search') && github.event.pull_request.base.ref == 'main'
-    #if: contains(github.event.pull_request.labels.*.name, 'update search') # Updated to trigger directly on PRs with the label
+    if: github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'update search') && github.event.pull_request.base.ref == 'main')
     runs-on: ubuntu-latest
 
     steps:
@@ -32,7 +31,7 @@ jobs:
         run: yarn copy-clickhouse-repo-docs
 
       - name: Run Auto Generate Settings
-        run: yarn auto-generate-settings
+        run: yarn autogenerate-settings
 
       - name: Run Indexer
         run: yarn run-indexer

.gitignore

@@ -37,9 +37,7 @@ active_links.txt
 active_links.json
 
 # Files used by scripts to autogenerate settings and do spellcheck
-FormatFactorySettingsDeclaration.h
-FormatFactorySettings.h
-Settings.cpp
+scripts/settings/tmp
 
 # Files whose content gets autogenerated
 docs/en/cloud/manage/api/invitations-api-reference.md

README.md

@@ -69,28 +69,22 @@ You can run a copy of this website locally within a few steps. Some folks find t
     # ✨  Done in 6.44s.
     ```
 
-1. Use Yarn to grab the latest documentation changes from the `clickhouse/clickhouse` repository:
+1. Use Yarn to grab the latest documentation changes from the `ClickHouse/ClickHouse` repository:
 
     ```shell
-    yarn prep-from-master
+    yarn copy-clickhouse-repo-docs
 
-    # yarn run v1.22.19
-    # Cloning into '/tmp/ch_temp_14714'...
+    # Cloning into 'ClickHouse'...
     # ...
-    # Prep completed
-    # ✨  Done in 16.44s
+    # Copying docs from ClickHouse ...
+    # Successfully executed copy from master
+    # ✨  Done in 18.56s.
     ```
 
-    Alternatively, you can use a local copy of the `clickhouse/clickhouse` if you already have that repository cloned locally.
+    Alternatively, you can use a local copy of `ClickHouse/ClickHouse` if you already have that repository cloned locally with `-l`.
 
     ```shell
-    yarn prep-from-local "/Users/johnny/clickhouse/"
-
-    # yarn run v1.22.19
-    # $ bash -c 'array_root=($npm ...
-    # ...
-    # Prep completed
-    ✨  Done in 0.47s.
+    yarn copy-clickhouse-repo-docs -l "/Users/johnny/clickhouse/"
     ```
 
 1. Start the local web-server:

copyClickhouseRepoDocs.sh

@@ -37,7 +37,7 @@ Your service will be backed up based on the set schedule, whether it is the defa
 
 ## Understanding backup cost
 
-ClickHouse Cloud includes two backups for free, but choosing a schedule that requires retaining more data, or causes more frequent backups can cause additional storage charges for backups. If you do not change the default settings, you will not incur any backup cost.
+Per the default policy, ClickHouse Cloud mandates a backup every day, with a 24 hour retention.  Choosing a schedule that requires retaining more data, or causes more frequent backups can cause additional storage charges for backups.
 
 To understand the backup cost, you can view the backup cost per service from the usage screen (as shown below). Once you have backups running for a few days with a customized schedule, you can get an idea of the cost and extrapolate to get the monthly cost for backups.
 

docs/en/cloud/manage/backups/overview.md

@@ -62,44 +62,88 @@ After creating the CloudFormation stack, you will be prompted to set up the infr
 
 ### Optional: Setup VPC Peering
 
-To create or delete VPC peering for ClickHouse BYOC, submit a ticket with the following details:
+To create or delete VPC peering for ClickHouse BYOC, follow the steps:
 
-- ClickHouse BYOC name for the VPC peering request.  
-- VPC ID (`vpc-xxxxxx`) to peer with the BYOC VPC.  
-- CIDR range of the VPC.  
-- AWS account owning the peering VPC.  
-- AWS region of the VPC.  
+#### Step 1 Create a peering connection
+1. Navigate to the VPC Dashboard in ClickHouse BYOC account.
+2. Select Peering Connections.
+3. Click Create Peering Connection
+4. Set the VPC Requester to the ClickHouse VPC ID.
+5. Set the VPC Acceptor to the target VPC ID. (Select another account if applicable)
+6. Click Create Peering Connection.
 
-Once the support ticket is received and processed, you will need to complete a few steps in your AWS account to finalize the peering setup:
+<br />
+
+<img src={require('./images/byoc-vpcpeering-1.png').default}
+    alt='BYOC Create Peering Connection'
+    class='image'
+    style={{width: '800px'}}
+/>
+
+<br />
+
+#### Step 2 Accept the peering connection request
+Go to the peering account, in the (VPC -> Peering connections -> Actions -> Accept request) page customer can approve this VPC peering request.
+
+<br />
+
+<img src={require('./images/byoc-vpcpeering-2.png').default}
+    alt='BYOC Accept Peering Connection'
+    class='image'
+    style={{width: '800px'}}
+/>
 
-1. Accept the VPC peering request in the AWS account of the peered VPC.  
-   - Navigate to **VPC -> Peering connections -> Actions -> Accept request**.
+<br />
 
-2. Adjust the route table for the peered VPC:  
-   - Locate the subnet in the peered VPC that needs to connect to the ClickHouse instance.  
-   - Edit the subnet's route table and add a route with the following configuration:  
-     - **Destination**: ClickHouse BYOC VPC CIDR (e.g., `10.0.0.0/16`)  
-     - **Target**: Peering Connection (`pcx-12345678`, the actual ID will appear in the dropdown list)  
+#### Step 3 Add destination to ClickHouse VPC route tables
+In ClickHouse BYOC account,
+1. Select Route Tables in the VPC Dashboard.
+2. Search for the ClickHouse VPC ID. Edit each route table attached to the private subnets.
+3. Click the Edit button under the Routes tab.
+4. Click Add another route.
+5. Enter the CIDR range of the target VPC for the Destination.
+6. Select “Peering Connection” and the ID of the peering connection for the Target.
 
 <br />
 
-<img src={require('./images/byoc-2.png').default}
-    alt='BYOC network configuration'
+<img src={require('./images/byoc-vpcpeering-3.png').default}
+    alt='BYOC Add route table'
     class='image'
-    style={{width: '600px'}}
+    style={{width: '800px'}}
 />
 
 <br />
 
-3. Check existing security groups and ensure no rules block access to the BYOC VPC.
+#### Step 4 Add destination to the target VPC route tables
+In the peering AWS account,
+1. Select Route Tables in the VPC Dashboard.
+2. Search for the target VPC ID.
+3. Click the Edit button under the Routes tab.
+4. Click Add another route.
+5. Enter the CIDR range of the ClickHouse VPC for the Destination.
+6. Select “Peering Connection” and the ID of the peering connection for the Target.
 
+<br />
+
+<img src={require('./images/byoc-vpcpeering-4.png').default}
+    alt='BYOC Add route table'
+    class='image'
+    style={{width: '800px'}}
+/>
+
+<br />
+
+#### Step 5 Enable Private Load Balancer for ClickHouse BYOC
+Contact ClickHouse support to enable Private Load Balancer. 
+
+---
 The ClickHouse service should now be accessible from the peered VPC.
 
 To access ClickHouse privately, a private load balancer and endpoint are provisioned for secure connectivity from the user's peered VPC. The private endpoint follows the public endpoint format with a `-private` suffix. For example:  
 - **Public endpoint**: `h5ju65kv87.mhp0y4dmph.us-west-2.aws.byoc.clickhouse.cloud`  
 - **Private endpoint**: `h5ju65kv87-private.mhp0y4dmph.us-west-2.aws.byoc.clickhouse.cloud`
 
-4. (Optional) After verifying that peering is working, you can request the removal of the public load balancer for ClickHouse BYOC.
+Optional, after verifying that peering is working, you can request the removal of the public load balancer for ClickHouse BYOC.
 
 ## Upgrade Process