rollout

Documentation

Overview

Package rollout contains the rollout commands for the BindPlane CLI.

Index

• func Command(builder Builder) *cobra.Command
• func PauseCommand(builder Builder) *cobra.Command
• func ResumeCommand(builder Builder) *cobra.Command
• func StartCommand(builder Builder) *cobra.Command
• func StatusCommand(builder Builder) *cobra.Command
• func UpdateCommand(builder Builder) *cobra.Command
• type Builder
• type Rollouter
  • func NewRollouter(client client.BindPlane, printer printer.Printer) Rollouter

Functions

func Command

func Command(builder Builder) *cobra.Command

Command returns the BindPlane rollout cobra command.

func PauseCommand

func PauseCommand(builder Builder) *cobra.Command

PauseCommand the pause command pauses the rollout

func ResumeCommand

func ResumeCommand(builder Builder) *cobra.Command

ResumeCommand the resume command resumes a paused rollout

func StartCommand

func StartCommand(builder Builder) *cobra.Command

StartCommand the start command starts a rollout

func StatusCommand

func StatusCommand(builder Builder) *cobra.Command

StatusCommand the status command retrieves the status of a rollout

func UpdateCommand

func UpdateCommand(builder Builder) *cobra.Command

UpdateCommand the update command runs one cycle of a rollout

Types

type Builder

type Builder interface {
	BuildRollouter(ctx context.Context) (Rollouter, error)
}

Builder is an interface fo building a Rollouter

type Rollouter

type Rollouter interface {
	// PauseRollout pauses the rollout with rolloutName
	PauseRollout(ctx context.Context, rolloutName string) error

	// ResumeRollout resumes the rollout with rolloutName
	ResumeRollout(ctx context.Context, rolloutName string) error

	// RolloutStatus prints the status of the rollout with rolloutName
	RolloutStatus(ctx context.Context, rolloutName string) error

	// StartRollout starts the rollout with rolloutName
	StartRollout(ctx context.Context, rolloutName string) error

	// StartAllRollouts starts a rollout on all configurations
	StartAllRollouts(ctx context.Context) error

	// UpdateRollout updates a single rollout with rolloutName
	UpdateRollout(ctx context.Context, rolloutName string) error

	// UpdateRollouts updates all rollouts
	UpdateRollouts(ctx context.Context) error
}

Rollouter is an interface for managing rollouts

func NewRollouter

func NewRollouter(client client.BindPlane, printer printer.Printer) Rollouter

NewRollouter return a new Rollouter