diff --git a/docs/installation/tango-troubleshoot.md b/docs/installation/tango-troubleshoot.md new file mode 100644 index 000000000..13ce14477 --- /dev/null +++ b/docs/installation/tango-troubleshoot.md @@ -0,0 +1,13 @@ +This is a general list of Tango-related issues that we get often. If you are encountering or find a solution to an issue not mentioned here, +please let us know on our [Slack](https://autolab-slack.herokuapp.com). + +## Clearing Tango job queue +Due to faulty configs or other reasons, you may have a large backlog of jobs waiting to run that are stuck. +Restarting Tango does not solve this issue as the jobs are persisted on a Redis queue. You can drop everything in Redis using the `redis-cli` client as follows: + +```bash +$ redis-cli +127.0.0.1:6379> FLUSHALL +OK +127.0.0.1:6379> +``` \ No newline at end of file diff --git a/docs/installation/tango.md b/docs/installation/tango.md index 42abca2a1..01ff42d03 100644 --- a/docs/installation/tango.md +++ b/docs/installation/tango.md @@ -1,8 +1,7 @@ # Tango Installation - This guide provides instructions for installing Tango on either a [development environment](#development-installation) or a [production environment](#production-installation). -# Development Installation +## Development Installation This guide shows how to setup Tango in a **development environment**. Use the [production installation](#production-installation) guide for installing in a **production environment**. @@ -92,22 +91,17 @@ This guide shows how to setup Tango in a **development environment**. Use the [p 13. See below for instructions on how to deploy Tango in a standalone production environment. - - - -# Production Installation +## Production Installation This is a guide to setup a fully self-sufficient Tango deployment environment out-of-the-box using Docker. The suggested deployment pattern for Tango uses Nginx as a proxy and Supervisor as a process manager for Tango and all its dependencies. All requests to Nginx are rerouted to a Tango process. -## Details - +### Details - Nginx default port - 8600 - Tango ports - 8610, 8611 - Redis port - 6379 - You can change any of these in the respective config files in `deployment/config/` before you build the `tango_deployment` image. -## Steps - +### Steps 1. Clone the Tango repo :::sh @@ -239,7 +233,7 @@ This is a guide to setup a fully self-sufficient Tango deployment environment ou # (Server Reboots) $ service erwin status -# Docker VMMS Setup +## Docker VMMS Setup This is a guide to set up Tango to run jobs inside Docker containers. @@ -261,7 +255,7 @@ This is a guide to set up Tango to run jobs inside Docker containers. # in config.py VMMS_NAME = "localDocker" -# Amazon EC2 VMMS Setup +## Amazon EC2 VMMS Setup This is a guide to set up Tango to run jobs on an Amazon EC2 VM. @@ -326,4 +320,4 @@ This is a guide to set up Tango to run jobs on an Amazon EC2 VM. TANGO_RESERVATION_ID = '1' # Leave as 1 INSTANCE_RUNNING = 16 # Status code of a running instance, leave as 16 -10. You should now be ready to run Tango jobs on EC2! Use the [Tango CLI](/tango-cli/) to test your setup. +10. You should now be ready to run Tango jobs on EC2! Use the [Tango CLI](/tango-cli/) to test your setup. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index e316ed458..60b661d8b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,9 @@ nav: - Troubleshooting: installation/troubleshoot.md - Mailing Setup: installation/mailing.md - Github Integration Setup: installation/github_integration.md - - Tango: installation/tango.md + - Tango: + - Installation: installation/tango.md + - Troubleshooting: installation/tango-troubleshoot.md # - (Legacy) OneClick Install: installation/one-click.md - Getting Started: - Autolab Frontend: