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.

For example to install the Getting Started Configuration,

1apiVersion: pkg.crossplane.io/v1
2kind: Configuration
3metadata:
4  name: configuration-quickstart
5spec:
6  package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0
Tip

Crossplane supports installations with image digests instead of tags to get deterministic and repeatable installations.

1apiVersion: pkg.crossplane.io/v1
2kind: Configuration