logs

Documentation

Index

• Constants
• func NewCmdLogs(name, baseName string, f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• type LogsOptions
  • func NewLogsOptions(streams genericclioptions.IOStreams) *LogsOptions
  • func (o *LogsOptions) Complete(f kcmdutil.Factory, cmd *cobra.Command, args []string) error
  • func (o *LogsOptions) RunLog() error
  • func (o *LogsOptions) Validate(args []string) error

Constants

const LogsRecommendedCommandName = "logs"

LogsRecommendedCommandName is the recommended command name TODO: Probably move this pattern upstream?

Functions

func NewCmdLogs

func NewCmdLogs(name, baseName string, f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdLogs creates a new logs command that supports OpenShift resources.

Types

type LogsOptions

type LogsOptions struct {
	// Options should hold our own *LogOptions objects.
	Options runtime.Object
	// KubeLogOptions contains all the necessary options for
	// running the upstream logs command.
	KubeLogOptions *kcmd.LogsOptions
	// Client enables access to the Build object when processing
	// build logs for Jenkins Pipeline Strategy builds
	Client buildv1client.BuildV1Interface
	// Namespace is a required parameter when accessing the Build object when processing
	// build logs for Jenkins Pipeline Strategy builds
	Namespace string

	Builder   func() *resource.Builder
	Resources []string

	Version int64

	genericclioptions.IOStreams
}

LogsOptions holds all the necessary options for running oc logs.

func NewLogsOptions

func NewLogsOptions(streams genericclioptions.IOStreams) *LogsOptions

func (*LogsOptions) Complete

func (o *LogsOptions) Complete(f kcmdutil.Factory, cmd *cobra.Command, args []string) error

Complete calls the upstream Complete for the logs command and then resolves the resource a user requested to view its logs and creates the appropriate logOptions object for it.

func (*LogsOptions) RunLog

func (o *LogsOptions) RunLog() error

RunLog will run the upstream logs command and may use an OpenShift logOptions object.

func (*LogsOptions) Validate

func (o *LogsOptions) Validate(args []string) error

Validate runs the upstream validation for the logs command and then it will validate any OpenShift-specific log options.