管理 Ruby Gem

本頁說明如何新增、查看及刪除 Ruby Gem 和 Gem 版本。

事前準備

  1. 安裝初始化 Google Cloud CLI。

    如要執行 Ruby 存放區的指令,必須使用 354.0.0 以上版本的 Google Cloud CLI。您可以使用下列指令查看版本:

    gcloud version
    
  2. 如果目標存放區不存在,請建立 Ruby 套件存放區

  3. 確認已安裝 Ruby。如需安裝操作說明,請參閱Google Cloud 設定 Ruby 的教學課程

  4. (選用) 設定 gcloud 指令的預設值

必要的角色

如要取得管理 Gem 的權限,請要求管理員在存放區中授予您下列 IAM 角色:

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

新增寶石

Ruby 中的套件稱為「gem」,每個 gem 都包含名稱、版本和平台。Ruby 專案也必須包含 gemfile,這是用於指定必要 gem 依附元件的設定檔。

存放區模式標準

建構 Ruby 專案時,發布檔案會儲存在專案的 lib 子目錄中。接著,您可以使用 RubyGems 將 Gem 上傳至標準存放區。

如要將 Gem 新增至 Artifact Registry 存放區,請按照下列步驟操作:

gem push GEM_NAME --host https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

其中:

  • GEM_NAME 是要推送至存放區的 Gem 名稱。
  • LOCATION 是存放區的位置。
  • PROJECT 是專案 ID。如果省略這個標記,系統會使用目前的或預設專案
  • REPOSITORY 是 Artifact Registry 中的存放區名稱。

查看 Gem 和版本

存放區模式標準

如要使用 Google Cloud 控制台或 gcloud 查看套件和套件版本,請按照下列步驟操作:

主控台

  1. 在 Google Cloud 控制台中開啟「Repositories」頁面。

    開啟「存放區」頁面

  2. 在存放區清單中,按一下適當的存放區。

    「Packages」頁面會列出存放區中的套件。

  3. 按一下套件即可查看套件版本。

gcloud

如要列出存放區中的套件,請執行下列指令:

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

更改下列內容:

  • REPOSITORY 是存放區的名稱。如果您已設定預設存放區,可以省略此標記來使用預設值。
  • LOCATION 是存放區的地區或多地區位置。 如果您已設定預設位置,則可以省略此標記,以便使用預設值。

如要查看套件的版本,請執行下列指令:

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

更改下列內容:

  • PACKAGE 是套件的 ID 或套件的完整 ID。
  • REPOSITORY 是存放區的名稱。如果您已設定預設存放區,則可以略過此標記,以便使用預設值。
  • LOCATION 是存放區的地區或多地區位置。 使用這個旗標可查看特定位置的存放區。如果您已設定預設位置,則可以省略此標記,以便使用預設位置。

如果是遠端存放區,傳回的清單應包含所有直接和遞移依附元件。

可列出檔案

存放區模式標準

您可以列出存放區中的檔案、指定套件所有版本中的檔案,或是特定套件版本中的檔案。

對於下列所有指令,您可以在指令中加入 --limit 標記,設定要傳回的檔案數量上限。

如要列出設定預設值時,預設專案、存放區和位置中的所有檔案,請執行下列指令:

gcloud artifacts files list

如要列出特定專案、存放區和位置中的檔案,請執行下列指令:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

如要列出特定套件所有版本的檔案:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

如要列出特定套件版本的檔案:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION

替換下列值:

  • LOCATION:存放區的區域或多區域位置
  • PROJECT:您的 Google Cloud 專案 ID。 如果專案 ID 包含冒號 (:),請參閱「網域範圍專案」。
  • REPOSITORY:儲存映像檔的存放區名稱。
  • PACKAGE:套件名稱。
  • VERSION:套件版本。

範例

請參考下列套件資訊:

  • 專案:my-project
  • 存放區:my-repo
  • 存放區位置:us-west1
  • 套件:my-app

下列指令會列出預設專案us-west1 位置的存放區 my-repo 內所有檔案:

gcloud artifacts files list \
    --location=us-west1 \
    --repository=my-repo
下列指令會列出套件 1.0 版中的檔案。

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

安裝 Gem

存放區模式標準

如要安裝套件的最新穩定版本,請按照下列步驟操作:

gem install GEM_NAME

如果是標準存放區,您可以直接從存放區下載套件。

如果是遠端存放區,您會下載套件及其依附元件的快取副本。如果沒有快取副本,遠端存放區會從上游來源下載套件並快取,然後提供給您。您可以查看存放區中的套件清單,確認遠端存放區已從上游來源擷取套件。

如果是虛擬存放區,Artifact Registry 會在上游存放區中搜尋要求的套件。

  • 如果沒有快取副本,上游遠端存放區就會下載並快取要求的套件。虛擬存放區只會提供所要求的套件,不會儲存這些套件。
  • 如果您要求的版本在多個上游存放區中都有,Artifact Registry 會根據為虛擬存放區設定的優先順序,選擇要使用的上游存放區。

舉例來說,假設虛擬存放區的上游存放區有下列優先順序設定:

  • main-repo:優先順序設為 100
  • secondary-repo1:優先順序設為 80
  • secondary-repo2:優先順序設為 80
  • test-repo:優先順序設為 20

main-repo 的優先順序值最高,因此虛擬存放區一律會先搜尋這個存放區。

secondary-repo1secondary-repo2 的優先順序都設為 80。如果 main-repo 中沒有要求的套件,Artifact Registry 接下來會搜尋這些存放區。由於兩者具有相同的優先順序值,如果兩個存放區都有該版本,Artifact Registry 可以選擇從任一存放區提供套件。

test-repo 的優先順序值最低,如果其他上游存放區都沒有儲存構件,就會提供該構件。

其他資訊

將 Gem 推送至或從 Artifact Registry 存放區提取 Gem 時,如果系統在指定存放區中找不到要求的 Gem 或其依附元件,gem 用戶端會使用 Gemfile 中為 Gem 定義的任何其他來源。如要直接從 Artifact Registry 擷取及安裝,請執行下列指令,從 Gemfile 中移除非 Artifact Registry 來源:

gem sources --remove SOURCE

如要將 rubygems.org 加回來源,請按照下列步驟操作:

gem sources --add SOURCE

其中 SOURCE 是來源的地址,例如 https://rubygems.org

刪除套件和版本

存放區模式標準

您可以刪除套件和所有版本,也可以刪除特定版本。

  • 套件刪除後即無法復原。
  • 如果是遠端存放區,系統只會刪除套件的快取副本。上游來源不受影響。如果刪除快取的套件,下次存放區收到相同套件版本的請求時,Artifact Registry 會再次下載並快取該套件。

刪除套件或套件版本前,請確認您已通報或解決其中的任何重要依附元件。

如要刪除套件,請按照下列步驟操作:

主控台

  1. 在 Google Cloud 控制台中開啟「Repositories」頁面。

    開啟「存放區」頁面

  2. 在存放區清單中,按一下適當的存放區。

    「Packages」頁面會列出存放區中的套件。

  3. 選取要刪除的套件。

  4. 按一下 [刪除]

  5. 在確認對話方塊中,按一下「刪除」

gcloud

執行下列指令:

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

更改下列內容:

  • PACKAGE 是存放區中的套件名稱。
  • REPOSITORY 是存放區的名稱。如果您已設定預設存放區,可以略過此標記,以便使用預設值。
  • LOCATION 是存放區的地區或多地區位置。 使用這個旗標可查看特定位置的存放區。如果您已設定預設位置,則可以省略此標記,以便使用預設值。

--async 標記會讓指令立即傳回,而不會等待進行中的作業完成。

如要刪除套件版本,請按照下列步驟操作:

主控台

  1. 在 Google Cloud 控制台中開啟「Repositories」頁面。

    開啟「存放區」頁面

  2. 在存放區清單中,按一下適當的存放區。

    「Packages」頁面會列出存放區中的套件。

  3. 按一下套件即可查看該套件的版本。

  4. 選取要刪除的版本。

  5. 按一下 [刪除]

  6. 在確認對話方塊中,按一下「刪除」

gcloud

執行下列指令:

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

更改下列內容:

  • VERSION 是您要刪除的版本名稱。
  • PACKAGE 是存放區中的套件名稱。
  • REPOSITORY 是存放區的名稱。如果您已設定預設存放區,可以略過此標記,以便使用預設值。
  • LOCATION 是存放區的地區或多地區位置。 使用這個旗標可查看特定位置的存放區。如果您已設定預設位置,則可以省略此標記,以便使用預設值。

--async 標記會讓指令立即傳回,而不會等待進行中的作業完成。

限制

  • Artifact Registry 不支援使用 gem sources -add 指令將存放區新增為來源。不過,您可以手動將來源新增至 .gemrc 檔案,或直接在 gem 指令中傳遞 --source 標記。

  • Artifact Registry 不支援使用 gem fetch 提取 Gem。

後續步驟