Documentation

PLEASE NOTE: This document applies to v0.1 version and not to the latest release v0.2

Documentation for other releases can be found by using the version selector in the top right of any doc page.

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

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

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

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