v1beta1

package
v0.5.2 Latest Latest
Warning

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

 Go to latest Published: Oct 30, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	// BasicAuthUsernameKey is the key of the username for SecretTypeBasicAuth secrets
	BasicAuthUsernameKey = "username"
	// BasicAuthPasswordKey is the key of the password or token for SecretTypeBasicAuth secrets
	BasicAuthPasswordKey = "password"

	// BearerTokenKey is the key of the bearer token for SecretTypeBearerTokenAuth secrets
	BearerTokenKey = "token"
)
View Source 
const (
	// Name field.
	FilterName = "name"
	// SpecExternalName is the external name of the object.
	FilterSpecExternalName = "spec.externalName"
	// SpecExternalID is the external id of the object.
	FilterSpecExternalID = "spec.externalID"

	FilterSpecServiceBrokerName = "spec.serviceBrokerName"
	// SpecClusterServiceBrokerName is used for ClusterServiceClasses, the parent service broker name.
	FilterSpecClusterServiceBrokerName = "spec.clusterServiceBrokerName"

	// SpecServiceClassName is only used for plans, the parent service class name.
	FilterSpecServiceClassName = "spec.serviceClass.name"
	// SpecClusterServiceClassName is only used for plans, the parent service class name.
	FilterSpecClusterServiceClassName = "spec.clusterServiceClass.name"
	// SpecClusterServiceClassRefName is only used for plans, the parent service class name.
	FilterSpecServiceClassRefName = "spec.serviceClassRef.name"
	// SpecClusterServiceClassRefName is only used for plans, the parent service class name.
	FilterSpecClusterServiceClassRefName = "spec.clusterServiceClassRef.name"

	// SpecServicePlanRefName is only used for instances.
	FilterSpecServicePlanRefName = "spec.servicePlanRef.name"
	// SpecClusterServiceClassRefName is only used for instances.
	FilterSpecClusterServicePlanRefName = "spec.clusterServicePlanRef.name"

	// FilterSpecFree is only used for plans, determines if the plan is free.
	FilterSpecFree = "spec.free"
)

Filter path for Properties

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)

	// AddToScheme is exposed for API installation
	AddToScheme = SchemeBuilder.AddToScheme

	//SchemeBuilderRuntime maps go types to Kubernetes GroupVersionKinds.
	SchemeBuilderRuntime = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func ConvertClusterServiceClassToProperties 

func ConvertClusterServiceClassToProperties(serviceClass *ClusterServiceClass) filter.Properties

ConvertClusterServiceClassToProperties takes a Service Class and pulls out the properties we support for filtering, converting them into a map in the expected format.

func ConvertClusterServicePlanToProperties 

func ConvertClusterServicePlanToProperties(servicePlan *ClusterServicePlan) filter.Properties

ConvertClusterServicePlanToProperties takes a Service Plan and pulls out the properties we support for filtering, converting them into a map in the expected format.

func ConvertServiceClassToProperties 

func ConvertServiceClassToProperties(serviceClass *ServiceClass) filter.Properties

ConvertServiceClassToProperties takes a Service Class and pulls out the properties we support for filtering, converting them into a map in the expected format.

func ConvertServicePlanToProperties 

func ConvertServicePlanToProperties(servicePlan *ServicePlan) filter.Properties

ConvertServicePlanToProperties takes a Service Plan and pulls out the properties we support for filtering, converting them into a map in the expected format.

func IsValidClusterServiceClassProperty 

func IsValidClusterServiceClassProperty(p string) bool

IsValidClusterServiceClassProperty returns true if the specified property is a valid filterable property of ClusterServiceClasses

func IsValidClusterServicePlanProperty 

func IsValidClusterServicePlanProperty(p string) bool

IsValidClusterServicePlanProperty returns true if the specified property is a valid filterable property of ServicePlans

func IsValidServiceClassProperty 

func IsValidServiceClassProperty(p string) bool

IsValidServiceClassProperty returns true if the specified property is a valid filterable property of ServiceClasses

func IsValidServicePlanProperty 

func IsValidServicePlanProperty(p string) bool

IsValidServicePlanProperty returns true if the specified property is a valid filterable property of ServicePlans

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AddKeyTransform 

type AddKeyTransform struct {
	// The name of the key to add
	Key string `json:"key"`
	// The binary value (possibly non-string) to add to the Secret under the specified key. If both
	// value and stringValue are specified, then value is ignored and stringValue is stored.
	Value []byte `json:"value"`
	// The string (non-binary) value to add to the Secret under the specified key.
	StringValue *string `json:"stringValue"`
	// The JSONPath expression, the result of which will be added to the Secret under the specified key.
	// For example, given the following credentials:
	// { "foo": { "bar": "foobar" } }
	// and the jsonPathExpression "{.foo.bar}", the value "foobar" will be
	// stored in the credentials Secret under the specified key.
	JSONPathExpression *string `json:"jsonPathExpression"`
}

AddKeyTransform specifies that Service Catalog should add an additional entry to the Secret associated with the ServiceBinding. For example, given the following AddKeyTransform: 

{"key": "CONNECTION_POOL_SIZE", "stringValue": "10"}

the following entry will appear in the Secret: 

"CONNECTION_POOL_SIZE": "10"

Note that this transform should only be used to add non-sensitive (non-secret) values. To add sensitive information, the AddKeysFromTransform should be used instead.

func (*AddKeyTransform) DeepCopy 

func (in *AddKeyTransform) DeepCopy() *AddKeyTransform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddKeyTransform.

func (*AddKeyTransform) DeepCopyInto 

func (in *AddKeyTransform) DeepCopyInto(out *AddKeyTransform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AddKeysFromTransform 

type AddKeysFromTransform struct {
	// The reference to the Secret that should be merged into the credentials Secret.
	SecretRef *ObjectReference `json:"secretRef,omitempty"`
}

AddKeysFromTransform specifies that Service Catalog should merge an existing secret into the Secret associated with the ServiceBinding. For example, given the following AddKeysFromTransform: 

{"secretRef": {"namespace": "foo", "name": "bar"}}

the entries of the Secret "bar" from Namespace "foo" will be merged into the credentials Secret.

func (*AddKeysFromTransform) DeepCopy 

func (in *AddKeysFromTransform) DeepCopy() *AddKeysFromTransform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddKeysFromTransform.

func (*AddKeysFromTransform) DeepCopyInto 

func (in *AddKeysFromTransform) DeepCopyInto(out *AddKeysFromTransform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BasicAuthConfig 

type BasicAuthConfig struct {
	// SecretRef is a reference to a Secret containing information the
	// catalog should use to authenticate to this ServiceBroker.
	//
	// Required at least one of the fields:
	// - Secret.Data["username"] - username used for authentication
	// - Secret.Data["password"] - password or token needed for authentication
	SecretRef *LocalObjectReference `json:"secretRef,omitempty"`
}

BasicAuthConfig provides config for the basic authentication of cluster scoped brokers.

func (*BasicAuthConfig) DeepCopy 

func (in *BasicAuthConfig) DeepCopy() *BasicAuthConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BasicAuthConfig.

func (*BasicAuthConfig) DeepCopyInto 

func (in *BasicAuthConfig) DeepCopyInto(out *BasicAuthConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BearerTokenAuthConfig 

type BearerTokenAuthConfig struct {
	// SecretRef is a reference to a Secret containing information the
	// catalog should use to authenticate to this ServiceBroker.
	//
	// Required field:
	// - Secret.Data["token"] - bearer token for authentication
	SecretRef *LocalObjectReference `json:"secretRef,omitempty"`
}

BearerTokenAuthConfig provides config for the bearer token authentication of cluster scoped brokers.

func (*BearerTokenAuthConfig) DeepCopy 

func (in *BearerTokenAuthConfig) DeepCopy() *BearerTokenAuthConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BearerTokenAuthConfig.

func (*BearerTokenAuthConfig) DeepCopyInto 

func (in *BearerTokenAuthConfig) DeepCopyInto(out *BearerTokenAuthConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CatalogRestrictions 

type CatalogRestrictions struct {
	// ServiceClass represents a selector for plans, used to filter catalog re-lists.
	// +listType=set
	ServiceClass []string `json:"serviceClass,omitempty"`
	// ServicePlan represents a selector for classes, used to filter catalog re-lists.
	// +listType=set
	ServicePlan []string `json:"servicePlan,omitempty"`
}

CatalogRestrictions is a set of restrictions on which of a broker's services and plans have resources created for them.

Some examples of this object are as follows:

This is an example of a whitelist on service externalName. Goal: Only list Services with the externalName of FooService and BarService, 

Solution: restrictions := ServiceCatalogRestrictions{
		ServiceClass: ["spec.externalName in (FooService, BarService)"]
}

This is an example of a blacklist on service externalName. Goal: Allow all services except the ones with the externalName of FooService and BarService, 

Solution: restrictions := ServiceCatalogRestrictions{
		ServiceClass: ["spec.externalName notin (FooService, BarService)"]
}

This whitelists plans called "Demo", and blacklists (but only a single element in the list) a service and a plan. Goal: Allow all plans with the externalName demo, but not AABBCC, and not a specific service by name, 

Solution: restrictions := ServiceCatalogRestrictions{
		ServiceClass: ["name!=AABBB-CCDD-EEGG-HIJK"]
		ServicePlan: ["spec.externalName in (Demo)", "name!=AABBCC"]
}

CatalogRestrictions strings have a special format similar to Label Selectors, except the catalog supports only a very specific property set.

The predicate format is expected to be `<property><conditional><requirement>` Check the *Requirements type definition for which <property> strings will be allowed. <conditional> is allowed to be one of the following: ==, !=, in, notin <requirement> will be a string value if `==` or `!=` are used. <requirement> will be a set of string values if `in` or `notin` are used. Multiple predicates are allowed to be chained with a comma (,)

ServiceClass allowed property names: 

name - the value set to [Cluster]ServiceClass.Name
spec.externalName - the value set to [Cluster]ServiceClass.Spec.ExternalName
spec.externalID - the value set to [Cluster]ServiceClass.Spec.ExternalID

ServicePlan allowed property names: 

name - the value set to [Cluster]ServicePlan.Name
spec.externalName - the value set to [Cluster]ServicePlan.Spec.ExternalName
spec.externalID - the value set to [Cluster]ServicePlan.Spec.ExternalID
spec.free - the value set to [Cluster]ServicePlan.Spec.Free
spec.serviceClass.name - the value set to ServicePlan.Spec.ServiceClassRef.Name
spec.clusterServiceClass.name - the value set to ClusterServicePlan.Spec.ClusterServiceClassRef.Name

func (*CatalogRestrictions) DeepCopy 

func (in *CatalogRestrictions) DeepCopy() *CatalogRestrictions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CatalogRestrictions.

func (*CatalogRestrictions) DeepCopyInto 

func (in *CatalogRestrictions) DeepCopyInto(out *CatalogRestrictions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterBasicAuthConfig 

type ClusterBasicAuthConfig struct {
	// SecretRef is a reference to a Secret containing information the
	// catalog should use to authenticate to this ServiceBroker.
	//
	// Required at least one of the fields:
	// - Secret.Data["username"] - username used for authentication
	// - Secret.Data["password"] - password or token needed for authentication
	SecretRef *ObjectReference `json:"secretRef,omitempty"`
}

ClusterBasicAuthConfig provides config for the basic authentication of cluster scoped brokers.

func (*ClusterBasicAuthConfig) DeepCopy 

func (in *ClusterBasicAuthConfig) DeepCopy() *ClusterBasicAuthConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterBasicAuthConfig.

func (*ClusterBasicAuthConfig) DeepCopyInto 

func (in *ClusterBasicAuthConfig) DeepCopyInto(out *ClusterBasicAuthConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterBearerTokenAuthConfig 

type ClusterBearerTokenAuthConfig struct {
	// SecretRef is a reference to a Secret containing information the
	// catalog should use to authenticate to this ServiceBroker.
	//
	// Required field:
	// - Secret.Data["token"] - bearer token for authentication
	SecretRef *ObjectReference `json:"secretRef,omitempty"`
}

ClusterBearerTokenAuthConfig provides config for the bearer token authentication of cluster scoped brokers.

func (*ClusterBearerTokenAuthConfig) DeepCopy 

func (in *ClusterBearerTokenAuthConfig) DeepCopy() *ClusterBearerTokenAuthConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterBearerTokenAuthConfig.

func (*ClusterBearerTokenAuthConfig) DeepCopyInto 

func (in *ClusterBearerTokenAuthConfig) DeepCopyInto(out *ClusterBearerTokenAuthConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterObjectReference 

type ClusterObjectReference struct {
	// Name of the referent.
	Name string `json:"name,omitempty"`
}

ClusterObjectReference contains enough information to let you locate the cluster-scoped referenced object.

func (*ClusterObjectReference) DeepCopy 

func (in *ClusterObjectReference) DeepCopy() *ClusterObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterObjectReference.

func (*ClusterObjectReference) DeepCopyInto 

func (in *ClusterObjectReference) DeepCopyInto(out *ClusterObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServiceBroker 

type ClusterServiceBroker struct {
	metav1.TypeMeta `json:",inline"`

	// Non-namespaced.  The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the broker.
	// +optional
	Spec ClusterServiceBrokerSpec `json:"spec,omitempty"`

	// Status represents the current status of a broker.
	// +optional
	Status ClusterServiceBrokerStatus `json:"status,omitempty"`
}

ClusterServiceBroker represents an entity that provides ClusterServiceClasses for use in the service catalog. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,URL:.spec.url

func (*ClusterServiceBroker) DeepCopy 

func (in *ClusterServiceBroker) DeepCopy() *ClusterServiceBroker

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceBroker.

func (*ClusterServiceBroker) DeepCopyInto 

func (in *ClusterServiceBroker) DeepCopyInto(out *ClusterServiceBroker)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServiceBroker) DeepCopyObject 

func (in *ClusterServiceBroker) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ClusterServiceBroker) GetName 

func (b *ClusterServiceBroker) GetName() string

GetName returns the broker's name.

func (*ClusterServiceBroker) GetNamespace 

func (b *ClusterServiceBroker) GetNamespace() string

GetNamespace always returns "", because it's cluster-scoped.

func (*ClusterServiceBroker) GetSpec 

func (b *ClusterServiceBroker) GetSpec() CommonServiceBrokerSpec

GetSpec returns the broker spec.

func (*ClusterServiceBroker) GetStatus 

func (b *ClusterServiceBroker) GetStatus() CommonServiceBrokerStatus

GetStatus returns the broker status.

func (*ClusterServiceBroker) GetURL 

func (b *ClusterServiceBroker) GetURL() string

GetURL returns the broker's endpoint URL.

func (*ClusterServiceBroker) RecalculatePrinterColumnStatusFields 

func (in *ClusterServiceBroker) RecalculatePrinterColumnStatusFields()

RecalculatePrinterColumnStatusFields sets column status fields using status conditions

type ClusterServiceBrokerAuthInfo 

type ClusterServiceBrokerAuthInfo struct {
	// ClusterBasicAuthConfigprovides configuration for basic authentication.
	Basic *ClusterBasicAuthConfig `json:"basic,omitempty"`
	// ClusterBearerTokenAuthConfig provides configuration to send an opaque value as a bearer token.
	// The value is referenced from the 'token' field of the given secret.  This value should only
	// contain the token value and not the `Bearer` scheme.
	Bearer *ClusterBearerTokenAuthConfig `json:"bearer,omitempty"`
}

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

func (*ClusterServiceBrokerAuthInfo) DeepCopy 

func (in *ClusterServiceBrokerAuthInfo) DeepCopy() *ClusterServiceBrokerAuthInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceBrokerAuthInfo.

func (*ClusterServiceBrokerAuthInfo) DeepCopyInto 

func (in *ClusterServiceBrokerAuthInfo) DeepCopyInto(out *ClusterServiceBrokerAuthInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServiceBrokerList 

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

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

ClusterServiceBrokerList is a list of Brokers.

func (*ClusterServiceBrokerList) DeepCopy 

func (in *ClusterServiceBrokerList) DeepCopy() *ClusterServiceBrokerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceBrokerList.

func (*ClusterServiceBrokerList) DeepCopyInto 

func (in *ClusterServiceBrokerList) DeepCopyInto(out *ClusterServiceBrokerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServiceBrokerList) DeepCopyObject 

func (in *ClusterServiceBrokerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterServiceBrokerSpec 

type ClusterServiceBrokerSpec struct {
	CommonServiceBrokerSpec `json:",inline"`

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

ClusterServiceBrokerSpec represents a description of a Broker.

func (*ClusterServiceBrokerSpec) DeepCopy 

func (in *ClusterServiceBrokerSpec) DeepCopy() *ClusterServiceBrokerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceBrokerSpec.

func (*ClusterServiceBrokerSpec) DeepCopyInto 

func (in *ClusterServiceBrokerSpec) DeepCopyInto(out *ClusterServiceBrokerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServiceBrokerStatus 

type ClusterServiceBrokerStatus struct {
	CommonServiceBrokerStatus `json:",inline"`
}

ClusterServiceBrokerStatus represents the current status of a ClusterServiceBroker.

func (*ClusterServiceBrokerStatus) DeepCopy 

func (in *ClusterServiceBrokerStatus) DeepCopy() *ClusterServiceBrokerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceBrokerStatus.

func (*ClusterServiceBrokerStatus) DeepCopyInto 

func (in *ClusterServiceBrokerStatus) DeepCopyInto(out *ClusterServiceBrokerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServiceClass 

type ClusterServiceClass struct {
	metav1.TypeMeta `json:",inline"`

	// Non-namespaced.  The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the cluster service class.
	// +optional
	Spec ClusterServiceClassSpec `json:"spec,omitempty"`

	// Status represents the current status of the cluster service class.
	// +optional
	Status ClusterServiceClassStatus `json:"status,omitempty"`
}

ClusterServiceClass represents an offering in the service catalog. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.clusterServiceBrokerName,BINDABLE:.spec.bindable,PLAN UPDATABLE:.spec.planUpdatable

func (*ClusterServiceClass) DeepCopy 

func (in *ClusterServiceClass) DeepCopy() *ClusterServiceClass

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceClass.

func (*ClusterServiceClass) DeepCopyInto 

func (in *ClusterServiceClass) DeepCopyInto(out *ClusterServiceClass)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServiceClass) DeepCopyObject 

func (in *ClusterServiceClass) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ClusterServiceClass) GetDescription 

func (c *ClusterServiceClass) GetDescription() string

GetDescription returns the class description.

func (*ClusterServiceClass) GetExternalName 

func (c *ClusterServiceClass) GetExternalName() string

GetExternalName returns the class's external name.

func (*ClusterServiceClass) GetName 

func (c *ClusterServiceClass) GetName() string

GetName returns the class's name.

func (*ClusterServiceClass) GetNamespace 

func (c *ClusterServiceClass) GetNamespace() string

GetNamespace for cluster-scoped classes always returns "".

func (*ClusterServiceClass) GetServiceBrokerName 

func (c *ClusterServiceClass) GetServiceBrokerName() string

GetServiceBrokerName returns the name of the service broker for the class.

func (*ClusterServiceClass) GetSpec 

func (c *ClusterServiceClass) GetSpec() CommonServiceClassSpec

GetSpec returns the spec for the class.

func (*ClusterServiceClass) GetStatusText 

func (c *ClusterServiceClass) GetStatusText() string

GetStatusText returns the status of the class.

func (*ClusterServiceClass) IsClusterServiceClass 

func (c *ClusterServiceClass) IsClusterServiceClass() bool

IsClusterServiceClass returns true for ClusterServiceClasses

type ClusterServiceClassList 

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

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

ClusterServiceClassList is a list of ClusterServiceClasses.

func (*ClusterServiceClassList) DeepCopy 

func (in *ClusterServiceClassList) DeepCopy() *ClusterServiceClassList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceClassList.

func (*ClusterServiceClassList) DeepCopyInto 

func (in *ClusterServiceClassList) DeepCopyInto(out *ClusterServiceClassList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServiceClassList) DeepCopyObject 

func (in *ClusterServiceClassList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterServiceClassSpec 

type ClusterServiceClassSpec struct {
	CommonServiceClassSpec `json:",inline"`

	// ClusterServiceBrokerName is the reference to the Broker that provides this
	// ClusterServiceClass.
	//
	// Immutable.
	ClusterServiceBrokerName string `json:"clusterServiceBrokerName"`
}

ClusterServiceClassSpec represents the details about a ClusterServiceClass

func (*ClusterServiceClassSpec) DeepCopy 

func (in *ClusterServiceClassSpec) DeepCopy() *ClusterServiceClassSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceClassSpec.

func (*ClusterServiceClassSpec) DeepCopyInto 

func (in *ClusterServiceClassSpec) DeepCopyInto(out *ClusterServiceClassSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServiceClassStatus 

type ClusterServiceClassStatus struct {
	CommonServiceClassStatus `json:",inline"`
}

ClusterServiceClassStatus represents status information about a ClusterServiceClass.

func (*ClusterServiceClassStatus) DeepCopy 

func (in *ClusterServiceClassStatus) DeepCopy() *ClusterServiceClassStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServiceClassStatus.

func (*ClusterServiceClassStatus) DeepCopyInto 

func (in *ClusterServiceClassStatus) DeepCopyInto(out *ClusterServiceClassStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServicePlan 

type ClusterServicePlan struct {
	metav1.TypeMeta `json:",inline"`

	// Non-namespaced.  The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the service plan.
	// +optional
	Spec ClusterServicePlanSpec `json:"spec,omitempty"`

	// Status represents the current status of the service plan.
	// +optional
	Status ClusterServicePlanStatus `json:"status,omitempty"`
}

ClusterServicePlan represents a tier of a ServiceClass. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.clusterServiceBrokerName,CLASS:.spec.clusterServiceClassRef.name

func (*ClusterServicePlan) DeepCopy 

func (in *ClusterServicePlan) DeepCopy() *ClusterServicePlan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServicePlan.

func (*ClusterServicePlan) DeepCopyInto 

func (in *ClusterServicePlan) DeepCopyInto(out *ClusterServicePlan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServicePlan) DeepCopyObject 

func (in *ClusterServicePlan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ClusterServicePlan) GetBindingCreateSchema 

func (p *ClusterServicePlan) GetBindingCreateSchema() *runtime.RawExtension

GetBindingCreateSchema returns the instance create schema from plan.

func (*ClusterServicePlan) GetClassID 

func (p *ClusterServicePlan) GetClassID() string

GetClassID returns the class name from plan.

func (*ClusterServicePlan) GetDefaultProvisionParameters 

func (p *ClusterServicePlan) GetDefaultProvisionParameters() *runtime.RawExtension

GetDefaultProvisionParameters returns the default provision parameters from plan.

func (*ClusterServicePlan) GetDescription 

func (p *ClusterServicePlan) GetDescription() string

GetDescription returns the plan description.

func (*ClusterServicePlan) GetExternalName 

func (p *ClusterServicePlan) GetExternalName() string

GetExternalName returns the plan's external name.

func (*ClusterServicePlan) GetFree 

func (p *ClusterServicePlan) GetFree() bool

GetFree returns if the plan is free.

func (*ClusterServicePlan) GetInstanceCreateSchema 

func (p *ClusterServicePlan) GetInstanceCreateSchema() *runtime.RawExtension

GetInstanceCreateSchema returns the instance create schema from plan.

func (*ClusterServicePlan) GetInstanceUpdateSchema 

func (p *ClusterServicePlan) GetInstanceUpdateSchema() *runtime.RawExtension

GetInstanceUpdateSchema returns the instance update schema from plan.

func (*ClusterServicePlan) GetName 

func (p *ClusterServicePlan) GetName() string

GetName returns the plan's name.

func (*ClusterServicePlan) GetNamespace 

func (p *ClusterServicePlan) GetNamespace() string

GetNamespace for cluster-scoped plans always returns "".

func (*ClusterServicePlan) GetShortStatus 

func (p *ClusterServicePlan) GetShortStatus() string

GetShortStatus returns the plan's status.

type ClusterServicePlanList 

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

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

ClusterServicePlanList is a list of ClusterServicePlans.

func (*ClusterServicePlanList) DeepCopy 

func (in *ClusterServicePlanList) DeepCopy() *ClusterServicePlanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServicePlanList.

func (*ClusterServicePlanList) DeepCopyInto 

func (in *ClusterServicePlanList) DeepCopyInto(out *ClusterServicePlanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterServicePlanList) DeepCopyObject 

func (in *ClusterServicePlanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterServicePlanSpec 

type ClusterServicePlanSpec struct {
	// CommonServicePlanSpec contains the common details of this ClusterServicePlan
	CommonServicePlanSpec `json:",inline"`

	// ClusterServiceBrokerName is the name of the ClusterServiceBroker
	// that offers this ClusterServicePlan.
	ClusterServiceBrokerName string `json:"clusterServiceBrokerName"`

	// ClusterServiceClassRef is a reference to the service class that
	// owns this plan.
	ClusterServiceClassRef ClusterObjectReference `json:"clusterServiceClassRef"`
}

ClusterServicePlanSpec represents details about a ClusterServicePlan.

func (*ClusterServicePlanSpec) DeepCopy 

func (in *ClusterServicePlanSpec) DeepCopy() *ClusterServicePlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServicePlanSpec.

func (*ClusterServicePlanSpec) DeepCopyInto 

func (in *ClusterServicePlanSpec) DeepCopyInto(out *ClusterServicePlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServicePlanStatus 

type ClusterServicePlanStatus struct {
	CommonServicePlanStatus `json:",inline"`
}

ClusterServicePlanStatus represents status information about a ClusterServicePlan.

func (*ClusterServicePlanStatus) DeepCopy 

func (in *ClusterServicePlanStatus) DeepCopy() *ClusterServicePlanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServicePlanStatus.

func (*ClusterServicePlanStatus) DeepCopyInto 

func (in *ClusterServicePlanStatus) DeepCopyInto(out *ClusterServicePlanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommonServiceBrokerSpec 

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

	// InsecureSkipTLSVerify disables TLS certificate verification when communicating with this Broker.
	// This is strongly discouraged.  You should use the CABundle instead.
	// +optional
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`

	// CABundle is a PEM encoded CA bundle which will be used to validate a Broker's serving certificate.
	// +optional
	CABundle []byte `json:"caBundle,omitempty"`

	// RelistBehavior specifies the type of relist behavior the catalog should
	// exhibit when relisting ServiceClasses available from a broker.
	// +optional
	RelistBehavior ServiceBrokerRelistBehavior `json:"relistBehavior"`

	// RelistDuration is the frequency by which a controller will relist the
	// broker when the RelistBehavior is set to ServiceBrokerRelistBehaviorDuration.
	// Users are cautioned against configuring low values for the RelistDuration,
	// as this can easily overload the controller manager in an environment with
	// many brokers. The actual interval is intrinsically governed by the
	// configured resync interval of the controller, which acts as a minimum bound.
	// For example, with a resync interval of 5m and a RelistDuration of 2m, relists
	// will occur at the resync interval of 5m.
	RelistDuration *metav1.Duration `json:"relistDuration,omitempty"`

	// RelistRequests is a strictly increasing, non-negative integer counter that
	// can be manually incremented by a user to manually trigger a relist.
	// +optional
	RelistRequests int64 `json:"relistRequests"`

	// CatalogRestrictions is a set of restrictions on which of a broker's services
	// and plans have resources created for them.
	// +optional
	CatalogRestrictions *CatalogRestrictions `json:"catalogRestrictions,omitempty"`
}

CommonServiceBrokerSpec represents a description of a Broker.

func (*CommonServiceBrokerSpec) DeepCopy 

func (in *CommonServiceBrokerSpec) DeepCopy() *CommonServiceBrokerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServiceBrokerSpec.

func (*CommonServiceBrokerSpec) DeepCopyInto 

func (in *CommonServiceBrokerSpec) DeepCopyInto(out *CommonServiceBrokerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommonServiceBrokerStatus 

type CommonServiceBrokerStatus struct {
	Conditions []ServiceBrokerCondition `json:"conditions"`

	// ReconciledGeneration is the 'Generation' of the ClusterServiceBrokerSpec that
	// was last processed by the controller. The reconciled generation is updated
	// even if the controller failed to process the spec.
	ReconciledGeneration int64 `json:"reconciledGeneration"`

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time `json:"operationStartTime,omitempty"`

	// LastCatalogRetrievalTime is the time the Catalog was last fetched from
	// the Service Broker
	LastCatalogRetrievalTime *metav1.Time `json:"lastCatalogRetrievalTime,omitempty"`

	// LastConditionState aggregates state from the Conditions array
	// It is used for printing in a kubectl output via additionalPrinterColumns
	LastConditionState string `json:"lastConditionState"`
}

CommonServiceBrokerStatus represents the current status of a Broker.

func (*CommonServiceBrokerStatus) DeepCopy 

func (in *CommonServiceBrokerStatus) DeepCopy() *CommonServiceBrokerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServiceBrokerStatus.

func (*CommonServiceBrokerStatus) DeepCopyInto 

func (in *CommonServiceBrokerStatus) DeepCopyInto(out *CommonServiceBrokerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommonServiceClassSpec 

type CommonServiceClassSpec struct {
	// ExternalName is the name of this object that the Service Broker
	// exposed this Service Class as. Mutable.
	ExternalName string `json:"externalName"`

	// 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 ServiceClass.
	Description string `json:"description"`

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

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// BindingRetrievable indicates whether fetching a binding via a GET on
	// its endpoint is supported for all plans.
	BindingRetrievable bool `json:"bindingRetrievable"`

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

	// 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.
	Tags []string `json:"tags,omitempty"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// Requires 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
	// ServiceInstance provisioned from this ServiceClass will not
	// work correctly.
	Requires []string `json:"requires,omitempty"`

	// DefaultProvisionParameters are default parameters passed to the broker
	// when an instance of this class is provisioned. Any parameters defined on
	// the plan and instance are merged with these defaults, with
	// plan and then instance-defined parameters taking precedence over the class
	// defaults.
	DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`
}

CommonServiceClassSpec represents details about a ServiceClass

func (*CommonServiceClassSpec) DeepCopy 

func (in *CommonServiceClassSpec) DeepCopy() *CommonServiceClassSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServiceClassSpec.

func (*CommonServiceClassSpec) DeepCopyInto 

func (in *CommonServiceClassSpec) DeepCopyInto(out *CommonServiceClassSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommonServiceClassStatus 

type CommonServiceClassStatus struct {
	// RemovedFromBrokerCatalog indicates that the broker removed the service from its
	// catalog.
	RemovedFromBrokerCatalog bool `json:"removedFromBrokerCatalog"`
}

CommonServiceClassStatus represents common status information between cluster scoped and namespace scoped ServiceClasses.

func (*CommonServiceClassStatus) DeepCopy 

func (in *CommonServiceClassStatus) DeepCopy() *CommonServiceClassStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServiceClassStatus.

func (*CommonServiceClassStatus) DeepCopyInto 

func (in *CommonServiceClassStatus) DeepCopyInto(out *CommonServiceClassStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CommonServiceClassStatus) GetStatusText 

func (c *CommonServiceClassStatus) GetStatusText() string

GetStatusText returns the status based on the CommonServiceClassStatus.

type CommonServicePlanSpec 

type CommonServicePlanSpec struct {
	// ExternalName is the name of this object that the Service Broker
	// exposed this Service Plan as. Mutable.
	ExternalName string `json:"externalName"`

	// 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
	// ServiceInstance using this ServicePlan.  If set, overrides
	// the value of the corresponding ServiceClassSpec 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.
	//
	// InstanceCreateParameterSchema is the schema for the parameters
	// that may be supplied when provisioning a new ServiceInstance on this plan.
	InstanceCreateParameterSchema *runtime.RawExtension `json:"instanceCreateParameterSchema,omitempty"`

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

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

	// DefaultProvisionParameters are default parameters passed to the broker
	// when an instance of this plan is provisioned. Any parameters defined on
	// the instance are merged with these defaults, with instance-defined
	// parameters taking precedence over defaults.
	DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`
}

CommonServicePlanSpec represents details that are shared by both a ClusterServicePlan and a namespaced ServicePlan

func (*CommonServicePlanSpec) DeepCopy 

func (in *CommonServicePlanSpec) DeepCopy() *CommonServicePlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServicePlanSpec.

func (*CommonServicePlanSpec) DeepCopyInto 

func (in *CommonServicePlanSpec) DeepCopyInto(out *CommonServicePlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommonServicePlanStatus 

type CommonServicePlanStatus struct {
	// RemovedFromBrokerCatalog indicates that the broker removed the plan
	// from its catalog.
	RemovedFromBrokerCatalog bool `json:"removedFromBrokerCatalog"`
}

CommonServicePlanStatus represents status information about a ClusterServicePlan or a ServicePlan.

func (*CommonServicePlanStatus) DeepCopy 

func (in *CommonServicePlanStatus) DeepCopy() *CommonServicePlanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonServicePlanStatus.

func (*CommonServicePlanStatus) DeepCopyInto 

func (in *CommonServicePlanStatus) DeepCopyInto(out *CommonServicePlanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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.

type ExtraValue 

type ExtraValue []string

ExtraValue contains additional information about a user that may be provided by the authenticator.

func (ExtraValue) DeepCopy 

func (in ExtraValue) DeepCopy() ExtraValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtraValue.

func (ExtraValue) DeepCopyInto 

func (in ExtraValue) DeepCopyInto(out *ExtraValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalObjectReference 

type LocalObjectReference struct {
	// Name of the referent.
	Name string `json:"name,omitempty"`
}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

func (*LocalObjectReference) DeepCopy 

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalObjectReference.

func (*LocalObjectReference) DeepCopyInto 

func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObjectReference 

type ObjectReference struct {
	// Namespace of the referent.
	Namespace string `json:"namespace,omitempty"`
	// Name of the referent.
	Name string `json:"name,omitempty"`
}

ObjectReference contains enough information to let you locate the referenced object.

func (*ObjectReference) DeepCopy 

func (in *ObjectReference) DeepCopy() *ObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.

func (*ObjectReference) DeepCopyInto 

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ParametersFromSource 

type ParametersFromSource struct {
	// The Secret key to select from.
	// The value must be a JSON object.
	// +optional
	SecretKeyRef *SecretKeyReference `json:"secretKeyRef,omitempty"`
}

ParametersFromSource represents the source of a set of Parameters

func (*ParametersFromSource) DeepCopy 

func (in *ParametersFromSource) DeepCopy() *ParametersFromSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParametersFromSource.

func (*ParametersFromSource) DeepCopyInto 

func (in *ParametersFromSource) DeepCopyInto(out *ParametersFromSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PlanReference 

type PlanReference struct {
	// ClusterServiceClassExternalName is the human-readable name of the
	// service as reported by the ClusterServiceBroker. Note that if the
	// ClusterServiceBroker changes the name of the ClusterServiceClass,
	// it will not be reflected here, and to see the current name of the
	// ClusterServiceClass, you should follow the ClusterServiceClassRef below.
	//
	// Immutable.
	ClusterServiceClassExternalName string `json:"clusterServiceClassExternalName,omitempty"`
	// ClusterServicePlanExternalName is the human-readable name of the plan
	// as reported by the ClusterServiceBroker. Note that if the
	// ClusterServiceBroker changes the name of the ClusterServicePlan, it will
	// not be reflected here, and to see the current name of the
	// ClusterServicePlan, you should follow the ClusterServicePlanRef below.
	ClusterServicePlanExternalName string `json:"clusterServicePlanExternalName,omitempty"`

	// ClusterServiceClassExternalID is the ClusterServiceBroker's external id
	// for the class.
	//
	// Immutable.
	ClusterServiceClassExternalID string `json:"clusterServiceClassExternalID,omitempty"`

	// ClusterServicePlanExternalID is the ClusterServiceBroker's external id for
	// the plan.
	ClusterServicePlanExternalID string `json:"clusterServicePlanExternalID,omitempty"`

	// ClusterServiceClassName is the kubernetes name of the ClusterServiceClass.
	//
	// Immutable.
	ClusterServiceClassName string `json:"clusterServiceClassName,omitempty"`
	// ClusterServicePlanName is kubernetes name of the ClusterServicePlan.
	ClusterServicePlanName string `json:"clusterServicePlanName,omitempty"`

	// ServiceClassExternalName is the human-readable name of the
	// service as reported by the ServiceBroker. Note that if the ServiceBroker
	// changes the name of the ServiceClass, it will not be reflected here,
	// and to see the current name of the ServiceClass, you should
	// follow the ServiceClassRef below.
	//
	// Immutable.
	ServiceClassExternalName string `json:"serviceClassExternalName,omitempty"`
	// ServicePlanExternalName is the human-readable name of the plan
	// as reported by the ServiceBroker. Note that if the ServiceBroker changes
	// the name of the ServicePlan, it will not be reflected here, and to see
	// the current name of the ServicePlan, you should follow the
	// ServicePlanRef below.
	ServicePlanExternalName string `json:"servicePlanExternalName,omitempty"`

	// ServiceClassExternalID is the ServiceBroker's external id for the class.
	//
	// Immutable.
	ServiceClassExternalID string `json:"serviceClassExternalID,omitempty"`

	// ServicePlanExternalID is the ServiceBroker's external id for the plan.
	ServicePlanExternalID string `json:"servicePlanExternalID,omitempty"`

	// ServiceClassName is the kubernetes name of the ServiceClass.
	//
	// Immutable.
	ServiceClassName string `json:"serviceClassName,omitempty"`
	// ServicePlanName is kubernetes name of the ServicePlan.
	ServicePlanName string `json:"servicePlanName,omitempty"`
}

PlanReference defines the user specification for the desired (Cluster)ServicePlan and (Cluster)ServiceClass. Because there are multiple ways to specify the desired Class/Plan, this structure specifies the allowed ways to specify the intent. Note: a user may specify either cluster scoped OR namespace scoped identifiers, but NOT both, as they are mutually exclusive.

Currently supported ways:

  • ClusterServiceClassExternalName and ClusterServicePlanExternalName
  • ClusterServiceClassExternalID and ClusterServicePlanExternalID
  • ClusterServiceClassName and ClusterServicePlanName
  • ServiceClassExternalName and ServicePlanExternalName
  • ServiceClassExternalID and ServicePlanExternalID
  • ServiceClassName and ServicePlanName

For any of these ways, if a ClusterServiceClass only has one plan then the corresponding service plan field is optional.

func (PlanReference) ClusterServiceClassSpecified 

func (pr PlanReference) ClusterServiceClassSpecified() bool

ClusterServiceClassSpecified checks that at least one clusterserviceclass field is set.

func (PlanReference) ClusterServicePlanSpecified 

func (pr PlanReference) ClusterServicePlanSpecified() bool

ClusterServicePlanSpecified checks that at least one clusterserviceplan field is set.

func (*PlanReference) DeepCopy 

func (in *PlanReference) DeepCopy() *PlanReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlanReference.

func (*PlanReference) DeepCopyInto 

func (in *PlanReference) DeepCopyInto(out *PlanReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (PlanReference) Format 

func (pr PlanReference) Format(s fmt.State, verb rune)

Format the PlanReference %c - Print specified class fields only 

Examples:
 {ClassExternalName:"foo"}
 {ClassExternalID:"foo123"}
 {ClassName:"k8s-foo123"}

%b - Print specified plan fields only 

NOTE: %p is a reserved verb so we can't use it, and go vet fails for non-standard verbs
Examples:
 {PlanExternalName:"bar"}
 {PlanExternalID:"bar456"}
 {PlanName:"k8s-bar456"}

%s - Print a short form of the plan and class 

Examples:
 foo/bar
 foo123/bar456
 k8s-foo123/k8s-bar456

%v - Print all specified fields 

Examples:
 {ClassExternalName:"foo", PlanExternalName:"bar"}
 {ClassExternalID:"foo123", PlanExternalID:"bar456"}
 {ClassName:"k8s-foo123", PlanName:"k8s-bar456"}

func (PlanReference) GetClusterServiceClassFilterLabelName 

func (pr PlanReference) GetClusterServiceClassFilterLabelName() string

GetClusterServiceClassFilterLabelName returns the appropriate label name for filtering a list of service catalog classes by the PlanReference.

func (PlanReference) GetClusterServicePlanFilterLabelName 

func (pr PlanReference) GetClusterServicePlanFilterLabelName() string

GetClusterServicePlanFilterLabelName returns the appropriate label name for filtering a list of service catalog plans by the PlanReference.

func (PlanReference) GetServiceClassFilterLabelName 

func (pr PlanReference) GetServiceClassFilterLabelName() string

GetServiceClassFilterLabelName returns the appropriate label name for filtering a list of service catalog classes by the PlanReference.

func (PlanReference) GetServicePlanFilterLabelName 

func (pr PlanReference) GetServicePlanFilterLabelName() string

GetServicePlanFilterLabelName returns the appropriate label name for filtering a list of service catalog plans by the PlanReference.

func (PlanReference) GetSpecifiedClusterServiceClass 

func (pr PlanReference) GetSpecifiedClusterServiceClass() string

GetSpecifiedClusterServiceClass returns the user-specified class value from either: * ClusterServiceClassExternalName * ClusterServiceClassExternalID * ClusterServiceClassName

func (PlanReference) GetSpecifiedClusterServicePlan 

func (pr PlanReference) GetSpecifiedClusterServicePlan() string

GetSpecifiedClusterServicePlan returns the user-specified plan value from either: * ClusterServicePlanExternalName * ClusterServicePlanExternalID * ClusterServicePlanName

func (PlanReference) GetSpecifiedServiceClass 

func (pr PlanReference) GetSpecifiedServiceClass() string

GetSpecifiedServiceClass returns the user-specified class value from either: * ServiceClassExternalName * ServiceClassExternalID * ServiceClassName

func (PlanReference) GetSpecifiedServicePlan 

func (pr PlanReference) GetSpecifiedServicePlan() string

GetSpecifiedServicePlan returns the user-specified plan value from either: * ServicePlanExternalName * ServicePlanExternalID * ServicePlanName

func (PlanReference) ServiceClassSpecified 

func (pr PlanReference) ServiceClassSpecified() bool

ServiceClassSpecified checks that at least one serviceclass field is set.

func (PlanReference) ServicePlanSpecified 

func (pr PlanReference) ServicePlanSpecified() bool

ServicePlanSpecified checks that at least one serviceplan field is set.

func (PlanReference) String 

func (pr PlanReference) String() string

String representation of a PlanReference Example: class_name/plan_name, class_id/plan_id

type RemoveKeyTransform 

type RemoveKeyTransform struct {
	// The key to remove from the Secret
	Key string `json:"key"`
}

RemoveKeyTransform specifies that one of the credentials keys returned from the broker should not be included in the credentials Secret.

func (*RemoveKeyTransform) DeepCopy 

func (in *RemoveKeyTransform) DeepCopy() *RemoveKeyTransform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RemoveKeyTransform.

func (*RemoveKeyTransform) DeepCopyInto 

func (in *RemoveKeyTransform) DeepCopyInto(out *RemoveKeyTransform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RenameKeyTransform 

type RenameKeyTransform struct {
	// The name of the key to rename
	From string `json:"from"`
	// The new name for the key
	To string `json:"to"`
}

RenameKeyTransform specifies that one of the credentials keys returned from the broker should be renamed and stored under a different key in the Secret. For example, given the following credentials entry: 

"USERNAME": "johndoe"

and the following RenameKeyTransform: 

{"from": "USERNAME", "to": "DB_USER"}

the following entry will appear in the Secret: 

"DB_USER": "johndoe"

func (*RenameKeyTransform) DeepCopy 

func (in *RenameKeyTransform) DeepCopy() *RenameKeyTransform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RenameKeyTransform.

func (*RenameKeyTransform) DeepCopyInto 

func (in *RenameKeyTransform) DeepCopyInto(out *RenameKeyTransform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretKeyReference 

type SecretKeyReference struct {
	// The name of the secret in the pod's namespace to select from.
	Name string `json:"name"`
	// The key of the secret to select from.  Must be a valid secret key.
	Key string `json:"key"`
}

SecretKeyReference references a key of a Secret.

func (*SecretKeyReference) DeepCopy 

func (in *SecretKeyReference) DeepCopy() *SecretKeyReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretKeyReference.

func (*SecretKeyReference) DeepCopyInto 

func (in *SecretKeyReference) DeepCopyInto(out *SecretKeyReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretTransform 

type SecretTransform struct {
	// RenameKey represents a transform that renames a credentials Secret entry's key
	RenameKey *RenameKeyTransform `json:"renameKey,omitempty"`
	// AddKey represents a transform that adds an additional key to the credentials Secret
	AddKey *AddKeyTransform `json:"addKey,omitempty"`
	// AddKeysFrom represents a transform that merges all the entries of an existing Secret
	// into the credentials Secret
	AddKeysFrom *AddKeysFromTransform `json:"addKeysFrom,omitempty"`
	// RemoveKey represents a transform that removes a credentials Secret entry
	RemoveKey *RemoveKeyTransform `json:"removeKey,omitempty"`
}

SecretTransform is a single transformation that is applied to the credentials returned from the broker before they are inserted into the Secret associated with the ServiceBinding. Because different brokers providing the same type of service may each return a different credentials structure, users can specify the transformations that should be applied to the Secret to adapt its entries to whatever the service consumer expects. For example, the credentials returned by the broker may include the key "USERNAME", but the consumer requires the username to be exposed under the key "DB_USER" instead. To have the Service Catalog transform the Secret, the following SecretTransform must be specified in ServiceBinding.spec.secretTransform: - {"renameKey": {"from": "USERNAME", "to": "DB_USER"}} Only one of the SecretTransform's members may be specified.

func (*SecretTransform) DeepCopy 

func (in *SecretTransform) DeepCopy() *SecretTransform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretTransform.

func (*SecretTransform) DeepCopyInto 

func (in *SecretTransform) DeepCopyInto(out *SecretTransform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBinding 

type ServiceBinding struct {
	metav1.TypeMeta `json:",inline"`

	// The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec represents the desired state of a ServiceBinding.
	// +optional
	Spec ServiceBindingSpec `json:"spec,omitempty"`

	// Status represents the current status of a ServiceBinding.
	// +optional
	Status ServiceBindingStatus `json:"status,omitempty"`
}

ServiceBinding represents a "used by" relationship between an application and an ServiceInstance. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,INSTANCE:.spec.instanceRef.name,SECRET:.spec.secretName

func (*ServiceBinding) DeepCopy 

func (in *ServiceBinding) DeepCopy() *ServiceBinding

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBinding.

func (*ServiceBinding) DeepCopyInto 

func (in *ServiceBinding) DeepCopyInto(out *ServiceBinding)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceBinding) DeepCopyObject 

func (in *ServiceBinding) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ServiceBinding) RecalculatePrinterColumnStatusFields 

func (in *ServiceBinding) RecalculatePrinterColumnStatusFields()

RecalculatePrinterColumnStatusFields sets column status fields using status conditions

type ServiceBindingCondition 

type ServiceBindingCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceBindingConditionType `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"`
}

ServiceBindingCondition condition information for a ServiceBinding.

func (*ServiceBindingCondition) DeepCopy 

func (in *ServiceBindingCondition) DeepCopy() *ServiceBindingCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBindingCondition.

func (*ServiceBindingCondition) DeepCopyInto 

func (in *ServiceBindingCondition) DeepCopyInto(out *ServiceBindingCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBindingConditionType 

type ServiceBindingConditionType string

ServiceBindingConditionType represents a ServiceBindingCondition value. 

const (
	// ServiceBindingConditionReady represents a binding condition is in ready state.
	ServiceBindingConditionReady ServiceBindingConditionType = "Ready"

	// ServiceBindingConditionFailed represents a ServiceBindingCondition that has failed
	// completely and should not be retried.
	ServiceBindingConditionFailed ServiceBindingConditionType = "Failed"
)

type ServiceBindingList 

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

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

ServiceBindingList is a list of ServiceBindings.

func (*ServiceBindingList) DeepCopy 

func (in *ServiceBindingList) DeepCopy() *ServiceBindingList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBindingList.

func (*ServiceBindingList) DeepCopyInto 

func (in *ServiceBindingList) DeepCopyInto(out *ServiceBindingList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceBindingList) DeepCopyObject 

func (in *ServiceBindingList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServiceBindingOperation 

type ServiceBindingOperation string

ServiceBindingOperation represents a type of operation the controller can be performing for a binding in the OSB API. 

const (
	// ServiceBindingOperationBind indicates that the
	// ServiceBinding is being bound.
	ServiceBindingOperationBind ServiceBindingOperation = "Bind"
	// ServiceBindingOperationUnbind indicates that the
	// ServiceBinding is being unbound.
	ServiceBindingOperationUnbind ServiceBindingOperation = "Unbind"
)

type ServiceBindingPropertiesState 

type ServiceBindingPropertiesState struct {
	// Parameters is a blob of the parameters and their values that the broker
	// knows about for this ServiceBinding.  If a parameter was
	// sourced from a secret, its value will be "<redacted>" in this blob.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// ParameterChecksum is the checksum of the parameters that were sent.
	ParameterChecksum string `json:"parameterChecksum,omitempty"`

	// UserInfo is information about the user that made the request.
	UserInfo *UserInfo `json:"userInfo,omitempty"`
}

ServiceBindingPropertiesState is the state of a ServiceBinding that the ClusterServiceBroker knows about.

func (*ServiceBindingPropertiesState) DeepCopy 

func (in *ServiceBindingPropertiesState) DeepCopy() *ServiceBindingPropertiesState

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBindingPropertiesState.

func (*ServiceBindingPropertiesState) DeepCopyInto 

func (in *ServiceBindingPropertiesState) DeepCopyInto(out *ServiceBindingPropertiesState)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBindingSpec 

type ServiceBindingSpec struct {
	// InstanceRef is the reference to the Instance this ServiceBinding is to.
	//
	// Immutable.
	InstanceRef LocalObjectReference `json:"instanceRef"`

	// Parameters is a set of the parameters to be passed to the underlying
	// broker. The inline YAML/JSON payload to be translated into equivalent
	// JSON object. If a top-level parameter name exists in multiples sources
	// among `Parameters` and `ParametersFrom` fields, it is considered to be
	// a user error in the specification.
	//
	// The Parameters field is NOT secret or secured in any way and should
	// NEVER be used to hold sensitive information. To set parameters that
	// contain secret information, you should ALWAYS store that information
	// in a Secret and use the ParametersFrom field.
	//
	// +optional
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// List of sources to populate parameters.
	// If a top-level parameter name exists in multiples sources among
	// `Parameters` and `ParametersFrom` fields, it is
	// considered to be a user error in the specification.
	// +optional
	ParametersFrom []ParametersFromSource `json:"parametersFrom,omitempty"`

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

	// List of transformations that should be applied to the credentials
	// associated with the ServiceBinding before they are inserted into the Secret.
	SecretTransforms []SecretTransform `json:"secretTransforms,omitempty"`

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

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// UserInfo contains information about the user that last modified this
	// ServiceBinding. This field is set by the API server and not
	// settable by the end-user. User-provided values for this field are not saved.
	// +optional
	UserInfo *UserInfo `json:"userInfo,omitempty"`
}

ServiceBindingSpec represents the desired state of a ServiceBinding.

The spec field cannot be changed after a ServiceBinding is created. Changes submitted to the spec field will be ignored.

func (*ServiceBindingSpec) DeepCopy 

func (in *ServiceBindingSpec) DeepCopy() *ServiceBindingSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBindingSpec.

func (*ServiceBindingSpec) DeepCopyInto 

func (in *ServiceBindingSpec) DeepCopyInto(out *ServiceBindingSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBindingStatus 

type ServiceBindingStatus struct {
	Conditions []ServiceBindingCondition `json:"conditions"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// AsyncOpInProgress is set to true if there is an ongoing async operation
	// against this ServiceBinding in progress.
	AsyncOpInProgress bool `json:"asyncOpInProgress"`

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// 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"`

	// CurrentOperation is the operation the Controller is currently performing
	// on the ServiceBinding.
	CurrentOperation ServiceBindingOperation `json:"currentOperation,omitempty"`

	// ReconciledGeneration is the 'Generation' of the
	// ServiceBindingSpec that was last processed by the controller.
	// The reconciled generation is updated even if the controller failed to
	// process the spec.
	ReconciledGeneration int64 `json:"reconciledGeneration"`

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time `json:"operationStartTime,omitempty"`

	// InProgressProperties is the properties state of the
	// ServiceBinding when a Bind is in progress. If the current
	// operation is an Unbind, this will be nil.
	InProgressProperties *ServiceBindingPropertiesState `json:"inProgressProperties,omitempty"`

	// ExternalProperties is the properties state of the
	// ServiceBinding which the broker knows about.
	ExternalProperties *ServiceBindingPropertiesState `json:"externalProperties,omitempty"`

	// OrphanMitigationInProgress is a flag that represents whether orphan
	// mitigation is in progress.
	OrphanMitigationInProgress bool `json:"orphanMitigationInProgress"`

	// UnbindStatus describes what has been done to unbind the ServiceBinding.
	UnbindStatus ServiceBindingUnbindStatus `json:"unbindStatus"`

	// LastConditionState aggregates state from the Conditions array
	// It is used for printing in a kubectl output via additionalPrinterColumns
	LastConditionState string `json:"lastConditionState"`
}

ServiceBindingStatus represents the current status of a ServiceBinding.

func (*ServiceBindingStatus) DeepCopy 

func (in *ServiceBindingStatus) DeepCopy() *ServiceBindingStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBindingStatus.

func (*ServiceBindingStatus) DeepCopyInto 

func (in *ServiceBindingStatus) DeepCopyInto(out *ServiceBindingStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBindingUnbindStatus 

type ServiceBindingUnbindStatus string

ServiceBindingUnbindStatus is the status of unbinding a Binding 

const (
	// ServiceBindingUnbindStatusNotRequired indicates that a binding request
	// has not been sent for the ServiceBinding, so no unbinding request
	// needs to be made.
	ServiceBindingUnbindStatusNotRequired ServiceBindingUnbindStatus = "NotRequired"
	// ServiceBindingUnbindStatusRequired indicates that a binding request has
	// been sent for the ServiceBinding. An unbind request must be made before
	// deleting the ServiceBinding.
	ServiceBindingUnbindStatusRequired ServiceBindingUnbindStatus = "Required"
	// ServiceBindingUnbindStatusSucceeded indicates that a unbind request has
	// been sent for the ServiceBinding, and the request was successful.
	ServiceBindingUnbindStatusSucceeded ServiceBindingUnbindStatus = "Succeeded"
	// ServiceBindingUnbindStatusFailed indicates that unbind requests have
	// been sent for the ServiceBinding but they failed. The controller has
	// given up on sending more unbind requests.
	ServiceBindingUnbindStatusFailed ServiceBindingUnbindStatus = "Failed"
)

type ServiceBroker 

type ServiceBroker struct {
	metav1.TypeMeta `json:",inline"`

	// The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the broker.
	// +optional
	Spec ServiceBrokerSpec `json:"spec,omitempty"`

	// Status represents the current status of a broker.
	// +optional
	Status ServiceBrokerStatus `json:"status,omitempty"`
}

ServiceBroker represents an entity that provides ServiceClasses for use in the service catalog. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,URL:.spec.url

func (*ServiceBroker) DeepCopy 

func (in *ServiceBroker) DeepCopy() *ServiceBroker

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBroker.

func (*ServiceBroker) DeepCopyInto 

func (in *ServiceBroker) DeepCopyInto(out *ServiceBroker)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceBroker) DeepCopyObject 

func (in *ServiceBroker) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ServiceBroker) GetName 

func (b *ServiceBroker) GetName() string

GetName returns the broker's name.

func (*ServiceBroker) GetNamespace 

func (b *ServiceBroker) GetNamespace() string

GetNamespace returns the broker's namespace.

func (*ServiceBroker) GetSpec 

func (b *ServiceBroker) GetSpec() CommonServiceBrokerSpec

GetSpec returns the broker spec

func (*ServiceBroker) GetStatus 

func (b *ServiceBroker) GetStatus() CommonServiceBrokerStatus

GetStatus returns the broker status.

func (*ServiceBroker) GetURL 

func (b *ServiceBroker) GetURL() string

GetURL returns the broker's endpoint URL.

func (*ServiceBroker) RecalculatePrinterColumnStatusFields 

func (b *ServiceBroker) RecalculatePrinterColumnStatusFields()

RecalculatePrinterColumnStatusFields sets column status fields using status conditions

type ServiceBrokerAuthInfo 

type ServiceBrokerAuthInfo struct {
	// BasicAuthConfig provides configuration for basic authentication.
	Basic *BasicAuthConfig `json:"basic,omitempty"`
	// BearerTokenAuthConfig provides configuration to send an opaque value as a bearer token.
	// The value is referenced from the 'token' field of the given secret.  This value should only
	// contain the token value and not the `Bearer` scheme.
	Bearer *BearerTokenAuthConfig `json:"bearer,omitempty"`
}

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

func (*ServiceBrokerAuthInfo) DeepCopy 

func (in *ServiceBrokerAuthInfo) DeepCopy() *ServiceBrokerAuthInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBrokerAuthInfo.

func (*ServiceBrokerAuthInfo) DeepCopyInto 

func (in *ServiceBrokerAuthInfo) DeepCopyInto(out *ServiceBrokerAuthInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBrokerCondition 

type ServiceBrokerCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceBrokerConditionType `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"`
}

ServiceBrokerCondition contains condition information for a Broker.

func (*ServiceBrokerCondition) DeepCopy 

func (in *ServiceBrokerCondition) DeepCopy() *ServiceBrokerCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBrokerCondition.

func (*ServiceBrokerCondition) DeepCopyInto 

func (in *ServiceBrokerCondition) DeepCopyInto(out *ServiceBrokerCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBrokerConditionType 

type ServiceBrokerConditionType string

ServiceBrokerConditionType represents a broker condition value. 

const (
	// ServiceBrokerConditionReady represents the fact that a given broker condition
	// is in ready state.
	ServiceBrokerConditionReady ServiceBrokerConditionType = "Ready"

	// ServiceBrokerConditionFailed represents information about a final failure
	// that should not be retried.
	ServiceBrokerConditionFailed ServiceBrokerConditionType = "Failed"
)

type ServiceBrokerList 

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

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

ServiceBrokerList is a list of Brokers.

func (*ServiceBrokerList) DeepCopy 

func (in *ServiceBrokerList) DeepCopy() *ServiceBrokerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBrokerList.

func (*ServiceBrokerList) DeepCopyInto 

func (in *ServiceBrokerList) DeepCopyInto(out *ServiceBrokerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceBrokerList) DeepCopyObject 

func (in *ServiceBrokerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServiceBrokerRelistBehavior 

type ServiceBrokerRelistBehavior string

ServiceBrokerRelistBehavior represents a type of broker relist behavior. 

const (
	// ServiceBrokerRelistBehaviorDuration indicates that the broker will be
	// relisted automatically after the specified duration has passed.
	ServiceBrokerRelistBehaviorDuration ServiceBrokerRelistBehavior = "Duration"

	// ServiceBrokerRelistBehaviorManual indicates that the broker is only
	// relisted when the spec of the broker changes.
	ServiceBrokerRelistBehaviorManual ServiceBrokerRelistBehavior = "Manual"
)

type ServiceBrokerSpec 

type ServiceBrokerSpec struct {
	CommonServiceBrokerSpec `json:",inline"`

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

ServiceBrokerSpec represents a description of a Broker.

func (*ServiceBrokerSpec) DeepCopy 

func (in *ServiceBrokerSpec) DeepCopy() *ServiceBrokerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBrokerSpec.

func (*ServiceBrokerSpec) DeepCopyInto 

func (in *ServiceBrokerSpec) DeepCopyInto(out *ServiceBrokerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceBrokerStatus 

type ServiceBrokerStatus struct {
	CommonServiceBrokerStatus `json:",inline"`
}

ServiceBrokerStatus the current status of a ServiceBroker.

func (*ServiceBrokerStatus) DeepCopy 

func (in *ServiceBrokerStatus) DeepCopy() *ServiceBrokerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceBrokerStatus.

func (*ServiceBrokerStatus) DeepCopyInto 

func (in *ServiceBrokerStatus) DeepCopyInto(out *ServiceBrokerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceClass 

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

	// The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the service class.
	// +optional
	Spec ServiceClassSpec `json:"spec,omitempty"`

	// Status represents the current status of a service class.
	// +optional
	Status ServiceClassStatus `json:"status,omitempty"`
}

ServiceClass represents a namespaced offering in the service catalog.

func (*ServiceClass) DeepCopy 

func (in *ServiceClass) DeepCopy() *ServiceClass

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceClass.

func (*ServiceClass) DeepCopyInto 

func (in *ServiceClass) DeepCopyInto(out *ServiceClass)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceClass) DeepCopyObject 

func (in *ServiceClass) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ServiceClass) GetDescription 

func (c *ServiceClass) GetDescription() string

GetDescription returns the class description.

func (*ServiceClass) GetExternalName 

func (c *ServiceClass) GetExternalName() string

GetExternalName returns the class's external name.

func (*ServiceClass) GetName 

func (c *ServiceClass) GetName() string

GetName returns the class's name.

func (*ServiceClass) GetNamespace 

func (c *ServiceClass) GetNamespace() string

GetNamespace returns the class's namespace.

func (*ServiceClass) GetServiceBrokerName 

func (c *ServiceClass) GetServiceBrokerName() string

GetServiceBrokerName returns the name of the service broker for the class.

func (*ServiceClass) GetSpec 

func (c *ServiceClass) GetSpec() CommonServiceClassSpec

GetSpec returns the spec for the class.

func (*ServiceClass) GetStatusText 

func (c *ServiceClass) GetStatusText() string

GetStatusText returns the status of the class.

func (*ServiceClass) IsClusterServiceClass 

func (c *ServiceClass) IsClusterServiceClass() bool

IsClusterServiceClass returns false for ServiceClasses

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) DeepCopy 

func (in *ServiceClassList) DeepCopy() *ServiceClassList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceClassList.

func (*ServiceClassList) DeepCopyInto 

func (in *ServiceClassList) DeepCopyInto(out *ServiceClassList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceClassList) DeepCopyObject 

func (in *ServiceClassList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServiceClassSpec 

type ServiceClassSpec struct {
	CommonServiceClassSpec `json:",inline"`

	// ServiceBrokerName is the reference to the Broker that provides this
	// ServiceClass.
	//
	// Immutable.
	ServiceBrokerName string `json:"serviceBrokerName"`
}

ServiceClassSpec represents the details about a ServiceClass

func (*ServiceClassSpec) DeepCopy 

func (in *ServiceClassSpec) DeepCopy() *ServiceClassSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceClassSpec.

func (*ServiceClassSpec) DeepCopyInto 

func (in *ServiceClassSpec) DeepCopyInto(out *ServiceClassSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceClassStatus 

type ServiceClassStatus struct {
	CommonServiceClassStatus `json:",inline"`
}

ServiceClassStatus represents status information about a ServiceClass.

func (*ServiceClassStatus) DeepCopy 

func (in *ServiceClassStatus) DeepCopy() *ServiceClassStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceClassStatus.

func (*ServiceClassStatus) DeepCopyInto 

func (in *ServiceClassStatus) DeepCopyInto(out *ServiceClassStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceInstance 

type ServiceInstance struct {
	metav1.TypeMeta `json:",inline"`

	// The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the service instance.
	// +optional
	Spec ServiceInstanceSpec `json:"spec,omitempty"`

	// Status represents the current status of a service instance.
	// +optional
	Status ServiceInstanceStatus `json:"status,omitempty"`
}

ServiceInstance represents a provisioned instance of a ServiceClass. Currently, the spec field cannot be changed once a ServiceInstance is created. Spec changes submitted by users will be ignored.

In the future, this will be allowed and will represent the intention that the ServiceInstance should have the plan and/or parameters updated at the ClusterServiceBroker. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,CLASS:.spec.clusterServiceClassExternalName,PLAN:.spec.clusterServicePlanExternalName

func (*ServiceInstance) DeepCopy 

func (in *ServiceInstance) DeepCopy() *ServiceInstance

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstance.

func (*ServiceInstance) DeepCopyInto 

func (in *ServiceInstance) DeepCopyInto(out *ServiceInstance)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceInstance) DeepCopyObject 

func (in *ServiceInstance) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ServiceInstance) IsUserSpecifiedClassOrPlan 

func (in *ServiceInstance) IsUserSpecifiedClassOrPlan() bool

IsUserSpecifiedClassOrPlan returns true if user specified class or plan is not empty

func (*ServiceInstance) RecalculatePrinterColumnStatusFields 

func (in *ServiceInstance) RecalculatePrinterColumnStatusFields()

RecalculatePrinterColumnStatusFields sets column status fields using status conditions

type ServiceInstanceCondition 

type ServiceInstanceCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceInstanceConditionType `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"`
}

ServiceInstanceCondition contains condition information about an Instance.

func (*ServiceInstanceCondition) DeepCopy 

func (in *ServiceInstanceCondition) DeepCopy() *ServiceInstanceCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstanceCondition.

func (*ServiceInstanceCondition) DeepCopyInto 

func (in *ServiceInstanceCondition) DeepCopyInto(out *ServiceInstanceCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceInstanceConditionType 

type ServiceInstanceConditionType string

ServiceInstanceConditionType represents a instance condition value. 

const (
	// ServiceInstanceConditionReady represents that a given InstanceCondition is in
	// ready state.
	ServiceInstanceConditionReady ServiceInstanceConditionType = "Ready"

	// ServiceInstanceConditionFailed represents information about a final failure
	// that should not be retried.
	ServiceInstanceConditionFailed ServiceInstanceConditionType = "Failed"

	// ServiceInstanceConditionOrphanMitigation represents information about an
	// orphan mitigation that is required after failed provisioning.
	ServiceInstanceConditionOrphanMitigation ServiceInstanceConditionType = "OrphanMitigation"
)

type ServiceInstanceDeprovisionStatus 

type ServiceInstanceDeprovisionStatus string

ServiceInstanceDeprovisionStatus is the status of deprovisioning a ServiceInstance 

const (
	// ServiceInstanceDeprovisionStatusNotRequired indicates that a provision
	// request has not been sent for the ServiceInstance, so no deprovision
	// request needs to be made.
	ServiceInstanceDeprovisionStatusNotRequired ServiceInstanceDeprovisionStatus = "NotRequired"
	// ServiceInstanceDeprovisionStatusRequired indicates that a provision
	// request has been sent for the ServiceInstance. A deprovision request
	// must be made before deleting the ServiceInstance.
	ServiceInstanceDeprovisionStatusRequired ServiceInstanceDeprovisionStatus = "Required"
	// ServiceInstanceDeprovisionStatusSucceeded indicates that a deprovision
	// request has been sent for the ServiceInstance, and the request was
	// successful.
	ServiceInstanceDeprovisionStatusSucceeded ServiceInstanceDeprovisionStatus = "Succeeded"
	// ServiceInstanceDeprovisionStatusFailed indicates that deprovision
	// requests have been sent for the ServiceInstance but they failed. The
	// controller has given up on sending more deprovision requests.
	ServiceInstanceDeprovisionStatusFailed ServiceInstanceDeprovisionStatus = "Failed"
)

type ServiceInstanceList 

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

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

ServiceInstanceList is a list of instances.

func (*ServiceInstanceList) DeepCopy 

func (in *ServiceInstanceList) DeepCopy() *ServiceInstanceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstanceList.

func (*ServiceInstanceList) DeepCopyInto 

func (in *ServiceInstanceList) DeepCopyInto(out *ServiceInstanceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServiceInstanceList) DeepCopyObject 

func (in *ServiceInstanceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServiceInstanceOperation 

type ServiceInstanceOperation string

ServiceInstanceOperation represents a type of operation the controller can be performing for a service instance in the OSB API. 

const (
	// ServiceInstanceOperationProvision indicates that the ServiceInstance is
	// being Provisioned.
	ServiceInstanceOperationProvision ServiceInstanceOperation = "Provision"
	// ServiceInstanceOperationUpdate indicates that the ServiceInstance is
	// being Updated.
	ServiceInstanceOperationUpdate ServiceInstanceOperation = "Update"
	// ServiceInstanceOperationDeprovision indicates that the ServiceInstance is
	// being Deprovisioned.
	ServiceInstanceOperationDeprovision ServiceInstanceOperation = "Deprovision"
)

type ServiceInstancePropertiesState 

type ServiceInstancePropertiesState struct {
	// ClusterServicePlanExternalName is the name of the plan that the
	// broker knows this ServiceInstance to be on. This is the human
	// readable plan name from the OSB API.
	ClusterServicePlanExternalName string `json:"clusterServicePlanExternalName"`

	// ClusterServicePlanExternalID is the external ID of the plan that the
	// broker knows this ServiceInstance to be on.
	ClusterServicePlanExternalID string `json:"clusterServicePlanExternalID"`

	// ServicePlanExternalName is the name of the plan that the broker knows this
	// ServiceInstance to be on. This is the human readable plan name from the
	// OSB API.
	ServicePlanExternalName string `json:"servicePlanExternalName,omitempty"`

	// ServicePlanExternalID is the external ID of the plan that the
	// broker knows this ServiceInstance to be on.
	ServicePlanExternalID string `json:"servicePlanExternalID,omitempty"`

	// Parameters is a blob of the parameters and their values that the broker
	// knows about for this ServiceInstance.  If a parameter was sourced from
	// a secret, its value will be "<redacted>" in this blob.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// ParameterChecksum is the checksum of the parameters that were sent.
	ParameterChecksum string `json:"parameterChecksum,omitempty"`

	// UserInfo is information about the user that made the request.
	UserInfo *UserInfo `json:"userInfo,omitempty"`
}

ServiceInstancePropertiesState is the state of a ServiceInstance that the ClusterServiceBroker knows about.

func (*ServiceInstancePropertiesState) DeepCopy 

func (in *ServiceInstancePropertiesState) DeepCopy() *ServiceInstancePropertiesState

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstancePropertiesState.

func (*ServiceInstancePropertiesState) DeepCopyInto 

func (in *ServiceInstancePropertiesState) DeepCopyInto(out *ServiceInstancePropertiesState)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceInstanceProvisionStatus 

type ServiceInstanceProvisionStatus string

ServiceInstanceProvisionStatus is the status of provisioning a ServiceInstance 

const (
	// ServiceInstanceProvisionStatusProvisioned indicates that the instance
	// was provisioned.
	ServiceInstanceProvisionStatusProvisioned ServiceInstanceProvisionStatus = "Provisioned"
	// ServiceInstanceProvisionStatusNotProvisioned indicates that the instance
	// was not ever provisioned or was deprovisioned.
	ServiceInstanceProvisionStatusNotProvisioned ServiceInstanceProvisionStatus = "NotProvisioned"
)

type ServiceInstanceSpec 

type ServiceInstanceSpec struct {
	// Specification of what ServiceClass/ServicePlan is being provisioned.
	PlanReference `json:",inline"`

	// ClusterServiceClassRef is a reference to the ClusterServiceClass
	// that the user selected. This is set by the controller based on the
	// cluster-scoped values specified in the PlanReference.
	ClusterServiceClassRef *ClusterObjectReference `json:"clusterServiceClassRef,omitempty"`
	// ClusterServicePlanRef is a reference to the ClusterServicePlan
	// that the user selected. This is set by the controller based on the
	// cluster-scoped values specified in the PlanReference.
	ClusterServicePlanRef *ClusterObjectReference `json:"clusterServicePlanRef,omitempty"`

	// ServiceClassRef is a reference to the ServiceClass that the user selected.
	// This is set by the controller based on the namespace-scoped values
	// specified in the PlanReference.
	ServiceClassRef *LocalObjectReference `json:"serviceClassRef,omitempty"`
	// ServicePlanRef is a reference to the ServicePlan that the user selected.
	// This is set by the controller based on the namespace-scoped values
	// specified in the PlanReference.
	ServicePlanRef *LocalObjectReference `json:"servicePlanRef,omitempty"`

	// Parameters is a set of the parameters to be passed to the underlying
	// broker. The inline YAML/JSON payload to be translated into equivalent
	// JSON object. If a top-level parameter name exists in multiples sources
	// among `Parameters` and `ParametersFrom` fields, it is considered to be
	// a user error in the specification.
	//
	// The Parameters field is NOT secret or secured in any way and should
	// NEVER be used to hold sensitive information. To set parameters that
	// contain secret information, you should ALWAYS store that information
	// in a Secret and use the ParametersFrom field.
	//
	// +optional
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// List of sources to populate parameters.
	// If a top-level parameter name exists in multiples sources among
	// `Parameters` and `ParametersFrom` fields, it is
	// considered to be a user error in the specification
	// +optional
	ParametersFrom []ParametersFromSource `json:"parametersFrom,omitempty"`

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

	// Currently, this field is ALPHA: it may change or disappear at any time
	// and its data will not be migrated.
	//
	// UserInfo contains information about the user that last modified this
	// instance. This field is set by the API server and not settable by the
	// end-user. User-provided values for this field are not saved.
	// +optional
	UserInfo *UserInfo `json:"userInfo,omitempty"`

	// UpdateRequests is a strictly increasing, non-negative integer counter that
	// can be manually incremented by a user to manually trigger an update. This
	// allows for parameters to be updated with any out-of-band changes that have
	// been made to the secrets from which the parameters are sourced.
	// +optional
	UpdateRequests int64 `json:"updateRequests"`
}

ServiceInstanceSpec represents the desired state of an Instance.

func (*ServiceInstanceSpec) DeepCopy 

func (in *ServiceInstanceSpec) DeepCopy() *ServiceInstanceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstanceSpec.

func (*ServiceInstanceSpec) DeepCopyInto 

func (in *ServiceInstanceSpec) DeepCopyInto(out *ServiceInstanceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceInstanceStatus 

type ServiceInstanceStatus struct {
	// Conditions is an array of ServiceInstanceConditions capturing aspects of an
	// ServiceInstance's status.
	Conditions []ServiceInstanceCondition `json:"conditions"`

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

	// OrphanMitigationInProgress is set to true if there is an ongoing orphan
	// mitigation operation against this ServiceInstance in progress.
	OrphanMitigationInProgress bool `json:"orphanMitigationInProgress"`

	// 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"`

	// CurrentOperation is the operation the Controller is currently performing
	// on the ServiceInstance.
	CurrentOperation ServiceInstanceOperation `json:"currentOperation,omitempty"`

	// ReconciledGeneration is the 'Generation' of the serviceInstanceSpec that
	// was last processed by the controller. The reconciled generation is updated
	// even if the controller failed to process the spec.
	// Deprecated: use ObservedGeneration with conditions set to true to find
	// whether generation was reconciled.
	ReconciledGeneration int64 `json:"reconciledGeneration"`

	// ObservedGeneration is the 'Generation' of the serviceInstanceSpec that
	// was last processed by the controller. The observed generation is updated
	// whenever the status is updated regardless of operation result.
	ObservedGeneration int64 `json:"observedGeneration"`

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time `json:"operationStartTime,omitempty"`

	// InProgressProperties is the properties state of the ServiceInstance when
	// a Provision, Update or Deprovision is in progress.
	InProgressProperties *ServiceInstancePropertiesState `json:"inProgressProperties,omitempty"`

	// ExternalProperties is the properties state of the ServiceInstance which the
	// broker knows about.
	ExternalProperties *ServiceInstancePropertiesState `json:"externalProperties,omitempty"`

	// ProvisionStatus describes whether the instance is in the provisioned state.
	ProvisionStatus ServiceInstanceProvisionStatus `json:"provisionStatus"`

	// DeprovisionStatus describes what has been done to deprovision the
	// ServiceInstance.
	DeprovisionStatus ServiceInstanceDeprovisionStatus `json:"deprovisionStatus"`

	// DefaultProvisionParameters are the default parameters applied to this
	// instance.
	DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`

	// LastConditionState aggregates state from the Conditions array
	// It is used for printing in a kubectl output via additionalPrinterColumns
	LastConditionState string `json:"lastConditionState"`

	// UserSpecifiedPlanName aggregates cluster or namespace PlanName
	// It is used for printing in a kubectl output via additionalPrinterColumns
	UserSpecifiedPlanName string `json:"userSpecifiedPlanName"`

	// UserSpecifiedClassName aggregates cluster or namespace ClassName
	// It is used for printing in a kubectl output via additionalPrinterColumns
	UserSpecifiedClassName string `json:"userSpecifiedClassName"`
}

ServiceInstanceStatus represents the current status of an Instance.

func (*ServiceInstanceStatus) DeepCopy 

func (in *ServiceInstanceStatus) DeepCopy() *ServiceInstanceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceInstanceStatus.

func (*ServiceInstanceStatus) DeepCopyInto 

func (in *ServiceInstanceStatus) DeepCopyInto(out *ServiceInstanceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServicePlan 

type ServicePlan struct {
	metav1.TypeMeta `json:",inline"`

	// Non-namespaced.  The name of this resource in etcd is in ObjectMeta.Name.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of the service plan.
	// +optional
	Spec ServicePlanSpec `json:"spec,omitempty"`

	// Status represents the current status of the service plan.
	// +optional
	Status ServicePlanStatus `json:"status,omitempty"`
}

ServicePlan represents a tier of a ServiceClass. +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.serviceBrokerName,CLASS:.spec.serviceClassRef.name

func (*ServicePlan) DeepCopy 

func (in *ServicePlan) DeepCopy() *ServicePlan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServicePlan.

func (*ServicePlan) DeepCopyInto 

func (in *ServicePlan) DeepCopyInto(out *ServicePlan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServicePlan) DeepCopyObject 

func (in *ServicePlan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ServicePlan) GetBindingCreateSchema 

func (p *ServicePlan) GetBindingCreateSchema() *runtime.RawExtension

GetBindingCreateSchema returns the instance create schema from plan.

func (*ServicePlan) GetClassID 

func (p *ServicePlan) GetClassID() string

GetClassID returns the class name from plan.

func (*ServicePlan) GetDefaultProvisionParameters 

func (p *ServicePlan) GetDefaultProvisionParameters() *runtime.RawExtension

GetDefaultProvisionParameters returns the default provision parameters from plan.

func (*ServicePlan) GetDescription 

func (p *ServicePlan) GetDescription() string

GetDescription returns the plan description.

func (*ServicePlan) GetExternalName 

func (p *ServicePlan) GetExternalName() string

GetExternalName returns the plan's external name.

func (*ServicePlan) GetFree 

func (p *ServicePlan) GetFree() bool

GetFree returns if the plan is free.

func (*ServicePlan) GetInstanceCreateSchema 

func (p *ServicePlan) GetInstanceCreateSchema() *runtime.RawExtension

GetInstanceCreateSchema returns the instance create schema from plan.

func (*ServicePlan) GetInstanceUpdateSchema 

func (p *ServicePlan) GetInstanceUpdateSchema() *runtime.RawExtension

GetInstanceUpdateSchema returns the instance update schema from plan.

func (*ServicePlan) GetName 

func (p *ServicePlan) GetName() string

GetName returns the plan's name.

func (*ServicePlan) GetNamespace 

func (p *ServicePlan) GetNamespace() string

GetNamespace returns the plan's namespace.

func (*ServicePlan) GetShortStatus 

func (p *ServicePlan) GetShortStatus() string

GetShortStatus returns the plan's status.

type ServicePlanList 

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

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

ServicePlanList is a list of rServicePlans.

func (*ServicePlanList) DeepCopy 

func (in *ServicePlanList) DeepCopy() *ServicePlanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServicePlanList.

func (*ServicePlanList) DeepCopyInto 

func (in *ServicePlanList) DeepCopyInto(out *ServicePlanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServicePlanList) DeepCopyObject 

func (in *ServicePlanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServicePlanSpec 

type ServicePlanSpec struct {
	// CommonServicePlanSpec contains the common details of this ServicePlan
	CommonServicePlanSpec `json:",inline"`

	// ServiceBrokerName is the name of the ServiceBroker
	// that offers this ServicePlan.
	ServiceBrokerName string `json:"serviceBrokerName"`

	// ServiceClassRef is a reference to the service class that
	// owns this plan.
	ServiceClassRef LocalObjectReference `json:"serviceClassRef"`
}

ServicePlanSpec represents details about a ServicePlan.

func (*ServicePlanSpec) DeepCopy 

func (in *ServicePlanSpec) DeepCopy() *ServicePlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServicePlanSpec.

func (*ServicePlanSpec) DeepCopyInto 

func (in *ServicePlanSpec) DeepCopyInto(out *ServicePlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServicePlanStatus 

type ServicePlanStatus struct {
	CommonServicePlanStatus `json:",inline"`
}

ServicePlanStatus represents status information about a ServicePlan.

func (*ServicePlanStatus) DeepCopy 

func (in *ServicePlanStatus) DeepCopy() *ServicePlanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServicePlanStatus.

func (*ServicePlanStatus) DeepCopyInto 

func (in *ServicePlanStatus) DeepCopyInto(out *ServicePlanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserInfo 

type UserInfo struct {
	Username string                `json:"username"`
	UID      string                `json:"uid"`
	Groups   []string              `json:"groups,omitempty"`
	Extra    map[string]ExtraValue `json:"extra,omitempty"`
}

UserInfo holds information about the user that last changed a resource's spec.

func (*UserInfo) DeepCopy 

func (in *UserInfo) DeepCopy() *UserInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserInfo.

func (*UserInfo) DeepCopyInto 

func (in *UserInfo) DeepCopyInto(out *UserInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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.