Menjadwalkan Alur Kerja

Tutorial ini menunjukkan cara menggunakan Cloud Scheduler untuk menjalankan Workflows secara otomatis sehingga alur kerja berjalan sesuai jadwal tertentu, dalam hal ini setiap 5 menit.

Tujuan

1. Membuat dan men-deploy alur kerja yang dapat menerima argumen runtime.
2. Buat tugas Cloud Scheduler yang memicu alur kerja Anda dan menjalankannya setiap 5 menit, dengan meneruskan argumen JSON dalam format yang benar.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

• App Engine
• Cloud Scheduler
• Workflows

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Sebelum memulai

1. Siapkan lingkungan Anda untuk Cloud Scheduler, termasuk membuat aplikasi App Engine.

2. Aktifkan Workflows API, jika belum diaktifkan.

   Peran yang diperlukan untuk mengaktifkan API

   Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Service Usage Admin (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

   Mengaktifkan API

3. Setel lokasi default yang digunakan dalam tutorial ini:

     gcloud config set workflows/location REGION

   Ganti REGION dengan lokasi Workflows yang didukung pilihan Anda.
4. Buat akun layanan untuk Workflows yang akan digunakan; misalnya, sa-name.

     gcloud iam service-accounts create sa-name

5. Berikan peran workflows.invoker ke akun layanan Anda agar akun tersebut memiliki izin untuk memicu alur kerja Anda:

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member "serviceAccount:sa-name@PROJECT_ID." \
         --role "roles/workflows.invoker"

Ganti PROJECT_ID dengan project ID Google Cloud Anda.
6. Berikan peran logging.logWriter ke akun layanan.

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member "serviceAccount:sa-name@PROJECT_ID." \
         --role "roles/logging.logWriter"

Membuat alur kerja yang menerima argumen runtime

Definisi alur kerja terdiri dari serangkaian langkah yang dijelaskan menggunakan sintaksis workflows, yang dapat ditulis dalam format YAML atau JSON. Setelah membuat alur kerja, Anda men-deploy alur kerja tersebut agar tersedia untuk dieksekusi.

Konsol

1. Di konsol Google Cloud , buka halaman Workflows:

   Buka Workflows

2. Klik Create.

3. Masukkan myFirstWorkflow sebagai nama untuk alur kerja baru Anda.

4. Pilih us-east1 untuk region.

5. Pilih akun layanan yang Anda buat sebelumnya.

6. Klik Berikutnya.

7. Dalam editor alur kerja, masukkan definisi berikut untuk alur kerja Anda.

   YAML

   main:
     params: [args]
     steps:
       - step1:
           assign:
             - outputVar: ${"Hello, " + args.firstName + " " + args.lastName + "!"}
       - step2:
           return: ${outputVar}

   JSON

   {
     "main": {
       "params": [
         "args"
       ],
       "steps": [
         {
           "step1": {
             "assign": [
               {
                 "outputVar": "${\"Hello \" + args.firstName + \" \" + args.lastName}"
               }
             ]
           }
         },
         {
           "step2": {
             "return": "${outputVar}"
           }
         }
       ]
     }
   }
     

   Alur kerja ini menampilkan salam "Halo" kepada seseorang yang nama depan dan belakangnya Anda teruskan sebagai argumen runtime.

8. Klik Deploy.

gcloud

1. Buka terminal.

2. Simpan definisi alur kerja berikut sebagai file YAML atau JSON, seperti myFirstWorkflow.yaml atau myFirstWorkflow.json.

   YAML

   main:
     params: [args]
     steps:
       - step1:
           assign:
             - outputVar: ${"Hello, " + args.firstName + " " + args.lastName + "!"}
       - step2:
           return: ${outputVar}

   JSON

   {
     "main": {
       "params": [
         "args"
       ],
       "steps": [
         {
           "step1": {
             "assign": [
               {
                 "outputVar": "${\"Hello \" + args.firstName + \" \" + args.lastName}"
               }
             ]
           }
         },
         {
           "step2": {
             "return": "${outputVar}"
           }
         }
       ]
     }
   }
     

   Alur kerja ini menampilkan salam "Halo" kepada seseorang yang nama depan dan belakangnya Anda teruskan sebagai argumen runtime.

3. Deploy alur kerja dengan memasukkan perintah berikut:

   gcloud workflows deploy myFirstWorkflow \
       --location=us-east1 \
       --source=myFirstWorkflow.yaml_OR_json \
       --service-account=sa-name@PROJECT_ID.

   Ganti yaml_OR_json dengan yaml atau json, bergantung pada format file definisi Workflows yang Anda buat sebelumnya.

Menjadwalkan alur kerja

Buat tugas Cloud Scheduler yang memicu alur kerja Anda, menggunakan akun layanan yang Anda buat sebelumnya.

Konsol

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

   Buka Cloud Scheduler

2. Klik Create Job.

3. Tetapkan Name ke my-workflow-job.

4. Untuk Region, pilih us-east1 (South Carolina).

5. Untuk Frequency, masukkan:

   */5 * * * *

   Tindakan ini akan menjalankan tugas setiap 5 menit. Interval ditentukan menggunakan format unix-cron.

6. Untuk Timezone, pilih negara dan zona waktu.

   Misalnya, pilih Amerika Serikat dan Los Angeles atau Waktu Musim Panas Pasifik (PDT).

7. Klik Lanjutkan.

8. Untuk Target type, pilih HTTP.

9. Untuk URL, masukkan:

   https://workflowexecutions.googleapis.com/v1/projects/PROJECT_ID/locations/us-east1/workflows/myFirstWorkflow/executions
   

10. Biarkan HTTP method pada default POST.

11. Tambahkan dua header HTTP berikut:

    • Name: Content-Type dan Value: application/octet-stream
    • Name: User-Agent dan Value: Google-Cloud-Scheduler

12. Untuk Body, masukkan:

    {"argument": "{\"firstName\":\"Sherlock\", \"lastName\":\"Holmes\"}"}
    

    Tindakan ini akan meneruskan encoding JSON dari argumen alur kerja; dalam hal ini, nama depan, "Sherlock", dan nama belakang, "Holmes". Tanda petik ganda di dalam string di-escape menggunakan garis miring terbalik (\).

13. Untuk header Auth, pilih Tambahkan token OAuth.

14. Masukkan akun layanan yang Anda buat sebelumnya.

    sa-name@PROJECT_ID.
    

    Anda tidak perlu menentukan Scope karena default https://www.googleapis.com/auth/cloud-platform akan digunakan.

15. Setujui semua setelan default lainnya, lalu klik Create.

gcloud

Jadwalkan tugas bernama my-workflow-job dengan memasukkan perintah berikut:

gcloud scheduler jobs create http my-workflow-job \
    --location="us-east1" \
    --schedule="*/5 * * * *" \
    --uri="https://workflowexecutions.googleapis.com/v1/projects/PROJECT_ID/locations/us-east1/workflows/myFirstWorkflow/executions" \
    --message-body="{\"argument\": \"{\\\"firstName\\\":\\\"Sherlock\\\", \\\"lastName\\\":\\\"Holmes\\\"}\"}" \
    --time-zone="America/Los_Angeles" \
    --oauth-service-account-email="sa-name@PROJECT_ID."

Interval ditentukan menggunakan format unix-cron.

Flag message-body digunakan untuk meneruskan encoding JSON dari argumen alur kerja; dalam hal ini, nama depan, "Sherlock", dan nama belakang, "Holmes". Tanda kutip ganda di dalam string di-escape menggunakan garis miring terbalik (\).

Alur kerja Anda kini dijalankan setiap 5 menit.

Untuk mengetahui informasi selengkapnya tentang flag gcloud scheduler, serta cara menerapkan logging panggilan sehingga setiap langkah panggilan selama eksekusi alur kerja Anda dicatat ke dalam log, lihat Menjadwalkan alur kerja dan referensi gcloud.

Catatan: Setiap eksekusi alur kerja dikenai biaya, seperti yang dijelaskan dalam Harga Workflows. Agar tidak dikenai biaya dari alur kerja terjadwal, hapus tugas Cloud Scheduler. Untuk mencegah eksekusi alur kerja duplikat saat Cloud Scheduler mencoba ulang tugas, lihat Mencegah permintaan duplikat ke target API Google Cloud .

Menjalankan tugas dan memverifikasi hasilnya

Konsol

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

   Buka Cloud Scheduler

   Jika tugas tidak ditampilkan, Anda mungkin perlu memuat ulang halaman.

2. Untuk tugas bernama my-workflow-job, klik Run now.

   Anda akan melihat nilai Result diperbarui menjadi Success.

3. Di konsol Google Cloud , buka halaman Workflows:

   Buka Workflows

4. Dari daftar alur kerja, klik myFirstWorkflow untuk membuka halaman detailnya.

   Status eksekusi alur kerja Anda akan menjadi Succeeded.

5. Klik ID eksekusi alur kerja untuk membuka halaman detail dan melihat hasil alur kerja di panel Output.

   Output-nya akan berupa "Hello, Sherlock Holmes!".

gcloud

1. Jalankan tugas Cloud Scheduler untuk menjalankan alur kerja:

   gcloud scheduler jobs run my-workflow-job --location="us-east1"
   

2. Ambil ID eksekusi untuk alur kerja Anda:

   gcloud workflows executions list myFirstWorkflow
   

   Outputnya akan terlihat seperti berikut dengan ID eksekusi yang dicetak tebal:

   projects/316710615161/locations/us-east1/workflows/myFirstWorkflow/executions/138b31e1-f3bb-4ba7-a6da-008d0cb4a320

3. Ambil hasil eksekusi alur kerja:

   gcloud workflows executions describe EXECUTION_ID --workflow myFirstWorkflow

   Ganti EXECUTION_ID dengan ID eksekusi yang ditampilkan di langkah sebelumnya.

   Output akan terlihat seperti berikut:

   argument: '{"firstName":"Sherlock","lastName":"Holmes"}'
   endTime: '2021-09-09T15:15:00.869350639Z'
   name: projects/316710615161/locations/us-east1/workflows/myFirstWorkflow/executions/138b31e1-f3bb-4ba7-a6da-008d0cb4a320
   result: '"Hello, Sherlock Holmes!"'
   startTime: '2021-09-09T15:15:00.839175480Z'
   state: SUCCEEDED
   workflowRevisionId: 000001-4f9

Selamat! Anda telah berhasil membuat tugas Cloud Scheduler yang otomatis menjalankan alur kerja sesuai jadwal tertentu.

Pembersihan

Setelah menyelesaikan tutorial, Anda dapat membersihkan resource yang dibuat agar tidak lagi menggunakan kuota dan menimbulkan tagihan. Bagian berikut menjelaskan cara menghapus atau menonaktifkan resource ini.

Menghapus project

Cara termudah untuk menghilangkan penagihan adalah dengan menghapus project yang Anda buat untuk tutorial.

Untuk menghapus project:

Perhatian: Menghapus project memiliki efek berikut:

• Semua hal dalam project akan dihapus. Jika Anda menggunakan project yang ada untuk mengerjakan tugas di dokumen ini, saat Anda menghapusnya, pekerjaan lain dalam project tersebut juga akan dihapus.
• Project ID kustom akan hilang. Saat membuat project ini, Anda mungkin juga membuat project ID kustom yang masih ingin digunakan pada masa mendatang. Agar tidak kehilangan URL yang menggunakan project ID tersebut, seperti URL appspot.com, hapus resource yang dipilih di dalam project, bukan menghapus seluruh project.

Jika Anda berencana mempelajari beberapa arsitektur, tutorial atau panduan memulai, dengan menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di konsol Google Cloud , buka halaman Manage resources.

   Buka Kelola resource

2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Menghapus tugas Cloud Scheduler

1. Buka halaman Cloud Scheduler di konsol Google Cloud .

   Buka Cloud Scheduler

2. Centang kotak di samping tugas Anda.

3. Klik Hapus di bagian atas halaman dan konfirmasi penghapusan Anda.

Menghapus alur kerja Workflows

1. Buka halaman Workflows di konsol Google Cloud .

   Buka Workflows

2. Pilih alur kerja Anda.

3. Klik Delete di bagian atas halaman; ketik nama alur kerja Anda, dan konfirmasi penghapusan.

Menonaktifkan aplikasi App Engine

Menonaktifkan aplikasi App Engine akan menghentikan aplikasi Anda menjalankan instance dan melayani permintaan, sekaligus mempertahankan data dan setelan aplikasi.

1. Buka halaman Application settings di konsol Google Cloud .

   Buka Setelan aplikasi

2. Klik Disable application.

3. Ikuti petunjuknya.

Langkah berikutnya

• Pelajari Workflows lebih lanjut.