Terraform Explorer 介紹
概覽
Terraform Explorer 是阿里云基于 Terraform 開源版提供的一款在線調(diào)試 Terraform 配置文件的工具，旨在簡化開發(fā)者編寫 Terraform 配置文件和操作 Terraform 的流程，幫助開發(fā)者降低使用 Terraform 的門檻。借助 Terraform Explorer 開發(fā)者可以以表單填寫的方式實(shí)現(xiàn) Terraform 配置文件的自動(dòng)生成和轉(zhuǎn)換，并通過簡單的按鈕操作來實(shí)現(xiàn) Terraform 的在線運(yùn)行。
功能特性
Terraform 配置文件
Terraform 配置文件用于以代碼化的方式定義基礎(chǔ)設(shè)施資源。編寫 Terraform 配置文件是IaC 工作流程的第一步，在配置文件定義所需的阿里云資源（例如：ECS實(shí)例、RDS數(shù)據(jù)庫實(shí)例）、資源間的依賴關(guān)系等之后，Terraform 將自動(dòng)根據(jù)文件內(nèi)容完成所定義資源的創(chuàng)建和配置，實(shí)現(xiàn)自動(dòng)化部署及運(yùn)維。Terraform Explorer 即支持配置文件的自動(dòng)生成，也支持開發(fā)者在線編輯配置文件模板。
功能集 | 功能點(diǎn) | 功能描述 |
編寫配置文件 | 自動(dòng)生成配置文件 | 開發(fā)者選擇云產(chǎn)品以及相關(guān)的資源類型后，點(diǎn)擊“發(fā)起調(diào)試”按鈕，Terraform Explorer 將會(huì)自動(dòng)生成一個(gè)所選資源類型的配置文件，此時(shí)您可以通過左側(cè)的表單填寫部分或者全部參數(shù)來不斷完善配置文件。 |
在線編輯配置文件 | Terraform Explorer 為每個(gè)資源類型增加了一個(gè)或者多個(gè)示例模板，如果您不想填寫太多的參數(shù)或者想要?jiǎng)?chuàng)建多個(gè)資源時(shí)，可以在選擇資源類型之后，選擇具體某個(gè)示例模板，點(diǎn)擊“發(fā)起調(diào)試”按鈕，即可看到模板詳情并發(fā)起調(diào)試。 如果示例模板的內(nèi)容無法滿足您的需求，可以點(diǎn)擊打開模板右上角的“編輯模式”，在現(xiàn)有的模板中在線增加或者修改內(nèi)容，保存后繼續(xù)發(fā)起調(diào)試。 |
Terraform 在線執(zhí)行
初始化、預(yù)覽和執(zhí)行是配置文件編寫完成后 Terraform 的工作流節(jié)點(diǎn)，Terraform Explorer 以調(diào)試任務(wù)為載體，通過對(duì)任務(wù)的執(zhí)行來實(shí)現(xiàn) Terraform 工作流節(jié)點(diǎn)。每一次調(diào)試任務(wù)的執(zhí)行都會(huì)依次完成初始化、預(yù)覽和執(zhí)行三個(gè)動(dòng)作。
功能集 | 功能點(diǎn) | 功能描述 |
執(zhí)行配置文件 | 在線初始化 | 初始化動(dòng)作是預(yù)覽和執(zhí)行的第一步，因此在 Terraform Explorer 中作為預(yù)覽和執(zhí)行的一部分進(jìn)行運(yùn)行。 |
在線預(yù)覽 | 點(diǎn)擊“預(yù)覽”按鈕，Terraform Explorer 將創(chuàng)建一個(gè)新的調(diào)試任務(wù)或者在已有的調(diào)試任務(wù)中依次執(zhí)行 | |
在線執(zhí)行 | 當(dāng)執(zhí)行計(jì)劃符合您的預(yù)期后，您可以點(diǎn)擊“執(zhí)行”按鈕來運(yùn)行執(zhí)行計(jì)劃。Terraform Explorer 將根據(jù)您的選擇執(zhí)行 當(dāng)點(diǎn)擊“預(yù)覽并執(zhí)行”按鈕時(shí)，意味著生成執(zhí)行計(jì)劃后將跳過人工確認(rèn)而自動(dòng)執(zhí)行，即 Terraform Explorer 將依次執(zhí)行 | |
資源銷毀 | 當(dāng)您調(diào)試完成想要銷毀資源時(shí)，點(diǎn)擊“銷毀資源”按鈕，Terraform Explorer 將通過 |
產(chǎn)品優(yōu)勢(shì)
Terraform Explorer 支持對(duì) Terraform 開源版的主要功能的在線管理，具備環(huán)境免安裝、代碼免編寫、狀態(tài)免管理等優(yōu)勢(shì)。
環(huán)境免安裝
Terraform Explorer 支持了對(duì) Terraform 客戶端的在線托管，并且在執(zhí)行 Terraform 命令時(shí)支持對(duì)阿里云 Provider 的加速下載，您無需再關(guān)心 Terraform 的安裝、配置以及 Provider 下載慢等環(huán)境問題
代碼免編寫
Terraform Explorer 針對(duì)單資源提供了通過表單自動(dòng)生成模板配置文件的能力，您無需再擔(dān)心 Terraform 代碼不會(huì)寫、編寫麻煩等問題；同時(shí)，為每個(gè)資源類型配備了相關(guān)的示例模板，可以通過選擇模板來實(shí)現(xiàn)一鍵運(yùn)行。
除此之外，Terraform Explorer 默認(rèn)會(huì)幫您保存每一次的 Terraform 的執(zhí)行使用到的模板和參數(shù)，當(dāng)您發(fā)起新的調(diào)試任務(wù)時(shí)，可以選擇從歷史模板和參數(shù)中加載內(nèi)容。
狀態(tài)免管理
狀態(tài)管理是 Terraform 重要組成部分，分為本地狀態(tài)（local）和遠(yuǎn)端狀態(tài)（remote）兩種。Terraform Explorer 同樣支持對(duì)這兩種狀態(tài)的管理，默認(rèn)采用本地狀態(tài)管理，但是會(huì)幫您托管每一次 Terraform 的運(yùn)行狀態(tài)，以確保同一份配置文件的反復(fù)多次運(yùn)行，在保證狀態(tài)安全的前提下，保留了 Terraform 原生的狀態(tài)管理機(jī)制。
基本概念
概念 | 說明 |
版本 | 阿里云 Terraform Provider 的版本，目前支持的最低版本是 1.202.0 |
產(chǎn)品 | 每個(gè) Provider 版本所支持的云產(chǎn)品列表，支持按關(guān)鍵字模糊搜索 |
資源類型 | 每個(gè) Provider 版本中選定的云產(chǎn)品所支持的資源類型，支持按關(guān)鍵字模糊搜素 |
模板 | Terraform 配置文件，是一個(gè) HCL 格式的文本文件，使用UTF-8編碼。您可以通過填寫表單參數(shù)自動(dòng)生成或者引用某個(gè)資源類型下的示例模板。 |
模板版本 | 每次調(diào)試任務(wù)執(zhí)行的時(shí)候，都會(huì)將使用到的模板保存在一個(gè)模板版本，您可以查看不同的模板版本詳情。 |
任務(wù) | 每當(dāng)通過“發(fā)起調(diào)試”按鈕發(fā)起一次新的調(diào)試動(dòng)作時(shí)，Terraform Explorer 將會(huì)創(chuàng)建一個(gè)新的調(diào)試任務(wù)。每個(gè)任務(wù)對(duì)應(yīng)唯一的一個(gè)狀態(tài)文件，因此同一時(shí)間只能執(zhí)行一次預(yù)覽或者執(zhí)行操作。 |
調(diào)試記錄 | 每個(gè)任務(wù)每次的運(yùn)行（預(yù)覽或者預(yù)覽并執(zhí)行）都會(huì)生成一次調(diào)試記錄，新的調(diào)試記錄都是在上一次調(diào)試記錄的基礎(chǔ)上生成執(zhí)行計(jì)劃并執(zhí)行。 |
調(diào)試歷史 | 每個(gè)資源類型的所有調(diào)試任務(wù)都會(huì)被記錄在調(diào)試歷史中，您可以選擇歷史任務(wù)并在最新的調(diào)試記錄的基礎(chǔ)上繼續(xù)調(diào)試。 |
訪問控制
在訪問 Terraform Explorer 時(shí)，部分功能需要先完成授權(quán)，比如創(chuàng)建調(diào)試任務(wù)、預(yù)覽、預(yù)覽并執(zhí)行、銷毀資源、查看調(diào)試歷史、查看資源詳情等。Terraform Explorer 所使用到的需要鑒權(quán)的 API 和功能如下表所示：
API 名稱 | API 描述 | 涉及功能點(diǎn)（按鈕） |
CreateExplorerModule | 保存模板內(nèi)容 | 預(yù)覽，預(yù)覽并執(zhí)行 |
GetExplorerModule | 獲取模板內(nèi)容詳情 | 查看模板 |
CreateExplorerModuleVersion | 每次繼續(xù)調(diào)試模板內(nèi)容都將被保存為一個(gè)新的版本 | 預(yù)覽，預(yù)覽并執(zhí)行，繼續(xù)調(diào)試 |
CreateExplorerTask | 創(chuàng)建調(diào)試任務(wù) | 預(yù)覽，預(yù)覽并執(zhí)行 |
GetExplorerTask | 獲取調(diào)試任務(wù)詳情 | 調(diào)試結(jié)果 |
UpdateExplorerTaskAttribute | 更新調(diào)試任務(wù) | 銷毀資源 |
CreateJob | 創(chuàng)建作業(yè)，運(yùn)行調(diào)試任務(wù) | 預(yù)覽，預(yù)覽并執(zhí)行，銷毀資源 |
GetJob | 獲取調(diào)試任務(wù)運(yùn)行詳情 | 調(diào)試結(jié)果 |
OperateJob | 操作作業(yè)，預(yù)覽完成后執(zhí)行調(diào)試任務(wù) | 預(yù)覽并執(zhí)行，執(zhí)行，銷毀資源 |
ListJobs | 獲取作業(yè)列表，即調(diào)試任務(wù)的執(zhí)行記錄 | 調(diào)試記錄 |
CreateExplorerHistory | 記錄每一次的調(diào)試任務(wù) | 調(diào)試歷史 |
ListExplorerHistory | 獲取調(diào)試歷史詳情和歷史參數(shù) | 調(diào)試歷史，使用歷史參數(shù) |
ListResources | 獲取創(chuàng)建成功的資源列表和詳情 | 資源詳情 |
在使用 Terraform Explorer 前，您可以通過如上的 API 實(shí)現(xiàn)精細(xì)化權(quán)限控制，也可以通過如下的權(quán)限策略完成快速授權(quán)：
{
"Version": "1",
"Statement": [
{
"Effect": "Allow",
"Action": [
"iacservice:CreateExplorerModuleVersion",
"iacservice:GetExplorerModule",
"iacservice:CreateExplorerModule"
],
"Resource": "acs:iacservice:*:*:explorermodule/*"
},
{
"Effect": "Allow",
"Action": [
"iacservice:CreateExplorerTask",
"iacservice:UpdateExplorerTaskAttribute",
"iacservice:GetExplorerTask"
],
"Resource": "acs:iacservice:*:*:explorertask/*"
},
{
"Effect": "Allow",
"Action": [
"iacservice:CreateJob",
"iacservice:GetJob",
"iacservice:listJobs",
"iacservice:OperateJob"
],
"Resource": "acs:iacservice:*:*:task/*/job/*"
},
{
"Effect": "Allow",
"Action": [
"iacservice:ListResources",
"iacservice:ListExplorerHistories",
"iacservice:CreateExplorerHistory"
],
"Resource": "*"
}
]
}