Documentation

API Reference

Crossplane is configured using a variety of Kubernetes resources. These resources are separated into API groups. Core API groups are provided by Crossplane, while cloud provider specific API groups are provided by each cloud provider’s stack.

Each API Group supported by Crossplane is assigned its own individual status to reflect the varying maturity and stability. More details about API versioning and status in Kubernetes can be found on the Kubernetes API versioning page, but the key difference between the statuses are summarized below:

Crossplane

Crossplane is responsible for all portable resources, including resource claims (for example MySQLInstance) and portable resource classes (for example `MySQLInstanceClass). Crossplane currently supports the following API groups:

API Group Status Details
cache.crossplane.io/v1alpha1 Alpha Cache service claims and classes.
compute.crossplane.io/v1alpha1 Alpha Compute service resource claims and classes.
database.crossplane.io/v1alpha1 Alpha Database service resource claims and classes.
kubernetes.crossplane.io/v1alpha1 Alpha Resources for connecting to Kubernetes clusters.
storage.crossplane.io/v1alpha1 Alpha Blob storage service resource claims and classes.
stacks.crossplane.io/v1alpha1 Alpha Resources for managing Crossplane Stacks.
workload.crossplane.io/v1alpha1 Alpha Resources for managing Crossplane Workloads.

AWS Stack

The AWS Stack is responsible for all AWS specific resources, including managed resources (for example EKSCluster), and cloud specific resource classes (for example EKSClusterClass) The AWS Stack currently supports the following API groups:

API Group Status Details
aws.crossplane.io/v1alpha3 Alpha Core AWS resources.
cache.aws.crossplane.io/v1beta1 Beta ElastiCache managed resources and classes.
compute.aws.crossplane.io/v1alpha3 Alpha EKS managed resources and classes.
database.aws.crossplane.io/v1beta1 Beta RDS managed resources and classes.
identity.aws.crossplane.io/v1alpha3 Alpha IAM managed resources and classes.
network.aws.crossplane.io/v1alpha3 Alpha VPC managed resources and classes.
storage.aws.crossplane.io/v1alpha3 Alpha S3 managed resources and classes.

Azure Stack

The Azure Stack is responsible for all Azure specific resources, including managed resources (for example AKSCluster), and cloud specific resource classes (for example AKSClusterClass) The Azure Stack currently supports the following API groups:

API Group Status Details
azure.crossplane.io/v1alpha3 Alpha Core Azure resources.
cache.azure.crossplane.io/v1alpha3 Alpha Azure Redis managed resources and classes.
compute.azure.crossplane.io/v1alpha3 Alpha AKS managed resources and classes.
database.azure.crossplane.io/v1alpha3 Alpha Azure Database managed resources and classes.
network.azure.crossplane.io/v1alpha3 Alpha Virtual network managed resources and classes.
storage.azure.crossplane.io/v1alpha3 Alpha Azure Blob Storage managed resources and classes.

GCP Stack

The GCP Stack is responsible for all GCP specific resources, including managed resources (for example GKECluster), and cloud specific resource classes (for example GKEClusterClass) The GCP Stack currently supports the following API groups:

API Group Status Details
gcp.crossplane.io/v1alpha3 Alpha Core GCP resources.
cache.gcp.crossplane.io/v1beta1 Beta CloudMemorystore managed resources and classes.
compute.gcp.crossplane.io/v1alpha3 Alpha Compute and Kubernetes Engine managed resources and classes.
database.gcp.crossplane.io/v1beta1 Beta CloudSQL managed resources and classes.
servicenetworking.gcp.crossplane.io/v1alpha3 Alpha Service Networking managed resources and classes.
storage.gcp.crossplane.io/v1alpha3 Alpha Cloud Storage managed resources and classes.

Rook Stack

The Rook Stack is responsible for all Rook specific resources, including managed resources (for example YugabyteCluster), and stroage provider specific resource classes (for example YugabyteClusterClass) The Rook Stack currently supports the following API groups:

API Group Status Details
rook.crossplane.io/v1alpha1 Alpha Core Rook resources.
database.rook.crossplane.io/v1alpha1 Alpha Database managed resources and classes, such as YugabyteDB and CockroachDB.