cli

package
v1.0.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2021 License: Apache-2.0 Imports: 83 Imported by: 4

Documentation

Index

Constants

View Source 
const (
	App       = "app"
	Service   = "svc"
	Namespace = "namespace"
)

constants used in `svc` command

View Source 
const (
	// SideBar file name for docsify
	SideBar = "_sidebar.md"
	// NavBar file name for docsify
	NavBar = "_navbar.md"
	// IndexHTML file name for docsify
	IndexHTML = "index.html"
	// CSS file name for custom CSS
	CSS = "custom.css"
	// README file name for docsify
	README = "README.md"
)
View Source 
const (
	// HealthStatusHealthy represents healthy status.
	HealthStatusHealthy = v1alpha2.StatusHealthy
	// HealthStatusUnhealthy represents unhealthy status.
	HealthStatusUnhealthy = v1alpha2.StatusUnhealthy
	// HealthStatusUnknown represents unknown status.
	HealthStatusUnknown = v1alpha2.StatusUnknown
)
View Source 
const (
	ErrNotLoadAppConfig  = "cannot load the application"
	ErrFmtNotInitialized = "service: %s not ready"
	ErrServiceNotFound   = "service %s not found in app"
)

Error msg used in `status` command

View Source 
const (
	// Port is the port for reference docs website
	Port = ":18081"
)

Variables

This section is empty.

Functions

func AddTokenVarFlags 

func AddTokenVarFlags(cmd *cobra.Command)

AddTokenVarFlags adds token flag to a command

func CapabilityCommandGroup 

func CapabilityCommandGroup(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command

CapabilityCommandGroup commands for capability center

func CheckCapabilityReady 

func CheckCapabilityReady(ctx context.Context, c types.Args, timeout time.Duration) error

CheckCapabilityReady waits unitl capability is installed successfully

func CheckVelaRuntimeInstalledAndReady 

func CheckVelaRuntimeInstalledAndReady(ioStreams cmdutil.IOStreams, c client.Client) (bool, error)

CheckVelaRuntimeInstalledAndReady checks whether vela-core runtime is installed and ready

func CreateOrUpdateEnv 

func CreateOrUpdateEnv(ctx context.Context, c client.Client, envArgs *types.EnvMeta, args []string, ioStreams cmdutil.IOStreams) error

CreateOrUpdateEnv creates or updates an environment

func DeleteEnv 

func DeleteEnv(ctx context.Context, args []string, ioStreams cmdutil.IOStreams) error

DeleteEnv deletes an environment

func GetCapabilityByName 

func GetCapabilityByName(name string, workloads []types.Capability) (types.Capability, error)

GetCapabilityByName get eponymous types.Capability from workloads by name

func GetEnv 

func GetEnv(cmd *cobra.Command) (*types.EnvMeta, error)

GetEnv gets environment by name or current environment if no env exists, then init default environment

func GetOAMReleaseVersion 

func GetOAMReleaseVersion(ns string) (string, error)

GetOAMReleaseVersion gets version of vela-core runtime helm release

func InstallOamRuntime 

func InstallOamRuntime(chartPath, chartSource string, vals map[string]interface{}, ioStreams cmdutil.IOStreams) error

InstallOamRuntime installs vela-core runtime from helm chart

func ListConfigs 

func ListConfigs(ioStreams cmdutil.IOStreams, cmd *cobra.Command) error

ListConfigs will list all configs

func ListEnvs 

func ListEnvs(args []string, ioStreams cmdutil.IOStreams) error

ListEnvs shows info of all environments

func NewAdminInfoCommand 

func NewAdminInfoCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewAdminInfoCommand creates `system info` command

func NewAppStatusCommand 

func NewAppStatusCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewAppStatusCommand creates `status` command for showing status

func NewCapCenterConfigCommand 

func NewCapCenterConfigCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewCapCenterConfigCommand Configure (add if not exist) a capability center, default is local (built-in capabilities)

func NewCapCenterListCommand 

func NewCapCenterListCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewCapCenterListCommand List all capability centers

func NewCapCenterRemoveCommand 

func NewCapCenterRemoveCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewCapCenterRemoveCommand Remove specified capability center

func NewCapCenterSyncCommand 

func NewCapCenterSyncCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewCapCenterSyncCommand Sync capabilities from remote center, default to sync all centers

func NewCapInstallCommand 

func NewCapInstallCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewCapInstallCommand Install capability into cluster

func NewCapListCommand 

func NewCapListCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewCapListCommand List capabilities from cap-center

func NewCapUninstallCommand 

func NewCapUninstallCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewCapUninstallCommand Uninstall capability from cluster

func NewCapabilityShowCommand 

func NewCapabilityShowCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewCapabilityShowCommand shows the reference doc for a workload type or trait

func NewCenterCommand 

func NewCenterCommand(ioStream cmdutil.IOStreams) *cobra.Command

NewCenterCommand Manage Capability Center

func NewCommand 

func NewCommand() *cobra.Command

NewCommand will contain all commands

func NewCompletionCommand 

func NewCompletionCommand() *cobra.Command

NewCompletionCommand Output shell completion code for the specified shell (bash or zsh)

func NewConfigCommand 

func NewConfigCommand(io cmdutil.IOStreams) *cobra.Command

NewConfigCommand will create command for config management for AppFile

func NewConfigDeleteCommand 

func NewConfigDeleteCommand(io cmdutil.IOStreams) *cobra.Command

NewConfigDeleteCommand delete a config from local

func NewConfigGetCommand 

func NewConfigGetCommand(io cmdutil.IOStreams) *cobra.Command

NewConfigGetCommand get config from local

func NewConfigListCommand 

func NewConfigListCommand(io cmdutil.IOStreams) *cobra.Command

NewConfigListCommand list all created configs

func NewConfigSetCommand 

func NewConfigSetCommand(io cmdutil.IOStreams) *cobra.Command

NewConfigSetCommand set a config data in local

func NewDashboardCommand 

func NewDashboardCommand(c types.Args, ioStreams cmdutil.IOStreams, frontendSource string) *cobra.Command

NewDashboardCommand creates `dashboard` command and its nested children commands

func NewDeleteCommand 

func NewDeleteCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewDeleteCommand Delete App

func NewDryRunCommand 

func NewDryRunCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewDryRunCommand creates `dry-run` command

func NewEnvCommand 

func NewEnvCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command

NewEnvCommand creates `env` command and its nested children

func NewEnvDeleteCommand 

func NewEnvDeleteCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewEnvDeleteCommand creates `env delete` command for deleting environments

func NewEnvInitCommand 

func NewEnvInitCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewEnvInitCommand creates `env init` command for initializing environments

func NewEnvListCommand 

func NewEnvListCommand(ioStream cmdutil.IOStreams) *cobra.Command

NewEnvListCommand creates `env list` command for listing all environments

func NewEnvSetCommand 

func NewEnvSetCommand(ioStreams cmdutil.IOStreams) *cobra.Command

NewEnvSetCommand creates `env set` command for setting current environment

func NewExecCommand 

func NewExecCommand(c types.Args, ioStreams util.IOStreams) *cobra.Command

NewExecCommand creates `exec` command

func NewExportCommand 

func NewExportCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command

NewExportCommand will create command for exporting deploy manifests from an AppFile

func NewHelpCommand 

func NewHelpCommand() *cobra.Command

NewHelpCommand get any command help

func NewInitCommand 

func NewInitCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewInitCommand creates `init` command

func NewInstallCommand 

func NewInstallCommand(c types.Args, chartContent string, ioStreams cmdutil.IOStreams) *cobra.Command

NewInstallCommand creates `install` command

func NewListCommand 

func NewListCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewListCommand creates `ls` command and its nested children command

func NewLogsCommand 

func NewLogsCommand(c types.Args, ioStreams util.IOStreams) *cobra.Command

NewLogsCommand creates `logs` command to tail logs of application

func NewPortForwardCommand 

func NewPortForwardCommand(c types.Args, ioStreams util.IOStreams) *cobra.Command

NewPortForwardCommand is vela port-forward command

func NewTemplateCommand 

func NewTemplateCommand(ioStream cmdutil.IOStreams) *cobra.Command

NewTemplateCommand creates `template` command and its nested children command

func NewTemplateContextCommand 

func NewTemplateContextCommand(ioStream cmdutil.IOStreams) *cobra.Command

NewTemplateContextCommand creates `context` command

func NewTraitsCommand 

func NewTraitsCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewTraitsCommand creates `traits` command

func NewUpCommand 

func NewUpCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command

NewUpCommand will create command for applying an AppFile

func NewVersionCommand 

func NewVersionCommand() *cobra.Command

NewVersionCommand print client version

func NewWorkloadsCommand 

func NewWorkloadsCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command

NewWorkloadsCommand creates `workloads` command

func OpenBrowser 

func OpenBrowser(url string) error

OpenBrowser will open browser by url in different OS system nolint:gosec

func PrintHelpByTag 

func PrintHelpByTag(cmd *cobra.Command, all []*cobra.Command, tag string)

PrintHelpByTag print custom defined help message

func PrintTrackVelaRuntimeStatus 

func PrintTrackVelaRuntimeStatus(ctx context.Context, c client.Client, ioStreams cmdutil.IOStreams, trackTimeout time.Duration) (bool, error)

PrintTrackVelaRuntimeStatus prints status of installing vela-core runtime

func ReadObjectsFromFile 

func ReadObjectsFromFile(path string) ([]oam.Object, error)

ReadObjectsFromFile will read objects from file or dir in the format of yaml

func RunHelp 

func RunHelp(cmd *cobra.Command, args []string)

RunHelp exec help [command]

func SetEnv 

func SetEnv(args []string, ioStreams cmdutil.IOStreams) error

SetEnv sets current environment

func SetupAPIServer 

func SetupAPIServer(c types.Args, cmd *cobra.Command, o Options) error

SetupAPIServer starts a RESTfulAPI server

func SystemCommandGroup 

func SystemCommandGroup(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command

SystemCommandGroup creates `system` command and its nested children command

Types

type Args 

type Args struct {
	Output string
	Env    *types.EnvMeta
	C      types.Args
	App    *v1alpha2.Application
}

Args creates arguments for `logs` command

func (*Args) Run 

func (l *Args) Run(ctx context.Context, ioStreams util.IOStreams) error

Run refer to the implementation at https://github.com/oam-dev/stern/blob/master/stern/main.go

type CompStatus 

type CompStatus int

CompStatus represents the status of a component during "vela init"

func TrackDeployStatus 

func TrackDeployStatus(c types.Args, appName string, env *types.EnvMeta) (CompStatus, string, error)

TrackDeployStatus will only check AppConfig is deployed successfully,

type HealthStatus 

type HealthStatus = v1alpha2.HealthStatus

HealthStatus represents health status strings. 

const (
	// HealthStatusNotDiagnosed means there's no health scope referred or unknown health status returned
	HealthStatusNotDiagnosed HealthStatus = "NOT DIAGNOSED"
)

type Options 

type Options struct {
	// contains filtered or unexported fields
}

Options creates options for `dashboard` command

func (*Options) GetStaticPath 

func (o *Options) GetStaticPath() error

GetStaticPath gets the path of front-end directory

type ScopeHealthCondition 

type ScopeHealthCondition = v1alpha2.ScopeHealthCondition

ScopeHealthCondition holds health condition of a scope

type VelaExecOptions 

type VelaExecOptions struct {
	Cmd         *cobra.Command
	Args        []string
	Stdin       bool
	TTY         bool
	ServiceName string

	context.Context
	VelaC types.Args
	Env   *types.EnvMeta
	App   *v1alpha2.Application

	ClientSet kubernetes.Interface
	// contains filtered or unexported fields
}

VelaExecOptions creates options for `exec` command

func (*VelaExecOptions) Complete 

func (o *VelaExecOptions) Complete() error

Complete loads data from the command environment

func (*VelaExecOptions) Init 

func (o *VelaExecOptions) Init(ctx context.Context, c *cobra.Command, argsIn []string) error

Init prepares the arguments accepted by the Exec command

func (*VelaExecOptions) Run 

func (o *VelaExecOptions) Run() error

Run executes a validated remote execution against a pod

type VelaPortForwardOptions 

type VelaPortForwardOptions struct {
	Cmd  *cobra.Command
	Args []string

	context.Context
	VelaC types.Args
	Env   *types.EnvMeta
	App   *v1alpha2.Application

	ClientSet kubernetes.Interface
	Client    client.Client
	// contains filtered or unexported fields
}

VelaPortForwardOptions for vela port-forward

func (*VelaPortForwardOptions) Complete 

func (o *VelaPortForwardOptions) Complete() error

Complete will complete the config of port-forward

func (*VelaPortForwardOptions) Init 

func (o *VelaPortForwardOptions) Init(ctx context.Context, cmd *cobra.Command, argsIn []string) error

Init will initialize

func (*VelaPortForwardOptions) Run 

func (o *VelaPortForwardOptions) Run() error

Run will execute port-forward

type VelaRuntimeStatus 

type VelaRuntimeStatus int

VelaRuntimeStatus enums vela-core runtime status 

const (
	NotFound VelaRuntimeStatus = iota
	Pending
	Ready
	Error
)

Enums of VelaRuntimeStatus

type WorkloadHealthCondition 

type WorkloadHealthCondition = v1alpha2.WorkloadHealthCondition

WorkloadHealthCondition holds health status of any resource

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.