org.eclipse.jkube.api

Interface JKubePlugin

public interface JKubePlugin

JKube plugins are used by other services to perform additional actions.

Currently, JKubePlugins are used in the following services:

• BuildService: addExtraFiles(File)

JKubePlugins are automatically loaded by JKube by declaring a dependency to a module that contains a descriptor file at META-INF/jkube/plugin with class names line by line, for example:

 com.example.project.MyJKubePlugin
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	JKUBE_EXTRA_DIRECTORY

Method Summary

Modifier and Type	Method and Description
default void	addExtraFiles(File targetDir) Method called by JKube's build services with a single File argument.

Field Detail

JKUBE_EXTRA_DIRECTORY

static final String JKUBE_EXTRA_DIRECTORY

See Also:

Constant Field Values

Method Detail

addExtraFiles

default void addExtraFiles(File targetDir)

Method called by JKube's build services with a single File argument.

The File argument points to a directory jkube-extra which can be easily referenced by a Dockerfile or an Assembly configuration.

JKube plugins should create their own subdirectories under the provided jkube-extra file location to avoid a clash with other JKube plugins.

Parameters:

targetDir - location of the jkube-extra directory where plugin can copy files to.