Skip to content

crossplane-contrib/provider-upjet-aws

Repository files navigation

Official AWS Provider

CI GitHub release Go Report Card Contributors Slack X (formerly Twitter) Follow

Provider 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 getting more information about resource consumption and monitoring the upjet runtime, please see Sizing Guide and 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 provider (config) and 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 set to main (even though you might be on another branch) will let make publish the images to your docker hub account.

To install the provider provider-aws-ec2 into a local Kubernetes cluster, 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>

Use monolith instead of ec2 to build and publish the monolithic provider.

Add a New Resource

Follow the guide here.

Report a Bug

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

Contact

#upbound-provider-aws channel in Crossplane Slack

Licensing

Provider AWS is under the Apache 2.0 license with notice.