This article is aimed at Flow Production Tracking Administrators and introduce Flow Production Tracking Enterprise Console for Docker (SEC) to users.

Glossary

SEC - Flow Production Tracking Enterprise Console for Docker.

Cluster - A set of servers composing a Flow Production Tracking instance.

Node - A single host within a cluster.

Flow Production Tracking Instance - Refers to your Flow Production Tracking site and all its components, e.g., “flow production tracking.yourstudio.com”.

Overview

Clusters can be added to SEC from the landing page of the application. To do so, SEC needs to be able to access the URL used to communicate with the Docker agent. This can be over Unix sockets or a TCP socket.

Details on how to setup docker to connect to different socket types is available on Docker documentation.

Finding the right Docker network

Docker will create virtual networks when using the docker-compose tool. So, multiple Docker networks may be present on a host. The networks are typically named using the following convention: <parent directory name>_default. Please make sure to select the correct network name when setting up clusters, otherwise SEC will not be able to communicate with the containers.

SEC is capable of managing multiple Flow Production Tracking Clusters (i.e., production, staging, development). Each cluster corresponds to an instance of Flow Production Tracking.

Making the containers discoverable

SEC is relying on Docker Labels to be able to detect and identify containers in order to be able to interact with them. The label that it is used by SEC is "com.shotgunsoftware.component", and must be configured accordingly in the docker-compose.yml file.

 services:  
 app:  
   labels:  
     com.shotgunsoftware.component: app  
 emailnotifier:  
   labels:  
     com.shotgunsoftware.component: emailnotifier  
 dbops:  
   labels:  
     com.shotgunsoftware.component: dbops  
 transcoderserver:  
   labels:  
     com.shotgunsoftware.component: transcoderserver  
 transcoderworker:  
   labels:  
     com.shotgunsoftware.component: transcoderworker 

Once configured properly, SEC will be able to scan, detect and interact with the containers.

Cluster management

Additional nodes can be added to a cluster from the Nodes section. This will allow running different components on different servers if required, or scaling up various components in cases where performance is a consideration.

SEC provides easy access to commonly run commands used by Flow Production Tracking Administrators. These commands are available in the Manage section. 

SEC also provides some basic checks and information on the Docker instances in each cluster. These are available in the Health section. The checks ensure that all components required for a running a Flow Production Tracking instance are present, and compares them to values stored in Flow Production Tracking Preferences.