Skip to content

Commit 1f0bed1

Browse files
authored
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into shared-database
2 parents d27dd76 + ebf993d commit 1f0bed1

File tree

693 files changed

+29211
-17205
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

693 files changed

+29211
-17205
lines changed

docs/about-us/adopters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The following list of companies using ClickHouse and their success stories is as
6969
| [Beeline](https://beeline.ru/) | Telecom | Data Platform | [Blog post, July 2021](https://habr.com/en/company/beeline/blog/567508/) |||
7070
| [Beekeeper](https://www.beekeeper.io/) | Workforce Enablement | Analytics | [Blog post, April 2024](https://www.meetup.com/clickhouse—switzerland—meetup—group/events/299628922) |||
7171
| [Beetested](https://www.beetested.com/) | Software & Technology | Game Testing | [Case Study, June 2023](https://double.cloud/resources/case—studies/beetested—analyze—millions—of—gamers—emotions—with—doublecloud/) |||
72-
| [Benocs](https://www.benocs.com/) | Network Telemetry and Analytics | Main Product | [Meetup Video, December 2022](https://www.youtube.com/watch?v=48pAVShkeCY&list=PL0Z2YDlm0b3iNDUzpY1S3L_iV4nARda_U&index=12) [Slides, December 2022](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup66/Self%20repairing%20processing%20using%20ClickHouse.pdf) [Blog Post, March 2022](https://clickhouse.com/blog/—indexing—for—data—streams—benocs—telco/) [Slides in English, October 2017](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup9/lpm.pdf) |||
72+
| [Benocs](https://www.benocs.com/) | Network Telemetry and Analytics | Main Product | [Slides, December 2022](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup66/Self%20repairing%20processing%20using%20ClickHouse.pdf) [Blog Post, March 2022](https://clickhouse.com/blog/—indexing—for—data—streams—benocs—telco/) [Slides in English, October 2017](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup9/lpm.pdf) |||
7373
| [Bento](https://bento.me/en/home) | Software & Technology | Personal Portfolio | [Twitter, May 2023](https://twitter.com/gubmee/status/1653405962542219264) |||
7474
| [Better Stack](https://betterstack.com/) | Cloud, SaaS | Log Management | [Official Website](https://betterstack.com/logtail) |||
7575
| [BiliBili](https://www.bilibili.com/) | Video sharing || [Blog post, June 2021](https://chowdera.com/2021/06/20210622012241476b.html) |||

docs/cloud/manage/jan2025_faq/plan_migrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Your service has to be on version 24.8 or later and already migrated to SharedMe
7070

7171
### What is the migration experience for users of the current Development and Production services? Do users need to plan for a maintenance window where the service is unavailable? {#what-is-the-migration-experience-for-users-of-the-current-development-and-production-services-do-users-need-to-plan-for-a-maintenance-window-where-the-service-is-unavailable}
7272

73-
Migrations of Development and Production services to the new pricing tiers may trigger a server restart. To migrate a Dedicated service, please contact [support](https://clickhouse.com/support/program).
73+
Migrations of Development and Production services to the new pricing tiers may trigger a rolling restart. To migrate a Dedicated service, please contact [support](https://clickhouse.com/support/program).
7474

7575
### What other actions should a user take after the migration? {#what-other-actions-should-a-user-take-after-the-migration}
7676

docs/cloud/reference/byoc.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,3 +422,9 @@ scrape_configs:
422422
```
423423

424424
Please also see [this blog post](https://clickhouse.com/blog/clickhouse-cloud-now-supports-prometheus-monitoring) and the [Prometheus setup docs for ClickHouse](/integrations/prometheus).
425+
426+
### Uptime SLAs {#uptime-sla}
427+
428+
#### Does ClickHouse offer an uptime SLA for BYOC? {#uptime-sla-for-byoc}
429+
430+
No, since the data plane is hosted in the customer's cloud environment, service availability depends on resources not in ClickHouse's control. Therefore, ClickHouse does not offer a formal uptime SLA for BYOC deployments. If you have additional questions, please contact [email protected].

docs/cloud/reference/changelog.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,35 @@ import kafka_config from '@site/static/images/cloud/reference/june-13-kafka-conf
2727
import fast_releases from '@site/static/images/cloud/reference/june-13-fast-releases.png';
2828
import share_queries from '@site/static/images/cloud/reference/may-30-share-queries.png';
2929
import query_endpoints from '@site/static/images/cloud/reference/may-17-query-endpoints.png';
30+
import dashboards from '@site/static/images/cloud/reference/may-30-dashboards.png';
3031

3132
In addition to this ClickHouse Cloud changelog, please see the [Cloud Compatibility](/cloud/reference/cloud-compatibility.md) page.
3233

34+
## May 30, 2025 {#may-30-2025}
35+
36+
- We’re excited to announce general availability of **ClickPipes for Postgres CDC **
37+
in ClickHouse Cloud. With just a few clicks, you can now replicate your Postgres
38+
databases and unlock blazing-fast, real-time analytics. The connector delivers
39+
faster data synchronization, latency as low as a few seconds, automatic schema changes,
40+
fully secure connectivity, and more. Refer to the
41+
[blog](https://clickhouse.com/blog/postgres-cdc-connector-clickpipes-ga) for
42+
more information. To get started, refer to the instructions [here](https://clickhouse.com/docs/integrations/clickpipes/postgres).
43+
44+
- Introduced new improvements to the SQL console dashboards:
45+
- Sharing: You can share your dashboard with your team members. Four levels of access are supported, that can be adjusted both globally and on a per-user basis:
46+
- _Write access_: Add/edit visualizations, refresh settings, interact with dashboards via filters.
47+
- _Owner_: Share a dashboard, delete a dashboard, and all other permissions of a user with "write access".
48+
- _Read-only access_: View and interact with dashboard via filters
49+
- _No access_: Cannot view a dashboard
50+
- For existing dashboards that have already been created, Organization Administrators can assign existing dashboards to themselves as owners.
51+
- You can now add a table or chart from the SQL console to a dashboard from the query view.
52+
53+
<Image img={dashboards} size="md" alt="Dashboards improvements" border />
54+
55+
56+
- We are enlisting preview participants for [Distributed cache](https://clickhouse.com/cloud/distributed-cache-waitlist)
57+
for AWS and GCP. Read more in the [blog](https://clickhouse.com/blog/building-a-distributed-cache-for-s3).
58+
3359
## May 16, 2025 {#may-16-2025}
3460

3561
- Introduced the Resource Utilization Dashboard which provides a view of

docs/cloud/security/connectivity-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This section looks at connectivity and contains the following pages:
1010

1111
| Page | Description |
1212
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
13-
| [Setting IP Filters](/cloud/security/setting-ip-filters) | A guide on how to control traffic to your ClickHouse services using IP access lists. |
13+
| [Setting IP Filters](/cloud/security/setting-ip-filters) | A guide on how to control traffic to your ClickHouse services and API keys using IP access lists. |
1414
| [Private Networking](/cloud/security/private-link-overview) | Information on how to connect your services to your cloud virtual network. |
1515
| [Accessing S3 Data Securely](/cloud/security/secure-s3) | A guide on how to leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access data securely. |
1616
| [Cloud IP Addresses](/manage/security/cloud-endpoints-api) | Tables listing the static IPs and S3 endpoints for each supported cloud and region in ClickHouse Cloud. |

docs/cloud/security/setting-ip-filters.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,48 @@ import ip_filter_add_single_ip from '@site/static/images/cloud/security/ip-filte
1111

1212
## Setting IP Filters {#setting-ip-filters}
1313

14-
IP access lists filter traffic to your ClickHouse services by specifying which source addresses are permitted to connect to your ClickHouse service. The lists are configurable for each service. Lists can be configured during the deployment of a service, or afterward. If you do not configure an IP access list during provisioning, or if you want to make changes to your initial list, then you can make those changes by selecting the service and then the **Security** tab.
14+
IP access lists filter traffic to ClickHouse services or API keys by specifying which source addresses are permitted to connect. These lists are configurable for each service and each API key. Lists can be configured during service or API key creation, or afterward.
1515

1616
:::important
17-
If you skip the creation of the IP Access List for a ClickHouse Cloud service then no traffic will be permitted to the service.
17+
If you skip the creation of the IP access list for a ClickHouse Cloud service then no traffic will be permitted to the service.
1818
:::
1919

2020
## Prepare {#prepare}
21-
Before you begin, collect the IP Addresses or ranges that should be added to the access list. Take into consideration remote workers, on-call locations, VPNs, etc. The IP Access List user interface accepts individual addresses and CIDR notation.
22-
23-
Classless Inter-domain Routing (CIDR) notation, allows you to specify IP Address ranges smaller than the traditional Class A, B, or C (8, 6, or 24) subnet mask sizes. [ARIN](https://account.arin.net/public/cidrCalculator) and several other organizations provide CIDR calculators if you need one, and if you would like more information on CIDR notation, please see the [Classless Inter-domain Routing (CIDR)](https://www.rfc-editor.org/rfc/rfc4632.html) RFC.
24-
25-
## Create or modify an IP Access List {#create-or-modify-an-ip-access-list}
26-
27-
From your ClickHouse Cloud services list select the service and then select **Settings**. Under the **Security** section, you will find the IP access list. Click on the hyperlink where the text says: *You can connect to this service from* **(anywhere | x specific locations)**
28-
29-
A sidebar will appear with options for you to configure:
30-
31-
- Allow incoming traffic from anywhere to the service
32-
- Allow access from specific locations to the service
33-
- Deny all access to the service
34-
35-
This screenshot shows an access list which allows traffic from a range of IP Addresses, described as "NY Office range":
36-
21+
Before you begin, collect the IP addresses or ranges that should be added to the access list. Take into consideration remote workers, on-call locations, VPNs, etc. The IP access list user interface accepts individual addresses and CIDR notation.
22+
23+
Classless Inter-domain Routing (CIDR) notation, allows you to specify IP address ranges smaller than the traditional Class A, B, or C (8, 6, or 24) subnet mask sizes. [ARIN](https://account.arin.net/public/cidrCalculator) and several other organizations provide CIDR calculators if you need one, and if you would like more information on CIDR notation, please see the [Classless Inter-domain Routing (CIDR)](https://www.rfc-editor.org/rfc/rfc4632.html) RFC.
24+
25+
## Create or modify an IP access list {#create-or-modify-an-ip-access-list}
26+
27+
<details>
28+
<summary>IP access list for ClickHouse services</summary>
29+
30+
When you create a ClickHouse service, the default setting for the IP allow list is 'Allow from nowhere.'
31+
32+
From your ClickHouse Cloud services list select the service and then select **Settings**. Under the **Security** section, you will find the IP access list. Click on the Add IPs button.
33+
34+
A sidebar will appear with options for you to configure:
35+
36+
- Allow incoming traffic from anywhere to the service
37+
- Allow access from specific locations to the service
38+
- Deny all access to the service
39+
40+
</details>
41+
<details>
42+
<summary>IP access list for API keys</summary>
43+
44+
When you create an API key, the default setting for the IP allow list is 'Allow from anywhere.'
45+
46+
From the API key list, click the three dots next to the API key under the **Actions** column and select **Edit**. At the bottom of the screen you will find the IP access list and options to configure:
47+
48+
- Allow incoming traffic from anywhere to the service
49+
- Allow access from specific locations to the service
50+
- Deny all access to the service
51+
52+
</details>
53+
54+
This screenshot shows an access list which allows traffic from a range of IP addresses, described as "NY Office range":
55+
3756
<Image img={ip_filtering_after_provisioning} size="md" alt="Existing access list in ClickHouse Cloud" border/>
3857

3958
### Possible actions {#possible-actions}
@@ -60,7 +79,7 @@ To apply the changes you made, you must click **Save**.
6079

6180
## Verification {#verification}
6281

63-
Once you create your filter confirm connectivity from within the range, and confirm that connections from outside the permitted range are denied. A simple `curl` command can be used to verify:
82+
Once you create your filter confirm connectivity to a service from within the range, and confirm that connections from outside the permitted range are denied. A simple `curl` command can be used to verify:
6483
```bash title="Attempt rejected from outside the allow list"
6584
curl https://<HOSTNAME>.clickhouse.cloud:8443
6685
```
@@ -81,4 +100,4 @@ Ok.
81100

82101
## Limitations {#limitations}
83102

84-
- Currently, IP Access Lists support only IPv4
103+
- Currently, IP access lists support only IPv4

docs/getting-started/example-datasets/recipes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Result:
187187
10 rows in set. Elapsed: 0.215 sec. Processed 2.23 million rows, 1.48 GB (10.35 million rows/s., 6.86 GB/s.)
188188
```
189189

190-
In this example, we involve [has](../../sql-reference/functions/array-functions.md#hasarr-elem) function to filter by array elements and sort by the number of directions.
190+
In this example, we involve [has](../../sql-reference/functions/array-functions.md#has) function to filter by array elements and sort by the number of directions.
191191

192192
There is a wedding cake that requires the whole 126 steps to produce! Show that directions:
193193

0 commit comments

Comments
 (0)