Database-as-a-service Configuration

This repository contains an Upbound project, tailored for users establishing their initial control plane with Upbound. This configuration deploys fully managed database instances across AWS, Azure, and GCP.

Supported Database Engines

Provider	PostgreSQL	MySQL	MariaDB
AWS	✅	❌	✅
Azure	✅	✅	❌
GCP	✅	✅	❌

Note: This configuration currently supports a subset of available database engines. The engine availability is determined by the underlying provider-specific configurations.

Supported AWS Regions

The following AWS regions are supported with proper availability zone mapping:

• us-east-1, us-east-2, us-west-1, us-west-2
• eu-west-1, eu-west-2, eu-central-1
• ap-southeast-1, ap-southeast-2, ap-northeast-1
• ca-central-1

Other AWS regions will default to us-west-2 availability zones. For additional regions, please update the region-to-AZ mapping in functions/xsqlinstances/main.k.

Overview

The core components of a custom API in Upbound Project include:

• CompositeResourceDefinition (XRD): Defines the API's structure.
• Composition(s): Configures the Functions Pipeline
• Embedded Function(s): Encapsulates the Composition logic and implementation within a self-contained, reusable unit

In this specific configuration, the Database API contains:

• a SQL Instance custom resource type.
• Composition: Configured in /apis/xsqlinstances/composition.yaml,
• Embedded Function: The Composition logic is encapsulated within embedded function

Testing

The configuration includes comprehensive testing coverage:

Composition Tests:

• up test run tests/test-* - Fast validation of all 3 providers

E2E Tests (full support matrix):

• up test run tests/e2etest-* --e2e - Deploys real databases:
  • AWS: PostgreSQL 16.3, MariaDB 10.11 (us-west-2)
  • Azure: PostgreSQL 16, MySQL 8.0.21 (westeurope)
  • GCP: PostgreSQL 15, MySQL 8_0 (us-west2)

Rendering:

• up composition render --xrd=apis/xsqlinstances/definition.yaml apis/xsqlinstances/composition.yaml examples/postgres-aws.yaml

Deployment

• Execute up project run
• Alternatively, install the Configuration from the Upbound Marketplace
• Check examples for example claims and XR(Composite Resource)

Next steps

This repository serves as a foundational step. To enhance the configuration, consider:

1. create new API definitions in this same repo
2. editing the existing API definition to your needs

To learn more about how to build APIs for your managed control planes in Upbound, read the guide on Upbound's docs.