在 Application Design Center 中,複合式範本可讓您連結可重複使用的標準應用程式範本和個別元件,建構複雜的應用程式。模組化設計可讓團隊平行開發建構模塊,並更新個別模塊,而不必重新部署整個應用程式。您也可以指派不同的服務帳戶,限制每個建構模塊的部署權限。此外,複合範本可讓您在 App Lifecycle Manager 中,為 SaaS 產品建立部署單元的模型並進行封裝。
事前準備
如要執行本文件中的工作,請要求管理員授予您已啟用應用程式管理功能的資料夾或管理專案的必要角色,如下表所示:
| 工作 | 必要的角色 |
|---|---|
| 建立、設計及編輯複合範本 | Application Design Center 管理員 (roles/designcenter.admin),或Application Design Center 使用者 ( roles/designcenter.user) |
| 將複合範本發布或共用到目錄 | Application Design Center 管理員 (roles/designcenter.admin) |
如要進一步瞭解角色,請參閱「使用 IAM 控管存取權」。
如要使用自己的標準應用程式範本做為構成元素,請設定輸入和輸出變數來建立可設定的變數,並在應用程式範本之間建立連結。詳情請參閱下列文章:
建立複合式應用程式範本
如要設計及共用複雜的應用程式,請建立複合範本。您可以在範本設計中新增及連結下列項目:
標準應用程式範本:從下列現有範本中選取:
- Google 設計的範本,整合了 Google Cloud 最佳做法和預設安全性設定。
- 您先前建立並新增至工作區目錄的範本。
元件:從下列 Google Cloud 資源中選取:
- Google 設計的元件,整合 Google Cloud 最佳做法和預設安全性設定。
- 您匯入的元件,以您自己的 Terraform 模組為基礎。
指定範本詳細資料
範本詳細資料可協助您分類範本,並協助開發人員決定是否要使用範本。
如要輸入範本詳細資料,請按照下列步驟操作:
設計畫布
點選導覽選單中的「Templates」(範本)。
從「Region」(區域) 清單中選取範本的位置。如果您打算在 App Lifecycle Manager 中建立擴充部署作業,請選取「global」。
從「Create Template」(建立範本) 清單中,選取「Composite template」(複合範本)。
系統會自動填入「Template ID」(範本 ID) 欄位。或者,您也可以輸入範本的專屬 ID。這是必填欄位。
在「Template Name」(範本名稱) 欄位中,輸入要顯示在 Google Cloud 控制台的人類可讀 ID。
如未提供名稱,系統會將範本 ID 複製到這個欄位。
在「Description」(說明) 欄位中,簡短說明應用程式的用途。
按一下「建立範本」,系統隨即會顯示設計畫布。
gcloud CLI
建立新的複合應用程式範本。
gcloud design-center spaces application-templates create APPLICATION_TEMPLATE \
--project=PROJECT \
--location=LOCATION \
--space=SPACE \
--display-name=DISPLAY_NAME \
--description=DESCRIPTION \
--composition-type=COMPOSITE
更改下列內容:
APPLICATION_TEMPLATE:要建立的應用程式 範本 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。如果您打算在 App Lifecycle Manager 中建立擴充部署作業,請使用全域。SPACE:聊天室 ID。DISPLAY_NAME: Google Cloud 控制台中顯示的名稱。DESCRIPTION:簡短說明。
詳情請參閱「gcloud design-center spaces application-templates create」。
設計範本
如要設計複合範本,請新增標準應用程式範本和元件,並連結至下列起點:
- 空白畫布。
- Google 提供的範本。
- 使用 Gemini 協助生成的範本。
設計範本時,App Design Center 會產生 Terraform 程式碼,反映設計和設定詳細資料。
如要設計範本,請按照下列步驟操作:
設計畫布
在設計畫布中,選取「設計」即可查看畫布。
請執行下列任一操作:
如要從 Google 提供的範本開始,請在畫布的「Get Started」(開始使用) 區域中,按一下範本名稱。
如要從空白畫布開始,請繼續執行下一步。
如要將標準應用程式範本新增至畫布,請按照下列步驟操作:
在「Components」(元件) 區塊,點選「Embed templates」(嵌入範本)。
如要新增現有範本,請按一下下列其中一個清單中的範本:
- 範本:工作區目錄中的標準應用程式範本,或已與工作區共用的範本。
- Google 範本:由 Google 建立並新增至 Google 目錄的標準應用程式範本。
如要將所選範本新增至畫布,請按一下「選取」。
如要建立新的標準應用程式範本,請按一下「Create a new template」(建立新範本)。「Create new template」(建立新範本) 頁面隨即開啟。
詳情請參閱「設計標準應用程式範本」。
如要將元件新增至畫布,請在「Components」(元件) 區域中點選元件。
如要在範本和元件之間建立通訊管道,請執行下列任一操作:
從一個構成要素的藍點拖曳到另一個構成要素的藍點。
如要將連結元件新增至現有元件,請按一下「 新增」,然後選取要新增的元件。
如要瞭解連線詳情,請參閱各項支援資源的設定說明文件。
如要移除構成要素或連結,請按照下列步驟操作:
在畫布中,按一下建構區塊或連結。
在「設定」區域中,按一下「刪除」。
在欄位中輸入 delete。
點選「刪除」。
gcloud CLI
找出空間目錄中建構模塊的範本修訂版本 URI。
gcloud design-center spaces shared-templates list \ --project=PROJECT \ --location=LOCATION \ --space=SPACE更改下列內容:
PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。
找出要新增至範本的 Google 目錄建構區塊範本修訂版本 URI。
gcloud design-center spaces shared-templates list \ --google-catalog \ --location=us-central1將標準應用程式範本或元件新增至複合式範本。
gcloud design-center spaces application-templates components create COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --shared-template-revision-uri=SHARED_TEMPLATE_URI更改下列內容:
COMPONENT:要新增至範本的標準應用程式範本或元件 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:複合應用程式範本的範本 ID,您要在其中新增標準應用程式範本或元件。SHARED_TEMPLATE_URI:標準應用程式範本或元件共用範本 URI。例如:projects/my-project/locations/us-central1/spaces/my-space/sharedTemplates/my-shared-template/revisions/rev1。
詳情請參閱「gcloud design-center spaces application-templates components create」。
在範本中新增第二個標準應用程式範本或元件。
gcloud design-center spaces application-templates components create COMPONENT_2 \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --shared-template-revision-uri=SHARED_TEMPLATE_URI_2更改下列內容:
COMPONENT_2:要新增至範本的第二個標準應用程式範本或元件 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:要新增標準應用程式範本或元件的複合範本 ID。SHARED_TEMPLATE_URI_2:第二個標準應用程式範本或元件共用範本 URI。例如:projects/my-project/locations/us-central1/spaces/my-space/sharedTemplates/my-shared-template/revisions/rev1。
詳情請參閱「gcloud design-center spaces application-templates components create」。
在標準應用程式範本或元件之間建立連線。
gcloud design-center spaces application-templates components connections create CONNECTION \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --component=COMPONENT \ --destination-component-uri=COMPONENT_2更改下列內容:
CONNECTION:要新增至範本的連線 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:要新增連線的應用程式範本 ID。COMPONENT:來源標準應用程式範本或元件 ID。COMPONENT_2:目的地標準應用程式範本或元件 ID。
詳情請參閱「gcloud design-center spaces application-templates components connections create」。
設定元件的預設值
對於新增至範本的每個元件,您可以指定預設設定詳細資料,例如資源的專案和部署位置。從這個範本建立應用程式時,Application Design Center 會套用這些預設值。
如果預設設定不符合需求,應用程式開發人員也可以修改連線詳細資料。舉例來說,您可以在建立應用程式時,修改環境變數鍵名稱、變更連線通訊埠,或為服務帳戶新增其他角色。
開發人員部署應用程式前,可以查看及修改您在範本中設定的預設值。開發人員必須為每個支援的資源設定必要詳細資料。
如要設定元件和連線,請按照下列步驟操作:
設計畫布
在設計畫布中,按一下所需元件。
在「Configuration」(設定) 區域,從「Project ID」(專案 ID) 清單中選取要部署資源的專案。選取符合下列條件的專案:
專案必須位於所選啟用應用程式管理功能的資料夾中。
專案不得為管理專案。
進行資源的其他設定。舉例來說,您可以為 Cloud SQL 設定下列項目:
- 區域
- 備份設定
- 資料庫旗標
- IP 設定
如需各元件的設定說明文件連結,請參閱「支援的資源」。
在設計畫布上連結元件時,系統會使用預設設定值建立連線。如要新增或修改連線詳細資料,請按照下列步驟操作。
在設計畫布中,按一下兩個元件之間的連線。「Connection」(連線) 面板隨即開啟,並顯示連線參數。
執行下列其中一個步驟:
如要修改現有的連線參數,請按一下「Edit」(編輯)。
如要新增連線參數,請按一下「Add parameter」(新增參數)。
更新「Key」和「Value」欄位。舉例來說,您可能需要修改下列詳細資料:
- 環境變數鍵名稱,須符合應用程式需求。
- 連線通訊埠值。
- 新增至服務帳戶的角色。
按一下「儲存」。
gcloud CLI
說明應用程式範本中的各個元件,以便查看元件參數。
gcloud design-center spaces application-templates components describe COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE更改下列內容:
COMPONENT:要說明的元件 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:應用程式範本的範本 ID。
詳情請參閱「gcloud design-center spaces application-templates components describe」。
針對要修改的每個元件,請在主目錄中建立包含參數值的 JSON 檔案。
舉例來說,您可以為 Cloud Run 元件建立下列檔案:
[ { "key": "service_name", "value": "frontend-service" }, { "key": "project_id", "value": "DEPLOYMENT_PROJECT" } ]更新應用程式範本中的各個元件,設定必要參數。
gcloud design-center spaces application-templates components update COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --parameters=PARAMETERS_FILE_PATH \ --application-template=APPLICATION_TEMPLATE更改下列內容:
COMPONENT:要更新的元件 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。PARAMETERS_FILE_PATH:包含元件參數的 JSON 檔案。APPLICATION_TEMPLATE:應用程式範本的範本 ID。
詳情請參閱「gcloud design-center spaces application-templates components update」。
說明元件連線。
gcloud design-center spaces application-templates components connections describe CONNECTION \ --component=COMPONENT \ --application-template=APPLICATION_TEMPLATE \ --project=PROJECT \ --location=LOCATION \ --space=SPACE更改下列內容:
CONNECTION:連線 ID。COMPONENT:元件 ID。APPLICATION_TEMPLATE:範本 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。
詳情請參閱「gcloud design-center spaces application-templates components connections describe」。
編輯元件連線參數。
gcloud design-center spaces application-templates components connections update CONNECTION \ --component=COMPONENT \ --application-template=APPLICATION_TEMPLATE \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --source-component-parameters='[{"key": "SOURCE_KEY", "value": "SOURCE_VALUE"}]'更改下列內容:
CONNECTION:連線 ID。COMPONENT:元件 ID。APPLICATION_TEMPLATE:範本 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。SOURCE_KEY:新的參數鍵。SOURCE_VALUE:新的參數值。
詳情請參閱「gcloud design-center spaces application-templates components connections update」。
設定標準應用程式範本
開發人員將複合範本部署為應用程式時,系統會為下列各項建立應用程式:
- 每組標準應用程式範本。
- 每組元件。
您可以為每個群組提供預設值。例如,您可以加入部署專案、區域和擁有者。開發人員在 App Design Center 部署應用程式時,可以使用預設值,也可以為每個應用程式指定自己的詳細資料。
如要為每個群組提供預設應用程式詳細資料,請按照下列步驟操作:
設計畫布
在設計畫布中,點選標準應用程式範本。
「嵌入式範本」面板隨即開啟。
在「Configuration」(設定) 區域中,輸入應用程式詳細資料。
詳情請參閱「建立應用程式草稿」。
gcloud CLI
詳情請參閱「設計範本」。
避免變數名稱衝突
複合範本中的多個元件或標準應用程式範本可能包含相同的變數名稱。舉例來說,資料庫和應用程式服務可能都需要 project_id 變數。開發人員部署應用程式時,系統會將他們指定的值,套用至所有重複的變數名稱。
為避免變數名稱衝突,您可以將元件的變數名稱對應至複合範本上的專屬別名。舉例來說,您可以將 project_id 對應至資料庫元件的 database_project_id,以及服務元件的 service_project_id。
變數別名的驗證規則
請確認變數別名符合下列規定:
您只能為複合式應用程式範本 (
--composition-type=COMPOSITE) 建立變數別名。別名變數必須存在於元件中,並公開為範本輸入變數。根據預設,範本會公開必要的元件變數。如果變數為選用,您必須先將其新增為範本輸入變數,才能為其設定別名。
變數名稱和別名名稱不得為空字串。
在一個元件中,每個變數只能設定一個別名。
如果多個變數共用別名,這些變數必須具有相容的資料類型。
使用 gcloud CLI 設定變數別名
如要在將元件新增至複合範本時設定變數別名,或更新現有元件的別名,請使用下列 gcloud CLI 指令。如果變數為選用,您必須先將其新增為範本輸入變數,才能為其設定別名。
設定變數別名後,複合範本會使用這些範本輸入變數的別名。開發人員使用複合範本建立應用程式草稿時,輸入欄位會顯示別名。開發人員為 SaaS 產品指定部署參數或單位設定時,會使用別名索引鍵設定值。
建立元件時新增別名
如要在將元件或標準應用程式範本新增至複合範本時設定變數別名,請使用下列指令:
gcloud design-center spaces application-templates components create \
COMPONENT \
--project=PROJECT \
--location=LOCATION \
--space=SPACE \
--application-template=APPLICATION_TEMPLATE \
--shared-template-revision-uri=SHARED_TEMPLATE_URI \
--input-variable-aliases=variable=VARIABLE_NAME,alias=ALIAS_NAME
更改下列內容:
COMPONENT:要新增至範本的標準應用程式範本或元件 ID。PROJECT:您的管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:複合應用程式範本的範本 ID。SHARED_TEMPLATE_URI:標準應用程式範本或元件共用範本修訂版本 URI。VARIABLE_NAME:要建立別名的 元件內部變數名稱。ALIAS_NAME:範本輸入變數使用的專屬別名。
如要在建立元件時設定多個別名,請重複使用 --input-variable-aliases 旗標、提供 JSON 清單,或提供 YAML 或 JSON 檔案:
重複旗標:
--input-variable-aliases=variable=v1,alias=a1 --input-variable-aliases=variable=v2,alias=a2提供 JSON 清單:
--input-variable-aliases='[{"variable": "v1", "alias": "a1"}, {"variable": "v2", "alias": "a2"}]'提供 YAML 或 JSON 檔案:
--input-variable-aliases=path/to/aliases.yaml
詳情請參閱「gcloud design-center spaces application-templates components create」。
更新現有元件的別名
如要為複合範本中的現有元件新增別名,請使用 --add-input-variable-aliases 旗標和 components update 指令:
gcloud design-center spaces application-templates components update \
COMPONENT \
--project=PROJECT \
--location=LOCATION \
--space=SPACE \
--application-template=APPLICATION_TEMPLATE \
--add-input-variable-aliases=variable=VARIABLE_NAME,alias=ALIAS_NAME
更改下列內容:
COMPONENT:要更新的元件 ID。PROJECT:您的管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。APPLICATION_TEMPLATE:複合應用程式範本的範本 ID。VARIABLE_NAME:要建立別名的 元件內部變數名稱。ALIAS_NAME:範本輸入變數使用的專屬別名。
如要新增多個別名,請重複 --add-input-variable-aliases 旗標,或提供 JSON 清單或檔案。
管理現有別名
如要修改或移除現有元件的別名,請使用下列指令:
從元件中移除現有別名:
gcloud design-center spaces application-templates components update \ COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --remove-input-variable-aliases=variable=VARIABLE_NAME,alias=ALIAS_NAME從元件中移除所有變數別名:
gcloud design-center spaces application-templates components update \ COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --clear-input-variable-aliases以新清單取代所有現有別名,或在 YAML 或 JSON 檔案中提供別名:
gcloud design-center spaces application-templates components update \ COMPONENT \ --project=PROJECT \ --location=LOCATION \ --space=SPACE \ --application-template=APPLICATION_TEMPLATE \ --input-variable-aliases=ALIASES_FILE_PATH更改下列內容:
ALIASES_FILE_PATH:YAML 或 JSON 檔案的本機路徑,其中包含變數別名。
使用變數和別名組合清單,設定 YAML 或 JSON 檔案的格式。例如:
- variable: "db_password" alias: "database_password" - variable: "project_id" alias: "database_project_id"
詳情請參閱「gcloud design-center spaces application-templates components update」。
驗證範本
與開發人員分享複合範本前,請先在 App Design Center 部署及驗證範本。這個步驟可協助您在多部機器上大規模部署前,先驗證功能。
如要驗證範本,請按照下列步驟操作:
在設計畫布中,按一下「Continue」(繼續),然後選取「Create application to deploy」(建立要部署的應用程式)。
「Create an application」(建立應用程式) 面板隨即開啟。
在「Composite application details」區域中,輸入應用程式詳細資料。
詳情請參閱「建立應用程式草稿」。
點選「下一步」。
部署時,系統會為您新增至複合範本的每個建構模塊建立應用程式。設定各個應用程式,然後點選「下一步」。
詳情請參閱「建立應用程式草稿」。
測試已部署的應用程式,確保符合需求。
為避免產生週期性費用,請刪除測試部署作業。
建立縮放部署作業
如要部署及管理複合範本的多個執行個體,請使用 App Lifecycle Manager。
在 App Design Center 驗證範本。
在設計畫布中,按一下「Continue」(繼續),然後選取「Deploy at scale with App Lifecycle Manager」(透過 App Lifecycle Manager 大規模部署)。
App Lifecycle Manager 會在 Google Cloud 控制台中開啟。
如要在 App Lifecycle Manager 中部署,請參閱「部署 SaaS 產品」。
分享範本
如要讓開發人員使用範本,可以將範本新增至目錄並共用。將範本新增至目錄後,該範本就會在共用目錄的工作區中,做為應用程式來源。
如要共用範本,請按照下列步驟操作:
點選設計畫布中的「Add to Catalog」。
如要管理共用目錄的工作區,請參閱「管理目錄」。
修改並重新分享範本
隨著您對應用程式的經驗增加,以及業務需求不斷演變,您可能需要更新範本。舉例來說,您可能會決定新增 Memorystore 服務來進行快取,藉此提升後端服務的效能。
修改範本時,您會建立範本修訂版本。如要將變更套用至現有應用程式,開發人員必須使用修訂版本部署應用程式。
App Design Center 不會自動將範本修訂版本發布至目錄。如要共用最新修訂版本,請再次將範本發布至目錄。
如要建立新修訂版本,請按照下列步驟操作:
點選導覽選單中的「Templates」(範本)。
選取要修改的應用程式範本。畫布隨即開啟。
修改範本,以符合新需求。例如新增及設定新元件。
如要與其他工作區共用最新修訂版本,請再次將範本新增至目錄。
刪除範本
如果不再需要某個範本,可以將其刪除。
設計畫布
- 點選設計畫布中的「 Actions」(動作)。
- 點選「刪除」。
gcloud CLI
刪除應用程式範本。
```sh
gcloud design-center spaces application-templates delete APPLICATION_TEMPLATE \
--project=PROJECT \
--location=LOCATION \
--space=SPACE
```
更改下列內容:
APPLICATION_TEMPLATE:要刪除的應用程式範本 ID。PROJECT:管理專案 ID。LOCATION:應用程式範本區域。SPACE:聊天室 ID。
詳情請參閱「gcloud design-center spaces application-templates delete」。
後續步驟
- 部署 SaaS 產品,透過 App Lifecycle Manager 部署複合範本。
- 管理範本目錄,與其他工作區共用範本。
- 匯入元件,在範本設計中使用自己的 Terraform 模組。