Share

Flow Production Tracking Enterprise quick start

Warning:

Local installations of Flow Production Tracking are no longer offered. This documentation is intended only for those with existing instances of Shotgun Enterprise Docker. Click here for a list of our current offerings.

This guide is intended to help Flow Production Tracking Administrators setup and administer Flow Production Tracking Enterprise Docker.

Installation process

This guide is split up in multiple phases that will help you to get Flow Production Tracking Enterprise Docker running.

  1. Start a standalone Flow Production Tracking cluster
  2. Container configuration for using a standalone PostgreSQL server
  3. Media folder configuration
  4. Log management
  5. License
  6. Next steps

Flow Production Tracking application container

You first need to acquire the latest version of the containers from https://shotgrid.autodesk.com/. Copy the package on your host. Learn more about the installation procedure here.

Next, decompress the Flow Production Tracking Enterprise package and load it in Docker.


sudo tar -vxf flow production tracking-docker-se-7.12.2.3.tar.gz -C /opt  
sudo chown -R flow production tracking:flow production tracking /opt/flow production tracking  
cd /opt/flow production tracking/se  
sudo docker load < flow production tracking-app.7.12.2.3.tar 

Flow Production Tracking is now ready to be started using Docker Compose.

# Create your staging cluster from the example  
cp -r example staging  
cd staging  

# Edit docker-compose.yml to replace flow production tracking.mystudio.test by your flow production tracking site url.  
# You will also need to replace the placeholder <network_interface_ip> with the related IP.  
# You can edit the file using vi or your preferred editor.  

# You can then start Flow Production Tracking 
sudo docker-compose up -d  

# First initialization will take a minute, follow progress with  
sudo docker-compose logs -f app  

# Get flow production tracking_admin password  
sudo docker-compose logs app | grep password 

The site should now be available at the url you put in the Compose file.

Standalone PostgreSQL Server

In the quick start example, a PostgreSQL server running in a Docker container is used. It works out-of-the box, but a standalone PostgreSQL server is highly recommended for production. See Configure a standalone database server for details.

On startup, the container will create the database if it doesn’t exist and POSTGRES_USER can create the database. It will then initialize the database if needed. This may take up to two–three minutes, and Flow Production Tracking won't be available during the initialization.

SE Docker containers use two PostgreSQL databases:

  • flow production tracking: Main database
  • flow production tracking_transcoding: Transcoding jobs

To configure your containers to use another database, first stop and remove the db service section from your docker-compose.yml. Reconfigure the app service to connect to your standalone PostgreSQL server by adding the following env variables.

 environment:  
 POSTGRES_HOST: <your PostgreSQL server hostname>  
 POSTGRES_PORT: 5432  
 POSTGRES_DB: flow production tracking     # can be customized if needed  
 POSTGRES_USER: flow production tracking   # can be customized if needed  
 POSTGRES_PASSWORD: <flow production tracking user password> 

If the POSTGRES_USER cannot create the database, make sure to create the database first yourself.

Restart the app container. It will try to connect to the database and initialize the database if it’s empty, and won't do anything if the database exists.

Expose ports

When exposing ports in Docker, it is allowing by default every network interfaces (0.0.0.0) to access those ports. A good way of limiting which interfaces has access is by binding the IP of the network interfaces that you want to allow. You can even add multiple network interfaces:

ports:  
  - "172.0.0.5:80:80"  
  - "192.168.0.14:80:80" 

Explicitly binding network interface can increase the security level since you are limiting the access.

Media folder

Your Flow Production Tracking site needs a place to store all the medias. By default, it will store it in a media subfolder relative to the docker-compose.yml file. 

It’s recommended to map a bigger partition shared across all server like a Network File System (NFS) server. See Media storage configuration for more details.

Mount the media base folder in the container at /media. You can do so by modifying the volume property of the app container in the docker-compose.yml file. See Compose file - volumes for more details.

    app:  
    image: flow production tracking-app:%VERSION%  
    volumes:  
      - /myhost/mymedia:/media 

Then, restart the container.

 sudo docker-compose up -d 

On startup, the container will create two subfolders: files and storage, with the right permission at startup. Do not incorrectly set those permissions. Make sure the app and transcoderworker container are always using the media volume mount.

If you are starting with Flow Production Tracking for the first time, you can optionally use our demo media using the Media Package.

Register your flow production tracking site

You need to register your site to get rid of the Invalid Flow Production Tracking License banner and to be able to use Toolkit with your site. If you didn't already receive a package containing a license string, please contact support with the following messages to register your site.

Hi Autodesk!

I would like to register my Flow Production Tracking site.

Client Name: <your Client Name>

Flow Production Tracking URL: <your Flow Production Tracking URL>

Cheers

Autodesk Support will provide you a license string that you can paste in the Flow Production Tracking Web App:

Site Preferences -> Advanced -> License

Flow Production Tracking support will provide you a Toolkit Script Name and Key that you can paste in the Flow Production Tracking Web App:

Site Preferences -> Advanced -> Pipeline Toolkit Install Script Name

Site Preferences -> Advanced -> Pipeline Toolkit Install Key

Initialize usage metering

Refer to instructions here.

Troubleshooting

flow production tracking-app.7.12.2.3.tar: Permission denied on docker load

Make sure that the permission on the file are set to -rw-r--r--

Was this information helpful?