Skip to content

Commit c06f322

Browse files
committed
Install: Improve syntax/formatting after converting to MyST Markdown
1 parent e539f4b commit c06f322

File tree

16 files changed

+169
-201
lines changed

16 files changed

+169
-201
lines changed

docs/install/_control-linux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
You can control the `crate` service with the `systemctl` utility program:
55

6-
```
6+
```shell
77
sudo systemctl COMMAND crate
88
```
99

@@ -17,12 +17,12 @@ After the installation is finished, the `crate` service should be installed,
1717
but may not be configured to start automatically. Use the following command to
1818
start CrateDB:
1919

20-
```
20+
```shell
2121
sudo systemctl start crate
2222
```
2323

2424
In order to make the service reboot-safe, invoke:
2525

26-
```
26+
```shell
2727
sudo systemctl enable crate
2828
```

docs/install/cloud/aws/aws-terraform-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(aws-terraform-setup)=
22

3-
# Running CrateDB via Terraform
3+
# Deploy using Terraform
44

55
In {ref}`ec2_setup`, we elaborated on how to leverage EC2's functionality to set
66
up a CrateDB cluster. Here, we will explore how to automate this kind of setup.
@@ -50,7 +50,7 @@ The CrateDB Terraform configuration consists of a set of variables to customize
5050
your deployment. Create a new file `main.tf` with the following content and
5151
adjust variable values as needed:
5252

53-
```
53+
```terraform
5454
module "cratedb-cluster" {
5555
source = "github.com/crate/crate-terraform.git/aws"
5656

docs/install/cloud/aws/ec2-setup.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
```{highlight} yaml
2-
```
3-
41
(ec2-setup)=
52

6-
# Running CrateDB on Amazon EC2
3+
# CrateDB on Amazon EC2
74

85
## Introduction
96

@@ -60,7 +57,7 @@ CrateDB binds to the loopback interface by default. To get EC2 discovery
6057
working, you need to update the {ref}`host <crate-reference:conf_hosts>`
6158
setting, in order to bind to and publish the site-local address:
6259

63-
```
60+
```yaml
6461
network.host: _site_
6562
```
6663
@@ -134,7 +131,7 @@ security group then, you can easily filter instances by that group.
134131
For example, when you launch your instances with the security group
135132
`sg-crate-demo`, your CrateDB setting would be:
136133

137-
```
134+
```yaml
138135
discovery.ec2.groups: sg-crate-demo
139136
```
140137
@@ -181,7 +178,7 @@ This way, any number of tags can be used for filtering, using the
181178
Filtering by tags can help when you want to launch several CrateDB clusters
182179
within the same security group, e.g:
183180

184-
```
181+
```yaml
185182
discovery.ec2:
186183
groups: sg-crate-demo
187184
tag.env: production
@@ -198,7 +195,7 @@ you have several clusters for the same tenant in different availability zones
198195
same security group (e.g. `sg-crate-demo`) and filter the instances used for
199196
discovery by availability zone:
200197

201-
```
198+
```yaml
202199
discovery.ec2:
203200
groups: sg-crate-demo
204201
availability_zones: us-west-1

docs/install/cloud/aws/s3-setup.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
```{highlight} yaml
2-
```
3-
41
(s3-setup)=
52

63
# Using Amazon S3 as a snapshot repository
@@ -15,7 +12,7 @@ Support for *Snapshot* and *Restore* to the [Amazon S3] service is enabled by
1512
default in CrateDB. If you need to explicitly turn it off, disable the cloud
1613
setting in the `crate.yml` file:
1714

18-
```
15+
```yaml
1916
cloud.enabled: false
2017
```
2118

docs/install/cloud/azure/terraform.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(azure-terraform-setup)=
22

3-
# Running CrateDB via Terraform
3+
# Deploy using Terraform
44

55
In {ref}`azure_vm_setup`, we elaborated on how to leverage Azure's functionality to
66
set up a CrateDB cluster. Here, we will explore how to automate this kind of
@@ -51,7 +51,7 @@ The CrateDB Terraform configuration consists of a set of variables to customize
5151
your deployment. Create a new file `main.tf` with the following content and
5252
adjust variable values as needed:
5353

54-
```
54+
```terraform
5555
module "cratedb-cluster" {
5656
source = "github.com/crate/crate-terraform.git/azure"
5757

docs/install/cloud/azure/vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(azure-vm-setup)=
22

3-
# Running CrateDB on Azure VMs
3+
# CrateDB on Azure VMs
44

55
Getting CrateDB working on Azure with Linux or Windows is a simple process. You
66
can use Azure's management console or CLI interface ([Learn how to install

docs/install/cloud/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(install-cloud)=
22

3-
# Cloud Hosting
3+
# Cloud hosting
44

55
CrateDB provides packages and executables that will work on any operating
66
system capable of running Java.

docs/install/configure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ working directory.
3232

3333
Here is an example:
3434

35-
```
35+
```shell
3636
# Configure heap size (defaults to 256m min, 1g max).
3737
CRATE_HEAP_SIZE=2g
3838

docs/install/container/docker.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
```{highlight} sh
2-
```
3-
41
(cratedb-docker)=
52

63
# Run CrateDB on Docker
@@ -35,7 +32,7 @@ with no vote.
3532

3633
To create the [user-defined network], run the command:
3734

38-
```
35+
```shell
3936
sh$ docker network create crate
4037
```
4138

@@ -120,7 +117,7 @@ f79116373877 crate "/docker-entrypoin..." 16 seconds ago
120117

121118
You can have a look at the container's logs in tail mode like this:
122119

123-
```text
120+
```shell
124121
sh$ docker logs -f crate01
125122
```
126123

@@ -139,7 +136,7 @@ page that lists a single node.
139136

140137
Now add the second node, `crate02`, to the cluster:
141138

142-
```
139+
```shell
143140
sh$ docker run --rm -d \
144141
--name=crate02 \
145142
--net=crate \
@@ -169,7 +166,7 @@ should see two nodes.
169166

170167
You can now add `crate03` like this:
171168

172-
```
169+
```shell
173170
sh$ docker run --rm -d \
174171
--name=crate03 \
175172
--net=crate -p 4203:4200 \
@@ -213,7 +210,7 @@ If the limit cannot be adjusted on the host system, the memory map limit check
213210
can be bypassed by passing the `-Cnode.store.allow_mmap=false` option to
214211
the `crate` command:
215212

216-
```
213+
```shell
217214
sh$ docker run -d --name=crate01 \
218215
--net=crate -p 4201:4200 --env CRATE_HEAP_SIZE=1g \
219216
crate -Cnetwork.host=_site_ \
@@ -227,7 +224,7 @@ This will result in degraded performance.
227224
You can also start a single node without any {ref}`bootstrap checks
228225
<bootstrap-checks>` by passing the `-Cdiscovery.type=single-node` option:
229226

230-
```
227+
```shell
231228
sh$ docker run -d --name=crate01 \
232229
--net=crate -p 4201:4200 \
233230
--env CRATE_HEAP_SIZE=1g \
@@ -255,7 +252,7 @@ If you wanted to run `crash` inside a user-defined network called `crate`
255252
and connect to three hosts named `crate01`, `crate02`, and `crate03`
256253
(i.e. the example covered in the [Creating a Cluster] section) you could run:
257254

258-
```
255+
```shell
259256
$ docker run --rm -ti \
260257
--net=crate crate \
261258
crash --hosts crate01 crate02 crate03
@@ -370,7 +367,7 @@ per host machine.
370367
If you are running one container per machine, you can map the container ports
371368
to the host ports so that the host acts like a native installation. For example:
372369

373-
```
370+
```shell
374371
$ docker run -d -p 4200:4200 -p 4300:4300 -p 5432:5432 --env CRATE_HEAP_SIZE=1g crate \
375372
crate -Cnetwork.host=_site_
376373
```
@@ -382,7 +379,7 @@ and go, and any data inside them is lost when the container is removed. For
382379
this reason, you should mount a persistent `data` directory on your host
383380
machine to the `/data` directory inside the container:
384381

385-
```
382+
```shell
386383
$ docker run -d -v /srv/crate/data:/data --env CRATE_HEAP_SIZE=1g crate \
387384
crate -Cnetwork.host=_site_
388385
```
@@ -401,7 +398,7 @@ removed.
401398

402399
Here is an example of how you could mount the `crate.yml` config file:
403400

404-
```
401+
```shell
405402
$ docker run -d \
406403
-v /srv/crate/config/crate.yml:/crate/config/crate.yml \
407404
--env CRATE_HEAP_SIZE=1g crate \
@@ -470,7 +467,7 @@ If you want the container to use a maximum of 1.5 CPUs, a maximum of 2 GB
470467
memory, with a heap size of 1 GB, you could configure everything at once. For
471468
example:
472469

473-
```
470+
```shell
474471
$ docker run -d \
475472
--cpus 1.5 \
476473
--memory 1g \

docs/install/container/index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
(install-container)=
22

3-
# Container Setup
3+
# Container setup
44

5-
```{eval-rst}
6-
.. div:: sd-text-muted
7-
8-
Install CrateDB in container environments.
9-
```
5+
:::{div} sd-text-muted
6+
Install CrateDB in container environments.
7+
:::
108

119
CrateDB is ideal for containerized environments, creating and scaling a cluster
1210
takes minutes and your valuable data is always in sync and available.

0 commit comments

Comments
 (0)