設定 VM 啟動常式

您可以透過開機常式,自訂 Linux 虛擬機器 (VM) 在 Google Distributed Cloud 中的初始化方式。您可以設定 VM 來建立安全殼層金鑰、新增使用者和密碼、安裝套件、寫入檔案,以及調整網路設定。

您可以使用 cloud-init API 或開機指令碼 API,在 VirtualMachine YAML 資訊清單中指定開機常式,但不能同時使用兩者。每次 VM 啟動時,這些常式都會自動執行。

必要條件

如要使用啟動指令設定 VM,必須符合下列先決條件:

下列各節說明如何使用 cloud-init API 或開機指令碼,在 VM 資訊清單中指定開機常式。

使用 cloud-init API 初始化 VM

Cloud-init 通常用於初始化雲端執行個體,以及在啟動期間自訂 VM。VM 初始化通常涉及套件安裝、存放區設定、安全殼層金鑰建立、將資料寫入檔案,以及設定 VM 的其他方面等工作。您可以使用 spec.cloudInit 欄位,將 cloud-init 設定 YAML 納入 VirtualMachine 自訂資源。VM 執行個體啟動時,cloud-init 會讀取提供的資料,並據此初始化 VM。

請留意下列 cloud-init 實作細節:

  • 建立或更新 VM 時,您可以在 VirtualMachine YAML 資訊清單中指定 cloud-init 資料。如要瞭解如何套用資訊清單來建立 VM,請參閱「教學課程:在 GDC 的 VM 執行階段中建立及管理 Linux VM」。

  • 我們在 VM 規格中使用 NoCloud 資料來源 spec.cloudInit.noCloud。

  • 您可以在 VirtualMachine 資訊清單的不同部分中指定使用者資料和網路資料。區段命名和結構取決於您決定使用的資料格式。

  • 您可以透過下列資料格式指定 cloud-init 設定資訊:

    • 清除文字
    • Base64 編碼字串
    • Kubernetes 密鑰

為協助您快速上手,我們提供了一些常見 VM 初始化工作的設定範例。

Cloud-init 使用者資料

GDC 上的 VM 執行階段支援 cloud-config 語法中的 cloud-init 使用者資料,因此請以 #cloud-config 開頭。您可以將使用者資料格式化為明文、Base64 編碼字串或 Kubernetes Secret。

如要進一步瞭解使用者資料語法和模組參考資料,請參閱 cloud-init 說明文件。

Cloud-init 使用者資料 (純文字)

以下資訊清單範例說明如何以明文形式指定使用者資料。在本例中,cloud-init 會在 VM 啟動時執行指令:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - echo hello

Cloud-init 使用者資料 (以 Base64 編碼的字串)

以下範例說明如何以 base64 編碼格式指定使用者資料。在這個範例中,使用者資料包含與明文範例相同的 echo hello 指令:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userDataBase64: I2Nsb3VkLWNvbmZpZwpydW5jbWQ6CiAgLSBlY2hvIGhlbGxvCg==

Cloud-init 使用者資料做為 Kubernetes Secret

以下範例顯示 VirtualMachine 和 Secret 的 YAML 資訊清單。VirtualMachine 設定中的 spec.cloudInit.noCloud.secretRef 區段指出 cloud-init 使用者資料位於名為 my-sec 的 Kubernetes Secret 中。對應的 Secret 設定會將使用者資料指定為鍵/值組合。在本例中,Base64 編碼值是 cloud-config 語法的 cloud-init 使用者資料。

在參照的 Secret 中,使用資料金鑰 userData (如圖所示) 或 userdata 指定 cloud-init 使用者資料。

在這個範例中,使用者資料包含與明文範例相同的 echo hello 指令:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      secretRef:
        name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  userData: I2Nsb3VkLWNvbmZpZwpydW5jbWQ6CiAgLSBlY2hvIGhlbGxvCg==

如果找不到參照的 Secret,或 Secret 中沒有資料金鑰 userData 或 userdata,請注意下列 VM 啟動行為:

  • 建立 VM 時,VM 會進入 ErrorConfiguration 狀態,並附上詳細原因和訊息。

  • 在其他情況下,VM 會繼續使用舊的 cloud-init 使用者資料,直到 VM 設定正確為止。因此,在正確設定 VM 之前,啟用或停用訪客代理程式的更新不會生效。

如要擷取 VM 資訊 (包括使用的 cloud-init 使用者資料),請使用下列指令:

kubectl get vm VM_NAME -o yaml --kubeconfig KUBECONFIG_PATH

更改下列內容:

  • VM_NAME:VM 名稱。

  • KUBECONFIG_PATH:VM 所在叢集的 kubeconfig 檔案路徑。

如要擷取相關的 Kubernetes 警告事件,請使用 kubectl get event 或 kubectl describe gvm。

Cloud-init 網路資料

與使用者資料類似,您可以將網路資料格式化為明文、base64 編碼字串或 Kubernetes Secret。與使用者資料不同,網路資料不使用 cloud-config 語法。

使用明文或 Base64 編碼字串時,大小上限為 2048 個位元組。如果使用者資料大小接近或大於 2048 個位元組,請將其指定為 Kubernetes Secret。

如要進一步瞭解網路資料語法和相關詳細資料,請參閱 cloud-init 說明文件中的網路設定第 2 版。

Cloud-init 網路資料 (明文)

以下資訊清單範例說明如何將網路資料指定為明文。在這種情況下,cloud-init 會為名稱開頭為「e」的所有乙太網路裝置啟用 DHCP (e*):

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - echo hello
      networkData: |
        version: 2
        ethernets:
          alleths:
            match:
              name: e*
            dhcp4: true

Cloud-init 網路資料,以 Base64 編碼字串表示

以下範例說明如何以 Base64 編碼格式指定網路資料。在本範例中,網路資料包含明文範例中指定的相同 DHCP 設定:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      networkDataBase64: dmVyc2lvbjogMgpldGhlcm5ldHM6CiAgYWxsZXRoczoKICAgIG1hdGNoOgogICAgICBuYW1lOiBlKgogICAgZGhjcDQ6IHRydWUK

Cloud-init 網路資料 (Kubernetes Secret)

以下範例顯示 VirtualMachine 和 Secret 的 YAML 資訊清單。VirtualMachine 設定中的 spec.cloudInit.noCloud.networkDataSecretRef 區段表示 cloud-init 網路資料位於名為 my-sec 的 Kubernetes Secret 中。對應的 Secret 設定會將網路資料指定為鍵/值組合。在本例中,Base64 編碼值是 cloud-init 網路資料。

在參照的 Secret 中,使用資料金鑰 networkData (如圖所示) 或 networkdata 指定 cloud-init 網路資料。

在本範例中,網路資料包含明文範例中指定的相同 DHCP 設定:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      networkDataSecretRef:
        name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  networkData: dmVyc2lvbjogMgpldGhlcm5ldHM6CiAgYWxsZXRoczoKICAgIG1hdGNoOgogICAgICBuYW1lOiBlKgogICAgZGhjcDQ6IHRydWUK

cloud-init 範例

下列各節提供一些常見用途的純文字範例,說明如何使用 cloud-init 初始化 VM:

設定授權的安全殼層金鑰

下列使用者資料範例會將授權的安全殼層金鑰 ssh-rsa AAAAB3NzaK8L93bWxnyp 指派給預設使用者。

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        ssh_authorized_keys:
          - ssh-rsa AAAAB3NzaK8L93bWxnyp

新增使用者

以下使用者資料範例會建立使用者 test,並授予 test 完整的 sudo 存取權。這個範例會為使用者指派不會過期的密碼 pwd。

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        users:
        - default
        - name: test
          sudo: ALL=(ALL) NOPASSWD:ALL
        chpasswd:
          list: |
            test:pwd
          expire: False

在首次啟動時執行指令

下列使用者資料範例會執行 echo 指令和 ls 指令。您可以使用指令,在 VM 啟動時安裝套件等。

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - [ echo, hello ]
          - [ ls, -l, / ]

寫入檔案

下列使用者資料範例會將 Bash 指令碼寫入 VM /var/lib/google 目錄中的 test 檔案。cloud-init 指令會將檔案權限設為讀取、寫入和執行 (0744),供檔案擁有者使用。

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        write_files:
        - path: /var/lib/google/test
          permissions: 0744
          content: |
            #!/bin/bash
            echo hello

疑難排解 cloud-init 問題

如果您在使用 cloud-init 時遇到 VM 初始化問題,請檢查 VM 中的下列 cloud-init 記錄:

  • /var/log/cloud-init.log:根據預設,cloud-init 會將層級為 DEBUG 以上的所有事件寫入這個記錄。

  • /var/log/cloud-init-output.log:根據預設,cloud-init 會將所有 cloud-init 階段的 stdout 和 stderr 導向這個記錄。

使用開機指令碼初始化 VM

開機指令碼會在虛擬機器 (VM) 執行個體的啟動程序中執行工作。您可以在 VirtualMachine 規格的 spec.startupScripts 區段中指定一或多個指令碼。開機指令碼可用於初始化 VM。VM 初始化通常涉及套件安裝、存放區設定、安全殼層金鑰建立、將資料寫入檔案,以及設定 VM 的其他方面等工作。

請留意下列開機指令碼相關細節:

  • 建立或更新 VM 時,請在 VirtualMachine YAML 資訊清單中指定開機指令碼。如要瞭解如何套用資訊清單來建立 VM,請參閱「教學課程:在 GDC 的 VM 執行階段中建立及管理 Linux VM」。

  • 每次 VM 啟動時,都會執行指定的指令碼。

  • 在指令碼頂端加入 #!/bin/...,指出指令碼解譯器。例如,加入 #!/bin/bash 即可使用 Bash 殼層執行指令碼。

  • 您無法在同一個 VirtualMachine 資訊清單中同時指定 cloud-init API 指令 (spec.cloudInit) 和開機指令碼 (spec.startupScripts)。

腳本格式

您可以使用下列資料格式指定開機指令碼:

  • 清除文字
  • Base64 編碼字串
  • Kubernetes 密鑰

使用不同指令碼格式時,請注意下列規則:

  • 使用明文或 base64 編碼字串時,指令碼內容的大小上限為 2048 個位元組。如果指令碼內容大小接近或大於 2048 位元組,請將指令碼指定為 Kubernetes Secret。

  • 使用 Kubernetes Secret 時,請在參照的 Secret 中使用資料金鑰 script 指定指令碼內容。

  • 如果找不到參照的 Secret,或參照的 Secret 中沒有資料金鑰 script,VM 會繼續執行指令碼。不過,VM 不會寫入或更新指令碼內容。在這種情況下,您可以使用 kubectl get event 或 kubectl describe gvm 找到 Kubernetes 警告事件。

下列 VirtualMachine YAML 資訊清單範例包含三個指令碼,每個指令碼都採用支援的格式。在本例中,每個指令碼都會執行 myscript1 (明文範例) 所示的 echo hello 指令。

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  startupScripts:
  - name: myscript1
    script: |
      #!/bin/bash
      echo hello
  - name: myscript2
    scriptBase64: IyEvYmluL2Jhc2gKICAgICAgZWNobyBoZWxsbwo=
  - name: myscript3
    scriptSecretRef:
      name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  script: IyEvYmluL2Jhc2gKICAgICAgZWNobyBoZWxsbwo=

指令碼疑難排解

如要查看指令碼結果或記錄,請執行下列指令:

journalctl -u cloud-final

開機指令碼記錄項目開頭為下列文字:

started to run the command /var/lib/google/startup-scripts/SCRIPT_NAME ...

記錄項目包含開機指令碼的名稱 SCRIPT_NAME。