options

Documentation

Index

• Variables
• func GetCustomizeKtConfig() (string, bool)
• func GetCustomizeKubeConfig() (string, bool)
• func SetOptions(cmd *cobra.Command, flags *flag.FlagSet, optionStore any, ...)
• type CleanOptions
• type ConfigOptions
• type ConnectOptions
• type DaemonOptions
  • func Get() *DaemonOptions
• type ExchangeOptions
• type GlobalOptions
• type MeshOptions
• type OptionConfig
  • func CleanFlags() []OptionConfig
  • func ConfigFlags() []OptionConfig
  • func ConnectFlags() []OptionConfig
  • func ExchangeFlags() []OptionConfig
  • func GlobalFlags() []OptionConfig
  • func MeshFlags() []OptionConfig
  • func PreviewFlags() []OptionConfig
  • func RecoverFlags() []OptionConfig
• type PreviewOptions
• type RecoverOptions
• type RuntimeStore

Variables

var Store = &RuntimeStore{}

Functions

func GetCustomizeKtConfig

func GetCustomizeKtConfig() (string, bool)

func GetCustomizeKubeConfig

func GetCustomizeKubeConfig() (string, bool)

func SetOptions

func SetOptions(cmd *cobra.Command, flags *flag.FlagSet, optionStore any, config []OptionConfig)

Types

type CleanOptions

type CleanOptions struct {
	DryRun           bool
	ThresholdInMinus int64
	LocalOnly        bool
	SweepLocalRoute  bool
}

CleanOptions ...

type ConfigOptions

type ConfigOptions struct {
}

ConfigOptions ...

type ConnectOptions

type ConnectOptions struct {
	Global           bool
	DisablePodIp     bool
	DisableTunDevice bool
	DisableTunRoute  bool
	ProxyPort        int
	DnsPort          int
	DnsCacheTtl      int
	IncludeIps       string
	ExcludeIps       string
	Mode             string
	DnsMode          string
	ShareShadow      bool
	ClusterDomain    string
	SkipCleanup      bool
}

ConnectOptions ...

type DaemonOptions

type DaemonOptions struct {
	Connect  *ConnectOptions
	Exchange *ExchangeOptions
	Mesh     *MeshOptions
	Preview  *PreviewOptions
	Recover  *RecoverOptions
	Clean    *CleanOptions
	Config   *ConfigOptions
	Global   *GlobalOptions
}

DaemonOptions cli options

func Get

func Get() *DaemonOptions

Get fetch options instance

type ExchangeOptions

type ExchangeOptions struct {
	Mode            string
	Expose          string
	RecoverWaitTime int
}

ExchangeOptions ...

type GlobalOptions

type GlobalOptions struct {
	AsWorker            bool
	Kubeconfig          string
	Namespace           string
	ServiceAccount      string
	Debug               bool
	Image               string
	ImagePullSecret     string
	NodeSelector        string
	WithLabel           string
	WithAnnotation      string
	PortForwardTimeout  int
	PodCreationTimeout  int
	UseShadowDeployment bool
	ForceUpdate         bool
	UseLocalTime        bool
	Context             string
	PodQuota            string
}

GlobalOptions ...

type MeshOptions

type MeshOptions struct {
	Mode        string
	Expose      string
	VersionMark string
	RouterImage string
}

MeshOptions ...

type OptionConfig

type OptionConfig struct {
	Target       string
	Alias        string
	DefaultValue any
	Description  string
	Hidden       bool
	Required     bool
}

func CleanFlags

func CleanFlags() []OptionConfig

func ConfigFlags

func ConfigFlags() []OptionConfig

func ConnectFlags

func ConnectFlags() []OptionConfig

func ExchangeFlags

func ExchangeFlags() []OptionConfig

func GlobalFlags

func GlobalFlags() []OptionConfig

func MeshFlags

func MeshFlags() []OptionConfig

func PreviewFlags

func PreviewFlags() []OptionConfig

func RecoverFlags

func RecoverFlags() []OptionConfig

type PreviewOptions

type PreviewOptions struct {
	External bool
	Expose   string
}

PreviewOptions ...

type RecoverOptions

type RecoverOptions struct {
}

RecoverOptions ...

type RuntimeStore

type RuntimeStore struct {
	// Clientset for kubernetes operation
	Clientset kubernetes.Interface
	// RestConfig kubectl config
	RestConfig *rest.Config
	// Version ktctl version
	Version string
	// Component current sub-command (connect, exchange, mesh or preview)
	Component string
	// Shadow pod name
	Shadow string
	// Router pod name
	Router string
	// Mesh version of mesh pod
	Mesh string
	// Origin the origin deployment or service name
	Origin string
	// Replicas the origin replicas
	Replicas int32
	// Service exposed service name
	Service string
}

RuntimeStore ...