Packages on Crossplane

Providers

Providers enable Crossplane to provision infrastructure on an external service. Providers create new Kubernetes APIs and map them to external APIs.

Providers are responsible for all aspects of connecting to non-Kubernetes resources. This includes authentication, making external API calls and providing Kubernetes Controller logic for any external resources.

Examples of providers include:

Providers define every external resource they can create in Kubernetes as a Kubernetes API endpoint. These endpoints are Managed Resources.

Functions

Functions extend Crossplane with new ways to configure composition.

You can use different composition functions to configure what Crossplane does when someone creates or updates a composite resource (XR).

Important

This page is a work in progress.

Functions are packages, like Providers and Configurations. Their APIs are similar. You install and configure them the same way as a provider.

Read the composition documentation to learn how to use functions in a composition.

Configurations

A Configuration package is an OCI container image containing a collection of Compositions, Composite Resource Definitions and any required Providers or Functions.

Configuration packages make your Crossplane configuration fully portable.

Important

Crossplane Providers and Functions are also Crossplane packages.

This document describes how to install and manage configuration packages.

Refer to the Provider and Functions chapters for details on their usage of packages.

Install a configuration

Install a Configuration with a Crossplane Configuration object by setting the spec.package value to the location of the configuration package.

Image Configs

ImageConfig is an API for centralized control over the configuration of Crossplane package images. It allows you to configure package manager behavior for images globally, without needing to be referenced by other objects.

Matching image references

spec.matchImages is a list of image references that the ImageConfig applies to. Each item in the list specifies the type and configuration of the image reference to match. The only supported type is Prefix, which matches the prefix of the image reference. No wildcards are supported. The type defaults to Prefix and can be omitted.