org.eclipse.jkube.kit.build.api.assembly

Class AssemblyManager

java.lang.Object

org.eclipse.jkube.kit.build.api.assembly.AssemblyManager

public class AssemblyManager
extends Object

Tool for creating a docker image tar ball including a Dockerfile for building a docker image.

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATA_BASE_IMAGE
static String	SCRATCH_IMAGE

Method Summary

Modifier and Type	Method and Description
Map<org.eclipse.jkube.kit.common.Assembly,List<org.eclipse.jkube.kit.common.AssemblyFileEntry>>	copyFilesToFinalTarballDirectory(org.eclipse.jkube.kit.common.JKubeConfiguration configuration, BuildDirs buildDirs, org.eclipse.jkube.kit.common.AssemblyConfiguration assemblyConfiguration)
File	createChangedFilesArchive(List<org.eclipse.jkube.kit.common.AssemblyFileEntry> entries, File assemblyDirectory, String imageName, org.eclipse.jkube.kit.common.JKubeConfiguration jKubeConfiguration)
File	createDockerTarArchive(String imageName, org.eclipse.jkube.kit.common.JKubeConfiguration configuration, BuildConfiguration buildConfig, org.eclipse.jkube.kit.common.KitLogger log, ArchiverCustomizer finalCustomizer) Create a docker tar archive from the given configuration which can be sent to the Docker host for creating the image.
static org.eclipse.jkube.kit.common.AssemblyConfiguration	getAssemblyConfiguration(BuildConfiguration buildConfiguration, org.eclipse.jkube.kit.common.JKubeConfiguration configuration) Returns the complete AssemblyConfiguration with required options for the provided BuildConfiguration and JKubeConfiguration.
AssemblyFiles	getAssemblyFiles(ImageConfiguration imageConfiguration, org.eclipse.jkube.kit.common.JKubeConfiguration jKubeConfiguration) Extract all files with a tracking archiver.
static AssemblyManager	getInstance()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_BASE_IMAGE

public static final String DEFAULT_DATA_BASE_IMAGE

See Also:

Constant Field Values

SCRATCH_IMAGE

public static final String SCRATCH_IMAGE

See Also:

Constant Field Values

Method Detail

getInstance

public static AssemblyManager getInstance()

createDockerTarArchive

public File createDockerTarArchive(String imageName,
                                   org.eclipse.jkube.kit.common.JKubeConfiguration configuration,
                                   BuildConfiguration buildConfig,
                                   org.eclipse.jkube.kit.common.KitLogger log,
                                   ArchiverCustomizer finalCustomizer)
                            throws IOException

Create a docker tar archive from the given configuration which can be sent to the Docker host for creating the image.

Parameters:

imageName - Name of the image to create (used for creating build directories)

configuration - Mojos parameters (used for finding the directories)

buildConfig - configuration for how to build the image

log - KitLogger used to display warning if permissions are to be normalized

finalCustomizer - finalCustomizer to be applied to the tar archive

Returns:

file holding the path to the created assembly tar file

Throws:

IOException - IO exception

getAssemblyConfiguration

@Nonnull
public static org.eclipse.jkube.kit.common.AssemblyConfiguration getAssemblyConfiguration(@Nonnull
                                                                                                   BuildConfiguration buildConfiguration,
                                                                                                   @Nonnull
                                                                                                   org.eclipse.jkube.kit.common.JKubeConfiguration configuration)
                                                                                            throws IOException

Returns the complete AssemblyConfiguration with required options for the provided BuildConfiguration and JKubeConfiguration.

Parameters:

buildConfiguration - BuildConfiguration from which to compute the AssemblyConfiguration

configuration - global JKubeConfiguration

Returns:

the computed AssemblyConfiguration

Throws:

IOException

getAssemblyFiles

public AssemblyFiles getAssemblyFiles(ImageConfiguration imageConfiguration,
                                      org.eclipse.jkube.kit.common.JKubeConfiguration jKubeConfiguration)
                               throws IOException

Extract all files with a tracking archiver. These can be used to track changes in the filesystem and triggering a rebuild of the image if needed ('docker:watch')

Parameters:

imageConfiguration - the image configuration

jKubeConfiguration - JKube kit configuration

Returns:

assembly files

Throws:

IOException

createChangedFilesArchive

public File createChangedFilesArchive(List<org.eclipse.jkube.kit.common.AssemblyFileEntry> entries,
                                      File assemblyDirectory,
                                      String imageName,
                                      org.eclipse.jkube.kit.common.JKubeConfiguration jKubeConfiguration)
                               throws IOException

Throws:

IOException

copyFilesToFinalTarballDirectory

public Map<org.eclipse.jkube.kit.common.Assembly,List<org.eclipse.jkube.kit.common.AssemblyFileEntry>> copyFilesToFinalTarballDirectory(org.eclipse.jkube.kit.common.JKubeConfiguration configuration,
                                                                                                                                        BuildDirs buildDirs,
                                                                                                                                        org.eclipse.jkube.kit.common.AssemblyConfiguration assemblyConfiguration)
                                                                                                                                 throws IOException

Throws:

IOException