Skip to content

Commit 1cebe1c

Browse files
BlargianBlargian
committed
restructure getting started
1 parent e7af6bb commit 1cebe1c

File tree

7 files changed

+164
-25
lines changed

7 files changed

+164
-25
lines changed

‎docs/about-us/cloud.md

Lines changed: 22 additions & 3 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,10 +22,29 @@ 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+
## OSS vs ClickHouse Cloud comparison {#oss-vs-clickhouse-cloud}
26+
27+
| Feature | Benefits | OSS ClickHouse | ClickHouse Cloud |
28+
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------|
29+
| **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. | ✅ | ✅ |
30+
| **Storage** | As an open-source and cloud-hosted product, ClickHouse can be deployed in both shared-disk and shared-nothing architectures. | ✅ | ✅ |
31+
| **Monitoring and alerting** | Monitoring and alerting about the status of your services is critical to ensuring optimal performance and a proactive approach to detecting and triaging potential issues. | ✅ | ✅ |
32+
| **ClickPipes** | This integration template data ingestion from 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. | ❌ | ✅ |
33+
| **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. | ❌ | ✅ |
34+
| **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. | ❌ | ✅ |
35+
| **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. | ❌ | ✅ |
36+
| **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. | ❌ | ✅ |
37+
| **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. | ❌ | ✅ |
38+
| **Support services** | Our best-in-class support services and open-source community resources provide coverage for whichever deployment model you choose. | ❌ | ✅ |
39+
| **Database upgrades** | Regular database upgrades are essential to establish a strong security posture and access the latest features and performance improvements. | ❌ | ✅ |
40+
| **Backups** | Backups and restore functionality ensures data durability and supports graceful recovery in the event of outages or other disruptions. | ❌ | ✅ |
41+
| **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 once performance doesn't interfere with another's, enhancing flexibility, performance, and cost-efficiency. | ❌ | ✅ |
42+
| **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. | ❌ | ✅ |
43+
44+
## What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
2645

2746
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.
2847

2948
We offer a "Fast" Release Channel for subscribing to updates ahead of the regular release schedule. For more details, see ["Fast Release Channel"](/manage/updates#fast-release-channel-early-upgrades).
3049

31-
If you rely on functionality in the earlier version, you can, in some cases, revert to the previous behavior using your service's compatibility setting.
50+
If you rely on functionality in the earlier version, you can, in some cases, revert to the previous behavior using your service's compatibility setting.

‎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/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: '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

‎docs/getting-started/quick-start/index.mdx

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
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+
<CardSecondary
41+
badgeState="success"
42+
badgeText="recommended"
43+
description="Get started with ClickHouse Cloud in minutes.
44+
We'll walk you through creating a ClickHouse service,
45+
connecting to ClickHouse and adding data to your service via
46+
CDC, SQL console, local client or file upload.
47+
"
48+
icon="cloud"
49+
infoText="Get started"
50+
infoUrl="https://clickhouse.com"
51+
title="Cloud quick start"
52+
style={{width: '100%', height: '100%'}}
53+
/>
54+
</div>
55+
<div style={{
56+
flex: '1 1 300px',
57+
minWidth: '0',
58+
maxWidth: '100%',
59+
'@media (max-width: 996px)': {
60+
width: '100%',
61+
maxWidth: 'none',
62+
flex: '1 1 auto'
63+
}
64+
}}>
65+
<CardSecondary
66+
badgeState="success"
67+
description="Get started with OSS ClickHouse in minutes. You'll
68+
learn how to install ClickHouse server and client locally, create a
69+
table and insert some example data into it, and explore the many ways
70+
you can get your own data into ClickHouse.
71+
"
72+
icon="server"
73+
infoText="Get started"
74+
infoUrl="/"
75+
title="OSS quick start"
76+
style={{width: '100%', height: '100%'}}
77+
/>
78+
</div>
79+
</div>
80+
<div style={{
81+
width: '100%',
82+
'@media (max-width: 996px)': {
83+
maxWidth: '100%',
84+
margin: '0'
85+
}
86+
}}>
87+
<Link to="/cloud/overview#oss-vs-clickhouse-cloud" style={{textDecoration: 'none', width: '100%'}}>
88+
<CardPromotion
89+
icon="question"
90+
label="Not sure which to choose? Click here to learn about the differences between Cloud and OSS ClickHouse"
91+
style={{
92+
display: 'flex',
93+
flex: '1',
94+
width: '100%',
95+
minHeight: 'auto',
96+
alignItems: 'flex-start',
97+
padding: '1rem',
98+
boxSizing: 'border-box',
99+
cursor: 'pointer'
100+
}}
101+
/>
102+
</Link>
103+
</div>
104+
</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: '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+
# 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}

‎sidebars.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,16 @@ const sidebars = {
1414
link: { type: "doc", id: "introduction-index" },
1515
items: [
1616
"intro",
17-
"quick-start",
17+
{
18+
type: "category",
19+
label: "Quick start",
20+
collapsed: false,
21+
link: { type: "doc", id: "getting-started/quick-start/index" },
22+
items: [
23+
{ type: "doc", id: "getting-started/quick-start/cloud" },
24+
{ type: "doc", id: "getting-started/quick-start/oss" }
25+
]
26+
},
1827
"tutorial",
1928
{
2029
type: "category",
@@ -244,10 +253,6 @@ const sidebars = {
244253
link: { type: "doc", id: "cloud/get-started/index" },
245254
items: [
246255
"cloud-index",
247-
{
248-
type: "doc",
249-
id: "cloud/get-started/cloud-quick-start",
250-
},
251256
"cloud/get-started/sql-console",
252257
"cloud/get-started/query-insights",
253258
"cloud/get-started/query-endpoints",

‎vercel.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3355,6 +3355,21 @@
33553355
"source": "/docs/migrations/rockset",
33563356
"destination": "/docs/migrations/migrations",
33573357
"permanent": true
3358+
},
3359+
{
3360+
"source": "/docs/cloud/get-started/cloud-quick-start",
3361+
"destination": "/docs/cloud/get-started/sql-console",
3362+
"permanent": true
3363+
},
3364+
{
3365+
"source": "/docs/cloud/get-started/cloud-quick-start",
3366+
"destination": "/docs/cloud/get-started/sql-console",
3367+
"permanent": true
3368+
},
3369+
{
3370+
"source" : "/docs/getting-started/quick-star",
3371+
"destination" : "/getting-started/quick-start/oss",
3372+
"permanent" : true
33583373
}
33593374
]
33603375
}

0 commit comments

Comments
 (0)