commands

package
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2019 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Index

Constants

View Source
const FakeNamespace = "current"
View Source
const TruncateAt = 100

Max length When to truncate long strings (when not "all" mode switched on)

View Source
const WaitDefaultTimeout = 600

Default time out to use when waiting for reconciliation. It is deliberately very long as it is expected that the service doesn't stay in `Unknown` status very long and eventually ends up as `False` or `True` in a timely manner

Variables

View Source
var CfgFile string

CfgFile is Kn's config file is the path for the Kubernetes config

Functions

func AddNamespaceFlags

func AddNamespaceFlags(flags *pflag.FlagSet, allowAll bool)

AddNamespaceFlags adds the namespace-related flags: * --namespace * --all-namespaces

func Age

func Age(t time.Time) string

func CaptureStdout

func CaptureStdout(t *testing.T)

CaptureStdout collects the current content of os.Stdout

func ConditionsValue

func ConditionsValue(conditions duckv1.Conditions) string

conditionsValue returns the True conditions count among total conditions

func CreateTestKnCommand

func CreateTestKnCommand(cmd *cobra.Command, knParams *KnParams) (*cobra.Command, *fake.FakeServingV1alpha1, *bytes.Buffer)

CreateTestKnCommand helper for creating test commands

func NewCompletionCommand

func NewCompletionCommand(p *KnParams) *cobra.Command

func NewKnTestCommand

func NewKnTestCommand(subCommand *cobra.Command, params *KnParams) *cobra.Command

NewKnTestCommand needed since calling the one in core would cause a import cycle

func NonReadyConditionReason

func NonReadyConditionReason(conditions duckv1.Conditions) string

NonReadyConditionReason returns formatted string of reason and message for non ready conditions

func ReadStdout

func ReadStdout(t *testing.T) string

ReadStdout returns the collected os.Stdout content

func ReadyCondition

func ReadyCondition(conditions duckv1.Conditions) string

readyCondition returns status of resource's Ready type condition

func ReleaseStdout

func ReleaseStdout(t *testing.T)

ReleaseStdout releases the os.Stdout and restores to original

func TranslateTimestampSince

func TranslateTimestampSince(timestamp metav1.Time) string

translateTimestampSince returns the elapsed time since timestamp in human-readable approximation.

func WriteConditions

func WriteConditions(dw printers.PrefixWriter, conditions []apis.Condition, printMessage bool)

Print out a table with conditions.

func WriteMapDesc

func WriteMapDesc(dw printers.PrefixWriter, m map[string]string, label string, labelPrefix string, details bool)

Write a map either compact in a single line (possibly truncated) or, if printDetails is set, over multiple line, one line per key-value pair. The output is sorted by keys.

func WriteMetadata

func WriteMetadata(dw printers.PrefixWriter, m *metav1.ObjectMeta, printDetails bool)

Types

type Config

type Config struct {
	PluginsDir    string
	LookupPlugins bool
}

Config contains the variables for the Kn config

var Cfg Config

Cfg is Kn's configuration values

type HumanPrintFlags

type HumanPrintFlags struct {
	WithNamespace bool
	NoHeaders     bool
}

HumanPrintFlags provides default flags necessary for printing. Given the following flag values, a printer can be requested that knows how to handle printing based on these values.

func NewHumanPrintFlags

func NewHumanPrintFlags() *HumanPrintFlags

NewHumanPrintFlags returns flags associated with human-readable printing, with default values set.

func (*HumanPrintFlags) AddFlags

func (f *HumanPrintFlags) AddFlags(c *cobra.Command)

AddFlags receives a *cobra.Command reference and binds flags related to human-readable printing to it

func (*HumanPrintFlags) AllowedFormats

func (f *HumanPrintFlags) AllowedFormats() []string

AllowedFormats returns more customized formating options

func (*HumanPrintFlags) EnsureWithNamespace

func (f *HumanPrintFlags) EnsureWithNamespace()

EnsureWithNamespace sets the "WithNamespace" humanreadable option to true.

func (*HumanPrintFlags) ToPrinter

func (f *HumanPrintFlags) ToPrinter(getHandlerFunc func(h hprinters.PrintHandler)) (hprinters.ResourcePrinter, error)

ToPrinter receives returns a printer capable of handling human-readable output.

type KnParams

type KnParams struct {
	Output       io.Writer
	KubeCfgPath  string
	ClientConfig clientcmd.ClientConfig
	NewClient    func(namespace string) (serving_kn_v1alpha1.KnServingClient, error)

	// General global options
	LogHTTP bool
	// contains filtered or unexported fields
}

Parameters for creating commands. Useful for inserting mocks for testing.

func (*KnParams) CurrentNamespace

func (params *KnParams) CurrentNamespace() (string, error)

CurrentNamespace returns the current namespace which is either provided as option or picked up from kubeconfig

func (*KnParams) GetClientConfig

func (params *KnParams) GetClientConfig() (clientcmd.ClientConfig, error)

GetClientConfig gets ClientConfig from KubeCfgPath

func (*KnParams) GetConfig

GetConfig returns Serving Client

func (*KnParams) GetNamespace

func (params *KnParams) GetNamespace(cmd *cobra.Command) (string, error)

GetNamespace returns namespace from command specified by flag

func (*KnParams) Initialize

func (params *KnParams) Initialize()

type WaitFlags

type WaitFlags struct {
	// Timeout in seconds for how long to wait for a command to return
	TimeoutInSeconds int

	// If set then just apply resources and don't wait
	Async bool
}

Flags for tuning wait behaviour

func (*WaitFlags) AddConditionWaitFlags

func (p *WaitFlags) AddConditionWaitFlags(command *cobra.Command, waitTimeoutDefault int, action string, what string)

Add flags which influence the sync/async behaviour when creating or updating resources. Set `waitDefault` argument if the default behaviour is synchronous. Use `what` for describing what is waited for.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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