Skip to content

Docs - Nicer first sentence about ArangoDB cluster (planning#3143) #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2018
Merged

Docs - Nicer first sentence about ArangoDB cluster (planning#3143) #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 9 deletions docs/Manual/Tutorials/Starter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Starting an ArangoDB cluster or database the easy way

Starting an ArangoDB cluster is complex. It involves starting various servers with
Starting an ArangoDB cluster involves starting various servers with
different roles (agents, dbservers & coordinators).

The ArangoDB Starter is designed to make it easy to start and maintain an ArangoDB cluster
or single server database.
The ArangoDB Starter is designed to make it easy to start and
maintain an ArangoDB cluster or single server database.

Besides starting and maintaining ArangoDB deployments, the starter also provides
various commands to create TLS certificates & JWT token secrets to secure your
Expand All @@ -14,7 +14,8 @@ ArangoDB deployment.

The ArangoDB starter (`arangodb`) comes with all current distributions of ArangoDB.

If you want a specific version, download the precompiled binary via [the github releases page](https://github.com/arangodb-helper/arangodb/releases).
If you want a specific version, download the precompiled binary via the
[GitHub releases page](https://github.com/arangodb-helper/arangodb/releases).

## Starting a cluster

Expand All @@ -30,13 +31,13 @@ arangodb
```

This will use port 8528 to wait for colleagues (3 are needed for a
resilient agency). On host B: (can be the same as A):
resilient agency). On host B (can be the same as A):

```bash
arangodb --starter.join A
```

This will contact A on port 8528 and register. On host C: (can be same
This will contact A on port 8528 and register. On host C (can be same
as A or B):

```bash
Expand Down Expand Up @@ -94,9 +95,7 @@ it is also possible to use a host mapped volume. Make sure to map it on `/data`.
## Using multiple join arguments

It is allowed to use multiple `--starter.join` arguments.
This eases scripting.

For example:
This eases scripting. For example:

On host A:

Expand Down