com.google.cloud.tools.jib.gradle

Class JibExtension

java.lang.Object

com.google.cloud.tools.jib.gradle.JibExtension

public class JibExtension
extends java.lang.Object

Plugin extension for JibPlugin.

Example configuration:

 jib {
   from {
     image = 'gcr.io/my-gcp-project/my-base-image'
     credHelper = 'gcr'
     platforms {
       platform {
         os = 'linux'
         architecture = 'amd64'
       }
     }
   }
   to {
     image = 'gcr.io/gcp-project/my-app:built-with-jib'
     credHelper = 'ecr-login'
   }
   container {
     jvmFlags = ['-Xms512m', '-Xdebug']
     mainClass = 'com.mycompany.myproject.Main'
     args = ['arg1', 'arg2']
     ports = ['1000', '2000-2010', '3000']
     format = OCI
     appRoot = '/app'
   }
   extraDirectories {
     paths = ['/path/to/extra/dir', 'can/be/relative/to/project/root']
     permissions = [
       '/path/on/container/file1': 744,
       '/path/on/container/file2': 123
     ]
   }
   outputPaths {
     tar = file('reative/to/project/root/jib-image.tar')
     digest = file('/absolute/path/jib-image.digest')
     imageId = file("$buildDir/jib-image.id")
   }
   allowInsecureRegistries = false
   containerizingMode = 'exploded'
   pluginExtensions {
     pluginExtension {
       implementation = 'com.example.ThirdPartyJibGradleExtension'
       properties = [customKey: 'value]
     }
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
JibExtension(org.gradle.api.Project project) Should be called using ExtensionContainer.create(java.lang.Class<T>, java.lang.String, java.lang.Class<? extends T>, java.lang.Object...).

Method Summary

Modifier and Type	Method and Description
void	container(org.gradle.api.Action<? super ContainerParameters> action)
void	dockerClient(org.gradle.api.Action<? super DockerClientParameters> action)
void	extraDirectories(org.gradle.api.Action<? super ExtraDirectoriesParameters> action)
void	from(org.gradle.api.Action<? super BaseImageParameters> action)
org.gradle.api.provider.Property<java.lang.String>	getConfigurationName() Returns the configurationName property while setting it to the value of the system property if present.
ContainerParameters	getContainer()
java.lang.String	getContainerizingMode()
DockerClientParameters	getDockerClient()
ExtraDirectoriesParameters	getExtraDirectories()
BaseImageParameters	getFrom()
OutputPathsParameters	getOutputPaths()
org.gradle.api.provider.ListProperty<ExtensionParameters>	getPluginExtensions()
SkaffoldParameters	getSkaffold()
TargetImageParameters	getTo()
void	outputPaths(org.gradle.api.Action<? super OutputPathsParameters> action)
void	pluginExtensions(org.gradle.api.Action<? super ExtensionParametersSpec> action)
void	setAllowInsecureRegistries(boolean allowInsecureRegistries)
void	setContainerizingMode(java.lang.String containerizingMode)
void	skaffold(org.gradle.api.Action<? super SkaffoldParameters> action)
void	to(org.gradle.api.Action<? super TargetImageParameters> action)

Methods inherited from class java.lang.Object

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

Constructor Detail

JibExtension

public JibExtension(org.gradle.api.Project project)

Should be called using ExtensionContainer.create(java.lang.Class<T>, java.lang.String, java.lang.Class<? extends T>, java.lang.Object...).

Parameters:

project - the injected gradle project

Method Detail

from

public void from(org.gradle.api.Action<? super BaseImageParameters> action)

to

public void to(org.gradle.api.Action<? super TargetImageParameters> action)

container

public void container(org.gradle.api.Action<? super ContainerParameters> action)

extraDirectories

public void extraDirectories(org.gradle.api.Action<? super ExtraDirectoriesParameters> action)

dockerClient

public void dockerClient(org.gradle.api.Action<? super DockerClientParameters> action)

outputPaths

public void outputPaths(org.gradle.api.Action<? super OutputPathsParameters> action)

skaffold

public void skaffold(org.gradle.api.Action<? super SkaffoldParameters> action)

pluginExtensions

public void pluginExtensions(org.gradle.api.Action<? super ExtensionParametersSpec> action)

setAllowInsecureRegistries

public void setAllowInsecureRegistries(boolean allowInsecureRegistries)

setContainerizingMode

public void setContainerizingMode(java.lang.String containerizingMode)

getFrom

@Optional
public BaseImageParameters getFrom()

getTo

@Optional
public TargetImageParameters getTo()

getContainer

@Optional
public ContainerParameters getContainer()

getExtraDirectories

@Optional
public ExtraDirectoriesParameters getExtraDirectories()

getDockerClient

@Optional
public DockerClientParameters getDockerClient()

getOutputPaths

@Optional
public OutputPathsParameters getOutputPaths()

getSkaffold

@Optional
public SkaffoldParameters getSkaffold()

getContainerizingMode

@Input
 @Optional
public java.lang.String getContainerizingMode()

getConfigurationName

@Input
 @Optional
public org.gradle.api.provider.Property<java.lang.String> getConfigurationName()

Returns the configurationName property while setting it to the value of the system property if present.

Returns:

The configurationName property

getPluginExtensions

@Optional
public org.gradle.api.provider.ListProperty<ExtensionParameters> getPluginExtensions()