設定 Windows 執行個體的 EC2Launch v2 設定

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

本節包含有關如何進行 EC2Launch v2 設定的資訊。

使用 EC2Launch v2 設定對話方塊變更設定

以下是從 EC2Launch 對話方塊中輸入的設定建立的範例組態 YAML 檔案。

version: 1.0
config:
  - stage: boot
	tasks:
      - task: extendRootPartition
  - stage: preReady
    tasks:
      - task: activateWindows
        inputs:
          activation:
            type: amazon
      - task: setDnsSuffix
        inputs:
          suffixes:
            - $REGION.ec2-utilities.amazonaws.com
      - task: setAdminAccount
        inputs:
          password:
            type: random
      - task: setWallpaper
        inputs:
          path: C:\ProgramData\Amazon\EC2Launch\wallpaper\Ec2Wallpaper.jpg
          attributes:
            - hostName
            - instanceId
            - privateIpAddress
            - publicIpAddress
            - instanceSize
            - availabilityZone
            - architecture
            - memory
            - network
  - stage: postReady
    tasks:
      - task: startSsm

使用 CLI 設定 EC2Launch v2

您可以使用命令列介面 (CLI) 來配置 EC2Launch 設定並管理服務。下節包含您可用來管理 EC2Launch v2 之 CLI 命令的說明和使用資訊。

collect-logs

收集 EC2Launch 的日誌、壓縮檔案，並將它們置於指定的目錄中。

範例

ec2launch collect-logs -o C:\Mylogs.zip

用途

ec2launch collect-logs [flags]

Flags

-h, --help

collect-logs 的說明

-o, --output string

壓縮輸出日誌的路徑

get-agent-config

以指定的格式 (JSON 或 YAML) 列印 agent-config.yml。如果未指定任何格式，則會以先前指定的格式列印 agent-config.yml。

範例

ec2launch get-agent-config -f json

範例 2

下列 PowerShell 命令顯示如何編輯和儲存 JSON 格式的 agent-config 文件。

$config = & "$env:ProgramFiles/Amazon/EC2Launch/EC2Launch.exe" --format json | ConvertFrom-Json
$jumboFrame =@"
{
   "task": "enableJumboFrames"
}
"@
$config.config | %{if($_.stage -eq 'postReady'){$_.tasks += (ConvertFrom-Json -InputObject $jumboFrame)}}
$config | ConvertTo-Json -Depth 6 | Out-File -encoding UTF8
$env:ProgramData/Amazon/EC2Launch/config/agent-config.yml

用途

ec2launch get-agent-config [flags]

Flags

-h, --help

get-agent-config 的說明

-f, --format string

agent-config 檔案的輸出格式：json、yaml

list-volumes

列出連接到執行個體的所有儲存磁碟區，包括暫時磁碟區和 EBS 磁碟區。

範例

ec2launch list-volumes

用途

ec2launch list-volumes

Flags

-h, --help

list-volumes 的說明

重設

此任務的主要目標是在下次代理程式執行時重設該代理程式。為此，reset 命令會從本機 EC2Launch 目錄刪除 EC2Launch v2 的所有代理程式狀態資料 (請參閱：EC2Launch v2 目錄結構)。選擇性重設會刪除服務和 Sysprep 日誌。

指令碼行為取決於代理程式執行指令碼的模式 (內嵌或分離)。

範例

ec2launch reset -c

用途

ec2launch reset [flags]

Flags

-c, --clean

在 reset 前清除執行個體日誌

-h, --help

reset 的說明

run

執行 EC2Launch v2。

範例

ec2launch run

用途

ec2launch run [flags]

Flags

-h, --help

run 的說明

status

取得 EC2Launch v2 代理程式的狀態。選擇性地封鎖處理程序，直到代理程式完成為止。處理程序結束程式碼會決定代理程式狀態：

範例：

ec2launch status -b

用途

ec2launch status [flags]

Flags

-b,--block

封鎖處理程序，直到代理程式完成執行

-h,--help

status 的說明

sysprep

此任務的主要目標是在下次代理程式執行時重設該代理程式。為此，sysprep 命令會重設代理程式狀態、更新 unattend.xml 檔案、停用 RDP，然後執行 Sysprep。

指令碼行為取決於代理程式執行指令碼的模式 (內嵌或分離)。

範例：

ec2launch sysprep

用途

ec2launch sysprep [flags]

Flags

-c,--clean

在 sysprep 前清除執行個體日誌

-h,--help

Sysprep 說明

-s,--shutdown

在 sysprep 後關閉執行個體

validate

驗證 agent-config 檔案 C:\ProgramData\Amazon\EC2Launch\config\agent-config.yml。

範例

ec2launch validate

用途

ec2launch validate [flags]

Flags

-h , --help

validate 的說明

version

取得可執行版本。

範例

ec2launch version

用途

ec2launch version [flags]

Flags

-h, --help

version 的說明

桌布

將新桌布設定為提供的桌布路徑 (.jpg 檔案)，並顯示選取的執行個體詳細資料。

語法

ec2launch wallpaper ^
--path="C:\ProgramData\Amazon\EC2Launch\wallpaper\Ec2Wallpaper.jpg" ^
--all-tags ^
--attributes=hostName,instanceId,privateIpAddress,publicIpAddress,instanceSize,availabilityZone,architecture,memory,network

輸入

EC2Launch v2 任務組態

本節包含 agent-config.yml 和使用者資料的組態結構描述任務、詳細資訊及範例。

結構描述︰agent-config.yml

agent-config.yml 檔案的結構如下所示。請注意，不能在同一階段重複任務。有關任務屬性，請參閱後面的任務說明。

文件結構：agent-config.yml

JSON

{
	"version": "1.1",
	"config": [
		{
			"stage": "string",
			"tasks": [
				{
					"task": "string",
					"inputs": {
						...
					}
				},
				...
			]
		},
		...
	]
}

YAML

version: 1.1
config:
- stage: string
  tasks:
  - task: string
	inputs:
	  ...
  ...
...

範例：agent-config.yml

下列範例顯示 agent-config.yml 組態檔的設定。

version: 1.1
config:
- stage: boot
  tasks:
  - task: extendRootPartition
- stage: preReady
  tasks:
  - task: activateWindows
    inputs:
      activation:
        type: amazon
  - task: setDnsSuffix
    inputs:
      suffixes:
      - $REGION.ec2-utilities.amazonaws.com
  - task: setAdminAccount
    inputs:
      password:
        type: random
  - task: setWallpaper
    inputs:
      path: C:\ProgramData\Amazon\EC2Launch\wallpaper\Ec2Wallpaper.jpg
      attributes:
      - hostName
      - instanceId
      - privateIpAddress
      - publicIpAddress
      - instanceSize
      - availabilityZone
      - architecture
      - memory
      - network
- stage: postReady
  tasks:
  - task: startSsm

設定啟動或重新啟動期間執行的 EC2Launch v2 使用者資料指令碼

下列 JSON 和 YAML 範例顯示使用者資料的文件結構。Amazon EC2 會剖析您在文件中指定的 tasks 陣列中命名的每個任務。每個任務都有自己的屬性集和要求集。如需詳細資訊，請參閱 EC2Launch v2 啟動任務的任務定義。

文件結構：使用者資料

JSON

{
	"version": "1.1",
	"tasks": [
		{
			"task": "string",
			"inputs": {
				...
			},
		},
		...
	]
}

YAML

version: 1.1
tasks:
- task: string
  inputs:
    ...
...

範例：使用者資料

如需使用者資料的詳細資訊，請參閱 Amazon EC2 如何處理 Windows 執行個體的使用者資料。

下列 YAML 文件範例顯示 EC2Launch v2 執行以建立檔案的  PowerShell 指令碼 (作為使用者資料)。

version: 1.1
tasks:
- task: executeScript
  inputs:
  - frequency: always
    type: powershell
    runAs: localSystem
    content: |-
      New-Item -Path 'C:\PowerShellTest.txt' -ItemType File

針對與舊版啟動代理程式相容的使用者資料，您可以使用 XML 格式。EC2Launch v2 會將指令碼作為 UserData 階段中的 executeScript 任務執行。為了符合 EC2Launch v1 和 EC2Config 行為，預設情況下使用者資料指令碼會作為連接/內嵌的程序執行。

您可以新增選用標籤來自訂指令碼的執行方式。例如，除了在執行個體啟動時執行一次使用者資料指令碼之外，若還想在執行個體重新啟動時執行，您可以使用下列標記：

<persist>true</persist>

範例：

<powershell>
  $file = $env:SystemRoot + "\Temp" + (Get-Date).ToString("MM-dd-yy-hh-mm")
  New-Item $file -ItemType file
</powershell>
<persist>true</persist>

您可以使用 <powershellArguments> 標籤指定一或多個 PowerShell 引數。如果未傳遞引數，EC2Launch v2 預設會新增下列引數：-ExecutionPolicy Unrestricted。

範例：

<powershell>
  $file = $env:SystemRoot + "\Temp" + (Get-Date).ToString("MM-dd-yy-hh-mm")
  New-Item $file -ItemType file
</powershell>
<powershellArguments>-ExecutionPolicy Unrestricted -NoProfile -NonInteractive</powershellArguments>

若要將 XML 使用者資料指令碼作為分離的程序執行，請將下列標籤新增至您的使用者資料。

<detach>true</detach>

範例：

<powershell>
  $file = $env:SystemRoot + "\Temp" + (Get-Date).ToString("MM-dd-yy-hh-mm")
  New-Item $file -ItemType file
</powershell>
<detach>true</detach>

變更日誌：使用者資料

下表列出使用者資料的變更，並將其交叉參考至適用的 EC2Launch v2 代理程式版本。

* 與預設 agent-config.yml 檔案搭配使用時。

EC2Launch v2 結束程式碼和重新啟動

您可以使用 EC2Launch v2 定義指令碼處理結束程式碼的方式。根據預設，在指令碼中執行的最後一個命令的結束程式碼會報告為整個指令碼的結束程式碼。例如，如果指令碼包含三個命令，而第一個命令失敗，但後續命令成功，則會因最終命令成功而將執行狀態報告為 success。

如果您希望指令碼重新啟動執行個體，則必須在指令碼中指定 exit 3010，即使重新啟動是指令碼中的最後一個步驟也是如此。exit 3010 會指示 EC2Launch v2 重新啟動執行個體並再次呼叫指令碼，直到傳回不是 3010 的結束程式碼，或直到達到最大重新啟動計數為止。EC2Launch v2 允許每個任務最多 5 次重新啟動。如果您嘗試使用不同的機制 (例如 Restart-Computer) 從指令碼重新啟動執行個體，則指令碼執行狀態將不一致。例如，狀態可能會卡在重新啟動迴圈或不執行重新啟動。

如果您使用與舊版代理程式相容的 XML 使用者資料格式，則使用者資料執行的次數可能會超出您的預期。如需詳細資訊，請參閱故障診斷一節中的 服務會多次執行使用者資料。

EC2Launch v2 和 Sysprep

EC2Launch v2 服務將執行 Sysprep，此為 Microsoft 的工具，可讓您建立自訂且可重複使用的 Windows AMI。EC2Launch v2 呼叫 Sysprep 時，會使用 %ProgramData%\Amazon\EC2Launch 中的檔案來決定要執行的操作。您可以使用 EC2Launch 設定 對話方塊間接編輯這些檔案，或直接使用 YAML 編輯器或文字編輯器來編輯這些檔案。但有些進階設定無法在 EC2Launch 設定對話方塊中使用，因此您必須直接編輯這些項目。

如果您在更新執行個體設定後從執行個體建立 AMI，新設定將套用到從新 AMI 啟用的任何執行個體。如需有關建立 AMI 的詳細資訊，請參閱 建立 Amazon EBS 支援的 AMI。