Admincli

Warning This code is not intended to be used within the Control Plane.

Client

This is the Go client that should be used whenever communicating with the Envoy Admin API. Within the Gloo project, it is used inside of tests and our CLI.

Philosophy

We expose methods that return a Command which can be run by the calling code. Any methods that fit this structure, should end in Cmd:

func StatsCmd(ctx context.Context, queryParams map[string]string) cmdutils.Cmd {}

There are also methods that the client exposes which are syntactic sugar on top of this command API. These methods tend to follow the naming convention: GetX:

func GetStats(ctx context.Context, queryParams map[string]string) (string, error) {}

As a general practice, these methods should return a concrete type, whenever possible.

# Functions

GetStaticClustersByName

GetStaticClustersByName returns a map of static clusters, indexed by their name If there are no static clusters present, an empty map is returned An error is returned if any conversion fails.

NewClient

NewClient returns an implementation of the admincli.Client.

NewPortForwardedClient

NewPortForwardedClient takes a pod selector like <podname> or `deployment/<podname`, and returns a port-forwarded Envoy admin client pointing at that pod, as well as a deferrable shutdown function.

# Constants

ClustersPath