Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions docs/admin/clustering/index.md

This file was deleted.

11 changes: 5 additions & 6 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,17 @@ circuit-breaker
troubleshooting/index
```
+++
Production and troubleshooting guidelines and system resource considerations.
Production recommendations and troubleshooting guidelines.
::::

::::{grid-item-card} {material-outlined}`speed;2em` Cluster
::::{grid-item-card} {material-outlined}`speed;2em` Capacity Management
```{toctree}
:maxdepth: 1
:maxdepth: 2

clustering/index
Scaling <scale/index>
```
+++
Best practices and tips for clustering, sharding, and partitioning.
Best practices for scaling your cluster up and down.
::::

::::{grid-item-card} {material-outlined}`system_update_alt;2em` Software Upgrades
Expand All @@ -44,7 +43,7 @@ Best practices and tips for clustering, sharding, and partitioning.
upgrade/index
```
+++
Guidelines for upgrading CrateDB clusters in production—from planning to execution.
Upgrading CrateDB clusters in production—from planning to execution.
::::

:::::
6 changes: 3 additions & 3 deletions docs/install/configure.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
(install-configure)=

# Configuration Settings
# Configuration settings

In order to configure CrateDB, please take note of the configuration file
locations and the available environment variables.

## Configuration Files
## Configuration files

When using the package-based setup flavor for {ref}`install-deb` or
{ref}`install-rpm`, the main CrateDB configuration files are located within the
Expand All @@ -15,7 +15,7 @@ When using the {ref}`install-tarball` setup, or the {ref}`Microsoft Windows <ins
setup, the configuration files are located within the `config/` directory relative to the
working directory.

## Environment Variables
## Environment variables

For the vanilla package-based setup flavor, the CrateDB startup script reads
{ref}`crate-reference:conf-env` from the `/etc/default/crate` file as
Expand Down
48 changes: 46 additions & 2 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ cloud/index
configure
:::

:::{toctree}
:maxdepth: 1
:hidden:
multi-node
multi-zone
:::

% Layout stolen from Streamlink.

% https://github.com/streamlink/streamlink/blob/master/docs/install.rst?plain=1
Expand Down Expand Up @@ -135,10 +142,47 @@ configure

We recommend to use the package-based installation methods for {ref}`install-deb` and
{ref}`install-rpm`, by subscribing to the corresponding package release channels.

Alternatively, you can also do an {ref}`install-tarball`.

## Notes
(admin-clustering)=

:::{rubric} Cluster configuration
:::

In most environments, CrateDB is run as a cluster of three or more nodes.
Sometimes, it is needed to run a cluster across multiple data centers or availability zones.

::::{grid} 2 3 3 4
:gutter: 3
:padding: 0
:class-container: installation-grid

:::{grid-item-card} Multi-node setup
:link: multi-node-setup
:link-type: ref
:link-alt: Configure CrateDB in a multi-node setup
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-6
{material-outlined}`apps`
:::

:::{grid-item-card} Multi-zone setup
:link: multi-zone-setup
:link-type: ref
:link-alt: Configure CrateDB in a multi-zone setup
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-6
{material-outlined}`hub`
:::

::::

:::{rubric} Notes
:::

After the installation is finished, the CrateDB service should be up and
running, and will run a HTTP server on `localhost:4200`. To access the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(multi-node-setup)=

# CrateDB multi-node setup
# Multi-node setup

CrateDB can run on a single node. However, in most environments, CrateDB is run
as a cluster of three or more nodes.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(multi-zone-setup)=

# CrateDB multi-zone setup
# Multi-zone setup

If possible, we recommend running all CrateDB nodes of a cluster inside the
same physical space to minimize network latency and maximize speed between the
Expand Down