Module com.oracle.bedrock.runtime.k8s

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

Interface CLI<C extends CLI>

All Superinterfaces:

MetaClass<Application>

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface CLI<C extends CLI>
extends MetaClass<Application>

A Helm CLI command.

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	Interface	Description
static interface	CLI.WithCerts<C extends CLI.WithCerts>	A CLI command with certificate flags.
static interface	CLI.WithRepo<C extends CLI.WithRepo>	A CLI command with repo flags.
static interface	CLI.WithTLS<C extends CLI.WithTLS>	A CLI command with TLS flags.

Method Summary

Modifier and Type	Method	Description
default C	debug()	Obtain a copy of this Helm command with debug enabled.
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 location of the Helm executable.
default C	home(String helmHome)	Obtain a copy of this Helm command with the specified Helm home, overrides $HELM_HOME (default $HOME/.helm).
default C	host(String tillerHost)	Obtain a copy of this Helm command with the specified Tiller address.
boolean	isFlagsFirst()	Determine whether the flags appear at the start or end of the command line.
default C	kubeConfig(String config)	Obtain a copy of this Helm command with the alternative kubeconfig to use.
default C	kubeContext(String contextName)	Obtain a copy of this Helm command with the kubeconfig context to use.
C	newInstance(String helm, Arguments arguments, Arguments flags, EnvironmentVariables env)	Create a new instance of this Helm command.
default C	tillerNamespace(String namespace)	Obtain a copy of this Helm command with the specified Tiller namespace
default C	withArguments(Argument... args)	Obtain a copy of this command with the addition of the specified arguments.
default C	withArguments(Arguments args)	Obtain a copy of this command with the addition of the specified arguments.
default C	withArguments(Object... args)	Obtain a copy of this command with the addition of the specified arguments.
default C	withEnvironment(EnvironmentVariable... env)	Obtain a copy of this command with the addition of the specified environment variables.
default C	withEnvironment(EnvironmentVariables env)	Obtain a copy of this command with the addition of the specified environment variables.
default C	withEnvironment(String envVariable)	Obtain a copy of this command with the addition of the specified environment variables.
default C	withEnvironment(String name, Object value)	Obtain a copy of this command with the addition of the specified environment variables.
default C	withFlags(Argument... flags)	Obtain a copy of this command with the addition of the specified flags.
default C	withFlags(Arguments flags)	Obtain a copy of this command with the addition of the specified flags.
default C	withFlags(Object... flags)	Obtain a copy of this command with the addition of the specified flags.
default C	withHelmAt(String helm)	Obtain a copy of this command with the addition of the specified Helm executable location.

Methods inherited from interface com.oracle.bedrock.runtime.MetaClass

getImplementationClass, onLaunch, onLaunched, onLaunching

Method Detail

getCommands

String[] getCommands()

Obtain the Helm command that will be executed.

Returns:

the Helm command that will be executed

getArguments

Arguments getArguments()

Obtain the arguments to this command.

Returns:

the arguments to this command

getEnvironment

EnvironmentVariables getEnvironment()

Obtain the environment variables for this command.

Returns:

the environment variables for this command

getFlags

Arguments getFlags()

Obtain the flags to this command.

Returns:

the flags to this command

isFlagsFirst

boolean isFlagsFirst()

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

Returns:

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

debug

default C debug()

Obtain a copy of this Helm command with debug enabled.

Returns:

a copy of this Helm command with debug enabled

home

default C home(String helmHome)

Obtain a copy of this Helm command with the specified Helm home, overrides $HELM_HOME (default $HOME/.helm).

Parameters:

helmHome - the location of Helm home

Returns:

a copy of this Helm command with the specified helm home

host

default C host(String tillerHost)

Obtain a copy of this Helm command with the specified Tiller address.

Parameters:

tillerHost - the Tiller host

Returns:

a copy of this Helm command with the specified Tiller host

kubeContext

default C kubeContext(String contextName)

Obtain a copy of this Helm command with the kubeconfig context to use.

Parameters:

contextName - the kubeconfig context to use

Returns:

a copy of this Helm command with the kubeconfig context to use

kubeConfig

default C kubeConfig(String config)

Obtain a copy of this Helm command with the alternative kubeconfig to use.

Parameters:

config - the kubeconfig to use

Returns:

a copy of this Helm command with the alternative kubeconfig to use

tillerNamespace

default C tillerNamespace(String namespace)

Obtain a copy of this Helm command with the specified Tiller namespace

Parameters:

namespace - the Tiller namespace

Returns:

a copy of this Helm command with the specified Tiller namespace

newInstance

C newInstance(String helm,
              Arguments arguments,
              Arguments flags,
              EnvironmentVariables env)

Create a new instance of this Helm command.

Parameters:

helm -

arguments - the command arguments

flags - the command flags

env - the environment variables

Returns:

a new instance of this command

withHelmAt

default C withHelmAt(String helm)

Obtain a copy of this command with the addition of the specified Helm executable location.

Parameters:

helm - the location of the Helm executable

Returns:

a copy of this command with the addition of specified Helm executable location.

getHelmLocation

String getHelmLocation()

Obtain the location of the Helm executable.

Returns:

the location of the Helm executable

withArguments

default C withArguments(Object... args)

Obtain a copy of this command with the addition of the specified arguments.

Parameters:

args - the arguments to add

Returns:

a copy of this command with the addition of the specified arguments

withArguments

default C withArguments(Argument... args)

Obtain a copy of this command with the addition of the specified arguments.

Parameters:

args - the arguments to add

Returns:

a copy of this command with the addition of the specified arguments

withArguments

default C withArguments(Arguments args)

Obtain a copy of this command with the addition of the specified arguments.

Parameters:

args - the arguments to add

Returns:

a copy of this command with the addition of the specified arguments

withFlags

default C withFlags(Object... flags)

Obtain a copy of this command with the addition of the specified flags.

Parameters:

flags - the flags to add

Returns:

a copy of this command with the addition of the specified flags

withFlags

default C withFlags(Argument... flags)

Obtain a copy of this command with the addition of the specified flags.

Parameters:

flags - the flags to add

Returns:

a copy of this command with the addition of the specified flags

withFlags

default C withFlags(Arguments flags)

Obtain a copy of this command with the addition of the specified flags.

Parameters:

flags - the flags to add

Returns:

a copy of this command with the addition of the specified flags

withEnvironment

default C withEnvironment(String envVariable)

Obtain a copy of this command with the addition of the specified environment variables.

Parameters:

envVariable - the environment variable to add

Returns:

a copy of this command with the addition of the specified environment variables

withEnvironment

default C withEnvironment(String name,
                          Object value)

Obtain a copy of this command with the addition of the specified environment variables.

Parameters:

name - the environment variable name

value - the environment variable value

Returns:

a copy of this command with the addition of the specified environment variables

withEnvironment

default C withEnvironment(EnvironmentVariable... env)

Obtain a copy of this command with the addition of the specified environment variables.

Parameters:

env - the environment variables to add

Returns:

a copy of this command with the addition of the specified environment variables

withEnvironment

default C withEnvironment(EnvironmentVariables env)

Obtain a copy of this command with the addition of the specified environment variables.

Parameters:

env - the environment variables to add

Returns:

a copy of this command with the addition of the specified environment variables