Skip to content

Commit 1e73a03

Browse files
authored
Merge pull request #3988 from Blargian/cloud_quickstart
Cloud quick start restructure
2 parents 2f990c6 + 80511ce commit 1e73a03

File tree

20 files changed

+193
-36
lines changed

20 files changed

+193
-36
lines changed

docs/about-us/cloud.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: 'ClickHouse Cloud'
1111
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
1212
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).
1313

14-
### ClickHouse Cloud benefits: {#clickhouse-cloud-benefits}
14+
## ClickHouse Cloud benefits {#clickhouse-cloud-benefits}
1515

1616
Some of the benefits of using ClickHouse Cloud are described below:
1717

@@ -22,7 +22,28 @@ Some of the benefits of using ClickHouse Cloud are described below:
2222
- **Total cost of ownership**: Best price / performance ratio and low administrative overhead.
2323
- **Broad ecosystem**: Bring your favorite data connectors, visualization tools, SQL and language clients with you.
2424

25-
### What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
25+
<!--
26+
## OSS vs ClickHouse Cloud comparison {#oss-vs-clickhouse-cloud}
27+
28+
| Feature | Benefits | OSS ClickHouse | ClickHouse Cloud |
29+
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------|
30+
| **Deployment modes** | ClickHouse provides flexibility to self-manage with open-source or deploy in the cloud. Use ClickHouse Local for local files without a server or chDB to embed ClickHouse directly into your application. | ✅ | ✅ |
31+
| **Storage** | As an open-source and cloud-hosted product, ClickHouse can be deployed in both shared-disk and shared-nothing architectures. | ✅ | ✅ |
32+
| **Monitoring and alerting** | Monitoring and alerting about the status of your services is critical to ensuring optimal performance and a proactive approach to detect and triage potential issues. | ✅ | ✅ |
33+
| **ClickPipes** | ClickPipes is ClickHouse's managed ingestion pipeline that allows you to seamlessly connect your external data sources like databases, APIs, and streaming services into ClickHouse Cloud, eliminating the need for managing pipelines, custom jobs, or ETL processes. It supports workloads of all sizes. | ❌ | ✅ |
34+
| **Pre-built integrations** | ClickHouse provides pre-built integrations that connect ClickHouse to popular tools and services such as data lakes, SQL and language clients, visualization libraries, and more. | ❌ | ✅ |
35+
| **SQL console** | The SQL console offers a fast, intuitive way to connect, explore, and query ClickHouse databases, featuring a slick caption, query interface, data import tools, visualizations, collaboration features, and GenAI-powered SQL assistance. | ❌ | ✅ |
36+
| **Compliance** | ClickHouse Cloud compliance includes CCPA, EU-US DPF, GDPR, HIPAA, ISO 27001, ISO 27001 SoA, PCI DSS, SOC2. ClickHouse Cloud's security, availability, processing integrity, and confidentiality processes are all independently audited. Details: trust.clickhouse.com. | ❌ | ✅ |
37+
| **Enterprise-grade security** | Support for advanced security features such as SSO, multi-factor authentication, role-based access control (RBAC), private and secure connections with support for Private Link and Private Service Connect, IP filtering, customer-managed encryption keys (CMEK), and more. | ❌ | ✅ |
38+
| **Scaling and optimization** | Seamlessly scales up or down based on workload, supporting both horizontal and vertical scaling. With automated backups, replication, and high availability, ClickHouse, it provides users with optimal resource allocation. | ❌ | ✅ |
39+
| **Support services** | Our best-in-class support services and open-source community resources provide coverage for whichever deployment model you choose. | ❌ | ✅ |
40+
| **Database upgrades** | Regular database upgrades are essential to establish a strong security posture and access the latest features and performance improvements. | ❌ | ✅ |
41+
| **Backups** | Backups and restore functionality ensures data durability and supports graceful recovery in the event of outages or other disruptions. | ❌ | ✅ |
42+
| **Compute-compute separation** | Users can scale compute resources independently of storage, so teams and workloads can share the same storage and maintain dedicated compute resources. This ensures that the performance of one workload doesn't interfere with another, enhancing flexibility, performance, and cost-efficiency. | ❌ | ✅ |
43+
| **Managed services** | With a cloud-managed service, teams can focus on business outcomes and accelerate time-to-market without having to worry about the operational overhead of sizing, setup, and maintenance of ClickHouse. | ❌ | ✅ |
44+
-->
45+
46+
## What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
2647

2748
Clickhouse Cloud continuously upgrades your service to a newer version. After publishing a core database version in the open source, we do additional validation in our cloud staging environment, which typically takes 6-8 weeks before rolling out to production. The rollout is phased out by cloud service provider, service type, and region.
2849

docs/cloud/get-started/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Welcome to ClickHouse Cloud! Explore the pages below to learn more about what Cl
99

1010
| Page | Description |
1111
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
12-
| [Overview](/cloud/overview) | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it. |
13-
| [Cloud Quick Start](/cloud/get-started/cloud-quick-start) | Quick start guide to get up and running with Cloud. |
12+
| [Overview](/cloud/overview) | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it. |
1413
| [SQL Console](/cloud/get-started/sql-console) | Learn about the interactive SQL console available in Cloud |
1514
| [Query Insights](/cloud/get-started/query-insights) | Learn about how Cloud's Query Insights feature makes ClickHouse's built-in query log easier to use through various visualizations and tables. |
1615
| [Query Endpoints](/cloud/get-started/query-endpoints) | Learn about the Query API Endpoints feature which allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. |

docs/deployment-modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This deployment mode is the go-to choice for production environments where relia
4545

4646
<Image img={chCloud} alt="ClickHouse Cloud" size="sm"/>
4747

48-
A key advantage of ClickHouse Cloud is its integrated tooling. [ClickPipes](/cloud/get-started/cloud-quick-start#clickpipes) provides a robust data ingestion framework, allowing you to easily connect and stream data from various sources without managing complex ETL pipelines. The platform also offers a dedicated [querying API](/cloud/get-started/query-endpoints), making it significantly easier to build applications.
48+
A key advantage of ClickHouse Cloud is its integrated tooling. [ClickPipes](/getting-started/quick-start/cloud/#clickpipes) provides a robust data ingestion framework, allowing you to easily connect and stream data from various sources without managing complex ETL pipelines. The platform also offers a dedicated [querying API](/cloud/get-started/query-endpoints), making it significantly easier to build applications.
4949

5050
The SQL Console in ClickHouse Cloud includes a powerful [dashboarding](/cloud/manage/dashboards) feature that lets you transform your queries into interactive visualizations. You can create and share dashboards built from your saved queries, with the ability to add interactive elements through query parameters. These dashboards can be made dynamic using global filters, allowing users to explore data through customizable views – though it's important to note that users will need at least read access to the underlying saved queries to view the visualizations.
5151

docs/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: 'Tutorials and Example Datasets'
1212

1313
We have a lot of resources for helping you get started and learn how ClickHouse works:
1414

15-
- If you need to get ClickHouse up and running, check out our [Quick Start](../quick-start.mdx)
15+
- If you need to get ClickHouse up and running, check out our [Quick Start](/get-started/quick-start)
1616
- The [ClickHouse Tutorial](../tutorial.md) analyzes a dataset of New York City taxi rides
1717

1818
In addition, the sample datasets provide a great experience on working with ClickHouse,

docs/getting-started/install/_snippets/_quick_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ template](https://github.com/ClickHouse/ClickHouse/blob/master/programs/server/c
7171
You are now ready to start sending SQL commands to ClickHouse!
7272

7373
:::tip
74-
The [Quick Start](/quick-start.mdx) walks through the steps for creating tables and inserting data.
74+
The [Quick Start](/get-started/quick-start) walks through the steps for creating tables and inserting data.
7575
:::
7676

7777
</VerticalStepper>

docs/cloud/get-started/cloud-quick-start.mdx renamed to docs/getting-started/quick-start/cloud.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
sidebar_position: 1
3-
slug: /cloud/get-started/cloud-quick-start
4-
sidebar_label: 'Cloud Quick Start'
3+
slug: /getting-started/quick-start/cloud
4+
sidebar_label: 'Cloud'
55
keywords: ['clickhouse', 'install', 'getting started', 'quick start']
6-
pagination_next: cloud/get-started/sql-console
7-
title: 'ClickHouse Cloud Quick Start'
6+
title: 'ClickHouse Cloud quick start'
87
description: 'Quick start guide for ClickHouse Cloud'
98
---
109

@@ -22,10 +21,11 @@ import client_details from '@site/static/images/_snippets/client_details.png';
2221
import new_rows_from_csv from '@site/static/images/_snippets/new_rows_from_csv.png';
2322
import SQLConsoleDetail from '@site/docs/_snippets/_launch_sql_console.md';
2423

25-
# ClickHouse Cloud Quick Start
24+
# ClickHouse Cloud quick start
2625

27-
The quickest and easiest way to get up and running with ClickHouse is to create a new
28-
service in [ClickHouse Cloud](https://console.clickhouse.cloud).
26+
> The quickest and easiest way to get up and running with ClickHouse is to create a new
27+
service in [ClickHouse Cloud](https://console.clickhouse.cloud). In this quick start guide, we'll get you setup
28+
in three easy steps.
2929

3030
<VerticalStepper type="numbered">
3131

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
description: 'Get up and running on ClickHouse in minutes, explore some sample data, and build your solution'
3+
keywords: ['clickhouse', 'quick start']
4+
sidebar_label: 'Quick start'
5+
sidebar_position: 0
6+
slug: /get-started/quick-start
7+
title: 'Quick start'
8+
---
9+
10+
import {CardSecondary, CardPromotion} from '@clickhouse/click-ui/bundled';
11+
import Link from '@docusaurus/Link';
12+
13+
<div style={{
14+
display: 'inline-flex',
15+
flexDirection: 'column',
16+
width: '100%',
17+
maxWidth: 'calc(700px + 1rem)'
18+
}}>
19+
<div style={{
20+
display: 'flex',
21+
flexDirection: 'row',
22+
flexWrap: 'wrap',
23+
gap: '1rem',
24+
marginBottom: '1rem',
25+
width: '100%',
26+
'@media (max-width: 996px)': {
27+
flexDirection: 'column'
28+
}
29+
}}>
30+
<div style={{
31+
flex: '1 1 300px',
32+
minWidth: '0',
33+
maxWidth: '100%',
34+
'@media (max-width: 996px)': {
35+
width: '100%',
36+
maxWidth: 'none',
37+
flex: '1 1 auto'
38+
}
39+
}}>
40+
<Link to="/getting-started/quick-start/cloud" style={{textDecoration: 'none', width: '100%'}}>
41+
<CardSecondary
42+
badgeState="success"
43+
badgeText="recommended"
44+
description="Get started with ClickHouse Cloud in minutes.
45+
We'll walk you through creating a ClickHouse service,
46+
connecting to ClickHouse and adding data to your service via
47+
CDC, SQL console, local client or file upload.
48+
"
49+
icon="cloud"
50+
infoText="Get started"
51+
infoUrl="clickhouse.com/docs/getting-started/quick-start/cloud"
52+
title="Cloud quick start"
53+
style={{width: '100%', height: '100%'}}
54+
/>
55+
</Link>
56+
</div>
57+
<div style={{
58+
flex: '1 1 300px',
59+
minWidth: '0',
60+
maxWidth: '100%',
61+
'@media (max-width: 996px)': {
62+
width: '100%',
63+
maxWidth: 'none',
64+
flex: '1 1 auto'
65+
}
66+
}}>
67+
<Link to="/getting-started/quick-start/oss" style={{textDecoration: 'none', width: '100%'}}>
68+
<CardSecondary
69+
badgeState="success"
70+
description="Get started with OSS ClickHouse in minutes. You'll
71+
learn how to install ClickHouse server and client locally, create a
72+
table and insert some example data into it, and explore the many ways
73+
you can get your own data into ClickHouse.
74+
"
75+
icon="server"
76+
infoText="Get started"
77+
infoUrl="clickhouse.com/docs/getting-started/quick-start/oss"
78+
title="OSS quick start"
79+
style={{width: '100%', height: '100%'}}
80+
/>
81+
</Link>
82+
</div>
83+
</div>
84+
<div style={{
85+
width: '100%',
86+
'@media (max-width: 996px)': {
87+
maxWidth: '100%',
88+
margin: '0'
89+
}
90+
}}>
91+
<Link to="/cloud/overview" style={{textDecoration: 'none', width: '100%'}}>
92+
<CardPromotion
93+
icon="question"
94+
label="Not sure which to choose? Click here to learn about the differences between Cloud and OSS ClickHouse"
95+
style={{
96+
display: 'flex',
97+
flex: '1',
98+
width: '100%',
99+
minHeight: 'auto',
100+
alignItems: 'flex-start',
101+
padding: '1rem',
102+
boxSizing: 'border-box',
103+
cursor: 'pointer'
104+
}}
105+
/>
106+
</Link>
107+
</div>
108+
</div>

docs/quick-start.mdx renamed to docs/getting-started/quick-start/oss.mdx

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
slug: /getting-started/quick-start
3-
sidebar_label: 'Quick Start'
2+
slug: /getting-started/quick-start/oss
3+
sidebar_label: 'OSS'
44
sidebar_position: 1
55
keywords: ['getting started', 'quick start', 'beginner-friendly']
6-
pagination_next: getting-started/index
7-
title: 'Quick Start'
6+
title: 'ClickHouse OSS quick start'
87
description: 'ClickHouse Quick Start guide'
98
show_related_blogs: true
109
---
@@ -14,15 +13,13 @@ import TabItem from '@theme/TabItem';
1413
import CodeBlock from '@theme/CodeBlock';
1514
import {VerticalStepper} from '@clickhouse/click-ui/bundled';
1615

17-
**Welcome to ClickHouse!**
16+
# ClickHouse OSS quick start
1817

19-
In this quick-start tutorial, we'll get you set up in 8
18+
> In this quick start tutorial, we'll get you set up with OSS ClickHousein 8
2019
easy steps. You'll download an appropriate binary for your OS,
2120
learn to run ClickHouse server, and use the ClickHouse client to create a table,
2221
then insert data into it and run a query to select that data.
2322

24-
Let's get started?
25-
2623
<VerticalStepper>
2724

2825
## Download ClickHouse {#download-the-binary}

docs/guides/best-practices/sparse-primary-indexes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ In this guide we are going to do a deep dive into ClickHouse indexing. We will i
4343
- [what some of the best practices are for indexing in ClickHouse](#using-multiple-primary-indexes)
4444

4545
You can optionally execute all ClickHouse SQL statements and queries given in this guide by yourself on your own machine.
46-
For installation of ClickHouse and getting started instructions, see the [Quick Start](/quick-start.mdx).
46+
For installation of ClickHouse and getting started instructions, see the [Quick Start](/get-started/quick-start).
4747

4848
:::note
4949
This guide is focusing on ClickHouse sparse primary indexes.

docs/guides/sre/keeper/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ If you have ClickHouse installed, you can use the binary directly:
480480
clickhouse keeper-converter ...
481481
```
482482

483-
Otherwise, you can [download the binary](/getting-started/quick-start#download-the-binary) and run the tool as described above without installing ClickHouse.
483+
Otherwise, you can [download the binary](/getting-started/quick-start/oss#download-the-binary) and run the tool as described above without installing ClickHouse.
484484
:::
485485

486486

0 commit comments

Comments
 (0)