Overview
The Docker plugin supports usage of Docker using the Docker Remote API.
The plugin supports :
- Creation and deletion of Docker images.
- Creation and deletion of tagged Docker images.
- Creation and deletion of Docker images from Docker files.
- Creation of Docker containers.
- List created Docker images and containers.
The plugin does not support installation of Docker. For installation of Docker, there's the official Docker installation documentation or Docker can be installed using Pineapple as illustrated with these example modules:
- How-to: Install latest Docker version in a Vagrant box with CentOS 6.5 using SSH.
- How-to: Install latest Docker version in a Vagrant box with CentOS 7.6 using SSH.
- How-to: Install specific version of Docker in a Vagrant box with CentOS 7.6 using SSH.
Usage
Go to the Plugin Usage page for instructions on using the plugin.
Supported operations
The plugin supports the default operations:
- test (from the test workflow). When the plugin is invoked with this operation, it will... TODO: Write...
- create-report (from the report workflow). When the plugin is invoked with this operation, it will list the set of created images and containers.
- deploy-configuration (from the Deployment workflow). When the plugin is invoked with this operation, it will create all the defined images and container.
- undeploy-configuration (from the Deployment workflow). When the plugin is invoked with this operation, it will delete all the defined containers and images.
For more information about the default operations, refer to the Operation and workflow reference.
Plugin schema
The plugin defines a schema named Docker plugin schema for definition of models in module model files. The schema defines the namespace http://pineapple.dev.java.net/ns/plugin/docker_1_0. For more information about where the schema can be found, refer to the Schema locations for plugins page.
Examples
To provide you with better understanding on some usages of the plugin, you can take a look into the following examples:
- How-to: Create Docker image.
- How-to: Delete Docker image.
- How-to: List Docker images and containers.
- How-to: Create tagged Docker image.
- How-to: Create Docker image from a Dockerfile.
- How-to: Create Oracle JDK Docker image.
- How-to: Create OpenJDK Docker image.
- How-to: Create simple Pineapple Docker image.
- How-to: Create Docker container.
- How-to: Delete Docker container.
- How-to: Create multiple Docker containers in one Docker instance.
- How-to: Configure Docker container (Exposed ports).
- How-to: Configure Docker container (Labels).
- How-to: Configure Docker container (Volumes).
- How-to: Configure Docker container (Port bindings).
- How-to: Configure Docker container (Commands).
- How-to: Control Docker containers.
- How-to: Create and run multiple containers with Apache HTTP server (HTTPD) in load balanced setup.
- How-to: Test Docker containers.
Development documentation
Technical documentation for developers about the architecture, design and implementation of the project can be found here.