使用Terraform管理SAE命名空间_Serverless 应用引擎(SAE)-阿里云帮助中心

Serverless 应用引擎 SAE（Serverless App Engine）的命名空间可以将您的应用从逻辑上进行划分，例如测试环境、开发环境、预发环境和线上环境等。本文介绍如何通过Terraform创建、更新和删除SAE命名空间。

说明

本教程所含示例代码支持一键运行，您可以直接运行代码。一键运行

前提条件

由于阿里云账号（主账号）具有资源的所有权限，一旦发生泄露将面临重大风险。建议您使用RAM用户，并为该RAM用户创建AccessKey，具体操作方式请参见创建RAM用户和创建AccessKey。

为运行Terraform命令的RAM用户绑定以下最小权限策略，以获取管理本示例所涉及资源的权限。更多信息，请参见为RAM用户授权。

该权限策略允许用户管理SAE命名空间，包括创建、删除、更新、查看和列出命名空间。

{
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "sae:CreateNamespace",
                "sae:DeleteNamespace",
                "sae:UpdateNamespace",
                "sae:GetNamespace",
                "sae:ListNamespaces"
            ],
            "Resource": "*"
        }
    ]
}

准备Terraform运行环境，您可以选择以下任一方式来使用Terraform。
- ROS提供了Terraform托管服务，因此您可以直接在ROS控制台部署Terraform模板。详细操作，请参见创建Terraform类型资源栈。
- 在Terraform Explorer中使用Terraform：阿里云提供了Terraform的在线运行环境，您无需安装Terraform，登录后即可在线使用和体验Terraform。适用于零成本、快速、便捷地体验和调试Terraform的场景。
- Cloud Shell：阿里云Cloud Shell中预装了Terraform的组件，并已配置好身份凭证，您可直接在Cloud Shell中运行Terraform的命令。适用于低成本、快速、便捷地访问和使用Terraform的场景。
- 在本地安装和配置Terraform：适用于网络连接较差或需要自定义开发环境的场景。

使用的资源

alicloud_sae_namespace：用于创建和管理阿里云SAE的命名空间。

创建命名空间

本示例以在华东1（杭州）地域下创建命名空间为例，命名空间名称为admin、命名空间ID为cn-hangzhou:admin。

创建一个用于存放Terraform资源的项目文件夹，命名为terraform。
执行以下命令，进入项目目录。
```
cd terraform
```

执行以下命令，创建名为main.tf的配置文件。

provider "alicloud" {
  region = var.region_id
}

# 定义区域变量，默认值为 cn-hangzhou
variable "region_id" {
  type    = string
  default = "cn-hangzhou"
}

# 定义命名空间描述变量，默认值为 "a namespace sample"
variable "namespace_description" {
  description = "Namespace Description"
  default     = "a namespace sample"
}

# 定义命名空间名称变量，默认值为 "admin"
variable "namespace_name" {
  description = "Namespace Name"
  type        = string
  default     = "admin"
}

# 定义命名空间ID变量，默认值为 "cn-hangzhou:admin"
variable "namespace_id" {
  description = "Namespace ID"
  type        = string
  default     = "cn-hangzhou:admin"
}

resource "alicloud_sae_namespace" "default" {
  namespace_description = var.namespace_description
  namespace_id          = var.namespace_id
  namespace_name        = var.namespace_name
}

output "namespace_id" {
  value       = alicloud_sae_namespace.default.namespace_id
  description = "The ID of the created namespace."
}

执行以下命令，初始化Terraform运行环境。
```
terraform init
```

预期输出：

Initializing the backend...

Initializing provider plugins...
- Checking for available provider plugins...
- Downloading plugin for provider "alicloud" (hashicorp/alicloud) 1.233.0...

The following providers do not have any version constraints in configuration,
so the latest version was installed.

To prevent automatic upgrades to new major versions that may contain breaking
changes, it is recommended to add version = "..." constraints to the
corresponding provider blocks in configuration, with the constraint strings
suggested below.

* provider.alicloud: version = "~> 1.233"


Warning: registry.terraform.io: For users on Terraform 0.13 or greater, this provider has moved to aliyun/alicloud. Please update your source in required_providers.


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.

依次执行以下命令，创建SAE命名空间。
1. 执行以下命令，执行配置文件。在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示授权完成。
```
terraform apply
```
  预期输出：
```
Apply complete! Resources: 1 added, 0 changed, 1 destroyed.

Outputs:

namespace_id = cn-hangzhou:admin
```
命名空间已成功创建。
验证结果

执行terraform show命令

您可以使用以下命令查询Terraform已创建的资源详细信息：

terraform show

Serverless应用引擎SAE控制台

登录Serverless应用引擎SAE控制台，查看创建命名空间。

更新命名空间

本示例以更新命名空间名称为例，将华东1（杭州）地域下命名空间的名称从admin更新为prod。

打开 main.tf 文件，将 namespace_name 变量的默认值从 "admin" 修改为 "prod"。

provider "alicloud" {
  region = var.region_id
}

# 定义区域变量，默认值为 cn-hangzhou
variable "region_id" {
  type    = string
  default = "cn-hangzhou"
}

# 定义命名空间描述变量，默认值为 "a namespace sample"
variable "namespace_description" {
  description = "Namespace Description"
  default     = "a namespace sample"
}

# 修改定义命名空间名称变量为 "prod"
variable "namespace_name" {
  description = "Namespace Name"
  type        = string
  default     = "prod"
}

# 定义命名空间ID变量，默认值为 "cn-hangzhou:dev"
variable "namespace_id" {
  description = "Namespace ID"
  type        = string
  default     = "cn-hangzhou:admin"
}

resource "alicloud_sae_namespace" "default" {
  namespace_description = var.namespace_description
  namespace_id          = var.namespace_id
  namespace_name        = var.namespace_name
}

output "namespace_id" {
  value       = alicloud_sae_namespace.default.namespace_id
  description = "The ID of the created namespace."
}

执行如下命令，初始化Terraform运行环境。

terraform init

返回信息如下，Terraform初始化成功。

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.

继续运行以下命令来应用更改，在执行过程中，根据提示输入 yes 并按下 Enter 键，等待命令执行完成。

terraform apply

预期输出：

alicloud_sae_namespace.default: Modifying... [id=cn-hangzhou:admin]
alicloud_sae_namespace.default: Modifications complete after 1s [id=cn-hangzhou:admin]

Apply complete! Resources: 0 added, 1 changed, 0 destroyed.

Outputs:

namespace_id = "cn-hangzhou:admin"

命名空间名称已成功更新为prod。

执行terraform show命令

您可以使用以下命令查询Terraform已创建的资源详细信息：

terraform show

Serverless应用引擎SAE控制台

登录Serverless应用引擎SAE控制台，查看修改后的命名空间。

删除命名空间

本示例以在华东1（杭州）地域下删除命名空间为例，命名空间名称为prod、命名空间ID为cn-hangzhou:admin。

在目标项目目录内执行以下命令，运行配置文件。关于terraform destroy的更多信息，请参见Terraform常用命令。

terraform destroy

预期输出：

alicloud_sae_namespace.default: Refreshing state... [id=cn-hangzhou:admin]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  - destroy

Terraform will perform the following actions:

  # alicloud_sae_namespace.default will be destroyed
  - resource "alicloud_sae_namespace" "default" {
      - enable_micro_registration = true -> null
      - id                        = "cn-hangzhou:admin" -> null
      - namespace_description     = "a namespace sample" -> null
      - namespace_id              = "cn-hangzhou:admin" -> null
      - namespace_name            = "prod" -> null
      - namespace_short_id        = "admin" -> null
    }

Plan: 0 to add, 0 to change, 1 to destroy.

Changes to Outputs:
  - namespace_id = "cn-hangzhou:admin" -> null

Do you really want to destroy all resources?
  Terraform will destroy all your managed infrastructure, as shown above.
  There is no undo. Only 'yes' will be accepted to confirm.

  Enter a value: yes

alicloud_sae_namespace.default: Destroying... [id=cn-hangzhou:admin]
alicloud_sae_namespace.default: Destruction complete after 1s

Destroy complete! Resources: 1 destroyed.

命名空间已成功删除。

完整示例

说明

当前示例代码支持一键运行，您可以直接运行代码。一键运行

provider "alicloud" {
  region = var.region_id
}

# 定义区域变量，默认值为 cn-hangzhou
variable "region_id" {
  type    = string
  default = "cn-hangzhou"
}

# 定义命名空间描述变量，默认值为 "a namespace sample"
variable "namespace_description" {
  description = "Namespace Description"
  default     = "a namespace sample"
}

# 定义命名空间名称变量，默认值为 "admin"
variable "namespace_name" {
  description = "Namespace Name"
  type        = string
  default     = "admin"
}

# 定义命名空间ID变量，默认值为 "cn-hangzhou:admin"
variable "namespace_id" {
  description = "Namespace ID"
  type        = string
  default     = "cn-hangzhou:admin"
}

resource "alicloud_sae_namespace" "default" {
  namespace_description = var.namespace_description
  namespace_id          = var.namespace_id
  namespace_name        = var.namespace_name
}

output "namespace_id" {
  value       = alicloud_sae_namespace.default.namespace_id
  description = "The ID of the created namespace."
}

前提条件

使用的资源

创建命名空间

执行terraform show命令

Serverless应用引擎SAE控制台

更新命名空间

执行terraform show命令

Serverless应用引擎SAE控制台

删除命名空间

完整示例

相关文档