cli

Documentation

Index

• func MakeLocator(app string) (*loc.Locator, error)
• func NewProgress(ctx context.Context, title string, silent bool) utils.Progress
• func Run(tele Application) error
• type Application
  • func RegisterCommands(app *kingpin.Application) Application
• type BuildCmd
• type BuildParameters
  • func (p BuildParameters) BuilderConfig() builder.Config
  • func (p BuildParameters) Level() utils.ProgressLevel
• type HelmBuildCmd
• type HelmCmd
• type ListCmd
• type PullCmd
• type VersionCmd

Functions

func MakeLocator

func MakeLocator(app string) (*loc.Locator, error)

MakeLocator creates locator from the provided application package name.

func NewProgress

func NewProgress(ctx context.Context, title string, silent bool) utils.Progress

NewProgress returns progress reporter used in tele cli.

func Run

func Run(tele Application) error

Run parses CLI arguments and executes an appropriate tele command

Types

type Application

type Application struct {
	*kingpin.Application
	// Debug allows to run the command in debug mode
	Debug *bool
	// Insecure turns off TLS hostname validation
	Insecure *bool
	// StateDir is the local state directory
	StateDir *string
	// VersionCmd outputs the binary version
	VersionCmd VersionCmd
	// BuildCmd builds a cluster image.
	BuildCmd BuildCmd
	// HelmCmd combines commands operating on helm charts.
	HelmCmd HelmCmd
	// HelmBuildCmd builds an application image out of a helm chart.
	HelmBuildCmd HelmBuildCmd
	// ListCmd lists available apps and runtimes
	ListCmd ListCmd
	// PullCmd downloads app installer from Ops Center
	PullCmd PullCmd
}

Application represents the command-line "tele" application and contains definitions of all its flags, arguments and subcommands

func RegisterCommands

func RegisterCommands(app *kingpin.Application) Application

RegisterCommands registers all tele tool flags, arguments and subcommands

type BuildCmd

type BuildCmd struct {
	*kingpin.CmdClause
	// Path is the path to manifest file or Helm chart
	Path *string
	// OutFile is the output tarball file
	OutFile *string
	// Overwrite overwrites existing tarball
	Overwrite *bool
	// ImageCacheDir is the docker image cache directory to speed up subsequent builds
	ImageCacheDir *string
	// Name allows to override app name
	Name *string
	// Version allows to override app version
	Version *string
	// VendorPatters is file pattern to search for images
	VendorPatterns *[]string
	// VendorIgnorePatterns if file pattern to ignore when searching for images
	VendorIgnorePatterns *[]string
	// SetImages rewrites images to specified versions
	SetImages *loc.DockerImages
	// SetDeps rewrites app dependencies to specified versions
	SetDeps *loc.Locators
	// SkipVersionCheck suppresses version mismatch check
	SkipVersionCheck *bool
	// Parallel defines the number of tasks to execute concurrently
	Parallel *int
	// Quiet allows to suppress console output
	Quiet *bool
	// Verbose enables more detailed build output.
	Verbose *bool
	// Set is a list of Helm chart values set on the CLI.
	Set *[]string
	// Values is a list of YAML files with Helm chart values.
	Values *[]string
	// Pull allows to force-pull Docker images even if they're already present.
	Pull *bool
	// BaseImage allows to specify base image on the CLI.
	BaseImage *string
}

BuildCmd builds app installer tarball

type BuildParameters

type BuildParameters struct {
	// StateDir is build state directory, if was specified
	StateDir string
	// SourcePath is the path to a manifest file or a Helm chart to build image from
	SourcePath string
	// OutPath holds the path to the installer tarball to be output
	OutPath string
	// Overwrite indicates whether or not to overwrite an existing installer file
	Overwrite bool
	// SkipVersionCheck indicates whether or not to perform the version check of the tele binary with the application's runtime at build time
	SkipVersionCheck bool
	// Silent is whether builder should report progress to the console
	Silent bool
	// Verbose turns on more detailed progress output
	Verbose bool
	// Insecure turns on insecure verify mode
	Insecure bool
	// Vendor combines vendoring parameters
	Vendor service.VendorRequest
	// BaseImage sets base image for the cluster image
	BaseImage string
}

BuildParameters represents the arguments provided for building an application

func (BuildParameters) BuilderConfig

func (p BuildParameters) BuilderConfig() builder.Config

BuilderConfig makes builder config from CLI parameters.

func (BuildParameters) Level

func (p BuildParameters) Level() utils.ProgressLevel

Level returns level at which the progress should be reported based on the CLI parameters.

type HelmBuildCmd

type HelmBuildCmd struct {
	*kingpin.CmdClause
	// Path is the path to a helm chart.
	Path *string
	// OutFile is the output tarball file
	OutFile *string
	// Overwrite overwrites existing tarball
	Overwrite *bool
	// VendorPatters is file pattern to search for images
	VendorPatterns *[]string
	// VendorIgnorePatterns if file pattern to ignore when searching for images
	VendorIgnorePatterns *[]string
	// SetImages rewrites images to specified versions
	SetImages *loc.DockerImages
	// Parallel defines the number of tasks to execute concurrently
	Parallel *int
	// Quiet allows to suppress console output
	Quiet *bool
	// Verbose enables more detailed build output.
	Verbose *bool
	// Set is a list of Helm chart values set on the CLI.
	Set *[]string
	// Values is a list of YAML files with Helm chart values.
	Values *[]string
	// Pull allows to force-pull Docker images even if they're already present.
	Pull *bool
}

HelmBuildCmd builds an application image out of a helm chart.

type HelmCmd

type HelmCmd struct {
	*kingpin.CmdClause
}

HelmCmd combines commands operating on helm charts.

type ListCmd

type ListCmd struct {
	*kingpin.CmdClause
	// Runtimes shows available runtimes
	Runtimes *bool
	// Format is the output format
	Format *constants.Format
	// All displays all available versions
	All *bool
}

type PullCmd

type PullCmd struct {
	*kingpin.CmdClause
	// App is app name
	App *string
	// OutFile is installer tarball file name
	OutFile *string
	// Force overwrites existing tarball
	Force *bool
	// Quiet allows to suppress console output
	Quiet *bool
}

PullCmd downloads app installer from Ops Center

type VersionCmd

type VersionCmd struct {
	*kingpin.CmdClause
	// Output is output format
	Output *constants.Format
}

VersionCmd outputs the binary version