Documentation

This commit is contained in:
allegroai 2019-08-08 02:00:15 +03:00
parent c199976f70
commit dacdd5e965
2 changed files with 31 additions and 25 deletions

View File

@ -80,7 +80,7 @@ For Windows, we recommend installing our pre-built Docker image on a Linux virtu
1. Launch the Docker containers <a name="launch-docker"></a> 1. Launch the Docker containers <a name="launch-docker"></a>
* Automatically with docker-compose (details: [Linux/Ubuntu](docs/faq.md##ubuntu), [OS X](docs/faq.md#mac-osx)) * Automatically with docker-compose (details: [Linux/Ubuntu](docs/faq.md#ubuntu), [OS X](docs/faq.md#mac-osx))
```bash ```bash
$ docker-compose up $ docker-compose up
@ -193,18 +193,39 @@ When we release a new version and include a new pre-built Docker image for it, u
1. Shut down and remove each of your Docker instances using the following commands: 1. Shut down and remove each of your Docker instances using the following commands:
sudo docker stop <docker-name> * Using Docker-Compose
sudo docker rm -v <docker-name>
```bash
$ docker-compose up
```
The Docker names are (see [Launching Docker Containers](#launch-docker)): * Manual Docker launching
sudo docker stop <docker-name>
sudo docker rm -v <docker-name>
The Docker names are (see [Launching Docker Containers](#launch-docker)):
* `trains-elastic`
* `trains-mongo`
* `trains-fileserver`
* `trains-apiserver`
* `trains-webserver`
* `trains-elastic` 2. We highly recommend backing up your data directory!. A simple way to do that is using `tar`:
* `trains-mongo`
* `trains-fileserver`
* `trains-apiserver`
* `trains-webserver`
2. Pull the new **trains-server** docker image using the following command: For example, if your data directory is `/opt/trains`, use the following command:
sudo tar czvf ~/trains_backup.tgz /opt/trains/data
This backups all data to an archive in your home directory.
To restore this example backup, use the following command:
sudo rm -R /opt/trains/data
sudo tar -xzf ~/trains_backup.tgz -C /opt/trains/data
3. Pull the new **trains-server** docker image using the following command:
sudo docker pull allegroai/trains:latest sudo docker pull allegroai/trains:latest
@ -212,19 +233,6 @@ When we release a new version and include a new pre-built Docker image for it, u
sudo docker pull allegroai/trains:0.10.1 sudo docker pull allegroai/trains:0.10.1
3. We highly recommend backing up your data directory!. A simple way to do that is using `tar`:
For example, if your data directory is `/opt/trains`, use the following command:
sudo tar czvf ~/trains_backup.tgz /opt/trains/data
This back ups all data to an archive in your home directory.
To restore this example backup, use the following command:
sudo rm -R /opt/trains/data
sudo tar -xzf ~/trains_backup.tgz -C /opt/trains/data
4. Launch the newly released Docker image (see [Launching Docker Containers](#launch-docker)). 4. Launch the newly released Docker image (see [Launching Docker Containers](#launch-docker)).
## Community & Support ## Community & Support

View File

@ -79,8 +79,6 @@ For CentOS 7, Ubuntu 16.04, Mint 18.3, Ubuntu 18.04 and Mint 19.x, we tested the
echo "vm.max_map_count=262144" > /tmp/99-trains.conf echo "vm.max_map_count=262144" > /tmp/99-trains.conf
sudo mv /tmp/99-trains.conf /etc/sysctl.d/99-trains.conf sudo mv /tmp/99-trains.conf /etc/sysctl.d/99-trains.conf
sudo sysctl -w vm.max_map_count=262144 sudo sysctl -w vm.max_map_count=262144
sudo service docker restart
``` ```
For information about setting this parameter on other systems, see the [elastic](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode) documentation. For information about setting this parameter on other systems, see the [elastic](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode) documentation.