public class JibExtension
extends java.lang.Object
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 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...). |
| 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) |
public JibExtension(org.gradle.api.Project project)
ExtensionContainer.create(java.lang.Class<T>, java.lang.String, java.lang.Class<? extends T>, java.lang.Object...).project - the injected gradle projectpublic void from(org.gradle.api.Action<? super BaseImageParameters> action)
public void to(org.gradle.api.Action<? super TargetImageParameters> action)
public void container(org.gradle.api.Action<? super ContainerParameters> action)
public void extraDirectories(org.gradle.api.Action<? super ExtraDirectoriesParameters> action)
public void dockerClient(org.gradle.api.Action<? super DockerClientParameters> action)
public void outputPaths(org.gradle.api.Action<? super OutputPathsParameters> action)
public void skaffold(org.gradle.api.Action<? super SkaffoldParameters> action)
public void pluginExtensions(org.gradle.api.Action<? super ExtensionParametersSpec> action)
public void setAllowInsecureRegistries(boolean allowInsecureRegistries)
public void setContainerizingMode(java.lang.String containerizingMode)
@Optional public BaseImageParameters getFrom()
@Optional public TargetImageParameters getTo()
@Optional public ContainerParameters getContainer()
@Optional public ExtraDirectoriesParameters getExtraDirectories()
@Optional public DockerClientParameters getDockerClient()
@Optional public OutputPathsParameters getOutputPaths()
@Optional public SkaffoldParameters getSkaffold()
@Input @Optional public java.lang.String getContainerizingMode()
@Input @Optional public org.gradle.api.provider.Property<java.lang.String> getConfigurationName()
@Optional public org.gradle.api.provider.ListProperty<ExtensionParameters> getPluginExtensions()