Skip to content

Commit 16b09ff

Browse files
authored
Merge pull request #3760 from Blargian/improve_installation_guide
Improve installation guide
2 parents bc87dd1 + 87aaeb2 commit 16b09ff

Some content is hidden

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

43 files changed

+1217
-484
lines changed

docs/architecture/cluster-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Cluster Deployment'
66
description: 'By going through this tutorial, you will learn how to set up a simple ClickHouse cluster.'
77
---
88

9-
This tutorial assumes you've already set up a [local ClickHouse server](../getting-started/install.md)
9+
This tutorial assumes you've already set up a [local ClickHouse server](../getting-started/install/install.mdx)
1010

1111
By going through this tutorial, you'll learn how to set up a simple ClickHouse cluster. It'll be small, but fault-tolerant and scalable. Then we will use one of the example datasets to fill it with data and execute some demo queries.
1212

docs/guides/sizing-and-hardware-recommendations.md renamed to docs/best-practices/sizing-and-hardware-recommendations.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,14 @@ As an example, when using M-type CPUs, we recommend provisioning 100GB of memory
6969

7070
## Memory {#memory}
7171

72-
Like your choice of CPU, your choice of memory to storage ratio and memory to CPU ratio is dependent on your case. In general, however, the more memory you have, the faster your queries will run. If your use case is sensitive to price, lower amounts of memory will work as it is possible to enable settings ([`max_bytes_before_external_group_by`](/operations/settings/settings#max_bytes_before_external_group_by) and [`max_bytes_before_external_sort`](/operations/settings/settings#max_bytes_before_external_sort)) to allow spilling data to disk, but note that this may significantly affect query performance.
72+
Like your choice of CPU, your choice of memory to storage ratio and memory to CPU ratio is dependent on your use-case.
73+
74+
The required volume of RAM generally depends on:
75+
- The complexity of queries.
76+
- The amount of data that is processed in queries.
77+
78+
In general, however, the more memory you have, the faster your queries will run.
79+
If your use case is sensitive to price, lower amounts of memory will work as it is possible to enable settings ([`max_bytes_before_external_group_by`](/operations/settings/settings#max_bytes_before_external_group_by) and [`max_bytes_before_external_sort`](/operations/settings/settings#max_bytes_before_external_sort)) to allow spilling data to disk, but note that this may significantly affect query performance.
7380

7481
### What should the memory to storage ratio be? {#what-should-the-memory-to-storage-ratio-be}
7582

docs/deployment-guides/horizontal-scaling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ This example architecture is designed to provide scalability. It includes three
3030
|`chnode3`|Used for ClickHouse Keeper quorum|
3131

3232
:::note
33-
In production environments we strongly recommend that ClickHouse Keeper runs on dedicated hosts. This basic configuration runs the Keeper functionality within the ClickHouse Server process. The instructions for deploying ClickHouse Keeper standalone are available in the [installation documentation](/getting-started/install.md/#install-standalone-clickhouse-keeper).
33+
In production environments we strongly recommend that ClickHouse Keeper runs on dedicated hosts. This basic configuration runs the Keeper functionality within the ClickHouse Server process. The instructions for deploying ClickHouse Keeper standalone are available in the [installation documentation](/getting-started/install/install.mdx).
3434
:::
3535

3636
## Install {#install}
3737

38-
Install Clickhouse on three servers following the [instructions for your archive type](/getting-started/install.md/#available-installation-options) (.deb, .rpm, .tar.gz, etc.). For this example, you will follow the installation instructions for ClickHouse Server and Client on all three machines.
38+
Install Clickhouse on three servers following the [instructions for your archive type](/getting-started/install/install.mdx) (.deb, .rpm, .tar.gz, etc.). For this example, you will follow the installation instructions for ClickHouse Server and Client on all three machines.
3939

4040
## Editing configuration files {#editing-configuration-files}
4141

docs/deployment-guides/replicated.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ In production environments, we strongly recommend using *dedicated* hosts for Cl
3838

3939
## Install {#install}
4040

41-
Install ClickHouse server and client on the two servers `clickhouse-01` and `clickhouse-02` following the [instructions for your archive type](/getting-started/install.md/#available-installation-options) (.deb, .rpm, .tar.gz, etc.).
41+
Install ClickHouse server and client on the two servers `clickhouse-01` and `clickhouse-02` following the [instructions for your archive type](/getting-started/install/install.mdx) (.deb, .rpm, .tar.gz, etc.).
4242

43-
Install ClickHouse Keeper on the three servers `clickhouse-keeper-01`, `clickhouse-keeper-02` and `clickhouse-keeper-03` following the [instructions for your archive type](/getting-started/install.md/#install-standalone-clickhouse-keeper) (.deb, .rpm, .tar.gz, etc.).
43+
Install ClickHouse Keeper on the three servers `clickhouse-keeper-01`, `clickhouse-keeper-02` and `clickhouse-keeper-03` following the [instructions for your archive type](/getting-started/install/install.mdx) (.deb, .rpm, .tar.gz, etc.).
4444

4545
## Editing configuration files {#editing-configuration-files}
4646

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ The dataset used in this guide comes from the NYC Open Data team, and contains d
2121

2222
## Prerequisites {#prerequisites}
2323
- Download the dataset by visiting the [NYPD Complaint Data Current (Year To Date)](https://data.cityofnewyork.us/Public-Safety/NYPD-Complaint-Data-Current-Year-To-Date-/5uac-w243) page, clicking the Export button, and choosing **TSV for Excel**.
24-
- Install [ClickHouse server and client](../../getting-started/install.md).
25-
- [Launch](../../getting-started/install.md#launch) ClickHouse server, and connect with `clickhouse-client`
24+
- Install [ClickHouse server and client](../../getting-started/install/install.mdx)
2625

2726
### A note about the commands described in this guide {#a-note-about-the-commands-described-in-this-guide}
2827
There are two types of commands in this guide:

0 commit comments

Comments
 (0)