helm

package
v2.1.126 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2020 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PROW_JOB_ID   = "PROW_JOB_ID"
	REPO_OWNER    = "REPO_OWNER"
	REPO_NAME     = "REPO_NAME"
	PULL_PULL_SHA = "PULL_PULL_SHA"
)

Variables

View Source
var (
	StepHelmApplyLong = templates.LongDesc(`
		Applies the helm chart in a given directory.

		This step is usually used to apply any GitOps promotion changes into a Staging or Production cluster.

        Environment Variables:
		- JX_NO_DELETE_TMP_DIR="true" - prevents the removal of the temporary directory.
`)

	StepHelmApplyExample = templates.Examples(`
		# apply the chart in the env folder to namespace jx-staging
		jx step helm apply --dir env --namespace jx-staging

`)
)
View Source
var (
	StepHelmBuildLong = templates.LongDesc(`
		Builds the helm chart in a given directory.

		This step is usually used to validate any GitOps Pull Requests.
`)

	StepHelmBuildExample = templates.Examples(`
		# builds the helm chart in the env directory
		jx step helm build --dir env

`)
)
View Source
var (
	StepHelmEnvLong = templates.LongDesc(`
		Generates the helm environment variables
`)

	StepHelmEnvExample = templates.Examples(`
		# output the helm environment variables that should be set to use helm directly
		jx step helm env

`)
)
View Source
var (
	StepHelmInstallLong = templates.LongDesc(`
		Installs the given chart
`)

	StepHelmInstallExample = templates.Examples(`
		# installs a helm chart
		jx step helm install foo/bar

`)
)
View Source
var (
	StepHelmListLong = templates.LongDesc(`
		List the helm releases
`)

	StepHelmListExample = templates.Examples(`
		# list all the helm releases in the current namespace
		jx step helm list

`)
)
View Source
var (
	StepHelmReleaseLong = templates.LongDesc(`
		This pipeline step releases the Helm chart in the current directory
`)

	StepHelmReleaseExample = templates.Examples(`
		jx step helm release

`)
)
View Source
var (
	StepHelmVersionLong = templates.LongDesc(`
		Updates version of the Helm Chart.yaml in the given directory 
`)

	StepHelmVersionExample = templates.Examples(`
		# updates the current Helm Chart.yaml to the latest build number version
		jx step helm version

`)
)

Functions

func DefaultEnvironments

func DefaultEnvironments(c *config.RequirementsConfig, devGitInfo *gits.GitRepository)

DefaultEnvironments ensures we have valid values for environment owner and repository names. if none are configured lets default them from smart defaults

func NewCmdStepHelm

func NewCmdStepHelm(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepHelm Steps a command object for the "step" command

func NewCmdStepHelmApply

func NewCmdStepHelmApply(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmBuild

func NewCmdStepHelmBuild(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmDelete

func NewCmdStepHelmDelete(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepHelmDelete creates the command object

func NewCmdStepHelmEnv

func NewCmdStepHelmEnv(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmInstall

func NewCmdStepHelmInstall(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmList

func NewCmdStepHelmList(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmRelease

func NewCmdStepHelmRelease(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepHelmVersion

func NewCmdStepHelmVersion(commonOpts *opts.CommonOptions) *cobra.Command

Types

type StepHelmApplyOptions

type StepHelmApplyOptions struct {
	StepHelmOptions

	Namespace          string
	ReleaseName        string
	Wait               bool
	Force              bool
	DisableHelmVersion bool
	Boot               bool
	Vault              bool
	NoVault            bool
	NoMasking          bool
	ProviderValuesDir  string
}

StepHelmApplyOptions contains the command line flags

func (*StepHelmApplyOptions) Run

func (o *StepHelmApplyOptions) Run() error

type StepHelmBuildOptions

type StepHelmBuildOptions struct {
	StepHelmOptions

	Boot              bool
	ProviderValuesDir string
	// contains filtered or unexported fields
}

StepHelmBuildOptions contains the command line flags

func (*StepHelmBuildOptions) Run

func (o *StepHelmBuildOptions) Run() error

type StepHelmDeleteOptions

type StepHelmDeleteOptions struct {
	StepHelmOptions

	Namespace string
	Purge     bool
}

StepHelmDeleteOptions contains the command line flags

func (*StepHelmDeleteOptions) Run

func (o *StepHelmDeleteOptions) Run() error

Run performs the CLI command

type StepHelmEnvOptions

type StepHelmEnvOptions struct {
	StepHelmOptions
}

StepHelmEnvOptions contains the command line flags

func (*StepHelmEnvOptions) Run

func (o *StepHelmEnvOptions) Run() error

type StepHelmInstallOptions

type StepHelmInstallOptions struct {
	StepHelmOptions

	Name         string
	Namespace    string
	Version      string
	Values       []string
	ValueStrings []string
	ValuesFiles  []string
}

StepHelmInstallOptions contains the command line flags

func (*StepHelmInstallOptions) Run

func (o *StepHelmInstallOptions) Run() error

type StepHelmListOptions

type StepHelmListOptions struct {
	StepHelmOptions

	Namespace string
}

StepHelmListOptions contains the command line flags

func (*StepHelmListOptions) Run

func (o *StepHelmListOptions) Run() error

type StepHelmOptions

type StepHelmOptions struct {
	step.StepOptions

	Dir string

	GitProvider string
	// contains filtered or unexported fields
}

StepHelmOptions contains the command line flags

func (*StepHelmOptions) Run

func (o *StepHelmOptions) Run() error

Run implements this command

type StepHelmReleaseOptions

type StepHelmReleaseOptions struct {
	StepHelmOptions
}

StepHelmReleaseOptions contains the command line flags

func (*StepHelmReleaseOptions) Run

func (o *StepHelmReleaseOptions) Run() error

type StepHelmVersionOptions

type StepHelmVersionOptions struct {
	StepHelmOptions

	Version string
}

StepHelmVersionOptions contains the command line flags

func (*StepHelmVersionOptions) Run

func (o *StepHelmVersionOptions) Run() error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL