Mengelola library dan Cloud API di Cloud Code for IntelliJ

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

Dokumen ini menjelaskan cara menjelajahi API yang tersedia, mengaktifkan Cloud API, dan menambahkan Library Klien Cloud ke project Anda, serta menyiapkan autentikasi bergantung pada kebutuhan pengembangan Anda.

Menjelajahi Cloud API

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

  1. Pilih Tools > Cloud Code > Add Cloud Libraries and Manage Cloud APIs.
  2. Perluas hierarki Google Cloud APIs Explorer untuk melihat semua API yang tersedia. Penjelajah mengelompokkan Cloud API menurut kategori. Anda juga dapat mencari API tertentu menggunakan kotak penelusuran Search APIs.
    3. Screenshot yang menampilkan daftar Cloud API yang ditampilkan di penjelajah tampilan pohon.
  3. Klik API untuk melihat detail selengkapnya, seperti statusnya, petunjuk penginstalan khusus bahasa untuk library klien yang sesuai, dan dokumentasi yang relevan.

Mengaktifkan Cloud API

Untuk mengaktifkan Cloud API dengan cepat 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 tombol Enable API.

    Setelah API diaktifkan, Anda akan melihat pesan yang mengonfirmasi perubahan ini.

Menambahkan Library Klien Cloud

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

Untuk project Java Maven

  1. Pilih Tools > Cloud Code > Cloud APIs.

    2. Dialog Kelola Google Cloud API menampilkan library yang didukung.

    Screenshot yang menampilkan dialog Kelola Cloud API. Dialog ini menyediakan menu drop-down untuk memilih modul yang akan ditambahkan library, menampilkan daftar API yang tersedia untuk ditambahkan, dan menyediakan area kerja yang menampilkan informasi tentang API.
  2. Pilih jenis library pilihan Anda dari pilihan Library Klien Google Cloud (direkomendasikan) atau Library Java Spring Google Cloud.
  3. Di menu drop-down Module, pilih modul yang ingin Anda tambahi library.
  4. Klik Add Maven Dependency untuk menambahkan BOM dan library klien ke project Anda.

Untuk semua project lainnya

  1. Pilih Tools > Cloud Code > Add Cloud Libraries and Manage Cloud APIs.

    2. Dialog Add Google Cloud Libraries menampilkan library yang didukung.

    Screenshot yang menampilkan dialog Tambahkan Library Cloud. Dialog ini menampilkan daftar API yang tersedia untuk ditambahkan dan menyediakan area kerja yang menampilkan informasi tentang API.
  2. Instal API menggunakan petunjuk penginstalan yang tercantum di halaman detail API untuk bahasa pilihan Anda.

Menyiapkan autentikasi

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

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

Pengembangan lokal

minikube

  1. Pastikan Anda telah menyiapkan Kredensial Default Aplikasi (ADC) dengan menjalankan gcloud auth application-default login. Hal ini memungkinkan minikube menemukan ADC Anda untuk mengautentikasi.

minikube

  1. Pastikan Anda telah menyiapkan Kredensial Default Aplikasi (ADC) dengan menjalankan gcloud auth application-default login. Dengan demikian, minikube dapat menemukan ADC Anda untuk mengautentikasi.
  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 gcp-auth minikube.

Cluster Kubernetes lokal

  1. Pastikan Anda telah menyiapkan Kredensial Default Aplikasi (ADC) dengan menjalankan gcloud auth application-default login.
  2. Pasang direktori gcloud lokal di pod Kubernetes Anda dengan mengedit manifes 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

  1. Pastikan Anda telah menyiapkan Kredensial Default Aplikasi (ADC) dengan menjalankan gcloud auth application-default login. Hal ini memungkinkan lingkungan simulasi lokal Cloud Run menemukan ADC Anda untuk melakukan autentikasi.

Pengembangan jarak jauh

Google Kubernetes Engine

  1. Konfigurasi cluster dan aplikasi GKE Anda dengan Workload Identity untuk melakukan autentikasi layanan Google Cloud di GKE. Tindakan ini mengaitkan akun layanan Kubernetes Anda dengan akun layanan Google Anda.
  2. Jika layanan Google Cloud yang ingin Anda akses memerlukan peran tambahan, berikan peran tersebut untuk akun layanan Google yang Anda gunakan untuk mengembangkan aplikasi Anda.
    Untuk mengetahui daftar jenis peran IAM dan peran bawaan yang dapat Anda berikan kepada identitas, lihat panduan Memahami peran. Untuk mengetahui langkah-langkah memberikan peran, lihat Memberikan, mengubah, dan mencabut akses ke resource.
  3. Konfigurasi Deployment Kubernetes Anda untuk mereferensikan akun layanan Kubernetes dengan menyetel kolom .spec.serviceAccountName di file YAML Deployment Kubernetes Anda.
    Jika Anda mengerjakan aplikasi yang dibuat dari template Cloud Code, file ini berada di folder kubernetes-manifests.

Cloud Run

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

    Buka halaman Service Accounts

  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 ingin Anda akses memerlukan peran tambahan, berikan peran tersebut, klik Lanjutkan, lalu klik Selesai.
  6. Untuk menambahkan akun layanan ke konfigurasi deployment, buka konfigurasi eksekusi Cloud Run: Deploy, perluas bagian Advanced revision settings, lalu tentukan akun layanan Anda di kolom Service Account.
    Bagian Advanced revision settings yang diperluas di Cloud Run: Kolom Deploy dan Service Account diisi dengan nama akun layanan dalam format service-account-name@project-name.iam.gserviceaccount.com

Cloud Run

  1. Konfigurasi cluster dan aplikasi GKE Anda dengan Workload Identity untuk melakukan autentikasi layanan Google Cloud di GKE. Tindakan ini mengaitkan akun layanan Kubernetes Anda dengan akun layanan Google Anda.
  2. Jika layanan Google Cloud yang ingin Anda akses memerlukan peran tambahan, berikan peran tersebut untuk akun layanan Google yang Anda gunakan untuk mengembangkan aplikasi.
    Panduan Memahami peran menjelaskan jenis peran IAM dan mencantumkan peran standar yang tersedia yang dapat Anda berikan kepada identitas.
  3. Untuk menambahkan akun layanan Kubernetes ke konfigurasi deployment Anda, buka konfigurasi eksekusi Cloud Run: Deploy, perluas bagian Advanced revision settings, lalu tentukan akun layanan Kubernetes Anda di kolom Service Account.
    Bagian setelan revisi lanjutan diperluas di Cloud Run: Kolom Deploy dan Service Account diisi dengan nama akun layanan Kubernetes

Pengembangan jarak jauh dengan Secret Manager diaktifkan

Jika Anda mengembangkan dari jarak jauh, menggunakan akun layanan untuk autentikasi, dan aplikasi Anda menggunakan secret, Anda perlu menyelesaikan beberapa langkah lagi untuk menetapkan peran yang diperlukan untuk mengakses secret Secret Manager tertentu ke akun layanan Google Anda:

  1. Buka panel Secret Manager dan pilih secret yang ingin Anda akses dalam kode.

    Secret Manager di Cloud Code ditandai di sidebar kanan dan panel Secret Manager terbuka dengan tiga secret yang tercantum dan detail versi secret 'test' yang tercantum di panel bawah

  2. Beralihlah ke tab Izin, lalu konfigurasi izin rahasia Anda dengan mengklik edit Edit Izin. Halaman konfigurasi Secret Manager untuk secret akan terbuka di browser web Anda.

    Tab Izin dipilih dalam Secret Manager dan ikon Edit Izin ditandai

  3. Di Google Cloud konsol, klik Tampilkan Panel Info, lalu klik Tambahkan akun utama.

  4. Tetapkan peran Secret Manager Secret Accessor ke akun layanan Anda.

    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.