clients

Documentation

Index

• Constants
• Variables
• func ArtifactFactoryForSettings(ctx context.Context, settings *v1.Settings, ...) (factory.ResourceClientFactory, error)
• func ConfigFactoryForSettings(params ConfigFactoryParams, resourceCrd crd.Crd) (factory.ResourceClientFactory, error)
• func ConsulClientForSettings(ctx context.Context, settings *v1.Settings) (*consulapi.Client, error)
• func KubeServiceClientForSettings(ctx context.Context, settings *v1.Settings, ...) (skkube.ServiceClient, error)
• func NewMultiSecretResourceClientFactory(params MultiSecretFactoryParams) (factory.ResourceClientFactory, error)
• func NewSecretResourceClientFactory(ctx context.Context, params SecretFactoryParams) (factory.ResourceClientFactory, error)
• func SecretFactoryForSettings(ctx context.Context, params SecretFactoryParams) (factory.ResourceClientFactory, error)
• type ConfigFactoryParams
  • func NewConfigFactoryParams(settings *v1.Settings, sharedCache memory.InMemoryResourceCache, ...) ConfigFactoryParams
• type MultiSecretFactoryParams
• type MultiSecretResourceClient
  • func (m *MultiSecretResourceClient) ApplyStatus(statusClient resources.StatusClient, inputResource resources.InputResource, ...) (resources.Resource, error)
  • func (m *MultiSecretResourceClient) Delete(namespace string, name string, opts clients.DeleteOpts) error
  • func (m *MultiSecretResourceClient) Kind() string
  • func (m *MultiSecretResourceClient) List(namespace string, opts clients.ListOpts) (resources.ResourceList, error)
  • func (m *MultiSecretResourceClient) NewResource() resources.Resource
  • func (m *MultiSecretResourceClient) Read(namespace string, name string, opts clients.ReadOpts) (resources.Resource, error)
  • func (m *MultiSecretResourceClient) Register() error
  • func (m *MultiSecretResourceClient) Watch(namespace string, opts clients.WatchOpts) (<-chan resources.ResourceList, <-chan error, error)
  • func (m *MultiSecretResourceClient) Write(resource resources.Resource, opts clients.WriteOpts) (resources.Resource, error)
• type MultiSecretResourceClientFactory
  • func (m *MultiSecretResourceClientFactory) NewResourceClient(ctx context.Context, params factory.NewResourceClientParams) (clients.ResourceClient, error)
• type SecretFactoryParams
• type SourceList
  • func (s SourceList) Len() int
  • func (s SourceList) Less(i int, j int) bool
  • func (s SourceList) Swap(i int, j int)

Constants

const (
	DefaultRootKey = "gloo" // used for vault and consul key-value storage
)

const SecretSourceAPIVaultClientInitIndex = -1

SecretSourceAPIVaultClientInitIndex is a dedicated index for use of the SecretSource API

Variables

var (
	// ErrNilSourceSlice indicates a nil slice of sources was passed to the factory,
	// and we can therefore not initialize any sub-clients
	ErrNilSourceSlice = errors.New("nil slice of secret sources")

	// ErrEmptySourceSlice indicates the factory held an empty slice of sources while
	// trying to create a new client, and we can therefore not initialize any sub-clients
	ErrEmptySourceSlice = errors.New("empty slice of secret sources")
)

var DefaultConsulQueryOptions = &consulapi.QueryOptions{RequireConsistent: true, AllowStale: false}

DefaultConsulQueryOptions provides default query options for consul

var (
	// ErrNotImplemented indicates a call was made to an interface method which has not been implemented
	ErrNotImplemented = errors.New("interface method not implemented")
)

Functions

func ArtifactFactoryForSettings

func ArtifactFactoryForSettings(ctx context.Context,
	settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cfg **rest.Config,
	clientset *kubernetes.Interface,
	kubeCoreCache *cache.KubeCoreCache,
	consulClient *consulapi.Client,
	pluralName string) (factory.ResourceClientFactory, error)

ArtifactFactoryForSettings constructs a new ResourceClientFactory for Artifacts using Kubernetes, Directory, or Consul. settings.ArtifactSource or sharedCache must be non-nil

func ConfigFactoryForSettings

func ConfigFactoryForSettings(params ConfigFactoryParams, resourceCrd crd.Crd) (factory.ResourceClientFactory, error)

ConfigFactoryForSettings constructs a new ResourceClientFactory for Config using Kubernetes, Directory, or Consul. params.memory.sharedCache, resourceCrd+params.kube.restCfg OR params.consul.consulClient must be non-nil

func ConsulClientForSettings

func ConsulClientForSettings(ctx context.Context, settings *v1.Settings) (*consulapi.Client, error)

ConsulClientForSettings constructs a Consul API client for the configuration provided in the settings parameter.

func KubeServiceClientForSettings

func KubeServiceClientForSettings(ctx context.Context,
	settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cfg **rest.Config,
	clientset *kubernetes.Interface,
	kubeCoreCache *cache.KubeCoreCache) (skkube.ServiceClient, error)

KubeServiceClientForSettings initializes a ServiceClient for the given settings. If we are using Config in Kubernetes, we use a Kubernetes ServiceClient, otherwise we use an in-memory client.

func NewMultiSecretResourceClientFactory

func NewMultiSecretResourceClientFactory(params MultiSecretFactoryParams) (factory.ResourceClientFactory, error)

NewMultiSecretResourceClientFactory returns a resource client factory for a client supporting multiple sources

func NewSecretResourceClientFactory

func NewSecretResourceClientFactory(ctx context.Context, params SecretFactoryParams) (factory.ResourceClientFactory, error)

func SecretFactoryForSettings

func SecretFactoryForSettings(ctx context.Context, params SecretFactoryParams) (factory.ResourceClientFactory, error)

SecretFactoryForSettings creates a resource client factory for provided config. Implemented as secrets.MultiResourceClient iff secretOptions API is configured.

Types

type ConfigFactoryParams

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

func NewConfigFactoryParams

func NewConfigFactoryParams(settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cache kube.SharedCache,
	cfg **rest.Config,
	consulClient *consulapi.Client) ConfigFactoryParams

NewConfigFactoryParams constructs a ConfigFactoryParams to pass into ConfigFactoryForSettings

type MultiSecretFactoryParams

type MultiSecretFactoryParams struct {
	SecretSources      SourceList
	SharedCache        memory.InMemoryResourceCache
	Cfg                **rest.Config
	Clientset          *kubernetes.Interface
	KubeCoreCache      *cache.KubeCoreCache
	VaultClientInitMap map[int]vault.VaultClientInitFunc
}

type MultiSecretResourceClient

type MultiSecretResourceClient struct {
	// guard against concurrent slice access
	*sync.RWMutex
	// contains filtered or unexported fields
}

MultiSecretResourceClient represents a client that is minimally implemented to facilitate Gloo operations. Specifically, only List and Watch are properly implemented.

Direct access to clientList is deliberately omitted to prevent changing clients with an open Watch leading to inconsistent and undefined behavior

func (*MultiSecretResourceClient) ApplyStatus

func (m *MultiSecretResourceClient) ApplyStatus(statusClient resources.StatusClient, inputResource resources.InputResource, opts clients.ApplyStatusOpts) (resources.Resource, error)

func (*MultiSecretResourceClient) Delete

func (m *MultiSecretResourceClient) Delete(namespace string, name string, opts clients.DeleteOpts) error

func (*MultiSecretResourceClient) Kind

func (m *MultiSecretResourceClient) Kind() string

func (*MultiSecretResourceClient) List

func (m *MultiSecretResourceClient) List(namespace string, opts clients.ListOpts) (resources.ResourceList, error)

func (*MultiSecretResourceClient) NewResource

func (m *MultiSecretResourceClient) NewResource() resources.Resource

func (*MultiSecretResourceClient) Read

func (m *MultiSecretResourceClient) Read(namespace string, name string, opts clients.ReadOpts) (resources.Resource, error)

func (*MultiSecretResourceClient) Register

func (m *MultiSecretResourceClient) Register() error

Deprecated: implemented only by the kubernetes resource client. Will be removed from the interface.

func (*MultiSecretResourceClient) Watch

func (m *MultiSecretResourceClient) Watch(namespace string, opts clients.WatchOpts) (<-chan resources.ResourceList, <-chan error, error)

func (*MultiSecretResourceClient) Write

func (m *MultiSecretResourceClient) Write(resource resources.Resource, opts clients.WriteOpts) (resources.Resource, error)

type MultiSecretResourceClientFactory

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

func (*MultiSecretResourceClientFactory) NewResourceClient

func (m *MultiSecretResourceClientFactory) NewResourceClient(ctx context.Context, params factory.NewResourceClientParams) (clients.ResourceClient, error)

NewResourceClient implements ResourceClientFactory by creating a new client with each sub-client initialized

type SecretFactoryParams

type SecretFactoryParams struct {
	Settings           *v1.Settings
	SharedCache        memory.InMemoryResourceCache
	Cfg                **rest.Config
	Clientset          *kubernetes.Interface
	KubeCoreCache      *cache.KubeCoreCache
	VaultClientInitMap map[int]vault.VaultClientInitFunc // map client init funcs to their index in the sources slice
	PluralName         string
}

type SourceList

type SourceList []*v1.Settings_SecretOptions_Source

func (SourceList) Len

func (s SourceList) Len() int

func (SourceList) Less

func (s SourceList) Less(i int, j int) bool

func (SourceList) Swap

func (s SourceList) Swap(i int, j int)