mirror of https://github.com/crossplane/docs.git
docs snapshot for crossplane version `master`
This commit is contained in:
Crossplane
parent
91a4884b44
commit
d1255f9e11
|
|
@ -1,8 +1,3 @@
|
|||
---
|
||||
title: Welcome
|
||||
toc: true
|
||||
weight: 110
|
||||
---
|
||||
# Crossplane
|
||||
|
||||
Crossplane is an open source multicloud control plane. It introduces workload and resource abstractions on-top of existing managed services that enables a high degree of workload portability across cloud providers. A single crossplane enables the provisioning and full-lifecycle management of services and infrastructure across a wide range of providers, offerings, vendors, regions, and clusters. Crossplane offers a universal API for cloud computing, a workload scheduler, and a set of smart controllers that can automate work across clouds.
|
||||
|
|
@ -19,7 +14,7 @@ For a deeper dive into Crossplane, see the [architecture](https://docs.google.co
|
|||
|
||||
* [Quick Start Guide](quick-start.md)
|
||||
* [Getting Started](getting-started.md)
|
||||
* [Installing Crossplane Software](install-crossplane.md)
|
||||
* [Installing Crossplane](install-crossplane.md)
|
||||
* [Adding Your Cloud Providers](cloud-providers.md)
|
||||
* [Deploying Workloads](deploy.md)
|
||||
* [Running Resources](running-resources.md)
|
||||
|
|
|
|||
|
|
@ -4,4 +4,104 @@ toc: true
|
|||
weight: 320
|
||||
indent: true
|
||||
---
|
||||
# Installing Crossplane Software
|
||||
# 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
|
||||
|
||||
* [Kubernetes cluster](https://kubernetes.io/docs/setup/)
|
||||
* For example [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/), minimum version `v0.28+`
|
||||
* [Helm](https://docs.helm.sh/using_helm/), minimum version `v2.9.1+`.
|
||||
|
||||
## 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.
|
||||
|
||||
```console
|
||||
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:
|
||||
|
||||
```console
|
||||
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:
|
||||
|
||||
```console
|
||||
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:
|
||||
|
||||
```console
|
||||
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`.
|
||||
|
||||
```console
|
||||
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.
|
||||
|
||||
```console
|
||||
helm install --name crossplane --namespace crossplane-system crossplane-alpha/crossplane -f values.yaml
|
||||
```
|
||||
|
||||
Here are the sample settings to get you started.
|
||||
|
||||
```yaml
|
||||
replicas: 1
|
||||
|
||||
deploymentStrategy: RollingUpdate
|
||||
|
||||
image:
|
||||
repository: crossplane/crossplane
|
||||
tag: master
|
||||
pullPolicy: Always
|
||||
|
||||
imagePullSecrets:
|
||||
- dockerhub
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue