Membuat dan mengelola alur kerja

Pratinjau — Environment variables

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Anda dapat membuat dan mengelola alur kerja di konsol Google Cloud, atau menggunakan Google Cloud CLI di terminal atau Cloud Shell. Anda juga dapat mengelola alur kerja melalui Workflows API.

Sebelum memulai

Batasan keamanan yang ditentukan oleh organisasi mungkin mencegah Anda menyelesaikan langkah-langkah berikut. Untuk mengetahui informasi pemecahan masalah, lihat Mengembangkan aplikasi di lingkungan Google Cloud yang terbatas.

Konsol

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Workflows API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Workflows API.

   Enable the API

gcloud

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
2. Install the Google Cloud CLI.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

5. Make sure that billing is enabled for your Google Cloud project.

6. Enable the Workflows API:

   gcloud services enable workflows.googleapis.com

7. Install the Google Cloud CLI.

8. To initialize the gcloud CLI, run the following command:

   gcloud init

9. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

10. Make sure that billing is enabled for your Google Cloud project.

11. Enable the Workflows API:

    gcloud services enable workflows.googleapis.com

REST

Untuk mengelola alur kerja menggunakan Workflows API, sebaiknya Anda menggunakan library klien yang disediakan Google untuk memanggil layanan workflows.googleapis.com. Untuk informasi selengkapnya, lihat Workflows API.

Membuat akun layanan

Akun layanan mewakili identitas alur kerja dan menentukan izin yang dimiliki alur kerja dan resource Google Cloud yang dapat diaksesnya. Buat akun layanan jika Anda belum memilikinya; lalu berikan peran yang diperlukan untuk mengelola alur kerja dan membuat log.

Jika Anda tidak menentukan akun layanan selama pembuatan alur kerja, alur kerja tersebut akan menggunakan akun layanan Compute Engine default untuk identitasnya. Untuk mengetahui informasi selengkapnya, lihat Memberikan izin alur kerja untuk mengakses resource Google Cloud.

Kami sangat merekomendasikan penggunaan akun layanan dengan hak istimewa terendah yang diperlukan untuk mengakses resource yang diperlukan.

Perhatikan bahwa untuk membuat resource dan melampirkan akun layanan, Anda memerlukan izin untuk membuat resource tersebut dan meniru identitas akun layanan yang akan Anda lampirkan ke resource. Untuk mengetahui informasi selengkapnya, lihat Izin akun layanan.

Konsol

1. Di Konsol Google Cloud, buka halaman Akun layanan.

   Buka Akun Layanan

2. Pilih project, lalu klik Buat akun layanan.

3. Di kolom Nama akun layanan, masukkan nama.

   Panjang nama harus antara 6 hingga 30 karakter, serta dapat berisi karakter alfanumerik huruf kecil dan tanda pisah. Setelah membuat akun layanan, Anda tidak dapat mengubah namanya.

4. Klik Buat dan lanjutkan.

5. Klik Pilih peran.

6. Pilih peran berikut, dengan mengklik Tambahkan peran lain sesuai kebutuhan:

   1. Untuk membuat, memperbarui, dan menjalankan alur kerja, pilih Alur Kerja > Editor Alur Kerja.
   2. Untuk mengirim log ke Cloud Logging, pilih Logging > Logs Writer.
   Penting: Untuk lingkungan produksi, Google sangat merekomendasikan untuk membuat akun layanan baru dan memberinya satu atau beberapa peran IAM yang berisi izin minimum yang diperlukan untuk mengelola alur kerja. Untuk mempelajari lebih lanjut izin dan peran mana saja yang tersedia di Workflow, lihat Kontrol akses.

7. Klik Selesai untuk menyelesaikan pembuatan akun layanan.

gcloud

1. Buat akun layanan.

   gcloud iam service-accounts create SERVICE_ACCOUNT

2. Berikan izin ke akun layanan dengan menetapkan peran.

   1. Untuk membuat, memperbarui, dan menjalankan alur kerja, tetapkan peran roles/workflows.editor:

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
          --role "roles/workflows.editor"

   2. Untuk mengirim log ke Cloud Logging, tetapkan peran roles/logging.logWriter:

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

   Ganti kode berikut:

   • SERVICE_ACCOUNT: nama akun layanan. Panjangnya harus antara 6 dan 30 karakter, serta dapat berisi karakter alfanumerik huruf kecil dan tanda pisah. Setelah membuat akun layanan, Anda tidak dapat mengubah namanya.

   • PROJECT_ID: ID project Anda.

   Penting: Untuk lingkungan produksi, Google sangat merekomendasikan untuk membuat akun layanan baru dan memberinya satu atau beberapa peran IAM yang berisi izin minimum yang diperlukan untuk mengelola alur kerja. Untuk mempelajari lebih lanjut izin dan peran mana saja yang tersedia di Workflow, lihat Kontrol akses.

REST

Anda dapat menggunakan metode serviceAccounts.create untuk membuat akun layanan. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

Anda dapat memberikan beberapa peran secara terprogram dengan mengubah dan menetapkan kebijakan izin untuk resource menggunakan metode setIamPolicy. Untuk mengetahui informasi selengkapnya, lihat Memberi atau mencabut beberapa peran secara terprogram.

Membuat alur kerja

Definisi alur kerja terdiri dari serangkaian langkah yang dijelaskan menggunakan sintaksis workflows, yang dapat ditulis dalam format YAML atau JSON. Setelah menentukan alur kerja, Anda men-deploy alur kerja tersebut agar tersedia untuk dieksekusi. Langkah deploy juga memvalidasi bahwa file sumber dapat dieksekusi. Hal ini gagal jika file sumber tidak berisi definisi alur kerja yang valid.

Mengedit file YAML dapat rentan terhadap error. Anda dapat membuat alur kerja Anda dengan menggunakan IDE atau editor kode sumber pilihan dan menyiapkan pelengkapan otomatis dan validasi sintaksis untuk mengurangi error.

Catatan: Indentasi YAML bermakna dan harus berisi minimal dua spasi per tingkat indentasi. Indentasi yang tidak memadai dapat menyebabkan error, dan level baru harus berupa minimal dua spasi dari awal teks di baris sebelumnya. Untuk mengetahui detail selengkapnya, lihat Memecahkan masalah.

Konsol

1. Di konsol Google Cloud, buka halaman Workflows.

   Buka Workflows

2. Klik Buat.

3. Masukkan nama untuk alur kerja, seperti myFirstWorkflow. Nama dapat berisi huruf, angka, garis bawah, dan tanda hubung. Nama ini harus diawali dengan huruf dan diakhiri dengan angka atau huruf.

4. Secara opsional, tambahkan deskripsi alur kerja.

5. Dalam daftar Region, pilih lokasi yang sesuai untuk men-deploy alur kerja Anda; misalnya, us-central1.

6. Dalam daftar Service account, pilih akun layanan yang akan digunakan oleh alur kerja Anda untuk mengakses layanan Google Cloud lainnya. Untuk mengetahui informasi selengkapnya, dalam dokumen ini, lihat Membuat akun layanan.

7. Secara opsional, lakukan salah satu hal berikut:

   1. Tentukan level logging panggilan yang ingin Anda terapkan ke definisi alur kerja. Dalam daftar Level log panggilan, pilih salah satu opsi berikut:

      • Tidak ditentukan: tidak ada level logging yang ditentukan. Ini adalah setelan defaultnya. Level log eksekusi lebih diutamakan daripada level log alur kerja apa pun, kecuali jika level log eksekusi tidak ditentukan (default); dalam hal ini, level log alur kerja berlaku.
      • Hanya error: mencatat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya suatu pengecualian.
      • Semua panggilan: catat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
      • Tidak ada pencatatan: tidak ada logging panggilan.

   2. Tentukan kunci Cloud Key Management Service yang harus digunakan oleh alur kerja untuk enkripsi data: pilih Customer-managed encryption key (CMEK). Untuk informasi selengkapnya, lihat Gunakan customer-managed encryption keys.

   3. Tentukan variabel lingkungan yang dapat diakses oleh alur kerja Anda saat runtime. Untuk mengetahui informasi selengkapnya, lihat Gunakan variabel lingkungan.

   4. Tambahkan label: label adalah pasangan nilai kunci yang membantu Anda mengatur instance Google Cloud Anda. Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label? Label alur kerja diwariskan oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.

      Catatan: Diperlukan waktu hingga 10 menit agar label baru dapat diterapkan.

   5. Jadwalkan alur kerja Anda: pilih Tambahkan pemicu baru > Cloud Scheduler. Untuk mengetahui informasi selengkapnya, lihat Jadwalkan alur kerja menggunakan Cloud Scheduler.

   6. Picu alur kerja Anda melalui peristiwa atau pesan Pub/Sub: pilih Tambahkan pemicu baru > Eventarc. Untuk mengetahui informasi selengkapnya, lihat Picu alur kerja dengan peristiwa atau pesan Pub/Sub.

8. Klik Berikutnya.

9. Dalam editor alur kerja, masukkan definisi alur kerja Anda. Lihat contoh alur kerja.

10. Klik Deploy.

gcloud

1. Pastikan kode sumber alur kerja Anda disimpan dalam file YAML atau JSON, seperti MY_WORKFLOW.YAML atau MY_WORKFLOW.JSON. Lihat contoh alur kerja.

2. Buka terminal.

3. Anda dapat membuat dan men-deploy alur kerja menggunakan perintah gcloud workflows deploy:

   gcloud workflows deploy WORKFLOW_NAME \
       --location=LOCATION \
       --call-log-level=CALL_LOGGING_LEVEL \
       --description="DESCRIPTION" \
       --labels="LABEL_KEY=LABEL_VALUE" \
       --set-env-vars="ENV_KEY=ENV_VALUE" \
       --kms-key=ENCRYPT_KEY \
       --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
       --source=YAML_OR_JSON_SOURCE_FILE

   Ganti kode berikut:

   • WORKFLOW_NAME: nama alur kerja Anda—misalnya, myFirstWorkflow. Nama dapat berisi huruf, angka, garis bawah, dan tanda hubung. Nama ini harus diawali dengan huruf dan diakhiri dengan angka atau huruf.

   • LOCATION: Region tempat men-deploy alur kerja Anda; misalnya, us-central1.

   • CALL_LOGGING_LEVEL: optional. Level logging panggilan yang akan diterapkan selama eksekusi. Dapat berupa salah satu dari:

     • none: tidak ada level logging yang ditentukan. Ini adalah setelan defaultnya. Level log eksekusi lebih diutamakan daripada level log alur kerja apa pun, kecuali jika level log eksekusi tidak ditentukan (default); dalam hal ini, level log alur kerja berlaku.
     • log-errors-only: catat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya pengecualian.
     • log-all-calls: catat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
     • log-none: tidak ada logging panggilan.

   • DESCRIPTION: optional. Deskripsi alur kerja.

   • LABEL_KEY=LABEL_VALUE: optional. Daftar pasangan nilai kunci label yang membantu Anda mengatur instance Google Cloud; misalnya, name=wrench. Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label? Label alur kerja diwariskan oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.

     Catatan: Diperlukan waktu hingga 10 menit agar label baru dapat diterapkan.

   • ENV_KEY=ENV_VALUE: optional. Daftar pasangan nilai kunci variabel lingkungan; misalnya, MONTH=January. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel lingkungan.

   • ENCRYPT_KEY: optional. Kunci Cloud KMS yang harus digunakan oleh alur kerja untuk enkripsi data dalam format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Untuk informasi selengkapnya, lihat Gunakan customer-managed encryption keys.

   • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opsional. Akun layanan yang akan digunakan oleh alur kerja Anda untuk mengakses layanan Google Cloud lainnya. Untuk mengetahui informasi selengkapnya, dalam dokumen ini, lihat Membuat akun layanan.

   • YAML_OR_JSON_SOURCE_FILE: file sumber untuk definisi alur kerja. Contoh: myFirstWorkflow.yaml.

REST

Untuk membuat alur kerja baru dengan nama yang ditentukan, gunakan metode projects.locations.workflows.create, dan gunakan parameter kueri workflowId untuk menentukan ID alur kerja.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• WORKFLOW_NAME: nama alur kerja Anda—misalnya, myFirstWorkflow. Nama dapat berisi huruf, angka, garis bawah, dan tanda hubung. Nama ini harus diawali dengan huruf dan diakhiri dengan angka atau huruf.
• DESCRIPTION: optional. Deskripsi alur kerja Anda. Tidak boleh lebih dari 1.000 karakter Unicode.
• LABEL_KEY dan LABEL_VALUE: opsional. Peta pasangan nilai dan kunci label yang membantu Anda mengatur instance Google Cloud. Misalnya: {"name": "wrench", "mass": "1kg", "count": "3"} Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label? Label alur kerja diwariskan oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.
  Catatan: Diperlukan waktu hingga 10 menit agar label baru dapat diterapkan.
• SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opsional. Akun layanan yang akan digunakan oleh alur kerja Anda untuk mengakses layanan Google Cloud lainnya. Project ID adalah project ID Google Cloud Anda. Untuk mengetahui informasi selengkapnya, dalam dokumen ini, lihat Membuat akun layanan.
• ENCRYPT_KEY: optional. Kunci Cloud KMS yang harus digunakan oleh alur kerja untuk enkripsi data dalam format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Untuk informasi selengkapnya, lihat Menggunakan kunci enkripsi yang dikelola pelanggan.
• CALL_LOGGING_LEVEL: optional. Tingkat logging panggilan yang akan diterapkan selama eksekusi. Secara default, tidak ada level logging yang ditentukan dan level log alur kerja akan diterapkan. Untuk mengetahui informasi selengkapnya, lihat Mengirim Log ke Logging. Salah satu dari berikut ini:
  • CALL_LOG_LEVEL_UNSPECIFIED: tidak ada level logging yang ditentukan dan level log alur kerja yang berlaku. Ini adalah setelan defaultnya. Jika tidak, level log eksekusi akan berlaku dan lebih diutamakan daripada level log alur kerja.
  • LOG_ERRORS_ONLY: mencatat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya pengecualian.
  • LOG_ALL_CALLS: mencatat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
  • LOG_NONE: tidak ada logging panggilan.
• ENV_KEY dan ENV_VALUE: opsional. Peta pasangan nilai dan kunci variabel lingkungan; misalnya, { "month": "January", "day": "Monday"}. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel lingkungan.
• SOURCE_CODE: definisi alur kerja. Anda harus meng-escape baris baru di YAML. Contoh: main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello

  Anda harus meng-escape tanda kutip dalam JSON. Contoh: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}

• LOCATION: Region tempat alur kerja akan di-deploy—misalnya, us-central1.

Meminta isi JSON:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

cat > request.json << 'EOF'
{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
EOF

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows?workflowId=WORKFLOW_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

@'
{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows?workflowId=WORKFLOW_NAME" | Select-Object -Expand Content

API Explorer (browser)

Salin isi permintaan dan buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.

Jika berhasil, isi respons akan memuat instance Operation yang baru dibuat:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "create",
    "apiVersion": "v1"
  },
  "done": false
}

Jika nilai "done" adalah false, operasi masih berlangsung.

Mencantumkan alur kerja

Anda dapat mencantumkan alur kerja atau menggunakan filter untuk mengambil alur kerja tertentu.

Konsol

1. Di konsol Google Cloud, buka halaman Workflows.

   Buka Workflows

   Halaman ini mencantumkan alur kerja Anda di semua lokasi, dan menyertakan detail seperti nama, region, revisi terbaru, dan lainnya.

2. Untuk memfilter alur kerja:

   1. Klik Filter atau kolom Filter workflows.
   2. Di daftar Properti, pilih opsi untuk memfilter alur kerja.

   Anda dapat memilih satu properti atau menggunakan operator logika OR untuk menambahkan properti lainnya.

3. Untuk mengurutkan alur kerja, di samping judul kolom yang didukung, klik Urutkan.

gcloud

Cantumkan alur kerja menggunakan perintah gcloud workflows list:

gcloud workflows list --location=LOCATION

Ganti LOCATION dengan ID atau ID yang sepenuhnya memenuhi syarat untuk lokasi alur kerja Anda.

Perintah ini mencantumkan alur kerja Anda di lokasi yang ditentukan, dan menyertakan detail seperti NAME, STATE, REVISION_ID, dan UPDATE_TIME alur kerja.

REST

Untuk mencantumkan alur kerja di project dan lokasi tertentu, gunakan metode projects.locations.workflows.list.

Atau, untuk mengambil detail satu alur kerja, gunakan metode projects.locations.workflows.get.

Catatan: Saat mencantumkan alur kerja, paging dapat diterapkan sebelum atau setelah pemfilteran. Layanan mungkin menampilkan lebih sedikit resource daripada jumlah yang diminta melalui parameter pageSize, meskipun tidak di akhir koleksi.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: project ID Google Cloud Anda.
• LOCATION: Region tempat alur kerja di-deploy—misalnya, us-central1.

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows" | Select-Object -Expand Content

API Explorer (browser)

Buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.

Jika berhasil, isi respons akan berisi instance Workflow dan responsnya akan mirip dengan berikut ini:

{
  "workflows": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
      "state": "ACTIVE",
      "revisionId": "000001-0ce",
      "createTime": "2023-12-08T13:56:59.306770745Z",
      "updateTime": "2023-12-08T13:56:59.547021939Z",
      "revisionCreateTime": "2023-12-08T13:56:59.340161044Z",
      "serviceAccount": "projects/PROJECT_ID/serviceAccounts/[e-mail]",
      "sourceContents": "main:\n    params: [input]\n [...] return: '${wikiResult.body[1]}'\n"
    },
    {
      object (Workflow)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}

Memperbarui alur kerja

Anda dapat memperbarui alur kerja yang ada. Anda harus menentukan nama alur kerja yang ingin diperbarui dan sumbernya. Perhatikan bahwa Anda tidak dapat mengubah nama atau lokasi alur kerja.

Memperbarui alur kerja tidak memengaruhi eksekusi yang sedang berlangsung. Hanya eksekusi alur kerja mendatang yang akan menggunakan konfigurasi yang diperbarui.

Setiap kali Anda memperbarui alur kerja, versionID-nya akan diperbarui. versionID terdiri dari dua bagian, yang dipisahkan dengan tanda hubung:

• Angka, dimulai dari satu, yang bertambah setiap kali Anda memperbarui alur kerja.

• String alfanumerik tiga karakter acak.

Misalnya, 000001-27f menunjukkan versi awal alur kerja dan 000002-d52 menunjukkan alur kerja yang telah diperbarui satu kali.

Catatan: Jika Anda menghapus kunci enkripsi yang dikelola pelanggan (CMEK) dari revisi alur kerja saat ini, eksekusi berikutnya akan dibuat tanpa enkripsi CMEK. Namun, revisi dan eksekusi alur kerja yang ada tetap dienkripsi dengan kunci yang sebelumnya digunakan untuk mengenkripsinya.

Konsol

1. Di konsol Google Cloud, buka halaman Workflows.

   Buka Workflows

2. Klik nama alur kerja yang ingin diperbarui. Perhatikan bahwa Anda tidak dapat mengubah nama alur kerja.

   Halaman Workflow details akan muncul.

3. Anda dapat mengedit alur kerja dengan cara berikut:

   • Untuk mengedit sumber:

     1. Klik tab Sumber.
     2. Klik Edit.
     3. Untuk menyimpan perubahan, klik Save. Alur kerja yang diperbarui akan di-deploy.

   • Untuk memperbarui deskripsi, akun layanan yang digunakan alur kerja untuk autentikasi, tingkat log panggilan, variabel lingkungan, label, atau kunci enkripsi:

     1. Klik tab Detail.
     2. Klik ikon yang sesuai.
     3. Jika Anda memperbarui level log panggilan, pilih salah satu opsi berikut:
        • Tidak ditentukan: tidak ada level logging yang ditentukan. Ini adalah setelan defaultnya. Level log eksekusi lebih diutamakan daripada level log alur kerja apa pun, kecuali jika level log eksekusi tidak ditentukan (default); dalam hal ini, level log alur kerja berlaku.
        • Hanya error: mencatat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya suatu pengecualian.
        • Semua panggilan: catat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
        • Tidak ada pencatatan: tidak ada logging panggilan.
     4. Jika Anda memperbarui label yang ada, atau menambahkan label baru, perlu waktu hingga 10 menit agar label baru dapat diterapkan. Label alur kerja diwarisi oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.
     5. Untuk menyimpan perubahan, klik Save. Alur kerja yang diperbarui akan di-deploy.

   • Untuk mengedit kolom sebelumnya secara bersamaan, atau menambahkan atau memperbarui pemicu:

     1. Klik Edit.
     2. Untuk mengedit sumber, klik Berikutnya.
     3. Untuk menyimpan perubahan dan men-deploy alur kerja yang diperbarui, klik Deploy.

4. Jika Anda ingin memperbarui peran untuk akun layanan, klik tab Permissions.

   1. Akun utama adalah pengguna, grup, domain, atau akun layanan. Untuk memperbarui prinsipal yang ada:

      1. Temukan baris yang berisi akun utama.
      2. Klik Edit akun utama di baris tersebut.
      3. Klik Tambahkan peran lainnya atau klik Hapus peran.

   2. Jika Anda menambahkan peran, di daftar Select a role, pilih peran yang sesuai.

   3. Untuk menambahkan peran lain, klik Tambahkan peran lain.

   4. Klik Simpan.

   Catatan: Untuk mengubah akun layanan yang digunakan alur kerja untuk autentikasi, Anda masih harus mengedit alur kerja dan mengubah akun layanan seperti yang dijelaskan pada langkah sebelumnya. Untuk mengetahui informasi selengkapnya, lihat Memberikan izin alur kerja untuk mengakses resource Google Cloud.

gcloud

1. Buka terminal.

2. Temukan nama alur kerja yang ingin Anda perbarui. Jika tidak mengetahui nama alur kerja, Anda dapat memasukkan perintah berikut untuk mencantumkan semua alur kerja:

   gcloud workflows list

3. Temukan file YAML atau JSON tempat sumber alur kerja Anda disimpan, seperti WORKFLOW_NAME.YAML atau WORKFLOW_NAME.JSON.

4. Anda dapat memperbarui alur kerja yang ada untuk mengubah sumber, deskripsi, label, variabel lingkungan, level log panggilan, kunci enkripsi, atau akun layanan terkait menggunakan perintah gcloud workflows deploy.

   Anda harus menentukan nama alur kerja yang ingin diperbarui dan sumbernya; namun, flag lainnya bersifat opsional. Untuk menghapus kunci enkripsi yang dikelola pelanggan, gunakan flag --clear-kms-key.

   gcloud workflows deploy WORKFLOW_NAME \
       --call-log-level=CALL_LOGGING_LEVEL \
       --description="DESCRIPTION" \
       --labels="LABEL_KEY=LABEL_VALUE" \
       --set-env-vars="ENV_KEY=ENV_VALUE" \
       --kms-key=ENCRYPT_KEY \
       --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
       --source=YAML_OR_JSON_SOURCE_FILE

   Ganti kode berikut:

   • WORKFLOW_NAME: wajib diisi. Nama alur kerja Anda.

   • CALL_LOGGING_LEVEL: optional. Level logging panggilan yang akan diterapkan ke alur kerja. Dapat berupa salah satu dari:

     • none: tidak ada level logging yang ditentukan. Ini adalah setelan defaultnya. Level log eksekusi lebih diutamakan daripada level log alur kerja apa pun, kecuali jika level log eksekusi tidak ditentukan (default); dalam hal ini, level log alur kerja berlaku.
     • log-errors-only: catat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya pengecualian.
     • log-all-calls: catat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
     • log-none: tidak ada logging panggilan.

   • DESCRIPTION: optional. Deskripsi alur kerja.

   • LABEL_KEY=LABEL_VALUE: optional. Daftar pasangan nilai kunci label yang membantu Anda mengatur instance Google Cloud; misalnya, name=wrench. Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label? Label alur kerja diwariskan oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.

     Catatan: Jika Anda memperbarui label yang ada, atau menambahkan label baru, perlu waktu hingga 10 menit agar label baru dapat diterapkan.

   • ENV_KEY=ENV_VALUE: optional. Daftar pasangan nilai kunci variabel lingkungan; misalnya, MONTH=January. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel lingkungan.

   • ENCRYPT_KEY: optional. Kunci Cloud KMS yang harus digunakan oleh alur kerja untuk enkripsi data dalam format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Untuk informasi selengkapnya, lihat Gunakan customer-managed encryption keys.

   • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opsional. Akun layanan yang akan digunakan oleh alur kerja Anda untuk mengakses layanan Google Cloud lainnya. Jika Anda ingin memperbarui peran untuk akun layanan, lihat Memberikan izin alur kerja untuk mengakses resource Google Cloud dan Mengelola akses ke project, folder, dan organisasi.

   • YAML_OR_JSON_SOURCE_FILE: wajib diisi. File sumber untuk alur kerja dalam format YAML atau JSON. Contoh: myFirstWorkflow.yaml.

REST

Untuk memperbarui alur kerja yang ada, gunakan metode projects.locations.workflows.patch dan secara opsional gunakan parameter kueri updateMask untuk menentukan daftar kolom yang akan diperbarui.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• WORKFLOW_NAME: nama alur kerja Anda—misalnya, myFirstWorkflow.
• DESCRIPTION: optional. Deskripsi alur kerja Anda. Tidak boleh lebih dari 1.000 karakter Unicode.
• LABEL_KEY dan LABEL_VALUE: opsional. Peta pasangan nilai dan kunci label yang membantu Anda mengatur instance Google Cloud. Misalnya: {"name": "wrench", "mass": "1kg", "count": "3"} Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label? Label alur kerja diwariskan oleh eksekusi alur kerja. Untuk melihat label eksekusi, gunakan metode workflows.executions.list untuk mencantumkan dan memfilter eksekusi alur kerja.
  Catatan: Jika Anda memperbarui label yang ada, atau menambahkan label baru, perlu waktu hingga 10 menit agar label baru dapat diterapkan.
• SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opsional. Akun layanan yang akan digunakan oleh alur kerja Anda untuk mengakses layanan Google Cloud lainnya. Project ID adalah project ID Google Cloud Anda. Untuk mengetahui informasi selengkapnya, dalam dokumen ini, lihat Membuat akun layanan.
• ENCRYPT_KEY: optional. Kunci Cloud KMS yang harus digunakan oleh alur kerja untuk enkripsi data dalam format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Untuk informasi selengkapnya, lihat Menggunakan kunci enkripsi yang dikelola pelanggan.
• CALL_LOGGING_LEVEL: optional. Tingkat logging panggilan yang akan diterapkan selama eksekusi. Secara default, tidak ada level logging yang ditentukan dan level log alur kerja akan diterapkan. Untuk mengetahui informasi selengkapnya, lihat Mengirim Log ke Logging. Salah satu dari berikut ini:
  • CALL_LOG_LEVEL_UNSPECIFIED: tidak ada level logging yang ditentukan dan level log alur kerja yang berlaku. Ini adalah setelan defaultnya. Jika tidak, level log eksekusi akan berlaku dan lebih diutamakan daripada level log alur kerja.
  • LOG_ERRORS_ONLY: mencatat semua pengecualian yang tertangkap; atau saat panggilan dihentikan karena adanya pengecualian.
  • LOG_ALL_CALLS: mencatat semua panggilan ke sub-alur kerja atau fungsi library beserta hasilnya.
  • LOG_NONE: tidak ada logging panggilan.
• ENV_KEY dan ENV_VALUE: opsional. Peta pasangan nilai dan kunci variabel lingkungan; misalnya, { "month": "January", "day": "Monday"}. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel lingkungan.
• SOURCE_CODE: definisi alur kerja yang diminifikasi. Contoh: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
• LOCATION: Region tempat alur kerja di-deploy—misalnya, us-central1.
• UPDATE_FIELDS: optional. Daftar kolom yang akan diperbarui dan dipisahkan koma. Jika tidak diberikan, seluruh alur kerja akan diperbarui. Contohnya, description,callLogLevel.

Meminta isi JSON:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

cat > request.json << 'EOF'
{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
EOF

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME?updateMask="UPDATE_FIELDS""

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

@'
{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME?updateMask="UPDATE_FIELDS"" | Select-Object -Expand Content

API Explorer (browser)

Salin isi permintaan dan buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.

Jika berhasil, isi respons akan memuat instance Operation yang baru dibuat:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "update",
    "apiVersion": "v1"
  },
  "done": false
}

Jika nilai "done" adalah false, operasi masih berlangsung.

Menghapus alur kerja

Anda dapat menghapus alur kerja yang ada. Menghapus alur kerja juga akan menghapus eksekusi dan membatalkan eksekusi aktif untuk alur kerja tersebut.

Konsol

1. Di konsol Google Cloud, buka halaman Workflows.

   Buka Workflows

2. Klik nama alur kerja yang ingin Anda hapus, lalu klik Hapus.

3. Saat diminta untuk mengonfirmasi penghapusan, masukkan nama alur kerja.

4. Klik Konfirmasi.

gcloud

1. Buka terminal.

2. Temukan nama alur kerja yang ingin Anda hapus. Jika tidak mengetahui nama alur kerja, Anda dapat memasukkan perintah berikut untuk mencantumkan semua alur kerja:

   gcloud workflows list

3. Hapus alur kerja menggunakan perintah gcloud workflows delete:

   gcloud workflows delete WORKFLOW_NAME

   Ganti WORKFLOW_NAME dengan nama alur kerja Anda.

REST

Untuk menghapus alur kerja dengan nama yang ditentukan, gunakan metode projects.locations.workflows.delete.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• WORKFLOW_NAME: nama alur kerja yang ingin Anda hapus.
• PROJECT_ID: project ID Google Cloud Anda.
• LOCATION: Region tempat alur kerja di-deploy—misalnya, us-central1.

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME" | Select-Object -Expand Content

API Explorer (browser)

Buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.

Jika berhasil, isi respons berisi instance Operation:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "delete",
    "apiVersion": "v1"
  },
  "done": false
}

Jika nilai "done" adalah false, operasi masih berlangsung.

Langkah selanjutnya

• Menjalankan alur kerja

• Mengontrol urutan eksekusi dalam alur kerja

• Referensi sintaksis Workflows