broker

Documentation

Overview

Package api is the internal version of the API. +groupName=sdkbroker.broker.k8s.io

Index

• Constants
• Variables
• func DeepCopy_broker_ServiceInstance(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_broker_ServiceInstanceCondition(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_broker_ServiceInstanceList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_broker_ServiceInstanceSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_broker_ServiceInstanceStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func Kind(kind string) schema.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func RegisterDefaults(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type ServiceInstance
• type ServiceInstanceCondition
• type ServiceInstanceConditionType
• type ServiceInstanceList
• type ServiceInstanceSpec
• type ServiceInstanceStatus

Constants

const (
	// ServiceInstanceReady indicates the service instance is Ready for use
	// (provision was successful)
	ServiceInstanceReady ServiceInstanceConditionType = "Ready"

	// ServiceInstanceInstantiateFailed indicates the provision request failed.
	ServiceInstanceFailed ServiceInstanceConditionType = "Failure"

	// TypePackage is the name of the package that defines the resource types
	// used by this broker.
	TypePackage = "github.com/openshift/open-service-broker-sdk/pkg/apis/broker"

	// GroupName is the name of the api group used for resources created/managed
	// by this broker.
	GroupName = "sdkbroker.broker.k8s.io"

	// ServiceInstancesResource is the name of the resource used to represent
	// provision requests(possibly fulfilled) for service instances
	ServiceInstancesResource = "serviceinstances"

	// ServiceInstanceResource is the name of the resource used to represent
	// provision requests(possibly fulfilled) for service instances
	ServiceInstanceResource = "serviceinstance"

	// BrokerAPIPrefix is the route prefix for the open service broker api
	// endpoints (e.g. https://yourhost.com/broker/sdkbroker.broker.io/v2/catalog)
	BrokerAPIPrefix = "/broker/sdkbroker.broker.io"

	// Namespace is the namespace the broker will be deployed in and
	// under which it will create any resources
	Namespace = "brokersdk"
)

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_broker_ServiceInstance

func DeepCopy_broker_ServiceInstance(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_broker_ServiceInstance is an autogenerated deepcopy function.

func DeepCopy_broker_ServiceInstanceCondition

func DeepCopy_broker_ServiceInstanceCondition(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_broker_ServiceInstanceCondition is an autogenerated deepcopy function.

func DeepCopy_broker_ServiceInstanceList

func DeepCopy_broker_ServiceInstanceList(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_broker_ServiceInstanceList is an autogenerated deepcopy function.

func DeepCopy_broker_ServiceInstanceSpec

func DeepCopy_broker_ServiceInstanceSpec(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_broker_ServiceInstanceSpec is an autogenerated deepcopy function.

func DeepCopy_broker_ServiceInstanceStatus

func DeepCopy_broker_ServiceInstanceStatus(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_broker_ServiceInstanceStatus is an autogenerated deepcopy function.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type ServiceInstance

type ServiceInstance struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   ServiceInstanceSpec
	Status ServiceInstanceStatus
}

ServiceInstance represents a service instance provision request, possibly fullfilled.

type ServiceInstanceCondition

type ServiceInstanceCondition struct {
	// Type of the condition, currently Ready or InstantiateFailure.
	Type ServiceInstanceConditionType
	// Status of the condition, one of True, False or Unknown.
	Status kapi.ConditionStatus
	// LastTransitionTime is the last time a condition status transitioned from
	// one state to another.
	LastTransitionTime metav1.Time
	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string
	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string
}

ServiceInstanceCondition contains condition information for a ServiceInstance.

type ServiceInstanceConditionType

type ServiceInstanceConditionType string

ServiceInstanceConditionType is the type of condition pertaining to a ServiceInstance.

type ServiceInstanceList

type ServiceInstanceList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []ServiceInstance
}

ServiceInstanceList is a list of ServiceInstance objects.

type ServiceInstanceSpec

type ServiceInstanceSpec struct {
	Credential string
}

ServiceInstanceSpec defines the requested ServiceInstance

type ServiceInstanceStatus

type ServiceInstanceStatus struct {
	Conditions []ServiceInstanceCondition
}

ServiceInstanceStatus defines the current state of the ServiceInstance