Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Linux Tools Project/Docker Tooling"
(→Dependencies) |
m (adding link to user guide, mentioning support for "exec shell") |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
* support launching C/C++ applications in Docker Containers via Eclipse | * support launching C/C++ applications in Docker Containers via Eclipse | ||
* support Linux Tools profiling in Docker Containers | * support Linux Tools profiling in Docker Containers | ||
| − | |||
* make support accessible in package-based systems such as Fedora and possibly RHEL DTS | * make support accessible in package-based systems such as Fedora and possibly RHEL DTS | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_severity=enhancement&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Tools&component=Docker&list_id=12687997&product=Linux%20Tools&query_format=advanced Proposed Features] | ||
== Design == | == Design == | ||
| − | The tooling support | + | The tooling support uses the [https://github.com/spotify/docker-client docker-client] Java API library to communicate with the Docker daemon. At the time this project |
was started, there were two main Java API library efforts underway: docker-client and docker-java. | was started, there were two main Java API library efforts underway: docker-client and docker-java. | ||
As docker-client was the only one of the two to support Unix sockets (default on Linux), the choice | As docker-client was the only one of the two to support Unix sockets (default on Linux), the choice | ||
| Line 32: | Line 32: | ||
== Dependencies == | == Dependencies == | ||
| − | + | A full transitive closure of dependencies for docker-client may be seen at https://rgrunber.fedorapeople.org/docker-client-deps.svg | |
| − | + | ||
| − | + | ||
| − | + | The docker-client package is made available at Eclipse through the Eclipse Orbit Project. As of Eclipse Mars M7 (May 08/2015) | |
| − | + | all dependency CQs have been approved and the dependency packages have been pushed into Orbit. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Source Code == | == Source Code == | ||
| + | The source for the Docker Tooling code can be found in the containers directory of the Linux Tools git repository: | ||
| − | + | * [http://git.eclipse.org/c/linuxtools/org.eclipse.linuxtools.git/ http://git.eclipse.org/c/linuxtools/org.eclipse.linuxtools.git/] web | |
| − | + | * git://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous) | |
| − | + | * http://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous) | |
| + | * ssh://<committerId>@git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (committers) | ||
| + | == User Guide == | ||
| + | |||
| + | The user guide is available [https://wiki.eclipse.org/Linux_Tools_Project/Docker_Tooling/User_Guide here]. | ||
== Status == | == Status == | ||
| − | + | The following management functionality is working: | |
* Docker Explorer View, Docker Images View, and Docker Containers View all working | * Docker Explorer View, Docker Images View, and Docker Containers View all working | ||
* ability to connect to Unix socket or to TCP connection (remote/local) | * ability to connect to Unix socket or to TCP connection (remote/local) | ||
* support for Linux, Mac, and Windows platforms | * support for Linux, Mac, and Windows platforms | ||
| + | * Connection support | ||
| + | ** create connection | ||
| + | ** delete connection | ||
* Image support | * Image support | ||
** push image | ** push image | ||
| Line 88: | Line 65: | ||
** tag image | ** tag image | ||
** remote image | ** remote image | ||
| + | ** properties view support for Image info | ||
* Container support | * Container support | ||
** start container | ** start container | ||
| Line 96: | Line 74: | ||
** remove container | ** remove container | ||
** commit image from container | ** commit image from container | ||
| − | * | + | ** display logs |
| + | ** console stdin and tty support | ||
| + | ** properties view support for Container info | ||
| + | ** execute shell in a container (in the Terminal view) | ||
| + | * CDT support | ||
| + | ** run C/C++ application in Container | ||
| + | ** debug C/C++ application in Container (assumes gdbserver installed in Docker Image) | ||
| + | |||
| + | == Snapshot == | ||
| − | + | [[File:DockerTooling05192015.png]] | |
| − | + | ||
Latest revision as of 02:48, 20 May 2016
Contents
Background
The Docker Tooling project is an effort to support Docker Containers in Eclipse. The project was started as a prototype by the Linux Tools group and has grown to be a joint work effort between the Red Hat Linux Tools Eclipse team and the Red Hat JBoss Eclipse team.
Goals
- support management of Docker Images and Containers in Eclipse
- support launching C/C++ applications in Docker Containers via Eclipse
- support Linux Tools profiling in Docker Containers
- make support accessible in package-based systems such as Fedora and possibly RHEL DTS
- Proposed Features
Design
The tooling support uses the docker-client Java API library to communicate with the Docker daemon. At the time this project was started, there were two main Java API library efforts underway: docker-client and docker-java. As docker-client was the only one of the two to support Unix sockets (default on Linux), the choice was made.
There are two main plug-ins: org.eclipse.linuxtools.docker.core and org.eclipse.linuxtools.docker.ui which support Docker Image and Container management functionality. In the UI, there are three new views:
- Docker Explorer View (tree view showing Docker Connections plus their Images and Containers)
- Docker Images View (table view of all downloaded images for a selected connection)
- Docker Containers View (table view of all Containers for a selected connection (filter enabled))
Work is also underway on a CDT plug-in: org.eclipse.cdt.docker.launch which adds support for launching and debugging C/C++ applications built in the CDT into Docker Containers.
Dependencies
A full transitive closure of dependencies for docker-client may be seen at https://rgrunber.fedorapeople.org/docker-client-deps.svg
The docker-client package is made available at Eclipse through the Eclipse Orbit Project. As of Eclipse Mars M7 (May 08/2015) all dependency CQs have been approved and the dependency packages have been pushed into Orbit.
Source Code
The source for the Docker Tooling code can be found in the containers directory of the Linux Tools git repository:
- http://git.eclipse.org/c/linuxtools/org.eclipse.linuxtools.git/ web
- git://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous)
- http://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous)
- ssh://<committerId>@git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (committers)
User Guide
The user guide is available here.
Status
The following management functionality is working:
- Docker Explorer View, Docker Images View, and Docker Containers View all working
- ability to connect to Unix socket or to TCP connection (remote/local)
- support for Linux, Mac, and Windows platforms
- Connection support
- create connection
- delete connection
- Image support
- push image
- pull image
- create container from image
- build image
- tag image
- remote image
- properties view support for Image info
- Container support
- start container
- stop container
- pause container
- unpause container
- kill container
- remove container
- commit image from container
- display logs
- console stdin and tty support
- properties view support for Container info
- execute shell in a container (in the Terminal view)
- CDT support
- run C/C++ application in Container
- debug C/C++ application in Container (assumes gdbserver installed in Docker Image)
Snapshot
