Difference between revisions of "Docker Linux"
JoshHowitt (talk | contribs) (Created page with "{{bluebanner|Home > Administration > IT Operations Management > ITOM Package Library >Docker Linux|:C...") |
JoshHowitt (talk | contribs) |
||
Line 1: | Line 1: | ||
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] >Docker Linux|[[:Category:ITOM|Index]]}} | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] >Docker Linux|[[:Category:ITOM|Index]]}} | ||
− | [[File: | + | [[File:Docker_logo.png|x170px]] |
{{IntroAndLinks|A collection of operations to enable the automated management of Docker containers, and images from Hornbill workflows. | {{IntroAndLinks|A collection of operations to enable the automated management of Docker containers, and images from Hornbill workflows. | ||
| | | |
Revision as of 09:17, 17 May 2023
Home > Administration > IT Operations Management > ITOM Package Library >Docker Linux | Index |
IntroductionA collection of operations to enable the automated management of Docker containers, and images from Hornbill workflows. |
|
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
OPTIONALcommand
OPTIONALimageName
MANDATORYcontainerName
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
OPTIONALimagePath
MANDATORY - Format /file-path/file-path
Output Parameters
imageResponse
The created image responseoutcome
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 Nameoutcome
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
OPTIONALimageID
MANDATORY
Output Parameters
imageResponse
The returned response from the listoutcome
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
OPTIONALimage
MANDATORY - Format /file-path/file-path OR ImageID
Output Parameters
imageResponse
OPTIONAL The outcome of the requestoutcome
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
OPTIONALcontainer
MANDATORY - The name of the container you would like to remove.
Output Parameters
containerResponse
The response from Docker on the removal of the requested containeroutcome
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
OPTIONALcontainer
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
OPTIONALcontainer
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
OPTIONALcontainer
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
OPTIONALcontainer
MANDATORYcommand
MANDATORY
Output Parameters
response
outcome
MANDATORY The outcome of the operation (OK/FAIL)errors
Any errors returned by the operation