PLEASE NOTE: This document applies to v0.3 version and not to the latest release v0.4Documentation 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
After Crossplane has been installed, you can add additional functionality to its control plane by installing Crossplane Stacks. For example, each supported cloud provider has its own corresponding stack that contains all the functionality for that particular cloud. After a cloud provider’s stack is installed, you will be able to provision and manage resources within that cloud from Crossplane.
To get started with Google Cloud Platform (GCP), create a file named
stack-gcp.yaml with the following content:
apiVersion: v1 kind: Namespace metadata: name: gcp --- apiVersion: stacks.crossplane.io/v1alpha1 kind: ClusterStackInstall metadata: name: stack-gcp namespace: gcp spec: package: "crossplane/stack-gcp:v0.1.0"
Then you can install the GCP stack into Crossplane in the
gcp namespace with the following command:
kubectl apply -f stack-gcp.yaml
To get started with Amazon Web Services (AWS), create a file named
stack-aws.yaml with the following content:
apiVersion: v1 kind: Namespace metadata: name: aws --- apiVersion: stacks.crossplane.io/v1alpha1 kind: ClusterStackInstall metadata: name: stack-aws namespace: aws spec: package: "crossplane/stack-aws:v0.1.0"
Then you can install the AWS stack into Crossplane in the
aws namespace with the following command:
kubectl apply -f stack-aws.yaml
To get started with Microsoft Azure, create a file named
stack-azure.yaml with the following content:
apiVersion: v1 kind: Namespace metadata: name: azure --- apiVersion: stacks.crossplane.io/v1alpha1 kind: ClusterStackInstall metadata: name: stack-azure namespace: azure spec: package: "crossplane/stack-azure:v0.1.0"
Then you can install the Azure stack into Crossplane in the
azure namespace with the following command:
kubectl apply -f stack-azure.yaml
The cloud provider stacks can be uninstalled simply by deleting the stack resources from the cluster with a command similar to what’s shown below.
Note that this will also delete any resources that Crossplane has provisioned in the cloud provider if their
ReclaimPolicy is set to
After you have ensured that you are completely done with all your cloud provider resources, you can then run one of the commands below, depending on which cloud provider you are removing, to remove its stack from Crossplane:
kubectl delete -f stack-gcp.yaml
kubectl delete -f stack-aws.yaml
kubectl delete -f stack-azure.yaml
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