v1

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the ibmcloud v1 API group +kubebuilder:object:generate=true +groupName=ibmcloud.ibm.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "ibmcloud.ibm.com", Version: "v1"}

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

Functions

This section is empty.

Types

type Binding 

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

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

Binding is an instance of a service binding resource on IBM Cloud. A Binding creates a secret with the service instance credentials.

func (*Binding) DeepCopy 

func (in *Binding) DeepCopy() *Binding

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

func (*Binding) DeepCopyInto 

func (in *Binding) DeepCopyInto(out *Binding)

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

func (*Binding) DeepCopyObject 

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

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

func (*Binding) GetMessage 

func (b *Binding) GetMessage() string

func (*Binding) GetState 

func (b *Binding) GetState() string

type BindingList 

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

BindingList contains a list of Binding

func (*BindingList) DeepCopy 

func (in *BindingList) DeepCopy() *BindingList

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

func (*BindingList) DeepCopyInto 

func (in *BindingList) DeepCopyInto(out *BindingList)

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

func (*BindingList) DeepCopyObject 

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

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

type BindingSpec 

type BindingSpec struct {
	// ServiceClass is the name of the service resource to bind
	ServiceName string `json:"serviceName"`
	// ServiceNamespace is the namespace of the service resource to bind
	// +optional
	ServiceNamespace string `json:"serviceNamespace,omitempty"`
	// SecretName is the name of the secret where credentials will be stored
	// +optional
	SecretName string `json:"secretName,omitempty"`
	// Role is the role for the credentials
	// +optional
	Role string `json:"role,omitempty"`
	// Alias is the name for the credentials to be aliased
	// +optional
	Alias string `json:"alias,omitempty"`
	// Parameters pass configuration to the service during creation
	// +optional
	Parameters []Param `json:"parameters,omitempty"`
}

BindingSpec defines the desired state of Binding

func (*BindingSpec) DeepCopy 

func (in *BindingSpec) DeepCopy() *BindingSpec

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

func (*BindingSpec) DeepCopyInto 

func (in *BindingSpec) DeepCopyInto(out *BindingSpec)

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

type BindingStatus 

type BindingStatus struct {
	// State is a short name for the current status
	State string `json:"state,omitempty"`
	// Message is a detailed message on current status
	Message string `json:"message,omitempty"`

	// +optional
	Generation int64 `json:"generation,omitempty"`
	// InstanceID is the instance ID for the service
	// +optional
	InstanceID string `json:"instanceId,omitempty"`
	// KeyInstanceID is the key instance ID for the credentials
	// +optional
	KeyInstanceID string `json:"keyInstanceId,omitempty"`
	// SecretName is the name of the generated secret with service credentials
	// +optional
	SecretName string `json:"secretName,omitempty"`
}

BindingStatus defines the observed state of Binding

func (*BindingStatus) DeepCopy 

func (in *BindingStatus) DeepCopy() *BindingStatus

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

func (*BindingStatus) DeepCopyInto 

func (in *BindingStatus) DeepCopyInto(out *BindingStatus)

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

type Param 

type Param struct {
	// Name representing the key.
	Name string `json:"name"`

	// A parameter may have attributes (e.g. message hub topic might have partitions)
	// +optional
	Attributes map[string]ParamValue `json:"attributes,omitempty"`

	// Defaults to null.
	// +optional
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	Value *ParamValue `json:"value,omitempty"`

	// Source for the value. Cannot be used if value is not empty.
	// +optional
	ValueFrom *ParamSource `json:"valueFrom,omitempty"`
}

Param represents a key-value pair

func (*Param) DeepCopy 

func (in *Param) DeepCopy() *Param

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

func (*Param) DeepCopyInto 

func (in *Param) DeepCopyInto(out *Param)

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

type ParamSource 

type ParamSource struct {
	// Selects a key of a ConfigMap.
	// +optional
	ConfigMapKeyRef *v1.ConfigMapKeySelector `json:"configMapKeyRef,omitempty"`

	// Selects a key of a secret in the resource namespace
	// +optional
	SecretKeyRef *v1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

ParamSource represents a source for the value of a Param.

func (*ParamSource) DeepCopy 

func (in *ParamSource) DeepCopy() *ParamSource

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

func (*ParamSource) DeepCopyInto 

func (in *ParamSource) DeepCopyInto(out *ParamSource)

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

type ParamValue 

type ParamValue struct {
	json.RawMessage `json:"-"`
}

func (*ParamValue) DeepCopy 

func (in *ParamValue) DeepCopy() *ParamValue

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

func (*ParamValue) DeepCopyInto 

func (in *ParamValue) DeepCopyInto(out *ParamValue)

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

type ResourceContext 

type ResourceContext struct {
	// +optional
	Org string `json:"org,omitempty"`
	// +optional
	Space string `json:"space,omitempty"`
	// +optional
	Region string `json:"region,omitempty"`
	// +optional
	ResourceGroupID string `json:"resourcegroupid,omitempty"`
	// +optional
	ResourceLocation string `json:"resourcelocation,omitempty"`
	// +optional
	User string `json:"user,omitempty"`
}

ResourceContext defines the CloudFoundry context and resource group

func (*ResourceContext) DeepCopy 

func (in *ResourceContext) DeepCopy() *ResourceContext

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

func (*ResourceContext) DeepCopyInto 

func (in *ResourceContext) DeepCopyInto(out *ResourceContext)

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

type Service 

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

	Spec   ServiceSpec   `json:"spec,omitempty"`
	Status ServiceStatus `json:"status,omitempty"`
}

Service is an instance of a Service resource on IBM Cloud.

func (*Service) DeepCopy 

func (in *Service) DeepCopy() *Service

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

func (*Service) DeepCopyInto 

func (in *Service) DeepCopyInto(out *Service)

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

func (*Service) DeepCopyObject 

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

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

func (*Service) GetMessage 

func (s *Service) GetMessage() string

func (*Service) GetState 

func (s *Service) GetState() string

type ServiceContext 

type ServiceContext struct {
	// +optional
	Org string `json:"org,omitempty"`
	// +optional
	Space string `json:"space,omitempty"`
	// +optional
	Region string `json:"region,omitempty"`
	// +optional
	ResourceGroup string `json:"resourcegroup,omitempty"`
	// +optional
	ResourceGroupID string `json:"resourcegroupid,omitempty"`
	// +optional
	ResourceLocation string `json:"resourcelocation,omitempty"`
	// +optional
	User string `json:"user,omitempty"`
}

func (*ServiceContext) DeepCopy 

func (in *ServiceContext) DeepCopy() *ServiceContext

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

func (*ServiceContext) DeepCopyInto 

func (in *ServiceContext) DeepCopyInto(out *ServiceContext)

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

type ServiceList 

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

ServiceList contains a list of Service

func (*ServiceList) DeepCopy 

func (in *ServiceList) DeepCopy() *ServiceList

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

func (*ServiceList) DeepCopyInto 

func (in *ServiceList) DeepCopyInto(out *ServiceList)

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

func (*ServiceList) DeepCopyObject 

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

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

type ServiceSpec 

type ServiceSpec struct {
	// ServiceClass is the name of the service from the IBM Cloud Catalog
	ServiceClass string `json:"serviceClass"`
	// Plan for the service from the IBM Cloud Catalog
	Plan string `json:"plan"`
	// ServiceClassType is set to CF if the service is CloundFoundry
	// +optional
	ServiceClassType string `json:"serviceClassType,omitempty"`
	// ExternalName is the name for the service as it appears on IBM Cloud
	// +optional
	ExternalName string `json:"externalName,omitempty"`
	// Parameters pass configuration to the service during creation
	// +optional
	Parameters []Param `json:"parameters,omitempty"`
	// +optional
	Tags []string `json:"tags,omitempty"`
	// +optional
	Context ResourceContext `json:"context,omitempty"`
}

ServiceSpec defines the desired state of Service

func (*ServiceSpec) DeepCopy 

func (in *ServiceSpec) DeepCopy() *ServiceSpec

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

func (*ServiceSpec) DeepCopyInto 

func (in *ServiceSpec) DeepCopyInto(out *ServiceSpec)

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

type ServiceStatus 

type ServiceStatus struct {
	// State is a short name for the current status
	State string `json:"state,omitempty"`
	// Message is a detailed message on current status
	Message string `json:"message,omitempty"`

	Generation int64 `json:"generation,omitempty"`

	// ServiceClass is the name of the service from the IBM Cloud Catalog
	ServiceClass string `json:"serviceClass"`
	// ServiceClassType is set to CF if the service is CloundFoundry
	ServiceClassType string `json:"serviceClassType"`
	// Plan for the service from the IBM Cloud Catalog
	Plan string `json:"plan"`
	// InstanceID is the instance ID for the service
	// +optional
	InstanceID string `json:"instanceId,omitempty"`
	// ExternalName is the name for the service as it appears on IBM Cloud
	// +optional
	ExternalName string `json:"externalName,omitempty"`
	// +optional
	Context ResourceContext `json:"context,omitempty"`
	// Parameters pass configuration to the service during creation
	// +optional
	Parameters []Param `json:"parameters,omitempty"`
	// +optional
	Tags []string `json:"tags,omitempty"`
	// DashboardURL is the dashboard URL for the service
	// +optional
	DashboardURL string `json:"dashboardURL,omitempty"`
}

ServiceStatus defines the observed state of Service

func (*ServiceStatus) DeepCopy 

func (in *ServiceStatus) DeepCopy() *ServiceStatus

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

func (*ServiceStatus) DeepCopyInto 

func (in *ServiceStatus) DeepCopyInto(out *ServiceStatus)

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.