Mengelola library dan Cloud API di Cloud Code for IntelliJ

Anda dapat mengakses produk dan layanan Google Cloud dari kode Anda menggunakan Cloud API. Cloud API ini mengekspos antarmuka REST JSON sederhana yang dapat Anda panggil melalui library klien.

Dokumen ini menjelaskan cara mengaktifkan Cloud API dan menambahkan Library Klien Cloud ke project Anda.

Catatan: Untuk project yang tidak menggunakan Java dan Maven, Cloud Code tidak menambahkan Library Klien Cloud ke build Anda secara otomatis, tetapi mendukung fitur lain yang dijelaskan di sini dan menyediakan cuplikan build untuk sistem build Anda.

Menjelajahi Cloud API

Catatan: Daftar API dan library Cloud Code mencakup sebagian besar, tetapi tidak semua, API.

Untuk menjelajahi semua Google Cloud API yang tersedia di IDE Anda, ikuti langkah-langkah berikut:

1. Buka Tools > Google Cloud Code > Cloud APIs.

2. Jendela Manage Google Cloud APIs mengelompokkan Cloud API menurut kategori. Anda juga dapat menggunakan kotak penelusuran Search APIs untuk menemukan API tertentu.

   

3. Klik API untuk melihat detail selengkapnya, seperti statusnya, petunjuk penginstalan khusus bahasa untuk library klien yang sesuai, dan dokumentasi yang relevan.

Aktifkan Cloud API

Untuk mengaktifkan Cloud API untuk project menggunakan detail API, ikuti langkah-langkah berikut:

1. Di tampilan detail Cloud API, pilih project Google Cloud yang ingin Anda aktifkan Cloud API-nya.

2. Klik Enable API.

   Saat API diaktifkan, pesan akan muncul untuk mengonfirmasi perubahan.

Menambahkan Library Klien Cloud

Untuk menambahkan library ke project Anda di IntelliJ, ikuti langkah-langkah berikut:

Untuk project Java Maven

1. Buka Tools > Google Cloud Code > Cloud APIs.

Bagian Install Client Library di dialog Manage Google Cloud API menampilkan library yang didukung.

2. Pilih jenis library yang Anda inginkan sebagai Library Klien Google Cloud (direkomendasikan untuk sebagian besar project) atau Java Spring Google Cloud (direkomendasikan jika project Anda menggunakan Java Spring).
3. Ikuti petunjuk lainnya di Menginstal Library Klien di IDE Anda, jika berlaku.
Catatan: Google Cloud Java menyelesaikan konflik versi antar-library dengan menambahkan Bill of Materials (BOM) Google Cloud Java ke file pom.xml project Anda.
4. Setelah selesai, klik Tutup.

Untuk semua project lainnya

1. Buka Tools > Google Cloud Code > Cloud API.

Bagian Install Client Library di dialog Manage Google Cloud API menampilkan library yang didukung.

2. Untuk menginstal API, ikuti petunjuk penginstalan yang tercantum di halaman detail API untuk bahasa pilihan Anda.

   Jika mengembangkan aplikasi Java, Anda juga harus menentukan preferensi library sebagai Library Klien Google Cloud (direkomendasikan) atau Java Spring Google Cloud.

3. Setelah selesai, klik Tutup.

Menggunakan contoh kode API

Untuk menelusuri dan menggunakan contoh kode untuk setiap API di API Explorer, ikuti langkah-langkah berikut:

1. Buka Tools > Google Cloud Code > Cloud APIs.

2. Untuk membuka tampilan detail, klik nama API.

3. Untuk melihat contoh kode API, klik tab Contoh Kode.

4. Untuk memfilter daftar sampel, ketik teks yang akan ditelusuri atau pilih bahasa pemrograman dari menu drop-down Language.

Menyiapkan autentikasi

Setelah mengaktifkan API yang diperlukan dan menambahkan library klien yang diperlukan, Anda harus mengonfigurasi aplikasi agar berhasil diautentikasi. Konfigurasi Anda bergantung pada jenis pengembangan dan platform yang Anda jalankan.

Setelah Anda menyelesaikan langkah-langkah autentikasi yang relevan, aplikasi Anda dapat melakukan autentikasi dan siap di-deploy.

Pengembangan lokal

Komputer lokal

Cloud Code memastikan Anda telah menetapkan Kredensial Default Aplikasi (ADC) jika Anda login ke Google Cloud melalui IDE. Jika Anda tidak login dengan Cloud Code, jalankan gcloud auth application-default login secara manual.

minikube

1. Cloud Code memastikan Anda telah menetapkan Kredensial Default Aplikasi (ADC) jika Anda login ke Google Cloud melalui IDE. Jika Anda tidak login dengan Cloud Code, jalankan gcloud auth application-default login secara manual.
2. Mulai minikube dengan minikube start --addons gcp-auth. Tindakan ini akan memasang ADC di pod Anda. Untuk panduan autentikasi minikube mendetail untuk Google Cloud, lihat dokumen minikube gcp-auth.

Cluster K8s lokal lainnya

1. Cloud Code memastikan Anda telah menetapkan Kredensial Default Aplikasi (ADC) jika Anda login ke Google Cloud melalui IDE. Jika Anda tidak login dengan Cloud Code, jalankan gcloud auth application-default login secara manual.
2. Pasang direktori gcloud lokal di pod Kubernetes dengan mengedit spesifikasi Pod dalam manifes Pod atau Deployment, sehingga Library Klien Google Cloud dapat menemukan kredensial Anda. Contoh konfigurasi pod Kubernetes:

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-app
     labels:
       name: my-app
   spec:
     containers:
     - name: my-app
       image: gcr.io/google-containers/busybox
       ports:
         - containerPort: 8080
       volumeMounts:
         - mountPath: /root/.config/gcloud
           name: gcloud-volume
     volumes:
       - name: gcloud-volume
         hostPath:
           path: /path/to/home/.config/gcloud

Cloud Run

Cloud Code memastikan Anda telah menetapkan Kredensial Default Aplikasi (ADC) jika Anda login ke Google Cloud melalui IDE. Jika Anda tidak login dengan Cloud Code, jalankan gcloud auth application-default login secara manual.

Pengembangan jarak jauh

Google Kubernetes Engine

Bergantung pada cakupan project, Anda dapat memilih cara mengautentikasi layanan Google Cloud di GKE:

• (Khusus pengembangan)
  Catatan: Setelan akun layanan dan cakupan akses cluster GKE bersifat permanen; setelah cluster dibuat, setelan ini tidak dapat diubah. Tentukan setelan seperti yang direkomendasikan di bawah.
  1. Buat cluster GKE dengan setelan berikut:
     • Pastikan Anda menggunakan akun layanan yang digunakan GKE secara default, yaitu akun layanan default Compute Engine, dan bahwa Cakupan akses ditetapkan ke Izinkan akses penuh ke semua Cloud API (kedua setelan dapat diakses di bagian Node Pool > Keamanan).
       Karena akun layanan Compute Engine dibagikan oleh semua beban kerja yang di-deploy di node Anda, metode ini akan memberikan izin berlebih dan hanya boleh digunakan untuk pengembangan.
     • Pastikan Workload Identity tidak diaktifkan di cluster Anda (di bagian Cluster > Security).
  2. Tetapkan peran yang diperlukan ke akun layanan default Compute Engine:
     • Jika Anda mencoba mengakses secret, ikuti langkah-langkah khusus Secret Manager berikut untuk menyiapkan peran yang diperlukan di akun layanan Anda.
     • Jika akun layanan default Compute Engine sedang digunakan, peran IAM yang benar mungkin sudah diterapkan.

     • Untuk mengetahui daftar jenis peran IAM dan peran bawaan yang dapat Anda berikan ke identitas, lihat Panduan memahami peran.

       Untuk mengetahui langkah-langkah pemberian peran, lihat Memberikan, mengubah, dan mencabut akses ke resource.

• (Direkomendasikan untuk produksi)
  1. Konfigurasikan cluster dan aplikasi GKE Anda dengan Workload Identity untuk mengautentikasi layanan Google Cloud di GKE. Tindakan ini akan mengaitkan akun layanan Kubernetes dengan akun layanan Google Anda.
  2. Konfigurasikan Deployment Kubernetes untuk mereferensikan akun layanan Kubernetes dengan menetapkan kolom .spec.serviceAccountName dalam file YAML Deployment Kubernetes.
     Jika Anda mengerjakan aplikasi yang dibuat dari template Cloud Code, file ini terletak di dalam folder kubernetes-manifests.
  3. Jika layanan Google Cloud yang Anda coba akses memerlukan peran tambahan, berikan peran tersebut untuk akun layanan Google yang Anda gunakan untuk mengembangkan aplikasi Anda:
     • Jika Anda mencoba mengakses secret, ikuti langkah-langkah khusus Secret Manager berikut untuk menyiapkan peran yang diperlukan di akun layanan Anda.

     • Untuk mengetahui daftar jenis peran IAM dan peran bawaan yang dapat Anda berikan ke identitas, lihat Panduan memahami peran.

       Untuk mengetahui langkah-langkah pemberian peran, lihat Memberikan, mengubah, dan mencabut akses ke resource.

Cloud Run

1. Untuk membuat akun layanan unik baru guna men-deploy aplikasi Cloud Run, di halaman Akun Layanan, pilih project tempat secret Anda disimpan.
   

   Buka halaman Akun Layanan

2. Klik Create service account.
3. Di dialog Buat akun layanan, masukkan nama deskriptif untuk akun layanan.
4. Ubah ID akun layanan menjadi nilai yang unik dan dapat dikenali, lalu klik Buat.
5. Jika layanan Google Cloud yang Anda coba akses memerlukan peran tambahan, berikan peran tersebut, klik Lanjutkan, lalu klik Selesai.
6. Untuk menambahkan akun layanan Kubernetes ke konfigurasi deployment, buka Run > Edit Configurations, lalu tentukan akun layanan Anda di kolom Service Name.

Cloud Run

Bergantung pada cakupan project, Anda dapat memilih cara mengautentikasi layanan Google Cloud di GKE:

• (Khusus pengembangan)
  Catatan: Setelan akun layanan dan cakupan akses cluster GKE bersifat permanen; setelah cluster dibuat, setelan ini tidak dapat diubah. Tentukan setelan seperti yang direkomendasikan di bawah.
  1. Buat cluster GKE dengan setelan berikut:
     • Pastikan Anda menggunakan akun layanan yang digunakan GKE secara default, yaitu akun layanan default Compute Engine, dan bahwa Cakupan akses ditetapkan ke Izinkan akses penuh ke semua Cloud API (kedua setelan dapat diakses di bagian Node Pool > Keamanan).
       Karena akun layanan Compute Engine dibagikan oleh semua beban kerja yang di-deploy di node Anda, metode ini akan memberikan izin berlebih dan hanya boleh digunakan untuk pengembangan.
       
     • Pastikan Workload Identity tidak diaktifkan di cluster Anda (di bagian Cluster > Security).
  2. Tetapkan peran yang diperlukan ke akun layanan default Compute Engine:
     • Jika Anda mencoba mengakses secret, ikuti langkah-langkah khusus Secret Manager berikut untuk menyiapkan peran yang diperlukan di akun layanan Anda.
     • Jika akun layanan default Compute Engine sedang digunakan, peran IAM yang benar mungkin sudah diterapkan.

     • Untuk mengetahui daftar jenis peran IAM dan peran bawaan yang dapat Anda berikan ke identitas, lihat Panduan memahami peran.

       Untuk mengetahui langkah-langkah pemberian peran, lihat Memberikan, mengubah, dan mencabut akses ke resource.

• (Direkomendasikan untuk produksi)
  1. Konfigurasikan cluster dan aplikasi GKE Anda dengan Workload Identity untuk mengautentikasi layanan Google Cloud di GKE. Tindakan ini akan mengaitkan akun layanan Kubernetes dengan akun layanan Google Anda.
  2. Untuk menambahkan akun layanan Kubernetes ke konfigurasi deployment, buka Run > Edit Konfigurasi, lalu tentukan akun layanan Kubernetes di kolom Service Name.
     
  3. Jika layanan Google Cloud yang Anda coba akses memerlukan peran tambahan, berikan peran tersebut untuk akun layanan Google yang Anda gunakan untuk mengembangkan aplikasi Anda:
     • Jika Anda mencoba mengakses secret, ikuti langkah-langkah khusus Secret Manager berikut untuk menyiapkan peran yang diperlukan di akun layanan Anda.

     • Untuk mengetahui daftar jenis peran IAM dan peran bawaan yang dapat Anda berikan ke identitas, lihat Panduan memahami peran.

       Untuk mengetahui langkah-langkah pemberian peran, lihat Memberikan, mengubah, dan mencabut akses ke resource.

Pengembangan jarak jauh dengan izin Secret Manager diaktifkan

Jika Anda melakukan pengembangan dari jarak jauh, menggunakan akun layanan untuk autentikasi, dan aplikasi Anda menggunakan secret, Anda perlu menyelesaikan beberapa langkah lainnya selain petunjuk pengembangan jarak jauh. Langkah-langkah ini menetapkan peran yang diperlukan ke akun layanan Google Anda untuk mengakses secret Secret Manager tertentu:

1. Untuk membuka jendela alat Secret Manager, buka Tools > Google Cloud Code > Secret Manager.

2. Pilih secret yang ingin Anda akses dalam kode.

3. Klik tab Permissions, lalu konfigurasikan izin secret Anda dengan mengklik edit Edit Permission.

   

   Konsol Google Cloud akan terbuka di jendela baru browser web Anda, yang menampilkan halaman konfigurasi Secret Manager untuk secret Anda.

4. Di konsol Google Cloud, klik tab Permissions, lalu klik Grant Access.

5. Di kolom New principals, masukkan akun layanan Anda.

6. Di kolom dropdown Pilih peran, pilih peran Secret Manager Secret Accessor.

7. Jika sudah selesai, klik Simpan.

   Akun layanan Anda memiliki izin untuk mengakses secret ini.

Mendapatkan dukungan

Untuk mengirimkan masukan atau melaporkan masalah di IDE IntelliJ, buka Tools > Cloud Code > Help / About > Submit feedback or report an issue untuk melaporkan masalah di GitHub.