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 {
	// IAPToken returns a valid dsp-tools-k8s IAP token (as a string), or an error
	IAPToken() (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)
	// Google returns a client factory for GCP clients, using Thelma's default configuration
	Google() google.Clients
	// GoogleUsingVaultSA is like Google but allows a vault path/key for the service account key file
	// to be specified directly at runtime
	GoogleUsingVaultSA(string, string) google.Clients
	// GoogleUsingADC is like Google but forces usage of the environment's Application Default Credentials,
	// optionally allowing non-Broad email addresses
	GoogleUsingADC(bool) google.Clients
	// Kubernetes returns a factory for Kubernetes clients
	Kubernetes() kubernetes.Clients
	// Sherlock returns a swagger API client for a sherlock server instance
	Sherlock() (*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)