This document is for an unreleased version of Crossplane.

This document applies to the Crossplane master branch and not to the latest release v1.11.

Providers are Crossplane packages that bundle a set of Managed Resources and their respective controllers to allow Crossplane to provision the respective infrastructure resource.

Installing Providers

The core Crossplane controller can install provider controllers and CRDs for you through its own provider packaging mechanism, which is triggered by the application of a Provider resource. For example, in order to request installation of the provider-aws package, apply the following resource to the cluster where Crossplane is running:

2kind: Provider
4  name: provider-aws
6  package: ""

The field spec.package is where you refer to the container image of the provider. Crossplane Package Manager will unpack that container, register CRDs and set up necessary RBAC rules and then start the controllers.

There are a few other ways to to trigger the installation of provider packages:

  • As part of Crossplane Helm chart by adding the following statement to your helm install command: --set provider.packages={}.
  • Using the Crossplane CLI: kubectl crossplane install provider

You can uninstall a provider by deleting the Provider resource you’ve created.

Configuring Providers

In order to authenticate with the external provider API, the provider controllers need to have access to credentials. It could be an IAM User for AWS, a Service Account for GCP or a Service Principal for Azure. Every provider has a type called ProviderConfig that has information about how to authenticate to the provider API. An example ProviderConfig resource for AWS looks like the following:

 2kind: ProviderConfig
 4  name: aws-provider
 6  credentials:
 7    source: Secret
 8    secretRef:
 9      namespace: crossplane-system
10      name: aws-creds
11      key: creds

You can see that there is a reference to a key in a specific Secret. The value of that key should contain the credentials that the controller will use. The documentation of each provider should give you an idea of how that credentials blob should look like.

The following is an example usage of AWS ProviderConfig, referenced by a RDSInstance:

2kind: RDSInstance
4  name: prod-sql
6  providerConfigRef:
7    name: aws-provider
8  ...

The AWS provider controller will use that provider for this instance of RDSInstance. Since every resource has its own reference to a ProviderConfig, you can have multiple ProviderConfig resources in your cluster referenced by different resources. When no providerConfigRef is specified, the RDSInstance will attempt to use a ProviderConfig named default.