README
¶
Crossplane is a framework for building cloud native control planes without needing to write code. It has a highly extensible backend that enables you to build a control plane that can orchestrate applications and infrastructure no matter where they run, and a highly configurable frontend that puts you in control of the schema of the declarative API it offers.
Crossplane is a Cloud Native Computing Foundation project.
Get Started
Crossplane's Get Started Docs cover install and cloud provider quickstarts.
Releases
Currently maintained releases, as well as the next few upcoming releases are listed below. For more information take a look at the Crossplane release cycle documentation.
| Release | Release Date | EOL |
|---|---|---|
| v1.14 | Nov 1, 2023 | Aug 2024 |
| v1.15 | Feb 15, 2024 | Nov 2024 |
| v1.16 | May 15, 2024 | Feb 2025 |
| v1.17 | Early Aug '24 | May 2025 |
| v1.18 | Early Nov '24 | Aug 2025 |
| v1.19 | Early Feb '25 | Nov 2025 |
You can subscribe to the community calendar to track all release dates, and find the most recent releases on the releases page.
Roadmap
The public roadmap for Crossplane is published as a GitHub project board. Issues added to the roadmap have been triaged and identified as valuable to the community, and therefore a priority for the project that we expect to invest in.
The maintainer team regularly triages requests from the community to identify features and issues of suitable scope and impact to include in this roadmap. The community is encouraged to show their support for potential roadmap issues by adding a 👍 reaction, leaving descriptive comments, and attending the regular community meetings to discuss their requirements and use cases.
The maintainer team updates the roadmap on an as needed basis, in response to demand, priority, and available resources. The public roadmap can be updated at any time.
Milestones assigned to any issues in the roadmap are intended to give a sense of overall priority and the expected order of delivery. They should be considered approximate estimations and are not a strict commitment to a specific delivery timeline.
Get Involved
Crossplane is a community driven project; we welcome your contribution. To file a bug, suggest an improvement, or request a new feature please open an issue against Crossplane or the relevant provider. Refer to our contributing guide for more information on how you can help.
- Discuss Crossplane on Slack or our developer mailing list.
- Follow us on Twitter or LinkedIn, or subscribe to our newsletter.
- Contact us via Email.
- Join our regular community meetings.
- Provide feedback on our roadmap and releases board.
The Crossplane community meeting takes place every 4 weeks on Thursday at 10:00am Pacific Time. You can find the up to date meeting schedule on the Community Calendar.
Anyone who wants to discuss the direction of the project, design and implementation reviews, or raise general questions with the broader community is encouraged to join.
- Meeting link: https://zoom.us/j/425148449?pwd=NEk4N0tHWGpEazhuam1yR28yWHY5QT09
- Current agenda and past meeting notes
- Past meeting recordings
- Community Calendar
Special Interest Groups (SIG)
Each SIG collaborates in Slack and some groups have regular meetings, you can find the meetings in the Community Calendar.
- #sig-composition-environments
- #sig-composition-functions
- #sig-deletion-ordering
- #sig-devex
- #sig-docs
- #sig-e2e-testing
- #sig-observability
- #sig-observe-only
- #sig-provider-families
- #sig-secret-stores
- #sig-upjet
Adopters
A list of publicly known users of the Crossplane project can be found in ADOPTERS.md. We encourage all users of Crossplane to add themselves to this list - we want to see the community's growing success!
License
Crossplane is under the Apache 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apis contains Kubernetes API groups
|
Package apis contains Kubernetes API groups |
|
apiextensions
Package apiextensions contains Kubernetes API groups for extension types of Crossplane.
|
Package apiextensions contains Kubernetes API groups for extension types of Crossplane. |
|
apiextensions/v1
Package v1 contains API types that extend the Crossplane API.
|
Package v1 contains API types that extend the Crossplane API. |
|
apiextensions/v1alpha1
Package v1alpha1 contains API types that extend the Crossplane API.
|
Package v1alpha1 contains API types that extend the Crossplane API. |
|
apiextensions/v1beta1
Package v1beta1 contains API types that extend the Crossplane API.
|
Package v1beta1 contains API types that extend the Crossplane API. |
|
pkg
Package pkg contains Kubernetes API groups for Crossplane packages.
|
Package pkg contains Kubernetes API groups for Crossplane packages. |
|
pkg/meta/v1
Package v1 contains meta types used to configure Crossplane packages.
|
Package v1 contains meta types used to configure Crossplane packages. |
|
pkg/meta/v1alpha1
Package v1alpha1 contains meta types used to configure Crossplane packages.
|
Package v1alpha1 contains meta types used to configure Crossplane packages. |
|
pkg/meta/v1beta1
Package v1beta1 contains meta types used to configure Crossplane packages.
|
Package v1beta1 contains meta types used to configure Crossplane packages. |
|
pkg/v1
Package v1 contains resources relating to Crossplane packages.
|
Package v1 contains resources relating to Crossplane packages. |
|
pkg/v1alpha1
Package v1alpha1 contains resources relating to Crossplane packages.
|
Package v1alpha1 contains resources relating to Crossplane packages. |
|
pkg/v1beta1
Package v1beta1 contains resources relating to Crossplane packages.
|
Package v1beta1 contains resources relating to Crossplane packages. |
|
secrets
Package secrets contains Kubernetes API groups for secret store types of Crossplane.
|
Package secrets contains Kubernetes API groups for secret store types of Crossplane. |
|
secrets/v1alpha1
Package v1alpha1 contains the Secret StoreConfig resources.
|
Package v1alpha1 contains the Secret StoreConfig resources. |
|
cmd
|
|
|
crank
Package main implements Crossplane's crank CLI - aka crossplane CLI.
|
Package main implements Crossplane's crank CLI - aka crossplane CLI. |
|
crank/beta
Package beta contains beta Crossplane CLI subcommands.
|
Package beta contains beta Crossplane CLI subcommands. |
|
crank/beta/convert
Package convert contains Crossplane CLI subcommands for migrating Crossplane resources to newer versions or kinds.
|
Package convert contains Crossplane CLI subcommands for migrating Crossplane resources to newer versions or kinds. |
|
crank/beta/convert/deploymentruntime
Package deploymentruntime contains the logic for converting a ControllerConfig to a DeploymentRuntimeConfig.
|
Package deploymentruntime contains the logic for converting a ControllerConfig to a DeploymentRuntimeConfig. |
|
crank/beta/convert/io
Package io is a package for reading and writing files for the migration command.
|
Package io is a package for reading and writing files for the migration command. |
|
crank/beta/convert/pipelinecomposition
Package pipelinecomposition is a package for converting patch-and-transform Compositions to a function pipeline.
|
Package pipelinecomposition is a package for converting patch-and-transform Compositions to a function pipeline. |
|
crank/beta/top
Package top contains the top command.
|
Package top contains the top command. |
|
crank/beta/trace
Package trace contains the trace command.
|
Package trace contains the trace command. |
|
crank/beta/trace/internal/printer
Package printer contains the definition of the Printer interface and the implementation of all the available printers implementing it.
|
Package printer contains the definition of the Printer interface and the implementation of all the available printers implementing it. |
|
crank/beta/trace/internal/resource
Package resource contains the definition of the Resource used by all trace printers, and the client used to get a Resource and its children.
|
Package resource contains the definition of the Resource used by all trace printers, and the client used to get a Resource and its children. |
|
crank/beta/trace/internal/resource/xpkg
Package xpkg contains the client to get a Crossplane package with all its dependencies as a tree of Resource.
|
Package xpkg contains the client to get a Crossplane package with all its dependencies as a tree of Resource. |
|
crank/beta/trace/internal/resource/xrm
Package xrm contains the client to get a Crossplane resource with all its children as a tree of Resource.
|
Package xrm contains the client to get a Crossplane resource with all its children as a tree of Resource. |
|
crank/beta/validate
Package validate implements offline schema validation of Crossplane resources.
|
Package validate implements offline schema validation of Crossplane resources. |
|
crank/render
Package render implements composition rendering using composition functions.
|
Package render implements composition rendering using composition functions. |
|
crank/version
Package version contains common functions to get versions
|
Package version contains common functions to get versions |
|
crank/xpkg
Package xpkg contains Crossplane packaging commands.
|
Package xpkg contains Crossplane packaging commands. |
|
crossplane
Package main implements Crossplane's controller managers.
|
Package main implements Crossplane's controller managers. |
|
crossplane/core
Package core implements Crossplane's core controller manager.
|
Package core implements Crossplane's core controller manager. |
|
crossplane/rbac
Package rbac implements Crossplane's RBAC controller manager.
|
Package rbac implements Crossplane's RBAC controller manager. |
|
internal
|
|
|
controller/apiextensions
Package apiextensions implements the Crossplane Composition controllers.
|
Package apiextensions implements the Crossplane Composition controllers. |
|
controller/apiextensions/claim
Package claim implements composite resource claims.
|
Package claim implements composite resource claims. |
|
controller/apiextensions/composite
Package composite implements Crossplane composite resources.
|
Package composite implements Crossplane composite resources. |
|
controller/apiextensions/composite/watch
Package watch implements a garbage collector for composed resource watches.
|
Package watch implements a garbage collector for composed resource watches. |
|
controller/apiextensions/composition
Package composition creates composition revisions.
|
Package composition creates composition revisions. |
|
controller/apiextensions/controller
Package controller contains options specific to apiextensions controllers.
|
Package controller contains options specific to apiextensions controllers. |
|
controller/apiextensions/definition
Package definition manages the lifecycle of XR controllers.
|
Package definition manages the lifecycle of XR controllers. |
|
controller/apiextensions/offered
Package offered manages the lifecycle of claim controllers.
|
Package offered manages the lifecycle of claim controllers. |
|
controller/apiextensions/usage
Package usage manages the lifecycle of usageResource objects.
|
Package usage manages the lifecycle of usageResource objects. |
|
controller/pkg
Package pkg implements the controllers of the Crossplane Package manager.
|
Package pkg implements the controllers of the Crossplane Package manager. |
|
controller/pkg/controller
Package controller contains options specific to pkg controllers.
|
Package controller contains options specific to pkg controllers. |
|
controller/pkg/manager
Package manager implements the Crossplane Package controllers.
|
Package manager implements the Crossplane Package controllers. |
|
controller/pkg/resolver
Package resolver implements the Crossplane Package Lock controller.
|
Package resolver implements the Crossplane Package Lock controller. |
|
controller/pkg/revision
Package revision implements the Crossplane Package Revision controllers.
|
Package revision implements the Crossplane Package Revision controllers. |
|
controller/rbac
Package rbac implements the controllers of the Crossplane RBAC manager.
|
Package rbac implements the controllers of the Crossplane RBAC manager. |
|
controller/rbac/controller
Package controller contains options specific to rbac controllers.
|
Package controller contains options specific to rbac controllers. |
|
controller/rbac/definition
Package definition implements the RBAC manager's support for XRDs.
|
Package definition implements the RBAC manager's support for XRDs. |
|
controller/rbac/provider/binding
Package binding implements the RBAC manager's support for providers.
|
Package binding implements the RBAC manager's support for providers. |
|
controller/rbac/provider/roles
Package roles implements the RBAC manager's support for providers.
|
Package roles implements the RBAC manager's support for providers. |
|
dag
Package dag implements a Directed Acyclic Graph for Package dependencies.
|
Package dag implements a Directed Acyclic Graph for Package dependencies. |
|
dag/fake
Package fake contains mock a Crossplane package DAG.
|
Package fake contains mock a Crossplane package DAG. |
|
engine
Package engine manages the lifecycle of a set of controllers.
|
Package engine manages the lifecycle of a set of controllers. |
|
features
Package features defines Crossplane feature flags.
|
Package features defines Crossplane feature flags. |
|
initializer
Package initializer initializes a new installation of Crossplane.
|
Package initializer initializes a new installation of Crossplane. |
|
metrics
Package metrics contains functionality for emitting Prometheus metrics.
|
Package metrics contains functionality for emitting Prometheus metrics. |
|
names
Package names implements name generator
|
Package names implements name generator |
|
transport
Package transport contains HTTP transport utilities for Crossplane.
|
Package transport contains HTTP transport utilities for Crossplane. |
|
usage
Package usage contains the Handler for the usage webhook.
|
Package usage contains the Handler for the usage webhook. |
|
validation/apiextensions/v1/composition
Package composition contains internal logic linked to the validation of the v1.Composition type.
|
Package composition contains internal logic linked to the validation of the v1.Composition type. |
|
validation/apiextensions/v1/xrd
Package xrd contains internal logic linked to the validation of the v1.CompositeResourceDefinition type.
|
Package xrd contains internal logic linked to the validation of the v1.CompositeResourceDefinition type. |
|
validation/errors
Package errors provides a set of functions to handle validation errors.
|
Package errors provides a set of functions to handle validation errors. |
|
version
Package version contains utilities for working with semantic versions.
|
Package version contains utilities for working with semantic versions. |
|
version/fake
Package fake contains semantic version mocks.
|
Package fake contains semantic version mocks. |
|
xcrd
Package xcrd generates CustomResourceDefinitions from Crossplane definitions.
|
Package xcrd generates CustomResourceDefinitions from Crossplane definitions. |
|
xfn
Package xfn contains functionality for running Composition Functions.
|
Package xfn contains functionality for running Composition Functions. |
|
xpkg
Package xpkg contains functionality pertaining to Crossplane packages.
|
Package xpkg contains functionality pertaining to Crossplane packages. |
|
xpkg/fake
Package fake contains mock Crossplane package implementations.
|
Package fake contains mock Crossplane package implementations. |
|
xpkg/parser/examples
Package examples contains utilities for parsing examples.
|
Package examples contains utilities for parsing examples. |
|
xpkg/parser/yaml
Package yaml contains utilities for reading yaml packages.
|
Package yaml contains utilities for reading yaml packages. |
|
xpkg/upbound
Package upbound implements authentication for xpkg.upbound.io.
|
Package upbound implements authentication for xpkg.upbound.io. |
|
xpkg/upbound/config
Package config manages the Crossplane CLI configuration.
|
Package config manages the Crossplane CLI configuration. |
|
xpkg/upbound/credhelper
Package credhelper provides a docker credential helper for the Upbound marketplace.
|
Package credhelper provides a docker credential helper for the Upbound marketplace. |
|
pkg
|
|
|
validation/apiextensions/v1/composition
Package composition contains validation logic for the Composition type.
|
Package composition contains validation logic for the Composition type. |
|
validation/internal/schema
Package schema defines helpers for working with JSON schema.
|
Package schema defines helpers for working with JSON schema. |
|
test
|
|
|
e2e
Package e2e implements end-to-end tests for Crossplane.
|
Package e2e implements end-to-end tests for Crossplane. |
|
e2e/config
Package config contains the e2e test configuration.
|
Package config contains the e2e test configuration. |
|
e2e/funcs
Package funcs contains convenience functions for working with e2e-framework environments and feature tests.
|
Package funcs contains convenience functions for working with e2e-framework environments and feature tests. |
|
e2e/utils
Package utils contains convenience functions for certification creations and for retrieving k8s objects and their field values
|
Package utils contains convenience functions for certification creations and for retrieving k8s objects and their field values |
Click to show internal directories.
Click to hide internal directories.