你可以直接匯入現有 OpenAI 資源,無須重新建立。若要安全地將資源納入 Terraform 管理,請先讓 Terraform 組態與遠端資源的目前設定一致,再預覽並套用匯入計畫。進行任何預定的更新前,請再執行一次計畫,確認沒有需要變更的項目。
匯入區塊需要 Terraform 1.5 以上版本。
宣告並匯入資源
依照每個現有資源的目前設定宣告資源,再新增 import 區塊。區塊中的 ID 請使用供應程式參考文件指定的格式:
resource "openai_project" "existing" {
name = "existing-project"
}
resource "openai_group" "existing" {
name = "existing-group"
}
resource "openai_project_service_account" "existing" {
project_id = openai_project.existing.project_id
name = "existing-service-account"
}
import {
to = openai_project.existing
id = "proj_123"
}
import {
to = openai_group.existing
id = "group_123"
}
import {
to = openai_project_service_account.existing
id = "proj_123/svc_acct_123"
}
儲存計畫,並預覽其中的匯入項目:
terraform plan -out=tfplan
terraform show tfplan
計畫應列出要匯入的資源,且不應包含任何遠端資源更新。如果計畫包含更新,請先調整組態,使其與目前設定一致,再繼續操作。套用已儲存的計畫以匯入資源,然後再執行一次計畫:
terraform apply tfplan
terraform plan
第二次執行計畫時,結果應顯示沒有變更。你可以在組態中保留匯入區塊,記錄 Terraform 如何將這些資源納入管理。
常見的匯入 ID 格式如下:
| 資源 | 匯入 ID 格式 |
|---|---|
| 專案 | <project_id> |
| 組織群組 | <group_id> |
| 專案角色 | <project_id>/<role_id> |
| 專案服務帳戶 | <project_id>/<service_account_id> |
| 專案群組角色 | <project_id>/<group_id>/<role_id> |
| 專案使用者角色 | <project_id>/<user_id>/<role_id> |
| 專案速率限制 | <project_id>/<rate_limit_id> |
請查閱供應程式參考文件,確認每種資源的確切 ID 格式。
讀取資源而不將其納入管理
如果 Terraform 需要取得資源的最新資訊,而該資源由其他系統管理,請使用資料來源。供應程式提供的資料來源涵蓋專案、群組、角色、使用者、角色指派、速率限制、模型權限、託管工具權限、支出警示、資料保留設定及憑證。
以下範例會讀取現有專案及其目前的群組:
data "openai_project" "existing" {
project_id = var.project_id
}
data "openai_project_groups" "existing" {
project_id = data.openai_project.existing.project_id
}
output "project_groups" {
value = data.openai_project_groups.existing.groups
}
供應程式可以透過 ID 匯入現有的專案服務帳戶,但目前沒有提供服務帳戶的資料來源。若要將現有服務帳戶納入管理,請在經核准的資源清單中保留專案 ID 和服務帳戶 ID。關於 API 金鑰的初始設定及後續匯入步驟,請參閱服務帳戶。
偵測並處理設定漂移
執行一般計畫,讓 Terraform 讀取 OpenAI 的目前設定,並與 Terraform 組態中的預期值進行比較:
terraform plan -detailed-exitcode
結束代碼 0 表示沒有變更,2 表示計畫包含變更,1 表示 Terraform 遇到錯誤。
如果計畫顯示某項設定曾在 Terraform 以外變更:
- 確認這項變更是否為有意所做的調整。
- 若要保留遠端變更,請更新 Terraform 組態,使其與遠端設定一致。
- 若要撤銷遠端變更,請檢查並套用計畫,將設定還原為組態中指定的值。
- 再執行一次計畫,確認結果顯示沒有變更。
瞭解移除資源的效果
移除資源區塊會將該資源從 Terraform 狀態中移除。至於是否會刪除對應的遠端物件或重設遠端設定,則取決於資源類型:
| 資源類型 | 移除時的效果 |
|---|---|
openai_project |
封存專案。專案一旦封存便無法還原。 |
openai_project_service_account |
刪除服務帳戶。 |
| 角色、群組、成員資格及指派資源 | 刪除對應的受管理物件或指派關係。 |
openai_project_model_permissions |
刪除專案的模型權限設定。 |
| 專案速率限制、託管工具權限及資料保留資源 | 從 Terraform 狀態中移除資源,但不會重設遠端設定。 |