commands

Documentation

Overview

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Package commands contains all of the cli commands

Index

• func AddSubCommands(cmdName, version, commit string, rootCmd *cobra.Command) *cobra.Command
• func Deploy() *cobra.Command
• func GetConfig() *cobra.Command
• func GetMeshConfig(meshClient *mesh.Client) (*mesh.MeshConfig, error)
• func GetServices() *cobra.Command
• func Help() *cobra.Command
• func Inject() *cobra.Command
• func NewStatusCmd() *cobra.Command
• func NewVersionCmd(cmdName, version, commit string) *cobra.Command
• func ReadYes(msg string) error
• func Remove() *cobra.Command
• func Root(cmdName string) *cobra.Command
• func Setup(cmdName, version, commit string) *cobra.Command
• func Support(version string) *cobra.Command
• func TabWriterWithOpts() *tabwriter.Writer
• func Top() *cobra.Command
• func Upgrade(version string) *cobra.Command

Functions

func AddSubCommands

func AddSubCommands(cmdName, version, commit string, rootCmd *cobra.Command) *cobra.Command

AddSubCommands adds all subcommands to the root command.

func Deploy

func Deploy() *cobra.Command

Deploy deploys the mesh control plane.

func GetConfig

func GetConfig() *cobra.Command

GetConfig displays mesh config.

func GetMeshConfig

func GetMeshConfig(meshClient *mesh.Client) (*mesh.MeshConfig, error)

GetMeshConfig attempts to get the mesh config from mesh-api.

func GetServices

func GetServices() *cobra.Command

GetServices prints the service list fetched from the Control Plane.

func Help

func Help() *cobra.Command

Help defines the output of nginx-meshctl help and nginx-meshctl [command] help. Overrides the default help command in order to keep consistent naming. The Run function is taken straight from the default help command in cobra: https://github.com/spf13/cobra/blob/b04b5bfc50cbb6c036d2115ed55ea1bccdaf82a9/command.go#L1015

func Inject

func Inject() *cobra.Command

Inject injects the sidecar proxy containers into a deployment yaml.

func NewStatusCmd

func NewStatusCmd() *cobra.Command

NewStatusCmd creates a status command to connect to the mesh-api.

func NewVersionCmd

func NewVersionCmd(cmdName, version, commit string) *cobra.Command

NewVersionCmd create a new cobra to handle version.

func ReadYes

func ReadYes(msg string) error

ReadYes reads user input to make a yes/no decision.

func Remove

func Remove() *cobra.Command

Remove removes the service mesh control plane.

func Root

func Root(cmdName string) *cobra.Command

Root command prints usage information.

func Setup

func Setup(cmdName, version, commit string) *cobra.Command

Setup creates the root command and adds all sub commands.

func Support

func Support(version string) *cobra.Command

Support builds a support package containing information about the mesh. Building this package is best-effort. Many errors will be logged but not cause a crash because we want to continue on and attempt to get as much information as possible.

func TabWriterWithOpts

func TabWriterWithOpts() *tabwriter.Writer

TabWriterWithOpts returns a tabwriter. * This call, with these numbers were found across the codebase * and so were centralized here so that modifications to text attributes * could be made from one place.

func Top

func Top() *cobra.Command

Top builds top command for service-mesh-cli.

func Upgrade

func Upgrade(version string) *cobra.Command

Upgrade handles a version upgrade of NGINX Service Mesh.