REST Resource: projects.locations.deliveryPipelines.releases

Resource: Rilis

Resource Release di Cloud Deploy API.

Release menentukan instance konfigurasi Skaffold tertentu yang dapat di-deploy.

Representasi JSON 
{
  "name": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "abandoned": boolean,
  "createTime": string,
  "renderStartTime": string,
  "renderEndTime": string,
  "skaffoldConfigUri": string,
  "skaffoldConfigPath": string,
  "buildArtifacts": [
    {
      object (BuildArtifact)
    }
  ],
  "deliveryPipelineSnapshot": {
    object (DeliveryPipeline)
  },
  "targetSnapshots": [
    {
      object (Target)
    }
  ],
  "customTargetTypeSnapshots": [
    {
      object (CustomTargetType)
    }
  ],
  "renderState": enum (RenderState),
  "etag": string,
  "skaffoldVersion": string,
  "targetArtifacts": {
    string: {
      object (TargetArtifact)
    },
    ...
  },
  "targetRenders": {
    string: {
      object (TargetRender)
    },
    ...
  },
  "condition": {
    object (ReleaseCondition)
  },
  "deployParameters": {
    string: string,
    ...
  }
}
Kolom
name

string

Opsional. Nama Release. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/[a-z][a-z0-9\-]{0,62}.
uid

string

Hanya output. ID unik Release.
description

string

Deskripsi Release. Panjang maksimal adalah 255 karakter.
annotations

map (key: string, value: string)

Anotasi pengguna. Atribut ini hanya dapat ditetapkan dan digunakan oleh pengguna, bukan oleh Cloud Deploy. Lihat https://google.aip.dev/128#annotations untuk mengetahui detail selengkapnya seperti batasan format dan ukuran.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Label adalah atribut yang dapat ditetapkan dan digunakan oleh pengguna dan oleh Cloud Deploy. Label harus memenuhi batasan berikut:

  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung.
  • Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional diperbolehkan.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.
  • Setiap resource dibatasi maksimum 64 label.

Kunci dan nilai juga dibatasi menjadi <= 128 byte.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
abandoned

boolean

Hanya output. Menunjukkan apakah rilis ini ditinggalkan.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan Release.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
renderStartTime

string (Timestamp format)

Hanya output. Waktu render dimulai.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
renderEndTime

string (Timestamp format)

Hanya output. Waktu saat render selesai.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
skaffoldConfigUri

string

URI Cloud Storage arsip tar.gz yang berisi konfigurasi Skaffold.
skaffoldConfigPath

string

Jalur file konfigurasi Skaffold di dalam URI konfigurasi.
buildArtifacts[]

object (BuildArtifact)

Daftar artefak yang akan diteruskan ke perintah Skaffold.
deliveryPipelineSnapshot

object (DeliveryPipeline)

Hanya output. Snapshot pipeline induk yang diambil pada waktu pembuatan rilis.
targetSnapshots[]

object (Target)

Hanya output. Snapshot target yang diambil pada waktu pembuatan rilis.
customTargetTypeSnapshots[]

object (CustomTargetType)

Hanya output. Snapshot jenis target kustom yang dirujuk oleh target yang diambil pada waktu pembuatan rilis.
renderState

enum (RenderState)

Hanya output. Status operasi render saat ini.
etag

string

Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan dapat dikirim pada saat permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.
skaffoldVersion

string

Versi Skaffold yang akan digunakan saat beroperasi pada rilis ini, seperti "1.20.0". Tidak semua versi valid; Cloud Deploy mendukung serangkaian versi tertentu.

Jika tidak disetel, versi Skaffold terbaru yang didukung akan digunakan.
targetArtifacts

map (key: string, value: object (TargetArtifact))

Hanya output. Petakan dari ID target ke artefak target yang dibuat selama operasi render.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
targetRenders

map (key: string, value: object (TargetRender))

Hanya output. Memetakan dari ID target ke detail operasi render untuk target tersebut.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
condition

object (ReleaseCondition)

Hanya output. Informasi seputar status Rilis.
deployParameters

map (key: string, value: string)

Opsional. Parameter deploy yang akan digunakan untuk semua target dalam rilis ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BuildArtifact

Deskripsi gambar yang akan digunakan selama rendering Skaffold.

Representasi JSON 
{
  "image": string,
  "tag": string
}
Kolom
image

string

Nama image dalam konfigurasi Skaffold.
tag

string

Tag gambar yang akan digunakan. Ini umumnya akan menjadi jalur lengkap ke gambar, seperti "gcr.io/my-project/businessesbox:1.2.3" atau "gcr.io/my-project/runningbox@sha256:abc123".

RenderState

Status valid dari operasi render.

Enum
RENDER_STATE_UNSPECIFIED Status render tidak ditentukan.
SUCCEEDED Semua operasi rendering telah berhasil diselesaikan.
FAILED Semua operasi rendering telah selesai, dan satu atau beberapa operasi gagal.
IN_PROGRESS Rendering telah dimulai dan tidak selesai.

TargetArtifact

Artefak yang dihasilkan oleh operasi render target.

Representasi JSON 
{
  "skaffoldConfigPath": string,
  "manifestPath": string,
  "phaseArtifacts": {
    string: {
      object (PhaseArtifact)
    },
    ...
  },

  // Union field uri can be only one of the following:
  "artifactUri": string
  // End of list of possible types for union field uri.
}
Kolom
skaffoldConfigPath

string

Hanya output. Jalur file konfigurasi Skaffold yang di-resolve relatif terhadap URI.
manifestPath

string

Hanya output. Jalur file manifes yang dirender relatif terhadap URI.
phaseArtifacts

map (key: string, value: object (PhaseArtifact))

Hanya output. Petakan dari ID fase ke artefak fase untuk Target.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Kolom union uri.

uri hanya dapat berupa salah satu dari yang berikut:
artifactUri

string

Hanya output. URI direktori yang berisi artefak. File ini berisi konfigurasi deployment yang digunakan oleh Skaffold selama peluncuran, dan semua jalur bersifat relatif terhadap lokasi ini.

PhaseArtifact

Berisi jalur ke artefak, yang relatif terhadap URI, untuk suatu fase.

Representasi JSON 
{
  "skaffoldConfigPath": string,
  "manifestPath": string,
  "jobManifestsPath": string
}
Kolom
skaffoldConfigPath

string

Hanya output. Jalur file konfigurasi Skaffold yang di-resolve relatif terhadap URI.
manifestPath

string

Hanya output. Jalur file manifes yang dirender relatif terhadap URI.
jobManifestsPath

string

Hanya output. Jalur file direktori manifes tugas yang dirender relatif terhadap URI. Ini hanya ditetapkan jika berlaku.

TargetRender

Detail rendering untuk satu target.

Representasi JSON 
{
  "renderingBuild": string,
  "renderingState": enum (TargetRenderState),
  "metadata": {
    object (RenderMetadata)
  },
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Kolom
renderingBuild

string

Hanya output. Nama resource objek Build Cloud Build yang digunakan untuk merender manifes untuk target ini. Formatnya adalah projects/{project}/locations/{location}/builds/{build}.
renderingState

enum (TargetRenderState)

Hanya output. Status saat ini dari operasi render untuk Target ini.
metadata

object (RenderMetadata)

Hanya output. Metadata yang terkait dengan render Release untuk Target ini.
failureCause

enum (FailureCause)

Hanya output. Alasan kegagalan render ini. Ini akan selalu tidak ditentukan saat render berlangsung.
failureMessage

string

Hanya output. Informasi tambahan tentang kegagalan render, jika tersedia.

TargetRenderState

Status valid dari operasi render.

Enum
TARGET_RENDER_STATE_UNSPECIFIED Status operasi render tidak ditentukan.
SUCCEEDED Operasi render telah berhasil diselesaikan.
FAILED Operasi render gagal.
IN_PROGRESS Operasi render sedang berlangsung.

RenderMetadata

RenderMetadata mencakup informasi yang terkait dengan render Release.

Representasi JSON 
{
  "cloudRun": {
    object (CloudRunRenderMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Kolom
cloudRun

object (CloudRunRenderMetadata)

Hanya output. Metadata yang terkait dengan rendering untuk Cloud Run.
custom

object (CustomMetadata)

Hanya output. Metadata kustom yang disediakan oleh operasi render yang ditentukan pengguna.

CloudRunRenderMetadata

CloudRunRenderMetadata berisi informasi Cloud Run yang terkait dengan render Release.

Representasi JSON 
{
  "service": string
}
Kolom
service

string

Hanya output. Nama Layanan Cloud Run dalam manifes yang dirender. Formatnya adalah projects/{project}/locations/{location}/services/{service}.

FailureCause

Kegagalan rendering yang terkenal.

Enum
FAILURE_CAUSE_UNSPECIFIED Tidak ada alasan kegagalan yang ditentukan.
CLOUD_BUILD_UNAVAILABLE Cloud Build tidak tersedia karena tidak diaktifkan atau karena Cloud Deploy tidak memiliki izin yang memadai. Lihat izin yang diperlukan.
EXECUTION_FAILED Operasi render tidak berhasil diselesaikan; periksa log Cloud Build.
CLOUD_BUILD_REQUEST_FAILED Cloud Build gagal memenuhi permintaan Cloud Deploy. Lihat failedMessage untuk mengetahui detail selengkapnya.
VERIFICATION_CONFIG_NOT_FOUND Operasi render tidak berhasil diselesaikan karena stanza verifikasi yang diperlukan untuk verifikasi tidak ditemukan di konfigurasi Skaffold.
CUSTOM_ACTION_NOT_FOUND Operasi render tidak berhasil diselesaikan karena tindakan kustom yang diperlukan untuk pra-deployment atau pasca-deployment tidak ditemukan dalam konfigurasi Skaffold. Lihat failedMessage untuk mengetahui detail selengkapnya.
DEPLOYMENT_STRATEGY_NOT_SUPPORTED Rilis gagal selama rendering karena konfigurasi rilis tidak didukung dengan strategi deployment yang ditentukan.
RENDER_FEATURE_NOT_SUPPORTED Operasi render memiliki fitur yang dikonfigurasi tetapi tidak didukung.

ReleaseCondition

ReleaseCondition berisi semua kondisi yang relevan dengan Release.

Representasi JSON 
{
  "releaseReadyCondition": {
    object (ReleaseReadyCondition)
  },
  "skaffoldSupportedCondition": {
    object (SkaffoldSupportedCondition)
  }
}
Kolom
releaseReadyCondition

object (ReleaseReadyCondition)

Detail tentang status Rilis keseluruhan.
skaffoldSupportedCondition

object (SkaffoldSupportedCondition)

Detail seputar status dukungan versi Skaffold rilis.

ReleaseReadyCondition

ReleaseReadyCondition berisi informasi seputar status Rilis. Jika rilis belum siap, Anda tidak dapat membuat peluncuran dengan rilis tersebut.

Representasi JSON 
{
  "status": boolean
}
Kolom
status

boolean

True jika Rilis dalam status valid. Jika tidak, setidaknya satu kondisi di ReleaseCondition dalam status tidak valid. Lakukan iterasi pada kondisi tersebut dan lihat kondisi mana yang memiliki status = false untuk mengetahui masalah pada Rilis tersebut.

SkaffoldSupportedCondition

SkaffoldSupportedCondition berisi informasi tentang kapan dukungan untuk Skaffold versi rilis berakhir.

Representasi JSON 
{
  "status": boolean,
  "skaffoldSupportState": enum (SkaffoldSupportState),
  "maintenanceModeTime": string,
  "supportExpirationTime": string
}
Kolom
status

boolean

True jika versi Skaffold yang digunakan oleh rilis ini didukung.
skaffoldSupportState

enum (SkaffoldSupportState)

Status dukungan Skaffold untuk Skaffold versi rilis ini.
maintenanceModeTime

string (Timestamp format)

Waktu versi Skaffold rilis ini akan memasuki mode pemeliharaan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
supportExpirationTime

string (Timestamp format)

Waktu saat versi Skaffold rilis ini tidak akan didukung lagi.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

SkaffoldSupportState

Status dukungan versi Skaffold tertentu.

Enum
SKAFFOLD_SUPPORT_STATE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
SKAFFOLD_SUPPORT_STATE_SUPPORTED Versi Skaffold ini saat ini didukung.
SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE Versi Skaffold ini berada dalam mode pemeliharaan.
SKAFFOLD_SUPPORT_STATE_UNSUPPORTED Versi Skaffold ini tidak lagi didukung.

Metode

abandon

 Mengabaikan Rilis di Pipeline Pengiriman.

create

 Membuat Rilis baru di project dan lokasi tertentu.

get

 Mendapatkan detail satu Rilis.

list

 Mencantumkan Rilis di project dan lokasi tertentu.