provider-aws

README

Upjet-based Crossplane provider for AWS

Provider Upjet-AWS is a Crossplane provider that is built using Upjet code generation tools and exposes XRM-conformant managed resources for Amazon AWS.

Getting Started

Follow the quick start guide here.

You can find a detailed API reference for all the managed resources with examples in the Upbound Marketplace.

For more information about monitoring the Upjet runtime, please see Monitoring Guide

Contributing

For the general contribution guide, see Upjet Contribution Guide

If you'd like to learn how to use Upjet, see Usage Guide.

To build this provider locally and run it in a local Kubernetes cluster, run the following to build the family config provider (config) and the sub-package you are working on e.g. ec2:

DOCKERHUB_ORG=<your-docker-name>
BUILD_ARGS="--load" XPKG_REG_ORGS_NO_PROMOTE="" XPKG_REG_ORGS="index.docker.io/$DOCKERHUB_ORG" make build.all publish BRANCH_NAME=main SUBPACKAGES="config ec2"

The BRANCH_NAME is set to main (even though you might be on another branch) to allow for the publishing of the images to your docker hub account.

To install the provider, in this example provider-aws-ec2, into a local Kubernetes cluster with Crossplane already installed, apply:

apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-aws-ec2
spec:
  package: docker.io/<your-docker-name>/provider-aws-ec2:<the-version-taken-from-the-output-of-the-previous-command>

Add a New Resource

Follow the Upjet guide for adding new resources.

Getting help

For filing bugs, suggesting improvements, or requesting new resources or features, please open an issue.

For general help on using the provider consider asking the Crossplane community in the #upjet-provider-aws channel in Crossplane Slack

License

The provider is released under the the Apache 2.0 license with notice.