Documentation ¶
Overview ¶
package commands contains Cobra commands that implement the CLI behavior. The commands are responsible for arguments and flags manipulation/validation, printing of success and error, etc. Commands delegate to a high level client for actual interaction with the kubernetes environment.
Index ¶
- func ArgValidationConjunction(validators ...cobra.PositionalArgs) cobra.PositionalArgs
- func AtPosition(i int, validator PositionalArg) cobra.PositionalArgs
- func Channel() *cobra.Command
- func ChannelCreate(fcTool *core.Client) *cobra.Command
- func ChannelDelete(fcTool *core.Client) *cobra.Command
- func ChannelList(fcTool *core.Client) *cobra.Command
- func Completion(rootCmd *cobra.Command) *cobra.Command
- func CreateAndWireRootCommand(manifests map[string]*core.Manifest, localBuilder string, ...) *cobra.Command
- func Display(out io.Writer, items []interface{}, extractors []NamedExtractor)
- func Docs(rootCmd *cobra.Command, fs Filesystem) *cobra.Command
- func FindSubcommand(command *cobra.Command, names ...string) *cobra.Command
- func Function() *cobra.Command
- func FunctionCreate(fcTool *core.Client, defaults FunctionCreateDefaults) *cobra.Command
- func FunctionUpdate(fcTool *core.Client) *cobra.Command
- func GenerateDocs(rootCommand *cobra.Command, directory string, fs Filesystem) error
- func LabelArgs(cmd *cobra.Command, labels ...string)
- func Namespace() *cobra.Command
- func NamespaceInit(manifests map[string]*core.Manifest, kc *core.KubectlClient) *cobra.Command
- func OptionalAtPosition(i int, validator PositionalArg) cobra.PositionalArgs
- func PrintInterruptedCompletion(cmd *cobra.Command)
- func PrintSuccessfulCompletion(cmd *cobra.Command)
- func Service() *cobra.Command
- func ServiceCreate(fcTool *core.Client) *cobra.Command
- func ServiceDelete(fcClient *core.Client) *cobra.Command
- func ServiceInvoke(fcClient *core.Client) *cobra.Command
- func ServiceList(fcClient *core.Client) *cobra.Command
- func ServiceStatus(fcClient *core.Client) *cobra.Command
- func ServiceUpdate(client *core.Client) *cobra.Command
- func Subscription() *Command
- func SubscriptionCreate(client *core.Client) *Command
- func SubscriptionDelete(client *core.Client) *Command
- func SubscriptionList(client *core.Client) *Command
- func System() *cobra.Command
- func SystemInstall(manifests map[string]*core.Manifest, kc *core.KubectlClient) *cobra.Command
- func SystemUninstall(kc *core.KubectlClient) *cobra.Command
- func UpToDashDash(delegate cobra.PositionalArgs) cobra.PositionalArgs
- func Version() *cobra.Command
- func Visit(cmd *cobra.Command, f func(c *cobra.Command) error) error
- type CobraEFunction
- type Filesystem
- type FlagsMatcher
- type FlagsValidator
- func AtLeastOneOf(flagNames ...string) FlagsValidator
- func AtMostOneOf(flagNames ...string) FlagsValidator
- func ExactlyOneOf(flagNames ...string) FlagsValidator
- func FlagsDependency(matcher FlagsMatcher, delegate FlagsValidator) FlagsValidator
- func FlagsValidationConjunction(validators ...FlagsValidator) FlagsValidator
- func NotBlank(flagName string) FlagsValidator
- type FunctionCreateDefaults
- type LocalFs
- type Marshaller
- type NamedExtractor
- type PositionalArg
- type StringExtractor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ArgValidationConjunction ¶
func ArgValidationConjunction(validators ...cobra.PositionalArgs) cobra.PositionalArgs
ArgValidationConjunction returns a PositionalArgs validator that checks all provided validators in turn (all must pass).
func AtPosition ¶
func AtPosition(i int, validator PositionalArg) cobra.PositionalArgs
AtPosition returns a PositionalArgs that applies the single valued validator to the i-th argument. The actual number of arguments is not checked by this function (use cobra's MinimumNArgs, ExactArgs, etc)
func Display ¶ added in v0.2.0
func Display(out io.Writer, items []interface{}, extractors []NamedExtractor)
func FindSubcommand ¶ added in v0.2.0
func FunctionCreate ¶
func FunctionCreate(fcTool *core.Client, defaults FunctionCreateDefaults) *cobra.Command
func GenerateDocs ¶ added in v0.2.0
func GenerateDocs(rootCommand *cobra.Command, directory string, fs Filesystem) error
func NamespaceInit ¶
func OptionalAtPosition ¶ added in v0.1.3
func OptionalAtPosition(i int, validator PositionalArg) cobra.PositionalArgs
func PrintInterruptedCompletion ¶ added in v0.1.3
func PrintSuccessfulCompletion ¶ added in v0.1.3
func Subscription ¶ added in v0.1.3
func Subscription() *Command
func SubscriptionCreate ¶ added in v0.1.3
func SubscriptionDelete ¶ added in v0.1.3
func SubscriptionList ¶ added in v0.1.3
func SystemInstall ¶
func SystemUninstall ¶ added in v0.1.1
func SystemUninstall(kc *core.KubectlClient) *cobra.Command
func UpToDashDash ¶ added in v0.1.1
func UpToDashDash(delegate cobra.PositionalArgs) cobra.PositionalArgs
UpToDashDash returns a validator that will invoke the `delegate` validator, but only with args before the splitting `--`, if any
Types ¶
type CobraEFunction ¶
CobraEFunction is the type of functions cobra expects for Run, PreRun, etc that can return an error.
func FlagsValidatorAsCobraRunE ¶
func FlagsValidatorAsCobraRunE(validator FlagsValidator) CobraEFunction
FlagsValidatorAsCobraRunE allows a FlagsValidator to be used as a CobraEFunction (typically PreRunE())
type Filesystem ¶ added in v0.2.0
type FlagsMatcher ¶
func Set ¶
func Set(name string) FlagsMatcher
type FlagsValidator ¶
func AtLeastOneOf ¶
func AtLeastOneOf(flagNames ...string) FlagsValidator
AtLeastOneOf returns a FlagsValidator that asserts that at least one of the passed in flags is set.
func AtMostOneOf ¶
func AtMostOneOf(flagNames ...string) FlagsValidator
AtMostOneOf returns a FlagsValidator that asserts that at most one of the passed in flags is set.
func ExactlyOneOf ¶ added in v0.1.3
func ExactlyOneOf(flagNames ...string) FlagsValidator
ExactlyOneOf returns a FlagsValidator that asserts that one and only one of the passed in flags is set.
func FlagsDependency ¶
func FlagsDependency(matcher FlagsMatcher, delegate FlagsValidator) FlagsValidator
FlagsDependency returns a validator that will evaluate the given delegate if the provided flag matcher returns true. Use to enforce scenarios such as "if --foo is set, then --bar must be set as well".
func FlagsValidationConjunction ¶
func FlagsValidationConjunction(validators ...FlagsValidator) FlagsValidator
FlagsValidationConjunction returns a FlagsValidator validator that checks all provided validators in turn (all must pass).
func NotBlank ¶ added in v0.1.3
func NotBlank(flagName string) FlagsValidator
NotBlank returns a FlagsValidator that asserts that the given flag is not made entirely of space characters.
type FunctionCreateDefaults ¶ added in v0.2.0
type FunctionCreateDefaults struct { LocalBuilder string // the image for the builder used when building locally DefaultRunImage string // the default for the --run-image flag. }
FunctionCreateDefaults contains values for "defaults" or "constants" that can be overridden depending on the actual CLI tool being built.
type Marshaller ¶
type Marshaller interface {
Marshal(o interface{}) error
}
func NewMarshaller ¶
func NewMarshaller(w io.Writer) Marshaller
type NamedExtractor ¶ added in v0.2.0
type NamedExtractor struct {
// contains filtered or unexported fields
}
type PositionalArg ¶
PositionalArg is a function for validating a single argument
func KubernetesValidation ¶
func KubernetesValidation(k8s func(string) []string) PositionalArg
KubernetesValidation turns a kubernetes-style validation function into a PositionalArg
func ValidName ¶
func ValidName() PositionalArg
type StringExtractor ¶ added in v0.2.0
type StringExtractor func(interface{}) string