設定 Dataproc Hub

Dataproc Hub 是自訂的 JupyterHub 伺服器。管理員可設定及建立 Dataproc Hub 執行個體,產生單一使用者 Managed Service for Apache Spark 叢集,用於託管 JupyterJupyterLab 筆記本環境 (請參閱「使用 Dataproc Hub」)。

為多位使用者啟動 Notebooks:您可以建立支援 Managed Service for Apache Spark 的 Vertex AI Workbench 執行個體,或在 VM 上安裝 Managed Service for Apache Spark JupyterLab 外掛程式,為多位使用者提供筆記本服務。

目標

  1. 定義 Managed Service for Apache Spark 叢集設定 (或使用預先定義的設定檔)。

  2. 設定 Dataproc Hub 執行個體環境變數。

  3. 建立 Dataproc Hub 執行個體。

事前準備

請建立 Google Cloud 專案和 Cloud Storage bucket (如果尚未建立的話)。

  1. 設定專案

    1. 登入 Google Cloud 帳戶。如果您是 Google Cloud新手,歡迎 建立帳戶,親自評估產品在實際工作環境中的成效。新客戶還能獲得價值 $300 美元的免費抵免額,可用於執行、測試及部署工作負載。
    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Roles required to select or create a project

      • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
      • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

      Go to project selector

    3. Verify that billing is enabled for your Google Cloud project.

    4. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Roles required to enable APIs

      To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

      Enable the APIs

    5. 安裝 Google Cloud CLI。

    6. 若您採用的是外部識別資訊提供者 (IdP),請先使用聯合身分登入 gcloud CLI

    7. 執行下列指令,初始化 gcloud CLI:

      gcloud init
    8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Roles required to select or create a project

      • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
      • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

      Go to project selector

    9. Verify that billing is enabled for your Google Cloud project.

    10. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Roles required to enable APIs

      To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

      Enable the APIs

    11. 安裝 Google Cloud CLI。

    12. 若您採用的是外部識別資訊提供者 (IdP),請先使用聯合身分登入 gcloud CLI

    13. 執行下列指令,初始化 gcloud CLI:

      gcloud init

  2. 在專案中建立 Cloud Storage bucket,用於保存本教學課程中使用的資料。

    1. 前往 Google Cloud 控制台的 Cloud Storage「Buckets」(值區) 頁面。

      前往「Buckets」(值區) 頁面

    2. 點選 「Create」(建立)
    3. 在「建立 bucket」頁面中,輸入 bucket 資訊。如要前往下一個步驟,請按「繼續」
      1. 在「開始使用」部分,執行下列操作:
        • 輸入符合值區命名規定的全域不重複名稱。
        • 如要新增值區標籤,請展開「標籤」部分 (),按一下 「新增標籤」,然後為標籤指定 keyvalue
      2. 在「Choose where to store your data」(選擇資料的儲存位置) 專區中,執行下列操作:
        1. 選取「位置類型」
        2. 從「位置類型」下拉式選單中,選擇要永久儲存 bucket 資料的位置。
          • 如果您選取「雙區域」位置類型,也可以使用相關核取方塊啟用強化型複製
        3. 如要設定跨值區複製,請選取「透過 Storage 移轉服務新增跨值區複製作業」,然後按照下列步驟操作:

          設定跨 bucket 複製作業

          1. 在「Bucket」選單中選取 bucket。
          2. 在「複製設定」部分,按一下「設定」,設定複製作業的設定。

            系統隨即會顯示「設定跨 bucket 複製作業」窗格。

            • 如要依物件名稱前置字串篩選要複製的物件,請輸入要納入或排除物件的前置字串,然後按一下「新增前置字串」
            • 如要為複製的物件設定儲存空間級別,請從「儲存空間級別」選單中選取儲存空間級別。如果略過這個步驟,複製的物件預設會使用目標值區的儲存空間級別。
            • 按一下 [完成]
      3. 在「選擇資料儲存方式」部分,執行下列操作:
        1. 選取 bucket 的預設儲存空間級別,或選取「Autoclass」,讓系統自動管理 bucket 資料的儲存空間級別。
        2. 如要啟用階層命名空間,請在「為資料密集型工作負載提供最理想的儲存空間」部分,選取「為這個值區啟用階層命名空間」
      4. 在「選取如何控制物件的存取權」部分,選取 bucket 是否要強制執行禁止公開存取,並為 bucket 的物件選取存取控管方法
      5. 在「選擇保護物件資料的方式」部分,執行下列操作:
        • 選取「資料保護」下方的任何選項,為 bucket 設定所需項目。
          • 如要啟用虛刪除,請按一下「虛刪除政策 (用於資料復原)」核取方塊,並指定要保留物件的天數 (刪除後)。
          • 如要設定「物件版本管理」,請按一下「物件版本管理 (用於版本管控)」核取方塊,並指定每個物件的版本數量上限,以及非現行版本失效的天數。
          • 如要為物件和 bucket 啟用資料保留政策,請勾選「保留 (符合法規)」核取方塊,然後執行下列操作:
            • 如要啟用 Object Retention Lock,請按一下「啟用物件保留功能」核取方塊。
            • 如要啟用 Bucket Lock,請勾選「Set bucket retention policy」(設定值區資料保留政策) 核取方塊,然後選擇保留期限的時間單位和長度。
        • 如要選擇物件資料的加密方式,請展開「資料加密」部分 (),然後選取「資料加密」方法
    4. 點選「建立」

定義叢集設定

Dataproc Hub 執行個體會根據 YAML 叢集設定檔中的設定值建立叢集。

叢集設定可以指定 Managed Service for Apache Spark 叢集可用的任何功能或元件 (例如機型、初始化動作和選用元件)。叢集映像檔版本必須為 1.4.13 以上。如果嘗試使用 1.4.13 以下的映像檔版本產生叢集,會導致錯誤並失敗。

YAML 叢集設定檔範例

clusterName: cluster-name
config:
  softwareConfig:
    imageVersion: 2.2-ubuntu22
    optionalComponents:
    - JUPYTER

所有設定都必須儲存在 Cloud Storage。 您可以建立及儲存多個設定檔,讓使用者在使用 Dataproc Hub 建立 Managed Service for Apache Spark 叢集筆記本環境時,選擇要使用的設定檔。

建立 YAML 叢集設定檔的方式有兩種:

  1. 從控制台建立 YAML 叢集設定檔

  2. 從現有叢集匯出 YAML 叢集設定檔

從控制台建立 YAML 叢集設定檔

  1. 在 Google Cloud 控制台中開啟「Create a cluster」(建立叢集) 頁面,然後選取並填寫欄位,指定 Dataproc Hub 為使用者產生的叢集類型。
    1. 在左側面板底部選取「Equivalent REST」(對等 REST)。
    2. 複製產生的 JSON 模塊 (不含開頭的 POST 要求行),然後將 JSON 模塊貼到線上 JSON 轉 YAML 轉換器 (請在網路上搜尋「Convert JSON to YAML」(將 JSON 轉換成 YAML))。
    3. 將轉換後的 YAML 複製到本機 cluster-config-filename.yaml 檔案。

從現有叢集匯出 YAML 叢集設定檔

  1. 建立符合您需求的叢集
  2. 將叢集設定匯出至本機 cluster-config-filename.yaml 檔案。
    gcloud dataproc clusters export cluster-name \
        --destination cluster-config-filename.yaml  \
        --region region
     

將 YAML 設定檔儲存在 Cloud Storage 中

將本機的 YAML 叢集設定檔複製到 Cloud Storage bucket。

gcloud storage cp cluster-config-filename.yaml gs://bucket-name/

設定 Dataproc Hub 執行個體環境變數

管理員可以設定下表列出的中樞環境變數,為中樞使用者產生的 Managed Service for Apache Spark 叢集設定屬性。

變數 說明 範例
NOTEBOOKS_LOCATION 包含使用者筆記本的 Cloud Storage bucket 或 bucket 資料夾。`gs://` 前置字串為選用項目。預設值:Managed Service for Apache Spark 暫存 bucket gs://bucket-name/
DATAPROC_CONFIGS 導向 YAML 叢集設定檔的 Cloud Storage 路徑字串清單 (以半形逗號分隔)。「gs://」前置字串為選用項目。預設值:gs://dataproc-spawner-dist/example-configs/,其中包含預先定義的 example-cluster.yamlexample-single-node.yaml gs://cluster-config-filename.yaml
DATAPROC_LOCATIONS_LIST Dataproc Hub 執行個體所在區域的可用區尾碼。使用者可以選取其中一個區域,做為要產生 Managed Service for Apache Spark 叢集的區域。預設值:「b」。 b,c,d
DATAPROC_DEFAULT_SUBNET Dataproc Hub 執行個體產生 Managed Service for Apache Spark 叢集時所在的子網路。預設值:Dataproc Hub 執行個體子網路。 https://www.googleapis.com/compute/v1/projects/project-id/regions/region/subnetworks/subnet-name
DATAPROC_SERVICE_ACCOUNT Managed Service for Apache Spark VM 將以這個服務帳戶的身分執行。預設值:如未設定,系統會使用預設的 Managed Service for Apache Spark 服務帳戶 service-account@project-id.iam.gserviceaccount.com
SPAWNER_DEFAULT_URL 根據預設,要在已產生的 Managed Service for Apache Spark 叢集上顯示 Jupyter 還是 JupyterLab UI。預設值:「/lab」。 「/」或「/lab」,分別對應 Jupyter 或 JupyterLab。
DATAPROC_ALLOW_CUSTOM_CLUSTERS 是否允許使用者自訂 Managed Service for Apache Spark 叢集。 預設值:false。 「true」或「false」
DATAPROC_MACHINE_TYPES_LIST 如果已啟用叢集自訂功能 (DATAPROC_ALLOW_CUSTOM_CLUSTERS),這份清單會列出允許使用者為產生的 Managed Service for Apache Spark 叢集選擇哪些機型。預設值:空白 (允許所有機器類型)。 n1-standard-4,n1-standard-8,e2-standard-4,n1-highcpu-4
NOTEBOOKS_EXAMPLES_LOCATION 導向筆記本 bucket 或 bucket 資料夾的 Cloud Storage 路徑。叢集啟動時,上述 bucket 和資料夾會下載至已產生的 Managed Service for Apache Spark 叢集。預設值:空白。 gs://bucket-name/

設定中樞環境變數

設定中樞環境變數的方法有兩種:

  1. 從控制台設定中樞環境變數

  2. 在文字檔中設定中樞環境變數

從控制台設定中樞環境變數

在 Google Cloud 控制台依序前往「Dataproc」→「Workbench」頁面,在「User-Managed Notebooks」(使用者管理的筆記本) 分頁中建立 Dataproc Hub 執行個體時,您可以按一下「Populate」(填入) 按鈕,開啟「Populate Dataproc Hub」(填入 Dataproc Hub) 表單,設定每個環境變數。

在文字檔中設定中樞環境變數

  1. 建立檔案:您可以使用文字編輯器,在本機檔案中設定 Dataproc Hub 執行個體環境變數。或者,您也可以填入預留位置值,並變更或新增變數及其值,然後執行下列指令來建立檔案。

    cat <<EOF > environment-variables-file
    DATAPROC_CONFIGS=gs://bucket/cluster-config-filename.yaml
    NOTEBOOKS_LOCATION=gs://bucket/notebooks
    DATAPROC_LOCATIONS_LIST=b,c
    EOF
    

  2. 將檔案儲存到 Cloud Storage:將本機 Dataproc Hub 執行個體環境變數檔案複製到 Cloud Storage bucket。

    gcloud storage cp environment-variable-filename gs://bucket-name/folder-name/

設定 Identity and Access Management (IAM) 角色

Dataproc Hub 提供下列身分,每個角色可執行的操作如下:

  • 管理員:建立 Dataproc Hub 執行個體
  • 資料和機器學習使用者:存取 Dataproc Hub UI
  • Dataproc Hub 服務帳戶:代表 Dataproc Hub
  • Managed Service for Apache Spark 服務帳戶:代表 Dataproc Hub 建立的 Managed Service for Apache Spark 叢集。

每個身分都必須具備特定角色或權限,才能執行相關工作。下表摘要列出各身分所需的 IAM 角色和權限。

身分 類型 角色或權限
Dataproc Hub 管理員 使用者或服務帳戶 roles/notebooks.admin
Dataproc Hub 使用者 使用者 notebooks.instances.usedataproc.clusters.use
Dataproc Hub 服務帳戶 roles/dataproc.hubAgent
Dataproc 服務帳戶 roles/dataproc.worker

建立 Dataproc Hub 執行個體

  1. 事前準備:如要透過 Google Cloud 控制台建立 Managed Service for Apache Spark Hub 執行個體,使用者帳戶必須具備 compute.instances.create 權限。此外,執行個體的服務帳戶 (Compute Engine 預設服務帳戶,或「IAM & admin」(IAM 與管理) >「Service Accounts」(服務帳戶) 中列出的使用者指定服務帳戶 (請參閱「Managed Service for Apache Spark VM 服務帳戶」) 必須具備 iam.serviceAccounts.actAs 權限。

  2. 在 Google Cloud 控制台依序前往「Dataproc」→「Workbench」頁面,然後選取「使用者管理的筆記本」分頁標籤。

  3. 如果系統未預先選取「Environment:Dataproc Hub」(環境:Dataproc Hub) 做為篩選器,請按一下「Filter」(篩選器) 方塊,然後選取「Environment:Dataproc Hub」(環境:Dataproc Hub)。

  4. 依序按一下「New Notebook」(新增筆記本) →「Dataproc Hub」

  5. 在「Create a user-managed notebook」(建立由使用者管理的筆記本) 頁面中,提供下列資訊:

    1. 筆記本名稱:Dataproc Hub 執行個體名稱。
    2. 「Region」(區域):選取 Dataproc Hub 執行個體的區域。這個 Dataproc Hub 執行個體產生的 Apache Spark 叢集也會在這個區域中建立。
    3. 區域:選取所選地區內的區域。
    4. 環境:
      1. Environment:選取 Dataproc Hub
      2. Select a script to run after creation (選用):您可以插入或瀏覽並選取初始化動作指令碼或執行檔,在產生的 Managed Service for Apache Spark 叢集上執行。
      3. Populate Dataproc Hub (optional):按一下「Populate」(填入) 開啟表單,即可設定每個中樞環境變數 (如需各變數的說明,請參閱「設定 Dataproc Hub 執行個體環境變數」)。對於任何未設定的環境變數,Managed Service for Apache Spark 會使用預設值。或者,您也可以設定中繼資料 key:value 組合來設定環境變數 (請參閱下一個項目)。
      4. Metadata
        1. 如果您已建立包含中樞環境變數設定的文字檔 (請參閱「設定中樞環境變數」),請提供檔案名稱做為 key,並提供檔案的 gs://bucket-name/folder-name/environment-variable-filename Cloud Storage 位置做為 value。對於任何未設定的環境變數,Managed Service for Apache Spark 會使用預設值。
    5. 機器設定:
      1. Machine Type:選取 Compute Engine 機型
      2. 設定其他機器設定選項。
    6. 其他選項:
      1. 您可以展開「Disks」(磁碟)、「Networking」(網路)、「Permission」(權限)、「Security」(安全性),以及「Environment upgrade and system health」(環境升級與系統健康狀態) 部分,然後設定或替換預設值。
    7. 按一下「Create」(建立),啟動 Dataproc Hub 執行個體。
  6. 建立 Dataproc Hub 執行個體後,系統會啟用「Open JupyterLab」(開啟 JupyterLab) 連結。使用者點按這個連結,即可開啟 JupyterHub 伺服器頁面,以便設定及建立 Managed Service for Apache Spark JupyterLab 叢集 (請參閱「使用 Dataproc Hub」)。

清除所用資源

刪除 Dataproc Hub 執行個體

  • 如要刪除 Dataproc Hub 執行個體,請按照下列步驟操作:
    gcloud compute instances delete --project=${PROJECT} ${INSTANCE_NAME}
    

刪除 bucket

  • 如要刪除您在「事前準備」中建立的 Cloud Storage bucket,包括儲存在 bucket 中的資料檔案,請按照下列步驟操作:
    gcloud storage rm gs://${BUCKET_NAME} --recursive
    

後續步驟