rest

Documentation

Overview

Package rest provides methods and functions to communicate with the MarbleRun Coordinator using its REST API.

Index

• Constants
• func VerifyCoordinator(ctx context.Context, out io.Writer, host, configFilename string, insecure bool, ...) ([]*pem.Block, error)
• type Client
  • func NewAuthenticatedClient(cmd *cobra.Command, host string) (*Client, error)
  • func NewClient(cmd *cobra.Command, host string) (*Client, error)
  • func (c *Client) Get(ctx context.Context, path string, body io.Reader, queryParameters ...string) ([]byte, error)
  • func (c *Client) Post(ctx context.Context, path, contentType string, body io.Reader) ([]byte, error)
• type Flags
  • func ParseFlags(cmd *cobra.Command) (Flags, error)

Constants

const (
	ManifestEndpoint     = "manifest"
	UpdateEndpoint       = "update"
	UpdateCancelEndpoint = "update-cancel"
	UpdateStatusEndpoint = "update-manifest"
	RecoverEndpoint      = "recover"
	SecretEndpoint       = "secrets"
	StatusEndpoint       = "status"
	ContentJSON          = "application/json"
	ContentPlain         = "text/plain"
)

Endpoints of the MarbleRun Coordinator REST API.

Functions

func VerifyCoordinator

func VerifyCoordinator(
	ctx context.Context, out io.Writer, host, configFilename string,
	insecure bool, acceptedTCBStatuses []string,
) ([]*pem.Block, error)

VerifyCoordinator verifies the connection to the MarbleRun Coordinator.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a REST client for the MarbleRun Coordinator.

func NewAuthenticatedClient

func NewAuthenticatedClient(cmd *cobra.Command, host string) (*Client, error)

NewAuthenticatedClient creates and returns an http client with client authentication using the flags of cmd.

func NewClient

func NewClient(cmd *cobra.Command, host string) (*Client, error)

NewClient creates and returns an http client using the flags of cmd.

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, body io.Reader, queryParameters ...string) ([]byte, error)

Get sends a GET request to the Coordinator under the specified path. If body is non nil, it is sent as the request body. Query parameters can be provided as a list of strings, where each pair of strings is a key-value pair. On success, the data field of the JSON response is returned.

func (*Client) Post

func (c *Client) Post(ctx context.Context, path, contentType string, body io.Reader) ([]byte, error)

Post sends a POST request to the Coordinator under the specified path. Optionally, a body can be provided.

type Flags

type Flags struct {
	EraConfig           string
	Insecure            bool
	AcceptedTCBStatuses []string
}

Flags are command line flags used to configure the REST client.

func ParseFlags

func ParseFlags(cmd *cobra.Command) (Flags, error)

ParseFlags parses the command line flags used to configure the REST client.