component

package
Version: v1.2.6 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const CreateRecommendedCommandName = "create"

CreateRecommendedCommandName is the recommended watch command name

View Source
const DeleteRecommendedCommandName = "delete"

DeleteRecommendedCommandName is the recommended delete command name

View Source
const DescribeRecommendedCommandName = "describe"

DescribeRecommendedCommandName is the recommended describe command name

View Source
const ExecRecommendedCommandName = "exec"

ExecRecommendedCommandName is the recommended exec command name

View Source
const GetRecommendedCommandName = "get"

GetRecommendedCommandName is the recommended get command name

View Source
const LinkRecommendedCommandName = "link"

LinkRecommendedCommandName is the recommended link command name

View Source
const ListRecommendedCommandName = "list"

ListRecommendedCommandName is the recommended watch command name

View Source
const LocalDirectoryDefaultLocation = "./"

LocalDirectoryDefaultLocation is the default location of where --local files should always be.. since the application will always be in the same directory as `.odo`, we will always set this as: ./

View Source
const LogRecommendedCommandName = "log"

LogRecommendedCommandName is the recommended watch command name

View Source
const PushRecommendedCommandName = "push"

PushRecommendedCommandName is the recommended push command name

View Source
const PushedCompState = "Pushed"
View Source
const RecommendedCommandName = "component"

RecommendedCommandName is the recommended component command name

View Source
const TestRecommendedCommandName = "test"

TestRecommendedCommandName is the recommended test command name

View Source
const UnlinkRecommendedCommandName = "unlink"

UnlinkRecommendedCommandName is the recommended unlink command name

View Source
const UnpushedCompState = "Unpushed"
View Source
const UpdateRecommendedCommandName = "update"

UpdateRecommendedCommandName is the recommended update command name

View Source
const WatchRecommendedCommandName = "watch"

WatchRecommendedCommandName is the recommended watch command name

Variables

View Source
var ConfigFilePath = filepath.Join(LocalDirectoryDefaultLocation, configFile)

ConfigFilePath is the path of config.yaml for s2i component

DevfilePath is the devfile path that is used by odo, which means odo can: 1. Directly use the devfile in DevfilePath 2. Download devfile from registry to DevfilePath then use the devfile in DevfilePath 3. Copy user's own devfile (path is specified via --devfile flag) to DevfilePath then use the devfile in DevfilePath

EnvFilePath is the path of env file for devfile component

Functions

func AddComponentFlag added in v0.0.18

func AddComponentFlag(cmd *cobra.Command)

AddComponentFlag adds a `component` flag to the given cobra command Also adds a completion handler to the flag

func NewCmdComponent

func NewCmdComponent(name, fullName string) *cobra.Command

NewCmdComponent implements the component odo command

func NewCmdCreate

func NewCmdCreate(name, fullName string) *cobra.Command

NewCmdCreate implements the create odo command

func NewCmdDelete

func NewCmdDelete(name, fullName string) *cobra.Command

NewCmdDelete implements the delete odo command

func NewCmdDescribe

func NewCmdDescribe(name, fullName string) *cobra.Command

NewCmdDescribe implements the describe odo command

func NewCmdExec added in v1.2.4

func NewCmdExec(name, fullName string) *cobra.Command

NewCmdExec implements the exec odo command

func NewCmdGet added in v0.0.19

func NewCmdGet(name, fullName string) *cobra.Command

NewCmdGet implements odo component get command

func NewCmdLink(name, fullName string) *cobra.Command

NewCmdLink implements the link odo command

func NewCmdList

func NewCmdList(name, fullName string) *cobra.Command

NewCmdList implements the list odo command

func NewCmdLog

func NewCmdLog(name, fullName string) *cobra.Command

NewCmdLog implements the log odo command

func NewCmdPush

func NewCmdPush(name, fullName string) *cobra.Command

NewCmdPush implements the push odo command

func NewCmdTest added in v1.2.4

func NewCmdTest(name, fullName string) *cobra.Command

NewCmdTest implements the odo test command

func NewCmdUnlink(name, fullName string) *cobra.Command

NewCmdUnlink implements the link odo command

func NewCmdUpdate

func NewCmdUpdate(name, fullName string) *cobra.Command

NewCmdUpdate implements the Update odo command

func NewCmdWatch

func NewCmdWatch(name, fullName string) *cobra.Command

NewCmdWatch implements the watch odo command

Types

type CommonPushOptions added in v1.0.0

type CommonPushOptions struct {
	EnvSpecificInfo *envinfo.EnvSpecificInfo

	*genericclioptions.Context
	// contains filtered or unexported fields
}

CommonPushOptions has data needed for all pushes

func NewCommonPushOptions added in v1.0.0

func NewCommonPushOptions() *CommonPushOptions

NewCommonPushOptions instantiates a commonPushOptions object

func (*CommonPushOptions) AddContextFlag added in v1.1.1

func (cpo *CommonPushOptions) AddContextFlag(cmd *cobra.Command)

AddContextFlag adds the context flag to specified command storing value of flag in options.componentContext

func (*CommonPushOptions) InitConfigFromContext added in v1.1.1

func (cpo *CommonPushOptions) InitConfigFromContext() error

InitConfigFromContext initializes localconfiginfo from the context

func (*CommonPushOptions) InitEnvInfoFromContext added in v1.1.1

func (cpo *CommonPushOptions) InitEnvInfoFromContext() (err error)

InitEnvInfoFromContext initializes envinfo from the context

func (*CommonPushOptions) Push added in v1.0.0

func (cpo *CommonPushOptions) Push() (err error)

Push pushes changes as per set options

func (*CommonPushOptions) ResolveProject added in v1.0.0

func (cpo *CommonPushOptions) ResolveProject(prjName string) (err error)

ResolveProject completes the push options as needed

func (*CommonPushOptions) ResolveSrcAndConfigFlags added in v1.0.0

func (cpo *CommonPushOptions) ResolveSrcAndConfigFlags()

ResolveSrcAndConfigFlags sets all pushes if none is asked

func (*CommonPushOptions) SetSourceInfo added in v1.0.0

func (cpo *CommonPushOptions) SetSourceInfo() (err error)

SetSourceInfo sets up source information

func (*CommonPushOptions) ValidateComponentCreate added in v1.1.1

func (cpo *CommonPushOptions) ValidateComponentCreate() error

ValidateComponentCreate validates if the request to create component is valid

type ComponentOptions added in v0.0.19

type ComponentOptions struct {
	*genericclioptions.Context
	// contains filtered or unexported fields
}

ComponentOptions encapsulates basic component options

func (*ComponentOptions) Complete added in v0.0.19

func (co *ComponentOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes component options

type CreateOptions added in v0.0.19

type CreateOptions struct {
	*CommonPushOptions
	// contains filtered or unexported fields
}

CreateOptions encapsulates create options

func NewCreateOptions added in v0.0.19

func NewCreateOptions() *CreateOptions

NewCreateOptions returns new instance of CreateOptions

func (*CreateOptions) Complete added in v0.0.19

func (co *CreateOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes create args

func (*CreateOptions) Run added in v0.0.19

func (co *CreateOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*CreateOptions) Validate added in v0.0.19

func (co *CreateOptions) Validate() (err error)

Validate validates the create parameters

type DeleteOptions added in v0.0.19

type DeleteOptions struct {
	*ComponentOptions

	EnvSpecificInfo *envinfo.EnvSpecificInfo
	// contains filtered or unexported fields
}

DeleteOptions is a container to attach complete, validate and run pattern

func NewDeleteOptions added in v0.0.19

func NewDeleteOptions() *DeleteOptions

NewDeleteOptions returns new instance of DeleteOptions

func (*DeleteOptions) Complete added in v0.0.19

func (do *DeleteOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes log args

func (*DeleteOptions) DevFileRun added in v1.1.3

func (do *DeleteOptions) DevFileRun() (err error)

DevFileRun has the logic to perform the required actions as part of command for devfiles

func (*DeleteOptions) DevfileComponentDelete added in v1.1.2

func (do *DeleteOptions) DevfileComponentDelete() error

DevfileComponentDelete deletes the devfile component

func (*DeleteOptions) Run added in v0.0.19

func (do *DeleteOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*DeleteOptions) Validate added in v0.0.19

func (do *DeleteOptions) Validate() (err error)

Validate validates the list parameters

type DescribeOptions added in v0.0.19

type DescribeOptions struct {
	*ComponentOptions
	// contains filtered or unexported fields
}

DescribeOptions is a dummy container to attach complete, validate and run pattern

func NewDescribeOptions added in v0.0.19

func NewDescribeOptions() *DescribeOptions

NewDescribeOptions returns new instance of ListOptions

func (*DescribeOptions) Complete added in v0.0.19

func (do *DescribeOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes describe args

func (*DescribeOptions) Run added in v0.0.19

func (do *DescribeOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*DescribeOptions) Validate added in v0.0.19

func (do *DescribeOptions) Validate() (err error)

Validate validates the describe parameters

type DevfileMetadata added in v1.1.2

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

DevfileMetadata includes devfile component metadata

type ExecOptions added in v1.2.4

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

ExecOptions contains exec options

func NewExecOptions added in v1.2.4

func NewExecOptions() *ExecOptions

NewExecOptions returns new instance of ExecOptions

func (*ExecOptions) Complete added in v1.2.4

func (eo *ExecOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes exec args

func (*ExecOptions) DevfileComponentExec added in v1.2.4

func (eo *ExecOptions) DevfileComponentExec(command []string) error

DevfileComponentExec executes the given user command inside the component

func (*ExecOptions) Run added in v1.2.4

func (eo *ExecOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*ExecOptions) Validate added in v1.2.4

func (eo *ExecOptions) Validate() (err error)

Validate validates the exec parameters

type GetOptions added in v0.0.19

type GetOptions struct {
	*genericclioptions.Context
	// contains filtered or unexported fields
}

GetOptions encapsulates component get options

func NewGetOptions added in v0.0.19

func NewGetOptions() *GetOptions

NewGetOptions returns new instance of GetOptions

func (*GetOptions) Complete added in v0.0.19

func (gto *GetOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes get args

func (*GetOptions) Run added in v0.0.19

func (gto *GetOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*GetOptions) Validate added in v0.0.19

func (gto *GetOptions) Validate() (err error)

Validate validates the get parameters

type LinkOptions added in v0.0.18

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

LinkOptions encapsulates the options for the odo link command

func NewLinkOptions added in v0.0.18

func NewLinkOptions() *LinkOptions

NewLinkOptions creates a new LinkOptions instance

func (*LinkOptions) Complete added in v0.0.18

func (o *LinkOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes LinkOptions after they've been created

func (*LinkOptions) Run added in v0.0.18

func (o *LinkOptions) Run() (err error)

Run contains the logic for the odo link command

func (*LinkOptions) Validate added in v0.0.18

func (o *LinkOptions) Validate() (err error)

Validate validates the LinkOptions based on completed values

type ListOptions added in v0.0.19

type ListOptions struct {
	*genericclioptions.Context
	// contains filtered or unexported fields
}

ListOptions is a dummy container to attach complete, validate and run pattern

func NewListOptions added in v0.0.19

func NewListOptions() *ListOptions

NewListOptions returns new instance of ListOptions

func (*ListOptions) Complete added in v0.0.19

func (lo *ListOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes log args

func (*ListOptions) Run added in v0.0.19

func (lo *ListOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*ListOptions) Validate added in v0.0.19

func (lo *ListOptions) Validate() (err error)

Validate validates the list parameters

type LogOptions added in v0.0.19

type LogOptions struct {
	*ComponentOptions
	// contains filtered or unexported fields
}

LogOptions contains log options

func NewLogOptions added in v0.0.19

func NewLogOptions() *LogOptions

NewLogOptions returns new instance of LogOptions

func (*LogOptions) Complete added in v0.0.19

func (lo *LogOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes log args

func (LogOptions) DevfileComponentLog added in v1.2.4

func (lo LogOptions) DevfileComponentLog() error

DevfileComponentLog fetch and display log from devfile components

func (*LogOptions) Run added in v0.0.19

func (lo *LogOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*LogOptions) Validate added in v0.0.19

func (lo *LogOptions) Validate() (err error)

Validate validates the log parameters

type PushOptions added in v0.0.19

type PushOptions struct {
	*CommonPushOptions

	// devfile path
	DevfilePath string
	Devfile     parser.DevfileObj
	// contains filtered or unexported fields
}

PushOptions encapsulates options that push command uses

func NewPushOptions added in v0.0.19

func NewPushOptions() *PushOptions

NewPushOptions returns new instance of PushOptions with "default" values for certain values, for example, show is "false"

func (*PushOptions) Complete added in v0.0.19

func (po *PushOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes push args

func (*PushOptions) CompleteDevfilePath added in v1.2.3

func (po *PushOptions) CompleteDevfilePath()

CompleteDevfilePath completes the devfile path from context

func (*PushOptions) DevfilePush added in v1.1.1

func (po *PushOptions) DevfilePush() error

DevfilePush has the logic to perform the required actions for a given devfile

func (*PushOptions) Run added in v0.0.19

func (po *PushOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*PushOptions) Validate added in v0.0.19

func (po *PushOptions) Validate() (err error)

Validate validates the push parameters

type TestOptions added in v1.2.4

type TestOptions struct {
	*genericclioptions.Context
	// contains filtered or unexported fields
}

TestOptions encapsulates the options for the odo command

func NewTestOptions added in v1.2.4

func NewTestOptions() *TestOptions

NewTestOptions creates a new TestOptions instance

func (*TestOptions) Complete added in v1.2.4

func (to *TestOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes TestOptions after they've been created

func (*TestOptions) Run added in v1.2.4

func (to *TestOptions) Run() (err error)

Run contains the logic for the odo command

func (*TestOptions) RunTestCommand added in v1.2.4

func (to *TestOptions) RunTestCommand() error

RunTestCommand runs the specific test command in devfile

func (*TestOptions) Validate added in v1.2.4

func (to *TestOptions) Validate() (err error)

Validate validates the TestOptions based on completed values

type UnlinkOptions added in v0.0.18

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

UnlinkOptions encapsulates the options for the odo link command

func NewUnlinkOptions added in v0.0.18

func NewUnlinkOptions() *UnlinkOptions

NewUnlinkOptions creates a new UnlinkOptions instance

func (*UnlinkOptions) Complete added in v0.0.18

func (o *UnlinkOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes UnlinkOptions after they've been created

func (*UnlinkOptions) Run added in v0.0.18

func (o *UnlinkOptions) Run() (err error)

Run contains the logic for the odo link command

func (*UnlinkOptions) Validate added in v0.0.18

func (o *UnlinkOptions) Validate() (err error)

Validate validates the UnlinkOptions based on completed values

type UpdateOptions added in v0.0.19

type UpdateOptions struct {
	*CommonPushOptions
	// contains filtered or unexported fields
}

UpdateOptions encapsulates the update command options

func NewUpdateOptions added in v0.0.19

func NewUpdateOptions() *UpdateOptions

NewUpdateOptions returns new instance of UpdateOptions

func (*UpdateOptions) Complete added in v0.0.19

func (uo *UpdateOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes update args

func (*UpdateOptions) Run added in v0.0.19

func (uo *UpdateOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*UpdateOptions) Validate added in v0.0.19

func (uo *UpdateOptions) Validate() (err error)

Validate validates the update parameters

type WatchOptions added in v0.0.19

type WatchOptions struct {
	*genericclioptions.Context
	// contains filtered or unexported fields
}

WatchOptions contains attributes of the watch command

func NewWatchOptions added in v0.0.19

func NewWatchOptions() *WatchOptions

NewWatchOptions returns new instance of WatchOptions

func (*WatchOptions) Complete added in v0.0.19

func (wo *WatchOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes watch args

func (*WatchOptions) Run added in v0.0.19

func (wo *WatchOptions) Run() (err error)

Run has the logic to perform the required actions as part of command

func (*WatchOptions) Validate added in v0.0.19

func (wo *WatchOptions) Validate() (err error)

Validate validates the watch parameters

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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