status

Documentation

Overview

Package status implements a 'devenv status' command that allows developers to status shows the status of their developer environment.

Index

• Constants
• func NewCmdStatus(log logrus.FieldLogger) *cli.Command
• type Options
  • func NewOptions(log logrus.FieldLogger) (*Options, error)
  • func (o *Options) CheckLocalDNSResolution(ctx context.Context) error
  • func (o *Options) GetStatus(ctx context.Context) (*Status, error)
  • func (o *Options) Run(ctx context.Context) error
• type Status

Constants

const (
	Degraded      = "degraded"
	Unprovisioned = "unprovisioned"
	Running       = "running"
	Stopped       = "stopped"
	Unknown       = "unknown"
)

Functions

func NewCmdStatus

func NewCmdStatus(log logrus.FieldLogger) *cli.Command

Types

type Options

type Options struct {

	// Quiet denotes if we should output text or not
	Quiet bool

	// Namespaces is a slice of strings which, if not empty, filters
	// the output of the status command.
	Namespaces []string

	// AllNamespaces is a flag that denotes whether or not to display
	// all namespaces in the output of the status command.
	AllNamespaces bool

	// IncludeKubeSystem is a flag that denotes whether or not to
	// include kube-system in the output of the status command.
	IncludeKubeSystem bool
	// contains filtered or unexported fields
}

func NewOptions

func NewOptions(log logrus.FieldLogger) (*Options, error)

func (*Options) CheckLocalDNSResolution

func (o *Options) CheckLocalDNSResolution(ctx context.Context) error

func (*Options) GetStatus

func (o *Options) GetStatus(ctx context.Context) (*Status, error)

GetStatus determines the status of a developer environment

func (*Options) Run

func (o *Options) Run(ctx context.Context) error

type Status

type Status struct {
	// Status is the status of the cluster in text format, eventually
	// will be enum of: running, stopped, un-provisioned, degraded, or unknown
	Status string

	// Reason is included when a status may need potential
	// explanation. For now this is just non-running or stopped statuses
	Reason string

	// KubernetesVersion is the version of the developer environment
	KubernetesVersion string

	// Version is the version of the developer environment
	Version string
}