Documentation

PLEASE NOTE: This document applies to v1.7 version and not to the latest release v1.8

Documentation for other releases can be found by using the version selector in the top right of any doc page.

Providers

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

Here is the list of prominent providers:

       
Provider AWS GitHub Repo API Reference Amazon Web Services (AWS) IAM User
Provider Jet AWS GitHub Repo API Reference  
Provider GCP GitHub Repo API Reference Google Cloud Platform (GCP) Service Account
Provider Jet GCP GitHub Repo API Reference  
Provider Azure GitHub Repo API Reference Microsoft Azure Service Principal
Provider Jet Azure GitHub Repo API Reference  
Provider Alibaba GitHub Repo API Reference  
       
Provider Rook GitHub Repo API Reference  
Provider Helm GitHub Repo API Reference  
Provider Terraform GitHub Repo API Reference  
Provider Kubernetes GitHub Repo API Reference  
Provider SQL GitHub Repo API Reference  
Provider Gitlab GitHub Repo API Reference  
Provider Equinix Metal GitHub Repo API Reference  
Provider Digital Ocean GitHub Repo API Reference  
Provider Civo GitHub Repo API Reference  
Provider IBM Cloud GitHub Repo API Reference  
Provider Argocd GitHub Repo API Reference  
Provider Styra GitHub Repo API Reference  
Provider Cloudflare GitHub Repo API Reference  

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:

apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-aws
spec:
  package: "crossplane/provider-aws:master"

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:

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:

apiVersion: aws.crossplane.io/v1beta1
kind: ProviderConfig
metadata:
  name: aws-provider
spec:
  credentials:
    source: Secret
    secretRef:
      namespace: crossplane-system
      name: aws-creds
      key: key

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. See Getting Started guide for more details.

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

apiVersion: database.aws.crossplane.io/v1beta1
kind: RDSInstance
metadata:
  name: prod-sql
spec:
  providerConfigRef:
    name: aws-provider
  ...

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.