Architecture related docs. #170
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sleto-it
approved these changes
Jun 25, 2018
neunhoef
approved these changes
Jun 25, 2018
Contributor
neunhoef
left a comment
neunhoef
left a comment
There was a problem hiding this comment.
LGTM. Only typos. I did not understand one of the sentences.
| ## What does the Starter do | ||
|
|
||
| The ArangoDB Starter is a program used to create ArangoDB database deployments | ||
| on bare-metal (or virtual machines) with easy. |
| ArangoDB deployments with ArangoDB version `3.2.<something>` as well | ||
| as deployments with ArangoDB version `3.3.<something>`. | ||
|
|
||
| It also means that you can update the Starter independent from the ArangoDB |
| 1. Active failover | ||
| 1. Cluster | ||
|
|
||
| Note: Datacenter replication is an option for the the `cluster` deployment mode. |
| The Starter can run as normal processes directly on the host operating system, | ||
| or as containers in a docker runtime. | ||
|
|
||
| When running as normal process directly on the host operatoring system, |
Contributor
There was a problem hiding this comment.
"operatoring" -> "operating"
|
|
||
| ## Starter data-directory | ||
|
|
||
| The Starters use a single directory with a well known structure to store |
Contributor
There was a problem hiding this comment.
"Starters use" -> "Starter uses"
| The Starters running on those machines need to know about each others existence. | ||
| In order to do so, the Starters form a "cluster" of their own (not to be confused | ||
| with the ArangoDB database cluster). | ||
| This cluster of Starters is form from the values given to the `--starter.join` |
| is aborted and all Starters go directly to the `running` phase described below. | ||
| 1. All Starters create a unique ID | ||
| 1. The list of `--starter.join` arguments is sorted | ||
| 1. All Starters compare their unique ID with the ID their request from the first server |
Contributor
There was a problem hiding this comment.
I do not understand this sentence.
| 1. All Starters create a unique ID | ||
| 1. The list of `--starter.join` arguments is sorted | ||
| 1. All Starters compare their unique ID with the ID their request from the first server | ||
| in the sorter `--starter.join` list. |
| 1. The `bootstrap slaves` keep asking the `bootstrap master` about its state. | ||
| As soon as they receive confirmation to do so, they also continue with the `running` phase. | ||
|
|
||
| In the `running` all Starters launch the desired servers and keeps monitoring those |
|
|
||
| In the `running` all Starters launch the desired servers and keeps monitoring those | ||
| servers. Once a functional agency is detected, all Starters will try to be | ||
| `running master` by trying to write their ID in a well know location in the agency. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs intended to describe the architecture highlights and some deep dives into "cluster of Starters".