Use Docker with Automation

This article refers to features that are currently rolling out. To find out when these features will be live on your site, keep an eye on our release notes or the Atlassian Community.

You can connect your Docker account with your project to automate the process of managing the code delivery process.

To use these actions, you need to connect the Docker app to Atlassian Automation. For most of the automation actions, you’ll get a connection setup message when you select them. Once the connection is established, you can automate actions and set up triggers based on Docker events.

Before you begin

To manage project automations, you must have the appropriate project permissions:

• Company-managed projects: You’ll need the Administer projects and Browse projects permissions for your project. Learn more about permissions for company-managed projects

• Team-managed projects: You’ll need Administrator access for your project. Learn more about permissions for team-managed projects

To manage global automations, you’ll need the Administer Jira permission. Learn more about global permissions in Jira Cloud.

Actions

Get images from Docker

You can use this action to get all Docker images in your environment.

Enter the following fields or select using smart values:

• All: Return all images.

• Filters: Enter filters to process on the image list, encoded as JSON. For example, use {"dangling": ["true"]} to show only dangling images.

• Digests: Show digest information as a RepoDigests field on each image.

Remove an image from Docker

You can use this action to remove an image from Docker by name or ID.

Enter the following fields or select using smart values:

• Name or ID: Enter the image name or ID to remove.

• Force remove: Select to remove the image even if it is being used.

• Keep parent: Select to avoid deleting untagged parent images.

Inspect an image in Docker

You can use this action to get details about a Docker image.

Enter the following fields or select using smart values:

• Name: Enter the image name or ID to inspect.

Inspect a container in Docker

You can use this action to get details about a Docker container.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container.

• Container size: Select to return the size of the container as fields SizeRw and SizeRootFs.

Kill a container in Docker

You can use this action to stop a running Docker container by sending a signal.

Enter the following fields or select using smart values:

• Container ID or name: Enter the ID or name of the container to stop.

• Signal to send: Enter the stop signal to send to the container as an integer or string (for example, SIGINT or 9).

Get containers from Docker

You can use this action to get all Docker containers, with options to filter by status, creation time, or size.

Enter the following fields or select using smart values:

• All: Return all containers.

• Container size: Select to return the size of the container as fields SizeRw and SizeRootFs.

• Filters: Enter filters to process on the container list, encoded as JSON. For example, use {"status": ["exited"]}.

• Created after this ID: Show only containers created since this ID.

• Created before this ID: Show only containers created before this ID.

Pause a container in Docker

You can use this action to pause a running Docker container by ID or name.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to pause.

Remove a container from Docker

You can use this action to remove a Docker container by ID or name.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to remove.

• Force remove: Select to kill the container before removing it.

• Volume: Select to remove anonymous volumes.

• Link: Select to remove the specified link.

Start a container in Docker

You can use this action to start a stopped Docker container.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to start.

• Override detach keys: Override the key sequence for detaching a container. For example, use Ctrl+C or a single character.

Stop a container in Docker

You can use this action to stop a running Docker container. Optionally set a timeout.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to stop.

• Timeout (in seconds): Enter the number of seconds to wait before killing the container.

Restart a container in Docker

You can use this action to restart a Docker container. Optionally set a timeout.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to restart.

• Timeout (in seconds): Enter the number of seconds to wait before killing the container.

Resume a container in Docker

You can use this action to resume a paused Docker container.

Enter the following fields or select using smart values:

• Container name or ID: Enter the ID or name of the container to resume.

Create a network in Docker

You can use this action to create a Docker network.

Enter the following fields or select using smart values:

• Network name: Enter the name for the new network.

• Driver plugin: Enter the name of the network driver plugin.

• IP address management: Enter a custom IP scheme if needed. For example, use a custom subnet.

• Enable IPv6: Select to enable IPv6 on the network.

• Internal only: Select to restrict external access.

Inspect a network in Docker

You can use this action to get details for a Docker network.

Enter the following fields or select using smart values:

• Network name or ID: Enter the ID or name of the network.

• Filter by scope: Filter the network by scope. For example, use swarm, global, or local.

• Network details: Select to include detailed network information.

Get networks from Docker

You can use this action to get all Docker networks, with options to filter using JSON-encoded filters.

Enter the following fields or select using smart values:

• Filters: Enter filters to process on the network list, encoded as JSON. For example, use {"driver": ["bridge"]}.

Remove a network from Docker

You can use this action to remove a Docker network by ID or name.

Enter the following fields or select using smart values:

• Network name or ID: Enter the ID or name of the network to remove.

Get volumes from Docker

You can use this action to get Docker volumes, with an option to filter by volume name.

Enter the following fields or select using smart values:

• Volume name: Enter the volume name to filter by.

Inspect a volume in Docker

You can use this action to get details for a Docker volume.

Enter the following fields or select using smart values:

• Volume name or ID: Enter the volume name or ID to inspect.

Remove volume from Docker

You can use this action to remove a Docker volume by name or ID. Optionally force removal.

Enter the following fields or select using smart values:

• Volume name or ID: Enter the volume name or ID to remove.

• Force remove: Select to force the removal of the volume.

Get usage information from Docker

You can use this action to get usage data for Docker objects.

Enter the following fields or select using smart values:

• Object type: Enter the object types to compute data for (container, image, volume, build-cache, network). For example, use container or image.