Support server-side Terraform as cloud resource provider (#1519)

* Support server-side Terraform as cloud resource provider

Provide another schematic `Terraform` to provision cloud
resource.

Fix #698

* make namespace optional
add unit-tests

* support vela show to generate componentdefinition usage

* add unit-tests

* tidy go mod

* clean go mod and updated go sum

* Remove `variable` from `properties` of Terraform compoent

* don't literally set component catagory

* refine error message when a capability could not be found

* fix ut

* Code refactor and add unittests

* fix ci issues

* Update references/plugins/references.go
Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* add test cases

* fix ci issue

* revert lowercase of "Properties"

* fix ci issue

* add ut for appfile

* fix e2e issue

* add docs

* fix official site build
Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

apis/core.oam.dev/common/types.go

@@ -84,7 +84,7 @@ type Schematic struct {
 
 	HELM *Helm `json:"helm,omitempty"`
 
-	// TODO(wonderflow): support HCL(terraform)here.
+	Terraform *Terraform `json:"terraform,omitempty"`
 }
 
 // A Helm represents resources used by a Helm module
@@ -98,6 +98,17 @@ type Helm struct {
 	Repository runtime.RawExtension `json:"repository"`
 }
 
+// Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+type Terraform struct {
+	// Configuration is Terraform Configuration
+	Configuration string `json:"configuration"`
+
+	// Type specifies which Terraform configuration it is, HCL or JSON syntax
+	// +kubebuilder:default:=hcl
+	// +kubebuilder:validation:Enum:=hcl;json
+	Type string `json:"type,omitempty"`
+}
+
 // A WorkloadTypeDescriptor refer to a Workload Type
 type WorkloadTypeDescriptor struct {
 	// Type ref to a WorkloadDefinition via name

apis/core.oam.dev/common/zz_generated.deepcopy.go

@@ -291,6 +291,11 @@ func (in *Schematic) DeepCopyInto(out *Schematic) {
 		*out = new(Helm)
 		(*in).DeepCopyInto(*out)
 	}
+	if in.Terraform != nil {
+		in, out := &in.Terraform, &out.Terraform
+		*out = new(Terraform)
+		**out = **in
+	}
 }
 
 // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Schematic.
@@ -318,6 +323,21 @@ func (in *Status) DeepCopy() *Status {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *Terraform) DeepCopyInto(out *Terraform) {
+	*out = *in
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Terraform.
+func (in *Terraform) DeepCopy() *Terraform {
+	if in == nil {
+		return nil
+	}
+	out := new(Terraform)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *WorkloadGVK) DeepCopyInto(out *WorkloadGVK) {
 	*out = *in

apis/types/capability.go

@@ -59,6 +59,9 @@ type Capability struct {
 	Source  *Source       `json:"source,omitempty"`
 	Install *Installation `json:"install,omitempty"`
 	CrdInfo *CRDInfo      `json:"crdInfo,omitempty"`
+
+	// Terraform
+	TerraformConfiguration string `json:"terraformConfiguration,omitempty"`
 }
 
 // Chart defines all necessary information to install a whole chart

charts/vela-core/crds/core.oam.dev_applicationrevisions.yaml

@@ -665,6 +665,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -923,6 +939,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for trait
@@ -1119,6 +1151,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -1822,6 +1870,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -2081,6 +2145,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for trait
@@ -2277,6 +2357,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload

charts/vela-core/crds/core.oam.dev_componentdefinitions.yaml

@@ -143,6 +143,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for workload
@@ -354,6 +370,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for workload

charts/vela-core/crds/core.oam.dev_definitionrevisions.yaml

@@ -160,6 +160,22 @@ spec:
                             required:
                             - template
                             type: object
+                          terraform:
+                            description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                            properties:
+                              configuration:
+                                description: Configuration is Terraform Configuration
+                                type: string
+                              type:
+                                default: hcl
+                                description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                enum:
+                                - hcl
+                                - json
+                                type: string
+                            required:
+                            - configuration
+                            type: object
                         type: object
                       status:
                         description: Status defines the custom health policy and status message for workload
@@ -372,6 +388,22 @@ spec:
                             required:
                             - template
                             type: object
+                          terraform:
+                            description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                            properties:
+                              configuration:
+                                description: Configuration is Terraform Configuration
+                                type: string
+                              type:
+                                default: hcl
+                                description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                enum:
+                                - hcl
+                                - json
+                                type: string
+                            required:
+                            - configuration
+                            type: object
                         type: object
                       status:
                         description: Status defines the custom health policy and status message for trait

charts/vela-core/crds/core.oam.dev_traitdefinitions.yaml

@@ -144,6 +144,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for trait
@@ -339,6 +355,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for trait

charts/vela-core/crds/core.oam.dev_workloaddefinitions.yaml

@@ -152,6 +152,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for workload
@@ -338,6 +354,22 @@ spec:
                     required:
                     - template
                     type: object
+                  terraform:
+                    description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                    properties:
+                      configuration:
+                        description: Configuration is Terraform Configuration
+                        type: string
+                      type:
+                        default: hcl
+                        description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                        enum:
+                        - hcl
+                        - json
+                        type: string
+                    required:
+                    - configuration
+                    type: object
                 type: object
               status:
                 description: Status defines the custom health policy and status message for workload

docs/en/end-user/cloud-resources.md

 ---
-title: Provision and Consume Cloud Resources
+title: Provision and Consume Cloud Resources by Crossplane
 ---
 
 > ⚠️ This section requires your platform builder has already installed the [cloud resources related capabilities](../platform-engineers/cloud-services).

docs/en/end-user/terraform.md

+---
+title: Provision and Consume Cloud Resources by Terraform
+---
+
+> ⚠️ This section requires your platform builder has already installed the [Terraform related capabilities](../platform-engineers/terraform.md).
+
+Check the parameters of cloud resource components and trait.
+
+```shell
+$ kubectl vela show alibaba-rds
+# Properties
++----------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
+|            NAME            |                               DESCRIPTION                               |                           TYPE                            | REQUIRED | DEFAULT |
++----------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
+| bucket                     | OSS bucket name                                                         | string                                                    | true     |         |
+| acl                        | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string                                                    | true     |         |
+| writeConnectionSecretToRef | The secret which the cloud resource connection will be written to       | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false    |         |
++----------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------+----------+---------+
+
+
+## writeConnectionSecretToRef
++-----------+-----------------------------------------------------------------------------+--------+----------+---------+
+|   NAME    |                                 DESCRIPTION                                 |  TYPE  | REQUIRED | DEFAULT |
++-----------+-----------------------------------------------------------------------------+--------+----------+---------+
+| name      | The secret name which the cloud resource connection will be written to      | string | true     |         |
+| namespace | The secret namespace which the cloud resource connection will be written to | string | false    |         |
++-----------+-----------------------------------------------------------------------------+--------+----------+---------+
+
+
+$ kubectl vela show service-binding
+# Properties
++-------------+------------------------------------------------+------------------+----------+---------+
+|    NAME     |                  DESCRIPTION                   |       TYPE       | REQUIRED | DEFAULT |
++-------------+------------------------------------------------+------------------+----------+---------+
+| envMappings | The mapping of environment variables to secret | map[string]{...} | true     |         |
++-------------+------------------------------------------------+------------------+----------+---------+
+```
+
+Now apply an [application](https://github.com/oam-dev/kubevela/tree/master/docs/examples/terraform/cloud-resource-provision-and-consume/application.yaml) as below.
+
+```yaml
+apiVersion: core.oam.dev/v1beta1
+kind: Application
+metadata:
+  name: webapp
+spec:
+  components:
+    - name: express-server
+      type: webservice
+      properties:
+        image: zzxwill/flask-web-application:v0.3.1-crossplane
+        ports: 80
+      traits:
+        - type: service-binding
+          properties:
+            envMappings:
+              # environments refer to db-conn secret
+              DB_PASSWORD:
+                secret: db-conn                                   # 1) If the env name is the same as the secret key, secret key can be omitted.
+              endpoint:
+                secret: db-conn
+                key: DB_HOST                                      # 2) If the env name is different from secret key, secret key has to be set.
+              username:
+                secret: db-conn
+                key: DB_USER
+              # environments refer to oss-conn secret
+              BUCKET_NAME:
+                secret: oss-conn
+
+    - name: sample-db
+      type: alibaba-rds
+      properties:
+        instance_name: sample-db
+        account_name: oamtest
+        password: U34rfwefwefffaked
+        writeConnectionSecretToRef:
+          name: db-conn
+
+    - name: sample-oss
+      type: alibaba-oss
+      properties:
+        bucket: vela-website
+        acl: private
+        writeConnectionSecretToRef:
+          name: oss-conn
+
+
+```
+
+Apply it and verify the application.
+
+```shell
+$ kubectl get application
+NAME     AGE
+webapp   46m
+
+$ kubectl port-forward deployment/express-server 80:80
+Forwarding from 127.0.0.1:80 -> 80
+Forwarding from [::1]:80 -> 80
+Handling connection for 80
+Handling connection for 80
+```
+
+![](../resources/crossplane-visit-application.jpg)

docs/en/platform-engineers/cloud-services.md

@@ -126,7 +126,7 @@ metadata:
   name: alibaba-oss
   namespace: vela-system
   annotations:
-    definition.oam.dev/description: "Alibaba Cloud RDS Resource"
+    definition.oam.dev/description: "Alibaba Cloud OSS Resource"
 spec:
   workload:
     definition:

docs/en/platform-engineers/terraform.md

+---
+title: Terraform
+---
+
+In addition to provisioning and consuming cloud resources by [Crossplane](./cloud-services.md), we can also use Terraform,
+which is one of four ComponentDefinition schematic types `cue`, `kube`, `helm` and `terraform`.
+
+To enable end users to be able to create application by Terraform, please follow these steps.
+
+## Install Terraform Controller chart
+
+Download the latest chart, like `terraform-controller-chart-0.1.4.tgz`, from the latest [releases](https://github.com/oam-dev/terraform-controller/releases) and install it.
+
+```shell
+$ helm install terraform-controller terraform-controller-0.1.2.tgz
+NAME: terraform-controller
+LAST DEPLOYED: Mon Apr 26 15:55:35 2021
+NAMESPACE: default
+STATUS: deployed
+REVISION: 1
+TEST SUITE: None
+```
+
+For more detailed instruction, please refer to [Terraform controller getting started](https://github.com/oam-dev/terraform-controller/blob/master/getting-started.md).
+
+## Register ComponentDefinition and TraitDefinition
+
+### Register ComponentDefinition `alibaba-rds` as RDS cloud resource producer
+
+Register [alibaba-rds](https://github.com/oam-dev/kubevela/tree/master/docs/examples/terraform/cloud-resource-provision-and-consume/ComponentDefinition-alibaba-rds.yaml) Component type to KubeVela.
+
+```yaml
+apiVersion: core.oam.dev/v1alpha2
+kind: ComponentDefinition
+metadata:
+  name: alibaba-rds
+  annotations:
+    definition.oam.dev/description: Terraform configuration for Alibaba Cloud RDS object
+    type: terraform
+spec:
+  workload:
+    definition:
+      apiVersion: terraform.core.oam.dev/v1beta1
+      kind: Configuration
+  schematic:
+    terraform:
+      configuration: |
+        module "rds" {
+          source = "terraform-alicloud-modules/rds/alicloud"
+          engine = "MySQL"
+          engine_version = "8.0"
+          instance_type = "rds.mysql.c1.large"
+          instance_storage = "20"
+          instance_name = var.instance_name
+          account_name = var.account_name
+          password = var.password
+        }
+
+        output "DB_NAME" {
+          value = module.rds.this_db_instance_name
+        }
+        output "DB_USER" {
+          value = module.rds.this_db_database_account
+        }
+        output "DB_PORT" {
+          value = module.rds.this_db_instance_port
+        }
+        output "DB_HOST" {
+          value = module.rds.this_db_instance_connection_string
+        }
+        output "DB_PASSWORD" {
+          value = module.rds.this_db_instance_port
+        }
+
+        variable "instance_name" {
+          description = "RDS instance name"
+          type = string
+          default = "poc"
+        }
+
+        variable "account_name" {
+          description = "RDS instance user account name"
+          type = "string"
+          default = "oam"
+        }
+
+        variable "password" {
+          description = "RDS instance account password"
+          type = "string"
+          default = "Xyfff83jfewGGfaked"
+        }
+
+```
+
+### Register ComponentDefinition `alibaba-oss` as OSS cloud resource producer
+
+Register [alibaba-oss](https://github.com/oam-dev/kubevela/tree/master/docs/examples/terraform/cloud-resource-provision-and-consume/ComponentDefinition-alibaba-oss.yaml) Component type to KubeVela.
+
+
+```yaml
+apiVersion: core.oam.dev/v1alpha2
+kind: ComponentDefinition
+metadata:
+  name: alibaba-oss
+  annotations:
+    definition.oam.dev/description: Terraform configuration for Alibaba Cloud OSS object
+    type: terraform
+spec:
+  workload:
+    definition:
+      apiVersion: terraform.core.oam.dev/v1beta1
+      kind: Configuration
+  schematic:
+    terraform:
+      configuration: |
+        resource "alicloud_oss_bucket" "bucket-acl" {
+          bucket = var.bucket
+          acl = var.acl
+        }
+
+        output "BUCKET_NAME" {
+          value = "${alicloud_oss_bucket.bucket-acl.bucket}.${alicloud_oss_bucket.bucket-acl.extranet_endpoint}"
+        }
+
+        variable "bucket" {
+          description = "OSS bucket name"
+          default = "vela-website"
+          type = string
+        }
+
+        variable "acl" {
+          description = "OSS bucket ACL, supported 'private', 'public-read', 'public-read-write'"
+          default = "private"
+          type = string
+        }
+
+
+```
+
+### Prepare TraitDefinition `service-binding` to do env-secret mapping
+
+Apply [service-binding](https://github.com/oam-dev/kubevela/tree/master/docs/examples/terraform/cloud-resource-provision-and-consume/TraitDefinition-service-binding.yaml) to apply service binding trait.
+
+For more detailed introduction, please refer to [Crossplane](https://kubevela.io/docs/platform-engineers/cloud-services#prepare-traitdefinition-service-binding-to-do-env-secret-mapping).
+
+
+## Next
+Now You can refer to [Terraform for end users](../end-user/terraform.md) to provision and consume cloud resource by Terraform.
\ No newline at end of file

docs/examples/terraform/cloud-resource-provision-and-consume/ComponentDefinition-alibaba-oss.yaml

+apiVersion: core.oam.dev/v1alpha2
+kind: ComponentDefinition
+metadata:
+  name: alibaba-oss
+  annotations:
+    definition.oam.dev/description: Terraform configuration for Alibaba Cloud OSS object
+    type: terraform
+spec:
+  workload:
+    definition:
+      apiVersion: terraform.core.oam.dev/v1beta1
+      kind: Configuration
+  schematic:
+    terraform:
+      configuration: |
+        resource "alicloud_oss_bucket" "bucket-acl" {
+          bucket = var.bucket
+          acl = var.acl
+        }
+
+        output "BUCKET_NAME" {
+          value = "${alicloud_oss_bucket.bucket-acl.bucket}.${alicloud_oss_bucket.bucket-acl.extranet_endpoint}"
+        }
+
+        variable "bucket" {
+          description = "OSS bucket name"
+          default = "vela-website"
+          type = string
+        }
+
+        variable "acl" {
+          description = "OSS bucket ACL, supported 'private', 'public-read', 'public-read-write'"
+          default = "private"
+          type = string
+        }

docs/examples/terraform/cloud-resource-provision-and-consume/ComponentDefinition-alibaba-rds.yaml

+apiVersion: core.oam.dev/v1alpha2
+kind: ComponentDefinition
+metadata:
+  name: alibaba-rds
+  annotations:
+    definition.oam.dev/description: Terraform configuration for Alibaba Cloud RDS object
+    type: terraform
+spec:
+  workload:
+    definition:
+      apiVersion: terraform.core.oam.dev/v1beta1
+      kind: Configuration
+  schematic:
+    terraform:
+      configuration: |
+        module "rds" {
+          source = "terraform-alicloud-modules/rds/alicloud"
+          engine = "MySQL"
+          engine_version = "8.0"
+          instance_type = "rds.mysql.c1.large"
+          instance_storage = "20"
+          instance_name = var.instance_name
+          account_name = var.account_name
+          password = var.password
+        }
+
+        output "DB_NAME" {
+          value = module.rds.this_db_instance_name
+        }
+        output "DB_USER" {
+          value = module.rds.this_db_database_account
+        }
+        output "DB_PORT" {
+          value = module.rds.this_db_instance_port
+        }
+        output "DB_HOST" {
+          value = module.rds.this_db_instance_connection_string
+        }
+        output "DB_PASSWORD" {
+          value = module.rds.this_db_instance_port
+        }
+
+        variable "instance_name" {
+          description = "RDS instance name"
+          type = string
+          default = "poc"
+        }
+
+        variable "account_name" {
+          description = "RDS instance user account name"
+          type = "string"
+          default = "oam"
+        }
+
+        variable "password" {
+          description = "RDS instance account password"
+          type = "string"
+          default = "Xyfff83jfewGGfaked"
+        }

docs/examples/terraform/cloud-resource-provision-and-consume/TraitDefinition-service-binding.yaml

+apiVersion: core.oam.dev/v1beta1
+kind: TraitDefinition
+metadata:
+  annotations:
+    definition.oam.dev/description: "binding cloud resource secrets to pod env"
+  name: service-binding
+spec:
+  appliesToWorkloads:
+    - webservice
+    - worker
+  schematic:
+    cue:
+      template: |
+        patch: {
+        	spec: template: spec: {
+        		// +patchKey=name
+        		containers: [{
+        			name: context.name
+        			// +patchKey=name
+        			env: [
+        				for envName, v in parameter.envMappings {
+        					name: envName
+        					valueFrom: {
+        						secretKeyRef: {
+        							name: v.secret
+        							if v["key"] != _|_ {
+        								key: v.key
+        							}
+        							if v["key"] == _|_ {
+        								key: envName
+        							}
+        						}
+        					}
+        				},
+        			]
+        		}]
+        	}
+        }
+
+        parameter: {
+        	// +usage=The mapping of environment variables to secret
+        	envMappings: [string]: [string]: string
+        }
\ No newline at end of file

docs/examples/terraform/cloud-resource-provision-and-consume/application.yaml

+apiVersion: core.oam.dev/v1beta1
+kind: Application
+metadata:
+  name: webapp
+spec:
+  components:
+    - name: express-server
+      type: webservice
+      properties:
+        image: zzxwill/flask-web-application:v0.3.1-crossplane
+        ports: 80
+      traits:
+        - type: service-binding
+          properties:
+            envMappings:
+              # environments refer to db-conn secret
+              DB_PASSWORD:
+                secret: db-conn                                   # 1) If the env name is the same as the secret key, secret key can be omitted.
+              endpoint:
+                secret: db-conn
+                key: DB_HOST                                      # 2) If the env name is different from secret key, secret key has to be set.
+              username:
+                secret: db-conn
+                key: DB_USER
+              # environments refer to oss-conn secret
+              BUCKET_NAME:
+                secret: oss-conn
+
+    - name: sample-db
+      type: alibaba-rds
+      properties:
+        instance_name: sample-db
+        account_name: oamtest
+        password: U34rfwefwefffaked
+        writeConnectionSecretToRef:
+          name: db-conn
+
+    - name: sample-oss
+      type: alibaba-oss
+      properties:
+        bucket: vela-website
+        acl: private
+        writeConnectionSecretToRef:
+          name: oss-conn

docs/sidebars.js

@@ -36,6 +36,7 @@ module.exports = {
             'end-user/labels',
             'end-user/sidecar',
             'end-user/cloud-resources',
+            'end-user/terraform',
             'end-user/volumes',
             'end-user/monitoring',
             'end-user/health',
@@ -79,7 +80,8 @@ module.exports = {
               type: 'category',
               label: 'Defining Cloud Service',
               items: [
-                'platform-engineers/cloud-services'
+                'platform-engineers/cloud-services',
+                'platform-engineers/terraform',
               ]
             },
           ]

go.mod

@@ -22,7 +22,6 @@ require (
 	github.com/gin-contrib/static v0.0.0-20200815103939-31fb0c56a3d1
 	github.com/gin-gonic/gin v1.6.3
 	github.com/go-logr/logr v0.4.0
-	github.com/go-logr/zapr v0.4.0 // indirect
 	github.com/go-openapi/jsonreference v0.19.5 // indirect
 	github.com/go-openapi/spec v0.19.8 // indirect
 	github.com/go-openapi/swag v0.19.11 // indirect
@@ -30,12 +29,15 @@ require (
 	github.com/google/go-cmp v0.5.2
 	github.com/google/go-github/v32 v32.1.0
 	github.com/gosuri/uitable v0.0.4
+	github.com/hashicorp/hcl/v2 v2.9.1
 	github.com/hinshun/vt10x v0.0.0-20180616224451-1954e6464174
 	github.com/klauspost/compress v1.10.5 // indirect
 	github.com/kyokomi/emoji v2.2.4+incompatible
 	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mholt/archiver/v3 v3.3.0
 	github.com/mitchellh/hashstructure/v2 v2.0.1
+	github.com/oam-dev/terraform-config-inspect v0.0.0-20210418082552-fc72d929aa28
+	github.com/oam-dev/terraform-controller v0.1.4
 	github.com/olekukonko/tablewriter v0.0.2
 	github.com/onsi/ginkgo v1.13.0
 	github.com/onsi/gomega v1.10.3

legacy/charts/vela-core-legacy/crds/core.oam.dev_applicationrevisions.yaml

@@ -667,6 +667,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -925,6 +941,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for trait
@@ -1121,6 +1153,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -1819,6 +1867,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload
@@ -2078,6 +2142,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for trait
@@ -2274,6 +2354,22 @@ spec:
                               required:
                               - template
                               type: object
+                            terraform:
+                              description: Terraform is the struct to describe cloud resources managed by Hashicorp Terraform
+                              properties:
+                                configuration:
+                                  description: Configuration is Terraform Configuration
+                                  type: string
+                                type:
+                                  default: hcl
+                                  description: Type specifies which Terraform configuration it is, HCL or JSON syntax
+                                  enum:
+                                  - hcl
+                                  - json
+                                  type: string
+                              required:
+                              - configuration
+                              type: object
                           type: object
                         status:
                           description: Status defines the custom health policy and status message for workload