Docker Linux

Home > Administration > IT Operations Management > ITOM Package Library >Docker Linux

Index

Introduction A collection of operations to enable the automated management of Docker containers, and images from Hornbill workflows.

Related Articles IT Operations Management Business Process Designer KeySafe

Target Environment Requirements

Credentials

Accounts used when executing jobs against operations contained within this package must adhere to the following requirements:

• No additional credentials are required. All authentication is provided though KeySafe on job creation.

Package Operations

The Docker package contains the following operations, than can be used to create ITOM Jobs directly, or included in your Business Processes and/or IT Operations Management Runbooks.

Create Container

This operation will create a container within Docker.

Input Parameters

• options OPTIONAL
• command OPTIONAL
• imageName MANDATORY
• containerName MANDATORY

Output Parameters

• containerResponse The response from executing the specific container action.
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Build An Image

Create an image within Docker.

Input Parameters

• option OPTIONAL
• imagePath MANDATORY - Format /file-path/file-path

Output Parameters

• imageResponse The created image response
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Get Images

Retrieves all images within the Docker instance.

Input Parameters

Output Parameters

• imageResponse The Created File Name
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Remove A Image

This function will remove an image from within Docker.

Input Parameters

• options OPTIONAL
• imageID MANDATORY

Output Parameters

• imageResponse The returned response from the list
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Get Image History

Retrieves the history of the selected image.

Input Parameters

• options OPTIONAL
• image MANDATORY - Format /file-path/file-path OR ImageID

Output Parameters

• imageResponse OPTIONAL The outcome of the request
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Remove A Container

Removes a container from your Docker instance.

Input Parameters

• options OPTIONAL
• container MANDATORY - The name of the container you would like to remove.

Output Parameters

• containerResponse The response from Docker on the removal of the requested container
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Start Container

Starts up a container from within Docker

Input Parameters

• options OPTIONAL
• container MANDATORY

Output Parameters

• containerResponse
• outcome The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Export A Container

Export a container/file system from within Docker as a tar archive.

Input Parameters

• options OPTIONAL
• container MANDATORY

Output Parameters

• containerResponse
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Get Containers

Gets all Containers within Docker

Input Parameters

Output Parameters

• containerResponse
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Get All Running Containers

Provides a list of all running containers within Docker.

Input Parameters

Output Parameters

• containerResponse
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Stop A Running Container

Stops a running container

Input Parameters

• options OPTIONAL
• container MANDATORY

Output Parameters

• containerResponse
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Execute A Command

Execute a command on a running container within docker.

Input Parameters

• options OPTIONAL
• container MANDATORY
• command MANDATORY

Output Parameters

• response
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation