Skip to content

Commit fcb61b7

Browse files
committed
Install: Implement suggestions by CodeRabbit
1 parent 57a5072 commit fcb61b7

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ instances.
2626
### Authentication
2727
2828
It is recommended to restrict the permissions of CrateDB on S3 to only the
29-
required extent. First, an IAM role is required. This [AWS guide] gives a
30-
short description of how to create a policy either using the CLI or the AWS
31-
Management Console. Further, access of the snapshot to the S3 bucket needs to
29+
required extent. First, an IAM role is required. This [AWS IAM policy guide]
30+
explains how to create a policy by using the CLI or the AWS Management Console.
31+
Further, access of the snapshot to the S3 bucket needs to
3232
be restricted. An example policy file granting anybody access to a bucket
3333
called `snaps.example.com` is attached below:
3434

@@ -92,7 +92,7 @@ within the policy:
9292
```
9393

9494
[amazon s3]: https://aws.amazon.com/s3/
95-
[aws guide]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
95+
[AWS IAM policy guide]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
9696
[aws policy examples]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html
9797
[aws principals]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html
9898
[iam roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html

docs/install/container/docker.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -84,25 +84,26 @@ Breaking the command down:
8484
- Defines the environment variable {ref}`CRATE_HEAP_SIZE <crate-reference:conf-env-heap-size>`,
8585
which is used by CrateDB to allocate 1 GB for its heap memory.
8686
- Runs the command `crate` inside the container with parameters:
87-
- `network.host`: The `_site_` value results in the binding of the
88-
CrateDB process to a site-local IP address.
89-
- `node.name`: Defines the node's name as `crate01` (used by
90-
master election).
91-
- `discovery.seed_hosts`: This parameter lists the other hosts in the
92-
cluster. The format is a comma-separated list of `host:port` entries,
93-
where port defaults to setting `transport.tcp.port`. Each node must
94-
contain the name of all the other hosts in this list. Notice also that
95-
any node in the cluster might be started at any time, and this will
96-
create connection exceptions in the log files, however all nodes will
97-
eventually be running and interconnected.
98-
- `cluster.initial_master_nodes`: Defines the list of master-eligible
99-
node names which will participate in the vote of the first master
100-
(first bootstrap). If this parameter is not defined, then it is expected
101-
that the node will join an already formed cluster. This parameter is only
102-
relevant for the first election.
103-
- `gateway.expected_data_nodes` and `gateway.recover_after_data_nodes`:
104-
Specifies how many nodes you expect in the cluster and how many nodes must
105-
be discovered before the cluster state is recovered.
87+
88+
- `network.host`: The `_site_` value results in the binding of the
89+
CrateDB process to a site-local IP address.
90+
- `node.name`: Defines the node's name as `crate01` (used by
91+
master election).
92+
- `discovery.seed_hosts`: This parameter lists the other hosts in the
93+
cluster. The format is a comma-separated list of `host:port` entries,
94+
where port defaults to setting `transport.tcp.port`. Each node must
95+
contain the name of all the other hosts in this list. Notice also that
96+
any node in the cluster might be started at any time, and this will
97+
create connection exceptions in the log files, however all nodes will
98+
eventually be running and interconnected.
99+
- `cluster.initial_master_nodes`: Defines the list of master-eligible
100+
node names which will participate in the vote of the first master
101+
(first bootstrap). If this parameter is not defined, then it is expected
102+
that the node will join an already formed cluster. This parameter is only
103+
relevant for the first election.
104+
- `gateway.expected_data_nodes` and `gateway.recover_after_data_nodes`:
105+
Specifies how many nodes you expect in the cluster and how many nodes must
106+
be discovered before the cluster state is recovered.
106107

107108
:::{NOTE}
108109
If this command aborts with an error, consult the
@@ -269,7 +270,7 @@ Docker's Compose tool allows developers to define and run multi-container
269270
Docker applications that can be started with a single `docker-compose up`
270271
command.
271272

272-
Read about Docker Compose specifics [here](https://docs.docker.com/compose/).
273+
Read about Docker Compose specifics in the [Docker Compose documentation](https://docs.docker.com/compose/).
273274

274275
You can define the services that make up your app in a `docker-compose.yml`
275276
file. To recreate the three-node cluster in the previous example, you can

docs/install/container/kubernetes/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ spec:
273273
volumeClaimTemplates:
274274
# Use persistent storage.
275275
- metadata:
276-
name: data
276+
name: cratedb-data
277277
spec:
278278
accessModes:
279279
- ReadWriteOnce

0 commit comments

Comments
 (0)