Version: v1.2

Terraform Components

To enable end users to provision and consume cloud resources, platform engineers need to prepare ComponentDefinitions for cloud resources if end users’ requirements are beyond the built-in capabilities.

Here is the guide to create Terraform typed ComponentDefinitions of cloud resources for cloud providers Alibaba Cloud, AWS and Azure.

Alibaba Cloud

Take Elastic IP as an example.

Develop a Terraform resource or module

Create a Terraform resource or module for Alibaba Cloud EIP resource and store it in a GitHub repo like https://github.com/oam-dev/terraform-alibaba-eip.git.

Generate ComponentDefinition

  1. $ vela def init eip --type component --provider alibaba --desc "Terraform configuration for Alibaba Cloud Elastic IP" --git https://github.com/oam-dev/terraform-alibaba-eip.git
  3. apiVersion: core.oam.dev/v1beta1
  5. kind: ComponentDefinition
  7. metadata:
  9.   annotations:
  11.     definition.oam.dev/description: Terraform configuration for Alibaba Cloud Elastic
  13.       IP
  15.   creationTimestamp: null
  17.   labels:
  19.     type: terraform
  21.   name: alibaba-eip
  23.   namespace: vela-system
  25. spec:
  27.   schematic:
  29.     terraform:
  31.       configuration: https://github.com/oam-dev/terraform-alibaba-eip.git
  33.       type: remote
  35.   workload:
  37.     definition:
  39.       apiVersion: terraform.core.oam.dev/v1beta1
  41.       kind: Configuration
  43. status: {}

The ComponentDefinition for Alibaba Cloud EIP is generated. You are warmly welcome to contribute this extended cloud resource ComponentDefinition to oam-dev/catalog.

Verify

You can quickly verify the ComponentDefinition by command vela show.

  1. $ vela show alibaba-eip
  3. # Properties
  5. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  7. |            NAME            |                                       DESCRIPTION                                        |                           TYPE                            | REQUIRED | DEFAULT |
  9. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  11. | name                       | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'.                  | string                                                    | true     |         |
  13. | bandwidth                  | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number                                                    | true     |         |
  15. | writeConnectionSecretToRef | The secret which the cloud resource connection will be written to                        | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false    |         |
  17. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  25. ## writeConnectionSecretToRef
  27. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+
  29. |   NAME    |                                 DESCRIPTION                                 |  TYPE  | REQUIRED | DEFAULT |
  31. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+
  33. | name      | The secret name which the cloud resource connection will be written to      | string | true     |         |
  35. | namespace | The secret namespace which the cloud resource connection will be written to | string | false    |         |
  37. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+

If the tables display, the ComponentDefinition should work. To take a step further, you can verify it by provision an actual EIP instance per the doc Provision cloud resources.

Generate documentation

You are encouraged to generate the documentation for your ComponentDefinition and submit it to KubeVela official site.

  1. $ vela def doc-gen alibaba-eip -n vela-system
  3. Generated docs for alibaba-eip in ./kubevela.io/docs/end-user/components/cloud-services/terraform/alibaba-eip.md

Move the file generated to oam-dev/catalog repo. Follow the contribution guide to submit the doc.

AWS, Azure and other cloud providers

This only difference from Alibaba Cloud lies in the section of Generate ComponentDefinition. Please set --provider as aws or azure to generate the ComponentDefinition for an AWS or Azure cloud resource.

  1. $ vela def init -h
  6. Usage:
  8.   vela def init DEF_NAME [flags]
  13. Examples:
  15. # Command below initiate a typed ComponentDefinition named vswitch from Alibaba Cloud.
  17. > vela def init vswitch --type component --provider alibaba --desc xxx --git https://github.com/kubevela-contrib/terraform-modules.git --path alibaba/vswitch
  22. Flags:
  24.   -d, --desc string            Specify the description of the new definition.
  26.       --git string             Specify which git repository the configuration(HCL) is stored in. Valid when --provider/-p is set.
  28.   -h, --help                   help for init
  30.       --path string            Specify which path the configuration(HCL) is stored in the Git repository. Valid when --git is set.
  32.   -p, --provider alibaba       Specify which provider the cloud resource definition belongs to. Only `alibaba`, `aws`, `azure` are supported.