Skip to main content
Version: Deploy 24.1

Prerequisites for using the Docker plugin

This topic describes the steps required to use the Deploy Docker plugin. First, you need to create a Docker registry and then configure the necessary settings in Deploy to integrate with the registry.

Create a Docker registry​

  1. Click Explorer in the top menu.
  2. In the left pane, hover over Configuration and click Explorer action menu
  3. Click New and select docker.Registry.
  4. Fill in the required fields with the name, the registry url, username, and password.

Note When you deploy any container or service to an environment, Deploy will login to the associated registry to retrieve the images.

Configure Deploy to connect to Docker Engine​

  1. Click Explorer in the top menu.

  2. In the left pane, hover over Infrastructure and click Explorer action menu

  3. Click New and select docker.Engine.

  4. Fill in the required fields with the name and the host.

  5. If TLS is enabled on your host, select the Enable TLS option.

  6. Go to the Certificates section. Copy the contents of cert.pem to Certificate field, key.pem to Key field, and ca.pem to Certification Authority field.

    Note If the host system is TLS enabled, the above certificates are mandatory.

  7. Go to Registries section and associate the registry created in the above step under configuration. {% comment %}

  8. Right click the docker.Engine you created and execute Check Connection. {% endcomment %}

  9. Add the new docker.Engine infrastructure item to an environment.

Configure Deploy to connect to Docker Swarm​

  1. Click Explorer in the top menu.

  2. In the left pane, hover over Infrastructure and click Explorer action menu

  3. Click New and select docker.SwarmManager.

  4. Fill in the required fields with the name and the url of the Docker Swarm Leader .

  5. If TLS is enabled on your Leader, select the Enable TLS option.

  6. Go to the Certificates section. In the system home folder, go to .docker > machine > certs and copy the contents of cert.pem to Certificate field, key.pem to Key field, and ca.pem to Certification Authority field.

    Note If the host system is TLS enabled, the above certificates are mandatory.

  7. Go to Registries section and associate the registry created in the above step under configuration. {% comment %}

  8. Right click the docker.Engine you created and execute Check Connection. {% endcomment %}

  9. Add the new docker.SwarmManager infrastructure item to an environment.