v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the services v1alpha1 API group +kubebuilder:object:generate=true +groupName=services.cloudfoundry.org

Index

• Constants
• Variables
• type CFServiceBinding
  • func (in *CFServiceBinding) DeepCopy() *CFServiceBinding
  • func (in *CFServiceBinding) DeepCopyInto(out *CFServiceBinding)
  • func (in *CFServiceBinding) DeepCopyObject() runtime.Object
• type CFServiceBindingList
  • func (in *CFServiceBindingList) DeepCopy() *CFServiceBindingList
  • func (in *CFServiceBindingList) DeepCopyInto(out *CFServiceBindingList)
  • func (in *CFServiceBindingList) DeepCopyObject() runtime.Object
• type CFServiceBindingSpec
  • func (in *CFServiceBindingSpec) DeepCopy() *CFServiceBindingSpec
  • func (in *CFServiceBindingSpec) DeepCopyInto(out *CFServiceBindingSpec)
• type CFServiceBindingStatus
  • func (in *CFServiceBindingStatus) DeepCopy() *CFServiceBindingStatus
  • func (in *CFServiceBindingStatus) DeepCopyInto(out *CFServiceBindingStatus)
• type CFServiceInstance
  • func (in *CFServiceInstance) DeepCopy() *CFServiceInstance
  • func (in *CFServiceInstance) DeepCopyInto(out *CFServiceInstance)
  • func (in *CFServiceInstance) DeepCopyObject() runtime.Object
• type CFServiceInstanceList
  • func (in *CFServiceInstanceList) DeepCopy() *CFServiceInstanceList
  • func (in *CFServiceInstanceList) DeepCopyInto(out *CFServiceInstanceList)
  • func (in *CFServiceInstanceList) DeepCopyObject() runtime.Object
• type CFServiceInstanceSpec
  • func (in *CFServiceInstanceSpec) DeepCopy() *CFServiceInstanceSpec
  • func (in *CFServiceInstanceSpec) DeepCopyInto(out *CFServiceInstanceSpec)
• type CFServiceInstanceStatus
  • func (in *CFServiceInstanceStatus) DeepCopy() *CFServiceInstanceStatus
  • func (in *CFServiceInstanceStatus) DeepCopyInto(out *CFServiceInstanceStatus)
• type InstanceType

Constants

const (
	CFServiceInstanceGUIDLabelKey = "services.cloudfoundry.org/service-instance-guid"
)

const (
	UserProvidedType = "user-provided"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "services.cloudfoundry.org", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type CFServiceBinding

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

	Spec CFServiceBindingSpec `json:"spec,omitempty"`

	Status CFServiceBindingStatus `json:"status,omitempty"`
}

CFServiceBinding is the Schema for the cfservicebindings API

func (*CFServiceBinding) DeepCopy

func (in *CFServiceBinding) DeepCopy() *CFServiceBinding

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

func (*CFServiceBinding) DeepCopyInto

func (in *CFServiceBinding) DeepCopyInto(out *CFServiceBinding)

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

func (*CFServiceBinding) DeepCopyObject

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

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

type CFServiceBindingList

type CFServiceBindingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []CFServiceBinding `json:"items"`
}

CFServiceBindingList contains a list of CFServiceBinding

func (*CFServiceBindingList) DeepCopy

func (in *CFServiceBindingList) DeepCopy() *CFServiceBindingList

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

func (*CFServiceBindingList) DeepCopyInto

func (in *CFServiceBindingList) DeepCopyInto(out *CFServiceBindingList)

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

func (*CFServiceBindingList) DeepCopyObject

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

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

type CFServiceBindingSpec

type CFServiceBindingSpec struct {
	// Name defines the name of the Service Binding
	Name *string `json:"name,omitempty"`

	// Specifies the Service this binding uses
	Service v1.ObjectReference `json:"service"`

	// Specifies the App that owns this process
	AppRef v1.LocalObjectReference `json:"appRef"`
}

CFServiceBindingSpec defines the desired state of CFServiceBinding

func (*CFServiceBindingSpec) DeepCopy

func (in *CFServiceBindingSpec) DeepCopy() *CFServiceBindingSpec

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

func (*CFServiceBindingSpec) DeepCopyInto

func (in *CFServiceBindingSpec) DeepCopyInto(out *CFServiceBindingSpec)

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

type CFServiceBindingStatus

type CFServiceBindingStatus struct {
	// A reference to the Secret containing the credentials (same as spec.secretName).
	// This is required to conform to the Kubernetes Service Bindings spec
	Binding v1.LocalObjectReference `json:"binding"`

	// Conditions capture the current status of the CFServiceBinding
	Conditions []metav1.Condition `json:"conditions"`
}

CFServiceBindingStatus defines the observed state of CFServiceBinding

func (*CFServiceBindingStatus) DeepCopy

func (in *CFServiceBindingStatus) DeepCopy() *CFServiceBindingStatus

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

func (*CFServiceBindingStatus) DeepCopyInto

func (in *CFServiceBindingStatus) DeepCopyInto(out *CFServiceBindingStatus)

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

type CFServiceInstance

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

	Spec CFServiceInstanceSpec `json:"spec,omitempty"`

	Status CFServiceInstanceStatus `json:"status,omitempty"`
}

CFServiceInstance is the Schema for the cfserviceinstances API

func (*CFServiceInstance) DeepCopy

func (in *CFServiceInstance) DeepCopy() *CFServiceInstance

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

func (*CFServiceInstance) DeepCopyInto

func (in *CFServiceInstance) DeepCopyInto(out *CFServiceInstance)

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

func (*CFServiceInstance) DeepCopyObject

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

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

type CFServiceInstanceList

type CFServiceInstanceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []CFServiceInstance `json:"items"`
}

CFServiceInstanceList contains a list of CFServiceInstance

func (*CFServiceInstanceList) DeepCopy

func (in *CFServiceInstanceList) DeepCopy() *CFServiceInstanceList

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

func (*CFServiceInstanceList) DeepCopyInto

func (in *CFServiceInstanceList) DeepCopyInto(out *CFServiceInstanceList)

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

func (*CFServiceInstanceList) DeepCopyObject

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

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

type CFServiceInstanceSpec

type CFServiceInstanceSpec struct {
	// Name defines the name of the Service Instance
	Name string `json:"name"`

	// Name of a secret containing the service credentials
	SecretName string `json:"secretName"`

	// Type of the Service Instance. Must be `user-provided`
	Type InstanceType `json:"type"`

	// Tags are used by apps to identify service instances
	Tags []string `json:"tags,omitempty"`
}

CFServiceInstanceSpec defines the desired state of CFServiceInstance

func (*CFServiceInstanceSpec) DeepCopy

func (in *CFServiceInstanceSpec) DeepCopy() *CFServiceInstanceSpec

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

func (*CFServiceInstanceSpec) DeepCopyInto

func (in *CFServiceInstanceSpec) DeepCopyInto(out *CFServiceInstanceSpec)

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

type CFServiceInstanceStatus

type CFServiceInstanceStatus struct {
	// A reference to the Secret containing the credentials (same as spec.secretName).
	// This is required to conform to the Kubernetes Service Bindings spec
	Binding v1.LocalObjectReference `json:"binding"`

	// Conditions capture the current status of the CFServiceInstance
	Conditions []metav1.Condition `json:"conditions"`
}

CFServiceInstanceStatus defines the observed state of CFServiceInstance

func (*CFServiceInstanceStatus) DeepCopy

func (in *CFServiceInstanceStatus) DeepCopy() *CFServiceInstanceStatus

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

func (*CFServiceInstanceStatus) DeepCopyInto

func (in *CFServiceInstanceStatus) DeepCopyInto(out *CFServiceInstanceStatus)

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

type InstanceType

type InstanceType string

InstanceType defines the type of the Service Instance +kubebuilder:validation:Enum=user-provided