servicecatalog

package
v0.0.16 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package servicecatalog contains all of the sources needed to make servicebrokers and their related service objects. +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 (
	FinalizerServiceCatalog string = "kubernetes-incubator/service-catalog"
)

These are internal 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
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_servicecatalog_BasicAuthConfig added in v0.0.15 

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

DeepCopy_servicecatalog_BasicAuthConfig is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BearerTokenAuthConfig added in v0.0.15 

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

DeepCopy_servicecatalog_BearerTokenAuthConfig is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_Binding 

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

DeepCopy_servicecatalog_Binding is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BindingCondition 

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

DeepCopy_servicecatalog_BindingCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BindingList 

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

DeepCopy_servicecatalog_BindingList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BindingSpec 

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

DeepCopy_servicecatalog_BindingSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BindingStatus 

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

DeepCopy_servicecatalog_BindingStatus is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_Broker 

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

DeepCopy_servicecatalog_Broker is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BrokerAuthInfo added in v0.0.10 

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

DeepCopy_servicecatalog_BrokerAuthInfo is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BrokerCondition 

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

DeepCopy_servicecatalog_BrokerCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BrokerList 

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

DeepCopy_servicecatalog_BrokerList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BrokerSpec 

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

DeepCopy_servicecatalog_BrokerSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_BrokerStatus 

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

DeepCopy_servicecatalog_BrokerStatus is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_Instance 

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

DeepCopy_servicecatalog_Instance is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_InstanceCondition 

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

DeepCopy_servicecatalog_InstanceCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_InstanceList 

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

DeepCopy_servicecatalog_InstanceList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_InstanceSpec 

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

DeepCopy_servicecatalog_InstanceSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_InstanceStatus 

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

DeepCopy_servicecatalog_InstanceStatus is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ParametersFromSource added in v0.0.16 

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

DeepCopy_servicecatalog_ParametersFromSource is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_SecretKeyReference added in v0.0.16 

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

DeepCopy_servicecatalog_SecretKeyReference is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceClass 

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

DeepCopy_servicecatalog_ServiceClass is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceClassList 

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

DeepCopy_servicecatalog_ServiceClassList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServicePlan 

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

DeepCopy_servicecatalog_ServicePlan is an autogenerated deepcopy function.

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterDeepCopies 

func RegisterDeepCopies(scheme *runtime.Scheme) error

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

func RegisterDefaults 

func RegisterDefaults(scheme *runtime.Scheme) error

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

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type BasicAuthConfig added in v0.0.15 

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

BasicAuthConfig provides config for the basic authentication.

type BearerTokenAuthConfig added in v0.0.15 

type BearerTokenAuthConfig struct {
	// SecretRef is a reference to a Secret containing information the
	// catalog should use to authenticate to this Broker.
	//
	// Required field:
	// - Secret.Data["token"] - bearer token for authentication
	SecretRef *v1.ObjectReference
}

BearerTokenAuthConfig provides config for the bearer token authentication.

type Binding 

type Binding struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   BindingSpec
	Status BindingStatus
}

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

type BindingCondition 

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

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string
}

BindingCondition condition information for a Binding.

type BindingConditionType 

type BindingConditionType string

BindingConditionType represents a BindingCondition value. 

const (
	// BindingConditionReady represents a BindingCondition is in ready state.
	BindingConditionReady BindingConditionType = "Ready"

	// BindingConditionFailed represents a BindingCondition that has failed
	// completely and should not be retried.
	BindingConditionFailed BindingConditionType = "Failed"
)

type BindingList 

type BindingList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []Binding
}

BindingList is a list of Bindings.

type BindingSpec 

type BindingSpec struct {
	// InstanceRef is the reference to the Instance this Binding is to.
	//
	// Immutable.
	InstanceRef v1.LocalObjectReference

	// 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
	// +optional
	Parameters *runtime.RawExtension

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

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

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string
}

BindingSpec represents the desired state of a Binding.

type BindingStatus 

type BindingStatus struct {
	Conditions []BindingCondition

	// Checksum is the checksum of the BindingSpec that was last successfully
	// reconciled against the broker.
	Checksum *string
}

BindingStatus represents the current status of a Binding.

type Broker 

type Broker struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   BrokerSpec
	Status BrokerStatus
}

Broker represents an entity that provides ServiceClasses for use in the service catalog. Broker is backed by an OSBAPI v2 broker supporting the latest minor version of the v2 major version.

type BrokerAuthInfo added in v0.0.10 

type BrokerAuthInfo struct {
	// Basic provides configuration for basic authentication.
	Basic *BasicAuthConfig
	// 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

	// DEPRECATED: use `Basic` field for configuring basic authentication instead.
	// BasicAuthSecret is a reference to a Secret containing auth information the
	// catalog should use to authenticate to this Broker using basic auth.
	BasicAuthSecret *v1.ObjectReference
}

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

type BrokerCondition 

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

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string
}

BrokerCondition contains condition information for a Broker.

type BrokerConditionType 

type BrokerConditionType string

BrokerConditionType represents a broker condition value. 

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

type BrokerList 

type BrokerList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []Broker
}

BrokerList is a list of Brokers.

type BrokerSpec 

type BrokerSpec struct {
	// URL is the address used to communicate with the Broker.
	URL string

	// AuthInfo contains the data that the service catalog should use to authenticate
	// with the Broker.
	AuthInfo *BrokerAuthInfo
}

BrokerSpec represents a description of a Broker.

type BrokerStatus 

type BrokerStatus struct {
	Conditions []BrokerCondition

	// Checksum is the sha hash of the BrokerSpec that was last successfully
	// reconciled against the broker.
	Checksum *string
}

BrokerStatus represents the current status of a Broker.

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 Instance 

type Instance struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   InstanceSpec
	Status InstanceStatus
}

Instance represents a provisioned instance of a ServiceClass.

type InstanceCondition 

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

	// Status of the condition, one of ('True', 'False', 'Unknown').
	Status ConditionStatus

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	LastTransitionTime metav1.Time

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	Reason string

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	Message string
}

InstanceCondition contains condition information about an Instance.

type InstanceConditionType 

type InstanceConditionType string

InstanceConditionType represents a instance condition value. 

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

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

type InstanceList 

type InstanceList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []Instance
}

InstanceList is a list of instances.

type InstanceSpec 

type InstanceSpec struct {
	// ServiceClassName is the name of the ServiceClass this Instance
	// should be provisioned from.
	//
	// Immutable.
	ServiceClassName string

	// PlanName is the name of the ServicePlan this Instance should be
	// provisioned from.
	PlanName string

	// 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
	// +optional
	Parameters *runtime.RawExtension

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

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string
}

InstanceSpec represents the desired state of an Instance.

type InstanceStatus 

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

	// AsyncOpInProgress is set to true if there is an ongoing async operation
	// against this Instance in progress.
	AsyncOpInProgress bool

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

	// DashboardURL is the URL of a web-based management user interface for
	// the service instance.
	DashboardURL *string

	// Checksum is the checksum of the InstanceSpec that was last successfully
	// reconciled against the broker.
	Checksum *string
}

InstanceStatus represents the current status of an Instance.

type ParametersFromSource added in v0.0.16 

type ParametersFromSource struct {
	// The Secret key to select from.
	// The value must be a JSON object.
	//+optional
	SecretKeyRef *SecretKeyReference
}

ParametersFromSource represents the source of a set of Parameters

type SecretKeyReference added in v0.0.16 

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

SecretKeyReference references a key of a Secret.

type ServiceClass 

type ServiceClass struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// BrokerName is the reference to the Broker that provides this
	// ServiceClass.
	//
	// Immutable.
	BrokerName string

	// Description is a short description of this ServiceClass.
	Description string

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

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

	// PlanUpdatable indicates whether instances provisioned from this
	// ServiceClass may change ServicePlans after being provisioned.
	PlanUpdatable bool

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string

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

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

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

ServiceClass represents an offering in the service catalog.

type ServiceClassList 

type ServiceClassList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []ServiceClass
}

ServiceClassList is a list of ServiceClasses.

type ServicePlan 

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

	// ExternalID is the identity of this object for use with the OSB API.
	//
	// Immutable.
	ExternalID string

	// Description is a short description of this ServicePlan.
	Description string

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

	// Free indicates whether this ServicePlan is available at no cost.
	Free bool

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

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

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

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

ServicePlan represents a tier of a ServiceClass.

Source Files

View all Source files

Directories

Path Synopsis
checksum
unversioned
versioned/v1alpha1
Package install registers the service-catalog API group
 Package install registers the service-catalog API group
Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable.
 Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable.
Package v1alpha1 defines all of the versioned (v1alpha1) definitions of the service catalog model.
 Package v1alpha1 defines all of the versioned (v1alpha1) definitions of the service catalog model.

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.