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
7 changes: 4 additions & 3 deletions docs/Manual/Administration/Starter/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ArangoDB Starter Administration

This chapter documents administering the _ArangoDB Starter_.
In this chapter you find administration procedures for the
[ArangoDB Starter](programs-starter.html).

- [Remove a machine from the cluster](./Removal.md)
- [Recover from a failed machine](./Recovery.md)
- [Remove a machine from the cluster](Removal.md)
- [Recover from a failed machine](Recovery.md)
17 changes: 10 additions & 7 deletions docs/Manual/Administration/Starter/Removal.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# ArangoDB Starter Removal Procedure

{% hint 'danger' %}
**Do not** apply this procedure to machines that have an **agent** on it.
{% endhint %}

This procedure is intended to remove a machine from a cluster
(that was started with the ArangoDB _Starter_).
that was started with the ArangoDB _Starter_.

It is possible to run this procedure while the machine is still running
or when it has already been removed.

It is not possible to remove machines that have an agent on it!
Use the [recovery procedure](./Recovery.md) if you have a failed machine
with an agent on it.
The _Agency_ needs to remain functional for the cluster to operate.
Use the [recovery procedure](Recovery.md) if you have
a failed machine with an agent on it.

Note that it is highly recommended to remove a machine while it is still running.

Expand Down Expand Up @@ -50,10 +55,8 @@ If the machine you want to remove has address `10.21.56.123` and was listening
on port `8528`, use ID `21e42415`.

The `remove starter` command will attempt the cleanout all data from the servers
of the machine that you want to remove.
This can take a long of time.
of the machine that you want to remove. This can take a long of time.
If the cleanout fails, the `remove starter` command will fail.

If you want to remove the machine even when the cleanout has failed, use
the `--force` option.
Note that this may lead to data loss!
the `--force` option. Note that this may lead to data loss!
6 changes: 3 additions & 3 deletions docs/Manual/Deployment/ActiveFailover/UsingTheStarter.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ variable by adding this option to the above `docker` command:
-e ARANGO_LICENSE_KEY=<thekey>
```

You can get a free evaluation license key by visiting
You can get a free evaluation license key by visiting:

https://www.arangodb.com/download-arangodb-enterprise/
[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/)

Then replace `<thekey>` above with the actual license key. The start
will then hand on the license key to the Docker containers it launches
Expand Down Expand Up @@ -107,7 +107,7 @@ docker run -it --name=adb --rm -p 8528:8528 \
--starter.join=A,B,C
```

Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
as well as the additional mountpoint containing the certificate have been added above.
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
is mandatory that the certificates are stored in `$HOME/.docker`. So
Expand Down
6 changes: 3 additions & 3 deletions docs/Manual/Deployment/Cluster/UsingTheStarter.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ variable by adding this option to the above `docker` command:
-e ARANGO_LICENSE_KEY=<thekey>
```

You can get a free evaluation license key by visiting
You can get a free evaluation license key by visiting:

https://www.arangodb.com/download-arangodb-enterprise/
[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/)

Then replace `<thekey>` above with the actual license key. The start
will then hand on the license key to the Docker containers it launches
Expand Down Expand Up @@ -92,7 +92,7 @@ docker run -it --name=adb --rm -p 8528:8528 \
--starter.join=A,B,C
```

Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
as well as the additional mountpoint containing the certificate have been added above.
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
is mandatory that the certificates are stored in `$HOME/.docker`. So
Expand Down
6 changes: 3 additions & 3 deletions docs/Manual/Deployment/SingleInstance/UsingTheStarter.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ variable by adding this option to the above `docker` command:
-e ARANGO_LICENSE_KEY=<thekey>
```

You can get a free evaluation license key by visiting
You can get a free evaluation license key by visiting:

https://www.arangodb.com/download-arangodb-enterprise/
[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/)

Then replace `<thekey>` above with the actual license key. The start
will then hand on the license key to the Docker container it launches
Expand Down Expand Up @@ -69,7 +69,7 @@ docker run -it --name=adb --rm -p 8528:8528 \
--starter.mode=single
```

Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
as well as the additional mountpoint containing the certificate have been added above.
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
is mandatory that the certificates are stored in `$HOME/.docker`. So
Expand Down
2 changes: 1 addition & 1 deletion docs/Manual/Programs/Starter/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It enables you to create everything from a simple Single server instance
to a full blown Cluster with datacenter to datacenter replication in under 5 minutes.

The Starter is intended to be used in environments where there is no higher
level orchestration system (e.g. Kubernetes or DC/OS) available.
level orchestration system (e.g. Kubernetes) available.

## Starter versions

Expand Down
2 changes: 1 addition & 1 deletion docs/Manual/Programs/Starter/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ a docker container, the starter will auto-detect its container name.
The arango starter by default creates a cluster that uses no authentication.

To create a cluster that uses authentication, create a file containing a random JWT secret (single line)
and pass it through the `--auth.jwt-secret-path` option.
and pass it through the `--auth.jwt-secret` option.

For example:

Expand Down
7 changes: 4 additions & 3 deletions docs/Manual/Programs/Starter/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ArangoDB Starter

This chapter documents the _ArangoDB Starter_.
This chapter documents the _ArangoDB Starter_ (`arangodb` binary).

The _ArangoDB Starter_ is a tool that can help you deploy ArangoDB in an easy way (either in single-instance, active/passive or Cluster mode).
The _ArangoDB Starter_ is a tool that can help you deploy ArangoDB in an easy
way (either in single-instance, active/passive or Cluster mode).

For a Tutorial, please refer to [this](../../Tutorials/Starter/README.md) section.
Also see the [Starter Tutorial](../../Tutorials/Starter/README.md).
12 changes: 9 additions & 3 deletions docs/Manual/Tutorials/Starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Besides starting and maintaining ArangoDB deployments, the starter also provides
various commands to create TLS certificates & JWT token secrets to secure your
ArangoDB deployment.

{% hint 'info %}
ArangoDB is also available as
[**managed service** (ArangoDB Oasis)](https://www.arangodb.com/managed-service/).
{% endhint %}

## Installation

The ArangoDB starter (`arangodb`) comes with all current distributions of ArangoDB.
Expand Down Expand Up @@ -118,7 +123,7 @@ docker run -it --name=adb --rm -p 8528:8528 \
--starter.join=A,B,C
```

Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
as well as the additional mountpoint containing the certificate have been added above.
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
is mandatory that the certificates are stored in `$HOME/.docker`. So
Expand Down Expand Up @@ -196,8 +201,9 @@ Note: When you restart the starter, it remembers the original `--starter.local`
## Starting a cluster with datacenter to datacenter synchronization

{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
Datacenter to datacenter replication is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/),
also available as [**managed service**](https://www.arangodb.com/managed-service/).
{% endhint %}

Datacenter to datacenter replication (DC2DC) requires a normal ArangoDB cluster in both data centers
Expand Down
12 changes: 7 additions & 5 deletions docs/Manual/Upgrading/Starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ install a specific package using
dpkg -i arangodb3-3.3.14-1_amd64.deb
```

after you have downloaded the corresponding file from https://www.arangodb.com/download/.
after you have downloaded the corresponding file from
[www.arangodb.com/download/](https://www.arangodb.com/download/).

If you are using the `.tar.gz` distribution (only available from v3.4.0),
you can simply extract the new archive in a different
Expand Down Expand Up @@ -126,7 +127,7 @@ max 29513 3898 0 11:46 pts/4 00:00:00 arangodb --starter.data-dir=./db

### Restart the _Starter_

When using a supervisor like _SystemD_, this will happens automatically. In case
When using a supervisor like _SystemD_, this will happen automatically. In case
the _Starter_ was initiated manually, the _arangodb_ processes have to be restarted
manually with the same command that has been used before.

Expand All @@ -148,14 +149,15 @@ situation:

### Start the upgrade process of all _arangod_ & _arangosync_ servers

Run the following command:
Run the following command for any of the starter endpoints
(e.g. `http://localhost:8528`) to upgrade the entire cluster:

```bash
arangodb upgrade --starter.endpoint=<endpoint-of-a-starter>
```

The `--starter.endpoint` option can be set to the endpoint of any
of the starters. E.g. `http://localhost:8528`.
**Note:** if you have connected clusters across multiple datacenter,
you need to update each of the clusters.

**Important:**

Expand Down