Installation Manual

ITS The Inspection Stack

Description

The its-theinspection-swarm repository stores docker swarm mode deployment configurations for The Inspection project.

Requirements

  1. Windows, Linux OS
  2. Docker with initialized Swarm Mode
  3. Bash Shell is available (Linux)

CLI Script

  1. Download the latest version of the cli script from the link https://gitlab.com/theinspection/theinspection-cli/-/archive/v1.0.17/theinspection-cli-v1.0.17.zip
  2. Unzip the archive into a working folder.
  3. Initialize a private repository ./stack login

Initial Stack Deployment

  1. Run ./stack init <stack> to initial stack configuration and secret.
  2. Update secret ./stacks/<stack>.config.secret.yaml in the folder ./stacks.
  3. Update configuration ./stacks/<stack>.config.yaml in the folder ./stacks.
  4. Run ./stack configure to check stack configuration.
  5. Run ./stack deploy to run stack services.
  6. Run ./stack status to check all services are up and running.
  7. Run ./stack init_nc to initialize tenants and Nextcloud folders structure.
  8. Run ./stack init_files to copy reports and notification templates to Nextcloud.

Updating stack

  1. Add or update some part of configuration.
  2. Run ./stack deploy
  3. Run ./stack status to check the services' health.
  4. Optional. Run ./stack cleanup to remove extra secrets/config after update.
  5. Optional. Run ./stack configure to check configuration changes without deploy.

Important! You need to be aware that some parts of configuration cannot be simply updated through the config files because part of it is only used in the initial deployment process (for example, database user passwords).

Removing stack

  1. There are two commands to remove current stack (specified in .stack):
    • ./stack rm - remove all besides data volumes
    • ./stack rm-all - remove all including data volumes

Services overview

services

User workflow with external data

user_workflow_with_external_data