Skip to content

Commit

Permalink
Add a README
Browse files Browse the repository at this point in the history
Signed-off-by: Nic Cope <nicc@rk0n.org>
  • Loading branch information
negz committed Nov 8, 2024
1 parent 2ae0155 commit 9b6d749
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# example-project-aws

An example Upbound control plane project for Amazon Web Services (AWS).

A control plane project is a source-level representation of a Crossplane control
plane. It lets you treat your control plane configuration as a software project.
With a control plane project you can build your compositions using a language
like KCL or Python. This enables Crossplane schema-aware syntax highlighting,
autocompletion, and linting.

Read the [control plane project documentation][proj-docs] to learn more about
control plane projects.

This project defines a new `StorageBucket` API, which is powered by AWS S3. It
includes [KCL][kcl-docs] and [Python][py-docs] functions that implement the
composition logic.

The project uses the KCL function by default. Edit [`composition.yaml`][comp] to
switch to the Python function.


[proj-docs]: https://docs.upbound.io/core-concepts/projects/
[kcl-docs]: https://docs.upbound.io/core-concepts/kcl/overview/
[py-docs]: https://docs.upbound.io/core-concepts/python/overview/
[comp]: ./apis/xstoragebuckets/composition.yaml

0 comments on commit 9b6d749

Please sign in to comment.