https://github.com/upbound/configuration-aws-database
AWS Database Configuration
https://github.com/upbound/configuration-aws-database
Last synced: 12 months ago
JSON representation
AWS Database Configuration
- Host: GitHub
- URL: https://github.com/upbound/configuration-aws-database
- Owner: upbound
- License: apache-2.0
- Created: 2023-10-18T18:05:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-23T14:49:39.000Z (about 1 year ago)
- Last Synced: 2025-07-14T20:35:57.582Z (12 months ago)
- Language: AMPL
- Homepage:
- Size: 130 KB
- Stars: 3
- Watchers: 16
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# AWS Database Configuration
This repository contains an Upbound project, tailored for users establishing their initial control plane with [Upbound](https://cloud.upbound.io). This configuration deploys fully managed AWS database instances.
## Overview
The core components of a custom API in [Upbound Project](https://docs.upbound.io/learn/control-plane-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 API contains:
- **an [AWS Database](/apis/definition.yaml) custom resource type.**
- **Composition:** Configured in [/apis/composition.yaml](/apis/composition.yaml)
- **Embedded Function:** The Composition logic is encapsulated within [embedded function](/functions/xsqlinstance/main.k)
## Testing
The configuration can be tested using:
- `up composition render --xrd=apis/definition.yaml apis/composition.yaml examples/mariadb-xr.yaml` to render the MariaDB composition
- `up composition render --xrd=apis/definition.yaml apis/composition.yaml examples/postgres-xr.yaml` to render the PostgreSQL composition
- `up test run tests/*` to run composition tests
- `up test run tests/* --e2e` to run end-to-end tests
## Deployment
- Execute `up project run`
- Alternatively, install the Configuration from the [Upbound Marketplace](https://marketplace.upbound.io/configurations/upbound/configuration-aws-database)
- Check [examples](/examples/) for example 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](https://docs.upbound.io/).