保護軟體供應

1. 總覽

Artifact Registry 可讓您儲存不同的構件類型、在單一專案中建立多個存放區，以及將特定區域或多區域與各個存放區建立關聯。系統提供了幾種存放區模式，每種模式都有不同的用途。下圖顯示了在不同模式下搭配使用存放區的其中一種可能方式。此圖顯示兩項 Google Cloud 專案的工作流程。在開發專案中，開發人員建構 Java 應用程式。在另一個執行階段專案中，另一個建構作業會建立容器映像檔，以便部署至 Google Kubernetes Engine。

5af5e4da3ccfdff3.png

在本研究室中，您將瞭解如何執行下列工作。

  • 使用 Standard 存放區部署私人套件
  • 使用遠端存放區快取 Maven 中央套件
  • 使用虛擬存放區，在單一設定中結合多個上游存放區

自修環境設定

  1. 登入 Google Cloud 控制台，建立新專案或重複使用現有專案。如果您還沒有 Gmail 或 Google Workspace 帳戶，請先建立帳戶。

b35bf95b8bf3d5d8.png

a99b7ace416376c4.png

bd84a6d3004737c5.png

  • 「專案名稱」是這項專案參與者的顯示名稱。這是 Google API 未使用的字元字串。您可以隨時更新。
  • 所有 Google Cloud 專案的專案 ID 均不得重複，而且設定後即無法變更。Cloud 控制台會自動產生一個不重複的字串。但通常是在乎它何在在大部分的程式碼研究室中，您必須參照專案 ID (通常為 PROJECT_ID)。如果您對產生的 ID 不滿意，可以隨機產生一個 ID。此外，您也可以自行嘗試，看看系統是否提供該付款方式。在完成這個步驟後就無法變更，而且在專案期間仍會保持有效。
  • 資訊中的第三個值是專案編號，部分 API 會使用這個編號。如要進一步瞭解這三個值，請參閱說明文件。
  1. 接下來，您需要在 Cloud 控制台中啟用計費功能，才能使用 Cloud 資源/API。執行這個程式碼研究室並不會產生任何費用，如果有的話。如要關閉資源，以免系統產生本教學課程結束後產生的費用，您可以刪除自己建立的資源，或刪除整個專案。Google Cloud 的新使用者符合 $300 美元免費試用計畫的資格。

設定工作區

設定 gcloud

在 Cloud Shell 設定專案 ID 和專案編號，將其儲存為 PROJECT_ID 和 PROJECT_NUMBER 變數。

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format='value(projectNumber)')

啟用 API

gcloud services enable artifactregistry.googleapis.com

建立存放區的本機複本

git clone https://github.com/GoogleCloudPlatform/java-docs-samples
cd java-docs-samples/container-registry/container-analysis

2. 標準存放區

標準存放區提供一種方法來儲存私人套件，並與其他應用程式共用

建立標準 Maven 存放區

在 Cloud Shell 中執行下列指令，為 Java 構件建立存放區：

gcloud artifacts repositories create container-dev-java-repo \
    --repository-format=maven \
    --location=us-central1 \
    --description="Java package repository for Container Dev Workshop"

如果出現 Cloud Shell 授權提示，請點選「授權」

依序前往 Google Cloud 控制台 - Artifact Registry - 存放區，然後發現新建立的 Maven 存放區 (名稱為「container-dev-java-repo」)，發現目前沒有任何內容。

gcloud artifacts repositories describe container-dev-java-repo \
    --location=us-central1

應傳回類似以下的回應

Encryption: Google-managed key
Repository Size: 0.000MB
createTime: '2023-03-21T19:01:45.461589Z'
description: Java package repository for Container Dev Workshop
format: MAVEN
mavenConfig: {}
mode: STANDARD_REPOSITORY
name: projects/qwiklabs-gcp-03-4304110dc461/locations/us-central1/repositories/container-dev-java-repo
updateTime: '2023-03-21T19:01:45.461589Z'

設定 Maven for Artifact Registry

執行下列指令來顯示存放區設定，以便新增至 Java 專案：

gcloud artifacts print-settings mvn \
    --repository=container-dev-java-repo \
    --location=us-central1

先前的指令會傳回要新增至專案 pom.xml 的 xml，

  • 「repositories」區段會指定 Maven 可在哪些位置下載遠端構件，供目前專案使用。
  • 「distributionManagement」distributionManagement區段會指定在部署專案時，要將專案推送至哪個遠端存放區。
  • 「extensions」部分會加入 Artifact Registry-maven-wagon，以便啟用連線至 Artifact Registry 所需的驗證和傳輸層
  • 注意：擴充功能可以位於 pom.xml 或 extensions.xml 中。如果專案依附於父項專案，則系統會先存取這些依附元件，再載入 pom.xml 中的其他項目。為確保父項可以存取該擴充功能，可以將其置於 pom.xml 之前載入的 extensions.xml 檔案中，從而讓父項依附元件使用。

複製三個區段，然後在 Cloud Shell 編輯器中開啟 pom.xml，然後將傳回的設定新增至檔案底部的 project 結尾標記中。

提示：請在 cloudshell 中執行下列指令，在目前的目錄中開啟編輯器。

cloudshell workspace .

範例：(您的專案名稱在網址中可能不同)

  ...

  <distributionManagement>
    <snapshotRepository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </snapshotRepository>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </repository>
  </distributionManagement>

  <repositories>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
      <releases>
        <enabled>true</enabled>
      </releases>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>
  </repositories>

  <build>
    <extensions>
      <extension>
        <groupId>com.google.cloud.artifactregistry</groupId>
        <artifactId>artifactregistry-maven-wagon</artifactId>
        <version>2.2.0</version>
      </extension>
    </extensions>
  </build>

</project>

將 Java 套件上傳至 Artifact Registry

在 Maven 中設定 Artifact Registry 後，您現在可以使用 Artifact Registry 儲存 Java jar 檔案，供貴機構的其他專案使用。

執行下列指令，將 Java 套件上傳至 Artifact Registry：

mvn deploy -DskipTests

如要再次執行這個指令，請務必提高 pom.xml 中的版本。

在 Artifact Registry 中查看 Java 套件

前往 Cloud 控制台 - Artifact Registry - 存放區 按一下 container-dev-java-repo，然後檢查 hello-world 二進位檔成果是否存在：

147eac5168648db1.png

3. 遠端存放區

Remote Repositories 可快取第三方套件，以提高可靠性和安全性。

建立遠端存放區

注意事項：如要進一步瞭解驗證和設定，請參閱產品說明文件。

透過 Cloud Shell 執行下列指令，為 Maven Central 構件建立遠端存放區：

gcloud artifacts repositories create maven-central-cache \
    --project=$PROJECT_ID \
    --repository-format=maven \
    --location=us-central1 \
    --description="Remote repository for Maven Central caching" \
    --mode=remote-repository \
    --remote-repo-config-desc="Maven Central" \
    --remote-mvn-repo=MAVEN-CENTRAL

在控制台中查看存放區

前往 Cloud Console - Artifact Registry - 存放區點選 maven-central-cache，您會發現已建立且目前沒有任何內容

查看終端機中的存放區

gcloud artifacts repositories describe maven-central-cache \
    --location=us-central1

將存放區整合至專案

執行下列指令來顯示存放區設定，以便新增至 Java 專案：

gcloud artifacts print-settings mvn \
    --repository=maven-central-cache \
    --location=us-central1

將存放區區段新增至 pom.xml。請不要複製外部 <repositories>標記中。

將新增的存放區 ID 變更為「中央」確保每個存放區項目都有專屬 ID

範例：(您的專案名稱在網址中可能不同)

  ...

  <distributionManagement>
    <snapshotRepository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </snapshotRepository>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </repository>
  </distributionManagement>

  <repositories>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
      <releases>
        <enabled>true</enabled>
      </releases>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>

    <repository>
      <id>central</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/maven-central-cache</url>
      <releases>
        <enabled>true</enabled>
      </releases>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>


  </repositories>

  <build>
    <extensions>
      <extension>
        <groupId>com.google.cloud.artifactregistry</groupId>
        <artifactId>artifactregistry-maven-wagon</artifactId>
        <version>2.2.0</version>
      </extension>
    </extensions>
  </build>

</project>

在終端機執行下列指令，為專案建立 extensions.xml。如要使用核心擴充功能機制，確保 Maven 可以從 Artifact Registry 解析父項或外掛程式依附元件。

mkdir .mvn 
cat > .mvn/extensions.xml << EOF
<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
  <extension>
    <groupId>com.google.cloud.artifactregistry</groupId>
    <artifactId>artifactregistry-maven-wagon</artifactId>
    <version>2.2.0</version>
  </extension>
</extensions>
EOF

從遠端存放區提取依附元件

執行下列指令，使用遠端存放區編譯應用程式：

rm -rf ~/.m2/repository 
mvn compile

在控制台中查看套件

前往 Cloud 控制台 - Artifact Registry - 存放區點選 maven-central-cache，然後查看快取的二進位檔構件：

9deea93caa5fefd7.png

4. 虛擬存放區

虛擬存放區可做為多個存放區的介面，透過單一設定即可存取。這樣可以為構件的消費者簡化用戶端設定，並減輕依附元件混淆攻擊來提高安全性。

建立政策檔案

cat > ./policy.json << EOF
[
  {
    "id": "private",
    "repository": "projects/${PROJECT_ID}/locations/us-central1/repositories/container-dev-java-repo",
    "priority": 100
  },
  {
    "id": "central",
    "repository": "projects/${PROJECT_ID}/locations/us-central1/repositories/maven-central-cache",
    "priority": 80
  }
]

EOF

建立虛擬存放區

gcloud artifacts repositories create virtual-maven-repo \
    --project=${PROJECT_ID} \
    --repository-format=maven \
    --mode=virtual-repository \
    --location=us-central1 \
    --description="Virtual Maven Repo" \
    --upstream-policy-file=./policy.json

將存放區整合至專案

執行下列指令來顯示存放區設定，以便新增至 Java 專案：

gcloud artifacts print-settings mvn \
    --repository=virtual-maven-repo \
    --location=us-central1

將 pom 中的整個存放區區段替換成輸出內容中的一個虛擬存放區區段。

範例：(您的專案名稱在網址中可能不同)

  ...


  <distributionManagement>
    <snapshotRepository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </snapshotRepository>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/container-dev-java-repo</url>
    </repository>
  </distributionManagement>

  <repositories>
    <repository>
      <id>artifact-registry</id>
      <url>artifactregistry://us-central1-maven.pkg.dev/qwiklabs-gcp-04-3c51830ea757/virtual-maven-repo</url>
      <releases>
        <enabled>true</enabled>
      </releases>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>
  </repositories>

  <build>
    <extensions>
      <extension>
        <groupId>com.google.cloud.artifactregistry</groupId>
        <artifactId>artifactregistry-maven-wagon</artifactId>
        <version>2.2.0</version>
      </extension>
    </extensions>
  </build>

</project>

從虛擬存放區提取依附元件

由於虛擬存放區是通道，因此不會儲存任何實際套件，為了清楚示範這個過程，您必須刪除先前建立的 maven-central-cache 存放區並重新建立，以便從空的存放區重新開始

執行下列指令，重新建立快取存放區

gcloud artifacts repositories delete maven-central-cache \
    --project=$PROJECT_ID \
    --location=us-central1 \
    --quiet

gcloud artifacts repositories create maven-central-cache \
    --project=$PROJECT_ID \
    --repository-format=maven \
    --location=us-central1 \
    --description="Remote repository for Maven Central caching" \
    --mode=remote-repository \
    --remote-repo-config-desc="Maven Central" \
    --remote-mvn-repo=MAVEN-CENTRAL

您可以在控制台中查看空白的存放區。前往 Cloud 控制台 - Artifact Registry - 存放區

接著使用下列指令建構專案，練習虛擬存放區

rm -rf ~/.m2/repository 
mvn compile

在控制台中查看套件

前往 Cloud 控制台 - Artifact Registry - 存放區點選 maven-central-cache，確認二進位檔構件已設為從虛擬存放區提取，但最終是從 maven-central-cache 提取：

9deea93caa5fefd7.png

5. 恭喜！

恭喜，您已完成程式碼研究室！

涵蓋內容

  • 使用標準存放區部署私人套件
  • 使用遠端存放區快取 Maven 中央套件
  • 使用虛擬存放區，在單一設定中結合多個上游存放區

清除所用資源

執行下列指令以刪除專案

gcloud projects delete ${PROJECT_ID}

—

上次更新時間：2023 年 3 月 22 日