Mengonfigurasi lokalitas data menggunakan endpoint regional

Halaman ini menjelaskan endpoint layanan global dan regional Artifact Analysis serta cara menggunakannya.

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Analisis Artefak memiliki endpoint global dan regional.

  • Endpoint global: Secara default, Analisis Artefak mengirim permintaan API ke endpoint global, containeranalysis.googleapis.com. Endpoint global tidak menjamin bahwa data dalam transit tetap berada di lokasi tertentu dan dapat mengambil data Analisis Artefak dari region yang didukung. Data Anda mungkin diproses di luar region tempat data tersebut disimpan.

  • Endpoint regional: Endpoint layanan yang menerapkan batasan regional, memastikan bahwa data disimpan, dikirim, dan diproses di region tertentu. Endpoint regional hanya mengizinkan permintaan dilanjutkan jika resource yang terpengaruh ada di lokasi yang ditentukan oleh endpoint. Endpoint regional menggunakan format berikut:

    containeranalysis.region.rep.googleapis.com.

    Pertimbangkan untuk menggunakan endpoint regional dalam situasi berikut:

    • Aplikasi yang perlu mengakses data Anda tidak berada di lokasi yang dekat secara geografis dengan region tempat data Anda disimpan.

    • Anda menyimpan data di beberapa lokasi dan ingin mengoptimalkan latensi, keandalan, dan ketersediaan.

    • Anda harus mematuhi kebijakan atau peraturan lokalitas data yang mengharuskan Anda memproses data di lokasi yang sama dengan tempat data disimpan.

Data provenance build dan pengesahan disimpan di endpoint global. Hasil pemindaian kerentanan dan data SBOM disimpan di endpoint regional dan multi-regional.

Lokasi yang mendukung endpoint regional

Anda dapat menggunakan endpoint regional untuk sebagian besar region yang didukung Artifact Analysis.

Untuk multi-region dan beberapa region, Analisis Artefak hanya mendukung endpoint global.

Untuk daftar region yang didukung dan endpoint layanan yang didukung untuk setiap region, lihat Lokasi penyimpanan metadata.

Perintah Google Cloud CLI

Saat menggunakan gcloud CLI, ada dua cara untuk mengirim permintaan ke endpoint regional:

  • Menggunakan flag --location.
  • Tetapkan endpoint regional default yang ingin Anda gunakan untuk perintah Analisis Artefak.

Menggunakan flag --location

Anda dapat menggunakan flag --location dengan salah satu perintah berikut untuk mengarahkan permintaan ke endpoint layanan yang sesuai:

Agar berhasil memproses permintaan dengan endpoint regional, lokasi yang ditentukan harus memenuhi persyaratan berikut:

Jika Anda menghilangkan tanda --location atau menentukan lokasi yang tidak mendukung endpoint regional, perintah akan menggunakan endpoint global.

Misalnya, perintah berikut mencantumkan kerentanan untuk image yang disimpan di us-east1:

gcloud artifacts vulnerabilities list --location=us-east1 us-east1-docker.pkg.dev/my-project/my-repo/my-image@sha256:49765698074d6d7baa82f

Menetapkan endpoint default untuk perintah

Secara default, perintah gcloud CLI menggunakan endpoint global. Anda dapat menetapkan endpoint regional default untuk perintah Analisis Artefak sehingga Anda tidak perlu menentukan lokasi dalam setiap perintah.

Pastikan Anda menggunakan gcloud CLI 402.0.0 atau yang lebih baru.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • LOCATION: region tempat metadata Anda disimpan.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud config set api_endpoint_overrides/containeranalysis https://containeranalysis.LOCATION.rep.googleapis.com

Windows (PowerShell)

gcloud config set api_endpoint_overrides/containeranalysis https://containeranalysis.LOCATION.rep.googleapis.com

Windows (cmd.exe)

gcloud config set api_endpoint_overrides/containeranalysis https://containeranalysis.LOCATION.rep.googleapis.com

Menggunakan endpoint regional untuk metode API

Tentukan endpoint regional, bukan endpoint global. Misalnya, contoh berikut mencantumkan kemunculan di region yang ditentukan.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

  • LOCATION: region tempat metadata Anda disimpan.
  • PROJECT_ID: project ID Google Cloud project Anda.

Metode HTTP dan URL: 

GET https://containeranalysis.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/occurrences

Untuk mengirim permintaan, perluas salah satu opsi berikut:

Anda akan melihat respons JSON seperti berikut:

occurrences: [
  {
    name: "projects/my-project/locations/us-east1/occurrences/030b7805-eca4-4739-9a43-ec65ed98c61f"
    resource_uri: "https://us-east1-docker.pkg.dev/my-project/my-repo/my-image@sha256:b487c4da45ce363eef69d9c066fa26f6666e4f3c9c414d98d1e27bfcc949e544"
    note_name: "projects/goog-vulnz/locations/us-east1/notes/CVE-2018-1272"
    kind: VULNERABILITY
    ...
  }

Sebelum transisi ke penyimpanan metadata regional, kemunculan dan catatan tidak menyertakan nama lokasi dalam ID-nya. Karena pemindaian yang lebih baru menyimpan metadata di region, permintaan API yang menggunakan endpoint global atau regional akan menampilkan hasil yang menyertakan ID lokasi.

ID kemunculan sebelum transisi terlihat seperti contoh berikut:

name: "projects/my-project/occurrences/030b7805-eca4-4739-9a43-ec65ed98c61f"

Kejadian yang sama yang disimpan di us-east1 akan terlihat seperti ini:

name: "projects/my-project/locations/us-east1/occurrences/030b7805-eca4-4739-9a43-ec65ed98c61f"

Membatasi penggunaan endpoint API global

Untuk membantu menerapkan penggunaan endpoint regional, gunakan batasan kebijakan organisasi constraints/gcp.restrictEndpointUsage untuk memblokir permintaan ke endpoint API global. Untuk mengetahui informasi selengkapnya, lihat Membatasi penggunaan endpoint.

Langkah berikutnya