Package com.google.cloud.tools.jib.gradle

Class 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 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

      • container

        public void container​(org.gradle.api.Action<? super ContainerParameters> 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)

      • 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()