adapter

package
v1.0.0-beta.4 Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2018 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Overview

Copyright 2018 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package adapter contains the interface to create/delete/list resources as well as various implementations using different protocols.

Index

Constants

View Source 
const (
	OperationSucceeded  = "succeeded"
	OperationFailed     = "failed"
	OperationInProgress = "in progress"
)

A list of constants to represent all the states of OSB operations.

Variables

This section is empty.

Functions

This section is empty.

Types

type Adapter 

type Adapter interface {
	// Admin methods.
	CreateBroker(params *CreateBrokerParams) (*osb.Broker, error)
	DeleteBroker(params *DeleteBrokerParams) error
	ListInstances(params *ListInstancesParams) (*ListInstancesResult, error)
	ListBindings(params *ListBindingsParams) (*ListBindingsResult, error)
	ListBrokers(params *ListBrokersParams) (*ListBrokersResult, error)

	// OSB APIs.
	GetCatalog(params *GetCatalogParams) (*GetCatalogResult, error)
	CreateInstance(params *CreateInstanceParams) (*CreateInstanceResult, error)
	DeleteInstance(params *DeleteInstanceParams) (*DeleteInstanceResult, error)
	UpdateInstance(params *UpdateInstanceParams) (*UpdateInstanceResult, error)
	InstanceLastOperation(params *InstanceLastOperationParams) (*Operation, error)
	CreateBinding(params *CreateBindingParams) (*CreateBindingResult, error)
	DeleteBinding(params *DeleteBindingParams) (*DeleteBindingResult, error)
	BindingLastOperation(params *BindingLastOperationParams) (*Operation, error)
}

Adapter is the interface to connect to service brokers and the admin service.

func NewHttpAdapter 

func NewHttpAdapter(client DoClient) Adapter

NewHttpAdapter returns an Adapter which uses the given client.

type BindingLastOperationParams 

type BindingLastOperationParams struct {
	// Server is the URL for the broker.
	Server string
	// InstanceID is the instance that the binding binds to.
	InstanceID string
	// BindingID is the service binding to query the last operation for.
	BindingID string
	// LastOperationParams contains the common params used to poll last operation of the resource.
	*LastOperationParams
}

BindingLastOperation stores the parameters used to poll the last operation of a service binding.

type BrokerError 

type BrokerError struct {
	// StatusCode is the HTTP status code returned by the broker.
	StatusCode int
	// ErrorDescription describes the failed result of the request.
	ErrorDescription string
	// ErrorBody is the response body returned by the broker.
	ErrorBody string
}

BrokerError is the result of a failed broker request.

func (*BrokerError) Error 

func (e *BrokerError) Error() string

Error is the method inherited from "error" interface to print the error.

type CreateBindingParams 

type CreateBindingParams struct {
	// Server is the URL for the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// AcceptsIncomplete indicates whether the client can accept asynchronous provisioning.  If the
	// broker does not support synchronous/asynchronous provisioning of a service, it will reject a
	// request with this field set to false/true respectively.
	AcceptsIncomplete bool
	// InstanceID is the ID of the service instance to bind to.
	InstanceID string
	// BindingID is the ID of the service binding to be created. The Open Service Broker API
	// specification recommends using a GUID for this field.
	BindingID string
	// ServiceID is the ID of the service to use for the service binding.
	ServiceID string
	// PlanID is the ID of the plan to use for the service binding.
	PlanID string
	// Context is the contextual information under which the service binding is to be created.
	Context map[string]interface{}
	// AppGUID is the GUID of an application associated with the binding to be created. Optional.
	AppGUID string
	// BindResource holds extra information about platform resources associated with the binding to
	// be created. CF-specific. Optional.
	BindResource map[string]interface{}
	// Parameters is a set of configuration options for the service binding. Optional.
	Parameters map[string]interface{}
}

CreateBindingParams stores the parameters used to create a binding.

type CreateBindingResult 

type CreateBindingResult struct {
	// Async indicates whether the broker is handling the bind request asynchronously.
	Async bool
	// Credentials is a free-form hash of credentials that can be used by applications or users to
	// access the service.
	Credentials map[string]interface{}
	// SyslogDrainURl is a URL to which logs must be streamed. CF-specific. May only be supplied by a
	// service that declares a requirement for the 'syslog_drain' permission.
	SyslogDrainURL *string
	// RouteServiceURL is a URL to which the platform must proxy requests to the application the
	// binding is for. CF-specific. May only be supplied by a service that declares a requirement for
	// the 'route_service' permission.
	RouteServiceURL *string
	// VolumeMounts is an array of configuration string for mounting volumes. CF-specific. May only be
	// supplied by a service that declares a requirement for the 'volume_mount' permission.
	VolumeMounts []interface{}
	// OperationID is an extra identifier supplied by the broker to identify asynchronous operations.
	// It should be an empty string if the request is completed synchronously.
	OperationID string
}

CreateBindingResult is the result of a successful binding creation request.

type CreateBrokerParams 

type CreateBrokerParams struct {
	Host    string
	Project string
	Name    string
	Title   string
}

CreateBrokerParams is used as input to CreateBroker.

type CreateInstanceParams 

type CreateInstanceParams struct {
	// Server is the URL for the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// AcceptsIncomplete indicates whether the client can accept asynchronous provisioning.  If the
	// broker does not support synchronous/asynchronous provisioning of a service, it will reject a
	// request with this field set to false/true respectively.
	AcceptsIncomplete bool
	// InstanceID is the ID of the service instance. The Open Service Broker API specification
	// recommends using a GUID for this field.
	InstanceID string
	// ServiceID is the ID of the service to use for the service instance.
	ServiceID string
	// PlanID is the ID of the plan to use for the service instance.
	PlanID string
	// Context is platform-specific contextual information under which the service instance is to be
	// provisioned. Context was added in version 2.12 of the OSB API and is only sent for versions
	// 2.12 or later. Optional.
	Context map[string]interface{}
	// OrganizationGUID is the platform GUID for the organization under which the service plan is to
	// be provisioned. CF-specific. Optional.
	OrganizationGUID string
	// SpaceGUID is the identifier for the project space within the platform organization.
	// CF-specific. Optional.
	SpaceGUID string
	// Parameters is a set of configuration options for the service instance. Optional.
	Parameters map[string]interface{}
}

CreateInstanceParams stores the parameters used to create an instance.

type CreateInstanceResult 

type CreateInstanceResult struct {
	// Async indicates whether the broker is handling the provision request asynchronously.
	Async bool
	// DashboardURL is the URL of a web-based management user interface for the service instance.
	DashboardURL string
	// OperationID is an extra identifier supplied by the broker to identify asynchronous operations.
	// It should be an empty string if the request is completed synchronously.
	OperationID string
}

CreateInstanceResult is the result of a successful instance creation request.

type DeleteBindingParams 

type DeleteBindingParams struct {
	// Server is the URL for the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// AcceptsIncomplete indicates whether the client can accept asynchronous provisioning.  If the
	// broker does not support synchronous/asynchronous provisioning of a service, it will reject a
	// request with this field set to false/true respectively.
	AcceptsIncomplete bool
	// InstanceID is the ID of the service instance to bind to.
	InstanceID string
	// BindingID is the ID of the service binding to be created. The Open Service Broker API
	// specification recommends using a GUID for this field.
	BindingID string
	// ServiceID is the ID of the service to use for the service binding.
	ServiceID string
	// PlanID is the ID of the plan to use for the service binding.
	PlanID string
}

DeleteBindingParams stores the parameters used to delete a binding.

type DeleteBindingResult 

type DeleteBindingResult struct {
	// Async indicates whether the broker is handling the bind request asynchronously.
	Async bool
	// OperationID is an extra identifier supplied by the broker to identify asynchronous operations.
	// It should be an empty string if the request is completed synchronously.
	OperationID string
}

DeleteBindingResult is the result of a successful binding deletion request.

type DeleteBrokerParams 

type DeleteBrokerParams struct {
	BrokerURL string
}

DeleteBrokerParams is used as input to DeleteBroker.

type DeleteInstanceParams 

type DeleteInstanceParams struct {
	// Server is the URL for the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// AcceptsIncomplete indicates whether the client can accept asynchronous provisioning.  If the
	// broker does not support synchronous/asynchronous provisioning of a service, it will reject a
	// request with this field set to false/true respectively.
	AcceptsIncomplete bool
	// InstanceID is the ID of the service instance.  The Open Service Broker API specification
	// recommends using a GUID for this field.
	InstanceID string
	// ServiceID is the ID of the service to use for the service instance.
	ServiceID string
	// PlanID is the ID of the plan to use for the service instance.
	PlanID string
}

DeleteInstanceParams stores the parameters used to delete an instance.

type DeleteInstanceResult 

type DeleteInstanceResult struct {
	// Async indicates whether the broker is handling the deprovision request asynchronously.
	Async bool
	// OperationID is an extra identifier supplied by the broker to identify asynchronous operations.
	// It should be an empty string if the request is completed synchronously.
	OperationID string
}

DeleteInstanceResult is the result of a successful instance deletion request.

type DoClient 

type DoClient interface {
	Do(*http.Request) (*http.Response, error)
}

type GetCatalogParams 

type GetCatalogParams struct {
	// Server is URL of the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
}

GetCatalogParams is used as input to GetCatalog.

type GetCatalogResult 

type GetCatalogResult struct {
	Services []osb.Service
}

GetCatalogResult is output of successful GetCatalog request.

type InstanceLastOperationParams 

type InstanceLastOperationParams struct {
	// Server is the URL for the broker.
	Server string
	// InstanceID is the instance of the service to query the last operation for.
	InstanceID string
	// LastOperationParams contains the common params used to poll last operation of the resource.
	*LastOperationParams
}

InstanceLastOperation stores the parameters used to poll the last operation of a service instance.

type LastOperationParams 

type LastOperationParams struct {
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// ServiceID is the ID of the service that the resource is created from. Optional, but recommended.
	ServiceID string
	// PlanID is the ID of the plan that the resource is created from. Optional, but recommended.
	PlanID string
	// OperationID is the operation ID provided by the broker in the response to the initial request.
	// Optional, but must be sent if supplied in the response to the original request.
	OperationID string
	// OperationType is one of Create, Update or Delete.
	OperationType OperationType
}

LastOperationParams contains the common params used to poll last operation of the resource.

type ListBindingsParams 

type ListBindingsParams struct {
	// Server is the URL for the broker.
	Server string
	// UUID representing the instance.
	InstanceID string
}

ListBindingsParams stores the parameters used to list bindings to an instance.

type ListBindingsResult 

type ListBindingsResult struct {
	Bindings []*osb.Binding `json:"bindings"`
}

ListBindingsResult is the output from ListBindings.

type ListBrokersParams 

type ListBrokersParams struct {
	Host    string
	Project string
}

ListBrokersParams is used as input to ListBrokers.

type ListBrokersResult 

type ListBrokersResult struct {
	Brokers []osb.Broker `json:"brokers"`
}

ListBrokersResult is the output from ListBrokers.

type ListInstancesParams 

type ListInstancesParams struct {
	// Server is the URL for the broker.
	Server string
}

ListInstancesParams stores the parameters used to list instances in a broker.

type ListInstancesResult 

type ListInstancesResult struct {
	Instances []*osb.Instance `json:"instances"`
}

ListInstancesResult is the output from ListInstances.

type Operation 

type Operation struct {
	// State is the state of the queried operation.
	State string
	// Description is a message from the broker describing the current state of the operation.
	Description string
}

Operation is the result of a successful operation polling request.

type OperationType 

type OperationType int

OperationType is the enum to represent all the types of OSB operations. 

const (
	OperationCreate OperationType = iota
	OperationUpdate
	OperationDelete
	OperationUnknown
)

type UpdateInstanceParams 

type UpdateInstanceParams struct {
	// Server is the URL for the broker.
	Server string
	// APIVersion is the header value associated with the version of the Open Service Broker API used
	// by the request.
	APIVersion string
	// AcceptsIncomplete indicates whether the client can accept asynchronous update. If the broker
	// does not support synchronous/asynchronous update of an instance, it will reject a request with
	// this field set to false/true respectively.
	AcceptsIncomplete bool
	// InstanceID is the ID of a previously provisioned service instance.
	InstanceID string
	// ServiceID is the ID of the service provisioned by the service instance.
	ServiceID string
	// PlanID is the ID of the plan to use for the service instance.
	PlanID string
	// Context is the contextual data under which the service instance is created.
	Context map[string]interface{}
	// Parameters is the configuration options for the service instance.
	Parameters map[string]interface{}
	// PreviousServiceID is the ID of the service provisioned by the service instance.
	PreviousServiceID string
	// PreviousPlanID is the ID of the plan prior to the update.
	PreviousPlanID string
	// PreviousOrganizationID is the ID of the organization specified for the service instance.
	PreviousOrganizationID string
	// PreviousSpaceID is the ID of the space specified for the service instance.
	PreviousSpaceID string
}

UpdateInstanceParams stores the parameters used to update an instance.

type UpdateInstanceResult 

type UpdateInstanceResult struct {
	// Async indicates whether the broker is handling the update request asynchronously.
	Async bool
	// OperationID is an extra identifier supplied by the broker to identify asynchronous operations.
	// It should be an empty string if the request is completed synchronously.
	OperationID string
}

UpdateInstanceResult is the result of a successful instance update request.

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.