Module com.oracle.bedrock.runtime.k8s

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

Class HelmCommand.Template

java.lang.Object

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

com.oracle.bedrock.runtime.k8s.helm.HelmCommand.Template

All Implemented Interfaces:

CLI<HelmCommand.Template>, MetaClass<Application>

Enclosing class:

HelmCommand<C extends HelmCommand>

public static class HelmCommand.Template
extends HelmCommand<HelmCommand.Template>

A generic Helm command.

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.bedrock.runtime.k8s.helm.HelmCommand

HelmCommand.Template

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 inherited from class com.oracle.bedrock.runtime.k8s.helm.HelmCommand

DEFAULT_HELM

Method Summary

Modifier and Type	Method	Description
HelmCreate	create(String name)	Create a new chart with the given name.
HelmDelete	delete(String name)	Given a release name, delete the release from Kubernetes.
HelmDependencyBuild	dependencyBuild(String chart)	Manage a chart's dependencies - rebuild the charts/ directory based on the requirements.lock file.
HelmDependencyList	dependencyList(String chart)	Manage a chart's dependencies - list the dependencies for the given chart.
HelmDependencyUpdate	dependencyUpdate(String chart)	Manage a chart's dependencies - update charts/ based on the contents of requirements.yaml.
HelmFetch	fetch(String... charts)	Download a chart from a repository and (optionally) unpack it in local directory.
HelmGet	get(String releaseName)	Download a named release.
HelmGetHooks	getHooks(String releaseName)	Download all hooks for a named release.
HelmGetManifest	getManifest(String releaseName)	Download the manifest for a named release.
HelmGetValues	getValues(String releaseName)	Download all values file for a named release.
HelmHistory	history(String releaseName)	Fetch release history.
HelmInit	init()	Initialize Helm on both client and server.
HelmInspect	inspect(File chart)	Create a Helm inspect command.
HelmInspect	inspect(String chart)	Create a Helm inspect command.
HelmInspect	inspect(URL chart)	Create a Helm inspect command.
HelmInstall	install(File chart)	Install a chart archive.
HelmInstall	install(File directory, String chart)	Install a chart archive.
HelmInstall	install(String chart)	Install a chart archive.
HelmLint	lint(File chart)	Examines a chart for possible issues.
HelmLint	lint(File directory, String chart)	Examines a chart for possible issues.
HelmLint	lint(String chart)	Examines a chart for possible issues.
HelmList	list()	List releases.
HelmList	list(String filter)	List releases with a filter.
HelmCommand.Template	newInstance(String helm, Arguments arguments, Arguments flags, EnvironmentVariables env)	Create a new instance of this Helm command.
HelmRollback	rollback(String release, String revision)	Roll back a release to a previous revision.
HelmStatus	status(String release)	Displays the status of the named release.
HelmTest	test(String release)	Test a release.
HelmUpgrade	upgrade(String release, File chart)	Upgrade a release.
HelmUpgrade	upgrade(String release, String chart)	Upgrade a release.

Methods inherited from class com.oracle.bedrock.runtime.k8s.helm.HelmCommand

execute, executeAndWait, getArguments, getCommands, getEnvironment, getFlags, getHelmLocation, getImplementationClass, helmExists, isFlagsFirst, onLaunch, onLaunched, onLaunching

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, tillerNamespace, withArguments, withArguments, withArguments, withEnvironment, withEnvironment, withEnvironment, withEnvironment, withFlags, withFlags, withFlags, withHelmAt

Method Detail

newInstance

public HelmCommand.Template newInstance(String helm,
                                        Arguments arguments,
                                        Arguments flags,
                                        EnvironmentVariables env)

Description copied from interface: CLI

Create a new instance of this Helm command.

arguments - the command arguments

flags - the command flags

env - the environment variables

Returns:

a new instance of this command

create

public HelmCreate create(String name)

Create a new chart with the given name.

Parameters:

name - the name of the chart to create

delete

public HelmDelete delete(String name)

Given a release name, delete the release from Kubernetes.

Parameters:

name - the release to delete

dependencyBuild

public HelmDependencyBuild dependencyBuild(String chart)

Manage a chart's dependencies - rebuild the charts/ directory based on the requirements.lock file.

Parameters:

chart - the chart name

dependencyList

public HelmDependencyList dependencyList(String chart)

Manage a chart's dependencies - list the dependencies for the given chart.

Parameters:

chart - the chart name

dependencyUpdate

public HelmDependencyUpdate dependencyUpdate(String chart)

Manage a chart's dependencies - update charts/ based on the contents of requirements.yaml.

Parameters:

chart - the chart name

fetch

public HelmFetch fetch(String... charts)

Download a chart from a repository and (optionally) unpack it in local directory.

Parameters:

charts - the charts to download

get

public HelmGet get(String releaseName)

Download a named release.

getHooks

public HelmGetHooks getHooks(String releaseName)

Download all hooks for a named release.

Parameters:

releaseName - the name of the release

getManifest

public HelmGetManifest getManifest(String releaseName)

Download the manifest for a named release.

Parameters:

releaseName - the name of the release

getValues

public HelmGetValues getValues(String releaseName)

Download all values file for a named release.

Parameters:

releaseName - the name of the release

history

public HelmHistory history(String releaseName)

Fetch release history.

Parameters:

releaseName - the name of the release

init

public HelmInit init()

Initialize Helm on both client and server.

inspect

public HelmInspect inspect(String chart)

Create a Helm inspect command.

Parameters:

chart - the chart to inspect

inspect

public HelmInspect inspect(File chart)

Create a Helm inspect command.

Parameters:

chart - the chart to inspect

inspect

public HelmInspect inspect(URL chart)

Create a Helm inspect command.

Parameters:

chart - the chart to inspect

install

public HelmInstall install(String chart)

Install a chart archive.

Parameters:

chart - the name of the chart

install

public HelmInstall install(File chart)

Install a chart archive.

Parameters:

chart - the name of the chart

install

public HelmInstall install(File directory,
                           String chart)

Install a chart archive.

Parameters:

directory - the directory containing the chart directory

chart - the name of the chart

lint

public HelmLint lint(String chart)

Examines a chart for possible issues.

Parameters:

chart - the name of the chart

lint

public HelmLint lint(File chart)

Examines a chart for possible issues.

Parameters:

chart - the name of the chart

lint

public HelmLint lint(File directory,
                     String chart)

Examines a chart for possible issues.

Parameters:

directory - the directory containing the chart directory

chart - the name of the chart

list

public HelmList list()

List releases.

list

public HelmList list(String filter)

List releases with a filter.

Parameters:

filter - the Helm list command's filter argument

rollback

public HelmRollback rollback(String release,
                             String revision)

Roll back a release to a previous revision.

Parameters:

release - the name of the release

revision - the revision to rollback to

status

public HelmStatus status(String release)

Displays the status of the named release.

Parameters:

release - the name of the release to test

test

public HelmTest test(String release)

Test a release.

Parameters:

release - the name of the release to test

upgrade

public HelmUpgrade upgrade(String release,
                           String chart)

Upgrade a release.

Parameters:

release - the name of the release to be upgraded

chart - the name of the chart to use to upgrade the release

upgrade

public HelmUpgrade upgrade(String release,
                           File chart)

Upgrade a release.

Parameters:

release - the name of the release to be upgraded

chart - the name of the chart to use to upgrade the release