Tugboat Images

Tugboat maintains several Docker images. These images are extensions of official Docker images and include tools and configurations that help them work well with Tugboat. Tugboat’s images track the upstream images.

All of our images are available on Docker Hub. The source code used to generate these images is available on GitHub.

It is best practice to use the most specific tag available for a given image to prevent any unforeseen upstream changes from affecting your Previews. For example, instead of tugboatqa/mysql:5-debian, it is generally better to use tugboatqa/mysql:5.6-debian.

That said, sometimes the version of a Service doesn’t really matter much. For example, it may not matter which version of memcached you use, and you can be sure you always have the most recent version available by specifying tugboatqa/memcached or tugboatqa/memcached:latest. See also: Image version tags. There may be exceptions to this, such as the tugboatqa/mysql image, which does not have a latest tag (more on that below). Be sure to look at the Supported Tags linked below for the image you plan on using.

Additional Information

Alpine

The Alpine image is extremely minimal by nature. Unlike the other images, it does not have any extra tools installed except those required to use git with SSH.

Cypress/Included

The tugboatqa/cypress-included images adapt the cypress/included Docker image for use with Tugboat.

It is recommended to run your Cypress tests during the online command group.

If your Cypress config is committed to your repository, you will want to add checkout: true to your config.yml when using this image, so that your Cypress config is available to this service:

services:
  ...
  cypress:
    image: tugboatqa/cypress-included:12.7.0
    checkout: true
    commands:
      online:
        - cypress run --config baseUrl="$TUGBOAT_DEFAULT_SERVICE_URL"

Elastic Search

The 2.x tags of this image extend the official Elastic Search image on Docker Hub. These images are based on Debian.

The newer tags of this image extend the official Elastic Search images maintained by Elastic.co. These images are based on CentOS.

MySQL/MariaDB/Percona

The MySQL, MariaDB, and Percona images are all configured similarly.

Whether you use MySQL, MariaDB, or Percona, they all have a default database named tugboat as well as a user named tugboat with a password of tugboat. The tugboat user has full access to the tugboat database. In addition, the root database user does not have a password, but can only be used to connect to the database from the MariaDB or MySQL service.

This means that in order to do any root-level database operations, they must be done by the commands defined for the MySQL or MariaDB service.

services:
  mysql:
    image: tugboatqa/mysql:5-debian
    commands:
      init:
        - mysql -e "CREATE DATABASE foo;"

If MySQL or MariaDB daemon configuration needs to be changed, create or modify the configuration file and restart the service (which is managed using runit):

services:
  mysql:
    image: tugboatqa/mysql:5-debian
    commands:
      init:
        - echo "max_allowed_packet=536870912" >> /etc/mysql/conf.d/tugboat.cnf
        - sv restart mysql

Note the service restarts when the preview is committed, restarting may only be necessary when wanting the configuration to be applied before other actions, such as importing the database.

PHP

PHP Extensions

The PHP images provided upstream do not use apt-get to install PHP extensions. Instead, there are helper scripts that let you install additional extensions as required. The images provided by Tugboat attempt to balance installing the most commonly used extensions with reserving as much disk space as possible. If an extension that you need is not installed, use docker-php-ext-configure, docker-php-ext-install, and docker-php-ext-enable in your Service commands.

commands:
  init:
    # Install and enable the redis extension
    - pecl install redis
    - docker-php-ext-enable redis

More information about these helper scripts can be found in the upstream documentation.

Apache Modules

In order to keep the service containers as lean as possible, only the most basic apache modules are enabled in the PHP/Apache images. To enable a missing module, add it with a service command

commands:
  init:
    # Enable mod_rewrite and mod_headers
    - a2enmod rewrite headers

PostgreSQL

The PostgreSQL / PostGIS images have a default database named tugboat as well as a user named tugboat with a password of tugboat. The tugboat user has full access to the tugboat database. In addition, the default superuser password is set to tugboat.

Solr

Using the official Solr image inside of Tugboat requires creating the cores as the solr user.

services:
  ...
  solr:
    image: tugboatqa/solr:9.9
    checkout: true
    commands:
      init:
        - su -s /bin/sh -c "/opt/solr/bin/solr create -c [YOURCORENAME]" solr

Drupal and Search API Solr

The following is an example setup for use with Drupal’s Search API Solr module.

1. Prepare your Solr configuration files

Copy the example configuration from the Search API Solr module’s jump-start/solr9/configset directory into your repository at .tugboat/solr/conf (or another path of your choosing). This provides a complete, working configset for Solr 9.x.

2. Create a new Solr service in your Tugboat config.yml

services:
  ...
  solr:
    image: tugboatqa/solr:9.9
    expose: 8983
    environment:
      SOLR_MODULES: "extraction,langid,ltr,analysis-extras"
      tugboat_solr_core: yourcorename
    checkout: true
    commands:
      init:
        # Create the core
        - su -s /bin/sh -c "/opt/solr/bin/solr create -c $tugboat_solr_core" solr
        # Copy Solr config to Solr home
        - cp -r $TUGBOAT_ROOT/.tugboat/solr/conf/. $SOLR_HOME/$tugboat_solr_core/conf/.
        # Change ownership to the solr user
        - cd "$SOLR_HOME/$tugboat_solr_core" && sudo chown solr:solr -R conf
        # Reload the core (required in Solr 9.x)
        - curl -X POST "http://localhost:8983/api/cores/$tugboat_solr_core/reload"

Important notes for Solr 9.x:

• The SOLR_MODULES environment variable is required to load necessary Solr modules. From Solr 9.8+, the deprecated <lib> declarations in solrconfig.xml are ignored by default.
• You must manually reload the core after copying configuration files. This is a new requirement in Solr 9.x.
• The command changed from create_core to create in Solr 9.x.

3. Depend on the Solr service

Make sure to add the solr service (or whatever you call your Solr service) to the depends directive under the default application.

  php:
    ...
    depends:
      - mysql
      - solr

4. Configure Search API with the Solr service hostname

One way to accomplish this is to add the following to a settings.php file that’s loaded specifically for Tugboat:

$config['search_api.server.SERVER_MACHINE_NAME'] = [
  'backend_config' => [
    'connector' => 'standard',
    'connector_config' => [
      'scheme' => 'http',
      'host' => 'solr',
      'path' => '/',
      'core' => getenv('tugboat_solr_core'),
      'port' => 8983,
    ],
  ],
];

Note: solr here is the service name in .tugboat/config.yml. If you name your service something different, make sure to use that service name as the host. The tugboat_solr_core environment variable should be set in your Tugboat configuration to match the core name you created in the Solr service.

The Search API UI for editing the doesn’t show overwritten changes. To validate the overrides, run the following command: drush cget search_api.server.SERVER_MACHINE_NAME --include-overridden.