Contact UsGet started

Integration with Crossplane

Written by
Updated at September 3, 2024

Crossplane is an open-source Kubernetes add-on that helps you bring solutions from different providers into a single infrastructure and provide application developers access to this infrastructure through high-level APIs. With Crossplane, users can manage third-party services in the same way they manage Kubernetes resources.

To create a Yandex Compute Cloud VM using the Crossplane application installed in a Kubernetes cluster:

  1. Create Managed Service for Kubernetes resources
  2. Create resources using Crossplane

If you no longer need the resources you created, delete them.

Prepare your cloud

  1. If you do not have the Yandex Cloud command line interface yet, install and initialize it.

    The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

  2. Install the jq JSON stream processor.

Create Managed Service for Kubernetes resources

  1. Create a Kubernetes cluster and a group of nodes.

    1. If you do not have a network yet, create one.

    2. If you do not have any subnets yet, create them in the availability zones where your Kubernetes cluster and node group will be created.

    3. Create service accounts:

      • Service account with the k8s.clusters.agent and vpc.publicAdmin roles for the folder where the Kubernetes cluster is created. This service account will be used to create the resources required for the Kubernetes cluster.
      • Service account with the container-registry.images.puller role. Nodes will pull the required Docker images from the registry on behalf of this account.

      Tip

      You can use the same service account to manage your Kubernetes cluster and its node groups.

    4. Create security groups for the Managed Service for Kubernetes cluster and its node groups.

      Warning

      The configuration of security groups determines the performance and availability of the cluster and the services and applications running in it.

    5. Create a Kubernetes cluster and a node group in any suitable configuration. When creating them, specify the security groups prepared earlier.

    1. If you do not have Terraform yet, install it.

    2. Get the authentication credentials. You can add them to environment variables or specify them later in the provider configuration file.

    3. Configure and initialize a provider. There is no need to create a provider configuration file manually, you can download it.

    4. Place the configuration file in a separate working directory and specify the parameter values. If you did not add the authentication credentials to environment variables, specify them in the configuration file.

    5. Download the k8s-cluster.tf cluster configuration file to the same working directory. The file describes:

      • Network.

      • Subnet.

      • Kubernetes cluster.

      • Service account required to use the Managed Service for Kubernetes cluster and node group.

      • Security groups which contain rules required for the Managed Service for Kubernetes cluster and its node groups.

        Warning

        The configuration of security groups determines the performance and availability of the cluster and the services and applications running in it.

    6. Specify the following in the configuration file:

      • Folder ID.
      • Kubernetes version for the Kubernetes cluster and node groups.
      • Kubernetes cluster CIDR.
      • Name of the Managed Service for Kubernetes cluster service account.

    7. Make sure the Terraform configuration files are correct using this command:

      terraform validate

      If there are any errors in the configuration files, Terraform will point them out.

    8. Create the required infrastructure:

      1. Run the command to view planned changes:

        terraform plan

        If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

      2. If you are happy with the planned changes, apply them:

        1. Run the command:

          terraform apply

        2. Confirm the update of resources.

        3. Wait for the operation to complete.

      All the required resources will be created in the specified folder. You can check resource availability and their settings in the management console.

  2. Install kubectl and configure it to work with the created cluster.

  3. Install Crossplane in the Kubernetes cluster.

  4. Set up a NAT gateway for the Kubernetes cluster node subnet.

Create resources using Crossplane

  1. Create a Crossplane providerconfig.yml manifest:

    apiVersion: yandex-cloud.jet.crossplane.io/v1alpha1
kind: ProviderConfig
metadata:
  name: yc-config
spec:
  credentials:
    source: Secret
    secretRef:
      name: yc-creds
      namespace: <namespace_for_Crossplane>
      key: credentials

  2. Create a template manifest vm-instance-template.yml with a description of the network, subnet, and crossplane-vm instance created using Crossplane:

    apiVersion: vpc.yandex-cloud.jet.crossplane.io/v1alpha1
kind: Network
metadata:
  name: <NET_NAME>
  annotations:
    crossplane.io/external-name: <NET_ID>
spec:
  deletionPolicy: Orphan
  forProvider:
    name: <NET_NAME>
    folderId: <FOLDER_ID>
---
apiVersion: vpc.yandex-cloud.jet.crossplane.io/v1alpha1
kind: Subnet
metadata:
  name: <SUBNET_NAME>
  annotations:
    crossplane.io/external-name: <SUBNET_ID>
spec:
  deletionPolicy: Orphan
  forProvider:
    name: <SUBNET_NAME>
    networkIdRef:
      name: <NET_NAME>
    v4CidrBlocks:
      - <SUBNET_PREFIX>
    zone: <ZONE_ID>
    folderId: <FOLDER_ID>
---
apiVersion: compute.yandex-cloud.jet.crossplane.io/v1alpha1
kind: Instance
metadata:
  name: <VM_NAME>
spec:
  forProvider:
    name: <VM_NAME>
    platformId: standard-v2
    zone: <ZONE_ID>
    resources:
      - cores: 2
        memory: 4
    bootDisk:
      - initializeParams:
          # LEMP stack
          # yc compute image get --folder-id standard-images --name=lemp-v20220606 --format=json | jq -r .id
          - imageId: <IMAGE_ID>
    networkInterface:
      - subnetIdRef:
          name: <SUBNET_NAME>
    folderId: <FOLDER_ID>

    Where:

    • ZONE_ID: Availability zone.
    • VM_NAME: Name of the VM to be created using Crossplane tools.
    • NET_NAME: Name of the Kubernetes cluster cloud network.
    • SUBNET_NAME: Name of the Kubernetes cluster node subnet.
    • SUBNET_ID: Subnet ID.
    • NET_ID: Network ID.
    • SUBNET_PREFIX: Subnet CIDR.
    • FOLDER_ID: Folder ID.
    • IMAGE_ID: ID of the VM's boot image. You can fetch it with a list of images. This example uses the LEMP image.

  3. Apply the providerconfig.yml manifest:

    kubectl apply -f providerconfig.yml

  4. Apply the vm-instance.yml manifest:

    kubectl apply -f vm-instance.yml

  5. Check the state of the created resources:

    kubectl get network
kubectl get subnet
kubectl get instance

  6. Make sure the created crossplane-vm instance is now in the folder:

    yc compute instance list

Delete the resources you created

Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need:

  1. Delete the crossplane-vm instance:

    kubectl delete instance crossplane-vm

  2. Delete the other resources:

    1. In the command line, go to the directory with the current Terraform configuration file with an infrastructure plan.

    2. Delete the k8s-cluster.tf configuration file.

    3. Make sure the Terraform configuration files are correct using this command:

      terraform validate

      If there are any errors in the configuration files, Terraform will point them out.

    4. Confirm updating the resources.

      1. Run the command to view planned changes:

        terraform plan

        If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

      2. If you are happy with the planned changes, apply them:

        1. Run the command:

          terraform apply

        2. Confirm the update of resources.

        3. Wait for the operation to complete.

      All the resources described in the k8s-cluster.tf configuration file will be deleted.

Previous
Integration with Argo CD
Next
Syncing with Yandex Lockbox secrets