Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Johnston2015-06-04 17:33:39 -0400
committerJeff Johnston2015-06-04 18:56:06 -0400
commit18c1b907f9f6b93b9fa74b4b12e51c9761815c3b (patch)
tree1f5660dea7d8615c63ebb68f81e0375cc9050950
parent76d41f9f07cb5069859bdf3add7bbf11417445f9 (diff)
downloadorg.eclipse.linuxtools-18c1b907f9f6b93b9fa74b4b12e51c9761815c3b.tar.gz
org.eclipse.linuxtools-18c1b907f9f6b93b9fa74b4b12e51c9761815c3b.tar.xz
org.eclipse.linuxtools-18c1b907f9f6b93b9fa74b4b12e51c9761815c3b.zip
Update Docker Tooling User Guide for fixes applied to Mars RC3.
Change-Id: If935710121b0ddd2902de36cce70f67f12902c94 Task-Url: Reviewed-on: https://git.eclipse.org/r/49477 Tested-by: Hudson CI Reviewed-by: Jeff Johnston <jjohnstn@redhat.com> Tested-by: Jeff Johnston <jjohnstn@redhat.com> (cherry picked from commit 8acb3bb562c308fb5162b8b79b33035822e71301) Reviewed-on: https://git.eclipse.org/r/49479
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html132
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Updating-This-Document.html2
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerContainerMenu.pngbin0 -> 91787 bytes
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerImageMenu.pngbin0 -> 72144 bytes
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard1.pngbin0 -> 65332 bytes
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard2.pngbin0 -> 44908 bytes
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/build-helper.xml2
-rw-r--r--containers/org.eclipse.linuxtools.docker.docs/toc.xml2
-rw-r--r--releng/org.eclipse.linuxtools.target/linuxtools-e4.5.target4
9 files changed, 114 insertions, 28 deletions
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html
index cf99a7b2c8..58b7bd7098 100644
--- a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html
@@ -36,14 +36,14 @@
</p>
<p>This perspective brings up three new views added:</p>
<ul>
- <li>Docker Explorer View -
- <a href="Docker-Tooling-Perspective.html#Docker_Explorer_View">view for creating/managing connections to Docker daemons</a>
+ <li>
+ <a href="#Docker_Explorer_View">Docker Explorer View</a> - view for creating/managing connections to Docker daemons]]
</li>
- <li>Docker Images View -
- <a href="Docker-Tooling-Perspective.html#Docker_Images_View">view for managing Docker Images</a>
+ <li>
+ <a href="#Docker_Images_View">Docker Images View</a> - view for managing Docker Images]]
</li>
- <li>Docker Containers View -
- <a href="Docker-Tooling-Perspective.html#Docker_Containers_View">view for managing Docker Containers</a>
+ <li>
+ <a href="#Docker_Containers_View">Docker Containers View</a> - view for managing Docker Containers]]
</li>
</ul>
<p>In addition, the Docker Tooling Perspective adds the Console View and the Properties View.</p>
@@ -97,6 +97,94 @@
<li>Stopped Containers (this includes paused Containers)</li>
<li>Top-level Images (only show the first repo tag for an Image with multiple tags)</li>
</ul>
+ <h3 id="Docker_Explorer_Context_Menu">Docker Explorer Context Menu</h3>
+ <p>For both Containers and Images in the Docker Explorer View, right-clicking on a selection brings up the context menu with tasks to
+ perform on the selected item(s). Actions applying to multiple items are only enabled if the action can be performed on all selected items.</p>
+ <p>
+ <img border="0" src="images/LinuxToolsExplorerContainerMenu.png"/>
+ </p>
+ <p>For Containers, one can:</p>
+ <ul>
+ <li>Start selected Containers - start a stopped Container</li>
+ <li>Pause selected Containers - pause a running Container</li>
+ <li>Unpause selected Containers - continue a paused Container</li>
+ <li>Stop selected Containers - stop running Containers</li>
+ <li>Kill selected Containers - kill running Containers</li>
+ <li>Remove selected Containers - delete stopped Containers</li>
+ <li>
+ <a href="#Commit_Container">Commit Container</a> - commit the Container to an Image
+ </li>
+ <li>
+ <a href="#Display_Log">Display Log</a> - display the log for the Container
+ </li>
+ <li>Remove Log - removes the log for the Container from Eclipse Console View</li>
+ </ul>
+ <p>
+ <img border="0" src="images/LinuxToolsExplorerImageMenu.png"/>
+ </p>
+ <p>For Images, one can:</p>
+ <ul>
+ <li>
+ <a href="#Run_Image">Run Image</a> - build a Container and run it
+ </li>
+ <li>
+ <a href="#Push_Image">Push Image</a> - push an Image to a registry
+ </li>
+ <li>
+ <a href="#Tag_Image">Tag Image</a> - add a tag to an Image
+ </li>
+ <li>
+ <a href="#Remove_Tag">Remove Tag</a> - remove a tag from an Image with multiple tags
+ </li>
+ <li>Remove Selected Images - delete selected Images</li>
+ </ul>
+ <h3 id="Run_Image">Run Image</h3>
+ <p>The Run Image menu selection in the Docker Explorer View brings up the Run Image Wizard. This Wizard is
+ similar in functionality to the
+ <a href="#Create_Container">Create Container</a> toolbar action that is available from the Docker Images View. The
+ Run Image Wizard has less settings but is more straight-forward to use than the
+ <a href="#Create_Container">Create Container</a> Wizard.
+ </p>
+ <p>The first page of the Wizard allows a number of common settings:</p>
+ <p>
+ <img border="0" src="images/LinuxToolsRunImageWizard1.png"/>
+ </p>
+ <ul>
+ <li>Image - this field is filled in based on the user's selection
+ <ul>
+ <li>Other images are available from the pull-down or the user can type in an Image not currently loaded and click on the Pull Image link.</li>
+ </ul>
+ </li>
+ <li>Name - this field must be filled in as this is the name of the new Image</li>
+ <li>EntryPoint - this allows configuring the Container to run as an executable
+ <ul>
+ <li>The entry point is an executable to run plus arguments. On the command-line, additional arguments can be specified.</li>
+ </ul>
+ </li>
+ <li>Command - this is the command to run in the Container when it starts
+ <ul>
+ <li>This field may be left blank if the Image has a default command to run.</li>
+ </ul>
+ </li>
+ <li>Ports - the user can choose to expose ports from the Container (self-explanatory)</li>
+ <li>Links - the user can choose to link to other Containers</li>
+ <li>Keep Stdin Open - used to allow input from the Console</li>
+ <li>Allocate pseudo-tty - used to allocate a TTY for the Container (needed if running a shell)</li>
+ <li>Automatically remove the Container on exit - this is used to remove the Container when finished</li>
+ </ul>
+ <p>The second page of the Wizard also has a number of needed settings:</p>
+ <p>
+ <img border="0" src="images/LinuxToolsRunImageWizard2.png"/>
+ </p>
+ <ul>
+ <li>Data Volumes - the user can mount Host volumes in the Container or mount other Container volumes
+ <ul>
+ <li>This is useful for copying data from the Host into the Container (e.g. an executable).</li>
+ </ul>
+ </li>
+ <li>Environment Variables - way of specifying Env variables to use in the Container</li>
+ <li>Enable Resource Limits - this is used to restrict memory or CPU priority for the Container</li>
+ </ul>
<h2 id="Docker_Images_View">Docker Images View</h2>
<h3 id="Overview_2">Overview</h3>
<p>The Docker Images View is used to manage Docker Images. By default, the View shows only top-level Images that have at least one repo:tag name. The menu options allows you to see all Images by clicking the "Show all images" check-box.</p>
@@ -111,26 +199,26 @@
<ul>
<li>
<img border="0" src="images/LinuxToolsDockerImageViewPull.png"/> -
- <a href="Docker-Tooling-Perspective.html#Pull_Image">pull an Image from the Repository</a>
+ <a href="#Pull_Image">pull an Image from the Repository</a>
</li>
<li>
<img border="0" src="images/LinuxToolsDockerImageViewPush.png"/> -
- <a href="Docker-Tooling-Perspective.html#Push_Image">push an Image to the Repository</a>
+ <a href="#Push_Image">push an Image to the Repository</a>
</li>
<li>
<img border="0" src="images/LinuxToolsDockerContainerCreate.png"/> -
- <a href="Docker-Tooling-Perspective.html#Create_Container">create a Container from an Image</a>
+ <a href="#Create_Container">create a Container from an Image</a>
</li>
<li>
<img border="0" src="images/LinuxToolsDockerImageBuild.png"/> -
- <a href="Docker-Tooling-Perspective.html#Build_Image">build an Image from a Dockerfile</a>
+ <a href="#Build_Image">build an Image from a Dockerfile</a>
</li>
<li>
<img border="0" src="images/LinuxToolsDockerDeleteImage.png"/> - delete one or more Images (requires confirmation)
</li>
<li>
<img border="0" src="images/LinuxToolsDockerTagImage.png"/> -
- <a href="Docker-Tooling-Perspective.html#Tag_Image">tag an Image</a>
+ <a href="#Tag_Image">tag an Image</a>
</li>
<li>
<img border="0" src="images/LinuxToolsDockerRefreshImage.png"/> - refresh Images list
@@ -138,11 +226,11 @@
</ul>
<p>There are also context menu actions supported:</p>
<ul>
- <li>Tag Image -
- <a href="Docker-Tooling-Perspective.html#Tag_Image">same as the toolbar tag image action</a>
+ <li>
+ <a href="#Tag_Image">Tag Image</a> - same as the toolbar tag image action
</li>
- <li>Remove Tag -
- <a href="Docker-Tooling-Perspective.html#Remove_Tag">remove a tag from an Image with multiple repo tags</a>
+ <li>
+ <a href="#Remove_Tag">Remove Tag</a> - remove a tag from an Image with multiple repo tags
</li>
</ul>
<p>The text entry below the Connection name is used to search/filter the contents of the list.
@@ -270,7 +358,7 @@
<p>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
- <a href="Docker-Tooling-Perspective.html#Dockerfile_Editor">basic editor dialog</a>.
+ <a href="#Dockerfile_Editor">basic editor dialog</a>.
</p>
<p>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
@@ -307,7 +395,7 @@
</li>
<li>
<a href="&quot;param1&quot;,">"param2"</a> - default parameters to Entrypoint (see
- <a href="Docker-Tooling-Perspective.html#Create_Container">Entrypoint parameter of Create Container</a>
+ <a href="#Create_Container">Entrypoint parameter of Create Container</a>
</li>
<li>command param1 param2 - command form</li>
</ul>
@@ -433,10 +521,10 @@
<p>The following context menu actions are supported:</p>
<ul>
<li>Commit Container -
- <a href="Docker-Tooling-Perspective.html#Commit_Container">commit all changes of a selected Container into a new Image</a>
+ <a href="#Commit_Container">commit all changes of a selected Container into a new Image</a>
</li>
<li>Display Log -
- <a href="Docker-Tooling-Perspective.html#Display_Log">display the stdout/stderr logs of a selected Container in the Console View</a>
+ <a href="#Display_Log">display the stdout/stderr logs of a selected Container in the Console View</a>
</li>
<li>Remove Log - remove the stdout/stderr logs of a selected Container from the Console View</li>
</ul>
@@ -476,9 +564,9 @@
</ul>
<h2 id="Properties_View">Properties View</h2>
<p>The Properties View will respond to selections in the three Docker Tooling Views:
- <a href="Docker-Tooling-Perspective.html#Docker_Explorer_View">Docker Explorer View</a>,
- <a href="Docker-Tooling-Perspective.html#Docker_Images_View">Docker Images View</a>, and the
- <a href="Docker-Tooling-Perspective.html#Docker_Containers_View">Docker Containers View</a>. The data shown will depend on what is being selected:
+ <a href="#Docker_Explorer_View">Docker Explorer View</a>,
+ <a href="#Docker_Images_View">Docker Images View</a>, and the
+ <a href="#Docker_Containers_View">Docker Containers View</a>. The data shown will depend on what is being selected:
</p>
<ul>
<li>Docker Connection</li>
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Updating-This-Document.html b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Updating-This-Document.html
index f7575de56a..251d680ec0 100644
--- a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Updating-This-Document.html
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/Updating-This-Document.html
@@ -27,7 +27,7 @@
</table><hr/>
<h1 id="Updating_This_Document">Updating This Document</h1>
<pre> This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
- http://wiki.eclipse.org/Linux_Tools_Project/Docker_Tooling/User_Guide .
+ <a href="http://wiki.eclipse.org/Linux_Tools_Project/Docker_Tooling/User_Guide">http://wiki.eclipse.org/Linux_Tools_Project/Docker_Tooling/User_Guide</a> .
</pre><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerContainerMenu.png b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerContainerMenu.png
new file mode 100644
index 0000000000..6afa541779
--- /dev/null
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerContainerMenu.png
Binary files differ
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerImageMenu.png b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerImageMenu.png
new file mode 100644
index 0000000000..69195c9c51
--- /dev/null
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsExplorerImageMenu.png
Binary files differ
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard1.png b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard1.png
new file mode 100644
index 0000000000..2b4dd216b5
--- /dev/null
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard1.png
Binary files differ
diff --git a/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard2.png b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard2.png
new file mode 100644
index 0000000000..1c48845170
--- /dev/null
+++ b/containers/org.eclipse.linuxtools.docker.docs/Linux_Tools_Project/Docker_Tooling/User_Guide/images/LinuxToolsRunImageWizard2.png
Binary files differ
diff --git a/containers/org.eclipse.linuxtools.docker.docs/build-helper.xml b/containers/org.eclipse.linuxtools.docker.docs/build-helper.xml
index 6e44e9dc24..d10c86892e 100644
--- a/containers/org.eclipse.linuxtools.docker.docs/build-helper.xml
+++ b/containers/org.eclipse.linuxtools.docker.docs/build-helper.xml
@@ -9,7 +9,7 @@
<path id="tasks.classpath" path="bin" />
<path id="wikitext.tasks.classpath">
<!-- Replace dir with the dir you have wikitext installed into.-->
- <fileset dir="/usr/lib64/eclipse/dropins/mylyn-wikitext/eclipse/plugins">
+ <fileset dir="/usr/share/eclipse/dropins/mylyn/eclipse/plugins">
<include name="org.eclipse.mylyn.wikitext.*core*.jar" />
</fileset>
</path>
diff --git a/containers/org.eclipse.linuxtools.docker.docs/toc.xml b/containers/org.eclipse.linuxtools.docker.docs/toc.xml
index 5da808ec0e..3cfe63afd6 100644
--- a/containers/org.eclipse.linuxtools.docker.docs/toc.xml
+++ b/containers/org.eclipse.linuxtools.docker.docs/toc.xml
@@ -5,6 +5,8 @@
<topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html" label="Docker Tooling Perspective">
<topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Docker_Explorer_View" label="Docker Explorer View">
<topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Overview" label="Overview"></topic>
+ <topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Docker_Explorer_Context_Menu" label="Docker Explorer Context Menu"></topic>
+ <topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Run_Image" label="Run Image"></topic>
</topic>
<topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Docker_Images_View" label="Docker Images View">
<topic href="Linux_Tools_Project/Docker_Tooling/User_Guide/Docker-Tooling-Perspective.html#Overview_2" label="Overview"></topic>
diff --git a/releng/org.eclipse.linuxtools.target/linuxtools-e4.5.target b/releng/org.eclipse.linuxtools.target/linuxtools-e4.5.target
index b415f722c1..fd183d56ca 100644
--- a/releng/org.eclipse.linuxtools.target/linuxtools-e4.5.target
+++ b/releng/org.eclipse.linuxtools.target/linuxtools-e4.5.target
@@ -27,10 +27,6 @@
<repository location="http://download.eclipse.org/tm/updates/3.6"/>
</location>
<location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
-<unit id="org.eclipse.ptp.rdt.feature.group" version="0.0.0"/>
-<repository location="http://download.eclipse.org/tools/ptp/builds/mars/milestones"/>
-</location>
-<location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
<unit id="org.eclipse.ptp.rdt.sync.feature.group" version="0.0.0"/>
<repository location="http://download.eclipse.org/tools/ptp/builds/mars/milestones"/>
</location>

Back to the top