v1alpha1

package
v3.6.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2017 License: Apache-2.0, Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package v1alpha1 defines all of the versioned (v1alpha1) definitions of the service catalog model. +groupName=servicecatalog.k8s.io

Index

Constants

View Source 
const (
	FinalizerServiceCatalog string = "kubernetes-incubator/service-catalog"
)

These are external finalizer values to service catalog, must be qualified name.

View Source 
const GroupName = "servicecatalog.k8s.io"

GroupName is the group name use in this package

Variables

View Source 
var (
	// SchemeBuilder needs to be exported as `SchemeBuilder` so
	// the code-generation can find it.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addDefaultingFuncs)
	// AddToScheme is exposed for API installation
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_servicecatalog_AlphaPodPresetTemplate_To_v1alpha1_AlphaPodPresetTemplate 

func Convert_servicecatalog_AlphaPodPresetTemplate_To_v1alpha1_AlphaPodPresetTemplate(in *servicecatalog.AlphaPodPresetTemplate, out *AlphaPodPresetTemplate, s conversion.Scope) error

func Convert_servicecatalog_BindingCondition_To_v1alpha1_BindingCondition 

func Convert_servicecatalog_BindingCondition_To_v1alpha1_BindingCondition(in *servicecatalog.BindingCondition, out *BindingCondition, s conversion.Scope) error

func Convert_servicecatalog_BindingList_To_v1alpha1_BindingList 

func Convert_servicecatalog_BindingList_To_v1alpha1_BindingList(in *servicecatalog.BindingList, out *BindingList, s conversion.Scope) error

func Convert_servicecatalog_BindingSpec_To_v1alpha1_BindingSpec 

func Convert_servicecatalog_BindingSpec_To_v1alpha1_BindingSpec(in *servicecatalog.BindingSpec, out *BindingSpec, s conversion.Scope) error

func Convert_servicecatalog_BindingStatus_To_v1alpha1_BindingStatus 

func Convert_servicecatalog_BindingStatus_To_v1alpha1_BindingStatus(in *servicecatalog.BindingStatus, out *BindingStatus, s conversion.Scope) error

func Convert_servicecatalog_Binding_To_v1alpha1_Binding 

func Convert_servicecatalog_Binding_To_v1alpha1_Binding(in *servicecatalog.Binding, out *Binding, s conversion.Scope) error

func Convert_servicecatalog_BrokerAuthInfo_To_v1alpha1_BrokerAuthInfo 

func Convert_servicecatalog_BrokerAuthInfo_To_v1alpha1_BrokerAuthInfo(in *servicecatalog.BrokerAuthInfo, out *BrokerAuthInfo, s conversion.Scope) error

func Convert_servicecatalog_BrokerCondition_To_v1alpha1_BrokerCondition 

func Convert_servicecatalog_BrokerCondition_To_v1alpha1_BrokerCondition(in *servicecatalog.BrokerCondition, out *BrokerCondition, s conversion.Scope) error

func Convert_servicecatalog_BrokerList_To_v1alpha1_BrokerList 

func Convert_servicecatalog_BrokerList_To_v1alpha1_BrokerList(in *servicecatalog.BrokerList, out *BrokerList, s conversion.Scope) error

func Convert_servicecatalog_BrokerSpec_To_v1alpha1_BrokerSpec 

func Convert_servicecatalog_BrokerSpec_To_v1alpha1_BrokerSpec(in *servicecatalog.BrokerSpec, out *BrokerSpec, s conversion.Scope) error

func Convert_servicecatalog_BrokerStatus_To_v1alpha1_BrokerStatus 

func Convert_servicecatalog_BrokerStatus_To_v1alpha1_BrokerStatus(in *servicecatalog.BrokerStatus, out *BrokerStatus, s conversion.Scope) error

func Convert_servicecatalog_Broker_To_v1alpha1_Broker 

func Convert_servicecatalog_Broker_To_v1alpha1_Broker(in *servicecatalog.Broker, out *Broker, s conversion.Scope) error

func Convert_servicecatalog_InstanceCondition_To_v1alpha1_InstanceCondition 

func Convert_servicecatalog_InstanceCondition_To_v1alpha1_InstanceCondition(in *servicecatalog.InstanceCondition, out *InstanceCondition, s conversion.Scope) error

func Convert_servicecatalog_InstanceList_To_v1alpha1_InstanceList 

func Convert_servicecatalog_InstanceList_To_v1alpha1_InstanceList(in *servicecatalog.InstanceList, out *InstanceList, s conversion.Scope) error

func Convert_servicecatalog_InstanceSpec_To_v1alpha1_InstanceSpec 

func Convert_servicecatalog_InstanceSpec_To_v1alpha1_InstanceSpec(in *servicecatalog.InstanceSpec, out *InstanceSpec, s conversion.Scope) error

func Convert_servicecatalog_InstanceStatus_To_v1alpha1_InstanceStatus 

func Convert_servicecatalog_InstanceStatus_To_v1alpha1_InstanceStatus(in *servicecatalog.InstanceStatus, out *InstanceStatus, s conversion.Scope) error

func Convert_servicecatalog_Instance_To_v1alpha1_Instance 

func Convert_servicecatalog_Instance_To_v1alpha1_Instance(in *servicecatalog.Instance, out *Instance, s conversion.Scope) error

func Convert_servicecatalog_ServiceClassList_To_v1alpha1_ServiceClassList 

func Convert_servicecatalog_ServiceClassList_To_v1alpha1_ServiceClassList(in *servicecatalog.ServiceClassList, out *ServiceClassList, s conversion.Scope) error

func Convert_servicecatalog_ServiceClass_To_v1alpha1_ServiceClass 

func Convert_servicecatalog_ServiceClass_To_v1alpha1_ServiceClass(in *servicecatalog.ServiceClass, out *ServiceClass, s conversion.Scope) error

func Convert_servicecatalog_ServicePlan_To_v1alpha1_ServicePlan 

func Convert_servicecatalog_ServicePlan_To_v1alpha1_ServicePlan(in *servicecatalog.ServicePlan, out *ServicePlan, s conversion.Scope) error

func Convert_v1alpha1_AlphaPodPresetTemplate_To_servicecatalog_AlphaPodPresetTemplate 

func Convert_v1alpha1_AlphaPodPresetTemplate_To_servicecatalog_AlphaPodPresetTemplate(in *AlphaPodPresetTemplate, out *servicecatalog.AlphaPodPresetTemplate, s conversion.Scope) error

func Convert_v1alpha1_BindingCondition_To_servicecatalog_BindingCondition 

func Convert_v1alpha1_BindingCondition_To_servicecatalog_BindingCondition(in *BindingCondition, out *servicecatalog.BindingCondition, s conversion.Scope) error

func Convert_v1alpha1_BindingList_To_servicecatalog_BindingList 

func Convert_v1alpha1_BindingList_To_servicecatalog_BindingList(in *BindingList, out *servicecatalog.BindingList, s conversion.Scope) error

func Convert_v1alpha1_BindingSpec_To_servicecatalog_BindingSpec 

func Convert_v1alpha1_BindingSpec_To_servicecatalog_BindingSpec(in *BindingSpec, out *servicecatalog.BindingSpec, s conversion.Scope) error

func Convert_v1alpha1_BindingStatus_To_servicecatalog_BindingStatus 

func Convert_v1alpha1_BindingStatus_To_servicecatalog_BindingStatus(in *BindingStatus, out *servicecatalog.BindingStatus, s conversion.Scope) error

func Convert_v1alpha1_Binding_To_servicecatalog_Binding 

func Convert_v1alpha1_Binding_To_servicecatalog_Binding(in *Binding, out *servicecatalog.Binding, s conversion.Scope) error

func Convert_v1alpha1_BrokerAuthInfo_To_servicecatalog_BrokerAuthInfo 

func Convert_v1alpha1_BrokerAuthInfo_To_servicecatalog_BrokerAuthInfo(in *BrokerAuthInfo, out *servicecatalog.BrokerAuthInfo, s conversion.Scope) error

func Convert_v1alpha1_BrokerCondition_To_servicecatalog_BrokerCondition 

func Convert_v1alpha1_BrokerCondition_To_servicecatalog_BrokerCondition(in *BrokerCondition, out *servicecatalog.BrokerCondition, s conversion.Scope) error

func Convert_v1alpha1_BrokerList_To_servicecatalog_BrokerList 

func Convert_v1alpha1_BrokerList_To_servicecatalog_BrokerList(in *BrokerList, out *servicecatalog.BrokerList, s conversion.Scope) error

func Convert_v1alpha1_BrokerSpec_To_servicecatalog_BrokerSpec 

func Convert_v1alpha1_BrokerSpec_To_servicecatalog_BrokerSpec(in *BrokerSpec, out *servicecatalog.BrokerSpec, s conversion.Scope) error

func Convert_v1alpha1_BrokerStatus_To_servicecatalog_BrokerStatus 

func Convert_v1alpha1_BrokerStatus_To_servicecatalog_BrokerStatus(in *BrokerStatus, out *servicecatalog.BrokerStatus, s conversion.Scope) error

func Convert_v1alpha1_Broker_To_servicecatalog_Broker 

func Convert_v1alpha1_Broker_To_servicecatalog_Broker(in *Broker, out *servicecatalog.Broker, s conversion.Scope) error

func Convert_v1alpha1_InstanceCondition_To_servicecatalog_InstanceCondition 

func Convert_v1alpha1_InstanceCondition_To_servicecatalog_InstanceCondition(in *InstanceCondition, out *servicecatalog.InstanceCondition, s conversion.Scope) error

func Convert_v1alpha1_InstanceList_To_servicecatalog_InstanceList 

func Convert_v1alpha1_InstanceList_To_servicecatalog_InstanceList(in *InstanceList, out *servicecatalog.InstanceList, s conversion.Scope) error

func Convert_v1alpha1_InstanceSpec_To_servicecatalog_InstanceSpec 

func Convert_v1alpha1_InstanceSpec_To_servicecatalog_InstanceSpec(in *InstanceSpec, out *servicecatalog.InstanceSpec, s conversion.Scope) error

func Convert_v1alpha1_InstanceStatus_To_servicecatalog_InstanceStatus 

func Convert_v1alpha1_InstanceStatus_To_servicecatalog_InstanceStatus(in *InstanceStatus, out *servicecatalog.InstanceStatus, s conversion.Scope) error

func Convert_v1alpha1_Instance_To_servicecatalog_Instance 

func Convert_v1alpha1_Instance_To_servicecatalog_Instance(in *Instance, out *servicecatalog.Instance, s conversion.Scope) error

func Convert_v1alpha1_ServiceClassList_To_servicecatalog_ServiceClassList 

func Convert_v1alpha1_ServiceClassList_To_servicecatalog_ServiceClassList(in *ServiceClassList, out *servicecatalog.ServiceClassList, s conversion.Scope) error

func Convert_v1alpha1_ServiceClass_To_servicecatalog_ServiceClass 

func Convert_v1alpha1_ServiceClass_To_servicecatalog_ServiceClass(in *ServiceClass, out *servicecatalog.ServiceClass, s conversion.Scope) error

func Convert_v1alpha1_ServicePlan_To_servicecatalog_ServicePlan 

func Convert_v1alpha1_ServicePlan_To_servicecatalog_ServicePlan(in *ServicePlan, out *servicecatalog.ServicePlan, s conversion.Scope) error

func DeepCopy_v1alpha1_AlphaPodPresetTemplate 

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

func DeepCopy_v1alpha1_Binding 

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

func DeepCopy_v1alpha1_BindingCondition 

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

func DeepCopy_v1alpha1_BindingList 

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

func DeepCopy_v1alpha1_BindingSpec 

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

func DeepCopy_v1alpha1_BindingStatus 

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

func DeepCopy_v1alpha1_Broker 

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

func DeepCopy_v1alpha1_BrokerAuthInfo 

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

func DeepCopy_v1alpha1_BrokerCondition 

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

func DeepCopy_v1alpha1_BrokerList 

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

func DeepCopy_v1alpha1_BrokerSpec 

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

func DeepCopy_v1alpha1_BrokerStatus 

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

func DeepCopy_v1alpha1_Instance 

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

func DeepCopy_v1alpha1_InstanceCondition 

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

func DeepCopy_v1alpha1_InstanceList 

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

func DeepCopy_v1alpha1_InstanceSpec 

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

func DeepCopy_v1alpha1_InstanceStatus 

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

func DeepCopy_v1alpha1_ServiceClass 

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

func DeepCopy_v1alpha1_ServiceClassList 

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

func DeepCopy_v1alpha1_ServicePlan 

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

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterConversions 

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

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 a Group qualified GroupResource

func SetDefaults_BindingSpec 

func SetDefaults_BindingSpec(spec *BindingSpec)

func SetDefaults_InstanceSpec 

func SetDefaults_InstanceSpec(spec *InstanceSpec)

func SetObjectDefaults_Binding 

func SetObjectDefaults_Binding(in *Binding)

func SetObjectDefaults_BindingList 

func SetObjectDefaults_BindingList(in *BindingList)

func SetObjectDefaults_Instance 

func SetObjectDefaults_Instance(in *Instance)

func SetObjectDefaults_InstanceList 

func SetObjectDefaults_InstanceList(in *InstanceList)

Types

type AlphaPodPresetTemplate 

type AlphaPodPresetTemplate struct {
	// Name is the name of the PodPreset to create.
	Name string `json:"name"`
	// Selector is the LabelSelector of the PodPreset to create.
	Selector metav1.LabelSelector `json:"selector"`
}

AlphaPodPresetTemplate represents how a PodPreset should be created for a Binding.

func (*AlphaPodPresetTemplate) CodecDecodeSelf 

func (x *AlphaPodPresetTemplate) CodecDecodeSelf(d *codec1978.Decoder)

func (*AlphaPodPresetTemplate) CodecEncodeSelf 

func (x *AlphaPodPresetTemplate) CodecEncodeSelf(e *codec1978.Encoder)

type Binding 

type Binding struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BindingSpec   `json:"spec"`
	Status BindingStatus `json:"status"`
}

Binding represents a "used by" relationship between an application and an Instance.

func (*Binding) CodecDecodeSelf 

func (x *Binding) CodecDecodeSelf(d *codec1978.Decoder)

func (*Binding) CodecEncodeSelf 

func (x *Binding) CodecEncodeSelf(e *codec1978.Encoder)

type BindingCondition 

type BindingCondition struct {
	// Type of the condition, currently ('Ready').
	Type BindingConditionType `json:"type"`

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus `json:"status"`

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time `json:"lastTransitionTime"`

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string `json:"reason"`

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string `json:"message"`
}

BindingCondition condition information for a Binding.

func (*BindingCondition) CodecDecodeSelf 

func (x *BindingCondition) CodecDecodeSelf(d *codec1978.Decoder)

func (*BindingCondition) CodecEncodeSelf 

func (x *BindingCondition) CodecEncodeSelf(e *codec1978.Encoder)

type BindingConditionType 

type BindingConditionType string

BindingConditionType represents a BindingCondition value. 

const (
	// BindingConditionReady represents a binding condition is in ready state.
	BindingConditionReady BindingConditionType = "Ready"
)

func (*BindingConditionType) CodecDecodeSelf 

func (x *BindingConditionType) CodecDecodeSelf(d *codec1978.Decoder)

func (BindingConditionType) CodecEncodeSelf 

func (x BindingConditionType) CodecEncodeSelf(e *codec1978.Encoder)

type BindingList 

type BindingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Binding `json:"items"`
}

BindingList is a list of Bindings.

func (*BindingList) CodecDecodeSelf 

func (x *BindingList) CodecDecodeSelf(d *codec1978.Decoder)

func (*BindingList) CodecEncodeSelf 

func (x *BindingList) CodecEncodeSelf(e *codec1978.Encoder)

type BindingSpec 

type BindingSpec struct {
	// InstanceRef is the reference to the Instance this Binding is to.
	//
	// Immutable.
	InstanceRef v1.LocalObjectReference `json:"instanceRef"`

	// Parameters is a YAML representation of the properties to be
	// passed to the underlying broker.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// SecretName is the name of the secret to create in the Binding's
	// namespace that will hold the credentials associated with the Binding.
	SecretName string `json:"secretName"`

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string `json:"externalID"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AlphaPodPresetTemplate describes how a PodPreset should be created once
	// the Binding has been made. If supplied, a PodPreset will be created
	// using information in this field once the Binding has been made in the
	// Broker. The PodPreset will use the EnvFrom feature to expose the keys
	// from the Secret (specified by SecretName) that holds the Binding
	// information into Pods.
	//
	// In the future, we will provide a higher degree of control over the PodPreset.
	AlphaPodPresetTemplate *AlphaPodPresetTemplate `json:"alphaPodPresetTemplate,omitempty"`
}

BindingSpec represents the desired state of a Binding.

func (*BindingSpec) CodecDecodeSelf 

func (x *BindingSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*BindingSpec) CodecEncodeSelf 

func (x *BindingSpec) CodecEncodeSelf(e *codec1978.Encoder)

type BindingStatus 

type BindingStatus struct {
	Conditions []BindingCondition `json:"conditions"`

	// Checksum is the checksum of the BindingSpec that was last successfully
	// reconciled against the broker.
	Checksum *string `json:"checksum,omitempty"`
}

BindingStatus represents the current status of a Binding.

func (*BindingStatus) CodecDecodeSelf 

func (x *BindingStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*BindingStatus) CodecEncodeSelf 

func (x *BindingStatus) CodecEncodeSelf(e *codec1978.Encoder)

type Broker 

type Broker struct {
	metav1.TypeMeta `json:",inline"`
	// Non-namespaced.  The name of this resource in etcd is in ObjectMeta.Name.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BrokerSpec   `json:"spec"`
	Status BrokerStatus `json:"status"`
}

Broker represents an entity that provides ServiceClasses for use in the service catalog.

func (*Broker) CodecDecodeSelf 

func (x *Broker) CodecDecodeSelf(d *codec1978.Decoder)

func (*Broker) CodecEncodeSelf 

func (x *Broker) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerAuthInfo 

type BrokerAuthInfo struct {
	// BasicAuthSecret is a reference to a Secret containing auth information the
	// catalog should use to authenticate to this Broker using basic auth.
	BasicAuthSecret *v1.ObjectReference `json:"basicAuthSecret,omitempty"`
}

BrokerAuthInfo is a union type that contains information on one of the authentication methods the the service catalog and brokers may support, according to the OpenServiceBroker API specification (https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md).

Note that we currently restrict a single broker to have only one of these fields set on it.

func (*BrokerAuthInfo) CodecDecodeSelf 

func (x *BrokerAuthInfo) CodecDecodeSelf(d *codec1978.Decoder)

func (*BrokerAuthInfo) CodecEncodeSelf 

func (x *BrokerAuthInfo) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerCondition 

type BrokerCondition struct {
	// Type of the condition, currently ('Ready').
	Type BrokerConditionType `json:"type"`

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus `json:"status"`

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time `json:"lastTransitionTime"`

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string `json:"reason"`

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string `json:"message"`
}

BrokerCondition contains condition information for a Broker.

func (*BrokerCondition) CodecDecodeSelf 

func (x *BrokerCondition) CodecDecodeSelf(d *codec1978.Decoder)

func (*BrokerCondition) CodecEncodeSelf 

func (x *BrokerCondition) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerConditionType 

type BrokerConditionType string

BrokerConditionType represents a broker condition value. 

const (
	// BrokerConditionReady represents the fact that a given broker condition
	// is in ready state.
	BrokerConditionReady BrokerConditionType = "Ready"
)

func (*BrokerConditionType) CodecDecodeSelf 

func (x *BrokerConditionType) CodecDecodeSelf(d *codec1978.Decoder)

func (BrokerConditionType) CodecEncodeSelf 

func (x BrokerConditionType) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerList 

type BrokerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Broker `json:"items"`
}

BrokerList is a list of Brokers.

func (*BrokerList) CodecDecodeSelf 

func (x *BrokerList) CodecDecodeSelf(d *codec1978.Decoder)

func (*BrokerList) CodecEncodeSelf 

func (x *BrokerList) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerSpec 

type BrokerSpec struct {
	// URL is the address used to communicate with the Broker.
	URL string `json:"url"`

	// AuthInfo contains the data that the service catalog should use to authenticate
	// with the Broker.
	AuthInfo *BrokerAuthInfo `json:"authInfo,omitempty"`
}

BrokerSpec represents a description of a Broker.

func (*BrokerSpec) CodecDecodeSelf 

func (x *BrokerSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*BrokerSpec) CodecEncodeSelf 

func (x *BrokerSpec) CodecEncodeSelf(e *codec1978.Encoder)

type BrokerStatus 

type BrokerStatus struct {
	Conditions []BrokerCondition `json:"conditions"`
}

BrokerStatus represents the current status of a Broker.

func (*BrokerStatus) CodecDecodeSelf 

func (x *BrokerStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*BrokerStatus) CodecEncodeSelf 

func (x *BrokerStatus) CodecEncodeSelf(e *codec1978.Encoder)

type ConditionStatus 

type ConditionStatus string

ConditionStatus represents a condition's status. 

const (
	// ConditionTrue represents the fact that a given condition is true
	ConditionTrue ConditionStatus = "True"

	// ConditionFalse represents the fact that a given condition is false
	ConditionFalse ConditionStatus = "False"

	// ConditionUnknown represents the fact that a given condition is unknown
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

func (*ConditionStatus) CodecDecodeSelf 

func (x *ConditionStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (ConditionStatus) CodecEncodeSelf 

func (x ConditionStatus) CodecEncodeSelf(e *codec1978.Encoder)

type Instance 

type Instance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   InstanceSpec   `json:"spec"`
	Status InstanceStatus `json:"status"`
}

Instance represents a provisioned instance of a ServiceClass.

func (*Instance) CodecDecodeSelf 

func (x *Instance) CodecDecodeSelf(d *codec1978.Decoder)

func (*Instance) CodecEncodeSelf 

func (x *Instance) CodecEncodeSelf(e *codec1978.Encoder)

type InstanceCondition 

type InstanceCondition struct {
	// Type of the condition, currently ('Ready').
	Type InstanceConditionType `json:"type"`

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus `json:"status"`

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time `json:"lastTransitionTime"`

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string `json:"reason"`

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string `json:"message"`
}

InstanceCondition contains condition information about an Instance.

func (*InstanceCondition) CodecDecodeSelf 

func (x *InstanceCondition) CodecDecodeSelf(d *codec1978.Decoder)

func (*InstanceCondition) CodecEncodeSelf 

func (x *InstanceCondition) CodecEncodeSelf(e *codec1978.Encoder)

type InstanceConditionType 

type InstanceConditionType string

InstanceConditionType represents a instance condition value. 

const (
	// InstanceConditionReady represents that a given InstanceCondition is in
	// ready state.
	InstanceConditionReady InstanceConditionType = "Ready"
)

func (*InstanceConditionType) CodecDecodeSelf 

func (x *InstanceConditionType) CodecDecodeSelf(d *codec1978.Decoder)

func (InstanceConditionType) CodecEncodeSelf 

func (x InstanceConditionType) CodecEncodeSelf(e *codec1978.Encoder)

type InstanceList 

type InstanceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Instance `json:"items"`
}

InstanceList is a list of instances.

func (*InstanceList) CodecDecodeSelf 

func (x *InstanceList) CodecDecodeSelf(d *codec1978.Decoder)

func (*InstanceList) CodecEncodeSelf 

func (x *InstanceList) CodecEncodeSelf(e *codec1978.Encoder)

type InstanceSpec 

type InstanceSpec struct {
	// ServiceClassName is the reference to the ServiceClass this Instance
	// should be provisioned from.
	//
	// Immutable.
	ServiceClassName string `json:"serviceClassName"`

	// PlanName is the name of the ServicePlan this Instance should be
	// provisioned from.
	PlanName string `json:"planName"`

	// Parameters is a YAML representation of the properties to be
	// passed to the underlying broker.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// ExternalID is the identity of this object for use with the OSB SB API.
	//
	// Immutable.
	ExternalID string `json:"externalID"`
}

InstanceSpec represents the desired state of an Instance.

func (*InstanceSpec) CodecDecodeSelf 

func (x *InstanceSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*InstanceSpec) CodecEncodeSelf 

func (x *InstanceSpec) CodecEncodeSelf(e *codec1978.Encoder)

type InstanceStatus 

type InstanceStatus struct {
	// Conditions is an array of InstanceConditions capturing aspects of an
	// Instance's status.
	Conditions []InstanceCondition `json:"conditions"`

	// AsyncOpInProgress is set to true if there is an ongoing async operation
	// against this Service Instance in progress.
	AsyncOpInProgress bool `json:"asyncOpInProgress"`

	// LastOperation is the string that the broker may have returned when
	// an async operation started, it should be sent back to the broker
	// on poll requests as a query param.
	LastOperation *string `json:"lastOperation,omitempty"`

	// DashboardURL is the URL of a web-based management user interface for
	// the service instance.
	DashboardURL *string `json:"dashboardURL,omitempty"`

	// Checksum is the checksum of the InstanceSpec that was last successfully
	// reconciled against the broker.
	Checksum *string `json:"checksum,omitempty"`
}

InstanceStatus represents the current status of an Instance.

func (*InstanceStatus) CodecDecodeSelf 

func (x *InstanceStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*InstanceStatus) CodecEncodeSelf 

func (x *InstanceStatus) CodecEncodeSelf(e *codec1978.Encoder)

type ServiceClass 

type ServiceClass struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// BrokerName is the reference to the Broker that provides this
	// ServiceClass.
	//
	// Immutable.
	BrokerName string `json:"brokerName"`

	// Description is a short description of this ServiceClass.
	Description string `json:"description"`

	// Bindable indicates whether a user can create bindings to an Instance
	// provisioned from this service. ServicePlan has an optional field called
	// Bindable which overrides the value of this field.
	Bindable bool `json:"bindable"`

	// Plans is the list of ServicePlans for this ServiceClass.  All
	// ServiceClasses have at least one ServicePlan.
	Plans []ServicePlan `json:"plans"`

	// PlanUpdatable indicates whether instances provisioned from this
	// ServiceClass may change ServicePlans after being provisioned.
	PlanUpdatable bool `json:"planUpdatable"`

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string `json:"externalID"`

	// ExternalMetadata is a blob of information about the ServiceClass, meant
	// to be user-facing content and display instructions.  This field may
	// contain platform-specific conventional values.
	ExternalMetadata *runtime.RawExtension `json:"externalMetadata, omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// Tags is a list of strings that represent different classification
	// attributes of the ServiceClass.  These are used in Cloud Foundry in a
	// way similar to Kubernetes labels, but they currently have no special
	// meaning in Kubernetes.
	AlphaTags []string `json:"alphaTags,omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AlphaRequires exposes a list of Cloud Foundry-specific 'permissions'
	// that must be granted to an instance of this service within Cloud
	// Foundry.  These 'permissions' have no meaning within Kubernetes and an
	// Instance provisioned from this ServiceClass will not work correctly.
	AlphaRequires []string `json:"alphaRequires,omitempty"`
}

ServiceClass represents an offering in the service catalog.

func (*ServiceClass) CodecDecodeSelf 

func (x *ServiceClass) CodecDecodeSelf(d *codec1978.Decoder)

func (*ServiceClass) CodecEncodeSelf 

func (x *ServiceClass) CodecEncodeSelf(e *codec1978.Encoder)

type ServiceClassList 

type ServiceClassList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []ServiceClass `json:"items"`
}

ServiceClassList is a list of ServiceClasses.

func (*ServiceClassList) CodecDecodeSelf 

func (x *ServiceClassList) CodecDecodeSelf(d *codec1978.Decoder)

func (*ServiceClassList) CodecEncodeSelf 

func (x *ServiceClassList) CodecEncodeSelf(e *codec1978.Encoder)

type ServicePlan 

type ServicePlan struct {
	// Name is the CLI-friendly name of this ServicePlan.
	Name string `json:"name"`

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string `json:"externalID"`

	// Description is a short description of this ServicePlan.
	Description string `json:"description"`

	// Bindable indicates whether a user can create bindings to an Instance
	// using this ServicePlan.  If set, overrides the value of the
	// ServiceClass.Bindable field.
	Bindable *bool `json:"bindable,omitempty"`

	// Free indicates whether this plan is available at no cost.
	Free bool `json:"free"`

	// ExternalMetadata is a blob of information about the plan, meant to be
	// user-facing content and display instructions.  This field may contain
	// platform-specific conventional values.
	ExternalMetadata *runtime.RawExtension `json:"externalMetadata, omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AlphaInstanceCreateParameterSchema is the schema for the parameters
	// that may be supplied when provisioning a new Instance on this plan.
	AlphaInstanceCreateParameterSchema *runtime.RawExtension `json:"alphaInstanceCreateParameterSchema,omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AlphaInstanceUpdateParameterSchema is the schema for the parameters
	// that may be updated once an Instance has been provisioned on this plan.
	// This field only has meaning if the ServiceClass is PlanUpdatable.
	AlphaInstanceUpdateParameterSchema *runtime.RawExtension `json:"alphaInstanceUpdateParameterSchema,omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AlphaBindingCreateParameterSchema is the schema for the parameters that
	// may be supplied binding to an Instance on this plan.
	AlphaBindingCreateParameterSchema *runtime.RawExtension `json:"alphaBindingCreateParameterSchema,omitempty"`
}

ServicePlan represents a tier of a ServiceClass.

func (*ServicePlan) CodecDecodeSelf 

func (x *ServicePlan) CodecDecodeSelf(d *codec1978.Decoder)

func (*ServicePlan) CodecEncodeSelf 

func (x *ServicePlan) CodecEncodeSelf(e *codec1978.Encoder)

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.