Docker Client Operations: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(110 intermediate revisions by the same user not shown)
Line 7: Line 7:
* [[Docker_Concepts#The_Docker_Client|Docker Concepts]]
* [[Docker_Concepts#The_Docker_Client|Docker Concepts]]
* [[Docker Operations#Subjects|Docker Operations]]
* [[Docker Operations#Subjects|Docker Operations]]
=Commands=
{|
| [[docker build|build]] || [[docker create|create]] || [[docker cp|cp]] || [[docker rm|rm]]
|-
| [[docker ps|ps]] || [[docker run|run]] || [[docker stop|stop]]  || [[docker rm|rm]]
|-
| [[docker pull|pull]] || [[docker push|push]] || [[docker rmi|rmi]]
|-
| [[docker tag|tag]] || [[docker stack|stack]]
|}
=Installation Verification=
{{Internal|Docker Installation Verification|Docker Installation Verification}}


=Running the Client=
=Running the Client=
Line 27: Line 43:
==From a Remote Host==
==From a Remote Host==


=Commands=
=Info=
 
==Info==
 
: System-wide info [[docker info]]
 
==Queries==
 
:<span id='ps'></span>[[docker ps|ps]]
:<span id='inspect'></span>Low-level information about a container: [[docker inspect|inspect]]
:<span id='version'></span>[[docker version|version]]
: Look at container's logs [[docker logs|logs]]
: Changes introduced in the container's file system [[docker diff]]
 
==Executions==
 
:<span id='exec'></span>[[docker exec|exec]]
 
==Other==


:<span id='build'></span>[[docker build|build]]
* <span id='version'></span>Server and client version [[docker version|docker version]]
:<span id='import'></span>[[docker import|import]]
* System-wide info [[docker info]]
:<span id='load'></span>[[docker load|load]]
* Low level metadata about an image or container [[docker inspect]]
:<span id='update'></span>[[docker update|update]]
* Resource statistics for running containers [[docker stats]].


=Installation Verification=
=<span id='Image_Management'></span><span id='images'></span>Image Operations=


{{Internal|Docker Installation Verification|Docker Installation Verification}}
==<span id='Image_Registry_Operations'></span>Registry Operations==


=Recipes=
* <span id='Search_for_Images'></span>Search Docker Hub or other registries: [[docker search]]
* <span id='List_Images'></span>List images in the [[Docker_Concepts#Local_Image_Registry|local registry]]: [[docker images]]
* <span id='Remove_an_Image'></span>Remove images from the  [[Docker_Concepts#Local_Image_Registry|local registry]]: [[docker rmi|docker rmi]]
* <span id='Pull_an_Image_from_Registry'></span>Pull an image or a repository from a registry and place it in the local registry: [[docker pull#Overview|docker pull]]
* <span id='Push'></span>Push an image or a repository to a registry: [[docker push#Overview|docker push]]
* <font color=red>'''TODO''': how is a docker instance configured with specific [[Docker Concepts#Image_Registry_Operations|registries]]?</font>
* [[docker tag]]


* [[docker - Start a Container Automatically|Start a Container Automatically]]
==<span id='Image_Manipulation'></span>Image Introspection and Manipulation==
* [[Docker_exec#Attach_to_a_Running_Container|Attach to a Running Container]]


=Scenarios=
* <span id='Build'></span><span id='Build_an_Image'></span>Build an image: [[docker build]]
** [[Building a Container that Loops]]
* <span id='Image_Inspect'></span>Obtain low-level metadata about an image: [[docker inspect]]
* <span id='Image_History'></span>Obtain image history: [[docker history]]
* <span id='Image_Save'></span>Save an image into a TAR archive: [[docker save]]
* <span id='load'></span>Load an image from a TAR archive: [[docker load]]
* <span id='Export_the_Filesystem'></span>Export a container's filesystem into a TAR file: [[docker export]]
* <span id='import'></span>Create a new image from a TAR archive: [[docker import|docker import]]
* [[Docker Image Operations - Create a New Image by Writing Over an Existing Image|Create a new image by writing over an existing image]]


{{Internal|Docker Client Scenarios|Docker Client Scenarios}}


=Image Operations=
===Explore an Image===
<span id='Image_Management'></span><span id='images'></span>
 
{{Internal|Docker_Concepts#Docker_Image_Operations|Docker Concepts - Images}}
 
==Search for Images==
 
Use "search" to look into Docker hub for publicly available images:
 
docker search ''<term>''
 
A different repository can be specified as follows:
 
docker search registry.access.redhat.com/rhel7.4
 
==List Images==
 
List images in the [[Docker_Concepts#Local_Image_Repository|local repository]]:
 
[[docker images]]
 
==Remove an Image==
 
Remove images from the  [[Docker_Concepts#Local_Image_Repository|local repository]]:
 
[[docker rmi|docker rmi]]
 
==Pull an Image from Registry==
 
Pull an image or a repository from a registry:
 
[[docker pull|docker pull]]
 
==Explore an Image==


If the image has a shell, it can be run in interactive mode and explored:  
If the image has a shell, it can be run in interactive mode and explored:  


   [[docker run]] -it <''image-id''|''name''> sh
   [[docker run]] --rm -it <''image-id''|''name''> bash|sh


==Build an Image==
While the container is running, the image can be exported into a TAR file system with [[docker export]] and explored off-line.


[[docker build]]
===Determine the Command that Launches the Process to Be Executed in the Container===


==Image History==
docker inspect --format '&#123;{.Config.Cmd}}' <''image-id''>


[[docker history]]
=<span id='Lifecycle'></span><span id='Recipes'></span>Container Lifecycle Operations=


==Export the Filesystem==
* <span id='List_Containers'></span><span id='ps></span>List containers (running or otherwise): [[docker ps#Overview|docker ps]]
* <span id='Create_and_Run_a_New_Container'></span><span id='run'></span>Create and run a new container:  [[docker run|docker run]]
* <span id='stop'></span><span id='Stop_a_Container'></span>Stop a running container: [[docker stop#Overview|docker stop]]
* <span id='start'></span><span id='Start_a_Previously_Stopped_Container'></span>Start a previously stopped container: [[docker start#Overview|docker start]]
* <span id='start'></span><span id='Restart_a_Container'></span>Restart a container: [[docker restart#Overview|docker restart]]
* <span id='Remove_a_Container></span>Remove a container:  [[docker rm#Overview|docker rm]]
* [[docker - Start a Container Automatically|Start a Container Automatically]]


[[docker export]]
=Interaction with a Running Container=


=Container Lifecycle Operations=
* [[Docker_exec#Attach_to_a_Running_Container|Attach to a Running Container]]:  <span id='exec'></span>[[docker exec|docker exec]]
<span id='Lifecycle'></span>
* <span id='update'></span>[[docker update|docker update]]
* Attach the local standard input, output, and error streams to a running container: <span id='attach'></span>[[docker attach|docker attach]]
* [[Docker Image Operations - Copy Files In and Out of a Container|Copy files in and out of a container]]


==Create and Run a New Container==
=Container Introspection=
<span id='run'></span>


Create and run a new container:  
* <span id='inspect'></span>Low-level information about a container: [[docker inspect|docker inspect]]
* <span id='logs'></span>Look at container's logs [[docker logs|docker logs]]
* Explore changes introduced in the container's file system [[docker diff|docker diff]]
* Resource statistics for running containers [[docker stats]].


[[docker run|docker run]]
=Network=


==Stop a Container==
{{Internal|Docker Network Operations|Network Operations}}
<span id='stop'></span>


Stop a container:
=Storage=


[[docker stop|docker stop]]
{{Internal|Docker Storage Operations|Storage Operations}}


==Start a Previously Stopped Container==
=Security=
:<span id='start'></span>


Start a previously stopped container:
* [[docker login]]


[[docker start|docker start]]
=Scenarios=


==Remove a Container==
{{Internal|Docker Client Scenarios|Docker Client Scenarios}}


Remove a container
=Troubleshooting=


[[docker rm|docker rm]]
* [[Docker_inspect#Get_the_Reasons_a_Container_Was_Killed_For|Get the Reasons a Container Was Killed For]]

Latest revision as of 21:10, 16 August 2019

External

Internal

Commands

build create cp rm
ps run stop rm
pull push rmi
tag stack

Installation Verification

Docker Installation Verification

Running the Client

On the Same Host as the Server

In order to connect to the docker server over the Unix socket, the user running the client must have permissions to do so:

[testuser@docker-server ~]$ ls -al /var/run/docker.sock
srw-rw----. 1 root docker 0 Apr 25 16:00 /var/run/docker.sock

One way to do that is to make the user a member of "docker" group:

usermod -G docker testuser

From a Remote Host

Info

Image Operations

Registry Operations

Image Introspection and Manipulation


Explore an Image

If the image has a shell, it can be run in interactive mode and explored:

 docker run --rm -it <image-id|name> bash|sh

While the container is running, the image can be exported into a TAR file system with docker export and explored off-line.

Determine the Command that Launches the Process to Be Executed in the Container

docker inspect --format '{{.Config.Cmd}}' <image-id>

Container Lifecycle Operations

Interaction with a Running Container

Container Introspection

Network

Network Operations

Storage

Storage Operations

Security

Scenarios

Docker Client Scenarios

Troubleshooting