管理員工作站設定檔

管理員工作站設定檔會指定 vCenter 資源、網路設定,以及 gkeadm 用來建立 Google Distributed Cloud 軟體 (僅限 VMware) 管理員工作站的 CPU、記憶體和磁碟大小。本文將說明檔案中的各個欄位,並提供完整的設定檔範例。

正在產生設定檔範本

下載 gkeadm 指令列工具。

生成範本:

./gkeadm create config --config=OUTPUT_FILENAME

將 OUTPUT_FILENAME 替換為您選擇的生成範本路徑。如果省略這個旗標,gkeadm 會將檔案命名為 admin-ws-config.yaml,並放入目前的目錄。

範本

填寫設定檔

在設定檔中,按照下列各節所述輸入欄位值。

gcp

本節包含元件存取服務帳戶的相關資訊。

gcp.componentAccessServiceAccountKeyPath

字串。元件存取服務帳戶的 JSON 金鑰檔案路徑。如要瞭解如何建立 JSON 金鑰檔案,請參閱「元件存取服務帳戶」。

例如:

gcp:
  componentAccessServiceAccountKeyPath: "my-key-folder/component-access-key.json"

vCenter

這個部分包含 vSphere 環境的相關資訊。

vCenter.credentials.address

字串。vCenter 伺服器的 IP 位址或主機名稱。

填寫 address 欄位前,請先下載並檢查 vCenter 伺服器的服務憑證。輸入下列指令,下載憑證並儲存至名為 vcenter.pem 的檔案。

true | openssl s_client -connect VCENTER_IP:443 -showcerts 2>/dev/null | sed -ne '/-BEGIN/,/-END/p' > vcenter.pem

將 VCENTER_IP 替換為 vCenter Server 的 IP 位址。

開啟憑證檔案,查看主體一般名稱和主體別名:

openssl x509 -in vcenter.pem -text -noout

輸出內容會顯示 Subject 一般名稱 (CN)。這可能是 IP 位址或主機名稱。例如:

Subject: ... CN = 203.0.113.100
Subject: ... CN = my-host.my-domain.example

輸出內容也可能包含 Subject Alternative Name 下的一或多個 DNS 名稱:

X509v3 Subject Alternative Name:
    DNS:vcenter.my-domain.example

選擇 Subject 一般名稱或 Subject Alternative Name 下方的其中一個 DNS 名稱,做為設定檔中 vCenter.credentials.address 的值。例如:

vCenter:
  credentials:
    address: "203.0.113.1"
    ...
vCenter:
  credentials:
    address: "my-host.my-domain.example"
    ...

vCenter.credentials.fileRef.path

字串。憑證設定檔的路徑,其中包含 vCenter 使用者帳戶的使用者名稱和密碼。使用者帳戶應具備管理員角色或同等權限。請參閱 vSphere 需求。

執行 gkeadm create config 時,系統會為名為 admin-ws-config.yaml 的管理員工作站設定檔建立範本。此外,也會建立名為 credential.yaml 的憑證設定檔範本。

範例:

vCenter:
  credentials:
    fileRef:
      path: "credential.yaml"

vCenter.credentials.fileRef.entry

字串。憑證設定檔中憑證區塊的名稱,其中包含 vCenter 使用者帳戶的使用者名稱和密碼。

在 credential.yaml 中,gkeadm 會自動建立名為 vCenter 的憑證區塊。

範例:

vCenter:
  credentials:
    fileRef:
      entry: "vCenter"

vCenter.datacenter

字串。vCenter 資料中心的名稱。例如:

vCenter:
  datacenter: "MY-DATACENTER"

vCenter.datastore

字串。vCenter 資料儲存庫的名稱。例如:

vCenter:
  datastore: "MY-DATASTORE"

vCenter.cluster

字串。vCenter 叢集的名稱。例如:

vCenter:
  cluster: "MY-CLUSTER"

vCenter.network

字串。要建立管理員工作站的 vCenter 網路名稱。例如:

vCenter:
  network: "MY-VM-NETWORK"

vCenter.folder

字串。資料中心內存放管理員工作站 VM 的資料夾。例如:

vCenter:
  folder: "MY-FOLDER"

vCenter.resourcePool

字串。如果您使用的是非預設資源集區,請提供 vCenter 資源集區的名稱。例如:

vCenter:
  resourcePool: "MY-POOL"

如果您使用的是預設資源集區,請提供下列值:

vCenter:
  resourcePool: "MY_CLUSTER/Resources"

將 MY_CLUSTER 替換為 vCenter 叢集名稱。

請參閱「指定獨立主機的根資源集區」。

vCenter.caCertPath

字串。當用戶端 (例如 Google Distributed Cloud 軟體專用 VMware) 向 vCenter 伺服器傳送要求時,伺服器必須出示憑證或憑證套裝組合,向用戶端證明其身分。如要驗證憑證或套裝組合,只有 VMware 適用的 Google Distributed Cloud 軟體必須在信任鏈中具備根憑證。

將 vCenter.caCertPath 設為根憑證的路徑。例如:

vCenter:
  caCertPath: "/usr/local/google/home/me/certs/vcenter-ca-cert.pem"

VMware 安裝作業具有憑證授權單位 (CA),可向 vCenter 伺服器核發憑證。信任鏈中的根憑證是由 VMware 建立的自行簽署憑證。

如果不想使用預設的 VMware CA,可以將 VMware 設為使用其他憑證授權單位。

如果 vCenter 伺服器使用預設 VMware CA 核發的憑證,請按照下列步驟下載憑證:

curl -k "https://SERVER_ADDRESS/certs/download.zip" > download.zip

將 SERVER_ADDRESS 替換為 vCenter 伺服器的位址。

安裝 unzip 指令並解壓縮憑證檔案:

sudo apt-get install unzip
unzip download.zip

如果解壓縮指令第一次執行失敗,請再次輸入指令。

在 certs/lin 中找出憑證檔案。

proxyUrl

字串。如果執行 gkeadm 的機器使用 Proxy 伺服器存取網際網路,請將這個欄位設為 Proxy 伺服器的網址。即使通訊埠編號與配置的預設通訊埠相同,也請一併加入。例如:

proxyUrl: "https://my-proxy.example.local:80"

adminWorkstation

這個部分包含管理員工作站的相關資訊。

adminWorkstation.name

字串。管理員工作站的名稱。這個欄位會填入產生的值。您可以保留產生的值,或自行提供其他名稱。例如:

adminWorkstation:
  name: "gke-admin-ws-200617-113711"

adminWorkstation.cpus

整數。管理員工作站的虛擬 CPU 數量。例如:

adminWorkstation:
  cpus: 4

adminWorkstation.memoryMB

整數。管理員工作站的記憶體容量 (以 MB 為單位)。例如:

adminWorkstation:
  memoryMB: 8192

adminWorkstation.diskGB

整數。管理員工作站的開機磁碟大小 (以 GB 為單位)。建議至少 100 GB,1.28 以上版本則必須為 100 GB。例如:

adminWorkstation:
  diskGB: 100

adminWorkstation.dataDiskName

字串。要掛接至主目錄的永久磁碟名稱。這個欄位會填入產生的值。您可以保留產生的值,也可以自行提供名稱。結尾必須是 .vmdk。部署前,必須先在提供的路徑中建立任何目錄。如未設定這個欄位的值,預設值為:

gke-on-prem-admin-workstation-data-disk/ADMIN_WORKSTATION_NAME-data-disk.vmdk

例如:

adminWorkstation:
  dataDiskName: "gke-on-prem-admin-workstation-data-disk/gke-admin-ws-200617-113711-data-disk.vmdk"

adminWorkstation.dataDiskMB

整數。資料磁碟的大小 (以 MB 為單位)。如果未設定這個欄位的值,則預設為 512。例如:

adminWorkstation:
  dataDiskMB: 512

adminWorkstation.network.ipAllocationMode

字串。如要讓管理員工作站從 DHCP 伺服器取得 IP 位址,請將這個值設為 "dhcp"。如要讓管理員工作站使用您選擇的靜態 IP 位址,請將此值設為 "static"。例如:

adminWorkstation:
  network:
    ipAllocationMode: "static"

adminWorkstation.network.hostConfig

如果將 ipAllocationMode 設為 "static",請填寫這個部分的欄位。

如果您將 ipAllocationMode 設為 "dhcp",請移除這個部分,或將其保留為註解排除狀態。

adminWorkstation.network.hostConfig.ip

字串。管理員工作站的 IP 位址 (可自行選擇)。例如:

adminWorkstation:
  network:
    hostConfig:
      ip: "172.16.5.1"

adminWorkstation.network.hostConfig.gateway

字串。管理員工作站所在網路的預設閘道 IP 位址。例如:

adminWorkstation:
  network:
    hostConfig:
      gateway: "172.16.6.254"

adminWorkstation.network.hostConfig.netmask

字串。管理員工作站所在網路的網路遮罩。例如:

adminWorkstation:
  network:
    hostConfig:
      netmask: "255.255.248.0"

adminWorkstation.network.hostConfig.dns

字串陣列。管理員工作站可使用的 DNS 伺服器 IP 位址陣列。例如:

adminWorkstation:
  network:
    hostConfig:
      dns:
      - "172.16.255.1"
      - "172.16.255.2"

adminWorkstation.proxyUrl

字串。如果網路位於 Proxy 伺服器後方,且您希望管理員工作站和管理員叢集使用相同的 Proxy 伺服器,請將 adminWorkstation.proxyUrl 設為 Proxy 伺服器的網址。即使通訊埠編號與配置的預設通訊埠相同,也請一併加入。例如:

adminWorkstation:
  proxyUrl: "http://aw-proxy.example:80"

adminWorkstation.ntpServer

字串。管理員工作站應使用的網路時間通訊協定伺服器主機名稱或 IP 位址。例如:

adminWorkstation:
  ntpServer: "216.239.35.0"

如果留空,僅限軟體的 Google Distributed Cloud for VMware 會使用 "ntp.ubuntu.com"。

設定檔範例

以下是管理員工作站設定檔範例:

gcp:
  componentAccessServiceAccountKeyPath: "my-key-folder/component-access-key.json"
vCenter:
  credentials:
    address: "203.0.113.1"
    fileRef:
      path: "credential.yaml"
      entry: "vCenter"
  datacenter: "MY-DATACENTER"
  datastore: "MY-DATASTORE"
  cluster: "MY-CLUSTER"
  network: "MY-VM-NETWORK"
  resourcePool: "MY-POOL"
  caCertPath: "/usr/local/google/home/me/certs/the-root.cert"
proxyUrl: ""
adminWorkstation:
  name: "my-admin-workstation"
  cpus: 4
  memoryMB: 8192
  diskGB: 100
  dataDiskName: "gke-on-prem-admin-workstation-data-disk/gke-admin-ws-200617-113711-data-disk.vmdk"
  dataDiskMB: 512
  network:
    ipAllocationMode: "static"
    hostConfig:
      ip: "172.16.5.1"
      gateway: "172.16.6.254"
      netmask: "255.255.248.0"
      dns:
      - "172.16.255.1"
      - "172.16.255.2"
  proxyUrl: ""
  ntpServer: "216.239.35.0"