utils

Documentation

Index

• Constants
• func AddManagementKubeconfigFlags(kubeconfig, kubecontext *string, flags *pflag.FlagSet)
• func AddOutputFlag(cmd *cobra.Command, format *string)
• func BuildClient(kubeConfigPath, kubeContext string) (client.Client, error)
• func MarshalProtoWithFormat(msg proto.Message, format string) (string, error)
• func PortForwardFromDeployment(ctx context.Context, kubeConfig string, kubeContext string, deployName string, ...) (chan struct{}, string, error)
• func PortForwardFromPod(kubeConfig string, kubeContext string, podName string, podNamespace string, ...) (chan struct{}, string, error)
• type GlobalFlags
  • func (g *GlobalFlags) AddToFlags(flags *pflag.FlagSet)

Constants

const (
	Yaml = "yaml"
	Json = "json"
)

Functions

func AddManagementKubeconfigFlags

func AddManagementKubeconfigFlags(kubeconfig, kubecontext *string, flags *pflag.FlagSet)

Set kubeconfig path and context flags for the management cluster.

func AddOutputFlag

func AddOutputFlag(cmd *cobra.Command, format *string)

augment the input cobra command with a flag specifying the output format, also add pre-run validation that the format string is valid

func BuildClient

func BuildClient(kubeConfigPath, kubeContext string) (client.Client, error)

func MarshalProtoWithFormat

func MarshalProtoWithFormat(msg proto.Message, format string) (string, error)

marshal a proto message with the given format

func PortForwardFromDeployment

func PortForwardFromDeployment(
	ctx context.Context,
	kubeConfig string,
	kubeContext string,
	deployName string,
	deployNamespace string,
	localPort string,
	remotePort string,
	logger *logrus.Logger,
) (chan struct{}, string, error)

Open a port-forward against the specified deployment. Returns the stop channel and the local port. If localPort is unspecified, a free port will be chosen at random. Close the port forward by closing the returned channel.

func PortForwardFromPod

func PortForwardFromPod(
	kubeConfig string,
	kubeContext string,
	podName string,
	podNamespace string,
	localPort string,
	remotePort string,
	logger *logrus.Logger,
) (chan struct{}, string, error)

Open a port forward against the specified pod. Returns the stop channel and the local port. If localPort is unspecified, a free port will be chosen at random. Close the port forward by closing the returned channel.

Types

type GlobalFlags

type GlobalFlags struct {
	Verbose bool
}

func (*GlobalFlags) AddToFlags

func (g *GlobalFlags) AddToFlags(flags *pflag.FlagSet)