Field Detail

• public static final java.lang.String DEFAULT_DOCKERFILE

  Constant of default Dockerfile file path and name

  Default:

  "Dockerfile"

• public static final java.lang.String DEFAULT_IMAGE_TAG

  Default Docker image tag.

  Default:

  "latest"

Property Detail

• java.lang.String _image

  Temporary image name

• java.lang.String _url

  Docker registry without https:// or http://

  Default:

  ''

• java.lang.String buildArgs

  Extra build args supplied through pipeline

• java.lang.String dockerFile

  File path and name of Dockerfile.

  Default:

  DEFAULT_DOCKERFILE

• java.lang.String image

  Docker image name

• java.lang.Object steps

  Reference to the groovy pipeline variable.

• java.lang.String[] tags

  Docker image tags, can be multiple

  Default:

  DEFAULT_IMAGE_TAG

• java.lang.String url

  Docker registry url

  Default:

  ''

• java.lang.String usernamePasswordCredential

  Jenkins credential ID for Docker registry username/password(token)

• java.lang.String version

  Image version extracted from Dockerfile

Constructor Detail

• Registry(java.lang.Object steps)

  Constructs the class.

  When invoking from a Jenkins pipeline script, the Pipeline must be passed the current environment of the Jenkinsfile to have access to the steps.

  Example:

   def dockerRegistry = new Registry(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

• java.lang.String build(java.util.Map args = [:])

  Build docker image.

  Example:

       // build docker image from ./my-sub-folder/Dockerfile
       // it returns image ID (hash)
       def imageId = dockerRegistry.build(
           dockerFile   : './my-sub-folder/Dockerfile'
       )
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

• java.lang.String build(java.lang.String dockerFile)

  Build docker image.

  See Also:

  build(Map)

• void clean()

  Remove last build image

• java.lang.String getFullImageName(java.lang.String tag)

  Return full image name

  Parameters:

  tag - docker image tag name

• java.lang.String getImageId()

  Return the image ID from last build

• void init(java.util.Map args = [:])

  Initialize Docker registry properties.

  Note:

  The below parameters are supported keys of the args Map.

  Parameters:

  url - the registry URL

  usernamePasswordCredential - Jenkins credential ID for Docker registry username/password(token). Optional.

  dockerFile - Dockerfile file path and name. Optional, default is DEFAULT_DOCKERFILE.

  image - docker image name

  tag - docker image tag

  tags - docker image tags, can be multiple

• void publish(java.util.Map args = [:])

  Publish the image to registry.

  Example:

       // publish last build image to registry
       // the image will also be tagged as latest, v1.x and v1.2.3
       dockerRegistry.publish(
           image                      : 'my-user/my-image',
           tags                       : ['latest', 'v1.x', 'v1.2.3'],
       )
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

• void publish(java.lang.String image, java.lang.String tags = '')

  Publish the image to registry.

  See Also:

  publish(Map)

• void publish(java.lang.String image, java.lang.String[] tags)

  Publish the image to registry.

  See Also:

  publish(Map)

• java.lang.String tag(java.lang.String tag)

  Tag the build image

  Parameters:

  tag - tag name

• void version(java.util.Map args = [:])

  Declare a new version of Docker image.

  Note:

  This task will bump the docker image version defined in Dockerfile, commit the change, and push to GitHub. The commit is signed-off.

  Example:

       def github = new org.zowe.jenkins_shared_library.scm.GitHub(this)
       // bump patch version on master branch
       dockerRegistry.version(
           github  :     github,
           branch  :     'master',
           version :     'patch'
       )
       // After this, you should be able to see your repository master branch has a commit of
       // version bump.
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  See Also:

  GitHub

  Parameters:

  github - GitHub instance must have been initialized with repository, credential, etc

  branch - which branch to release

  version - what kind of version bump we should make

• void version(org.zowe.jenkins_shared_library.scm.GitHub github, java.lang.String branch, java.lang.String version = 'PATCH')

  Declare a new version of docker image.

  See Also:

  version(Map)

• void within(java.util.Map args, groovy.lang.Closure body)

  Execute scripts within proper docker registry authentication

  Note:

  Use similar parameters defined in init(Map) method:

  Parameters:

  body - a CLosure scripts to run within the registrry

• void within(groovy.lang.Closure body)

  Execute scripts within proper docker registry

  See Also:

  within(Map, Closure)