clients

package
v1.1.38 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2024 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package clients contains convenience constructors API clients that Thelma uses

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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)

Directories

Path Synopsis
Package api contains interfaces for client factories in the clients package.
Package api contains interfaces for client factories in the clients package.
gha
bucket/testing/assert
Package assert contains helper functions for making Testify assertions about objects in GCS buckets.
Package assert contains helper functions for making Testify assertions about objects in GCS buckets.
testing
Package testing provides utilities for testing code that requires a Vault client
Package testing provides utilities for testing code that requires a Vault client

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL