cmd

Documentation

Index

• Constants
• func Execute()
• type BlackholeStatus
• type BlockedCluster
  • func NewBlockedCluster(config *api.Config, context string) (*BlockedCluster, error)
  • func (c *BlockedCluster) AllAddresses() []string
  • func (c *BlockedCluster) Inspect() error
• type ClusterStatus
• type Command
  • func NewCommand(blockedContext string, targetContexts []string, kubeconfig string, ...) (*Command, error)
  • func (c *Command) BlockCluster() error
  • func (c *Command) ClusterStatus() (map[string]*ClusterStatus, error)
  • func (c *Command) UnblockCluster() error
• type Progress
  • func NewProgress(descripiton string, tasks uint, out io.Writer) *Progress
  • func (p *Progress) Add(completed uint)
  • func (p *Progress) Clear()
  • func (p *Progress) SetDescription(desciption string)
  • func (p *Progress) SetTasks(tasks uint)
• type Result
• type TargetCluster
  • func NewTargetCluster(config *api.Config, context string) (*TargetCluster, error)
  • func (c *TargetCluster) Inspect() error

Constants

const (
	// None of cluster addresses are blocked in target cluster.
	StatusUnblocked = BlackholeStatus("unblocked")

	// All cluster addresses are blocked in target cluster.
	StatusBlocked = BlackholeStatus("blocked")

	// Some of cluster addresses are blocked in target cluster.
	StatusPartlyBlocked = BlackholeStatus("partly-blocked")
)

Functions

func Execute

func Execute()

Types

type BlackholeStatus

type BlackholeStatus string

type BlockedCluster

type BlockedCluster struct {
	Context            string
	NodeAddresses      []string
	APIServerAddresses []string
	RouteAddresses     []string
	// contains filtered or unexported fields
}

func NewBlockedCluster

func NewBlockedCluster(config *api.Config, context string) (*BlockedCluster, error)

func (*BlockedCluster) AllAddresses

func (c *BlockedCluster) AllAddresses() []string

AllAddresses return sorted list of uniqe cluster address that must be blocked on the target cluster.

func (*BlockedCluster) Inspect

func (c *BlockedCluster) Inspect() error

type ClusterStatus

type ClusterStatus struct {
	Valid bool
	Nodes map[string]BlackholeStatus
}

type Command

type Command struct {
	Cluster *BlockedCluster
	Targets []*TargetCluster
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(blockedContext string, targetContexts []string, kubeconfig string, showProgress bool) (*Command, error)

func (*Command) BlockCluster

func (c *Command) BlockCluster() error

func (*Command) ClusterStatus

func (c *Command) ClusterStatus() (map[string]*ClusterStatus, error)

func (*Command) UnblockCluster

func (c *Command) UnblockCluster() error

type Progress

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

func NewProgress

func NewProgress(descripiton string, tasks uint, out io.Writer) *Progress

NewProgress return a new progress indicator.

func (*Progress) Add

func (p *Progress) Add(completed uint)

Add completed tasks to progress.

func (*Progress) Clear

func (p *Progress) Clear()

Clear the progress output.

func (*Progress) SetDescription

func (p *Progress) SetDescription(desciption string)

SetDescription changes the description.

func (*Progress) SetTasks

func (p *Progress) SetTasks(tasks uint)

SetTasks changes the number of tasks.

type Result

type Result struct {
	Context string
	Node    string
	Routes  sets.Set[string]
	Err     error
}

type TargetCluster

type TargetCluster struct {
	Context   string
	NodeNames []string
	// contains filtered or unexported fields
}

func NewTargetCluster

func NewTargetCluster(config *api.Config, context string) (*TargetCluster, error)

func (*TargetCluster) Inspect

func (c *TargetCluster) Inspect() error