config

Documentation

Overview

Package config provides open service broker configuration abstraction.

Index

• Constants
• Variables
• func Clients() client.Clients
• func Config() *v1.ServiceBrokerConfig
• func Configure(clients client.Clients, namespace string) error
• func Lock()
• func Unlock()

Constants

const (
	// ConfigurationNameDefault is the default configuration name.
	ConfigurationNameDefault = "couchbase-service-broker"
)

Variables

var (
	// ConfigurationName is the configuration resource name.
	// This has a default for the benfit of testing, it is overidden
	// by flags for the main binary.
	ConfigurationName = ConfigurationNameDefault

	// ErrCacheSync is raised when a shared informer failed to synchronize.
	ErrCacheSync = errors.New("cache synchronization error")
)

var ErrConfigurationInvalid = errors.New("configuration is invalid")

ErrConfigurationInvalid is a generic configuration error.

Functions

func Clients

func Clients() client.Clients

Clients returns a set of Kubernetes clients.

func Config

func Config() *v1.ServiceBrokerConfig

Config returns the user specified custom resource.

func Configure

func Configure(clients client.Clients, namespace string) error

Configure initializes global configuration and must be called before starting the API service.

func Lock

func Lock()

Lock puts a read lock on the configuration during the lifetime of a request.

func Unlock

func Unlock()

Unlock releases the read lock on the configuration after a request has completed.