Skip to content

Commit e539f4b

Browse files
amotlamotl
committed
Install: Fix formatting after converting to MyST Markdown
1 parent 59a26f1 commit e539f4b

File tree

5 files changed

+71
-31
lines changed

5 files changed

+71
-31
lines changed

‎docs/install/_control-linux.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Control CrateDB on Linux
1+
:::{rubric} Control CrateDB on Linux
2+
:::
23

34
You can control the `crate` service with the `systemctl` utility program:
45

@@ -9,7 +10,8 @@ sudo systemctl COMMAND crate
910
Replace `COMMAND` with `start`, `stop`, `restart`, `status` and
1011
so on.
1112

12-
# Notes
13+
:::{rubric} Notes
14+
:::
1315

1416
After the installation is finished, the `crate` service should be installed,
1517
but may not be configured to start automatically. Use the following command to

‎docs/install/_post-install.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Post-install notes
1+
:::{rubric} Post-install notes
2+
:::
23

34
After successfully installing CrateDB, for example on your workstation, the web-based
45
Admin UI can be visited at:

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,24 @@ with the same cluster name and form a cluster.
3232
Once you have your instances running and CrateDB installed, you can enable EC2
3333
discovery:
3434

35-
| CrateDB Version | Reference | Example |
36-
| --------------- | --------- | ------- |
37-
| >=4.x | [latest] | ```
38-
discovery.seed_providers: ec2 ``` |
39-
| \<=3.x | [3.3] | ```
40-
discovery.zen.hosts_provider: ec2 ``` |
35+
````{list-table}
36+
---
37+
header-rows: 1
38+
---
39+
* - CrateDB Version
40+
- Reference
41+
- Configuration Example
42+
* - \>=4.x
43+
- [latest]
44+
- ```yaml
45+
discovery.seed_providers: ec2
46+
```
47+
* - <=3.x
48+
- [3.3]
49+
- ```yaml
50+
discovery.zen.hosts_provider: ec2
51+
```
52+
````
4153

4254
To be able to use the EC2 API, CrateDB must [sign the requests] by using
4355
AWS credentials consisting of an access key and a secret key. Therefore

‎docs/install/cloud/azure/terraform.md‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -105,22 +105,26 @@ output "cratedb" {
105105

106106
The Azure-specific variables need to be adjusted according to your environment:
107107

108-
```{eval-rst}
109-
+--------------------------+--------------------------------------------------------------+----------------------------------+
110-
| Variable | Explanation | How to obtain |
111-
+==========================+==============================================================+==================================+
112-
| ``subscription_id`` | The ID of the Azure subscription to use for creating the | ``az account list`` |
113-
| | resource group in | |
114-
+---------------+----------+--------------------------------------------------------------+----------------------------------+
115-
| ``location`` | The geographic region in which to create the Azure | ``az account list-locations`` |
116-
| | resources | |
117-
+---------------+----------+--------------------------------------------------------------+----------------------------------+
118-
| ``storage_account_type`` | Storage Account Type of the disk containing the CrateDB | [List of Storage Account Types] |
119-
| | data directory | |
120-
+--------------------------+--------------------------------------------------------------+----------------------------------+
121-
| ``size`` | Specifies the size of the VM | ``az vm list-sizes`` |
122-
+--------------------------+--------------------------------------------------------------+----------------------------------+
123-
```
108+
````{list-table}
109+
---
110+
header-rows: 1
111+
---
112+
* - Variable
113+
- Explanation
114+
- How to obtain
115+
* - `subscription_id`
116+
- The ID of the Azure subscription to use for creating the resource group in.
117+
- `az account list`
118+
* - `location`
119+
- The geographic region in which to create the Azure resources.
120+
- `az account list-locations`
121+
* - `storage_account_type`
122+
- Storage Account Type of the disk containing the CrateDB data directory.
123+
- [List of Storage Account Types]
124+
* - `size`
125+
- Specifies the size of the VM.
126+
- `az vm list-sizes`
127+
````
124128

125129
## Execution
126130

‎docs/install/cloud/azure/vm.md‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,33 @@ configuration file at */etc/crate/crate.yml*.
9393

9494
Uncomment / add these lines:
9595

96-
| CrateDB Version | Reference | Configuration Example |
97-
| --------------- | --------- | --------------------- |
98-
| \<=4.x | [latest] | ```yaml
99-
discovery.seed_hosts: - node1.example.com:4300 - node2.example.com:4300 - 10.0.1.102:4300 - 10.0.1.103:4300 ``` |
100-
| \<=3.x | [3.3] | ```yaml
101-
discovery.zen.ping.unicast.hosts: - node1.example.com:4300 - node2.example.com:4300 - 10.0.1.102:4300 - 10.0.1.103:4300 ``` |
96+
97+
````{list-table}
98+
---
99+
header-rows: 1
100+
---
101+
* - CrateDB Version
102+
- Reference
103+
- Configuration Example
104+
* - \>=4.x
105+
- [latest]
106+
- ```yaml
107+
discovery.seed_hosts:
108+
- node1.example.com:4300
109+
- node2.example.com:4300
110+
- 10.0.1.102:4300
111+
- 10.0.1.103:4300
112+
```
113+
* - <=3.x
114+
- [3.3]
115+
- ```yaml
116+
discovery.zen.ping.unicast.hosts:
117+
- node1.example.com:4300
118+
- node2.example.com:4300
119+
- 10.0.1.102:4300
120+
- 10.0.1.103:4300
121+
```
122+
````
102123

103124
Note: You might want to try {ref}`DNS based discovery
104125
<crate-reference:conf_dns_discovery>` for inter-node communication.

0 commit comments

Comments
 (0)