clients

Documentation

Overview

Package clients contains convenience constructors API clients that Thelma uses

Index

• type Clients
  • func New(thelmaConfig config.Config, thelmaRoot root.Root, ...) (Clients, error)

Types

type Clients

type Clients interface {
	// IAP returns a credentials.TokenProvider for a particular iap.Project's IAP tokens.
	IAP(project iap.Project) (credentials.TokenProvider, error)
	// IAPToken returns a valid iap.Project's IAP token (as a string), or an error.
	// This is a convenience method on top of IAP().
	IAPToken(project iap.Project) (string, error)
	// Vault returns a Vault client for the DSP Vault instance
	Vault() (*vaultapi.Client, error)
	// ArgoCD returns a client for the DSP ArgoCD instance
	ArgoCD() (argocd.ArgoCD, error)
	// Github returns a wrapper around a github api client instance
	Github() (*github.Client, error)
	// Google returns a client factory for GCP clients, using Thelma's default configuration
	Google(options ...google.Option) google.Clients
	// Kubernetes returns a factory for Kubernetes clients
	Kubernetes() kubernetes.Clients
	// Sherlock returns a swagger API client for a sherlock server instance
	Sherlock(options ...sherlock.Option) (sherlock.Client, error)
	// Slack returns a wrapper around the official API client
	Slack() (slack.Slack, error)
}

Clients convenience builders for client objects used in Thelma commands

func New

func New(thelmaConfig config.Config, thelmaRoot root.Root, creds credentials.Credentials, runner shell.Runner) (Clients, error)