https://github.com/upbound/configuration-aws-network
AWS Network Configuration
https://github.com/upbound/configuration-aws-network
Last synced: 8 months ago
JSON representation
AWS Network Configuration
- Host: GitHub
- URL: https://github.com/upbound/configuration-aws-network
- Owner: upbound
- License: apache-2.0
- Created: 2023-10-16T20:32:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T11:45:30.000Z (over 1 year ago)
- Last Synced: 2025-03-15T02:50:19.338Z (over 1 year ago)
- Language: Makefile
- Size: 225 KB
- Stars: 3
- Watchers: 16
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# AWS Network 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 network resources.
## 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):** Implements the API by orchestrating a set of Crossplane managed resources.
- **Embedded Function(s):** Encapsulates the Composition logic and implementation within a self-contained, reusable unit
In this specific configuration, the AWS Network API contains:
- **an [AWS network](/apis/xnetworks/definition.yaml) custom resource type.**
- **Composition of the networking resources:** Configured in [/apis/xnetworks/composition.yaml](/apis/xnetworks/composition.yaml), it provisions networking resources in the `upbound-system` namespace.
- **Embedded Function:** The Composition logic is encapuslated within [embedded function](/functions/xnetwork/main.k)
## Deployment
- Execute `up project run`
- Alternatively, install the Configuration from the [Upbound Marketplace](https://marketplace.upbound.io/configurations/upbound/configuration-aws-network)
- Check [examples](/examples/) for example XR(Composite Resource)
## Testing
The configuration can be tested using:
- `up composition render --xrd=apis/xnetworks/definition.yaml apis/xnetworks/composition.yaml examples/network-xr.yaml` to render the composition
- `up test run tests/*` to run composition tests in `tests/test-xnetwork/`
- `up test run tests/* --e2e` to run end-to-end tests in `tests/e2etest-xnetwork/`
## Next steps
This repository serves as a foundational step. To enhance your 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/).