gateclient

Documentation

Index

• func AddAuthHeaders(ctx context.Context, req *http.Request) error
• func Authenticate(output func(string), httpClient *http.Client, endpoint string, ...) (updatedConfig bool, err error)
• func ContextWithAuth(ctx context.Context, auth *auth.Config) (context.Context, error)
• func InitializeHTTPClient(auth *auth.Config) (*http.Client, error)
• type GatewayClient
  • func NewGateClient(ui output.Ui, gateEndpoint, defaultHeaders, configLocation string, ...) (*GatewayClient, error)
  • func (m *GatewayClient) GateEndpoint() string
  • func (m *GatewayClient) RetryTimeout() int

Functions

func AddAuthHeaders

func AddAuthHeaders(ctx context.Context, req *http.Request) error

AddAuthHeaders will use the context variables to set via ContextWithAuth to add any necessary authentication headers to the request.

func Authenticate

func Authenticate(output func(string), httpClient *http.Client, endpoint string, auth *auth.Config) (updatedConfig bool, err error)

Authenticate is helper function to attempt to authenticate with OAuth2, Google Service Account or LDAP as configured in the auth.Config.

func ContextWithAuth

func ContextWithAuth(ctx context.Context, auth *auth.Config) (context.Context, error)

ContextWithAuth will set context variables that maybe necessary for IAP or Basic authentication per-request. This can be used in conjunction with AddAuthHeaders to ensure auth headers from the context are added to all requests.

func InitializeHTTPClient

func InitializeHTTPClient(auth *auth.Config) (*http.Client, error)

InitializeHTTPClient will return an *http.Client configured with optional TLS keys as specified in the auth.Config

Types

type GatewayClient

type GatewayClient struct {

	// Generate Gate Api client.
	*gate.APIClient

	// Spin CLI configuration.
	Config config.Config

	// Context for OAuth2 access token.
	Context context.Context
	// contains filtered or unexported fields
}

GatewayClient is the wrapper with authentication

func NewGateClient

func NewGateClient(ui output.Ui, gateEndpoint, defaultHeaders, configLocation string, ignoreCertErrors bool, ignoreRedirects bool, retryTimeout int) (*GatewayClient, error)

Create new spinnaker gateway client with flag

func (*GatewayClient) GateEndpoint

func (m *GatewayClient) GateEndpoint() string

func (*GatewayClient) RetryTimeout

func (m *GatewayClient) RetryTimeout() int