Package v1beta1 contains API Schema definitions for the dbaas v1beta1 API group
ConditionalProvisioningParameterData provides a list of available options with default values for a dropdown menu, or a list of default values entered by the user within the user interface (UI) based on the dependencies. A provisioning parameter can have many options lists and default values, depending on the dependency parameters. If options lists are present, the field displays a dropdown menu in the UI, otherwise it displays an empty field for user input. For example, you can have four different options lists for different regions: one for dedicated clusters on Google Cloud Platform (GCP), one for dedicated clusters on Amazon Web Services (AWS), one for serverless on GCP, and one for serverless on AWS.
Appears in:
| Field | Description |
|---|---|
dependencies FieldDependency array |
List of the dependent fields and values. |
options Option array |
Options displayed in the UI. |
defaultValue string |
Set a default value. |
CredentialField defines the CredentialField object attributes.
Appears in:
| Field | Description |
|---|---|
key string |
The name for this field. |
displayName string |
A user-friendly name for this field. |
type string |
The type of field: string, maskedstring, integer, or boolean. |
required boolean |
Defines if the field is required or not. |
helpText string |
Additional information about the field. |
DBaaSConnection defines the schema for the DBaaSConnection API.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSConnection |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSConnectionSpec |
DBaaSConnectionPolicy sets a connection policy.
Appears in:
| Field | Description |
|---|---|
namespaces string |
Namespaces where DBaaSConnection and DBaaSInstance objects are only allowed to reference a policy's inventories. 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. |
nsSelector LabelSelector |
Use a label selector to determine the namespaces where DBaaSConnection and DBaaSInstance objects are only allowed to reference a policy's inventories. 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. |
DBaaSConnectionSpec defines the desired state of a DBaaSConnection object.
Appears in:
| Field | Description |
|---|---|
inventoryRef NamespacedName |
A reference to the relevant DBaaSInventory custom resource (CR). |
databaseServiceID string |
The ID of the database service to connect to, as seen in the status of the referenced DBaaSInventory. |
databaseServiceRef NamespacedName |
A reference to the database service CR used, if the DatabaseServiceID is not specified. |
databaseServiceType DatabaseServiceType |
The type of the database service to connect to, as seen in the status of the referenced DBaaSInventory. |
DBaaSInstance defines the schema for the DBaaSInstance API.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSInstance |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSInstanceSpec |
DBaaSInstanceSpec defines the desired state of a DBaaSInstance object.
Appears in:
| Field | Description |
|---|---|
inventoryRef NamespacedName |
A reference to the relevant DBaaSInventory custom resource (CR). |
provisioningParameters object (keys:ProvisioningParameterType, values:string) |
Parameters with values used for provisioning. |
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.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSInventory |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSOperatorInventorySpec |
DBaaSInventoryPolicy sets the inventory policy.
Appears in:
| Field | Description |
|---|---|
disableProvisions boolean |
Disables provisioning on inventory accounts. |
connections DBaaSConnectionPolicy |
Namespaces where DBaaSConnection and DBaaSInstance objects are only allowed to reference a policy's inventories. |
DBaaSInventorySpec defines the inventory specifications for the provider's operators.
Appears in:
| Field | Description |
|---|---|
credentialsRef LocalObjectReference |
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. |
DBaaSOperatorInventorySpec defines the desired state of a DBaaSInventory object.
Appears in:
| Field | Description |
|---|---|
providerRef NamespacedName |
A reference to a DBaaSProvider custom resource (CR). |
DBaaSInventorySpec DBaaSInventorySpec |
The properties that will be copied into the provider’s inventory. |
policy DBaaSInventoryPolicy |
The policy for this inventory. |
DBaaSPlatform defines the schema for the DBaaSPlatform API.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSPlatform |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSPlatformSpec |
DBaaSPlatformSpec defines the desired state of a DBaaSPlatform object.
Appears in:
| Field | Description |
|---|---|
syncPeriod integer |
Sets the minimum interval, which the provider's operator controllers reconcile. The default value is 180 minutes. |
DBaaSPolicy enables administrative capabilities within a namespace, and sets a default inventory policy. Policy defaults can be overridden on a per-inventory basis.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSPolicy |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSPolicySpec |
DBaaSPolicySpec the specifications for a DBaaSPolicy object.
Appears in:
| Field | Description |
|---|---|
DBaaSInventoryPolicy DBaaSInventoryPolicy |
DBaaSProvider defines the schema for the DBaaSProvider API.
| Field | Description |
|---|---|
apiVersion string |
dbaas.redhat.com/v1beta1 |
kind string |
DBaaSProvider |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBaaSProviderSpec |
DBaaSProviderSpec defines the desired state of a DBaaSProvider object.
Appears in:
| Field | Description |
|---|---|
provider DatabaseProviderInfo |
Contains information about database provider and platform. |
groupVersion string |
The DBaaS API group version supported by the provider. |
inventoryKind string |
The name of the inventory custom resource definition (CRD) as defined by the database provider. |
connectionKind string |
The name of the connection's custom resource definition (CRD) as defined by the provider. |
instanceKind string |
The name of the instance's custom resource definition (CRD) as defined by the provider for provisioning. |
credentialFields CredentialField array |
Indicates what information to collect from the user interface and how to display fields in a form. |
allowsFreeTrial boolean |
Indicates whether the provider offers free trials. |
externalProvisionURL string |
The URL for provisioning instances by using the database provider's web portal. |
externalProvisionDescription string |
Instructions on how to provision instances by using the database provider's web portal. |
provisioningParameters object (keys:ProvisioningParameterType, values:ProvisioningParameter) |
Parameter specifications used by the user interface (UI) for provisioning a database instance. |
DatabaseProviderInfo defines the information for a DBaaSProvider object.
Appears in:
| Field | Description |
|---|---|
name string |
The name used to specify the service binding origin parameter. For example, 'OpenShift Database Access / Crunchy Bridge'. |
displayName string |
A user-friendly name for this database provider. For example, 'Crunchy Bridge managed PostgreSQL'. |
displayDescription string |
Indicates the description text shown for a database provider within the user interface. For example, the catalog tile description. |
icon ProviderIcon |
Indicates what icon to display on the catalog tile. |
Underlying type: string
DatabaseServiceType defines the supported database service types.
Appears in:
FieldDependency defines the name and value of a dependency field.
Appears in:
| Field | Description |
|---|---|
field ProvisioningParameterType |
Name of the dependency field. |
value string |
Value of the dependency field. |
LocalObjectReference contains enough information to locate the referenced object inside the same namespace.
Appears in:
| Field | Description |
|---|---|
name string |
Name of the referent. |
NamespacedName defines the namespace and name of a k8s resource.
Appears in:
| Field | Description |
|---|---|
namespace string |
The namespace where an object of a known type is stored. |
name string |
The name for object of a known type. |
Option defines the value and display value for an option in a dropdown menu, radio button, or checkbox.
Appears in:
| Field | Description |
|---|---|
value string |
Value of the option. |
displayValue string |
Corresponding display value. |
ProviderIcon follows the same field and naming formats as a comma-separated values (CSV) file.
Appears in:
| Field | Description |
|---|---|
base64data string |
|
mediatype string |
ProvisioningParameter provides information for a ProvisioningParameter object.
Appears in:
| Field | Description |
|---|---|
displayName string |
A user-friendly name for this field. |
helpText string |
Additional information about the field. |
conditionalData ConditionalProvisioningParameterData array |
Lists of additional data containing the options or default values for the field. |
Underlying type: string
ProvisioningParameterType defines teh type for provisioning parameters
Appears in: