config

package
v0.20.0-alpha.2 Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2018 License: Apache-2.0 Imports: 10 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthHeaderBuilder 

type AuthHeaderBuilder interface {
	AddAuthHeader(request *http.Request, logger *log.Logger) error
}

type Authentication added in v0.20.0 

type Authentication struct {
	Basic UserCredentials
	UAA   UAAAuthentication
}

func (Authentication) Validate added in v0.20.0 

func (a Authentication) Validate(URLRequired bool) error

type Bosh 

type Bosh struct {
	URL            string `yaml:"url"`
	TrustedCert    string `yaml:"root_ca_cert"`
	Authentication Authentication
}

func (Bosh) NewAuthHeaderBuilder added in v0.17.2 

func (boshConfig Bosh) NewAuthHeaderBuilder(UAAURL string, disableSSLCertVerification bool) (AuthHeaderBuilder, error)

func (Bosh) Validate 

func (b Bosh) Validate() error

type Broker 

type Broker struct {
	Port                       int
	Username                   string
	Password                   string
	DisableSSLCertVerification bool `yaml:"disable_ssl_cert_verification"`
	StartUpBanner              bool `yaml:"startup_banner"`
	ShutdownTimeoutSecs        int  `yaml:"shutdown_timeout_in_seconds"`
	DisableCFStartupChecks     bool `yaml:"disable_cf_startup_checks"`
	ExposeOperationalErrors    bool `yaml:"expose_operational_errors"`
}

func (Broker) Validate 

func (b Broker) Validate() error

type BrokerAPI added in v0.18.0 

type BrokerAPI struct {
	URL            string         `yaml:"url"`
	Authentication Authentication `yaml:"authentication"`
}

type CF 

type CF struct {
	URL            string
	TrustedCert    string `yaml:"root_ca_cert"`
	Authentication Authentication
}

func (CF) NewAuthHeaderBuilder 

func (cf CF) NewAuthHeaderBuilder(disableSSLCertVerification bool) (AuthHeaderBuilder, error)

func (CF) Validate 

func (cf CF) Validate() error

type ClientCredentials 

type ClientCredentials struct {
	ID     string `yaml:"client_id"`
	Secret string `yaml:"client_secret"`
}

func (ClientCredentials) IsSet 

func (cc ClientCredentials) IsSet() bool

func (ClientCredentials) Validate added in v0.20.0 

func (c ClientCredentials) Validate() error

type Config 

type Config struct {
	Broker            Broker
	Bosh              Bosh
	CF                CF
	CredHub           CredHub           `yaml:"credhub"`
	ServiceAdapter    ServiceAdapter    `yaml:"service_adapter"`
	ServiceDeployment ServiceDeployment `yaml:"service_deployment"`
	ServiceCatalog    ServiceOffering   `yaml:"service_catalog"`
}

func Parse 

func Parse(configFilePath string) (Config, error)

func (Config) HasCredHub added in v0.17.2 

func (c Config) HasCredHub() bool

func (Config) Validate 

func (c Config) Validate() error

type CredHub added in v0.17.2 

type CredHub struct {
	APIURL            string `yaml:"api_url"`
	ClientID          string `yaml:"client_id"`
	ClientSecret      string `yaml:"client_secret"`
	CaCert            string `yaml:"ca_cert"`
	InternalUAACaCert string `yaml:"internal_uaa_ca_cert"`
}

type DashboardClient 

type DashboardClient struct {
	ID          string
	Secret      string
	RedirectUri string `yaml:"redirect_uri"`
}

type FieldError added in v0.20.0 

type FieldError struct {
	Field string
	Msg   string
}

func (FieldError) Error added in v0.20.0 

func (f FieldError) Error() string

type Plan 

type Plan struct {
	ID               string `yaml:"plan_id"`
	Name             string
	Free             *bool
	Bindable         *bool
	Description      string
	Metadata         PlanMetadata
	Quotas           Quotas `yaml:"quotas,omitempty"`
	Properties       serviceadapter.Properties
	InstanceGroups   []serviceadapter.InstanceGroup   `yaml:"instance_groups,omitempty"`
	Update           *serviceadapter.Update           `yaml:"update,omitempty"`
	LifecycleErrands *serviceadapter.LifecycleErrands `yaml:"lifecycle_errands,omitempty"`
}

func (Plan) AdapterPlan 

func (p Plan) AdapterPlan(globalProperties serviceadapter.Properties) serviceadapter.Plan

func (Plan) PostDeployErrand 

func (p Plan) PostDeployErrand() string

func (Plan) PostDeployErrandInstances added in v0.18.0 

func (p Plan) PostDeployErrandInstances() []string

func (Plan) PreDeleteErrand 

func (p Plan) PreDeleteErrand() string

func (Plan) PreDeleteErrandInstances added in v0.19.0 

func (p Plan) PreDeleteErrandInstances() []string

type PlanCost 

type PlanCost struct {
	Amount map[string]float64 `yaml:"amount"`
	Unit   string             `yaml:"unit"`
}

type PlanMetadata 

type PlanMetadata struct {
	DisplayName string     `yaml:"display_name"`
	Bullets     []string   `yaml:"bullets,omitempty"`
	Costs       []PlanCost `yaml:"costs"`
}

type Plans 

type Plans []Plan

func (Plans) FindByID 

func (p Plans) FindByID(id string) (Plan, bool)

type Quotas 

type Quotas struct {
	ServiceInstanceLimit *int `yaml:"service_instance_limit,omitempty"`
}

type ServiceAdapter 

type ServiceAdapter struct {
	Path string
}

type ServiceDeployment 

type ServiceDeployment struct {
	Releases serviceadapter.ServiceReleases
	Stemcell serviceadapter.Stemcell
}

func (ServiceDeployment) Validate 

func (s ServiceDeployment) Validate() error

type ServiceInstancesAPI added in v0.18.0 

type ServiceInstancesAPI struct {
	URL            string         `yaml:"url"`
	RootCACert     string         `yaml:"root_ca_cert"`
	Authentication Authentication `yaml:"authentication"`
}

type ServiceMetadata 

type ServiceMetadata struct {
	DisplayName         string `yaml:"display_name"`
	ImageURL            string `yaml:"image_url"`
	LongDescription     string `yaml:"long_description"`
	ProviderDisplayName string `yaml:"provider_display_name"`
	DocumentationURL    string `yaml:"documentation_url"`
	SupportURL          string `yaml:"support_url"`
	Shareable           bool   `yaml:"shareable"`
}

type ServiceOffering 

type ServiceOffering struct {
	ID               string
	Name             string `yaml:"service_name"`
	Description      string `yaml:"service_description"`
	Bindable         bool
	PlanUpdatable    bool     `yaml:"plan_updatable"`
	Requires         []string `yaml:"requires,omitempty"`
	Metadata         ServiceMetadata
	DashboardClient  *DashboardClient `yaml:"dashboard_client,omitempty"`
	Tags             []string
	GlobalProperties serviceadapter.Properties `yaml:"global_properties"`
	GlobalQuotas     Quotas                    `yaml:"global_quotas"`
	Plans            Plans
}

func (ServiceOffering) FindPlanByID 

func (s ServiceOffering) FindPlanByID(id string) (Plan, bool)

func (ServiceOffering) HasLifecycleErrands 

func (s ServiceOffering) HasLifecycleErrands() bool

func (ServiceOffering) Validate added in v0.18.0 

func (s ServiceOffering) Validate() error

type UAAAuthentication 

type UAAAuthentication struct {
	URL               string
	ClientCredentials ClientCredentials `yaml:"client_credentials"`
	UserCredentials   UserCredentials   `yaml:"user_credentials"`
}

func (UAAAuthentication) IsSet 

func (cc UAAAuthentication) IsSet() bool

func (UAAAuthentication) Validate 

func (a UAAAuthentication) Validate(URLRequired bool) error

type UpgradeAllInstanceErrandConfig added in v0.18.0 

type UpgradeAllInstanceErrandConfig struct {
	BrokerAPI           BrokerAPI           `yaml:"broker_api"`
	ServiceInstancesAPI ServiceInstancesAPI `yaml:"service_instances_api"`
	PollingInterval     int                 `yaml:"polling_interval"`
	AttemptInterval     int                 `yaml:"attempt_interval"`
	AttemptLimit        int                 `yaml:"attempt_limit"`
	MaxInFlight         int                 `yaml:"max_in_flight"`
	Canaries            int                 `yaml:"canaries"`
}

type UserCredentials 

type UserCredentials struct {
	Username string
	Password string
}

func (UserCredentials) IsSet 

func (c UserCredentials) IsSet() bool

func (UserCredentials) Validate added in v0.20.0 

func (b UserCredentials) Validate() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.