Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker

Class DockerRemoteTerminal

java.lang.Object

com.oracle.bedrock.runtime.docker.DockerRemoteTerminal

All Implemented Interfaces:

com.oracle.bedrock.Option, Deployer, RemoteTerminal

public class DockerRemoteTerminal
extends Object
implements RemoteTerminal, Deployer

A specialized RemoteTerminal used to generate Docker images and launch Docker containers from those images.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerRemoteTerminal.ContainerApplication	An implementation of an Application the sole purpose of which is to be able to capture the ApplicationProcess.
static class	DockerRemoteTerminal.ContainerMetaClass	The MetaClass that is used when starting a Docker container application.

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Nested classes/interfaces inherited from interface com.oracle.bedrock.runtime.remote.RemoteTerminal

RemoteTerminal.Launchable

Field Summary

Fields inherited from interface com.oracle.bedrock.runtime.remote.options.Deployer

NULL

Constructor Summary

Constructors

Constructor	Description
DockerRemoteTerminal(com.oracle.bedrock.runtime.Platform platform)	Construct a new DockerRemoteTerminal.

Method Summary

Modifier and Type	Method	Description
protected DockerImage	createImage(String imageTag, File dockerFile, Docker docker, com.oracle.bedrock.OptionsByType optionsByType)	Create a Docker image.
DeployedArtifacts	deploy(List<DeploymentArtifact> artifactsToDeploy, String remoteDirectory, com.oracle.bedrock.runtime.Platform platform, com.oracle.bedrock.Option... deploymentOptions)
RemoteApplicationProcess	launch(RemoteTerminal.Launchable launchable, Class<? extends com.oracle.bedrock.runtime.Application> applicationClass, com.oracle.bedrock.OptionsByType optionsByType)
void	makeDirectories(String directoryName, com.oracle.bedrock.OptionsByType optionsByType)	Write any mkdir commands to the Dockerfile
protected com.oracle.bedrock.runtime.ApplicationProcess	runContainer(String containerName, RemoteTerminal.Launchable launchable, DockerImage image, Docker docker, com.oracle.bedrock.OptionsByType optionsByType)	Run a container using the specified image.
DeployedArtifacts	undeploy(DeployedArtifacts deployedArtifacts, com.oracle.bedrock.runtime.Platform platform, com.oracle.bedrock.Option... deploymentOptions)
protected File	writeDockerFile(RemoteTerminal.Launchable launchable, String baseImage, com.oracle.bedrock.OptionsByType optionsByType)	Write a Dockerfile that can be used to run the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockerRemoteTerminal

public DockerRemoteTerminal(com.oracle.bedrock.runtime.Platform platform)

Construct a new DockerRemoteTerminal.

Parameters:

platform - the Platform the commands will run on

Method Detail

deploy

public DeployedArtifacts deploy(List<DeploymentArtifact> artifactsToDeploy,
                                String remoteDirectory,
                                com.oracle.bedrock.runtime.Platform platform,
                                com.oracle.bedrock.Option... deploymentOptions)

Specified by:

deploy in interface Deployer

undeploy

public DeployedArtifacts undeploy(DeployedArtifacts deployedArtifacts,
                                  com.oracle.bedrock.runtime.Platform platform,
                                  com.oracle.bedrock.Option... deploymentOptions)

Specified by:

undeploy in interface Deployer

makeDirectories

public void makeDirectories(String directoryName,
                            com.oracle.bedrock.OptionsByType optionsByType)

Write any mkdir commands to the Dockerfile

Specified by:

makeDirectories in interface RemoteTerminal

Parameters:

directoryName - the directory to create

optionsByType - the OptionsByType controlling the build of the Dockerfile

launch

public RemoteApplicationProcess launch(RemoteTerminal.Launchable launchable,
                                       Class<? extends com.oracle.bedrock.runtime.Application> applicationClass,
                                       com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

launch in interface RemoteTerminal

writeDockerFile

protected File writeDockerFile(RemoteTerminal.Launchable launchable,
                               String baseImage,
                               com.oracle.bedrock.OptionsByType optionsByType)
                        throws IOException

Write a Dockerfile that can be used to run the application.

Parameters:

launchable - the RemoteTerminal.Launchable to use

baseImage - the name of the base image to use in the Dockerfile FROM statement

optionsByType - the OptionsByType to use

Returns:

the File representing the Dockerfile created

Throws:

IOException - if there is an error writing the Dockerfile

createImage

protected DockerImage createImage(String imageTag,
                                  File dockerFile,
                                  Docker docker,
                                  com.oracle.bedrock.OptionsByType optionsByType)

Create a Docker image.

The image will contain all of the required artifacts to run the application. The image will be tagged with a random UUID.

Parameters:

imageTag - the tag to apply to the image

dockerFile - the Dockerfile to use to build the image

docker - the Docker environment to use

optionsByType - the OptionsByType to use

Returns:

a DockerImage representing the built image

runContainer

protected com.oracle.bedrock.runtime.ApplicationProcess runContainer(String containerName,
                                                                     RemoteTerminal.Launchable launchable,
                                                                     DockerImage image,
                                                                     Docker docker,
                                                                     com.oracle.bedrock.OptionsByType optionsByType)

Run a container using the specified image.

Parameters:

containerName - the name of the container

launchable - the RemoteTerminal.Launchable that will give the command to execute

image - the image to use to run the container

docker - the Docker environment to use

optionsByType - the OptionsByType to use

Returns:

a DockerContainer representing the running image