Mengelola kumpulan agen

Kumpulan agen adalah kumpulan agen yang menggunakan konfigurasi yang sama, dengan akses dan visibilitas seragam ke sumber dan tujuan. Kumpulan agen juga memberikan kontrol atas batas bandwidth transfer.

Semua agen harus tergabung dalam kumpulan agen.

Panduan ini menjelaskan cara menggunakan kumpulan agen.

Sebelum memulai

Anda harus memiliki izin yang benar pada project agar dapat bekerja dengan kumpulan agen. Baca Kontrol akses dengan IAM untuk mengetahui detailnya.

Anda dapat melihat izin Anda saat ini.

Untuk menggunakan perintah gcloud, instal alat command line gcloud.

Membuat kumpulan agen

Jangan sertakan informasi sensitif seperti informasi identitas pribadi (PII) atau data keamanan di nama kumpulan agen Anda. Nama resource dapat diterapkan ke nama resource Google Cloud lainnya dan mungkin terekspos ke sistem internal Google di luar project Anda.

Untuk membuat kumpulan agen:

Konsol Google Cloud

  1. Di konsol Google Cloud, buka halaman Kumpulan agen.

    Buka Kumpulan agen

    Halaman Kumpulan agen akan ditampilkan, yang mencantumkan kumpulan agen yang ada.

  2. Klik Buat kumpulan lainnya.

  3. Beri nama kumpulan Anda, dan deskripsikan secara opsional.

  4. Anda dapat memilih untuk menetapkan batas bandwidth yang akan berlaku untuk kumpulan tersebut secara keseluruhan. Bandwidth yang ditentukan dalam MB/d akan dibagi untuk semua agen dalam kumpulan. Baca bagian Mengelola bandwidth jaringan untuk mengetahui informasi selengkapnya.

  5. Klik Create.

REST API

Gunakan projects.agentPools.create:

POST https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools?agent_pool_id=AGENT_POOL_ID

Dengan keterangan:

  • PROJECT_ID: Project ID tempat Anda membuat kumpulan agen.
  • AGENT_POOL_ID: ID kumpulan agen yang Anda buat.

Jika kumpulan agen terhenti di status Creating selama lebih dari 30 menit, sebaiknya hapus kumpulan agen dan buat lagi.

Mencabut izin Storage Transfer Service yang diperlukan dari sebuah project saat kumpulan agen berada dalam status Creating akan menyebabkan perilaku layanan yang salah.

gcloud CLI

Untuk membuat kumpulan agen dengan alat command line gcloud, jalankan gcloud transfer agent-pools create.

gcloud transfer agent-pools create NAME \
  [--no-async] \
  [--bandwidth-limit=BANDWIDTH_LIMIT] \
  [--display-name=DISPLAY_NAME]

Tempat opsi berikut tersedia:

  • NAME adalah ID permanen yang unik untuk kumpulan ini.

  • --no-async memblokir tugas lain di terminal Anda hingga kumpulan dibuat. Jika tidak disertakan, pembuatan kumpulan akan berjalan secara asinkron.

  • --bandwidth-limit menentukan jumlah bandwidth Anda dalam MB/d yang harus disediakan untuk agen kumpulan ini. Batas bandwidth berlaku untuk semua agen dalam satu kumpulan dan dapat membantu mencegah beban kerja transfer kumpulan mengganggu operasi lain yang menggunakan bandwidth yang sama dengan Anda. Misalnya, masukkan '50' untuk menetapkan batas bandwidth 50 MB/dtk. Dengan membiarkan flag ini tidak ditentukan, agen kumpulan ini akan menggunakan semua bandwidth yang tersedia untuknya.

  • --display-name adalah nama yang dapat diubah untuk membantu Anda mengidentifikasi kumpulan ini. Anda dapat menyertakan detail yang mungkin tidak sesuai dengan nama resource lengkap kumpulan yang unik.

Menetapkan agen ke kumpulan

Kumpulan agen baru kosong dan harus memiliki agen yang ditetapkan ke kumpulan tersebut. Agen hanya dapat ditetapkan ke kumpulan agen pada saat pembuatan agen.

Jika kumpulan agen tidak ditentukan, agen akan ditetapkan ke kumpulan transfer_service_default.

Untuk membuat agen dan menetapkannya ke kumpulan:

Konsol Google Cloud

  1. Dari halaman Agent pool, pilih kumpulan untuk menetapkan agen.

  2. Klik Instal agen. Panduan penginstalan Agen akan muncul.

  3. Ikuti petunjuk untuk membuat agen di kumpulan agen ini.

gcloud CLI

Untuk menggunakan alat command line gcloud guna membuat agen dan menetapkannya ke kumpulan, jalankan gcloud transfer agents install. Agen harus diinstal pada komputer yang memiliki akses root ke sistem file.

gcloud transfer agents install --pool=AGENT_POOL

Untuk menginstal agen yang akan digunakan dengan sumber yang kompatibel dengan S3, berikan kredensial akses sebagai variabel lingkungan sebagai nilai AWS_ACCESS_KEY_ID dan AWS_SECRET_ACCESS_KEY, atau simpan sebagai kredensial default di file konfigurasi sistem Anda.

export AWS_ACCESS_KEY_ID=ID
export AWS_SECRET_ACCESS_KEY=SECRET
gcloud transfer agents install --pool=POOL_NAME

Baca artikel Mengelola agen transfer untuk mengetahui detail selengkapnya.

Untuk opsi tambahan, lihat Opsi agen lanjutan.

Untuk mengelola agen, lihat Mengelola agen transfer.

Menetapkan kumpulan agen ke tugas

Setelah dibuat, kumpulan agen dapat ditetapkan ke tugas selama pembuatan atau update tugas.

Memperbarui kumpulan agen

Anda dapat memperbarui nama tampilan dan batas bandwidth kumpulan agen.

Untuk memperbarui kumpulan agen:

Konsol Google Cloud

Di konsol Google Cloud, buka halaman Kumpulan agen.

Buka Kumpulan agen

Anda dapat mengedit item berikut:

  • Nama tampilan kumpulan agen: Klik Edit di samping nama Kumpulan agen saat ini.

  • Batas bandwidth kumpulan agen: Klik Setel batas bandwidth, dan masukkan batas bandwidth baru pada dialog Setel batas bandwidth. Klik Tetapkan Batas untuk menerapkan batas bandwidth baru. Bandwidth dibagikan kepada semua agen dalam kumpulan.

REST API

Untuk memperbarui kumpulan agen, gunakan projects.agentPools.patch dengan mask kolom dari kolom yang akan diperbarui. Kolom kumpulan agen berikut dapat diperbarui:

Misalnya, untuk memperbarui displayName menjadi my-transfer, Anda harus menyediakan mask kolom "displayName,my-transfer".

Berikut adalah contoh permintaan patch untuk memperbarui nama tampilan:

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"displayName,NEW_NAME"

Dengan keterangan:

  • PROJECT_ID: Project ID tempat Anda memperbarui kumpulan agen.
  • AGENT_POOL_ID: ID kumpulan agen yang sedang Anda perbarui.
  • NEW_NAME: Nama tampilan baru untuk kumpulan agen ini.

Berikut adalah contoh permintaan patch untuk memperbarui batas bandwidth:

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"bandwidthLimit,NEW_LIMIT"

Dengan keterangan:

  • PROJECT_ID: Project ID tempat Anda memperbarui kumpulan agen.
  • AGENT_POOL_ID: ID kumpulan agen yang sedang Anda perbarui.
  • NEW_LIMIT: Batas bandwidth baru untuk kumpulan agen ini.

gcloud CLI

Untuk menggunakan alat command line gcloud guna mengupdate kumpulan agen, jalankan gcloud transfer agent-pools update.

gcloud transfer agent-pools update NAME \
  [--bandwidth-limit=NEW_BANDWIDTH_LIMIT] [--clear-bandwidth-limit] \
  [--clear-display-name] [--display-name=NEW_DISPLAY_NAME]

Diperlukan argumen berikut:

  • NAME adalah ID unik dan permanen untuk kumpulan ini. NAME mengidentifikasi kumpulan agen untuk diperbarui, dan tidak dapat diperbarui sendiri.

Flag berikut dapat ditentukan dengan perintah ini:

  • --bandwidth-limit dapat diperbarui atau dihapus dengan menentukan --clear-bandwidth-limit. Lihat Membuat kumpulan agen untuk mengetahui detail selengkapnya tentang batas bandwidth.

  • --display-name dapat diperbarui, atau dihapus dengan flag --clear-display-name.

Menghapus kumpulan agen

Anda dapat menghapus kumpulan agen yang tidak memiliki agen aktif dan tidak ada tugas aktif yang berjalan.

Untuk menghapus kumpulan agen:

Konsol Google Cloud

  1. Di konsol Google Cloud, buka halaman Kumpulan agen.

    Buka Kumpulan agen

  2. Klik Delete. Baca pop-up, lalu klik Delete untuk mengonfirmasi.

    Jika tombol hapus tidak aktif, Anda harus menghentikan semua agen dan tugas yang terkait dengan kumpulan ini.

REST API

Gunakan projects.agentPools.delete:

DELETE https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

Dengan keterangan:

  • PROJECT_ID: Project ID tempat Anda menghapus kumpulan agen.

gcloud CLI

Untuk menggunakan alat command line gcloud guna menghapus kumpulan agen, jalankan gcloud transfer agent-pools delete.

gcloud transfer agent-pools delete NAME

Diperlukan argumen berikut:

  • NAME adalah ID unik dan permanen untuk kumpulan ini.

Sebelum Anda dapat menghapus kumpulan, semua agen dalam kumpulan harus dihentikan, tugas kumpulan harus dinonaktifkan, dan tidak boleh ada operasi transfer yang sedang berlangsung untuk kumpulan ini.

Untuk melihat semua tugas yang terkait dengan kumpulan, pilih kumpulan tugas Anda di konsol Google Cloud, lalu klik tab Transfer tugas.

Dapatkan kumpulan agen

Untuk mendapatkan kumpulan agen:

Konsol Google Cloud

Di konsol Google Cloud, buka halaman Kumpulan agen.

Buka Kumpulan agen

Halaman ini menampilkan daftar semua kumpulan agen yang terkait dengan project Anda, dan informasi berikut untuk setiap kumpulan agen:

  • Nama kumpulan agen
  • Status koneksi
  • Jumlah agen yang terhubung
  • Batas bandwidth, jika disetel
  • Jumlah tugas transfer yang terkait
  • Nama tampilan kumpulan agen

Untuk melihat kumpulan agen tertentu, klik Name kumpulan agen.

Tindakan berikut tersedia dari halaman informasi kumpulan agen:

  • Instal agen: menampilkan petunjuk untuk menginstal Agen transfer.
  • Agen penghentian: Pilih agen di tabel, lalu klik Hentikan Agen.
  • Membuat daftar tugas transfer: Klik Transfer Tugas untuk menampilkan agen tugas transfer dalam kumpulan ini yang terhubung.

REST API

Gunakan projects.agentPools.get:

GET https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

Dengan keterangan:

  • PROJECT_ID: Project ID yang Anda dapatkan kumpulan agen.

gcloud CLI

Untuk menggunakan alat command line gcloud guna mengambil kumpulan agen, jalankan gcloud transfer agent-pools describe.

gcloud transfer agent-pools describe NAME

Diperlukan argumen berikut:

  • NAME adalah ID unik dan permanen untuk kumpulan ini.

Mencantumkan kumpulan agen

Untuk mencantumkan kumpulan agen:

Konsol Google Cloud

Di konsol Google Cloud, buka halaman Kumpulan agen.

Buka Kumpulan agen

Semua kumpulan agen ditampilkan.

REST API

Gunakan projects.agentPools.list:

GET https://storagetransfer.googleapis.com/v1/projects/{project_id=PROJECT_ID}/agentPools

Dengan keterangan:

  • PROJECT_ID: Project ID yang Anda dapatkan kumpulan agen.

gcloud CLI

Untuk menggunakan alat command line gcloud guna membuat daftar kumpulan agen, jalankan gcloud transfer agent-pools list.

gcloud transfer agent-pools list \
  [--limit=LIMIT] \
  [--names=[NAMES,...]] \
  [--page-size=PAGE_SIZE]

Flag berikut dapat ditentukan dengan perintah ini:

  • --limit menentukan jumlah maksimum kumpulan agen yang akan ditampilkan.

  • --names menentukan nama kumpulan agen yang akan dicantumkan. Pisahkan beberapa nama dengan koma; misalnya, --names=foo,bar. Jika tidak ditentukan, semua kumpulan agen dalam project Anda saat ini akan dicantumkan.

  • --page-size menentukan perilaku pengelompokan untuk perintah ini. Secara default, perintah list mengelompokkan respons ke dalam 256 item, yang secara otomatis mengambil batch berikutnya hingga semua item tercantum atau limit tercapai.

Perintah tersebut menampilkan daftar kumpulan agen yang cocok dan detail konfigurasinya. Contoh berikut menunjukkan contoh respons.

name: projects/my-project-123/agentPools/my-first-pool
state: CREATED
---
bandwidthLimit:
  limitMbps: '120'
displayName: Source A to destination Z.
name: projects/my-project-123/agentPools/a2z-pool
state: CREATED