Deployment

Available Arguments

The TopMod QA deployment binary has several arguments available:

help	Prints the help message and outlines the same information as available in this section.
auth	Prompts the user for client and license IDs in order to download and validate the license key from DAQA servers.
setup	Prompts the user for multiple pieces of information for the setup including sharepoint and smtp details. This option generates all of the necessary docker-compose scripts to run the system, as well as logs the user into DAQA's docker registry.
nginx	Sets up the appropriate host files in Nginx and requests LetsEncrypt SSL certificates.
run	Pulls and runs each of the containers in order.
stop	Stops all running containers.

General Usage

To begin, run the deployment binary with the "auth" argument to get the necessary License.key file. This is required before the user can run the "setup" argument.

The output of the "auth" argument will look something like this upon completion:

user@debian:~$ sudo ./deployment auth

       Welcome to...

 🚀 DAQA's TopMod QA Deployment   
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔  

Let's get started...

🔑  Authentication
 ├─[🔑 ] Enter your client ID: exampleClientId
 └─[🔑 ] Enter your license ID: exampleLicenseId

 License Validated.
 Limits
 └─[Users] 50 
 └─[Expiry] 2099-01-01 12:00:00

Once the License.key file is downloaded and validated, the "setup" argument can be run. Once again the user will be asked a series of questions, this time in order to dynamically generate docker-compose.yml files and the appropriate folder structure.

The "setup" argument will also save a file labelled "backup" in the current directory. This can be piped back into the deployment binary if the system needs to be redeployed or if the user has encountered an error. To do this, simply run:

sudo ./deployment setup < backup

After providing the required information, the user will be logged in to the DAQA docker repository automatically.

Next, use the "nginx" argument to setup the two hosts and their SSL certificates. Once this step completes, the "run" argument may now be used to start all of the containers.