v1alpha1

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the dbaas v1alpha1 API group +kubebuilder:object:generate=true +groupName=dbaas.redhat.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "dbaas.redhat.com", 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
)
View Source 
var ProviderFieldsMap = map[string]interface{}{
	v1beta1.CrunchyBridgeRegistration: map[string]v1beta1.ProvisioningParameterType{
		"Name":     v1beta1.ProvisioningName,
		"Provider": v1beta1.ProvisioningCloudProvider,
	},
	v1beta1.MongoDBAtlasRegistration: map[string]v1beta1.ProvisioningParameterType{
		"clusterName":  v1beta1.ProvisioningName,
		"providerName": v1beta1.ProvisioningCloudProvider,
		"ProjectName":  v1beta1.ProvisioningTeamProject,
	},
	v1beta1.RdsRegistration: map[string]v1beta1.ProvisioningParameterType{
		"Engine": v1beta1.ProvisioningDatabaseType,
	},
}

ProviderFieldsMap is the global map for the fields supported for each provider

Functions

func ConvertNameFrom added in v0.4.0 

func ConvertNameFrom(providerName string, name v1beta1.ProvisioningParameterType) string

ConvertNameFrom converts a provisioning parameter name from v1beta1

func ConvertNameTo added in v0.4.0 

func ConvertNameTo(providerName, name string) v1beta1.ProvisioningParameterType

ConvertNameTo converts a provisioning parameter name to v1beta1

Types

type CredentialField 

type CredentialField struct {
	// The name for this field.
	Key string `json:"key"`

	// A user-friendly name for this field.
	DisplayName string `json:"displayName"`

	// The type of field: string, maskedstring, integer, or boolean.
	Type string `json:"type"`

	// Defines if the field is required or not.
	Required bool `json:"required"`

	// Additional information about the field.
	HelpText string `json:"helpText,omitempty"`
}

CredentialField defines the attributes.

func (*CredentialField) DeepCopy 

func (in *CredentialField) DeepCopy() *CredentialField

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

func (*CredentialField) DeepCopyInto 

func (in *CredentialField) DeepCopyInto(out *CredentialField)

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

type DBaaSConnection 

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

	Spec   DBaaSConnectionSpec   `json:"spec,omitempty"`
	Status DBaaSConnectionStatus `json:"status,omitempty"`
}

DBaaSConnection defines the schema for the DBaaSConnection API.

func (*DBaaSConnection) ConvertFrom added in v0.4.0 

func (dst *DBaaSConnection) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1beta1) to this version.

func (*DBaaSConnection) ConvertTo added in v0.4.0 

func (src *DBaaSConnection) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this DBaaSConnection to the Hub version (v1beta1).

func (*DBaaSConnection) DeepCopy 

func (in *DBaaSConnection) DeepCopy() *DBaaSConnection

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

func (*DBaaSConnection) DeepCopyInto 

func (in *DBaaSConnection) DeepCopyInto(out *DBaaSConnection)

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

func (*DBaaSConnection) DeepCopyObject 

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

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

type DBaaSConnectionList 

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

DBaaSConnectionList contains a list of DBaaSConnections.

func (*DBaaSConnectionList) DeepCopy 

func (in *DBaaSConnectionList) DeepCopy() *DBaaSConnectionList

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

func (*DBaaSConnectionList) DeepCopyInto 

func (in *DBaaSConnectionList) DeepCopyInto(out *DBaaSConnectionList)

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

func (*DBaaSConnectionList) DeepCopyObject 

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

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

type DBaaSConnectionSpec 

type DBaaSConnectionSpec struct {
	// A reference to the relevant DBaaSInventory custom resource (CR).
	InventoryRef NamespacedName `json:"inventoryRef"`

	// The ID of the instance to connect to, as seen in the status of the referenced DBaaSInventory.
	InstanceID string `json:"instanceID,omitempty"`

	// A reference to the DBaaSInstance CR used, if the InstanceID is not specified.
	InstanceRef *NamespacedName `json:"instanceRef,omitempty"`
}

DBaaSConnectionSpec defines the desired state of a DBaaSConnection object.

func (*DBaaSConnectionSpec) ConvertFrom added in v0.4.0 

func (dst *DBaaSConnectionSpec) ConvertFrom(src *v1beta1.DBaaSConnectionSpec)

ConvertFrom converts the DBaaSConnectionSpec from the v1beta1 to this version.

func (*DBaaSConnectionSpec) DeepCopy 

func (in *DBaaSConnectionSpec) DeepCopy() *DBaaSConnectionSpec

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

func (*DBaaSConnectionSpec) DeepCopyInto 

func (in *DBaaSConnectionSpec) DeepCopyInto(out *DBaaSConnectionSpec)

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

type DBaaSConnectionStatus 

type DBaaSConnectionStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// The secret holding account credentials for accessing the database instance.
	CredentialsRef *corev1.LocalObjectReference `json:"credentialsRef,omitempty"`

	// A ConfigMap object holding non-sensitive information for connecting to the database instance.
	ConnectionInfoRef *corev1.LocalObjectReference `json:"connectionInfoRef,omitempty"`
}

DBaaSConnectionStatus defines the observed state of a DBaaSConnection object.

func (*DBaaSConnectionStatus) ConvertFrom added in v0.4.0 

func (dst *DBaaSConnectionStatus) ConvertFrom(src *v1beta1.DBaaSConnectionStatus)

ConvertFrom converts the DBaaSConnectionStatus from the v1beta1 to this version.

func (*DBaaSConnectionStatus) ConvertTo added in v0.4.0 

func (src *DBaaSConnectionStatus) ConvertTo(dst *v1beta1.DBaaSConnectionStatus)

ConvertTo convert this DBaaSConnectionStatus to v1beta1.DBaaSConnectionStatus

func (*DBaaSConnectionStatus) DeepCopy 

func (in *DBaaSConnectionStatus) DeepCopy() *DBaaSConnectionStatus

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

func (*DBaaSConnectionStatus) DeepCopyInto 

func (in *DBaaSConnectionStatus) DeepCopyInto(out *DBaaSConnectionStatus)

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

type DBaaSInstance added in v0.1.4 

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

	Spec   DBaaSInstanceSpec   `json:"spec,omitempty"`
	Status DBaaSInstanceStatus `json:"status,omitempty"`
}

DBaaSInstance defines the schema for the DBaaSInstance API.

func (*DBaaSInstance) ConvertFrom added in v0.4.0 

func (dst *DBaaSInstance) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1beta1) to this version.

func (*DBaaSInstance) ConvertTo added in v0.4.0 

func (src *DBaaSInstance) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this DBaaSInstance to the Hub version (v1beta1).

func (*DBaaSInstance) DeepCopy added in v0.1.4 

func (in *DBaaSInstance) DeepCopy() *DBaaSInstance

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

func (*DBaaSInstance) DeepCopyInto added in v0.1.4 

func (in *DBaaSInstance) DeepCopyInto(out *DBaaSInstance)

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

func (*DBaaSInstance) DeepCopyObject added in v0.1.4 

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

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

type DBaaSInstanceList added in v0.1.4 

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

DBaaSInstanceList contains a list of DBaaSInstances.

func (*DBaaSInstanceList) DeepCopy added in v0.1.4 

func (in *DBaaSInstanceList) DeepCopy() *DBaaSInstanceList

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

func (*DBaaSInstanceList) DeepCopyInto added in v0.1.4 

func (in *DBaaSInstanceList) DeepCopyInto(out *DBaaSInstanceList)

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

func (*DBaaSInstanceList) DeepCopyObject added in v0.1.4 

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

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

type DBaaSInstanceSpec added in v0.1.4 

type DBaaSInstanceSpec struct {
	// A reference to the relevant DBaaSInventory custom resource (CR).
	InventoryRef NamespacedName `json:"inventoryRef"`

	// The name of this instance in the database service.
	Name string `json:"name"`

	// Identifies the cloud-hosted database provider.
	CloudProvider string `json:"cloudProvider,omitempty"`

	// Identifies the deployment region for the cloud-hosted database provider.
	// For example, us-east-1.
	CloudRegion string `json:"cloudRegion,omitempty"`

	// Any other provider-specific parameters related to the instance, such as provisioning.
	OtherInstanceParams map[string]string `json:"otherInstanceParams,omitempty"`
}

DBaaSInstanceSpec defines the desired state of a DBaaSInstance object.

func (*DBaaSInstanceSpec) ConvertFrom added in v0.4.0 

func (dst *DBaaSInstanceSpec) ConvertFrom(src *v1beta1.DBaaSInstanceSpec) error

ConvertFrom converts the DBaaSInstanceSpec from the v1beta1 to this version.

func (*DBaaSInstanceSpec) ConvertTo added in v0.4.0 

func (src *DBaaSInstanceSpec) ConvertTo(dst *v1beta1.DBaaSInstanceSpec) error

ConvertTo convert this DBaaSInstanceSpec to v1beta1.DBaaSInstanceSpec

func (*DBaaSInstanceSpec) DeepCopy added in v0.1.4 

func (in *DBaaSInstanceSpec) DeepCopy() *DBaaSInstanceSpec

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

func (*DBaaSInstanceSpec) DeepCopyInto added in v0.1.4 

func (in *DBaaSInstanceSpec) DeepCopyInto(out *DBaaSInstanceSpec)

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

type DBaaSInstanceStatus added in v0.1.4 

type DBaaSInstanceStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// A provider-specific identifier for this instance in the database service.
	// It can contain one or more pieces of information used by the provider's operator to identify the instance on the database service.
	InstanceID string `json:"instanceID"`

	// Any other provider-specific information related to this instance.
	InstanceInfo map[string]string `json:"instanceInfo,omitempty"`

	// +kubebuilder:validation:Enum=Unknown;Pending;Creating;Updating;Deleting;Deleted;Ready;Error;Failed
	// +kubebuilder:default=Unknown
	// Represents the following cluster provisioning phases.
	// Unknown: An unknown cluster provisioning status.
	// Pending: In the queue, waiting for provisioning to start.
	// Creating: Provisioning is in progress.
	// Updating: Updating the cluster is in progress.
	// Deleting: Cluster deletion is in progress.
	// Deleted: Cluster has been deleted.
	// Ready: Cluster provisioning is done.
	// Error: Cluster provisioning error.
	// Failed: Cluster provisioning failed.
	Phase DBaasInstancePhase `json:"phase"`
}

DBaaSInstanceStatus defines the observed state of a DBaaSInstance.

func (*DBaaSInstanceStatus) ConvertFrom added in v0.4.0 

func (dst *DBaaSInstanceStatus) ConvertFrom(src *v1beta1.DBaaSInstanceStatus)

ConvertFrom converts the DBaaSInstanceStatus from the v1beta1 to this version.

func (*DBaaSInstanceStatus) ConvertTo added in v0.4.0 

func (src *DBaaSInstanceStatus) ConvertTo(dst *v1beta1.DBaaSInstanceStatus)

ConvertTo convert this DBaaSInstanceStatus to v1beta1.DBaaSInstanceStatus

func (*DBaaSInstanceStatus) DeepCopy added in v0.1.4 

func (in *DBaaSInstanceStatus) DeepCopy() *DBaaSInstanceStatus

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

func (*DBaaSInstanceStatus) DeepCopyInto added in v0.1.4 

func (in *DBaaSInstanceStatus) DeepCopyInto(out *DBaaSInstanceStatus)

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

type DBaaSInventory 

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

	Spec   DBaaSOperatorInventorySpec `json:"spec,omitempty"`
	Status DBaaSInventoryStatus       `json:"status,omitempty"`
}

DBaaSInventory defines the schema for the DBaaSInventory API. Inventory objects must be created in a valid namespace, determined by the existence of a DBaaSPolicy object.

func (*DBaaSInventory) ConvertFrom added in v0.4.0 

func (dst *DBaaSInventory) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1beta1) to this version.

func (*DBaaSInventory) ConvertTo added in v0.4.0 

func (src *DBaaSInventory) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this DBaaSInventory to the Hub version (v1beta1).

func (*DBaaSInventory) DeepCopy 

func (in *DBaaSInventory) DeepCopy() *DBaaSInventory

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

func (*DBaaSInventory) DeepCopyInto 

func (in *DBaaSInventory) DeepCopyInto(out *DBaaSInventory)

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

func (*DBaaSInventory) DeepCopyObject 

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

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

type DBaaSInventoryList 

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

DBaaSInventoryList contains a list of DBaaSInventories.

func (*DBaaSInventoryList) DeepCopy 

func (in *DBaaSInventoryList) DeepCopy() *DBaaSInventoryList

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

func (*DBaaSInventoryList) DeepCopyInto 

func (in *DBaaSInventoryList) DeepCopyInto(out *DBaaSInventoryList)

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

func (*DBaaSInventoryList) DeepCopyObject 

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

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

type DBaaSInventoryPolicy added in v0.2.0 

type DBaaSInventoryPolicy struct {
	// Disables provisioning on inventory accounts.
	DisableProvisions *bool `json:"disableProvisions,omitempty"`

	// Namespaces where DBaaSConnection and DBaaSInstance objects are only allowed to reference a policy's inventories.
	// Each inventory can individually override this.
	// Using an asterisk surrounded by single quotes ('*'), allows all namespaces.
	// If not set in the policy or by an inventory object, connections are only allowed in the inventory's namespace.
	ConnectionNamespaces *[]string `json:"connectionNamespaces,omitempty"`

	// Use a label selector to determine the namespaces where DBaaSConnection and DBaaSInstance objects are only allowed to reference a policy's inventories.
	// Each inventory can individually override this.
	// A label selector is a label query over a set of resources.
	// Results use a logical AND from matchExpressions and matchLabels queries.
	// An empty label selector matches all objects.
	// A null label selector matches no objects.
	ConnectionNsSelector *metav1.LabelSelector `json:"connectionNsSelector,omitempty"`
}

DBaaSInventoryPolicy sets the inventory policy.

func (*DBaaSInventoryPolicy) DeepCopy added in v0.2.0 

func (in *DBaaSInventoryPolicy) DeepCopy() *DBaaSInventoryPolicy

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

func (*DBaaSInventoryPolicy) DeepCopyInto added in v0.2.0 

func (in *DBaaSInventoryPolicy) DeepCopyInto(out *DBaaSInventoryPolicy)

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

type DBaaSInventorySpec 

type DBaaSInventorySpec struct {
	// The secret containing the provider-specific connection credentials to use with the provider's API endpoint.
	// The format specifies the secret in the provider’s operator for its DBaaSProvider custom resource (CR), such as the CredentialFields key.
	// The secret must exist within the same namespace as the inventory.
	CredentialsRef *LocalObjectReference `json:"credentialsRef"`
}

DBaaSInventorySpec defines the Inventory Spec to be used by provider operators

func (*DBaaSInventorySpec) DeepCopy 

func (in *DBaaSInventorySpec) DeepCopy() *DBaaSInventorySpec

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

func (*DBaaSInventorySpec) DeepCopyInto 

func (in *DBaaSInventorySpec) DeepCopyInto(out *DBaaSInventorySpec)

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

type DBaaSInventoryStatus 

type DBaaSInventoryStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// A list of instances returned from querying the database provider.
	Instances []Instance `json:"instances,omitempty"`
}

DBaaSInventoryStatus defines the inventory status that the provider's operator uses.

func (*DBaaSInventoryStatus) ConvertFrom added in v0.4.0 

func (dst *DBaaSInventoryStatus) ConvertFrom(src *v1beta1.DBaaSInventoryStatus)

ConvertFrom converts the DBaaSInventoryStatus from the v1beta1 to this version.

func (*DBaaSInventoryStatus) ConvertTo added in v0.4.0 

func (src *DBaaSInventoryStatus) ConvertTo(dst *v1beta1.DBaaSInventoryStatus)

ConvertTo convert this DBaaSInventoryStatus to v1beta1.DBaaSInventoryStatus

func (*DBaaSInventoryStatus) DeepCopy 

func (in *DBaaSInventoryStatus) DeepCopy() *DBaaSInventoryStatus

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

func (*DBaaSInventoryStatus) DeepCopyInto 

func (in *DBaaSInventoryStatus) DeepCopyInto(out *DBaaSInventoryStatus)

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

type DBaaSOperatorInventorySpec 

type DBaaSOperatorInventorySpec struct {
	// A reference to a DBaaSProvider custom resource (CR).
	ProviderRef NamespacedName `json:"providerRef"`

	// The properties that will be copied into the provider’s inventory.
	DBaaSInventorySpec `json:",inline"`

	// The policy for this inventory.
	DBaaSInventoryPolicy `json:",inline"`
}

DBaaSOperatorInventorySpec defines the desired state of a DBaaSInventory object.

func (*DBaaSOperatorInventorySpec) ConvertFrom added in v0.4.0 

func (dst *DBaaSOperatorInventorySpec) ConvertFrom(src *v1beta1.DBaaSOperatorInventorySpec)

ConvertFrom converts the DBaaSInventorySpec from the v1beta1 to this version.

func (*DBaaSOperatorInventorySpec) DeepCopy 

func (in *DBaaSOperatorInventorySpec) DeepCopy() *DBaaSOperatorInventorySpec

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

func (*DBaaSOperatorInventorySpec) DeepCopyInto 

func (in *DBaaSOperatorInventorySpec) DeepCopyInto(out *DBaaSOperatorInventorySpec)

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

type DBaaSPlatform 

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

	Spec   DBaaSPlatformSpec   `json:"spec,omitempty"`
	Status DBaaSPlatformStatus `json:"status,omitempty"`
}

DBaaSPlatform defines the schema for the DBaaSPlatform API.

func (*DBaaSPlatform) DeepCopy 

func (in *DBaaSPlatform) DeepCopy() *DBaaSPlatform

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

func (*DBaaSPlatform) DeepCopyInto 

func (in *DBaaSPlatform) DeepCopyInto(out *DBaaSPlatform)

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

func (*DBaaSPlatform) DeepCopyObject 

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

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

type DBaaSPlatformList 

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

DBaaSPlatformList contains a list of DBaaSPlatforms.

func (*DBaaSPlatformList) DeepCopy 

func (in *DBaaSPlatformList) DeepCopy() *DBaaSPlatformList

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

func (*DBaaSPlatformList) DeepCopyInto 

func (in *DBaaSPlatformList) DeepCopyInto(out *DBaaSPlatformList)

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

func (*DBaaSPlatformList) DeepCopyObject 

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

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

type DBaaSPlatformSpec 

type DBaaSPlatformSpec struct {
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=1440
	// The SyncPeriod set The minimum interval at which the provider operator controllers reconcile, the default value is 180 minutes.
	SyncPeriod *int `json:"syncPeriod,omitempty"`
}

DBaaSPlatformSpec defines the desired state of a DBaaSPlatform object.

func (*DBaaSPlatformSpec) DeepCopy 

func (in *DBaaSPlatformSpec) DeepCopy() *DBaaSPlatformSpec

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

func (*DBaaSPlatformSpec) DeepCopyInto 

func (in *DBaaSPlatformSpec) DeepCopyInto(out *DBaaSPlatformSpec)

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

type DBaaSPlatformStatus 

type DBaaSPlatformStatus struct {
	Conditions      []metav1.Condition `json:"conditions,omitempty"`
	PlatformsStatus []PlatformStatus   `json:"platformsStatus"`
}

DBaaSPlatformStatus defines the observed state of a DBaaSPlatform object.

func (*DBaaSPlatformStatus) DeepCopy 

func (in *DBaaSPlatformStatus) DeepCopy() *DBaaSPlatformStatus

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

func (*DBaaSPlatformStatus) DeepCopyInto 

func (in *DBaaSPlatformStatus) DeepCopyInto(out *DBaaSPlatformStatus)

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

type DBaaSPolicy added in v0.2.0 

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

	Spec   DBaaSPolicySpec   `json:"spec,omitempty"`
	Status DBaaSPolicyStatus `json:"status,omitempty"`
}

DBaaSPolicy enables administrative capabilities within a namespace, and sets a default inventory policy. Policy defaults can be overridden on a per-inventory basis.

func (*DBaaSPolicy) ConvertFrom added in v0.4.0 

func (dst *DBaaSPolicy) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1beta1) to this version.

func (*DBaaSPolicy) ConvertTo added in v0.4.0 

func (src *DBaaSPolicy) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this DBaaSPolicy to the Hub version (v1beta1).

func (*DBaaSPolicy) DeepCopy added in v0.2.0 

func (in *DBaaSPolicy) DeepCopy() *DBaaSPolicy

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

func (*DBaaSPolicy) DeepCopyInto added in v0.2.0 

func (in *DBaaSPolicy) DeepCopyInto(out *DBaaSPolicy)

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

func (*DBaaSPolicy) DeepCopyObject added in v0.2.0 

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

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

type DBaaSPolicyList added in v0.2.0 

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

DBaaSPolicyList contains a list of DBaaSPolicies.

func (*DBaaSPolicyList) DeepCopy added in v0.2.0 

func (in *DBaaSPolicyList) DeepCopy() *DBaaSPolicyList

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

func (*DBaaSPolicyList) DeepCopyInto added in v0.2.0 

func (in *DBaaSPolicyList) DeepCopyInto(out *DBaaSPolicyList)

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

func (*DBaaSPolicyList) DeepCopyObject added in v0.2.0 

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

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

type DBaaSPolicySpec added in v0.2.0 

type DBaaSPolicySpec struct {
	DBaaSInventoryPolicy `json:",inline"`
}

DBaaSPolicySpec The specifications for a _DBaaSPolicy_ object. Enables administrative capabilities within a namespace, and sets a default inventory policy. Policy defaults can be overridden on a per-inventory basis.

func (*DBaaSPolicySpec) DeepCopy added in v0.2.0 

func (in *DBaaSPolicySpec) DeepCopy() *DBaaSPolicySpec

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

func (*DBaaSPolicySpec) DeepCopyInto added in v0.2.0 

func (in *DBaaSPolicySpec) DeepCopyInto(out *DBaaSPolicySpec)

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

type DBaaSPolicyStatus added in v0.2.0 

type DBaaSPolicyStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

DBaaSPolicyStatus defines the observed state of a DBaaSPolicy object.

func (*DBaaSPolicyStatus) DeepCopy added in v0.2.0 

func (in *DBaaSPolicyStatus) DeepCopy() *DBaaSPolicyStatus

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

func (*DBaaSPolicyStatus) DeepCopyInto added in v0.2.0 

func (in *DBaaSPolicyStatus) DeepCopyInto(out *DBaaSPolicyStatus)

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

type DBaaSProvider 

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

	Spec   DBaaSProviderSpec   `json:"spec,omitempty"`
	Status DBaaSProviderStatus `json:"status,omitempty"`
}

DBaaSProvider defines the schema for the DBaaSProvider API.

func (*DBaaSProvider) ConvertFrom added in v0.4.0 

func (dst *DBaaSProvider) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1beta1) to this version.

func (*DBaaSProvider) ConvertTo added in v0.4.0 

func (src *DBaaSProvider) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this DBaaSProvider to the Hub version (v1beta1).

func (*DBaaSProvider) DeepCopy 

func (in *DBaaSProvider) DeepCopy() *DBaaSProvider

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

func (*DBaaSProvider) DeepCopyInto 

func (in *DBaaSProvider) DeepCopyInto(out *DBaaSProvider)

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

func (*DBaaSProvider) DeepCopyObject 

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

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

type DBaaSProviderConnection 

type DBaaSProviderConnection struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DBaaSConnectionSpec   `json:"spec,omitempty"`
	Status DBaaSConnectionStatus `json:"status,omitempty"`
}

DBaaSProviderConnection defines the schema for a provider's connection status.

func (*DBaaSProviderConnection) DeepCopy 

func (in *DBaaSProviderConnection) DeepCopy() *DBaaSProviderConnection

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

func (*DBaaSProviderConnection) DeepCopyInto 

func (in *DBaaSProviderConnection) DeepCopyInto(out *DBaaSProviderConnection)

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

type DBaaSProviderInstance added in v0.1.4 

type DBaaSProviderInstance struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DBaaSInstanceSpec   `json:"spec,omitempty"`
	Status DBaaSInstanceStatus `json:"status,omitempty"`
}

DBaaSProviderInstance defines the schema for a provider instance object.

func (*DBaaSProviderInstance) DeepCopy added in v0.1.4 

func (in *DBaaSProviderInstance) DeepCopy() *DBaaSProviderInstance

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

func (*DBaaSProviderInstance) DeepCopyInto added in v0.1.4 

func (in *DBaaSProviderInstance) DeepCopyInto(out *DBaaSProviderInstance)

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

type DBaaSProviderInventory 

type DBaaSProviderInventory struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DBaaSInventorySpec   `json:"spec,omitempty"`
	Status DBaaSInventoryStatus `json:"status,omitempty"`
}

DBaaSProviderInventory defines the schema for a provider's inventory status.

func (*DBaaSProviderInventory) DeepCopy 

func (in *DBaaSProviderInventory) DeepCopy() *DBaaSProviderInventory

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

func (*DBaaSProviderInventory) DeepCopyInto 

func (in *DBaaSProviderInventory) DeepCopyInto(out *DBaaSProviderInventory)

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

type DBaaSProviderList 

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

DBaaSProviderList contains a list of DBaaSProviders.

func (*DBaaSProviderList) DeepCopy 

func (in *DBaaSProviderList) DeepCopy() *DBaaSProviderList

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

func (*DBaaSProviderList) DeepCopyInto 

func (in *DBaaSProviderList) DeepCopyInto(out *DBaaSProviderList)

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

func (*DBaaSProviderList) DeepCopyObject 

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

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

type DBaaSProviderSpec 

type DBaaSProviderSpec struct {
	// Contains information about database provider and platform.
	Provider DatabaseProvider `json:"provider"`

	// The name of the inventory custom resource definition (CRD) as defined by the database provider.
	InventoryKind string `json:"inventoryKind"`

	// The name of the connection's custom resource definition (CRD) as defined by the provider.
	ConnectionKind string `json:"connectionKind"`

	// The name of the instance's custom resource definition (CRD) as defined by the provider for provisioning.
	InstanceKind string `json:"instanceKind"`

	// Indicates what information to collect from the user interface and how to display fields in a form.
	CredentialFields []CredentialField `json:"credentialFields"`

	// Indicates whether the provider offers free trials.
	AllowsFreeTrial bool `json:"allowsFreeTrial"`

	// The URL for provisioning instances by using the database provider's web portal.
	ExternalProvisionURL string `json:"externalProvisionURL"`

	// Instructions on how to provision instances by using the database provider's web portal.
	ExternalProvisionDescription string `json:"externalProvisionDescription"`

	// Indicates what parameters to collect from the user interface, and how to display those fields in a form to provision a database instance.
	InstanceParameterSpecs []InstanceParameterSpec `json:"instanceParameterSpecs"`
}

DBaaSProviderSpec defines the desired state of a DBaaSProvider object.

func (*DBaaSProviderSpec) DeepCopy 

func (in *DBaaSProviderSpec) DeepCopy() *DBaaSProviderSpec

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

func (*DBaaSProviderSpec) DeepCopyInto 

func (in *DBaaSProviderSpec) DeepCopyInto(out *DBaaSProviderSpec)

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

type DBaaSProviderStatus 

type DBaaSProviderStatus struct {
}

DBaaSProviderStatus defines the observed state of a DBaaSProvider object.

func (*DBaaSProviderStatus) DeepCopy 

func (in *DBaaSProviderStatus) DeepCopy() *DBaaSProviderStatus

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

func (*DBaaSProviderStatus) DeepCopyInto 

func (in *DBaaSProviderStatus) DeepCopyInto(out *DBaaSProviderStatus)

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

type DBaasInstancePhase added in v0.4.0 

type DBaasInstancePhase string

DBaasInstancePhase defines the phases for instance provisioning. 

const (
	InstancePhaseUnknown  DBaasInstancePhase = "Unknown"
	InstancePhasePending  DBaasInstancePhase = "Pending"
	InstancePhaseCreating DBaasInstancePhase = "Creating"
	InstancePhaseUpdating DBaasInstancePhase = "Updating"
	InstancePhaseDeleting DBaasInstancePhase = "Deleting"
	InstancePhaseDeleted  DBaasInstancePhase = "Deleted"
	InstancePhaseReady    DBaasInstancePhase = "Ready"
	InstancePhaseError    DBaasInstancePhase = "Error"
	InstancePhaseFailed   DBaasInstancePhase = "Failed"
)

Constants for the instance phases.

type DatabaseProvider 

type DatabaseProvider struct {
	// The name used to specify the service binding origin parameter.
	// For example, 'OpenShift Database Access / MongoDB Atlas'.
	Name string `json:"name"`

	// A user-friendly name for this database provider.
	// For example, 'MongoDB Atlas'.
	DisplayName string `json:"displayName"`

	// Indicates the description text shown for a database provider within the user interface.
	// For example, the catalog tile description.
	DisplayDescription string `json:"displayDescription"`

	// Indicates what icon to display on the catalog tile.
	Icon ProviderIcon `json:"icon"`
}

DatabaseProvider defines the information for a DBaaSProvider object.

func (*DatabaseProvider) DeepCopy 

func (in *DatabaseProvider) DeepCopy() *DatabaseProvider

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

func (*DatabaseProvider) DeepCopyInto 

func (in *DatabaseProvider) DeepCopyInto(out *DatabaseProvider)

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

type Instance 

type Instance struct {
	// A provider-specific identifier for this instance in the database service.
	// It can contain one or more pieces of information used by the provider's operator to identify the instance on the database service.
	InstanceID string `json:"instanceID"`

	// The name of this instance in the database service.
	Name string `json:"name,omitempty"`

	// Any other provider-specific information related to this instance.
	InstanceInfo map[string]string `json:"instanceInfo,omitempty"`
}

Instance defines the information of a database instance.

func (*Instance) DeepCopy 

func (in *Instance) DeepCopy() *Instance

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

func (*Instance) DeepCopyInto 

func (in *Instance) DeepCopyInto(out *Instance)

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

type InstanceParameterSpec added in v0.1.4 

type InstanceParameterSpec struct {
	// The name for this field.
	Name string `json:"name"`

	// A user-friendly name for this parameter.
	DisplayName string `json:"displayName"`

	// The type of field: string, maskedstring, integer, or boolean.
	Type string `json:"type"`

	// Define if this field is required or not.
	Required bool `json:"required"`

	// Default value for this field.
	DefaultValue string `json:"defaultValue,omitempty"`
}

InstanceParameterSpec indicates what parameters to collect from the user interface, and how to display those fields in a form to provision a database instance.

func (*InstanceParameterSpec) DeepCopy added in v0.1.4 

func (in *InstanceParameterSpec) DeepCopy() *InstanceParameterSpec

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

func (*InstanceParameterSpec) DeepCopyInto added in v0.1.4 

func (in *InstanceParameterSpec) DeepCopyInto(out *InstanceParameterSpec)

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

type LocalObjectReference added in v0.2.0 

type LocalObjectReference struct {
	// Name of the referent.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
}

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

func (*LocalObjectReference) DeepCopy added in v0.2.0 

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

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

func (*LocalObjectReference) DeepCopyInto added in v0.2.0 

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

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

type NamespacedName 

type NamespacedName struct {
	// The namespace where an object of a known type is stored.
	Namespace string `json:"namespace,omitempty"`

	// The name for object of a known type.
	Name string `json:"name"`
}

NamespacedName defines the namespace and name of a k8s resource.

func (*NamespacedName) DeepCopy 

func (in *NamespacedName) DeepCopy() *NamespacedName

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

func (*NamespacedName) DeepCopyInto 

func (in *NamespacedName) DeepCopyInto(out *NamespacedName)

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

type ObservabilityConfig added in v0.4.0 

type ObservabilityConfig struct {
	AuthType        string
	RemoteWritesURL string
	RHSSOTokenURL   string
	AddonName       string
	RHOBSSecretName string
}

ObservabilityConfig defines parameters for observatorium.

func (*ObservabilityConfig) DeepCopy added in v0.4.0 

func (in *ObservabilityConfig) DeepCopy() *ObservabilityConfig

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

func (*ObservabilityConfig) DeepCopyInto added in v0.4.0 

func (in *ObservabilityConfig) DeepCopyInto(out *ObservabilityConfig)

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

type PlatformConfig added in v0.1.4 

type PlatformConfig struct {
	Name           string
	CSV            string
	DeploymentName string
	Image          string
	PackageName    string
	Channel        string
	DisplayName    string
	Envs           []corev1.EnvVar
	Type           PlatformsType
}

PlatformConfig defines parameters for a platform.

func (*PlatformConfig) DeepCopy added in v0.1.4 

func (in *PlatformConfig) DeepCopy() *PlatformConfig

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

func (*PlatformConfig) DeepCopyInto added in v0.1.4 

func (in *PlatformConfig) DeepCopyInto(out *PlatformConfig)

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

type PlatformStatus added in v0.4.0 

type PlatformStatus struct {
	PlatformName   PlatformsName         `json:"platformName"`
	PlatformStatus PlatformsInstlnStatus `json:"platformStatus"`
	LastMessage    string                `json:"lastMessage,omitempty"`
}

PlatformStatus defines the status of a DBaaSPlatform object.

func (*PlatformStatus) DeepCopy added in v0.4.0 

func (in *PlatformStatus) DeepCopy() *PlatformStatus

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

func (*PlatformStatus) DeepCopyInto added in v0.4.0 

func (in *PlatformStatus) DeepCopyInto(out *PlatformStatus)

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

type PlatformsInstlnStatus 

type PlatformsInstlnStatus string

PlatformsInstlnStatus provides the status of a platform installation. 

const (
	ResultSuccess    PlatformsInstlnStatus = "success"
	ResultFailed     PlatformsInstlnStatus = "failed"
	ResultInProgress PlatformsInstlnStatus = "in progress"
)

Platform status values.

type PlatformsName 

type PlatformsName string

PlatformsName defines the name of the platform. 

const (
	CrunchyBridgeInstallation      PlatformsName = "crunchy-bridge"
	MongoDBAtlasInstallation       PlatformsName = "mongodb-atlas"
	DBaaSDynamicPluginInstallation PlatformsName = "dbaas-dynamic-plugin"
	CockroachDBInstallation        PlatformsName = "cockroachdb-cloud"
	ObservabilityInstallation      PlatformsName = "observability"
	DBaaSQuickStartInstallation    PlatformsName = "dbaas-quick-starts"
	RDSProviderInstallation        PlatformsName = "rds-provider"
)

Supported platform names.

type PlatformsType added in v0.1.4 

type PlatformsType int

PlatformsType defines the platform type. 

const (
	TypeQuickStart PlatformsType = iota
	TypeConsolePlugin
	TypeOperator
	TypeObservability
)

Platform types.

type ProviderIcon 

type ProviderIcon struct {
	Data      string `json:"base64data"`
	MediaType string `json:"mediatype"`
}

ProviderIcon follows the same field and naming formats as a comma-separated values (CSV) file.

func (*ProviderIcon) DeepCopy 

func (in *ProviderIcon) DeepCopy() *ProviderIcon

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

func (*ProviderIcon) DeepCopyInto 

func (in *ProviderIcon) DeepCopyInto(out *ProviderIcon)

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.