PLEASE NOTE: This document applies to an unreleased version of Crossplane. It is strongly recommended that you only use official releases of Crossplane, as unreleased versions are subject to changes and incompatibilities that will not be supported in the official releases.
If you are using an official release version of Crossplane, you should refer to the documentation for your specific version.Documentation for other releases can be found by using the version selector in the top right of any doc page.
Crossplane can be easily installed into any existing Kubernetes cluster using the regularly published Helm chart. The Helm chart contains all the custom resources and controllers needed to deploy and configure Crossplane.
Helm charts for Crossplane are currently published to the
In the future,
stable will also be available.
The alpha channel is the most recent release of Crossplane that is considered ready for testing by the community.
helm repo add crossplane-alpha https://charts.crossplane.io/alpha helm install --name crossplane --namespace crossplane-system crossplane-alpha/crossplane
master channel contains the latest commits, with all automated tests passing.
master is subject to instability, incompatibility, and features may be added or removed without much prior notice.
It is recommended to use one of the more stable channels, but if you want the absolute newest Crossplane installed, then you can use the
To install the Helm chart from master, you will need to pass the specific version returned by the
helm repo add crossplane-master https://charts.crossplane.io/master/ helm search crossplane helm install --name crossplane --namespace crossplane-system crossplane-master/crossplane --version <version>
helm install --name crossplane --namespace crossplane-system crossplane-master/crossplane --version 0.0.0-249.637ccf9
To uninstall/delete the
helm delete --purge crossplane
That command removes all Kubernetes components associated with Crossplane, including all the custom resources and controllers.
The following tables lists the configurable parameters of the Crossplane chart and their default values.
||Image pull policy||
||Names of image pull secrets to use||
||The number of replicas to run for the Crossplane operator||
||The deployment strategy for the Crossplane operator||
You can pass the settings with helm command line parameters.
Specify each parameter using the
--set key=value[,key=value] argument to
For example, the following command will install Crossplane with an image pull policy of
helm install --name crossplane --namespace crossplane-system crossplane-alpha/crossplane --set image.pullPolicy=IfNotPresent
Alternatively, a yaml file that specifies the values for the above parameters (
values.yaml) can be provided while installing the chart.
helm install --name crossplane --namespace crossplane-system crossplane-alpha/crossplane -f values.yaml
Here are the sample settings to get you started.
replicas: 1 deploymentStrategy: RollingUpdate image: repository: crossplane/crossplane tag: master pullPolicy: Always imagePullSecrets: - dockerhub