Module com.oracle.bedrock.runtime.k8s

Package com.oracle.bedrock.runtime.k8s.helm

Class HelmCommand<C extends HelmCommand>

java.lang.Object

com.oracle.bedrock.runtime.k8s.helm.HelmCommand<C>

Type Parameters:

C - the type of the command

All Implemented Interfaces:

CLI<C>, MetaClass<Application>

Direct Known Subclasses:

HelmCommand.Template, HelmCreate, HelmDelete, HelmDependencyBuild, HelmDependencyList, HelmDependencyUpdate, HelmFetch, HelmGet, HelmGetHooks, HelmGetManifest, HelmGetValues, HelmHistory, HelmInit, HelmInspect, HelmInstall, HelmLint, HelmList, HelmRollback, HelmStatus, HelmTest, HelmUpgrade

public abstract class HelmCommand<C extends HelmCommand>
extends Object
implements CLI<C>

An immutable representation of a Helm command that can be executed by a Bedrock Platform.

Copyright (c) 2018. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HelmCommand.Template	A generic Helm command.

Nested classes/interfaces inherited from interface com.oracle.bedrock.runtime.k8s.helm.CLI

CLI.WithCerts<C extends CLI.WithCerts>, CLI.WithRepo<C extends CLI.WithRepo>, CLI.WithTLS<C extends CLI.WithTLS>

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_HELM	The default location of the Helm executable.

Method Summary

Modifier and Type	Method	Description
Application	execute(com.oracle.bedrock.Option... options)	Execute this Helm command on the LocalPlatform.
int	executeAndWait(com.oracle.bedrock.Option... options)	Execute this Helm command on the LocalPlatform and wait for the command to complete.
Arguments	getArguments()	Obtain the arguments to this command.
String[]	getCommands()	Obtain the Helm command that will be executed.
EnvironmentVariables	getEnvironment()	Obtain the environment variables for this command.
Arguments	getFlags()	Obtain the flags to this command.
String	getHelmLocation()	Obtain the Helm executable to run.
Class<? extends Application>	getImplementationClass(Platform platform, com.oracle.bedrock.OptionsByType options)
boolean	helmExists()	Determine whether the Helm executable that this command would use exists.
boolean	isFlagsFirst()	Determine whether the flags appear at the start or end of the command line.
void	onLaunch(Platform platform, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunched(Platform platform, Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunching(Platform platform, com.oracle.bedrock.OptionsByType optionsByType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bedrock.runtime.k8s.helm.CLI

debug, home, host, kubeConfig, kubeContext, newInstance, tillerNamespace, withArguments, withArguments, withArguments, withEnvironment, withEnvironment, withEnvironment, withEnvironment, withFlags, withFlags, withFlags, withHelmAt

Field Detail

DEFAULT_HELM

public static final String DEFAULT_HELM

The default location of the Helm executable.

Method Detail

getHelmLocation

public String getHelmLocation()

Obtain the Helm executable to run.

Specified by:

getHelmLocation in interface CLI<C extends HelmCommand>

Returns:

the Helm executable to run

helmExists

public boolean helmExists()

Determine whether the Helm executable that this command would use exists.

Returns:

true if the Helm executable exists

getCommands

public String[] getCommands()

Obtain the Helm command that will be executed.

Specified by:

getCommands in interface CLI<C extends HelmCommand>

Returns:

the Helm command that will be executed

getArguments

public Arguments getArguments()

Obtain the arguments to this command.

Specified by:

getArguments in interface CLI<C extends HelmCommand>

Returns:

the arguments to this command

getEnvironment

public EnvironmentVariables getEnvironment()

Obtain the environment variables for this command.

Specified by:

getEnvironment in interface CLI<C extends HelmCommand>

Returns:

the environment variables for this command

getFlags

public Arguments getFlags()

Obtain the flags to this command.

Specified by:

getFlags in interface CLI<C extends HelmCommand>

Returns:

the flags to this command

isFlagsFirst

public boolean isFlagsFirst()

Determine whether the flags appear at the start or end of the command line.

Specified by:

isFlagsFirst in interface CLI<C extends HelmCommand>

Returns:

true if the flags appear at the start or end of the command line

execute

public Application execute(com.oracle.bedrock.Option... options)

Execute this Helm command on the LocalPlatform.

Parameters:

options - any options to apply to the process

Returns:

the Application representing the Helm command execution

executeAndWait

public int executeAndWait(com.oracle.bedrock.Option... options)

Execute this Helm command on the LocalPlatform and wait for the command to complete.

Parameters:

options - any options to apply to the process

Returns:

the return code from the completed command.

getImplementationClass

public Class<? extends Application> getImplementationClass(Platform platform,
                                                           com.oracle.bedrock.OptionsByType options)

Specified by:

getImplementationClass in interface MetaClass<C extends HelmCommand>

onLaunching

public void onLaunching(Platform platform,
                        com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunching in interface MetaClass<C extends HelmCommand>

onLaunch

public void onLaunch(Platform platform,
                     com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunch in interface MetaClass<C extends HelmCommand>

onLaunched

public void onLaunched(Platform platform,
                       Application application,
                       com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunched in interface MetaClass<C extends HelmCommand>