Mengonfigurasi sandbox untuk tugas

Sandbox Cloud Run menyediakan lingkungan yang cepat, aman, dan terisolasi untuk mengeksekusi kode agen, melakukan transformasi data, dan menjalankan skrip dengan aman dalam tugas yang ada. Sandbox sangat dioptimalkan untuk latensi dan berjalan dalam instance yang sama dengan container Anda, yang berbagi CPU dan memori yang dialokasikan.

Halaman ini menjelaskan cara mengonfigurasi sandbox di container Anda. Untuk mengetahui detail tentang cara menulis kode untuk berinteraksi dengan sandbox menggunakan CLI, lihat Eksekusi kode di Cloud Run.

Sebelum memulai

  1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
  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. 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

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

  6. Instal dan lakukan inisialisasi gcloud CLI.
  7. Membuat tugas Cloud Run.

Peran yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk mengonfigurasi tugas Cloud Run, minta administrator untuk memberi Anda peran IAM berikut:

Untuk mengetahui daftar peran dan izin IAM yang terkait dengan Cloud Run, lihat Peran IAM Cloud Run dan Izin IAM Cloud Run. Jika tugas Cloud Run Anda berinteraksi dengan Google Cloud API, seperti Library Klien Cloud, lihat panduan konfigurasi identitas layanan. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat izin deployment dan mengelola akses.

Mengaktifkan sandbox

Untuk mengaktifkan sandbox di tugas Cloud Run, gunakan Google Cloud CLI, konfigurasi YAML, atau Terraform:

gcloud

Untuk membuat atau memperbarui tugas, tentukan flag --sandbox-launcher:

  • Untuk membuat tugas, jalankan perintah berikut:

    gcloud beta run jobs create JOB --image IMAGE_URL --sandbox-launcher

    Ganti kode berikut:

    • JOB: nama tugas Cloud Run Anda.
    • IMAGE_URL: referensi ke image container—misalnya, us-docker.pkg.dev/cloudrun/container/job:latest
  • Untuk memperbarui tugas yang ada, jalankan perintah berikut:

    gcloud beta run jobs update JOB --sandbox-launcher

YAML

  1. Jika Anda membuat tugas baru, lewati langkah ini. Jika Anda mengupdate tugas yang ada, download konfigurasi YAML-nya:

    gcloud run jobs describe JOB --format export > job.yaml
  2. Perbarui file YAML Anda untuk menyertakan atribut sandboxLauncher yang ditetapkan ke true di dalam konfigurasi container:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
                sandboxLauncher: true
    

    Ganti kode berikut:

    • JOB: nama tugas Cloud Run Anda.
    • CONTAINER: nama container Anda.
    • IMAGE_URL: referensi ke image container—misalnya, us-docker.pkg.dev/cloudrun/container/job:latest
  3. Buat atau update tugas menggunakan perintah berikut:

    gcloud run jobs replace job.yaml

    Perintah gcloud run jobs replace secara default menggunakan file job.yaml jika ada.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Tambahkan kode berikut ke resource google_cloud_run_v2_job dalam konfigurasi Terraform Anda:
resource "google_cloud_run_v2_job" "default" {
  name     = "JOB"
  location = "REGION"

  template {
    template {
      containers {
        image            = "IMAGE_URL"
        sandbox_launcher = true
      }
    }
  }
}

Ganti kode berikut:

  • JOB: nama tugas Cloud Run Anda.
  • REGION: region Google Cloud . Misalnya, europe-west1.
  • IMAGE_URL: referensi ke image container—misalnya, us-docker.pkg.dev/cloudrun/container/job:latest

Sandbox berbagi CPU dan memori yang dialokasikan ke container host. Pastikan batas CPU dan memori container utama Anda dapat mengakomodasi aplikasi dan sandbox aktif yang Anda jalankan secara bersamaan.

Menonaktifkan sandbox

Untuk menonaktifkan kemampuan meluncurkan sandbox dalam tugas Anda, gunakan Google Cloud CLI atau konfigurasi YAML:

gcloud

Perbarui tugas menggunakan flag --no-sandbox-launcher dengan menjalankan perintah berikut:

gcloud beta run jobs update JOB --no-sandbox-launcher

Ganti JOB dengan nama tugas Anda.

YAML

  1. Jika Anda membuat tugas baru, lewati langkah ini. Jika Anda mengupdate tugas yang ada, download konfigurasi YAML-nya:

    gcloud run jobs describe JOB --format export > job.yaml
  2. Perbarui file YAML Anda untuk menghapus atribut sandboxLauncher di dalam konfigurasi container:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
    

    Ganti kode berikut:

    • JOB: nama tugas Cloud Run Anda.
    • CONTAINER: nama container Anda.
    • IMAGE_URL: referensi ke image container—misalnya, us-docker.pkg.dev/cloudrun/container/job:latest
  3. Buat atau update tugas menggunakan perintah berikut:

    gcloud run jobs replace job.yaml

    Perintah gcloud run jobs replace secara default menggunakan file job.yaml jika ada.

Melihat setelan sandbox

Untuk melihat setelan sandbox saat ini untuk tugas Cloud Run Anda:

Konsol

  1. Di konsol Google Cloud , buka halaman Tugas Cloud Run:

    Buka tugas Cloud Run

  2. Klik tugas untuk membuka halaman Job details.

  3. Dari tab History, klik ID tugas yang dijalankan dari daftar.

  4. Di tab Containers, cari setelan Sandbox launcher untuk melihat apakah container dengan sandbox diaktifkan atau dinonaktifkan.

gcloud

  1. Gunakan perintah berikut:

    gcloud run jobs executions describe EXECUTION_NAME --format yaml

    Ganti EXECUTION_NAME dengan nama eksekusi tugas.

  2. Untuk memverifikasi bahwa container dengan sandbox diaktifkan, temukan atribut sandboxLauncher: true dalam konfigurasi yang ditampilkan.

Untuk menjalankan kode yang tidak tepercaya di sandbox dari tugas Anda, lihat Eksekusi kode di Cloud Run.

Mengonfigurasi template sandbox

Template sandbox memungkinkan Anda menentukan image container untuk sandbox. Alih-alih menjalankan sesi sandbox di dalam container aplikasi utama, perintah sandbox do --template dan sandbox run --template meluncurkan container baru menggunakan image yang Anda tentukan, seperti Python, Node.js, atau lingkungan eksekusi kustom. Sandbox ini berjalan di container-nya sendiri dan berbagi batas CPU dan memori container utama. Anda tidak dapat menetapkan batas CPU dan memori terpisah untuk template. Cloud Run mendukung hingga 10 template sandbox. Pemasangan volume harus merujuk ke volume dalam memori di resource Cloud Run Anda. Template sandbox menyediakan kemampuan berikut:

  • Image container khusus: Deklarasikan image container yang berbeda, seperti python:3.12-slim atau busybox:latest, sebagai template sandbox. Anda juga dapat menggunakan runtime dan alat lain untuk sandbox yang tidak diperlukan di container utama Anda. Hal ini membuat container utama Anda tetap ringan dengan mengisolasi alat dan runtime yang hanya digunakan untuk sandbox.

  • Pembuatan instance on-demand: CLI sandbox (/usr/local/gcp/bin/sandbox) memunculkan container sandbox baru dari template tanpa menyediakan VM baru atau menagih instance baru.

  • Berbagi file terisolasi per sandbox: Bagikan volume dalam memori antara container utama dan beberapa sandbox sekaligus membatasi setiap sandbox ke subdirektori terisolasinya sendiri untuk mencegah sandbox melihat atau mengubah file lain.

Anda dapat mengonfigurasi template sandbox menggunakan konfigurasi YAML atau Cloud Run Admin API:

YAML

  1. Jika Anda membuat tugas baru, lewati langkah ini. Jika Anda mengupdate tugas yang ada, download konfigurasi YAML-nya:

    gcloud run jobs describe JOB --format export > job.yaml
  2. Update file YAML tugas Anda untuk menyertakan konfigurasi template sandboxes:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: IMAGE_URL
                sandboxLauncher: true
                volumeMounts:
                - name: VOLUME_NAME
                  mountPath: CONTAINER_MOUNT_PATH
              volumes:
              - name: VOLUME_NAME
                emptyDir:
                  medium: Memory
              sandboxes:
                templates:
                - name: TEMPLATE_NAME
                  image: TEMPLATE_IMAGE_URL
                  volumeMounts:
                  - name: VOLUME_NAME
                    mountPath: SANDBOX_MOUNT_PATH
                    subPath: SUBPATH
    

    Ganti kode berikut:

    • JOB: nama tugas Cloud Run Anda.

    • IMAGE_URL: URL image container yang akan digunakan untuk container utama.
    • TEMPLATE_NAME: nama template.
    • TEMPLATE_IMAGE_URL: URL image container yang akan digunakan untuk template sandbox.
    • Opsional: VOLUME_NAME: nama volume yang akan dipasang.
    • Opsional: CONTAINER_MOUNT_PATH: jalur tempat volume dipasang di dalam container utama.
    • Opsional: SANDBOX_MOUNT_PATH: jalur tempat volume dipasang di dalam container sandbox.
    • Opsional: SUBPATH: jalur subdirektori relatif dalam volume yang akan dipasang ke container sandbox, seperti my-subdir. Untuk menetapkan subdirektori yang berbeda untuk setiap sandbox saat runtime, gunakan placeholder $(VARIABLE_NAME), seperti $(SANDBOX_DIR):
      • VARIABLE_NAME hanya boleh berisi huruf ASCII dan garis bawah; angka dan tanda hubung tidak didukung.
      • Untuk me-resolve placeholder saat runtime, teruskan flag --template-var=VARIABLE_NAME=VALUE bersama dengan --template.
      • subPath tidak membuat direktori secara otomatis. Buat direktori SUBPATH yang di-resolve dalam volume dari container utama, misalnya menggunakan mkdir -p, sebelum menjalankan sandbox do atau sandbox run.
  3. Buat atau update tugas menggunakan perintah berikut:

    gcloud run jobs replace job.yaml

    Perintah gcloud run jobs replace secara default menggunakan file job.yaml jika ada.

REST API

Untuk mengonfigurasi template sandbox, kirim permintaan PATCH ke Cloud Run Admin API:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X PATCH \
"https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB" \
-d '{
  "launchStage": "BETA",
  "template": {
    "template": {
      "containers": [
        {
          "image": "IMAGE_URL",
          "sandboxLauncher": true,
          "volumeMounts": [
            {
              "name": "VOLUME_NAME",
              "mountPath": "CONTAINER_MOUNT_PATH"
            }
          ]
        }
      ],
      "sandboxes": {
        "templates": [
          {
            "name": "TEMPLATE_NAME",
            "image": "TEMPLATE_IMAGE_URL",
            "volumeMounts": [
              {
                "name": "VOLUME_NAME",
                "mountPath": "SANDBOX_MOUNT_PATH",
                "subPath": "SUBPATH"
              }
            ]
          }
        ]
      },
      "volumes": [
        {
          "name": "VOLUME_NAME",
          "emptyDir": {
            "medium": "MEMORY"
          }
        }
      ]
    }
  }
}'

Ganti kode berikut:

  • JOB: nama tugas Cloud Run Anda.

  • PROJECT_ID: Project ID Google Cloud Anda.
  • REGION: region tempat resource Cloud Run Anda di-deploy.
  • IMAGE_URL: URL image container yang akan digunakan untuk container utama.
  • TEMPLATE_NAME: nama template.
  • TEMPLATE_IMAGE_URL: URL image container yang akan digunakan untuk template sandbox.
  • Opsional: VOLUME_NAME: nama volume yang akan dipasang.
  • Opsional: CONTAINER_MOUNT_PATH: jalur tempat volume dipasang di dalam container utama.
  • Opsional: SANDBOX_MOUNT_PATH: jalur tempat volume dipasang di dalam container sandbox.
  • Opsional: SUBPATH: jalur subdirektori relatif dalam volume yang akan dipasang ke container sandbox, seperti my-subdir. Untuk menetapkan subdirektori yang berbeda untuk setiap sandbox saat runtime, gunakan placeholder $(VARIABLE_NAME), seperti $(SANDBOX_DIR):
    • VARIABLE_NAME hanya boleh berisi huruf ASCII dan garis bawah; angka dan tanda hubung tidak didukung.
    • Untuk me-resolve placeholder saat runtime, teruskan flag --template-var=VARIABLE_NAME=VALUE bersama dengan --template.
    • subPath tidak membuat direktori secara otomatis. Buat direktori SUBPATH yang di-resolve dalam volume dari container utama, misalnya menggunakan mkdir -p, sebelum menjalankan sandbox do atau sandbox run.

Untuk menjalankan template menggunakan CLI dari dalam container tugas, lihat Menjalankan perintah menggunakan template sandbox.