Version: v1.1

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.

Develop a ComponentDefinition for a cloud resource

Alibaba Cloud

Take Elastic IP as an example.

Develop a Terraform resource or module for the cloud resource

We recommend you to search the required cloud resource module in Terraform official module registry. If no luck, you can create a Terraform resource or module yourself per Terraform Alibaba Cloud Provider specifications.

  1. module "eip" {
  2.   source = "github.com/zzxwill/terraform-alicloud-eip"
  3.   name = var.name
  4.   bandwidth = var.bandwidth
  5. }
  8. variable "name" {
  9.   description = "Name to be used on all resources as prefix. Default to 'TF-Module-EIP'."
  10.   default = "TF-Module-EIP"
  11.   type = string
  12. }
  15. variable "bandwidth" {
  16.   description = "Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second)."
  17.   type = number
  18.   default = 5
  19. }
  22. output "EIP_ADDRESS" {
  23.   description = "The elastic ip address."
  24.   value       = module.eip.this_eip_address.0
  25. }

For Alibaba Cloud EIP, here is the complete ComponentDefinition. You are warmly welcome to contribute this extended cloud resource ComponentDefinition to oam-dev/kubevela.

  1. apiVersion: core.oam.dev/v1alpha2
  2. kind: ComponentDefinition
  3. metadata:
  4.   name: alibaba-eip
  5.   namespace: {{.Values.systemDefinitionNamespace}}
  6.   annotations:
  7.     definition.oam.dev/description: Terraform configuration for Alibaba Cloud Elastic IP
  8.   labels:
  9.     type: terraform
  10. spec:
  11.   workload:
  12.     definition:
  13.       apiVersion: terraform.core.oam.dev/v1beta1
  14.       kind: Configuration
  15.   schematic:
  16.     terraform:
  17.       configuration: |
  18.         module "eip" {
  19.           source = "github.com/zzxwill/terraform-alicloud-eip"
  20.           name = var.name
  21.           bandwidth = var.bandwidth
  22.         }
  25.         variable "name" {
  26.           description = "Name to be used on all resources as prefix. Default to 'TF-Module-EIP'."
  27.           default = "TF-Module-EIP"
  28.           type = string
  29.         }
  32.         variable "bandwidth" {
  33.           description = "Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second)."
  34.           type = number
  35.           default = 5
  36.         }
  39.         output "EIP_ADDRESS" {
  40.           description = "The elastic ip address."
  41.           value       = module.eip.this_eip_address.0
  42.         }

Verify

You can quickly verify the ComponentDefinition by command vela show.

  1. $ vela show alibaba-eip
  2. # Properties
  3. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  4. |            NAME            |                                       DESCRIPTION                                        |                           TYPE                            | REQUIRED | DEFAULT |
  5. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  6. | name                       | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'.                  | string                                                    | true     |         |
  7. | bandwidth                  | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number                                                    | true     |         |
  8. | writeConnectionSecretToRef | The secret which the cloud resource connection will be written to                        | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false    |         |
  9. +----------------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
  14. ## writeConnectionSecretToRef
  15. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+
  16. |   NAME    |                                 DESCRIPTION                                 |  TYPE  | REQUIRED | DEFAULT |
  17. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+
  18. | name      | The secret name which the cloud resource connection will be written to      | string | true     |         |
  19. | namespace | The secret namespace which the cloud resource connection will be written to | string | false    |         |
  20. +-----------+-----------------------------------------------------------------------------+--------+----------+---------+

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.