interactive

Documentation

Index

• Constants
• Variables
• func AddFlag(flags *pflag.FlagSet)
• func AddModeFlag(cmd *cobra.Command)
• func BuildAutomaticUpgradeSchedule(cmd *cobra.Command, schedule string) (string, error)
• func BuildManualUpgradeSchedule(cmd *cobra.Command, scheduleDate string, scheduleTime string) (time.Time, error)
• func Enable()
• func Enabled() bool
• func GetAddonArgument(param asv1.AddonParameter, dflt string) (string, error)
• func GetBool(input Input) (a bool, err error)
• func GetCert(input Input) (a string, err error)
• func GetFloat(input Input) (a float64, err error)
• func GetIPNet(input Input) (a net.IPNet, err error)
• func GetInt(input Input) (a int, err error)
• func GetMode() (string, error)
• func GetMultipleOptions(input Input) ([]string, error)
• func GetOption(input Input) (a string, err error)
• func GetOptionMode(cmd *cobra.Command, mode string, question string) (string, error)
• func GetPassword(input Input) (a string, err error)
• func GetString(input Input) (a string, err error)
• func IsCIDR(val interface{}) error
• func IsCert(filepath interface{}) error
• func IsURL(val interface{}) error
• func IsURLHttps(val interface{}) error
• func IsValidHostname(val interface{}) error
• func PrintHelp(help Help) error
• func SetEnabled(setEnabled bool)
• func SetModeKey(key string)
• type Help
• type Input
• type Validator
  • func AvailabilityZonesCountValidator(multiAZ bool) Validator
  • func MachinePoolRootDiskSizeValidator(version string) Validator
  • func MaxValue(max int) Validator
  • func MinValue(min int) Validator
  • func NodePoolRootDiskSizeValidator() Validator
  • func RegExp(restr string) Validator
  • func RegExpBoolean(restr string) Validator
  • func SubnetsValidator(awsClient aws.Client, multiAZ bool, privateLink bool, hostedCP bool) Validator

Constants

const (
	Mode       = "mode"
	ModeAuto   = "auto"
	ModeManual = "manual"
)

Variables

var MaxLength = func(length int) Validator {
	return Validator(survey.MaxLength(length))
}

var Modes = []string{ModeAuto, ModeManual}

Functions

func AddFlag

func AddFlag(flags *pflag.FlagSet)

AddFlag adds the interactive flag to the given set of command line flags.

func AddModeFlag

func AddModeFlag(cmd *cobra.Command)

func BuildAutomaticUpgradeSchedule

func BuildAutomaticUpgradeSchedule(cmd *cobra.Command, schedule string) (string, error)

func BuildManualUpgradeSchedule

func BuildManualUpgradeSchedule(cmd *cobra.Command, scheduleDate string, scheduleTime string) (time.Time, error)

func Enable

func Enable()

Enable enables the interactive mode

func Enabled

func Enabled() bool

Enabled returns a boolean flag that indicates if the interactive mode is enabled.

func GetAddonArgument

func GetAddonArgument(param asv1.AddonParameter, dflt string) (string, error)

func GetBool

func GetBool(input Input) (a bool, err error)

Asks for true/false value in the command line

func GetCert

func GetCert(input Input) (a string, err error)

Gets path to certificate file from the command line

func GetFloat

func GetFloat(input Input) (a float64, err error)

Gets float number input from the command line

func GetIPNet

func GetIPNet(input Input) (a net.IPNet, err error)

Asks for CIDR value in the command line

func GetInt

func GetInt(input Input) (a int, err error)

Gets int number input from the command line

func GetMode

func GetMode() (string, error)

func GetMultipleOptions

func GetMultipleOptions(input Input) ([]string, error)

Asks for multiple options selection

func GetOption

func GetOption(input Input) (a string, err error)

Asks for option selection in the command line

func GetOptionMode

func GetOptionMode(cmd *cobra.Command, mode string, question string) (string, error)

func GetPassword

func GetPassword(input Input) (a string, err error)

Gets password input from the command line

func GetString

func GetString(input Input) (a string, err error)

Gets string input from the command line

func IsCIDR

func IsCIDR(val interface{}) error

func IsCert

func IsCert(filepath interface{}) error

IsCert validates whether the given filepath is a valid cert file

func IsURL

func IsURL(val interface{}) error

IsURL validates whether the given value is a valid URL

func IsURLHttps

func IsURLHttps(val interface{}) error

func IsValidHostname

func IsValidHostname(val interface{}) error

IsValidHostname is same validation as in the Open Shift GitHub IDP CRD Validates the hostname DNS1123 format https://github.com/openshift/kubernetes/blob/91607f5d750ba4002f87d34a12ae1cfd45b45b81/openshift-kube-apiserver/admission/customresourcevalidation/oauth/helpers.go#L13 and denies any [*.]github.com hostnames https://github.com/openshift/kubernetes/blob/258f1d5fb6491ba65fd8201c827e179432430627/openshift-kube-apiserver/admission/customresourcevalidation/oauth/validate_github.go#L49 nolint

func PrintHelp

func PrintHelp(help Help) error

func SetEnabled

func SetEnabled(setEnabled bool)

func SetModeKey

func SetModeKey(key string)

Types

type Help

type Help struct {
	Message string
	Steps   []string
}

type Input

type Input struct {
	Question       string
	Help           string
	Options        []string
	Default        interface{}
	DefaultMessage string
	Required       bool
	Validators     []Validator
}

type Validator

type Validator survey.Validator

func AvailabilityZonesCountValidator

func AvailabilityZonesCountValidator(multiAZ bool) Validator

func MachinePoolRootDiskSizeValidator

func MachinePoolRootDiskSizeValidator(version string) Validator

func MaxValue

func MaxValue(max int) Validator

MaxValue returns a Validator that validates the entered number is less than or equal to max

func MinValue

func MinValue(min int) Validator

MinValue returns a validator that validates the entered number is greater than or equal to min

func NodePoolRootDiskSizeValidator

func NodePoolRootDiskSizeValidator() Validator

func RegExp

func RegExp(restr string) Validator

func RegExpBoolean

func RegExpBoolean(restr string) Validator

func SubnetsValidator

func SubnetsValidator(awsClient aws.Client, multiAZ bool, privateLink bool, hostedCP bool) Validator

SubnetsCountValidator get a slice of `[]core.OptionAnswer` as an interface. e.g. core.OptionAnswer { Value: subnet-04f67939f44a97dbe (us-west-2b), Index: 0 }