為執行個體設定記憶體內磁碟區掛接作業

本頁說明如何設定專用的記憶體內磁碟區,以便使用 Cloud Run 磁碟區掛接功能讀取及寫入檔案。請注意,這項功能與 Cloud Run 提供的內建記憶體內檔案系統不同。

在 Cloud Run 中掛接記憶體內磁碟區時,記憶體內磁碟區會顯示為容器檔案系統中的檔案。掛接記憶體內磁碟區後,您可以使用程式設計語言的檔案系統作業和程式庫,存取該磁碟區,就像存取本機檔案系統中的目錄一樣。

您可以使用記憶體內磁碟區執行下列操作:

  • 限制記憶體內磁碟區的大小。限制磁碟區大小後,寫入已滿磁碟區的作業會失敗,這比磁碟區耗用過多記憶體而導致 Cloud Run 終止執行個體要好。

行為

建立記憶體內磁碟區時,建議您指定大小限制。如果磁碟區達到大小上限,後續寫入作業就會因記憶體不足而失敗。執行個體可以處理這項錯誤並繼續執行。

請注意,大小限制只是限制,不會為記憶體內磁碟區分配額外空間。而是會耗用您為容器設定的記憶體。如果部署多個容器,每次寫入磁碟區的記憶體用量,都會計入寫入資料的容器記憶體用量。

如未指定大小限制,系統會自動將限制設為執行個體中所有容器總大小的一半。舉例來說, emptyDir磁碟區大小 = [記憶體 (容器 A) + 記憶體 (容器 B) + 記憶體 (容器 N)]/2。 這項預設行為可能會導致記憶體內磁碟區的大小上限,高於為部分容器分配的記憶體。即使磁碟區大小未達上限,如果單一容器在嘗試將更多資料寫入磁碟區時,超出自身分配到的記憶體,就可能導致非預期的當機。

雖然設定大小限制是選用功能,但我們建議您設定,以免容器耗盡記憶體並當機。

禁止的路徑

Cloud Run 不允許您在 /dev/proc/sys 或其子目錄中掛接磁碟區。

必要的角色

如需與 Cloud Run 相關聯的 IAM 角色和權限清單,請參閱「Cloud Run IAM 角色」和「Cloud Run IAM 權限」。如果 Cloud Run 執行個體與Google Cloud API (例如 Cloud 用戶端程式庫) 介接,請參閱服務身分設定指南。 如要進一步瞭解如何授予角色,請參閱「部署權限」和「管理存取權」。

設定記憶體內磁碟區

為 Cloud Run 執行個體設定記憶體內磁碟區後,系統會為每個啟動的 Cloud Run 執行個體建立空白磁碟區,且只要該執行個體正在執行,磁碟區就會存在。執行個體停止執行後,磁碟區中的資料就會永久刪除。

使用 Google Cloud CLI 或 YAML 設定記憶體內磁碟區掛接。

gcloud

  • 如要掛接磁碟區,請按照下列步驟操作:

    gcloud beta run instances update INSTANCE \
      --add-volume mount-path=MOUNT_PATH,type=in-memory,size-limit=SIZE_LIMIT

    更改下列內容:

    • INSTANCE:執行個體的名稱。
    • MOUNT_PATH:要在容器檔案系統中掛接這個磁碟區的相對路徑,例如 /mnt/my-volume
    • SIZE_LIMIT:要指派給磁碟區的記憶體限制,以 MiB 或 GiB 為單位 (指定為 Mi 或 Gi),例如 500Mi。這個限制必須小於為容器指定的記憶體總量
  • 如果您使用多個容器,請先指定磁碟區,然後為每個容器指定磁碟區掛接點

    gcloud beta run instances update INSTANCE \
      --add-volume=name=VOLUME_NAME,type=in-memory,size-limit=SIZE_LIMIT \
      --container=CONTAINER_1 \
      --add-volume-mount=volume=VOLUME_NAME,mount-path=MOUNT_PATH \
      --container=CONTAINER_2 \
      --add-volume-mount volume=VOLUME_NAME,mount-path=MOUNT_PATH2

YAML

  1. 如果您要建立新執行個體,請略過這個步驟。 如要更新現有執行個體,請下載其 YAML 設定

    gcloud beta run instances describe INSTANCE --format export > instance.yaml
  2. 以下範例包含 YAML 設定:

    apiVersion: run.googleapis.com/v1
    kind: Instance
    metadata:
      name: INSTANCE
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
        containers:
          - name: CONTAINER_NAME
            image: IMAGE_URL
            volumeMounts:
            - name: VOLUME_NAME
              mountPath: MOUNT_PATH
          volumes:
          - name: VOLUME_NAME
            emptyDir:
              medium: Memory
              sizeLimit: SIZE_LIMIT

    更改下列內容:

    • INSTANCE:Cloud Run 執行個體的名稱。
    • CONTAINER_NAME:容器名稱。
    • IMAGE_URL:容器映像檔的參照,例如 us-docker.pkg.dev/cloudrun/container/hello:latest
    • VOLUME_NAME:磁碟區的名稱。VOLUME_NAME 值用於將磁碟區對應至磁碟區掛接點。
    • MOUNT_PATH:要掛接磁碟區的相對路徑,例如 /mnt/my-volume
    • SIZE_LIMIT:要指派給磁碟區的記憶體限制,以 MiB 或 GiB 為單位 (指定為 Mi 或 Gi),例如 500Mi。這個限制必須小於為容器指定的記憶體總量
  3. 使用下列指令建立或更新執行個體:

    gcloud beta run instances replace instance.yaml

讀取及寫入磁碟區

如果您使用 Cloud Run 磁碟區掛接功能,可以透過程式設計語言中的相同程式庫存取已掛接的磁碟區,以便在本機檔案系統上讀取及寫入檔案。

如果您使用現有容器,且容器預期資料會儲存在本機檔案系統,並使用一般檔案系統作業存取資料,這個選項就特別實用。

下列程式碼片段假設磁碟區掛接點的 mountPath 設為 /mnt/my-volume

NodeJS

使用檔案系統模組在磁碟區中建立新檔案,或附加至現有檔案,/mnt/my-volume

var fs = require('fs');
fs.appendFileSync('/mnt/my-volume/sample-logfile.txt', 'Hello logs!', { flag: 'a+' });

Python

寫入磁碟區中保留的檔案 /mnt/my-volume

f = open("/mnt/my-volume/sample-logfile.txt", "a")

Go

使用 os 套件建立磁碟區中保留的新檔案 /mnt/my-volume

f, err := os.Create("/mnt/my-volume/sample-logfile.txt")

Java

使用 Java.io.File 類別在磁碟區中建立記錄檔 /mnt/my-volume

import java.io.File;
File f = new File("/mnt/my-volume/sample-logfile.txt");

清除及移除磁碟區和磁碟區掛接

您可以清除所有磁碟區和掛接點,也可以移除個別磁碟區和磁碟區掛接點。

清除所有磁碟區和磁碟區掛接點

如要清除單一容器執行個體中的所有磁碟區和磁碟區掛接點,請執行下列指令:

gcloud beta run instances update INSTANCE \
    --clear-volumes \
    --clear-volume-mounts

移除個別磁碟區和磁碟區掛接點

如要移除磁碟區,您也必須移除使用該磁碟區的所有磁碟區掛接。

如要移除個別磁碟區或磁碟區掛接,請使用 remove-volumeremove-volume-mount 旗標:

gcloud beta run instances update INSTANCE \
    --remove-volume VOLUME_NAME \
    --container=container1 \
    --remove-volume-mount MOUNT_PATH \
    --container=container2 \
    --remove-volume-mount MOUNT_PATH