Menggunakan autentikasi dengan target HTTP

Cloud Scheduler dapat memanggil target HTTP yang memerlukan autentikasi jika Anda menyiapkan akun layanan terkait yang memiliki kredensial yang sesuai.

Menyiapkan akun layanan

Akun layanan biasanya digunakan oleh aplikasi atau beban kerja komputasi dan diidentifikasi oleh alamat emailnya, yang unik untuk akun tersebut.

Aplikasi dapat menggunakan akun layanan untuk melakukan panggilan API yang diotorisasi dengan melakukan autentikasi sebagai akun layanan itu sendiri, dan mengakses semua resource yang diizinkan untuk diakses oleh akun layanan.

Cara paling umum untuk mengizinkan aplikasi melakukan autentikasi sebagai akun layanan adalah dengan memasang akun layanan ke resource yang menjalankan aplikasi. Kemudian, Anda dapat memberikan peran Identity and Access Management (IAM) akun layanan agar akun layanan dapat mengakses resource Google Cloud .

  1. Jika Anda belum memiliki akun layanan yang ingin digunakan untuk tugas Cloud Scheduler dengan target HTTP, buat akun layanan baru. Perhatikan hal berikut:

    • Akun layanan harus merupakan bagian dari project tempat tugas Cloud Scheduler dibuat.

    • Jangan gunakan agen layanan Cloud Scheduler (service-PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com). Agen ini tidak dapat digunakan untuk tujuan ini.

    • Jangan mencabut peran Cloud Scheduler Service Agent (roles/cloudscheduler.serviceAgent) dari agen layanan Cloud Scheduler di project Anda. Tindakan ini akan menghasilkan respons 403 ke endpoint yang memerlukan autentikasi, meskipun akun layanan tugas Anda memiliki peran yang sesuai.

  2. Jika target Anda berada dalam Google Cloud, berikan peran IAM yang diperlukan ke akun layanan Anda. Setiap layanan dalam Google Cloud memerlukan peran tertentu, dan layanan penerima akan otomatis memverifikasi token yang dihasilkan. Misalnya, untuk Cloud Run dan fungsi Cloud Run generasi kedua, Anda harus memberikan peran Cloud Run Invoker.

    Untuk mendapatkan izin yang diperlukan untuk melampirkan akun layanan ke resource, minta administrator untuk memberi Anda peran IAM Pengguna Akun Layanan (roles/iam.serviceAccountUser) di akun layanan. Peran yang telah ditentukan ini berisi izin iam.serviceAccounts.actAs, yang diperlukan untuk melampirkan akun layanan ke resource. (Jika Anda membuat akun layanan, Anda akan otomatis diberi izin ini.)

    Pada langkah sebelumnya, jika Anda secara khusus membuat akun layanan untuk memanggil layanan yang ditargetkan oleh tugas Cloud Scheduler, Anda dapat mengikuti prinsip hak istimewa terendah dengan mengikat akun dan izin pemanggilnya ke layanan target:

    Konsol

    1. Di konsol Google Cloud, pada halaman pemilih project, pilih project Google Cloud.

      Buka pemilih project

    2. Buka halaman untuk jenis resource yang Anda panggil. Misalnya, jika Anda memanggil layanan Cloud Run, buka halaman yang mencantumkan layanan Cloud Run.

    3. Pilih kotak centang di sebelah kiri layanan yang ingin Anda panggil. (Jangan mengklik layanan.)

    4. Klik tab Permissions .

      Jika panel informasi tidak terlihat, Anda mungkin perlu mengklik Tampilkan Panel Info > Izin.

    5. Klik Add principal.

    6. Di kolom New principals, masukkan alamat email untuk akun layanan yang Anda buat.

    7. Dari daftar Select a role, pilih peran yang akan diberikan.

      Ikuti prinsip hak istimewa terendah dengan memilih peran yang hanya menyertakan izin yang diperlukan oleh akun utama Anda.

    8. Klik Save.

    gcloud 

    gcloud RESOURCE_TYPE add-iam-policy-binding RESOURCE_ID \
    --member=PRINCIPAL \
    --role=ROLE

    Ganti kode berikut:

    • RESOURCE_TYPE: jenis resource target Anda. Misalnya, run untuk target Cloud Run.
    • RESOURCE_ID: ID untuk target Anda. Misalnya, nama layanan untuk target Cloud Run.
    • PRINCIPAL: ID untuk akun layanan Anda. Ini memiliki bentuk berikut: serviceAccount:SERVICE_ACCOUNT_EMAIL_ADDRESS. Misalnya, serviceAccount:my-service-account@my-project.iam.gserviceaccount.com.
    • ROLE: nama peran yang diperlukan layanan target Anda untuk pemanggilan. Misalnya, roles/run.invoker untuk target fungsi Cloud Run atau Cloud Run generasi kedua.
    • Parameter opsional lainnya dijelaskan dalam referensi command line gcloud.

    Contoh:

    • Berikan peran IAM Cloud Run Invoker (roles/run.invoker) ke akun layanan my-service-account@my-project.iam.gserviceaccount.com di layanan Cloud Run my-service:

      gcloud run add-iam-policy-binding my-service \
    --member=serviceAccount:my-service-account@my-project.iam.gserviceaccount.com \
    --role=roles/run.invoker

    • Berikan peran IAM Cloud Run Invoker (roles/run.invoker) yang diperlukan oleh fungsi Cloud Run generasi kedua ke akun layanan my-service-account@my-project.iam.gserviceaccount.com pada fungsi Cloud Run my-gen2-function:

      gcloud functions add-iam-policy-binding my-gen2-function \
    --member=serviceAccount:my-service-account@my-project.iam.gserviceaccount.com \
    --role=roles/run.invoker \
    --gen2

  3. Jika target Anda berada di luar Google Cloud, layanan penerima harus memverifikasi token secara manual.

  4. Agen layanan Cloud Scheduler default akan otomatis disiapkan saat Anda mengaktifkan Cloud Scheduler API, kecuali Anda mengaktifkannya sebelum 19 Maret 2019. Jika demikian, Anda harus memberikan peran Agen Layanan Cloud Scheduler. Hal ini agar dapat menghasilkan token header atas nama akun layanan Anda untuk melakukan autentikasi ke target.

Membuat tugas Cloud Scheduler yang menggunakan autentikasi

Untuk mengautentikasi antara Cloud Scheduler dan target HTTP, Cloud Scheduler membuat token header berdasarkan akun layanan klien Anda, yang diidentifikasi oleh emailnya, dan mengirimkannya, menggunakan HTTPS, ke target. Anda dapat menggunakan token ID (OIDC) atau token OAuth (akses). OIDC umumnya digunakan kecuali untuk Google API yang dihosting di *.googleapis.com karena API ini memerlukan token OAuth.

Untuk membuat tugas Cloud Scheduler yang menggunakan autentikasi, Anda harus menambahkan jenis token dan alamat email yang mengidentifikasi akun layanan klien saat membuat tugas:

Konsol

  1. Di konsol Google Cloud, buka halaman Cloud Scheduler.

    Buka Cloud Scheduler

  2. Klik Create job.

  3. Di kolom Nama, masukkan nama untuk tugas Anda yang unik untuk project. Perlu diperhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun menghapus tugas terkaitnya.

  4. Dalam daftar Region, pilih region untuk tugas Anda.

  5. Tentukan Frequency dan Timezone untuk tugas Anda. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron.

  6. Klik Lanjutkan.

  7. Dalam daftar Jenis target, pilih HTTP.

  8. Tentukan URL dan metode HTTP.

  9. Dalam daftar Auth header, pilih jenis token. Token OIDC umumnya digunakan kecuali untuk Google API yang dihosting di *.googleapis.com karena API ini memerlukan token OAuth.

  10. Dalam daftar Service account, pilih email akun layanan Anda.

  11. Secara opsional, tentukan Audiens yang membatasi penerima untuk token OIDC; biasanya, URL target tugas tanpa parameter URL apa pun. Jika tidak ditentukan, seluruh URL akan digunakan sebagai audiens, termasuk parameter permintaan.

  12. Konfigurasikan setelan opsional apa pun.

  13. Klik Buat.

gcloud 

gcloud scheduler jobs create http JOB_ID \
    --schedule="FREQUENCY" \
    --uri=URI \
    --oidc-service-account-email=SERVICE_ACCOUNT_EMAIL

Ganti kode berikut:

  • JOB_ID: nama untuk tugas yang unik untuk project. Perlu diperhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun menghapus tugas terkaitnya.
  • FREQUENCY: interval atau seberapa sering tugas akan dijalankan; misalnya, every 3 hours atau every 10 mins. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron.
  • URI: URL endpoint yang sepenuhnya memenuhi syarat.
  • SERVICE_ACCOUNT_EMAIL: email akun layanan Anda. Token OIDC umumnya digunakan kecuali untuk Google API yang dihosting di *.googleapis.com karena API ini memerlukan token OAuth. (Gunakan flag --oauth-service-account-email untuk menentukan jenis token OAuth.)
  • Parameter opsional lainnya dijelaskan dalam referensi command line gcloud.

Memberikan peran Cloud Scheduler Service Agent

Beberapa layanan Google Cloud memerlukan akses ke resource Anda agar layanan tersebut dapat bertindak atas nama Anda. Untuk memenuhi kebutuhan ini, Google Cloud membuat dan mengelola akun layanan yang dikenal sebagai agen layanan dan dibuat serta diberi peran secara otomatis saat Anda mengaktifkan dan menggunakan layanan Google Cloud.

Agen layanan Cloud Scheduler memerlukan peran Cloud Scheduler Service Agent (roles/cloudscheduler.serviceAgent). Tanpa peran ini, tugas Cloud Scheduler akan gagal. Anda dapat memberikan peran secara manual kepada agen layanan Cloud Scheduler yang memiliki alamat email dengan format berikut:

service-PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com

Anda hanya perlu memberikan peran secara manual jika salah satu hal berikut berlaku:

  • Anda mengaktifkan Cloud Scheduler API sebelum 19 Maret 2019
  • Anda menghapus peran Cloud Scheduler Service Agent dari agen layanan

Anda dapat memverifikasi bahwa agen layanan Cloud Scheduler disiapkan di project dan memiliki peran Agen Layanan Cloud Scheduler yang diberikan dengan melihat akses project saat ini. Perhatikan bahwa jika Anda menggunakan konsol Google Cloud untuk melihat akses project, pastikan untuk memilih kotak centang Sertakan pemberian peran yang diberikan Google.

Untuk mempelajari cara memberikan peran kepada agen layanan, lihat Membuat dan memberikan peran kepada agen layanan.

Langkah selanjutnya

Pelajari cara melakukan autentikasi ke Cloud Scheduler secara terprogram.