broker

type BrokerRegistry map[string]*ServiceDefinition

type BrokerVariable struct {
	// Is this variable required?
	Required bool `yaml:"required,omitempty"`
	// The name of the JSON field this variable serializes/deserializes to
	FieldName string `yaml:"field_name"`
	// The JSONSchema type of the field
	Type JSONType `yaml:"type"`
	// Whether the value can be set to 'null'
	Nullable bool `yaml:"nullable,omitempty"`
	// Human-readable info about the field.
	Details string `yaml:"details"`
	// The default value of the field.
	Default any `yaml:"default,omitempty"`
	// If there are a limited number of valid values for this field then
	// Enum will hold them in value:friendly name pairs
	Enum map[any]string `yaml:"enum,omitempty"`
	// Constraints holds JSON Schema validations defined for this variable.
	// Keys are valid JSON Schema validation keywords, and values are their
	// associated values.
	// http://json-schema.org/latest/json-schema-validation.html
	Constraints     map[string]any `yaml:"constraints,omitempty"`
	ProhibitUpdate  bool           `yaml:"prohibit_update,omitempty"`
	TFAttribute     string         `yaml:"tf_attribute,omitempty"`
	TFAttributeSkip string         `yaml:"tf_attribute_skip,omitempty"`
}

type ImportVariable struct {
	Name       string `yaml:"field_name"`
	Type       string `yaml:"type"`
	Details    string `yaml:"details"`
	TfResource string `yaml:"tf_resource"`
}

type JSONType string

type Service struct {
	domain.Service

	Plans []ServicePlan `json:"plans"`
}

type ServiceDefinition struct {
	ID                  string
	Name                string
	Description         string
	DisplayName         string
	ImageURL            string
	DocumentationURL    string
	ProviderDisplayName string
	SupportURL          string
	Tags                []string
	Bindable            bool
	PlanUpdateable      bool
	Plans               []ServicePlan

	ProvisionInputVariables    []BrokerVariable
	ImportInputVariables       []ImportVariable
	ProvisionComputedVariables []varcontext.DefaultVariable
	BindInputVariables         []BrokerVariable
	BindOutputVariables        []BrokerVariable
	BindComputedVariables      []varcontext.DefaultVariable
	PlanVariables              []BrokerVariable
	Examples                   []ServiceExample
	DefaultRoleWhitelist       []string

	// ProviderBuilder creates a new provider given the project, auth, and logger.
	ProviderBuilder func(plogger lager.Logger, store ServiceProviderStorage) ServiceProvider

	// IsBuiltin is true if the service is built-in to the platform.
	IsBuiltin bool

	GlobalLabels map[string]string
}

type ServiceExample struct {
	// Name is a human-readable name of the example.
	Name string `json:"name" yaml:"name"`
	// Description is a long-form description of what this example is about.
	Description string `json:"description" yaml:"description"`
	// PlanID is the plan this example will run against.
	PlanID string `json:"plan_id" yaml:"plan_id"`

	// ProvisionParams is the JSON object that will be passed to provision.
	ProvisionParams map[string]any `json:"provision_params" yaml:"provision_params"`

	// BindParams is the JSON object that will be passed to bind. If nil,
	// this example DOES NOT include a bind portion.
	BindParams  map[string]any `json:"bind_params" yaml:"bind_params"`
	BindCanFail bool           `json:"bind_can_fail,omitempty" yaml:"bind_can_fail,omitempty"`
}

type ServicePlan struct {
	domain.ServicePlan

	ServiceProperties  map[string]any `json:"service_properties"`
	ProvisionOverrides map[string]any `json:"provision_overrides,omitempty"`
	BindOverrides      map[string]any `json:"bind_overrides,omitempty"`
}

type ServiceProvider interface {
	// Provision creates the necessary resources that an instance of this service
	// needs to operate.
	Provision(ctx context.Context, provisionContext *varcontext.VarContext) (storage.ServiceInstanceDetails, error)

	// Update makes necessary updates to resources so they match new desired configuration
	Update(ctx context.Context, updateContext *varcontext.VarContext) (models.ServiceInstanceDetails, error)

	UpgradeInstance(ctx context.Context, instanceContext *varcontext.VarContext) (*sync.WaitGroup, error)
	UpgradeBindings(ctx context.Context, instanceContext *varcontext.VarContext, bindingContexts []*varcontext.VarContext) error

	// GetImportedProperties extracts properties that should have been saved as part of subsume operation
	GetImportedProperties(ctx context.Context, instanceGUID string, inputVariables []BrokerVariable, initialProperties map[string]any) (map[string]any, error)

	// Bind provisions the necessary resources for a user to be able to connect to the provisioned service.
	// This may include creating service accounts, granting permissions, and adding users to services e.g. a SQL database user.
	// It stores information necessary to access the service _and_ delete the binding in the returned map.
	Bind(ctx context.Context, vc *varcontext.VarContext) (map[string]any, error)

	// Unbind deprovisions the resources created with Bind.
	Unbind(ctx context.Context, instanceGUID, bindingID string, vc *varcontext.VarContext) error

	// Deprovision deprovisions the service.
	// If the deprovision is asynchronous (results in a long-running job), then operationId is returned.
	// If no error and no operationId are returned, then the deprovision is expected to have been completed successfully.
	Deprovision(ctx context.Context, instanceGUID string, vc *varcontext.VarContext) (*string, error)

	PollInstance(ctx context.Context, instanceGUID string) (bool, string, error)

	GetTerraformOutputs(ctx context.Context, instanceGUID string) (storage.JSONObject, error)

	DeleteInstanceData(ctx context.Context, instanceGUID string) error

	DeleteBindingData(ctx context.Context, instanceGUID, bindingID string) error

	CheckUpgradeAvailable(deploymentID string) error

	CheckOperationConstraints(deploymentID string, operationType string) error
}

type ServiceProviderStorage interface {
	StoreTerraformDeployment(t storage.TerraformDeployment) error
	GetTerraformDeployment(id string) (storage.TerraformDeployment, error)
	DeleteTerraformDeployment(id string) error
	ExistsTerraformDeployment(id string) (bool, error)
	GetServiceBindingIDsForServiceInstance(serviceInstanceID string) ([]string, error)
}