Solusi Praktis: Library Klien Cloud SDK

Last reviewed 2024-03-21 UTC

Panduan ini membantu Anda memahami dan men-deploy solusi Library Klien Cloud SDK.

Solusi ini memungkinkan Anda berinteraksi dengan Google Cloud menggunakan Library Klien Google Cloud SDK untuk memproses dan menggabungkan data, lalu menampilkan visualisasi radar. Gunakan aplikasi ini untuk mengidentifikasi tren dan pengamatan berdasarkan data gabungan.

Solusi ini akan membantu Anda mempelajari keterampilan penting agar berhasil melakukan panggilan API. Solusi ini menggunakan Library Klien Google Cloud SDK untuk mengakses Google Cloud API secara terprogram, dengan memanfaatkan layanan Google Cloud (tugas Cloud Run dan Cloud Storage) untuk mengurangi kode boilerplate.

Dalam solusi ini, kode mengurai set data contoh (Sensus Tupai Central Park 2018) dengan tugas Cloud Run dan Cloud Storage. Semua permintaan Klien Google Cloud SDK dicatat ke dalam Cloud Logging, menggunakan pola umum untuk memungkinkan pemecahan masalah dan observabilitas sehingga Anda dapat melihat berapa lama permintaan tersebut berlangsung dan tempat proses mungkin mengalami error. Solusi ini juga akan memandu Anda dalam menjalankan tugas Cloud Run untuk memproses dan menyimpan set data.

API adalah mekanisme dasar yang digunakan developer untuk berinteraksi dengan produk dan layanan Google Cloud. Google Cloud SDK menyediakan library Klien Cloud khusus bahasa yang mendukung delapan bahasa berbeda beserta konvensi dan gayanya. Gunakan solusi ini untuk mempelajari cara menggunakan Library Klien Google Cloud SDK untuk memproses data dan men-deploy aplikasi frontend tempat Anda dapat melihat hasilnya.

Catatan: Solusi ini membantu Anda mempelajari kemampuan Google Cloud. Solusi ini tidak dimaksudkan untuk digunakan untuk lingkungan produksi. Untuk informasi tentang cara mendesain dan menyiapkan lingkungan tingkat produksi di Google Cloud, lihat Desain zona landing di Google Cloud dan Checklist penyiapan Google Cloud.

Tujuan

Panduan solusi ini membantu Anda melakukan hal berikut:

• Pelajari cara menggunakan library klien untuk panggilan Google Cloud API.
• Men-deploy set data interaktif menggunakan tugas Cloud Run dan Cloud Storage.
• Jelajahi panggilan Google Cloud API menggunakan Cloud Logging.
• Lihat aplikasi Cloud Run, konfigurasi akun layanan, dan API yang diaktifkan serta penggunaannya.

Arsitektur

Solusi ini men-deploy data mentah ke bucket di Cloud Storage, mengonfigurasi tugas Cloud Run untuk memproses data dan menyimpannya ke bucket terpisah di Cloud Storage, serta men-deploy layanan frontend di Cloud Run yang dapat melihat dan berinteraksi dengan data yang diproses.

Diagram berikut menunjukkan arsitektur dari solusi:

Bagian berikut menjelaskan resource Google Cloud yang ditampilkan dalam diagram.

Komponen dan konfigurasi

Berikut adalah alur pemrosesan permintaan solusi ini. Langkah-langkah dalam alur diberi nomor seperti yang ditunjukkan pada diagram arsitektur sebelumnya.

1. Data yang belum diproses telah diupload ke bucket Cloud Storage.
2. Tugas Cloud Run mengubah data mentah menjadi format yang lebih terstruktur yang dapat dipahami oleh layanan frontend. Tugas Cloud Run mengupload data yang diproses di bucket Cloud Storage kedua.
3. Frontend, yang dihosting sebagai layanan Cloud Run, mengambil data yang diproses dari bucket Cloud Storage kedua.
4. Pengguna dapat mengunjungi aplikasi web yang ditayangkan oleh layanan Cloud Run frontend.

Produk yang digunakan

Solusi ini menggunakan produk Google Cloud berikut:

• Cloud Storage: Layanan siap pakai bagi perusahaan yang menyediakan penyimpanan objek tanpa batas dan berbiaya rendah untuk beragam jenis data. Data dapat diakses dari dalam dan di luar Google Cloud serta direplikasi secara geo-redundan.
• Cloud Logging: Layanan yang memungkinkan Anda menyimpan, menelusuri, menganalisis, memantau, dan membuat pemberitahuan terkait data logging dan peristiwa dari Google Cloud dan cloud lainnya.
• Cloud Run: Layanan terkelola sepenuhnya yang memungkinkan Anda membangun dan men-deploy aplikasi dalam container tanpa server. Google Cloud menangani penskalaan dan tugas infrastruktur lainnya, sehingga Anda dapat berfokus pada logika bisnis kode Anda

Biaya

Untuk mengetahui perkiraan biaya resource Google Cloud yang digunakan oleh solusi Library Klien Cloud SDK, lihat perkiraan yang telah dihitung sebelumnya di Kalkulator Harga Google Cloud.

Gunakan perkiraan biaya tersebut sebagai titik awal untuk menghitung biaya deployment Anda. Anda dapat mengubah perkiraan biaya untuk mencerminkan setiap perubahan konfigurasi yang Anda rencanakan untuk memastikan resource yang digunakan dalam solusi.

Perkiraan yang telah dihitung sebelumnya didasarkan pada asumsi untuk faktor-faktor tertentu, termasuk hal-hal berikut:

• Lokasi Google Cloud tempat resource di-deploy.

• Durasi waktu resource tersebut digunakan.

• Lokasi Google Cloud tempat resource di-deploy.

• Durasi waktu resource tersebut digunakan.

Men-deploy solusi

Bagian berikut akan memandu Anda dalam proses men-deploy solusi.

Membuat atau memilih project Google Cloud

Saat men-deploy solusi, Anda perlu menentukan di mana project Google Cloud resource akan di-deploy. Anda dapat membuat project baru atau menggunakan project yang ada untuk deployment.

Jika Anda ingin membuat project baru, lakukan sebelum memulai deployment. Menggunakan project dapat membantu menghindari konflik dengan resource yang telah disediakan sebelumnya, seperti resource yang digunakan untuk workload produksi.

Untuk membuat project, selesaikan langkah-langkah berikut ini:

1. Di konsol Google Cloud, buka halaman Pemilih project.

   Buka pemilih project

2. Untuk mulai membuat project Google Cloud, klik Buat project.

3. Beri nama project Anda. Catat project ID yang dibuat.

4. Edit kolom lain sesuai kebutuhan.

5. Untuk membuat project, klik Buat.

Mendapatkan izin IAM yang diperlukan

Untuk memulai proses deployment, Anda memerlukan izin Identity and Access Management (IAM) yang terdaftar dalam tabel berikut ini.

Jika Anda membuat project baru untuk solusi ini, Anda memiliki peran dasar roles/owner di project tersebut dan memiliki semua izin yang diperlukan. Jika Anda tidak memiliki peran roles/owner, minta administrator Anda untuk memberikan izin ini (atau peran yang menyertakan izin ini) kepada Anda.

Izin IAM diperlukan	Peran bawaan yang mencakup izin yang diperlukan
serviceusage.services.enable	Service Usage Admin (roles/serviceusage.serviceUsageAdmin)
iam.serviceAccounts.create	Service Account Admin (roles/iam.serviceAccountAdmin)
resourcemanager.projects.setIamPolicy	Project IAM Admin (roles/resourcemanager.projectIamAdmin)
config.deployments.create config.deployments.list	Cloud Infrastructure Manager Admin (roles/config.admin)
iam.serviceAccount.actAs	Service Account User (roles/iam.serviceAccountUser)

Tentang izin akun layanan sementara

Jika Anda memulai proses deployment melalui konsol, Google akan membuat akun layanan untuk men-deploy solusi atas nama Anda (dan akan menghapus deployment jika Anda memilihnya). Akun layanan ini diberi izin IAM tertentu untuk sementara; yaitu, izin tersebut akan otomatis dicabut setelah operasi deployment dan penghapusan solusi selesai. Google merekomendasikan agar setelah Anda menghapus deployment, Anda harus menghapus akun layanan, seperti yang akan dijelaskan dalam panduan ini.

Melihat peran yang ditetapkan ke akun layanan

Peran-peran tersebut tercantum di sini untuk mengantisipasi jika administrator project Google Cloud atau organisasi Anda memerlukan informasi ini.

• roles/storage.admin
• roles/run.admin
• roles/iam.serviceAccountAdmin
• roles/iam.serviceAccountUser
• roles/resourcemanager.projectIamAdmin
• roles/iam.roleAdmin
• roles/serviceusage.serviceUsageAdmin

Memilih metode deployment

Untuk membantu Anda men-deploy solusi ini dengan upaya minimal, konfigurasi Terraform disediakan di GitHub. Konfigurasi Terraform menentukan semua resource Google Cloud yang diperlukan untuk solusi.

Anda dapat men-deploy solusi menggunakan salah satu dari metode berikut ini:

• Melalui konsol: Gunakan metode ini jika Anda ingin mencoba solusi dengan konfigurasi default dan melihat cara kerjanya. Cloud Build men-deploy semua resource yang diperlukan untuk solusi. Jika Anda sudah tidak memerlukan solusi yang di-deploy, Anda dapat menghapusnya melalui konsol. Semua resource yang telah Anda buat setelah men-deploy solusi mungkin perlu dihapus secara terpisah.

  Untuk menggunakan metode deployment ini, ikuti petunjuknya di Deploy melalui konsol.

• Menggunakan Terraform CLI: Gunakan metode ini jika Anda ingin menyesuaikan solusi atau mengotomatisasi penyediaan dan pengelolaan resource menggunakan pendekatan Infrastructure as Code (IaC). Download konfigurasi Terraform melalui GitHub, sesuaikan kode secara opsional sesuai kebutuhan, kemudian deploy solusi menggunakan Terraform CLI. Setelah men-deploy solusi, Anda dapat terus menggunakan Terraform untuk mengelola solusi tersebut.

  Untuk menggunakan metode deployment ini, ikuti instruksinya di Men-deploy menggunakan Terraform CLI.

Men-deploy melalui konsol

Selesaikan langkah-langkah berikut untuk men-deploy solusi yang telah terkonfigurasi.

Catatan: JIka Anda ingin menyesuaikan solusi atau mengotomatiskan penyediaan dan pengelolaan solusi menggunakan pendekatan infrastruktur sebagai kode (IaC), selanjutnya lihat Men-deploy menggunakan Terraform CLI.

1. Di katalog Solusi Praktis Google Cloud, buka solusi Library Klien Cloud SDK.

   Buka solusi Library Klien Cloud SDK

2. Tinjau informasi yang tersedia di halaman seperti perkiraan biaya solusi dan waktu deployment.

3. Jika sudah siap untuk mulai men-deploy solusi, klik Deploy.

   Panel konfigurasi langkah demi langkah akan ditampilkan.

4. Selesaikan langkah-langkah di panel konfigurasi.

   Catat nama yang Anda masukkan untuk deployment. Nama ini akan diperlukan saat Anda menghapus deployment.

   Saat Anda mengklik Deploy, halaman Deployment solusi akan ditampilkan. Kolom Status di halaman ini menampilkan Men-deploy.

5. Tunggu hingga solusi berhasil di-deploy.

   Jika deployment gagal, kolom Status akan menampilkan Gagal. Anda dapat menggunakan log Cloud Build untuk mendiagnosis error. Untuk informasi selengkapnya, lihat Error ketika men-deploy melalui konsol.

   Setelah deployment selesai, kolom Status berubah menjadi Di-deploy.

6. Untuk melihat solusi, kembali ke halaman Deployment solusi di konsol.

7. Dengan solusi ini, Anda perlu menjalankan tugas pemrosesan data menggunakan tugas Cloud Run agar dapat mengubah dan berinteraksi dengan set data sampel. Untuk mengikuti panduan langkah demi langkah untuk tugas ini langsung di konsol Google Cloud, klik Mulai tugas pemrosesan data.

   Memulai tugas pemrosesan data

8. Untuk melihat resource Google Cloud yang di-deploy beserta konfigurasinya, pilih tur interaktif dalam bahasa pilihan Anda (Python, Node.js, atau Java).

   Memilih tur

   Setelah memproses set data contoh ke bucket Cloud Storage, Anda dapat terus menggunakan solusi Library Klien Cloud SDK untuk mempelajari lebih lanjut cara berinteraksi dengan Google Cloud API, cara API didukung oleh Identity and Access Management, dan memecahkan masalah API di aplikasi Cloud Client API.

Ketika Anda tidak lagi memerlukan solusi tersebut, Anda dapat menghapus deployment untuk menghindari penagihan berkelanjutan untuk resource Google Cloud tersebut. Untuk informasi selengkapnya, lihat Menghapus deployment.

Men-deploy menggunakan Terraform CLI

Bagian ini menjelaskan cara menyesuaikan solusi atau mengotomatiskan penyediaan dan pengelolaan solusi menggunakan Terraform CLI. Solusi yang Anda deploy menggunakan Terraform CLI tidak ditampilkan di halaman Deployment solusi pada Konsol Google Cloud.

Catatan: Jika Anda ingin men-deploy solusi dengan konfigurasi default untuk melihat cara kerjanya, ikuti petunjuk dalam Men-deploy melalui konsol.

Menyiapkan klien Terraform

Anda dapat menjalankan Terraform baik di Cloud Shell maupun host lokal Anda. Panduan ini menjelaskan cara menjalankan Terraform di Cloud Shell, yang telah menginstal Terraform di Cloud Shell dan dikonfigurasi untuk diautentikasi dengan Google Cloud.

Kode Terraform untuk solusi ini tersedia di repositori GitHub.

1. Lakukan clone repositori GitHub ke Cloud Shell.

   

   Perintah akan ditampilkan untuk mengonfirmasi download repositori GitHub ke Cloud Shell.

2. Klik Confirm.

   Cloud Shell diluncurkan di tab browser yang terpisah, lalu kode Terraform didownload ke direktori $HOME/cloudshell_open lingkungan Cloud Shell Anda.

3. Dalam Cloud Shell, periksa apakah direktori yang sedang bekerja adalah $HOME/cloudshell_open/terraform-cloud-client-api/infra. Ini merupakan direktori yang berisi file konfigurasi Terraform untuk solusi. Jika Anda perlu mengubah ke direktori tersebut, jalankan perintah berikut:

   cd $HOME/cloudshell_open/terraform-cloud-client-api/infra
   

4. Lakukan inisialisasi Terraform dengan menjalankan perintah berikut:

   terraform init
   

   Tunggu hingga Anda melihat pesan berikut:

   Terraform has been successfully initialized!
   

Mengonfigurasi variabel Terraform

Kode Terraform yang Anda download mencakup variabel yang dapat digunakan untuk menyesuaikan deployment berdasarkan persyaratan Anda. Misalnya, Anda dapat menentukan project Google Cloud dan region tempat Anda ingin men-deploy solusi.

1. Pastikan direktori yang sedang bekerja adalah $HOME/cloudshell_open/terraform-cloud-client-api/infra. Jika bukan, buka direktori tersebut.

2. Pada direktori yang sama, buatlah file teks dengan nama terraform.tfvars.

3. Dalam file terraform.tfvars, salin cuplikan kode berikut dan tetapkan nilai untuk variabel yang diperlukan.

   • Ikuti petunjuk yang disediakan sebagai komentar dalam cuplikan kode.
   • Cuplikan kode ini hanya mencakup variabel yang harus Anda tetapkan nilainya. Konfigurasi Terraform mencakup variabel lain yang memiliki nilai default. Untuk meninjau semua variabel dan nilai default, lihat file variables.tf yang tersedia di direktori $HOME/cloudshell_open/terraform-cloud-client-api/infra.
   • Pastikan setiap nilai yang Anda tetapkan dalam file terraform.tfvars cocok dengan jenis variabel seperti yang dideklarasikan dalam file variables.tf. Misalnya, jika jenis yang ditentukan untuk variabel dalam file variables.tf adalah file bool, Anda harus menentukan true atau false sebagai nilai variabel tersebut di file terraform.tfvars.

   # ID of the project in which you want to deploy the solution
   project_id = "PROJECT_ID"
   
   # Google Cloud region where you want to deploy the solution
   # Example: us-central1
   region = "REGION"
   
   # Programming language implementation to use
   # Example: python
   language = "LANGUAGE"
   
   # Version of application image to use
   # Example: 0.4.0
   image_version = "IMAGE_VERSION"
   

Untuk mengetahui informasi tentang nilai yang dapat Anda tetapkan untuk variabel-variabel yang diperlukan, lihat berikut ini:

• project_id: Mengidentifikasi project.
• region: Region yang tersedia.
• language: Implementasi bahasa pemrograman yang akan digunakan.
• image_version: Versi image aplikasi yang akan digunakan.

Memvalidasi dan meninjau konfigurasi Terraform

1. Pastikan direktori yang sedang bekerja adalah $HOME/cloudshell_open/terraform-cloud-client-api/infra. Jika bukan, buka direktori tersebut.

2. Pastikan konfigurasi Terraform tidak terdapat error:

   terraform validate
   

   Jika perintah menunjukkan error, lakukan perbaikan yang diperlukan dalam konfigurasi kemudian jalankan kembali perintahterraform validate. Ulangi langkah ini hingga perintah menunjukkan pesan berikut:

   Success! The configuration is valid.
   

3. Tinjau resource yang ditentukan dalam konfigurasi:

   terraform plan
   

4. Jika Anda tidak membuat file terraform.tfvars seperti yang dijelaskan sebelumnya, Terraform akan meminta Anda memasukkan nilai untuk variabel yang tidak memiliki nilai default. Masukkan nilai yang diperlukan.

   Output perintah terraform plan adalah daftar resource yang disediakan Terraform ketika Anda menerapkan konfigurasi.

   Jika Anda ingin melakukan perubahan, edit konfigurasi, kemudian jalankan kembali perintah terraform validate dan terraform plan.

Menyediakan resource

Jika tidak ada perubahan lebih lanjut yang diperlukan dalam konfigurasi Terraform, deploy resource.

1. Pastikan direktori yang sedang bekerja adalah $HOME/cloudshell_open/terraform-cloud-client-api/infra. Jika bukan, buka direktori tersebut.

2. Terapkan konfigurasi Terraform:

   terraform apply
   

3. Jika Anda tidak membuat file terraform.tfvars seperti yang dijelaskan sebelumnya, Terraform akan meminta Anda memasukkan nilai untuk variabel yang tidak memiliki nilai default. Masukkan nilai yang diperlukan.

   Terraform menampilkan daftar resource yang akan dibuat.

4. Ketika Anda diminta untuk melakukan tindakan, masukkan yes.

   Terraform menampilkan pesan yang menunjukkan progres deployment.

   Jika deployment tidak dapat diselesaikan, Terraform akan menampilkan error yang menyebabkan kegagalan. Tinjau pesan error dan update konfigurasi untuk memperbaiki error. Kemudian jalankan kembali perintah terraform apply. Untuk bantuan terkait pemecahan masalah error Terraform, lihat Error ketika men-deploy solusi menggunakan Terraform CLI.

   Setelah semua resource dibuat, Terraform akan menampilkan pesan berikut:

   Apply complete!
   

5. Untuk melihat solusi, kembali ke halaman Deployment solusi di konsol.

6. Dengan solusi ini, Anda perlu menjalankan tugas pemrosesan data menggunakan tugas Cloud Run agar dapat mentransformasi dan berinteraksi dengan set data sampel. Untuk mengikuti panduan langkah demi langkah untuk tugas ini langsung di konsol Google Cloud, klik Mulai tugas pemrosesan data.

   Memulai tugas pemrosesan data

7. Untuk melihat resource Google Cloud yang di-deploy beserta konfigurasinya, pilih tur interaktif dalam bahasa pilihan Anda (Python, Node.js, atau Java).

   Memilih tur

   Setelah memproses set data contoh ke bucket Cloud Storage, Anda dapat terus menggunakan solusi Library Klien Cloud SDK untuk mempelajari lebih lanjut cara berinteraksi dengan Google Cloud API, cara API didukung oleh Identity and Access Management, dan memecahkan masalah API di aplikasi Cloud Client API.

Ketika Anda tidak lagi memerlukan solusi tersebut, Anda dapat menghapus deployment untuk menghindari penagihan berkelanjutan untuk resource Google Cloud tersebut. Untuk mengetahui informasi selengkapnya, lihat Menghapus deployment.

Menghapus deployment

Jika tidak lagi membutuhkan solusi, hapus semua resource yang telah Anda buat dalam solusi tersebut untuk menghindari penagihan berkelanjutan.

Menghapus melalui konsol

Gunakan prosedur ini jika Anda men-deploy solusi melalui konsol.

1. Pada Konsol Google Cloud, buka halaman Deployment solusi.

   Buka Deployment solusi

2. Pilih project berisi deployment yang ingin Anda hapus.

3. Cari deployment yang ingin Anda hapus.

4. Di baris untuk deployment, klik Tindakan, lalu pilih Hapus.

   Anda mungkin perlu men-scroll untuk melihat Tindakan di baris.

5. Masukkan nama deployment, lalu klik Konfirmasi.

   Kolom Status menampilkan Menghapus.

   Jika penghapusan gagal, lihat panduan pemecahan masalah pada bagian Error saat menghapus deployment.

Jika tidak lagi memerlukan project Google Cloud yang digunakan untuk solusi, Anda dapat menghapus project tersebut. Untuk informasi selengkapnya, lihat Opsional: Menghapus project

Menghapus menggunakan Terraform CLI

Gunakan prosedur ini jika Anda men-deploy solusi menggunakan Terraform CLI.

1. Di Cloud Shell, pastikan direktori kerja saat ini adalah $HOME/cloudshell_open/terraform-cloud-client-api/infra. Jika bukan, buka direktori tersebut.

2. Hapus resource yang disediakan oleh Terraform:

   terraform destroy
   

   Terraform menampilkan daftar resource yang akan dimusnahkan.

3. Ketika Anda diminta untuk melakukan tindakan, masukkan yes.

   Terraform menampilkan pesan yang menunjukkan progres. Setelah semua resource dihapus, Terraform akan menampilkan pesan berikut:

   Destroy complete!
   

   Jika penghapusan gagal, lihat panduan pemecahan masalah pada bagian Error saat menghapus deployment.

Jika tidak lagi memerlukan project Google Cloud yang digunakan untuk solusi, Anda dapat menghapus project tersebut. Untuk informasi selengkapnya, lihat Opsional: Menghapus project

Opsional: Menghapus project

Jika Anda men-deploy solusi di project Google Cloud baru, dan tidak lagi memerlukan project tersebut, hapus dengan melakukan langkah-langkah berikut:

Perhatian: Jika Anda menghapus project, seluruh resource dalam project tersebut akan dihapus secara permanen.

1. Pada Konsol Google Cloud, buka halaman Kelola resource

   Buka Kelola resource

2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Hapus.
3. Pada layar perintah, ketik project ID, lalu klik Matikan.

Jika Anda memutuskan untuk mempertahankan project, hapus akun layanan yang dibuat untuk solusi ini, seperti yang akan dijelaskan pada bagian selanjutnya.

Opsional: Menghapus akun layanan

Jika Anda menghapus project yang digunakan untuk solusi tersebut, lewati bagian ini.

Seperti yang telah disebutkan dalam panduan ini, ketika men-deploy solusi, akun layanan akan dibuat atas nama Anda. Akun layanan telah diberi izin IAM tertentu untuk sementara; yaitu, izin yang otomatis dicabut setelah operasi deployment dan penghapusan solusi selesai, tetapi akun layanan tidak dihapus. Google merekomendasikan agar Anda menghapus akun layanan ini.

• Jika Anda men-deploy solusi melalui Konsol Google Cloud, buka halaman Deployment solusi. (Jika Anda sudah berada di halaman tersebut, muat ulang browser.) Proses terpicu di latar belakang untuk menghapus akun layanan. Tidak ada tindakan lebih lanjut yang diperlukan.

• Jika Anda men-deploy solusi menggunakan Terraform CLI, lakukan langkah-langkah berikut:

  1. Di Konsol Google Cloud, buka halaman Service accounts.

     Buka halaman Service accounts

  2. Pilih project yang Anda gunakan untuk solusi tersebut.

  3. Pilih akun layanan yang ingin Anda hapus.

     ID email akun layanan yang digunakan untuk membuat solusi menggunakan format berikut:

     goog-sc-DEPLOYMENT_NAME-NNN@PROJECT_ID.
     

     ID email berisi nilai-nilai berikut:

     • DEPLOYMENT_NAME: nama deployment.
     • NNN: 3 digit angka acak.
     • PROJECT_ID: ID project tempat Anda men-deploy solusi.

  4. Klik Delete.

Mengatasi error

Tindakan yang dapat Anda lakukan untuk mendiagnosis dan mengatasi error bergantung pada metode deployment dan kompleksitas error.

Error ketika men-deploy melalui konsol

Jika deployment gagal saat Anda menggunakan konsol, lakukan hal-hal berikut:

1. Buka halaman Deployment solusi.

   Jika deployment gagal, kolom Status akan menampilkan Gagal.

2. Lihat detail error yang menyebabkan kegagalan:

   1. Di baris untuk deployment, klik Tindakan.

      Anda mungkin perlu men-scroll untuk melihat Tindakan di baris.

   2. Pilih Lihat log Cloud Build.

3. Tinjau log Cloud Build dan ambil tindakan yang sesuai untuk menyelesaikan masalah yang menyebabkan kegagalan.

Error ketika men-deploy menggunakan Terraform CLI

Jika deployment gagal saat Anda menggunakan Terraform, output perintah terraform apply akan menyertakan pesan error yang dapat Anda tinjau untuk mendiagnosis masalah.

Pada bagian berikut ditunjukkan contoh error deployment yang mungkin Anda alami saat menggunakan Terraform.

Error API dinonaktifkan

Jika Anda membuat project dan segera mencoba men-deploy solusi di project baru, deployment mungkin akan gagal dengan error seperti berikut:

Error: Error creating Network: googleapi: Error 403: Compute Engine API has not
been used in project PROJECT_ID before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/compute.googleapis.com/overview?project=PROJECT_ID
then retry. If you enabled this API recently, wait a few minutes for the action
to propagate to our systems and retry.

Jika terjadi error, tunggu beberapa menit, lalu jalankan kembali perintah terraform apply.

Error ketika menghapus deployment

Dalam kasus tertentu, upaya untuk menghapus deployment mungkin akan gagal:

• Jika Anda mengubah resource yang disediakan oleh solusi setelah men-deploy solusi melalui konsol, lalu Anda mencoba menghapus deployment, penghapusan mungkin akan gagal. Kolom Status pada halaman Deployment solusi akan menampilkan Gagal, dan log Cloud Build akan menunjukkan penyebab error.
• Jika Anda mengubah resource dengan menggunakan antarmuka non-Terraform (misalnya, konsol) setelah men-deploy solusi menggunakan Terraform CLI, kemudian Anda mencoba menghapus deployment, penghapusan mungkin akan gagal. Pesan dalam output perintah terraform destroy menunjukkan penyebab error.

Tinjau log dan pesan error serta identifikasi dan hapus resource yang menyebabkan error tersebut. Setelah itu, coba hapus kembali deployment.

Jika deployment berbasis konsol tidak dapat dihapus dan Anda tidak dapat mendiagnosis error menggunakan log Cloud Build, Anda dapat menghapus deployment tersebut menggunakan Terraform CLI yang akan dijelaskan pada bagian berikutnya.

Menghapus deployment berbasis konsol menggunakan Terraform CLI

Bagian ini menjelaskan cara menghapus deployment berbasis konsol jika terjadi error saat Anda mencoba menghapusnya melalui konsol. Dalam pendekatan ini, Anda perlu mendownload konfigurasi Terraform untuk deployment yang ingin dihapus, lalu gunakan Terraform CLI untuk menghapus deployment tersebut.

1. Identifikasi region tempat kode Terraform, log, dan data deployment lainnya disimpan. Region ini mungkin berbeda dari region yang Anda pilih ketika men-deploy solusi.

   1. Pada Konsol Google Cloud, buka halaman Deployment solusi.

      Buka Deployment solusi

   2. Pilih project berisi deployment yang ingin Anda hapus.

   3. Dalam daftar deployment, identifikasi baris deployment yang ingin Anda hapus.

   4. Klik Lihat semua konten baris.

   5. Pada kolom Lokasi, catat lokasi kedua seperti yang ditandai dalam contoh berikut:

      

2. Di konsol Google Cloud, aktifkan Cloud Shell.

   Aktifkan Cloud Shell

   Di bagian bawah Google Cloud Console, Cloud Shell sesi akan terbuka dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi sesi.

3. Membuat variabel lingkungan untuk project ID, region, dan nama deployment yang ingin Anda hapus:

   export REGION="REGION"
   export PROJECT_ID="PROJECT_ID"
   export DEPLOYMENT_NAME="DEPLOYMENT_NAME"
   

   Dalam perintah ini, ganti kode berikut:

   • REGION: lokasi yang Anda catat sebelumnya dalam prosedur ini.
   • PROJECT_ID: ID project tempat Anda men-deploy solusi.
   • DEPLOYMENT_NAME: nama deployment yang ingin Anda hapus.

4. Dapatkan ID revisi deployment terbaru yang ingin Anda hapus:

   export REVISION_ID=$(curl \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json" \
       "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
       | jq .latestRevision -r)
       echo $REVISION_ID
   

   Outputnya mirip dengan yang berikut ini:

   projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME/revisions/r-0
   

5. Dapatkan lokasi Cloud Storage dari konfigurasi Terraform untuk deployment:

   export CONTENT_PATH=$(curl \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json" \
       "https://config.googleapis.com/v1alpha2/${REVISION_ID}" \
       | jq .applyResults.content -r)
       echo $CONTENT_PATH
   

   Berikut adalah contoh output dari perintah ini:

   gs://PROJECT_ID-REGION-blueprint-config/DEPLOYMENT_NAME/r-0/apply_results/content
   

6. Download konfigurasi Terraform dari Cloud Storage ke Cloud Shell:

   gcloud storage cp $CONTENT_PATH $HOME --recursive
   cd $HOME/content/infra
   

   Tunggu hingga pesan Operation completed ditampilkan, seperti yang ditunjukkan dalam contoh berikut:

   Operation completed over 45 objects/268.5 KiB
   

7. Lakukan inisialisasi Terraform:

   terraform init
   

   Tunggu hingga Anda melihat pesan berikut:

   Terraform has been successfully initialized!
   

8. Menghapus resource yang di-deploy:

   terraform destroy
   

   Terraform menampilkan daftar resource yang akan dimusnahkan.

   Jika muncul peringatan tentang variabel yang tidak dideklarasikan, abaikan peringatan tersebut.

9. Ketika Anda diminta untuk melakukan tindakan, masukkan yes.

   Terraform menampilkan pesan yang menunjukkan progres. Setelah semua resource dihapus, Terraform akan menampilkan pesan berikut:

   Destroy complete!
   

10. Menghapus artefak deployment:

    curl -X DELETE \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}?force=true&delete_policy=abandon"
    

11. Tunggu beberapa detik, lalu verifikasi bahwa artefak deployment telah dihapus:

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
        | jq .error.message
    

    Jika output menampilkan null, tunggu beberapa detik, lalu jalankan kembali perintah.

    Setelah artefak deployment dihapus, pesan seperti yang ditunjukkan pada contoh yang ditampilkan berikut ini:

    Resource 'projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME' was not found
    

Mengirim masukan

Solusi Praktis hanya untuk keperluan informasi dan bukan produk yang didukung secara resmi. Google dapat mengubah atau menghapus solusi tanpa pemberitahuan.

Untuk mengatasi error, tinjau log Cloud Build dan output Terraform.

Untuk mengirim masukan, lakukan hal-hal berikut:

• Untuk dokumentasi, tutorial dalam konsol, atau solusi, gunakan tombol Kirim Masukan pada halaman tersebut.

• Untuk kode Terraform yang tidak dimodifikasi, buat laporan masalah di Repositori GitHub. Laporan masalah pada GitHub ditinjau berdasarkan upaya terbaik dan tidak ditujukan untuk pertanyaan umum.

• Untuk masalah terkait produk yang digunakan dalam solusi, hubungi Cloud Customer Care.

Langkah selanjutnya

Untuk mempelajari lebih lanjut solusi Library Klien Cloud SDK:

• Pelajari API yang mendukung Google Cloud, dan cara berinteraksi dengan API tersebut dalam bahasa pemrograman pilihan Anda.
• Pelajari cara API didukung oleh Identity and Access Management di Google Cloud.
• Memecahkan masalah API di aplikasi Cloud Client API.

Kontributor

Penulis: Kadeem Dunn | Technical Writer

Kontributor lainnya: Katie McLaughlin | Senior Developer Relations Engineer