servicecatalog

package
v0.0.21 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 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 (
	// 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 ServiceInstanceConditionType = "Failed"
)
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.16 

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.16 

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

DeepCopy_servicecatalog_BearerTokenAuthConfig 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_ServiceBroker added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBroker is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceBrokerAuthInfo added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBrokerAuthInfo is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceBrokerCondition added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBrokerCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceBrokerList added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBrokerList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceBrokerSpec added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBrokerSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceBrokerStatus added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceBrokerStatus 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_ServiceInstance added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstance is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCondition added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCredential added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCredential is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCredentialCondition added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCredentialCondition is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCredentialList added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCredentialList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCredentialSpec added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCredentialSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceCredentialStatus added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceCredentialStatus is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceList added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceList is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceSpec added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceSpec is an autogenerated deepcopy function.

func DeepCopy_servicecatalog_ServiceInstanceStatus added in v0.0.17 

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

DeepCopy_servicecatalog_ServiceInstanceStatus 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 DeepCopy_servicecatalog_UserInfo added in v0.0.20 

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

DeepCopy_servicecatalog_UserInfo 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.16 

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 *v1.ObjectReference
}

BasicAuthConfig provides config for the basic authentication.

type BearerTokenAuthConfig added in v0.0.16 

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 *v1.ObjectReference
}

BearerTokenAuthConfig provides config for the bearer token authentication.

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 added in v0.0.20 

type ExtraValue []string

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

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 ServiceBroker added in v0.0.17 

type ServiceBroker struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   ServiceBrokerSpec
	Status ServiceBrokerStatus
}

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

type ServiceBrokerAuthInfo added in v0.0.17 

type ServiceBrokerAuthInfo 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 ServiceBroker using basic auth.
	BasicAuthSecret *v1.ObjectReference
}

ServiceBrokerAuthInfo 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 ServiceBrokerCondition added in v0.0.17 

type ServiceBrokerCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceBrokerConditionType

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

ServiceBrokerCondition contains condition information for a Broker.

type ServiceBrokerConditionType added in v0.0.17 

type ServiceBrokerConditionType string

ServiceBrokerConditionType represents a broker condition value.

type ServiceBrokerList added in v0.0.17 

type ServiceBrokerList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []ServiceBroker
}

ServiceBrokerList is a list of Brokers.

type ServiceBrokerRelistBehavior added in v0.0.21 

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 added in v0.0.17 

type ServiceBrokerSpec struct {
	// URL is the address used to communicate with the ServiceBroker.
	URL string

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

	// InsecureSkipTLSVerify disables TLS certificate verification when communicating with this Broker.
	// This is strongly discouraged.  You should use the CABundle instead.
	// +optional
	InsecureSkipTLSVerify bool
	// CABundle is a PEM encoded CA bundle which will be used to validate a Broker's serving certificate.
	// +optional
	CABundle []byte

	// RelistBehavior specifies the type of relist behavior the catalog should
	// exhibit when relisting ServiceClasses available from a broker.
	RelistBehavior ServiceBrokerRelistBehavior

	// RelistDuration is the frequency by which a controller will relist the
	// broker when the RelistBehavior is set to ServiceBrokerRelistBehaviorDuration.
	RelistDuration *metav1.Duration

	// RelistRequests is a strictly increasing, non-negative integer counter that
	// can be manually incremented by a user to manually trigger a relist.
	RelistRequests int64
}

ServiceBrokerSpec represents a description of a Broker.

type ServiceBrokerStatus added in v0.0.17 

type ServiceBrokerStatus struct {
	Conditions []ServiceBrokerCondition

	// ReconciledGeneration is the 'Generation' of the serviceBrokerSpec that
	// was last processed by the controller. The reconciled generation is updated
	// even if the controller failed to process the spec.
	ReconciledGeneration int64

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time
}

ServiceBrokerStatus represents the current status of a Broker.

type ServiceClass 

type ServiceClass struct {
	metav1.TypeMeta
	metav1.ObjectMeta

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

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

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

	// 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.
	Tags []string

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

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 ServiceInstance added in v0.0.17 

type ServiceInstance struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   ServiceInstanceSpec
	Status ServiceInstanceStatus
}

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 ServiceBroker.

type ServiceInstanceCondition added in v0.0.17 

type ServiceInstanceCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceInstanceConditionType

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

ServiceInstanceCondition contains condition information about an Instance.

type ServiceInstanceConditionType added in v0.0.17 

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

type ServiceInstanceCredential added in v0.0.17 

type ServiceInstanceCredential struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   ServiceInstanceCredentialSpec
	Status ServiceInstanceCredentialStatus
}

ServiceInstanceCredential represents a "used by" relationship between an application and an ServiceInstance.

type ServiceInstanceCredentialCondition added in v0.0.17 

type ServiceInstanceCredentialCondition struct {
	// Type of the condition, currently ('Ready').
	Type ServiceInstanceCredentialConditionType

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

ServiceInstanceCredentialCondition condition information for a ServiceInstanceCredential.

type ServiceInstanceCredentialConditionType added in v0.0.17 

type ServiceInstanceCredentialConditionType string

ServiceInstanceCredentialConditionType represents a ServiceInstanceCredentialCondition value. 

const (
	// ServiceInstanceCredentialConditionReady represents a ServiceInstanceCredentialCondition is in ready state.
	ServiceInstanceCredentialConditionReady ServiceInstanceCredentialConditionType = "Ready"

	// ServiceInstanceCredentialConditionFailed represents a ServiceInstanceCredentialCondition that has failed
	// completely and should not be retried.
	ServiceInstanceCredentialConditionFailed ServiceInstanceCredentialConditionType = "Failed"
)

type ServiceInstanceCredentialList added in v0.0.17 

type ServiceInstanceCredentialList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []ServiceInstanceCredential
}

ServiceInstanceCredentialList is a list of ServiceInstanceCredentials.

type ServiceInstanceCredentialSpec added in v0.0.17 

type ServiceInstanceCredentialSpec struct {
	// ServiceInstanceRef is the reference to the Instance this ServiceInstanceCredential is to.
	//
	// Immutable.
	ServiceInstanceRef 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 ServiceInstanceCredential's
	// namespace that will hold the credentials associated with the ServiceInstanceCredential.
	SecretName string

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

	// 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
	// ServiceInstanceCredential. 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
}

ServiceInstanceCredentialSpec represents the desired state of a ServiceInstanceCredential.

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

type ServiceInstanceCredentialStatus added in v0.0.17 

type ServiceInstanceCredentialStatus struct {
	Conditions []ServiceInstanceCredentialCondition

	// ReconciledGeneration is the 'Generation' of the
	// serviceInstanceCredentialSpec that was last processed by the controller.
	// The reconciled generation is updated even if the controller failed to
	// process the spec.
	ReconciledGeneration int64

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time
}

ServiceInstanceCredentialStatus represents the current status of a ServiceInstanceCredential.

type ServiceInstanceList added in v0.0.17 

type ServiceInstanceList struct {
	metav1.TypeMeta
	metav1.ListMeta

	Items []ServiceInstance
}

ServiceInstanceList is a list of instances.

type ServiceInstanceSpec added in v0.0.17 

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

	// PlanName is the name of the ServicePlan this ServiceInstance 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

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

ServiceInstanceSpec represents the desired state of an Instance.

type ServiceInstanceStatus added in v0.0.17 

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

	// AsyncOpInProgress is set to true if there is an ongoing async operation
	// against this ServiceInstance 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

	// 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.
	ReconciledGeneration int64

	// OperationStartTime is the time at which the current operation began.
	OperationStartTime *metav1.Time
}

ServiceInstanceStatus represents the current status of an Instance.

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 ServiceInstance
	// 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.
	//
	// ServiceInstanceCreateParameterSchema is the schema for the parameters
	// that may be supplied when provisioning a new ServiceInstance on this plan.
	ServiceInstanceCreateParameterSchema *runtime.RawExtension

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

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

ServicePlan represents a tier of a ServiceClass.

type UserInfo added in v0.0.20 

type UserInfo struct {
	Username string
	UID      string
	Groups   []string
	Extra    map[string]ExtraValue
}

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

Source Files

View all Source files

Directories

Path Synopsis
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.