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 Gloo Admin API. Within the Gloo project, it is used inside of tests.

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 InputSnapshotCmd(ctx context.Context) 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 GetInputSnapshot(ctx context.Context) ([]interface{}, error) {}

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