utils

Documentation

Index

• Constants
• Variables
• func AddManagementKubeconfigFlags(kubeconfig, kubecontext *string, flags *pflag.FlagSet)
• func AddMeshctlConfigFlags(meshctlConfigPath *string, flags *pflag.FlagSet)
• func AddOutputFlag(cmd *cobra.Command, format *string)
• func BuildClient(kubeConfigPath, kubeContext string) (client.Client, error)
• func BuildClientConfigAndClientset(kubeconfig, kubeContext string) (clientcmd.ClientConfig, *kubernetes.Clientset, error)
• func BuildClientset(kubeConfigPath, kubeContext string) (*kubernetes.Clientset, error)
• func CleanupCompletedPodsInNamespace(ctx context.Context, kubeconfig, kubecontext, namespace string) error
• func DefaultMeshctlConfigFilePath() (string, error)
• func EnsureNamespace(ctx context.Context, kubeClient client.Client, namespace string) error
• func GetGlooMeshVersion(ctx context.Context, kubeConfigPath, kubeContext, namespace string) (string, error)
• func MarshalProtoWithFormat(msg proto.Message, format string) (string, error)
• func PortForwardFromDeployment(ctx context.Context, kubeConfig string, kubeContext string, deployName string, ...) (string, error)
• func PortForwardFromPod(ctx context.Context, kubeConfig string, kubeContext string, podName string, ...) (string, error)
• func RunShell(c string, writer io.Writer)
• func UpdateMeshctlConfigWithDeregistrationInfo(...) error
• func UpdateMeshctlConfigWithInstallInfo(mgmtKubeConfig, mgmtKubecontext string) error
• func UpdateMeshctlConfigWithRegistrationInfo(...) error
• func WaitUntilCRDsEstablished(ctx context.Context, kubeClient client.Client, timeout time.Duration, ...) error
• func WriteConfigToFile(config MeshctlConfig, meshctlConfigPath string) error
• func Zip(fs afero.Fs, dir string, file string) error
• type GlobalFlags
  • func (g *GlobalFlags) AddToFlags(flags *pflag.FlagSet)
• type KubeConfig
• type KubeConfigCluster
• type MeshctlCluster
• type MeshctlConfig
  • func NewMeshctlConfig() MeshctlConfig
  • func ParseMeshctlConfig(meshctlConfigPath string) (MeshctlConfig, error)
  • func (c MeshctlConfig) AddDataPlaneCluster(name string, kc MeshctlCluster) error
  • func (c MeshctlConfig) AddMgmtCluster(kc MeshctlCluster)
  • func (c MeshctlConfig) FilePath() string
  • func (c MeshctlConfig) IsMgmtCluster(name string) bool
  • func (c MeshctlConfig) MgmtCluster() MeshctlCluster
  • func (c MeshctlConfig) RemoteClusters() map[string]MeshctlCluster

Constants

const (
	ConfigFileName = "meshctl-config.yaml"
	ConfigDirName  = ".gloo-mesh"
)

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

Variables

var (
	DefaultConfigPath = path.Join(homeDir, ConfigDirName, ConfigFileName)
)

Functions

func AddManagementKubeconfigFlags

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

Set kubeconfig path and context flags for the management cluster.

func AddMeshctlConfigFlags

func AddMeshctlConfigFlags(meshctlConfigPath *string, flags *pflag.FlagSet)

Set the meshctl config file path

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 BuildClientConfigAndClientset

func BuildClientConfigAndClientset(kubeconfig, kubeContext string) (clientcmd.ClientConfig, *kubernetes.Clientset, error)

BuildClientConfigAndClientset creates a rest.Config and AppsClientset from the given kubeconfig path and Context.

func BuildClientset

func BuildClientset(kubeConfigPath, kubeContext string) (*kubernetes.Clientset, error)

func CleanupCompletedPodsInNamespace

func CleanupCompletedPodsInNamespace(ctx context.Context, kubeconfig, kubecontext, namespace string) error

func DefaultMeshctlConfigFilePath

func DefaultMeshctlConfigFilePath() (string, error)

return the default meshctl config filepath

func EnsureNamespace

func EnsureNamespace(ctx context.Context, kubeClient client.Client, namespace string) error

func GetGlooMeshVersion

func GetGlooMeshVersion(ctx context.Context, kubeConfigPath, kubeContext, namespace string) (string, 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,
) (string, error)

Open a port-forward against the specified deployment. Returns the local port. If localPort is unspecified, a free port will be chosen at random. Canceling the context will stop the port-forward.

func PortForwardFromPod

func PortForwardFromPod(
	ctx context.Context,
	kubeConfig string,
	kubeContext string,
	podName string,
	podNamespace string,
	localPort string,
	remotePort string,
) (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.

func RunShell

func RunShell(c string, writer io.Writer)

func UpdateMeshctlConfigWithDeregistrationInfo

func UpdateMeshctlConfigWithDeregistrationInfo(mgmtKubeConfigPath, mgmtKubecontext,
	remoteClusterName, remoteKubeConfigPath string) error

update the default meschtl config file with deregistration info

func UpdateMeshctlConfigWithInstallInfo

func UpdateMeshctlConfigWithInstallInfo(mgmtKubeConfig, mgmtKubecontext string) error

update the default meschtl config file with install info

func UpdateMeshctlConfigWithRegistrationInfo

func UpdateMeshctlConfigWithRegistrationInfo(mgmtKubeConfigPath, mgmtKubecontext,
	remoteClusterName, remoteKubeConfigPath, remoteKubecontext string) error

update the default meschtl config file with registration info

func WaitUntilCRDsEstablished

func WaitUntilCRDsEstablished(ctx context.Context, kubeClient client.Client, timeout time.Duration, crdNames []string) error

block until CRD is in the "established" phase to prevent subsequent race conditions when attempting to create CRs

func WriteConfigToFile

func WriteConfigToFile(config MeshctlConfig, meshctlConfigPath string) error

func Zip

func Zip(fs afero.Fs, dir string, file string) error

Types

type GlobalFlags

type GlobalFlags struct {
	Verbose bool
}

func (*GlobalFlags) AddToFlags

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

type KubeConfig

type KubeConfig struct {
	ApiVersion string              `json:"apiVersion"`
	Clusters   []KubeConfigCluster `yaml:"clusters"`
}

type KubeConfigCluster

type KubeConfigCluster struct {
	Name string `yaml:"name"`
}

type MeshctlCluster

type MeshctlCluster struct {
	KubeConfig  string `json:"kubeConfig"`
	KubeContext string `json:"kubeContext"`
	Namespace   string `json:"namespace"`
}

type MeshctlConfig

type MeshctlConfig struct {
	ApiVersion string                    `json:"apiVersion"`
	Clusters   map[string]MeshctlCluster `json:"clusters"`
	// contains filtered or unexported fields
}

func NewMeshctlConfig

func NewMeshctlConfig() MeshctlConfig

new initialized meshctl config

func ParseMeshctlConfig

func ParseMeshctlConfig(meshctlConfigPath string) (MeshctlConfig, error)

parse the meshctl config file into a MeshctlConfig struct If the file doesn't exist or is invalid, return an error

func (MeshctlConfig) AddDataPlaneCluster

func (c MeshctlConfig) AddDataPlaneCluster(name string, kc MeshctlCluster) error

add a data plane cluster config

func (MeshctlConfig) AddMgmtCluster

func (c MeshctlConfig) AddMgmtCluster(kc MeshctlCluster)

add the management cluster config

func (MeshctlConfig) FilePath

func (c MeshctlConfig) FilePath() string

returns the path of the file storing the config

func (MeshctlConfig) IsMgmtCluster

func (c MeshctlConfig) IsMgmtCluster(name string) bool

returns the mgmt meshctl cluster name

func (MeshctlConfig) MgmtCluster

func (c MeshctlConfig) MgmtCluster() MeshctlCluster

returns the mgmt meshctl cluster config

func (MeshctlConfig) RemoteClusters

func (c MeshctlConfig) RemoteClusters() map[string]MeshctlCluster

return cluster names and configs for all remote clusters