You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DOCKER_USER_GUIDE.md
+43-42
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Introduction
3
3
4
4
The Linux Tools Docker Tooling plug-ins allow a user to manage Docker Images and Containers with functionality similar to the command-line docker command.
5
5
6
-
For details on Docker and the docker command, see the Docker web-site at <http://www.docker.com>
6
+
For details on Docker and the docker command, see the Docker web-site at <https://www.docker.com>
7
7
8
8
This document discusses functionality found in the Docker Tooling 3.1.0 feature.
9
9
@@ -16,11 +16,11 @@ A new perspective known as the Docker Tooling Perspective is added.
16
16
17
17
This perspective brings up three new views added:
18
18
19
-
-[Docker Explorer View](#Docker_Explorer_View"wikilink") - view for creating/managing connections to Docker daemons
20
-
-[Docker Images View](#Docker_Images_View"wikilink") - view for managing Docker Images
21
-
-[Docker Containers View](#Docker_Containers_View"wikilink") - view for managing Docker Containers
19
+
-[Docker Explorer View](#docker-explorer-view"wikilink") - view for creating/managing connections to Docker daemons
20
+
-[Docker Images View](#docker-images-view"wikilink") - view for managing Docker Images
21
+
-[Docker Containers View](#docker-containers-view"wikilink") - view for managing Docker Containers
22
22
23
-
In addition, the Docker Tooling Perspective adds the [Docker Image Hierarchy View](#Docker_Image_Hierarchy_View"wikilink"), Console View, the Terminal View, and the Properties View.
23
+
In addition, the Docker Tooling Perspective adds the [Docker Image Hierarchy View](#docker-image-hierarchy-view"wikilink"), Console View, the Terminal View, and the Properties View.
24
24
25
25
The Console View is used to display logs of stdout/stderr output from Containers and in some instances, allow input to stdin. The Properties View allows clicking on various elements such as Connections, Images, and Containers and getting detailed info not readily shown in the various views mentioned above.
26
26
@@ -79,11 +79,11 @@ For Connections, Containers, and Images in the Docker Explorer View, right-click
-[Run](#Run_Image"wikilink") - build a Container and run it
113
+
-[Run](#run-image"wikilink") - build a Container and run it
113
114
- Show in Properties View
114
-
-[Open Image Hierarchy](#Docker_Image_Hierarchy_View"wikilink") - show parent Image plus its parents in Image Hierarchy View
115
+
-[Open Image Hierarchy](#docker-image-hierarchy-view"wikilink") - show parent Image plus its parents in Image Hierarchy View
115
116
- Remove - delete selected Images
116
-
-[Push](#Push_Image"wikilink") - push an Image to a registry
117
-
-[Add Tag](#Add_Tag"wikilink") - add a tag to an Image
118
-
-[Remove Tag](#Remove_Tag"wikilink") - remove a tag from an Image with multiple tags
117
+
-[Push](#push-image"wikilink") - push an Image to a registry
118
+
-[Add Tag](#add-tag"wikilink") - add a tag to an Image
119
+
-[Remove Tag](#remove-tag"wikilink") - remove a tag from an Image with multiple tags
119
120
120
121
Docker Images View
121
122
------------------
@@ -130,20 +131,20 @@ The connection used for the Docker Images View is determined by the latest selec
130
131
131
132
There are a number of toolbar actions supported in the Docker Images View:
132
133
133
-
-![](images/LinuxToolsDockerImageViewPull.gif"fig:images/LinuxToolsDockerImageViewPull.png") - [pull an Image from the Repository](#Pull_Image"wikilink")
134
-
-![](images/LinuxToolsDockerImageViewPush.gif"fig:images/LinuxToolsDockerImageViewPush.png") - [push an Image to the Repository](#Push_Image"wikilink")
135
-
-![](images/LinuxToolsDockerContainerCreate.gif"fig:images/LinuxToolsDockerContainerCreate.png") - [create a Container from an Image](#Run_Image"wikilink")
136
-
-![](images/LinuxToolsDockerImageBuild.png"fig:images/LinuxToolsDockerImageBuild.png") - [build an Image from a Dockerfile](#Build_Image"wikilink")
137
-
-![](images/LinuxToolsDockerTagImage.gif"fig:images/LinuxToolsDockerTagImage.png") - [tag an Image](#Add_Tag"wikilink")
134
+
-![](images/LinuxToolsDockerImageViewPull.gif"fig:images/LinuxToolsDockerImageViewPull.png") - [pull an Image from the Repository](#pull-image"wikilink")
135
+
-![](images/LinuxToolsDockerImageViewPush.gif"fig:images/LinuxToolsDockerImageViewPush.png") - [push an Image to the Repository](#push-image"wikilink")
136
+
-![](images/LinuxToolsDockerContainerCreate.gif"fig:images/LinuxToolsDockerContainerCreate.png") - [create a Container from an Image](#run-image"wikilink")
137
+
-![](images/LinuxToolsDockerImageBuild.png"fig:images/LinuxToolsDockerImageBuild.png") - [build an Image from a Dockerfile](#build-image"wikilink")
138
+
-![](images/LinuxToolsDockerTagImage.gif"fig:images/LinuxToolsDockerTagImage.png") - [tag an Image](#add-tag"wikilink")
138
139
-![](images/LinuxToolsDockerDeleteImage.gif"fig:images/LinuxToolsDockerDeleteImage.png") - delete one or more Images (requires confirmation)
139
140
-![](images/LinuxToolsDockerRefreshImage.gif"fig:images/LinuxToolsDockerRefreshImage.png") - refresh Images list
140
141
141
142
There are also context menu actions supported:
142
143
143
-
-![](images/LinuxToolsDockerContainerCreate.gif"fig:images/LinuxToolsDockerContainerCreate.png") - [Run an Image and create a Container](#Run_Image"wikilink")
144
-
-![](images/LinuxToolsDockerTagImage.gif"fig:images/LinuxToolsDockerTagImage.png") - [tag an Image](#Add_Tag"wikilink") (same as the toolbar tag image action)
145
-
-![](images/LinuxToolsDockerRemoveTagIcon.gif"fig:images/LinuxToolsDockerRemoveTagIcon.png") - [remove a tag from an Image with multiple repo tags](#Remove_Tag"wikilink")
-![](images/LinuxToolsDockerContainerCreate.gif"fig:images/LinuxToolsDockerContainerCreate.png") - [Run an Image and create a Container](#run-image"wikilink")
145
+
-![](images/LinuxToolsDockerTagImage.gif"fig:images/LinuxToolsDockerTagImage.png") - [tag an Image](#add-tag"wikilink") (same as the toolbar tag image action)
146
+
-![](images/LinuxToolsDockerRemoveTagIcon.gif"fig:images/LinuxToolsDockerRemoveTagIcon.png") - [remove a tag from an Image with multiple repo tags](#remove-tag"wikilink")
The text entry below the Connection name is used to search/filter the contents of the list. Anything typed in the filter text widget is used to match items in the list (any column) and any row without a match is excluded.
149
150
@@ -155,7 +156,7 @@ The pull Wizard is used to specify the repository or repo:tag specification and
By default, the Docker Hub registry will be used, however, a user may specify an additional private registry if desired. Additional registries can be added by clicking on ***Add a registry account...*** or going to [Windows -\> Preferences -\> Docker -\> Registry Accounts](#Docker_Registry_Accounts_Preference_Page"wikilink").
159
+
By default, the Docker Hub registry will be used, however, a user may specify an additional private registry if desired. Additional registries can be added by clicking on ***Add a registry account...*** or going to [Windows -\> Preferences -\> Docker -\> Registry Accounts](#docker-registry-accounts-preference-page"wikilink").
159
160
160
161
The user can either fill in the complete name of the image to download or a search can be performed using the Search button. This brings up the Search Image Wizard.
161
162
@@ -175,7 +176,7 @@ The pull of an Image may take a long time. This is because an Image may use seve
175
176
176
177
Pushing a Docker Image consists of specifying an existing repo tag to push. By default, Images will be pushed to the default Docker registry, but if a tag contains a registry specifier in addition to repo:tag, it will be pushed to the specified registry. To specify an external or local registry, use the Tag Image function to add a new tag to an existing Image which has the registry specifier and then push that tag.
177
178
178
-
The latest version of the Push Image Wizard allows one to specify a registry/account that has been added via [Window -\> Preferences -\> Docker -\> Registry Accounts](#Docker_Registry_Accounts_Preference_Page"wikilink"). This is needed when authorization is required by the registry for the specified repo. Using the aforementioned tag method assumes no authorization required.
179
+
The latest version of the Push Image Wizard allows one to specify a registry/account that has been added via [Window -\> Preferences -\> Docker -\> Registry Accounts](#docker-registry-accounts-preference-page"wikilink"). This is needed when authorization is required by the registry for the specified repo. Using the aforementioned tag method assumes no authorization required.
179
180
180
181
As well, a new tag can be specified at the time of the push. This new tag is not retained unless specified in the options.
181
182
@@ -259,7 +260,7 @@ There are two fields that need to be filled in:
259
260
- Note that this name must follow correct repo:tag format.
260
261
- Directory - this is the directory that contains or will contain the Dockerfile
261
262
262
-
The directory can be specified using the "Browse" button. Once a valid existing directory is specified, the "Edit" button will be enabled, allowing creation and modification of the Dockerfile using a [basic editor dialog](#Dockerfile_Editor"wikilink").
263
+
The directory can be specified using the "Browse" button. Once a valid existing directory is specified, the "Edit" button will be enabled, allowing creation and modification of the Dockerfile using a [basic editor dialog](#dockerfile-editor"wikilink").
263
264
264
265
When the Dockerfile is considered complete, hitting the "Finish" button will start the Image build action. When the build is complete, the Docker Images View will be refreshed automatically.
265
266
@@ -278,10 +279,10 @@ A Dockerfile is used to specify how to build the new Docker Image. The file cont
278
279
- The cmd form is run in a shell (/bin/sh -c cmd).
279
280
- Typically, this is how you install new packages (e.g. RUN yum install -y gdb). It can also be used to modify the configuration (e.g. sed operations on a config file).
280
281
- These commands are run in the build stage prior to any Container being run and there can be multiple RUN commands specified.
281
-
- CMD - this is the default command that the new Image will run if one isn't specified on [Container create](#Container_Create"wikilink").
282
+
- CMD - this is the default command that the new Image will run if one isn't specified on [Container create](#container-create"wikilink").
282
283
- There are three forms:
283
284
-["executable", "param1", "param2"] - executable form
284
-
-["param1", "param2"] - default parameters to Entrypoint (see [Entrypoint parameter of Create Container](#Create_Container"wikilink")
285
+
-["param1", "param2"] - default parameters to Entrypoint (see [Entrypoint parameter of Create Container](#create-container"wikilink")
285
286
- command param1 param2 - command form
286
287
- The CMD is not run in build, but only when the Container is created and started.
287
288
- ENV - this specifies one of more environment variables
@@ -304,7 +305,7 @@ A Dockerfile is used to specify how to build the new Docker Image. The file cont
304
305
- COPY ["\<src\>"... "\<dest\>"]
305
306
- The second form is used to quote names that have white-space.
306
307
307
-
For more details, see [the official Dockerfile reference](http://docs.docker.com/reference/builder)
308
+
For more details, see [the official Dockerfile reference](https://docs.docker.com/build)
308
309
309
310
#### Build Image Run Configuration
310
311
@@ -372,14 +373,14 @@ It should be noted that the various actions above are enabled/disabled based on
372
373
373
374
The following context menu actions are supported:
374
375
375
-
-![](images/LinuxToolsDockerContainerCommitIcon.gif"fig:LinuxToolsDockerContainerCommitIcon.png") Commit Container - [commit all changes of a selected Container into a new Image](#Commit_Container"wikilink")
376
+
-![](images/LinuxToolsDockerContainerCommitIcon.gif"fig:LinuxToolsDockerContainerCommitIcon.png") Commit Container - [commit all changes of a selected Container into a new Image](#commit-container"wikilink")
376
377
-![](images/LinuxToolsDockerContainerRestartIcon.gif"fig:LinuxToolsDockerContainerRestartIcon.png") Restart - restart a Container (will wait to stop a running Container, then will kill it before starting again)
377
-
-![](images/LinuxToolsDockerContainerDisplayLogIcon.gif"fig:LinuxToolsDockerContainerDisplayLogIcon.png") Display Log - [display the stdout/stderr logs of a selected Container in the Console View](#Display_Log"wikilink")
378
+
-![](images/LinuxToolsDockerContainerDisplayLogIcon.gif"fig:LinuxToolsDockerContainerDisplayLogIcon.png") Display Log - [display the stdout/stderr logs of a selected Container in the Console View](#display-log"wikilink")
378
379
-![](images/LinuxToolsDockerContainerRemoveLogIcon.gif"fig:LinuxToolsDockerContainerRemoveLogIcon.png") Remove Log - remove the stdout/stderr logs of a selected Container from the Console View
379
-
-![](images/LinuxToolsDockerOpenImageHierarchy.png"fig:LinuxToolsDockerOpenImageHierarchy.png") Open Image Hierarchy - [Open Image Hierarchy for Container](#Docker_Image_Hierarchy_View"wikilink")
380
-
-![](images/LinuxToolsDockerCopyFromContainer.gif"fig:LinuxToolsDockerCopyFromContainer.png") Copy from Container - [copy files from Container to Host](#Copy_from_Container"wikilink")
381
-
-![](images/LinuxToolsDockerCopyToContainer.gif"fig:LinuxToolsDockerCopyToContainer.png") Copy to Container - [copy files from Host to Container](#Copy_to_Container"wikilink")
382
-
-![](images/LinuxToolsDockerExecuteShell.gif"fig:LinuxToolsDockerExecuteShell.png") Execute Shell - [execute a shell in running Container](#Execute_Shell"wikilink")
380
+
-![](images/LinuxToolsDockerOpenImageHierarchy.png"fig:LinuxToolsDockerOpenImageHierarchy.png") Open Image Hierarchy - [Open Image Hierarchy for Container](#docker-image-hierarchy-view"wikilink")
381
+
-![](images/LinuxToolsDockerCopyFromContainer.gif"fig:LinuxToolsDockerCopyFromContainer.png") Copy from Container - [copy files from Container to Host](#copy-from-container"wikilink")
382
+
-![](images/LinuxToolsDockerCopyToContainer.gif"fig:LinuxToolsDockerCopyToContainer.png") Copy to Container - [copy files from Host to Container](#copy-to-container"wikilink")
383
+
-![](images/LinuxToolsDockerExecuteShell.gif"fig:LinuxToolsDockerExecuteShell.png") Execute Shell - [execute a shell in running Container](#execute-shell"wikilink")
383
384
384
385
### Filtering Labels
385
386
@@ -451,12 +452,12 @@ Docker Image Hierarchy View
451
452
452
453
The Image Hierarchy View displays a hierarchy of Images starting at a particular Image or Container back to its earliest parent Image. A parent Image is one that is used in a Build Image action. In the case where the Image Hierarchy is started from an Image, all of its existing Containers are shown as children. In the case where the Image Hierarchy is started from a Container, just the selected Container is shown under the Image used to create it.
453
454
454
-
Context menu actions are available for the Docker Images and Docker Containers in the View. These match those found in the [Docker Explorer View context menu](#Docker_Explorer_Context_Menu"wikilink").
455
+
Context menu actions are available for the Docker Images and Docker Containers in the View. These match those found in the [Docker Explorer View context menu](#docker-explorer-context-menu"wikilink").
455
456
456
457
Properties View
457
458
---------------
458
459
459
-
The Properties View will respond to selections in the four Docker Tooling Views: [Docker Explorer View](#Docker_Explorer_View"wikilink"), [Docker Images View](#Docker_Images_View"wikilink"), [Docker Containers View](#Docker_Containers_View"wikilink"), and the [Docker Image Hierarchy View](#Docker_Image_Hierarchy_View"wikilink"). The data shown will depend on what is being selected:
460
+
The Properties View will respond to selections in the four Docker Tooling Views: [Docker Explorer View](#docker-explorer-view"wikilink"), [Docker Images View](#docker-images-view"wikilink"), [Docker Containers View](#docker-containers-view"wikilink"), and the [Docker Image Hierarchy View](#docker-image-hierarchy-view"wikilink"). The data shown will depend on what is being selected:
460
461
461
462
- Docker Connection
462
463
- Docker Image
@@ -478,7 +479,7 @@ Support has been added for docker-compose.
478
479
479
480
Users can select a docker-compose.yml file and start Docker Compose from the context menu, using the Run \> Docker Compose launcher shortcut.
480
481
481
-
The Docker Compose process displays its logs (with support for text coloring based on ANSI escape codes) and provides a stop button to stop the underlying process. The location of the docker-compose command is specified using the [docker compose preferences page](#Docker_Compose_Preference_Page"wikilink") location using Window-\>Preferences-\>Docker-\>Docker Compose.
482
+
The Docker Compose process displays its logs (with support for text coloring based on ANSI escape codes) and provides a stop button to stop the underlying process. The location of the docker-compose command is specified using the [docker compose preferences page](#docker-compose-preference-page"wikilink") location using Window-\>Preferences-\>Docker-\>Docker Compose.
@@ -527,4 +528,4 @@ Here a user may specify registry account information. By default, a user has acc
527
528
528
529
The page supports adding, editing, and removing accounts.
529
530
530
-
Once a registry account entry is added, it may be used for pushing and pulling images. See the [push image](#Push_Image"wikilink") and [pull image](#Pull_Image"wikilink") sections for details.
531
+
Once a registry account entry is added, it may be used for pushing and pulling images. See the [push image](#push-image"wikilink") and [pull image](#pull-image"wikilink") sections for details.
0 commit comments