|
|
| (2 intermediate revisions by 2 users not shown) |
| 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]]}}
| | This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. |
| [[File:Ansible-logo.png|x170px]]
| |
| {{IntroAndLinks|A collection of operations to enable the automated management of Docker containers, and images from Hornbill workflows.
| |
| |
| |
| <!-- Related Links go here -->
| |
| :* [[IT_Operations_Management|IT Operations Management]]
| |
| :* [[Business_Process_Designer|Business Process Designer]]
| |
| :* [[Hornbill_KeySafe|KeySafe]]
| |
| }}
| |
|
| |
|
| ==Target Environment Requirements==
| | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| | | [[Category:HDOC]] |
| === 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_Process_Designer|Business Processes]] and/or IT Operations Management Runbooks.
| |
| | |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Create Container===
| |
| <div class="mw-collapsible-content">
| |
| This operation will create a container within Docker.
| |
| | |
| ====Input Parameters====
| |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>command</code> '''OPTIONAL'''
| |
| * <code>imageName</code> '''MANDATORY'''
| |
| * <code>containerName</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| * <code>containerResponse</code> The response from executing the specific container action.
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Build An Image===
| |
| <div class="mw-collapsible-content">
| |
| Create an image within Docker.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>option</code> '''OPTIONAL'''
| |
| * <code>imagePath</code> '''MANDATORY''' - Format /file-path/file-path
| |
| ====Output Parameters====
| |
| | |
| * <code>imageResponse</code> The created image response
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Get Images===
| |
| <div class="mw-collapsible-content">
| |
| Retrieves all images within the Docker instance.
| |
| | |
| ====Input Parameters====
| |
| | |
| ====Output Parameters====
| |
| | |
| * <code>imageResponse</code> The Created File Name
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Remove A Image===
| |
| <div class="mw-collapsible-content">
| |
| This function will remove an image from within Docker.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>imageID</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| * <code>imageResponse</code> The returned response from the list
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Get Image History===
| |
| <div class="mw-collapsible-content">
| |
| Retrieves the history of the selected image.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>image</code> '''MANDATORY''' - Format /file-path/file-path OR ImageID
| |
| | |
| ====Output Parameters====
| |
| | |
| * <code>imageResponse</code> '''OPTIONAL''' The outcome of the request
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Remove A Container===
| |
| <div class="mw-collapsible-content">
| |
| Removes a container from your Docker instance.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>container</code> '''MANDATORY''' - The name of the container you would like to remove.
| |
| | |
| ====Output Parameters====
| |
| | |
| * <code>containerResponse</code> The response from Docker on the removal of the requested container
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Start Container===
| |
| <div class="mw-collapsible-content">
| |
| Starts up a container from within Docker
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>container</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| | |
| * <code>containerResponse</code>
| |
| * <code>outcome</code> The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Export A Container===
| |
| <div class="mw-collapsible-content">
| |
| Export a container/file system from within Docker as a tar archive.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>container</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| | |
| *<code>containerResponse</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Get Containers===
| |
| <div class="mw-collapsible-content">
| |
| Gets all Containers within Docker
| |
| ====Input Parameters====
| |
| | |
| ====Output Parameters====
| |
|
| |
| * <code>containerResponse</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Get All Running Containers===
| |
| <div class="mw-collapsible-content">
| |
| Provides a list of all running containers within Docker.
| |
| | |
| ====Input Parameters====
| |
| | |
| | |
| ====Output Parameters====
| |
| | |
| *<code>containerResponse</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Stop A Running Container===
| |
| <div class="mw-collapsible-content">
| |
| Stops a running container
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>container</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| | |
| *<code>containerResponse</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| ===Execute A Command===
| |
| <div class="mw-collapsible-content">
| |
| Execute a command on a running container within docker.
| |
| | |
| ====Input Parameters====
| |
| | |
| * <code>options</code> '''OPTIONAL'''
| |
| * <code>container</code> '''MANDATORY'''
| |
| * <code>command</code> '''MANDATORY'''
| |
| | |
| ====Output Parameters====
| |
| | |
| *<code>response</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation
| |
| | |
| </div></div>
| |
| | |
| [[Category:ITOM]] | |
