Property Detail

• java.lang.String appDir

  Name of the directory to be created in the docker image to host the app. Typically this is set to be /applicationName-version.version but if you want a different dir structure, specify it here. Note that appDirLatest will be symlink'd to this location.

  See Also:

  appDirLatest

• java.lang.String appDirLatest

  Name of the "latest" dir. This will be symlink'd to the appDir directory in the docker image and typically is set to /applicationName-latest but if you want to change that name you can do so here.

  See Also:

  appDir

• java.lang.String dockerBase

  Docker base image.

• java.lang.String dockerFile

  Where in the project build structure is the Dockerfile. Typically this will be in ./build/docker/Dockerfile, but if you handcrafted your own Dockerfile, specify the path here.

• groovy.lang.Closure dockerImage

  Closure to execute when building the docker image. By default the code just creates the appDir directory and symlinks appDirLatest to it and sets the entry point to the shell script in appDirLatest/bin. If you need any other files or symlinks or commands to be executed, specify them here. If not set (or set to null) then no extra commands will be added to the Dockerfile.

• java.util.Map<java.lang.String, java.lang.String> dockerRepo

  Map of environment to docker repository. This allows for the docker image to be deployed in different environments / repos. For instance, if you have a different docker repo for 'test' and 'prod' you can define this as: project.nebulaDocker.dockerRepo = [test: 'http://url.for.test/path', prod: 'https://url.prod:port/path'] Note that the keys of this map are used to generate the getEnvironments() property.

  See Also:

  getEnvironments()

• boolean dockerRepoAuth

  This is a simple flag to indicate whether or not to add registryCredentials to the underlying docker extension for specifying user credentials (default is false)

• java.lang.String dockerRepoEmail

  The registry email address (default is null)

• java.lang.String dockerRepoPassword

  The registry password (default is null)

• java.lang.String dockerRepoUsername

  The registry username (default is null)

• java.lang.String dockerUrl

  Docker daemon url.

• java.lang.String maintainerEmail

  Email address of the maintainer of the docker image.

• groovy.lang.Closure<java.lang.String> tagVersion

  Closure used to set the tag on the docker image. Typically the code will set 2 tags: one with the application version and one with latest. This closure allows you to define the tagging for the application version. If not set, the application version will be set, as per above.

• boolean tagWithoutPush

  Do we only tag images (locally) or also push the tags to origin.

Method Detail

• java.util.Set<java.lang.String> getEnvironments()

  Defines a property which returns all the environments defined in the dockerRepo. This is basically a set of all the keys present in the dockerRepo set.

  Returns:

  Immutable set of all the environments present in dockerRepo or null if the dockerRepo is null/empty.

  See Also:

  dockerRepo

• @java.lang.Override java.lang.String toString()