Serverless App Engine:Use Terraform to manage SAE applications

• alicloud_sae_application: Manages and creates Serverless App Engine (SAE) applications.

• alicloud_vpc: Configures your VPC, including subnets, route tables, and security settings.

• alicloud_vswitch: Creates subnets within a VPC. Each subnet can have its own IP address range and route table. You can use vSwitches to deploy different applications and services in different subnets.

• alicloud_security_group: Manages network access control within a VPC.

Custom configuration: Image deployment

This example shows how to deploy an application from an image with custom configurations in the China (Shenzhen) region.

1. Create a project folder named terraform for storing Terraform resources.
2. Run the following command to go to the project directory:

   cd terraform

3. Create a configuration file named main.tf and add the following content.

   provider "alicloud" {
     region = var.region_id
   }
   # Region ID
   variable "region_id" {
     type    = string
     default = "cn-shenzhen"
   }
   # Application name
   variable "app_name" {
     description = "The name of the application"
     type        = string
     default     = "manual-jar-tf"
   }
   # Application description
   variable "app_description" {
     default     = "description created by Terraform"
     description = "The description of the application"
     type        = string
   }
   # Application deployment method
   variable "package_type" {
     default     = "FatJar"
     description = "The package type of the application"
     type        = string
   }
   # Instance CPU specification
   variable "cpu" {
     default     = "500"
     description = "The cpu of the application, in unit of millicore"
     type        = string
   }
   # Instance memory specification
   variable "memory" {
     default     = "1024"
     description = "The memory of the application, in unit of MB"
     type        = string
   }
   # JAR package URL
   variable "jar_url" {
     description = "The JAR url of the application, like `oss://my-bucket/my-app.jar`"
     type        = string
     default     = "https://edas-sz.oss-cn-shenzhen.aliyuncs.com/prod/demo/SPRING_CLOUD_CONSUMER.jar"
   }
   # Number of application instances
   variable "replicas" {
     default     = "1"
     description = "The replicas of the application"
     type        = string
   }
   # Namespace name
   variable "namespace_name" {
     description = "Namespace Name"
     type        = string
     default     = "tfjardemo"
   }
   # Namespace ID
   variable "namespace_id" {
     description = "Namespace ID"
     type        = string
     default     = "cn-shenzhen:tfjardemo"  # Reference an existing namespace ID
   }
   # Namespace description
   variable "namespace_description" {
     description = "Namespace Description"
     default     = "a namespace"
   }
   # VPC and security group
   variable "name" {
     default     = "tf"
     description = "The name of the security group rule"
     type        = string
   }
   variable "description" {
     default     = "The description of the security group rule"
     description = "The description of the security group rule"
     type        = string
   }
   # Port range
   variable "port_range" {
     default     = "1/65535"
     description = "The port range of the security group rule"
     type        = string
   }
   # CIDR block
   variable "cidr_ip" {
     description = "cidr blocks used to create a new security group rule"
     type        = string
     default     = "0.0.0.0/0"
   }
   # Availability zone in the region
   variable "zone_id" {
     description = "Availability Zone ID"
     type        = string
     default     = "cn-shenzhen-e"  # Select an availability zone with sufficient resources
   }
   # Collect application logs to SLS
   variable "slsConfig" {
     default     = "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/home/admin/logs/*.log\"}]"
     description = "The config of sls log collect"
     type        = string
   }
   resource "alicloud_vpc" "vpc" {
     vpc_name   = "tf-vpc"
     cidr_block = "172.16.0.0/16"
   }
   resource "alicloud_vswitch" "vswitch" {
     vpc_id       = alicloud_vpc.vpc.id
     cidr_block   = "172.16.1.0/24"
     zone_id      = var.zone_id
     vswitch_name = "tf-vswitch"
     description  = "tf-vswitch description"
   }
   resource "alicloud_sae_namespace" "default" {
     namespace_id          = var.namespace_id
     namespace_name        = var.namespace_name
     namespace_description = var.namespace_description
   }
   output "namespace_id" {
     value       = var.namespace_id
     description = "Namespace ID"
   }
   resource "alicloud_security_group" "sg" {
     name        = var.name
     description = var.description
     vpc_id      = alicloud_vpc.vpc.id
   }
   resource "alicloud_security_group_rule" "sg_rule" {
     type              = "ingress"
     ip_protocol       = "tcp"
     nic_type          = "intranet"
     policy            = "accept"
     port_range        = var.port_range
     priority          = 1
     security_group_id = alicloud_security_group.sg.id
     cidr_ip           = var.cidr_ip
   }
   resource "alicloud_sae_application" "manual" {
     app_name           = var.app_name
     app_description    = var.app_description
     deploy             = true
     package_url        = var.jar_url
     namespace_id       = alicloud_sae_namespace.default.id
     vswitch_id         = alicloud_vswitch.vswitch.id
     vpc_id             = alicloud_vpc.vpc.id
     security_group_id  = alicloud_security_group.sg.id
     package_type       = var.package_type
     jdk                = "Open JDK 8"
     timezone           = "Asia/Beijing"
     replicas           = var.replicas
     cpu                = var.cpu
     memory             = var.memory
     micro_registration = "0"
     lifecycle {
       ignore_changes = [
         micro_registration
       ]
     }
   }
   output "app_id" {
     description = "The id of the application"
     value       = alicloud_sae_application.manual.id
   }
   output "app_name" {
     description = "The name of the application"
     value       = var.app_name
   }

4. Run the following command to initialize the configurations:

   terraform init

5. Expected output:

   Terraform has been successfully initialized!
   You may now begin working with Terraform. Try running "terraform plan" to see
   any changes that are required for your infrastructure. All Terraform commands
   should now work.
   If you ever set or change modules or backend configuration for Terraform,
   rerun this command to reinitialize your working directory. If you forget, other
   commands will detect it and remind you to do so if necessary.

6. Run the following commands in sequence to create an application by using an image. During the execution, enter yes and press the Enter key when prompted. Wait for the command to complete. If the following information appears, the authorization is complete.

terraform apply

6. Expected output:

Apply complete! Resources: 6 added, 0 changed, 0 destroyed.
Outputs:
app_id = "72c052ba-xxx"
app_name = "manual-image-tf"
namespace_id = "cn-shenzhen:tfdemo"

terraform show

shell@Alicloud: ~/serverless$ terraform show
# alicloud_sae_application.manual:
resource "alicloud_sae_application" "manual" {
    app_description              = "description created by Terraform"
    app_name                     = "manual-image-tf"
    batch_wait_time              = 10
    command_args_v2              = []
    config_map_mount_desc        = jsonencode([])
    cpu                          = 500
    custom_host_alias            = jsonencode([])
    deploy                       = true
    enable_ahas                  = "false"
    enable_grey_tag_route        = false
    envs                         = jsonencode([])
    id                           = "72c05xxx"
    image_url                    = "registry.cn-beijing.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0"
    memory                       = 1024
    min_ready_instance_ratio     = -1
    min_ready_instances          = -1
    namespace_id                 = "cn-shenzhen:tfdemo"
    package_type                 = "Image"
    package_version              = "1732169733"
    replicas                     = 1
    security_group_id            = "sg-wz96xxx"
    status                       = "RUNNING"
    termination_grace_period_seconds = 30
    timezone                     = "Asia/Beijing"
    vpc_id                       = "vpc-xxx"
    vswitch_id                   = "vsw-xxx"
}
# alicloud_sae_namespace.default:
resource "alicloud_sae_namespace" "default" {
    enable_micro_registration = true
    id                        = "cn-shenzhen:tfdemo"
    namespace_description     = "a namespace"
    namespace_id              = "cn-shenzhen:tfdemo"
    namespace_name            = "tfdemo"
    namespace_short_id        = "tfdemo"
}

Custom configuration: JAR package deployment

This example shows how to deploy an application from a JAR package with custom configurations in the China (Shenzhen) region.

1. Create a project folder named terraform for storing Terraform resources.
2. Run the following command to go to the project directory:

   cd terraform

3. Create a configuration file named main.tf and add the following content.

   provider "alicloud" {
     region = var.region_id
   }
   # Region ID
   variable "region_id" {
     type    = string
     default = "cn-shenzhen"
   }
   # Application name
   variable "app_name" {
     description = "The name of the application"
     type        = string
     default     = "manual-jar-tf"
   }
   # Application description
   variable "app_description" {
     default     = "description created by Terraform"
     description = "The description of the application"
     type        = string
   }
   # Application deployment method
   variable "package_type" {
     default     = "FatJar"
     description = "The package type of the application"
     type        = string
   }
   # Instance CPU specification
   variable "cpu" {
     default     = "500"
     description = "The cpu of the application, in unit of millicore"
     type        = string
   }
   # Instance memory specification
   variable "memory" {
     default     = "1024"
     description = "The memory of the application, in unit of MB"
     type        = string
   }
   # JAR package URL
   variable "jar_url" {
     description = "The JAR url of the application, like `oss://my-bucket/my-app.jar`"
     type        = string
     default     = "https://edas-sz.oss-cn-shenzhen.aliyuncs.com/prod/demo/SPRING_CLOUD_CONSUMER.jar"
   }
   # Number of application instances
   variable "replicas" {
     default     = "1"
     description = "The replicas of the application"
     type        = string
   }
   # Namespace name
   variable "namespace_name" {
     description = "Namespace Name"
     type        = string
     default     = "tfjardemo"
   }
   # Namespace ID
   variable "namespace_id" {
     description = "Namespace ID"
     type        = string
     default     = "cn-shenzhen:tfjardemo"  # Reference an existing namespace ID
   }
   # Namespace description
   variable "namespace_description" {
     description = "Namespace Description"
     default     = "a namespace"
   }
   # VPC and security group
   variable "name" {
     default     = "tf"
     description = "The name of the security group rule"
     type        = string
   }
   variable "description" {
     default     = "The description of the security group rule"
     description = "The description of the security group rule"
     type        = string
   }
   # Port range
   variable "port_range" {
     default     = "1/65535"
     description = "The port range of the security group rule"
     type        = string
   }
   # CIDR block
   variable "cidr_ip" {
     description = "cidr blocks used to create a new security group rule"
     type        = string
     default     = "0.0.0.0/0"
   }
   # Availability zone in the region
   variable "zone_id" {
     description = "Availability Zone ID"
     type        = string
     default     = "cn-shenzhen-e"  # Select an availability zone with sufficient resources
   }
   # Collect application logs to SLS
   variable "slsConfig" {
     default     = "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/home/admin/logs/*.log\"}]"
     description = "The config of sls log collect"
     type        = string
   }
   resource "alicloud_vpc" "vpc" {
     vpc_name   = "tf-vpc"
     cidr_block = "172.16.0.0/16"
   }
   resource "alicloud_vswitch" "vswitch" {
     vpc_id       = alicloud_vpc.vpc.id
     cidr_block   = "172.16.1.0/24"
     zone_id      = var.zone_id
     vswitch_name = "tf-vswitch"
     description  = "tf-vswitch description"
   }
   resource "alicloud_sae_namespace" "default" {
     namespace_id          = var.namespace_id
     namespace_name        = var.namespace_name
     namespace_description = var.namespace_description
   }
   output "namespace_id" {
     value       = var.namespace_id
     description = "Namespace ID"
   }
   resource "alicloud_security_group" "sg" {
     name        = var.name
     description = var.description
     vpc_id      = alicloud_vpc.vpc.id
   }
   resource "alicloud_security_group_rule" "sg_rule" {
     type              = "ingress"
     ip_protocol       = "tcp"
     nic_type          = "intranet"
     policy            = "accept"
     port_range        = var.port_range
     priority          = 1
     security_group_id = alicloud_security_group.sg.id
     cidr_ip           = var.cidr_ip
   }
   resource "alicloud_sae_application" "manual" {
     app_name           = var.app_name
     app_description    = var.app_description
     deploy             = true
     package_url        = var.jar_url
     namespace_id       = alicloud_sae_namespace.default.id
     vswitch_id         = alicloud_vswitch.vswitch.id
     vpc_id             = alicloud_vpc.vpc.id
     security_group_id  = alicloud_security_group.sg.id
     package_type       = var.package_type
     jdk                = "Open JDK 8"
     timezone           = "Asia/Beijing"
     replicas           = var.replicas
     cpu                = var.cpu
     memory             = var.memory
     micro_registration = "0"
     lifecycle {
       ignore_changes = [
         micro_registration
       ]
     }
   }
   output "app_id" {
     description = "The id of the application"
     value       = alicloud_sae_application.manual.id
   }
   output "app_name" {
     description = "The name of the application"
     value       = var.app_name
   }

4. Run the following command to initialize the configuration.

   terraform init

5. Run the following commands to create an application from a JAR package.

   1. Run the following command to deploy the application.When prompted, enter yes and press Enter. The authorization is complete if the following message is displayed after the command finishes running.

      terraform apply

      Expected output:

      Apply complete! Resources: 6 added, 0 changed, 4 destroyed.
      Outputs:
      app_id = "aad70a1a-xxx"
      app_name = "manual-jar-tf"
      namespace_id = "cn-shenzhen:tfjardemo"

   If the output is as expected, the application is successfully deployed from the JAR package.

6. Verify the result:

terraform show

shell1@Alicloud:~/serverless$ terraform show
# alicloud_sae_application.manual:
resource "alicloud_sae_application" "manual" {
    app_description             = "description created by Terraform"
    app_name                    = "manual-jar-tf"
    batch_wait_time             = 10
    command_args_v2             = []
    config_map_mount_desc       = jsonencode([])
    cpu                         = 500
    custom_host_alias           = jsonencode([])
    deploy                      = true
    enable_ahas                 = "false"
    enable_grey_tag_route       = false
    envs                        = jsonencode([])
    id                          = "6acbf6fc-6b1xxx"
    jdk                         = "Open JDK 8"
    memory                      = 1024
    micro_registration          = "0"
    min_ready_instance_ratio    = -1
    min_ready_instances         = -1
    namespace_id                = "cn-shenzhen:tfjardemo"
    package_type                = "FatJar"
    package_url                 = "https://edas-sz.oss-cn-shenzhen.aliyuncs.com/prod/demo/SPRING_CLOUD_CONSUMER.jar"
    package_version             = "1732241446"
}
    programming_language        = "java"
    replicas                    = 1
    security_group_id           = "sg-wz9j10xxx"
    status                      = "RUNNING"
    termination_grace_period_seconds = 30
    timezone                    = "Asia/Beijing"
    vpc_id                      = "vpc-wz9sjxxx"
    vswitch_id                  = "vsw-wz9e1xxx"
}