sbproxy

Documentation

Index

• Constants
• func AddPFlags(set *pflag.FlagSet)
• func DefaultEnv(ctx context.Context, additionalPFlags ...func(set *pflag.FlagSet)) (env.Environment, error)
• type SMProxy
  • func (p *SMProxy) Run()
• type SMProxyBuilder
  • func New(ctx context.Context, cancel context.CancelFunc, environment env.Environment, ...) (*SMProxyBuilder, error)
  • func (smb *SMProxyBuilder) Build() *SMProxy
  • func (smb *SMProxyBuilder) Security() *osssm.SecurityBuilder
• type Settings
  • func DefaultSettings() *Settings
  • func NewSettings(env env.Environment) (*Settings, error)
  • func (c *Settings) Validate() error

Constants

const (
	// BrokerPathParam for the broker id
	BrokerPathParam = "brokerID"

	// APIPrefix for the Proxy OSB API
	APIPrefix = "/v1/osb"

	// Path for the Proxy OSB API
	Path = APIPrefix + "/{" + BrokerPathParam + "}"
)

Functions

func AddPFlags

func AddPFlags(set *pflag.FlagSet)

AddPFlags adds the SM config flags to the provided flag set

func DefaultEnv

func DefaultEnv(ctx context.Context, additionalPFlags ...func(set *pflag.FlagSet)) (env.Environment, error)

DefaultEnv creates a default environment that can be used to boot up a Service Broker proxy

Types

type SMProxy

type SMProxy struct {
	*server.Server
	// contains filtered or unexported fields
}

SMProxy struct

func (*SMProxy) Run

func (p *SMProxy) Run()

Run starts the proxy

type SMProxyBuilder

type SMProxyBuilder struct {
	*web.API
	// contains filtered or unexported fields
}

SMProxyBuilder type is an extension point that allows adding additional filters, plugins and controllers before running SMProxy.

func New

func New(ctx context.Context, cancel context.CancelFunc, environment env.Environment, settings *Settings, platformClient platform.Client) (*SMProxyBuilder, error)

New creates service broker proxy that is configured from the provided environment and platform client.

func (*SMProxyBuilder) Build

func (smb *SMProxyBuilder) Build() *SMProxy

Build builds the Service Manager

func (*SMProxyBuilder) Security

func (smb *SMProxyBuilder) Security() *osssm.SecurityBuilder

Security returns the ready to use SecurityBuilder

type Settings

type Settings struct {
	Server         *server.Settings                `mapstructure:"server"`
	Log            *log.Settings                   `mapstructure:"log"`
	Sm             *sm.Settings                    `mapstructure:"sm"`
	Reconcile      *reconcile.Settings             `mapstructure:"app"`
	Producer       *notifications.ProducerSettings `mapstructure:"producer"`
	Health         *health.Settings                `mapstructure:"health"`
	Authentication *authn.Settings                 `mapstructure:"authn"`
}

Settings type holds all config properties for the sbproxy

func DefaultSettings

func DefaultSettings() *Settings

DefaultSettings returns default value for the proxy settings

func NewSettings

func NewSettings(env env.Environment) (*Settings, error)

NewSettings creates new proxy settings from the specified environment

func (*Settings) Validate

func (c *Settings) Validate() error

Validate validates that the configuration contains all mandatory properties