Menjalankan hook sebelum dan sesudah deployment

Dokumen ini menjelaskan cara menjalankan program atau operasi arbitrer sebelum dan/atau setelah Anda men-deploy.

Anda dapat mengonfigurasi Cloud Deploy dan Skaffold untuk menjalankan tindakan guna melakukan tindakan pra-penerapan atau tindakan pasca-penerapan, atau keduanya. Program yang dijalankan dengan cara ini disebut "hook". Hook pra-deployment dan pasca-deployment berjalan sebagai tugas pra-deployment dan pasca-deployment pada peluncuran.

Anda dapat mengonfigurasi setiap hook untuk berjalan di lingkungan eksekusi Cloud Deploy yang ditentukan, tetapi jika men-deploy ke Google Kubernetes Engine, Anda dapat mengonfigurasinya secara opsional untuk berjalan di cluster GKE tempat Anda men-deploy aplikasi.

Hook deployment diasumsikan idempoten. Jika tindakan tertentu dijalankan lebih dari sekali, tidak akan ada efek tambahan.

Bagaimana cara kerja hook deployment?

Berikut ini menjelaskan langkah-langkah untuk mengonfigurasi hook deployment, dan proses Skaffold dan Cloud Deploy untuk menjalankan hook tersebut:

  1. Anda mengonfigurasi skaffold.yaml yang digunakan untuk rilis tertentu agar menyertakan customActions yang mengidentifikasi image container yang akan digunakan untuk menjalankan hook, dan perintah atau skrip tertentu yang akan dijalankan di setiap penampung.

  2. Anda mengonfigurasi hook di satu atau beberapa tahap dalam progres pipeline pengiriman, yang masing-masing mereferensikan salah satu customActions yang Anda konfigurasikan di skaffold.yaml.

  3. Sebelum tugas deployment peluncuran dijalankan, Skaffold akan menjalankan perintah apa pun yang dikonfigurasi di skaffold.yaml yang direferensikan dalam stanza predeploy dalam progres pipeline.

    Hook predeploy selalu berjalan sebagai tugas pertama dalam fase.

  4. Setelah tugas deployment peluncuran berjalan, Cloud Deploy akan menjalankan perintah apa pun yang dikonfigurasi di skaffold.yaml yang dirujuk dalam stanza postdeploy dalam progres pipeline.

Hook deployment dijalankan di lingkungan eksekusi Cloud Deploy default, atau di lingkungan eksekusi alternatif yang ditentukan. Untuk deployment ke GKE dan GKE Enterprise, Anda dapat secara opsional menjalankan hook di cluster yang sama tempat aplikasi di-deploy.

Menggunakan hook deployment dengan deployment canary

Saat Anda mengonfigurasi hook deployment untuk deployment canary, ada beberapa hal yang perlu diketahui:

  • Pada tahap pipeline pengiriman, konfigurasi hook (predeploy dan postdeploy) berada di bagian strategy.canary.canaryDeployment atau strategy.canary.customCanaryDeployment.phaseConfigs, bukan di bagian strategy.standard.

  • Untuk canary otomatis, hook predeploy dieksekusi sebelum deployment di fase pertama saja, dan hook postdeploy dieksekusi setelah deployment di fase terakhir (stabil) saja.

Mengonfigurasi tindakan di Skaffold

Dalam file skaffold.yaml, stanza customActions menggunakan satu atau beberapa stanza customActions, yang dikonfigurasi sebagai berikut:

customActions
- name: ACTION_NAME
  containers:
  - name: CONTAINER_NAME
    image: IMAGE
    command: [COMMANDS_TO_RUN]
    args: [LIST_OF_ARGS]

Dalam stanza customerActions ini:

  • ACTION_NAME

    Adalah nama untuk tindakan ini. Nama ini dapat berupa apa pun yang Anda inginkan, tetapi harus unik dalam skaffold.yaml ini. Ini adalah nama yang akan dirujuk dari tindakan pra- dan pasca-deployment yang ditentukan di tahap pipeline pengiriman.

  • CONTAINER_NAME

    Adalah nama untuk penampung tertentu. Nama ini dapat berupa apa pun yang Anda inginkan, tetapi harus unik dalam skaffold.yaml ini.

  • IMAGE

    Adalah nama image container tempat perintah Anda akan dieksekusi.

  • COMMANDS_TO_RUN

    Adalah daftar titik entri yang akan dijalankan di penampung tersebut. "/bin/sh" adalah perintah biasa yang akan ditentukan di sini, untuk memanggil shell, dan Anda akan menyertakan perintah untuk dijalankan di shell tersebut dalam argumen.

  • LIST_OF_ARGS

    Adalah daftar argumen yang akan diberikan ke perintah. Ini adalah daftar yang dipisahkan koma, dengan setiap argumen dalam tanda kutip. Jika COMMAND_TO_RUN Anda adalah "/bin/sh", salah satu argumen di sini adalah "-c", dan argumen lainnya adalah seluruh perintah yang ingin Anda jalankan di shell yang Anda panggil.

    Berikut contohnya:

    command: ["/bin/sh"]
args: ["-c", `echo "This command ran!"`]

Untuk mempelajari tindakan kustom Skaffold lebih lanjut, lihat dokumentasi Skaffold.

Mengonfigurasi pipeline untuk mereferensikan tindakan

Untuk menyelesaikan konfigurasi hook deployment, Anda harus mengonfigurasi pipeline pengiriman untuk mereferensikan tindakan kustom yang ditentukan dalam file skaffold.yaml. Tindakan pra- dan pasca-penyebaran dikonfigurasi dalam satu atau beberapa tahap spesifik dalam progres pipeline.

Berikut adalah cara mengonfigurasi hook pra-dan pasca-deploy di tahap pipeline saat menggunakan strategi deployment standard:

serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["PREDEPLOY-ACTION"]
        postdeploy:
          actions: ["POSTDEPLOY-ACTION"]

Dalam yaml ini:

  • PREDEPLOY_ACTION

    Sama dengan ACTION_NAME yang Anda gunakan di skaffold.yaml untuk menentukan tindakan kustom yang ingin dijalankan sebelum men-deploy.

  • POSTDEPLOY_ACTION

    Sama dengan ACTION_NAME yang Anda gunakan di skaffold.yaml untuk menentukan tindakan kustom yang ingin dijalankan setelah men-deploy.

Anda dapat menentukan lebih dari satu tindakan untuk predeploy dan postdeploy, yang dipisahkan dengan koma. Jika lebih dari satu tindakan ditentukan, tindakan tersebut akan dieksekusi secara berurutan, sesuai dengan urutan yang ditentukan. Tugas (pra-penyebaran atau pasca-penyebaran) gagal pada tindakan pertama yang gagal, dan tindakan yang tersisa tidak dijalankan.

Secara default, jika Anda menjalankan lebih dari satu penampung secara paralel, dan tugas gagal, kedua penampung akan dihentikan. Anda dapat mengonfigurasi perilaku ini menggunakan strategi kegagalan tindakan kustom Skaffold.

Menjalankan hook di cluster aplikasi

Secara default, hook deployment berjalan di lingkungan eksekusi Cloud Deploy. Anda juga dapat mengonfigurasi Skaffold untuk menjalankan tindakan kustom tersebut di cluster yang sama tempat aplikasi Anda berjalan. Saat Anda mengonfigurasi tindakan kustom di skaffold.yaml dan mengaktifkannya di tahap pipeline, tindakan akan berjalan secara otomatis di cluster target tersebut.

Kemampuan ini hanya tersedia untuk deployment ke GKE dan GKE Enterprise, bukan untuk Cloud Run. Deployment ke Cloud Run hanya dapat menjalankan hook di lingkungan eksekusi Cloud Deploy.

Untuk menjalankan hook di cluster, sertakan stanza executionMode.kubernetesCluster dalam file konfigurasi skaffold.yaml, di dalam stanza customActions untuk tindakan kustom tertentu:

customActions
- name: ACTION_NAME
  containers:
  - name: CONTAINER_NAME
    image: IMAGE
    command: [COMMANDS_TO_RUN]
    args: [LIST_OF_ARGS]
  executionMode:
    kubernetesCluster: {}

Berikut adalah contoh stanza customActions yang menyertakan executionMode untuk memanggil penampung hook di cluster aplikasi:

customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
  executionMode:
    kubernetesCluster: {}

Stanza executionMode bersifat opsional, dan jika Anda menghilangkannya, Skaffold akan menjalankan penampung tindakan kustom di lingkungan eksekusi Cloud Deploy.

Variabel lingkungan yang tersedia

Cloud Deploy menyediakan dan mengisi variabel lingkungan berikut di lingkungan eksekusi, yang dapat Anda gunakan untuk hook:

  • ANTHOS_MEMBERSHIP

    Untuk target jenis ANTHOS, nama resource yang sepenuhnya ditentukan dari langganan Anthos.

  • CLOUD_RUN_LOCATION

    Untuk target jenis RUN, region tempat layanan Cloud Run di-deploy.

  • CLOUD_RUN_PROJECT

    Untuk target jenis RUN, project tempat layanan Cloud Run dibuat.

  • CLOUD_RUN_SERVICE

    Untuk target jenis RUN, nama layanan Cloud Run yang di-deploy.

  • CLOUD_RUN_SERVICE_URLS

    Untuk target jenis RUN, URL atau URL (daftar yang dipisahkan koma) yang akan digunakan pengguna akhir untuk mengakses layanan Anda. Anda dapat menemukannya di detail layanan Cloud Run untuk layanan Anda, di konsol Google Cloud.

  • CLOUD_RUN_REVISION

    Untuk target jenis RUN, revisi tertentu dari layanan Cloud Run.

  • GKE_CLUSTER

    Untuk target jenis GKE, nama resource yang ditentukan sepenuhnya dari cluster Google Kubernetes Engine, misalnya projects/p/locations/us-central1/clusters/dev.

  • TARGET_TYPE

    Jenis runtime spesifik dari target. GKE, ANTHOS, atau RUN. Untuk target kustom, nilai ini tidak akan ditetapkan.

  • CLOUD_DEPLOY_LOCATION

    Region yang berisi resource Cloud Deploy.

  • CLOUD_DEPLOY_DELIVERY_PIPELINE

    ID pipeline pengiriman.

  • CLOUD_DEPLOY_TARGET

    ID target.

  • CLOUD_DEPLOY_PROJECT

    Project Google Cloud yang berisi resource Cloud Deploy.

  • CLOUD_DEPLOY_RELEASE

    ID rilis tempat hook akan berjalan.

  • CLOUD_DEPLOY_ROLLOUT

    ID peluncuran yang berisi tugas untuk hook.

  • CLOUD_DEPLOY_JOB_RUN

    ID job run yang mewakili eksekusi tugas saat ini.

  • CLOUD_DEPLOY_PHASE

    Fase dalam peluncuran yang berisi tugas untuk hook.

Men-deploy parameter sebagai variabel lingkungan

Selain variabel lingkungan yang tercantum di bagian ini, Cloud Deploy dapat meneruskan ke penampung kustom Anda semua parameter deployment yang telah Anda tetapkan.

Pelajari lebih lanjut.

Langkah selanjutnya