From b536020058f5a88c95bf36fafa4cf17622a98b65 Mon Sep 17 00:00:00 2001 From: allegroai <> Date: Sun, 29 Dec 2019 08:47:47 +0200 Subject: [PATCH] Update documentation --- README.md | 2 +- docs/faq.md | 2 +- docs/install_aws.md | 21 +++++++++------------ docs/install_linux_mac.md | 4 ++-- docs/install_win.md | 4 ++-- 5 files changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index c35a2f4..50dac8a 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ For more information about the Trains client, see [**Trains**](https://github.co **trains-server** provides a few additional useful features, which can be manually enabled: * [Web login authentication](https://github.com/allegroai/trains-server/blob/master/docs/faq.md#web-auth) -* [Non-responsive experiments watchdog](https://github.com/allegroai/trains-server/blob/master/docs/faq.md#watchdog) +* [Non-responsive experiments watchdog](https://github.com/allegroai/trains-server/blob/master/docs/faq.md#watchdog-the-non-responsive-task-watchdog-settings) ## Restarting trains-server diff --git a/docs/faq.md b/docs/faq.md index 49aa914..a9a8f88 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -47,7 +47,7 @@ To launch **trains-server** on a stand alone Linux Ubuntu: 1. Remove the previous installation of **trains-server**. - **WARNING**: This clears all existing **TRAINS** databases. + **WARNING**: This clears all existing **Trains** databases. sudo rm -R /opt/trains/ diff --git a/docs/install_aws.md b/docs/install_aws.md index 83b9761..f5716cc 100644 --- a/docs/install_aws.md +++ b/docs/install_aws.md @@ -1,22 +1,22 @@ # Deploying **trains-server** on AWS -To deploy **trains-server** on AWS, use one of the Amazon Machine Images (AMIs) listed in the [Released versions](#released-versions) section of this page. +To easily deploy **trains-server** on AWS, use one of our pre-built Amazon Machine Images (AMIs). +We provide AMIs per region for each released version of **trains-server**, see [Released versions](#released-versions) below. -Service port numbers on these AMIs are: +Once the AMI is up and running, [configure the Trains client](https://github.com/allegroai/trains/blob/master/README.md#configuration) to use your **trains-server**. +The service port numbers on our **trains-server** AMIs: -- Web: `8080` -- API: `8008` +- Web application: `8080` +- API Server: `8008` - File Server: `8081` -Persistent storage configuration: +The persistent storage configuration: - MongoDB: `/opt/trains/data/mongo/` - ElasticSearch: `/opt/trains/data/elastic/` - File Server: `/mnt/fileserver/` - -## Installing -We provide AMIs per region for each released version of **trains-server**, see [Released versions](#released-versions) on this page. +For examples and use cases, check the [Trains usage examples](https://github.com/allegroai/trains/blob/master/docs/trains_examples.md). For instructions on launching a custom AMI from the EC2 console, see the [AWS Knowledge Center](https://aws.amazon.com/premiumsupport/knowledge-center/launch-instance-custom-ami/) or detailed instructions in the [AWS Documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/launching-instance.html). @@ -26,7 +26,7 @@ The minimum recommended amount of RAM is 8GB. For example, **t3.large** or **t3a To upgrade **trains-server** on an existing EC2 instance based on one of these AMIs, SSH into the instance and follow the [upgrade instructions](../README.md#upgrade) for **trains-server**. -### Upgrading AMI's to v0.12 +### Upgrading AMIs to v0.12 This upgrade includes the automatically updated AMI in Version 0.12. It also includes an additional REDIS docker to the **trains-server** setup. @@ -185,6 +185,3 @@ For easier upgrades, the following AMIs automatically update to the latest relea * **us-west-1** : ami-0cf4768e9d47ed076 * **us-west-2** : ami-0b145f37da31eb9fb -## Next Step - -Configure the [TRAINS client for trains-server](https://github.com/allegroai/trains-server/blob/master/README#configuring-the-trains-client-for-trains-server). \ No newline at end of file diff --git a/docs/install_linux_mac.md b/docs/install_linux_mac.md index f23491e..3ed7684 100644 --- a/docs/install_linux_mac.md +++ b/docs/install_linux_mac.md @@ -51,7 +51,7 @@ To launch **trains-server** on Linux or Mac OS X: 1. Remove any previous installation of **trains-server**. - **WARNING**: This clears all existing **TRAINS** databases. + **WARNING**: This clears all existing **Trains** databases. sudo rm -R /opt/trains/ @@ -94,4 +94,4 @@ To launch **trains-server** on Linux or Mac OS X: ## Next Step -Configure the [TRAINS client for trains-server](https://github.com/allegroai/trains-server/blob/master/README#configuring-the-trains-client-for-trains-server). \ No newline at end of file +Configure the [Trains client for trains-server](https://github.com/allegroai/trains/blob/master/README.md#configuration). \ No newline at end of file diff --git a/docs/install_win.md b/docs/install_win.md index 9989e9a..8a429d9 100644 --- a/docs/install_win.md +++ b/docs/install_win.md @@ -20,7 +20,7 @@ To launch **trains-server** on Windows 10: 1. Remove any previous installation of **trains-server**. - **WARNING**: This clears all existing **TRAINS** databases. + **WARNING**: This clears all existing **Trains** databases. rmdir c:\opt\trains /s @@ -47,4 +47,4 @@ To launch **trains-server** on Windows 10: ## Next Step -Configure the [TRAINS client for trains-server](https://github.com/allegroai/trains-server/blob/master/README#configuring-the-trains-client-for-trains-server). \ No newline at end of file +Configure the [Trains client for trains-server](https://github.com/allegroai/trains/blob/master/README.md#configuration). \ No newline at end of file