Shipa Provider Install

Providers extend Crossplane to enable infrastructure resource provisioning. In order to provision a resource, a Custom Resource Definition(CRD) needs to be registered in your Kubernetes cluster and its controller should be watching the Custom Resources those CRDs define. Provider packages contain many Custom Resource Definitions and their controllers.

For this integration, Shipa is implemented as a provider for Crossplane, implementing controllers for:

  • Application management
  • Cluster management
  • Framework management
  • Plan management
  • Role management
  • Team and user management

Installing Crossplane

Crossplane can be easily installed into any existing Kubernetes cluster using the regularly published Helm chart and the steps below:

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 --set packageCache.sizeLimit=512Mi

📘

Crossplane install details

You can find detailed instructions on how to install Crossplane directly from Crossplane's official documentation available here

Installing the Shipa Provider

To install the Shipa provider package, apply the following resource to the cluster where Crossplane is running:

apiVersion: pkg.crossplane.io/v1beta1
kind: Provider
metadata:
  name: provider-shipa
spec:
  package: "shipasoftware/provider-shipa:0.0.1"

You can apply the file above by using the command:

kubectl apply -f crossplane-provider-shipa.yaml

Configuring the Provider

To authenticate with the Shipa API, the provider controllers need to have access to credentials. Therefore, we use a type called Provider with information about how to authenticate to the Shipa API.

The file above configures the connection between Crossplane and the Shipa API:

apiVersion: v1
kind: Secret
metadata:
  name: crossplane-secret
  namespace: crossplane-system
stringData:
  endpoint: "https://target.shipa.cloud:8081"
  token: "your token"

type: Opaque

You can apply the file above using the command:

kubectl apply -f crossplane-secret.yaml

📘

Finding your Shipa token

You can find your Shipa user token by using the following command:

shipa token show

Next, you need to create the Provider Config. You can do so using the following file:

apiVersion: shipa.crossplane.io/v1alpha1
kind: ProviderConfig
metadata:
  name: default
spec:
  credentials:
    source: ShipaConnectionSecret
    connectionSecretRef:
      name: crossplane-secret
      namespace: crossplane-system

You can apply the file above using the command:

kubectl apply -f crossplane-shipa-config.yaml

Your Shipa provider is now installed and ready to be used with Crossplane.


Did this page help you?