Documentation

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.

Install Crossplane

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.

Pre-requisites

Installation

Helm charts for Crossplane are currently published to the alpha and master channels. In the future, beta and stable will also be available.

If you’re using Helm 3, make sure you create the crossplane-system namespace (or the namespace you’d like to install crossplane) beforehand since Helm 3 does not create that for you automatically anymore.

Alpha

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

The 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 master channel.

To install the Helm chart from master, you will need to pass the specific version returned by the search command:

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>

For example:

helm install --name crossplane --namespace crossplane-system crossplane-master/crossplane --version 0.0.0-249.637ccf9

Installing Cloud Provider Stacks

You can add additional functionality to Crossplane’s 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.

Installation with Helm

This method is not supported with Helm 3, please see Manual Installation if you’re using Helm 3.

You can include deployment of additional infrastructure stacks into your helm installation by setting clusterStacks.<stack-name>.deploy to true.

For example, the following will install master version of the GCP stack:

helm install --name crossplane --namespace crossplane-system crossplane-master/crossplane --set clusterStacks.gcp.deploy=true --set clusterStacks.gcp.version=master

See helm configuration parameters for supported stacks and parameters.

Manual Installation

After Crossplane has been installed, it is possible to extend Crossplane’s functionality by installing Crossplane stacks.

GCP Stack

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:master"

Then you can install the GCP stack into Crossplane in the gcp namespace with the following command:

kubectl apply -f stack-gcp.yaml

AWS Stack

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:master"

Then you can install the AWS stack into Crossplane in the aws namespace with the following command:

kubectl apply -f stack-aws.yaml

Azure Stack

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:master"

Then you can install the Azure stack into Crossplane in the azure namespace with the following command:

kubectl apply -f stack-azure.yaml

Rook Stack

To get started with Rook, create a file named stack-rook.yaml with the following content:

apiVersion: v1
kind: Namespace
metadata:
  name: rook
---
apiVersion: stacks.crossplane.io/v1alpha1
kind: ClusterStackInstall
metadata:
  name: stack-rook
  namespace: rook
spec:
  package: "crossplane/stack-rook:master"

Then you can install the Rook stack into Crossplane in the rook namespace with the following command:

kubectl apply -f stack-rook.yaml

Uninstalling Cloud Provider Stacks

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 Delete.

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:

Uninstalling GCP

kubectl delete -f stack-gcp.yaml

Uninstalling AWS

kubectl delete -f stack-aws.yaml

Uninstalling Azure

kubectl delete -f stack-azure.yaml

Uninstalling Rook

kubectl delete -f stack-rook.yaml

Uninstalling the Chart

To uninstall/delete the crossplane deployment:

helm delete --purge crossplane

That command removes all Kubernetes components associated with Crossplane, including all the custom resources and controllers.

Configuration

The following tables lists the configurable parameters of the Crossplane chart and their default values.

Parameter Description Default
image.repository Image crossplane/crossplane
image.tag Image tag master
image.pullPolicy Image pull policy Always
imagePullSecrets Names of image pull secrets to use dockerhub
replicas The number of replicas to run for the Crossplane operator 1
deploymentStrategy The deployment strategy for the Crossplane operator RollingUpdate
clusterStacks.aws.deploy Deploy AWS stack false
clusterStacks.aws.version AWS stack version to deploy <latest released version>
clusterStacks.gcp.deploy Deploy GCP stack false
clusterStacks.gcp.version GCP stack version to deploy <latest released version>
clusterStacks.azure.deploy Deploy Azure stack false
clusterStacks.azure.version Azure stack version to deploy <latest released version>
clusterStacks.rook.deploy Deploy Rook stack false
clusterStacks.rook.version Rook stack version to deploy <latest released version>

Command Line

You can pass the settings with helm command line parameters. Specify each parameter using the --set key=value[,key=value] argument to helm install. For example, the following command will install Crossplane with an image pull policy of IfNotPresent.

helm install --name crossplane --namespace crossplane-system crossplane-alpha/crossplane --set image.pullPolicy=IfNotPresent

Settings File

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