Skip to content

Latest commit

 

History

History
196 lines (154 loc) · 5.23 KB

Quickstart.md

File metadata and controls

196 lines (154 loc) · 5.23 KB
Raw

Quickstart

This guide walks through the process to install Upbound Universal Crossplane and the Ionoscloud provider.

Install the Up command-line

Download and install the Upbound up command-line.

curl -sL "https://cli.upbound.io" | sh
sudo mv up /usr/local/bin/

Verify the version of up with up --version

$ up version --client
Client:
  Version:     v0.33.0

More information about the Up command-line is available in the Upbound Up documentation.

Install Upbound Universal Crossplane

Install Upbound Universal Crossplane (UXP) with the Up command-line up uxp install command.

$ up uxp install
UXP 1.17.1-up.1 installed

Verify all UXP pods are Running with kubectl get pods -n upbound-system

kubectl get pods -n upbound-system
NAME                                       READY   STATUS    RESTARTS   AGE
crossplane-77ff754998-4l8xb                1/1     Running   0          21s
crossplane-rbac-manager-79b8bdd6d8-ml6ft   1/1     Running   0          21s

Find more information in the Upbound UXP documentation.

Install the Ionoscloud provider

Install the Ionoscloud provider into the Kubernetes cluster with a Kubernetes configuration file.

cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-ionoscloud
spec:
  package: xpkg.upbound.io/ionoscloud/provider-upjet-ionoscloud:v0.1.0
EOF

Apply this configuration with kubectl apply -f.

After installing the provider, verify the install with kubectl get providers.

NAME                        INSTALLED   HEALTHY   PACKAGE                            AGE
provider-upjet-ionoscloud   True        True      provider-upjet-ionoscloud-v0.1.0   100s

Create a Kubernetes secret for Ionoscloud

Using a Ionoscloud token

kubectl -n upbound-system create secret generic ionoscloud-secret --from-literal=credentials="{\"token\":\"${IONOS_TOKEN}\"}"

With Object Storage access

kubectl -n upbound-system create secret generic ionoscloud-secret --from-literal=credentials="{\"token\":\"${IONOS_TOKEN}\",\"s3_access_key\":\"${IONOS_S3_ACCESS_KEY}\",\"s3_secret_key\":\"${IONOS_S3_SECRET_KEY}\"}"

Using the Ionoscloud username and password

kubectl -n upbound-system create secret generic ionoscloud-secret --from-literal=credentials="{\"user\":\"${IONOS_USERNAME}\",\"password\":\"${IONOS_PASSWORD}\"}"

View the secret with kubectl describe secret

kubectl describe secret ionoscloud-secret -n upbound-system
Name:         ionoscloud-secret
Namespace:    upbound-system
Labels:       <none>
Annotations:  <none>

Type:  Opaque

Data
====
credentials:  1274 bytes

Note: the size may be larger or smaller depending on which credentials you supplied

Create a ProviderConfig

Create a ProviderConfig Kubernetes configuration file to attach the Ionoscloud credentials to the provider.

cat <<EOF | kubectl apply -f -
apiVersion: upjet-ionoscloud.ionoscloud.io/v1beta1
kind: ProviderConfig
metadata:
  name: default
spec:
  credentials:
    source: Secret
    secretRef:
      namespace: upbound-system
      name: ionoscloud-secret
      key: credentials
EOF

The spec.secretRef describes the parameters of the secret to use.

  • namespace is the Kubernetes namespace the secret is in.
  • name is the name of the Kubernetes secret object.
  • key is the Data field from kubectl describe secret.

Apply this configuration with kubectl apply -f.

Verify the ProviderConfig with kubectl describe providerconfigs.

kubectl describe providerconfigs
Name:         default
Namespace:
API Version:  upjet-ionoscloud.ionoscloud.io/v1beta1
Kind:         ProviderConfig
# Output truncated
Spec:
  Credentials:
    Secret Ref:
      Key:        credentials
      Name:       ionoscloud-secret
      Namespace:  upbound-system
    Source:       Secret

Note: the ProviderConfig install fails and Kubernetes returns an error if the Provider isn't installed.

kubectl apply -f providerconfig.yml
error: resource mapping not found for name: "default" namespace: "" from "providerconfig.yml": no matches for kind "ProviderConfig" in version "upjet-ionoscloud.ionoscloud.io/v1beta1"
ensure CRDs are installed first

Create a managed resource

Create a managed resource to verify the provider is functioning.

This example creates a Ionoscloud datacenter.

CAT <<EOF | kubectl apply -f -
apiVersion: compute.ionoscloud.io/v1alpha1
kind: Datacenter
metadata:
  name: example
spec:
  forProvider:
    description: Example datacenter description
    location: de/fra
    name: Datacenter Example
    secAuthProtection: false
EOF

Use kubectl get datacenters to verify datacenter creation.

kubectl get datacenters
NAME      SYNCED   READY   EXTERNAL-NAME                          AGE
example   True     True    5bc1d7a9-2b1d-488c-b16f-8b946017ecde   5m3s

The datacenter creation is finalized when the values READY and SYNCED are True.

Delete the managed resource

kubectl delete datacenters.compute.ionoscloud.io example 
datacenter.compute.ionoscloud.io "example" deleted


kubectl get datacenters
No resources found