## Start with a Hosted Crossplane Upbound Cloud is a managed service of Crossplane created by the founders of Crossplane. You can [create an account](https://cloud.upbound.io/register) to get started. Once logged in, you can [create](https://cloud.upbound.io/docs/getting-started/set-up-upbound-cloud) and then [connect](https://cloud.upbound.io/docs/getting-started/connect-to-your-platform) to your hosted Crossplane cluster. Once you've completed these two steps, skip down to [Install Crossplane CLI](#install-crossplane-cli) for further setup instructions. Want see another hosted Crossplane service listed? Please [reach out on Slack][Slack] and our community will highlight it here!

## Start with a Self-Hosted Crossplane Installing Crossplane into an existing Kubernetes cluster will require a bit more setup, but can provide more flexibility for users who need it. ### Get a Kubernetes Cluster

For macOS via Homebrew use the following: ```console brew upgrade brew install kind brew install kubectl brew install helm kind create cluster --image kindest/node:v1.16.15 --wait 5m ```

For macOS / Linux use the following: * [Kubernetes cluster] * [Kind] * [Minikube], minimum version `v0.28+` * etc. * [Helm], minimum version `v3.0.0+`.

For Windows use the following: * [Kubernetes cluster] * [Kind] * [Minikube], minimum version `v0.28+` * etc. * [Helm], minimum version `v3.0.0+`.

### Install Crossplane

Helm 3 (stable)
Helm 3 (latest)

Use Helm 3 to install the latest official `stable` release of Crossplane, suitable for community use and testing: ```console kubectl create namespace crossplane-system helm repo add crossplane-stable https://charts.crossplane.io/stable helm repo update helm install crossplane --namespace crossplane-system crossplane-stable/crossplane --version 1.3.1 ```

Use Helm 3 to install the latest pre-release version of Crossplane: ```console kubectl create namespace crossplane-system helm repo add crossplane-master https://charts.crossplane.io/master/ helm repo update helm search repo crossplane-master --devel helm install crossplane --namespace crossplane-system crossplane-master/crossplane \ --devel --version ``` For example: ```console helm install crossplane --namespace crossplane-system crossplane-master/crossplane \ --version 0.11.0-rc.100.gbc5d311 --devel ```

### Check Crossplane Status ```console helm list -n crossplane-system kubectl get all -n crossplane-system ```

### Install Configuration Package > If you prefer to see the contents of this configuration package and how it is > constructed prior to install, skip ahead to the [create a configuration] > section. ```console kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws:v1.3.2 ``` Wait until all packages become healthy: ``` kubectl get pkg --watch ``` ### Get AWS Account Keyfile Using an AWS account with permissions to manage RDS databases: ```console AWS_PROFILE=default && echo -e "[default]\naws_access_key_id = $(aws configure get aws_access_key_id --profile $AWS_PROFILE)\naws_secret_access_key = $(aws configure get aws_secret_access_key --profile $AWS_PROFILE)" > creds.conf ``` ### Create a Provider Secret ```console kubectl create secret generic aws-creds -n crossplane-system --from-file=creds=./creds.conf ``` ### Configure the Provider We will create the following `ProviderConfig` object to configure credentials for AWS Provider: ```yaml apiVersion: aws.crossplane.io/v1beta1 kind: ProviderConfig metadata: name: default spec: credentials: source: Secret secretRef: namespace: crossplane-system name: aws-creds key: creds ``` ```console kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/release-1.3/docs/snippets/configure/aws/providerconfig.yaml ```

### Install Configuration Package > If you prefer to see the contents of this configuration package and how it is > constructed prior to install, skip ahead to the [create a configuration] > section. ```console kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws-with-vpc:v1.3.2 ``` Wait until all packages become healthy: ``` kubectl get pkg --watch ``` ### Get AWS Account Keyfile Using an AWS account with permissions to manage RDS databases: ```console AWS_PROFILE=default && echo -e "[default]\naws_access_key_id = $(aws configure get aws_access_key_id --profile $AWS_PROFILE)\naws_secret_access_key = $(aws configure get aws_secret_access_key --profile $AWS_PROFILE)" > creds.conf ``` ### Create a Provider Secret ```console kubectl create secret generic aws-creds -n crossplane-system --from-file=creds=./creds.conf ``` ### Configure the Provider We will create the following `ProviderConfig` object to configure credentials for AWS Provider: ```yaml apiVersion: aws.crossplane.io/v1beta1 kind: ProviderConfig metadata: name: default spec: credentials: source: Secret secretRef: namespace: crossplane-system name: aws-creds key: creds ``` ```console kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/release-1.3/docs/snippets/configure/aws/providerconfig.yaml ```

### Install Configuration Package > If you prefer to see the contents of this configuration package and how it is > constructed prior to install, skip ahead to the [create a configuration] > section. ```console kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-gcp:v1.3.2 ``` Wait until all packages become healthy: ``` kubectl get pkg --watch ``` ### Get GCP Account Keyfile ```console # replace this with your own gcp project id and the name of the service account # that will be created. PROJECT_ID=my-project NEW_SA_NAME=test-service-account-name # create service account SA="${NEW_SA_NAME}@${PROJECT_ID}.iam.gserviceaccount.com" gcloud iam service-accounts create $NEW_SA_NAME --project $PROJECT_ID # enable cloud API SERVICE="sqladmin.googleapis.com" gcloud services enable $SERVICE --project $PROJECT_ID # grant access to cloud API ROLE="roles/cloudsql.admin" gcloud projects add-iam-policy-binding --role="$ROLE" $PROJECT_ID --member "serviceAccount:$SA" # create service account keyfile gcloud iam service-accounts keys create creds.json --project $PROJECT_ID --iam-account $SA ``` ### Create a Provider Secret ```console kubectl create secret generic gcp-creds -n crossplane-system --from-file=creds=./creds.json ``` ### Configure the Provider We will create the following `ProviderConfig` object to configure credentials for GCP Provider: ```console # replace this with your own gcp project id PROJECT_ID=my-project echo "apiVersion: gcp.crossplane.io/v1beta1 kind: ProviderConfig metadata: name: default spec: projectID: ${PROJECT_ID} credentials: source: Secret secretRef: namespace: crossplane-system name: gcp-creds key: creds" | kubectl apply -f - ```

### Install Configuration Package > If you prefer to see the contents of this configuration package and how it is > constructed prior to install, skip ahead to the [create a configuration] > section. ```console kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-azure:v1.3.2 ``` Wait until all packages become healthy: ``` kubectl get pkg --watch ``` ### Get Azure Principal Keyfile ```console # create service principal with Owner role az ad sp create-for-rbac --sdk-auth --role Owner > "creds.json" # we need to get the clientId from the json file to add Azure Active Directory # permissions. if which jq > /dev/null 2>&1; then AZURE_CLIENT_ID=$(jq -r ".clientId" < "./creds.json") else AZURE_CLIENT_ID=$(cat creds.json | grep clientId | cut -c 16-51) fi RW_ALL_APPS=1cda74f2-2616-4834-b122-5cb1b07f8a59 RW_DIR_DATA=78c8a3c8-a07e-4b9e-af1b-b5ccab50a175 AAD_GRAPH_API=00000002-0000-0000-c000-000000000000 az ad app permission add --id "${AZURE_CLIENT_ID}" --api ${AAD_GRAPH_API} --api-permissions ${RW_ALL_APPS}=Role ${RW_DIR_DATA}=Role az ad app permission grant --id "${AZURE_CLIENT_ID}" --api ${AAD_GRAPH_API} --expires never > /dev/null az ad app permission admin-consent --id "${AZURE_CLIENT_ID}" ``` ### Create a Provider Secret ```console kubectl create secret generic azure-creds -n crossplane-system --from-file=creds=./creds.json ``` ### Configure the Provider We will create the following `ProviderConfig` object to configure credentials for Azure Provider: ```yaml apiVersion: azure.crossplane.io/v1beta1 kind: ProviderConfig metadata: name: default spec: credentials: source: Secret secretRef: namespace: crossplane-system name: azure-creds key: creds ``` ```console kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/release-1.3/docs/snippets/configure/azure/providerconfig.yaml ```