Membuat target kustom

Dokumen ini menjelaskan cara membuat jenis target Cloud Deploy kustom dan menggunakan jenis target kustom tersebut sebagai target dalam pipeline pengiriman Cloud Deploy.

Berikut adalah proses tingkat tinggi untuk membuat jenis target kustom dan menggunakannya di pipeline penayangan:

  1. Buat aplikasi yang di-container atau aplikasi yang menyertakan fungsi untuk men-deploy ke target kustom Anda, dan yang memenuhi persyaratan Cloud Deploy untuk jenis target kustom.

  2. Buat definisi CustomTargetType dengan tugas yang mereferensikan penampung dan tentukan perintah atau perintah yang akan dijalankan di dalamnya.

  3. Tentukan target baru dengan properti customTarget yang mengidentifikasi jenis target kustom baru Anda.

  4. Mereferensikan target tersebut dari progresi pipeline pengiriman Anda.

  5. Buat rilis.

Setiap langkah ini dijelaskan secara mendetail di bagian lain dalam dokumen ini.

Membuat aplikasi dalam container

Fungsi untuk men-deploy ke target kustom Anda ditentukan dalam aplikasi dalam container, yang Anda berikan ke Cloud Deploy dalam definisi CustomTargetType. Saat pipeline pengiriman Anda menyertakan target yang menggunakan jenis target kustom, Cloud Deploy memanggil penampung yang ditentukan untuk jenis target kustom tersebut guna menjalankan render dan deployment kustom yang telah Anda tentukan.

Perilaku aplikasi Anda terserah Anda. Namun, harus menggunakan variabel lingkungan input yang disediakan oleh Cloud Deploy, dan harus menampilkan output yang diperlukan.

Biasanya, Anda akan membuat satu penampung untuk render kustom dan satu untuk deployment kustom, untuk setiap jenis target kustom yang Anda buat. Render kustom bersifat opsional, tetapi Anda harus membuatnya kecuali target kustom Anda akan berfungsi dengan benar jika dirender dengan perender bawaan. Cloud Deploy menggunakan skaffold render secara default untuk merender manifes Anda.

Tentukan jenis target kustom Anda

Anda menentukan target kustom dengan terlebih dahulu membuat jenis target kustom, menggunakan konfigurasi CustomTargetType. Anda dapat membuat CustomTargetType dalam file yang sama dengan definisi pipeline pengiriman, atau dengan definisi target, atau dalam file terpisah.

Definisi CustomTargetType adalah sebagai berikut:

apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name: [CUSTOM_TARGET_TYPE_NAME]
  annotations:
  labels:
description:
tasks:
  render: [RENDER_TASK]
  deploy: [DEPLOY_TASK]

Di mana

  • CUSTOM_TARGET_TYPE_NAME

    Adalah nama arbitrer yang Anda berikan ke definisi jenis target kustom ini. Nama ini dirujuk dalam definisi target untuk target yang menggunakan jenis target kustom yang Anda tentukan.

  • RENDER_TASK

    Adalah tugas yang menentukan render kustom Anda. Jika tidak disediakan, Cloud Deploy akan menggunakan perender bawaan yang ditentukan dalam konfigurasi Skaffold Anda.

  • DEPLOY_TASK

    Adalah tugas yang menentukan deployment kustom Anda.

Mendaftarkan jenis target kustom Anda

Setelah Anda mengonfigurasi CustomTargetType, jalankan perintah gcloud deploy apply untuk mendaftarkan resource CustomTargetType di project Google Cloud :

gcloud deploy apply --file=[FILE] --project=[PROJECT] --region=[REGION]

Dengan:

FILE adalah nama file tempat Anda menentukan jenis target kustom ini.

PROJECT adalah project Google Cloud tempat resource ini akan dibuat. CustomTargetType harus berada dalam project yang sama dengan resource Target yang mereferensikannya. Anda tidak perlu menentukan project jika telah menetapkannya sebagai project default untuk Google Cloud CLI.

REGION adalah region (misalnya, us-central1) tempat resource ini akan dibuat. CustomTargetType harus berada di region yang sama dengan resource Target yang mereferensikannya. Anda tidak perlu menentukan region jika telah menetapkannya sebagai region default untuk gcloud CLI.

Dengan CustomTargetType yang kini dibuat sebagai resource Cloud Deploy, Anda dapat menggunakannya dalam definisi Target untuk membuat target kustom.

Untuk mengetahui informasi selengkapnya tentang definisi CustomTargetType, lihat referensi skema konfigurasi Cloud Deploy.

Tentukan target Anda

Satu-satunya perbedaan antara definisi target untuk jenis target yang didukung dan definisi target kustom adalah definisi target kustom menyertakan stanza customTarget. Sintaksis untuk customTarget adalah sebagai berikut:

customTarget:
  customTargetType: [CUSTOM_TARGET_TYPE_NAME]

Dengan CUSTOM_TARGET_TYPE_NAME adalah nilai dari properti name yang ditentukan dalam konfigurasi jenis target kustom Anda.

Menambahkan target ke pipeline pengiriman

Anda dapat menggunakan target kustom dalam pipeline pengiriman persis seperti Anda menggunakan jenis target yang didukung. Artinya, tidak ada perbedaan dalam progres pipeline penayangan antara target jenis target yang didukung dan target kustom.

Semua target dalam pipeline pengiriman harus menggunakan jenis target yang sama. Misalnya, Anda tidak dapat memiliki pipeline pengiriman dengan beberapa target yang di-deploy ke Google Kubernetes Engine dan beberapa target kustom.

Seperti jenis target yang didukung, Anda dapat menyertakan parameter deployment di tahap pipeline.

Membuat rilis

Setelah jenis target kustom Anda ditentukan sepenuhnya, dan target dibuat untuk menggunakan jenis tersebut, Anda kini dapat membuat rilis, dengan cara biasa:

gcloud deploy releases create [RELEASE_NAME] \
  --project=[PROJECT_NAME] \
  --region=[REGION] \
  --delivery-pipeline=[PIPELINE_NAME]

Setelah pembuatan rilis, render kustom Anda akan dieksekusi untuk setiap target di pipeline pengiriman, termasuk pemrosesan parameter deployment yang dikonfigurasi pada rilis, target, atau pipeline pengiriman. Cloud Deploy menyediakan parameter deployment sebagai input ke container rendering kustom.

Melihat output target kustom

Jika tugas rendering kustom Anda memenuhi persyaratan untuk target kustom, Anda dapat menggunakan konsol Google Cloud untuk melihat artefak yang dirender.

Ikuti langkah-langkah berikut untuk melihat output tugas rendering kustom Anda.

  1. Di konsol Google Cloud , buka halaman Delivery pipelines Cloud Deploy untuk melihat delivery pipeline Anda.

    Buka halaman Delivery pipelines

  2. Klik nama pipeline pengiriman Anda.

    Visualisasi pipeline menampilkan status deployment aplikasi, dan rilis Anda tercantum di tab Rilis di bagian Detail pipeline pengiriman.

  3. Klik nama rilis.

    Halaman Release details akan ditampilkan.

  4. Klik tab Artefak.

  5. Di bagian Targetkan artefak, klik panah di samping Lihat artefak.

    Artefak yang dirender dicantumkan, termasuk file konfigurasi Skaffold yang dirender dan file manifes yang dirender yang dihasilkan oleh perender kustom. Anda dapat mengklik link Lokasi penyimpanan di samping setiap file untuk membuka bucket Cloud Storage dan melihat file tersebut.

    Anda juga dapat mengklik link Lihat artefak untuk melihat file tersebut menurut rilis, menurut target, atau menurut fase, menggunakan pemeriksa rilis.

Langkah berikutnya