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.
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.10 | Oct 18, 2022 | Jul 2023 |
| v1.11 | Jan 31, 2023 | Oct 2023 |
| v1.12 | Apr 25, 2023 | Jan 2024 |
| v1.13 | Late Jul '23 | Apr 2024 |
| v1.14 | Late Oct '23 | Jul 2024 |
| v1.15 | Late Jan '24 | Oct 2024 |
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.
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 contact us via Email.
- Join our regular community meetings.
- Provide feedback on our roadmap and releases board.
The Crossplane community meeting takes place every other Thursday at 10:00am Pacific Time. 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
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/fn/io/v1alpha1
Package v1alpha1 contains meta types used to invoke Composition Functions.
|
Package v1alpha1 contains meta types used to invoke Composition Functions. |
|
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/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 kubectl crossplane.
|
Package main implements Crossplane's crank CLI - aka kubectl crossplane. |
|
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. |
|
xfn
Package main is the reference implementation of Composition Functions.
|
Package main is the reference implementation of Composition Functions. |
|
xfn/run
Package run implements a convenience CLI to run and test Composition Functions.
|
Package run implements a convenience CLI to run and test Composition Functions. |
|
xfn/spark
Package spark runs a Composition Function.
|
Package spark runs a Composition Function. |
|
xfn/start
Package start implements the reference Composition Function runner.
|
Package start implements the reference Composition Function runner. |
|
internal
|
|
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/apiextensions/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/apiextensions/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/pkg/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/pkg/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/pkg/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/pkg/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/pkg/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/pkg/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/secrets/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/secrets/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
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/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/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/namespace
Package namespace implements the RBAC manager's support for namespaces.
|
Package namespace implements the RBAC manager's support for namespaces. |
|
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. |
|
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. |
|
oci
Package oci contains functionality for working with Open Container Initiative (OCI) images and containers.
|
Package oci contains functionality for working with Open Container Initiative (OCI) images and containers. |
|
oci/layer
Package layer extracts OCI image layer tarballs.
|
Package layer extracts OCI image layer tarballs. |
|
oci/spec
Package spec implements OCI runtime spec support.
|
Package spec implements OCI runtime spec support. |
|
oci/store
Package store implements OCI container storage.
|
Package store implements OCI container storage. |
|
oci/store/overlay
Package overlay implements an overlay based container store.
|
Package overlay implements an overlay based container store. |
|
oci/store/uncompressed
Package uncompressed implemented an uncompressed layer based container store.
|
Package uncompressed implemented an uncompressed layer based container store. |
|
transport
Package transport contains HTTP transport utilities for Crossplane.
|
Package transport contains HTTP transport utilities for Crossplane. |
|
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/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 is the reference implementation of Composition Functions.
|
Package xfn is the reference implementation of 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. |
|
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/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.