Ringkasan Cloud Code for IntelliJ Kubernetes

Halaman ini memberikan ringkasan pengembangan Kubernetes di Cloud Code.

Menggunakan Kubernetes Explorer di Cloud Code

Dengan Explorer Kubernetes, Anda dapat mengakses informasi tentang cluster, node, workload, dan lainnya, langsung dari IDE Anda. Anda juga dapat menetapkan konteks saat ini, mengalirkan dan melihat log, membuka terminal interaktif, dan mencari deskripsi resource dengan Kubernetes Explorer.

Penjelajah Kubernetes Cloud Code

Cloud Code menggunakan file kubeconfig default, yang terletak di direktori $HOME/.kube di MacOS/Linux atau %USERPROFILE%\.kube di Windows, untuk mengambil resource Kubernetes. Anda dapat mengganti atau menambahkan file Kubeconfig baru dari dalam Kubernetes Explorer. File kubeconfig adalah file YAML yang berisi detail cluster Kubernetes, sertifikat, dan token rahasia Anda untuk mengautentikasi ke cluster.

Untuk menggunakan file kubeconfig selain kubeconfig default, lihat panduan Bekerja dengan file kubeconfig.

Mengakses Kubernetes Explorer

Untuk melihat dan mengelola resource Kubernetes, gunakan Kubernetes Explorer, yang dapat diakses dari panel samping di sebelah kanan. Atau, dapat diakses menggunakan Tools > Cloud Code > Kubernetes > View Cluster Explorer.

Saat Anda memulai sesi pengembangan atau proses debug, bagian Sesi pengembangan akan menampilkan tampilan logging terstruktur.

Panel sesi pengembangan

Tindakan dasar

Kubernetes Explorer didukung oleh kubectl. Selama Anda telah mengonfigurasi file kubectl config untuk mengakses cluster, Anda dapat menggunakan Kubernetes Explorer untuk menambahkan cluster, menjelajahi semua namespace, resource, dan node yang tersedia untuk cluster Anda, terlepas dari apakah cluster tersebut berada dalam konteks aktif atau tidak aktif.

Tindakan Kubernetes umum yang tersedia, yang dapat diakses melalui ikonnya di Kubernetes Explorer, adalah:

  • Ikon aplikasi Kubernetes baru dari sampel Membuat aplikasi Kubernetes baru dari sampel
  • Ikon muat ulang penjelajah Muat ulang Explorer
  • ikon buka dokumen Buka dokumentasi Cloud Code Kubernetes di browser web

Tindakan penelusuran kesalahan Kubernetes umum tambahan, yang dapat diakses melalui ikonnya di Penjelajah Kubernetes, adalah:

  • Ikon Run Jalankan konfigurasi Run/Debug saat ini.
  • Ikon debug Luncurkan konfigurasi run dalam mode debug.
  • Ikon berhenti debug Menghentikan sesi debug aktif.

Menyalin nama resource

Anda dapat menyalin nama resource Kubernetes apa pun ke papan klip (termasuk nama container dan cluster). Untuk menyalin nama resource, klik kanan resource, lalu pilih Salin nama resource.

Menyalin nama resource menggunakan menu klik kanan

Memuat ulang resource

Penjelajah Kubernetes memantau perubahan dan otomatis memuat ulang untuk mencerminkan update. Untuk memuat ulang paksa resource Kubernetes guna mengambil informasi terbarunya, klik kanan resource dan pilih Muat ulang.

Memuat ulang pod menggunakan menu klik kanan

Anda juga dapat memuat ulang seluruh Explorer Kubernetes secara paksa menggunakan tombol muat ulang Explorer Kubernetes. Tombol muat ulang penjelajah Kubernetes

Mendeskripsikan resource

Untuk menampilkan detail resource non-cluster, klik kanan resource, lalu pilih Describe. Informasi resource ditampilkan di panel konsol Kubernetes Explorer.

Opsi Describe tersedia saat mengklik kanan resource yang sesuai dalam Kubernetes Explorer dan memilih Describe

Untuk melihat detail resource, Anda juga dapat mengklik resource mana pun. Jika memiliki metadata terlampir, metadata tersebut tersedia di panel Detail Resource di Kubernetes Explorer.

Melihat metadata resource dalam panel Detail Resource yang tersedia di paruh kedua Kubernetes Explorer

Opsi Skaffold

  • Konfigurasi Skaffold - memilih file konfigurasi skaffold.yaml. Akan otomatis terdeteksi jika Anda memiliki skaffold.yaml dalam project.
  • Profil deployment - memilih profil dari opsi yang tersedia yang dikonfigurasi dalam file skaffold.yaml.
  • Variabel lingkungan - memungkinkan Anda mengonfigurasi variabel lingkungan tambahan untuk diteruskan ke proses deployment Skaffold. Flag Skaffold juga dapat dikonfigurasi sebagai variabel lingkungan untuk digunakan di kolom ini. Lihat dokumentasi referensi Skaffold CLI untuk mengetahui daftar lengkap variabel lingkungan Skaffold yang tersedia.
  • Banyaknya pembacaan - memungkinkan Anda menetapkan tingkat pembacaan output di trace, debug, info, warn, error, atau fatal. Tingkat kejelasan default adalah warn.

Opsi Kubernetes

  • Konteks Deployment - merepresentasikan konteks Kubernetes yang digunakan untuk men-deploy aplikasi Anda. Perilaku default, jika konteks deployment tidak ditentukan, adalah men-deploy ke konteks sistem Anda saat ini jika ada.

    Jika tidak ingin men-deploy ke konteks saat ini, di bagian Deployment pada setelan Run/Debug, Anda dapat memilih untuk:

    • Deploy secara lokal ke cluster minikube - memulai cluster minikube yang dikelola Cloud Code untuk menjalankan aplikasi Anda dan menghentikan cluster setelah deployment berhenti. Jika cluster minikube sudah berjalan, Cloud Code akan menggunakan cluster minikube yang ada untuk deployment.
    • Ganti konteks dan deploy ke - mengubah konteks saat ini di sistem Anda ke konteks yang ditentukan saat deployment.

      Memilih konteks deployment Kubernetes dalam konfigurasi Kubernetes Cloud Code

  • Hapus deployment setelah selesai - menghapus deployment Kubernetes saat proses dihentikan. Ini adalah perilaku default. Atau, Anda dapat mengalihkan setelan ini untuk mencegah penghapusan deployment

Menyesuaikan konfigurasi peluncuran

Untuk mengonfigurasi cara aplikasi Anda dijalankan, Anda dapat menyesuaikan file skaffold.yaml.

Anda juga dapat mengonfigurasi peluncuran di konfigurasi Run/Debug. Untuk mengedit konfigurasi, buka Run > Edit configurations.

Melihat YAML jarak jauh

Untuk melihat YAML resource di cluster Anda, langsung dari Kubernetes Explorer. Buka resource di Kubernetes Explorer, seperti pod, klik kanan nama resource, lalu pilih Lihat YAML Jarak Jauh.

File YAML yang sesuai dengan resource yang Anda tentukan akan terbuka di tab editor baru.

Lihat YAML pod dengan mengklik kanan labelnya di Kubernetes Explorer, lalu pilih 'View Remote YAML'

Melihat log

Anda dapat melakukan streaming dan melihat log dari resource Kubernetes ke konsol Kubernetes Explorer untuk memantau progresnya.

Setelah aplikasi Anda dibuat dan berjalan dalam mode reguler atau pengembangan, Anda dapat memantau streaming log dari aplikasi Anda dari dalam IDE.

Melihat log yang di-streaming dari aplikasi Java Hello World

Anda juga dapat melihat log dari layanan tertentu dengan membuka Kubernetes Explorer.

Untuk memilih resource yang ingin Anda lihat lognya, seperti pod, deployment, atau layanan:

  1. Klik kanan resource, lalu pilih Stream Logs. Atau, Anda dapat mengalirkan log untuk setiap container yang berjalan di pod.

    Tindakan ini akan menghasilkan log ke Konsol Kubernetes Explorer.

Untuk melihat status resource dalam deployment Anda:

  • Status pod, deployment, dan node: Resource Kubernetes ini memiliki tanda status berwarna di samping labelnya; merah untuk status gagal, kuning untuk status memulai/menghentikan/peringatan, dan hijau untuk status yang diinginkan dan berfungsi dengan baik.

    Tanda centang hijau di samping label pod menunjukkan status sehat

  • Deskripsi resource yang di-deploy: Anda dapat menjalankan kubectl describe pada resource yang di-deploy untuk menampilkan detailnya dengan mengklik kanan dan memilih Describe.

    Opsi Describe tersedia saat mengklik kanan resource yang sesuai dalam
panel Kubernetes Explorer dan memilih Describe

Luncurkan terminal

Untuk pod dan container, Anda dapat membuka terminal interaktif dengan mengklik kanan pod atau container dan memilih Dapatkan terminal.

Membuka terminal interaktif

Tindakan khusus resource

Kubernetes Explorer menampilkan cluster, namespace, node, beban kerja (seperti deployment, replicaset, pod, dan container), layanan dan ingress, konfigurasi (seperti secret dan config map), serta penyimpanan (seperti volume). Dengan menggunakan Kubernetes Explorer, Anda dapat melakukan tindakan unik pada beberapa resource ini.

Anda dapat mengakses Kubernetes Explorer dari panel samping atau membuka Tools > Cloud Code > Kubernetes > View Cluster Explorer.

Panel Kubernetes Explorer terbuka menggunakan tab di panel tugas sisi kanan

Untuk menampilkan detail resource yang di-deploy, klik kanan label resource di Kubernetes Explorer, lalu klik Describe.

Opsi Describe tersedia saat mengklik kanan resource yang sesuai di panel Kubernetes Explorer dan memilih Describe

Cluster

  • Menambahkan cluster Google Kubernetes Engine: Tambahkan cluster GKE Standard atau Autopilot yang ada atau buat yang baru dengan mengklik + Add GKE Cluster dalam Kubernetes Explorer.

Dialog Add Cluster akan muncul dan Anda dapat memilih project dan cluster yang ingin digunakan atau membuat cluster baru.

Setelah selesai, klik OK dan akses cluster yang Anda pilih serta resource pokoknya melalui Kubernetes Explorer.

Menambahkan cluster GKE dengan dialog Kubernetes Explorer dengan kolom untuk nama project dan cluster

  • Tetapkan sebagai konteks saat ini: Tetapkan cluster yang ditentukan sebagai aktif sehingga konteks kubectl yang dikonfigurasi mengakses cluster ini secara default.

    Menetapkan cluster sebagai konteks saat ini dengan Kubernetes Explorer

Kubernetes Explorer akan otomatis di-refresh dan Anda akan melihat simbol Kubernetes di samping cluster yang sesuai.

Jika cluster memiliki beberapa konteks yang dikonfigurasi, Anda dapat memilih salah satu konteks yang tersedia untuk ditetapkan sebagai konteks saat ini.

Memilih dan menyetel cluster aktif dari daftar beberapa konteks dengan Kubernetes Explorer

Namespace

  • Tetapkan sebagai konteks saat ini: Tetapkan namespace sebagai aktif sehingga konteks kubectl yang dikonfigurasi mengakses namespace ini secara default.

    Menetapkan namespace sebagai konteks saat ini menggunakan menu klik kanan

Jika tindakan ini berhasil, Kubernetes Explorer akan otomatis dimuat ulang dan Anda akan melihat tanda bintang di samping namespace untuk menunjukkan bahwa namespace tersebut adalah bagian dari konteks saat ini.

Perhatikan bahwa konteks Kubernetes adalah pintasan yang memberi Anda akses cepat ke namespace di cluster Anda. Konteks biasanya dibuat secara otomatis saat Anda memulai cluster minikube atau GKE. Jika Anda tidak melihat opsi Setel sebagai konteks saat ini untuk namespace tertentu dan ingin membuat konteks untuknya, gunakan perintah kubectl config set-context di terminal untuk menyetel konteks dengan cluster, pengguna, dan namespace pilihan Anda.

Pod

  • Melihat Log: Melihat log dari pod ke Konsol Kubernetes Explorer.
  • Dapatkan Terminal: Dapatkan terminal untuk pod di Konsol Kubernetes Explorer.

    Selain itu, pod yang sedang berjalan memiliki tanda status berwarna di samping labelnya:

    • Merah: Pod dalam status gagal
    • Kuning: Pod sedang dimulai atau dihentikan
    • Hijau: Pod dalam kondisi baik dan berjalan
Tanda centang hijau di samping pod menunjukkan status responsif

Container

  • Melihat log: Melihat log dari container ke konsol Kubernetes Explorer.
  • Dapatkan Terminal: Dapatkan terminal untuk container di konsol Kubernetes Explorer.
Mengalirkan log dari penampung menggunakan menu klik kanannya untuk menampilkan log ke Konsol Kubernetes Explorer

Deployment

  • Melihat log: Melihat log dari deployment ke konsol Kubernetes Explorer.

    Deployment aktif memiliki tanda status berwarna di samping label dan jumlah replika saat ini/total:

    • Kuning: Deployment tidak memiliki ketersediaan minimum atau memiliki masalah gambar.
    • Hijau: Deployment dalam kondisi baik dan memiliki ketersediaan minimum.
Ikon deployment hijau yang menunjukkan status responsif

Node

Node cluster Anda memiliki tanda status berwarna di samping namanya:

  • Kuning: Node memiliki masalah resource seperti ketersediaan memori atau disk.
  • Hijau: Node dalam kondisi baik.

Definisi Resource Kustom (CRD)

Kubernetes Explorer mencantumkan semua Definisi Resource Kustom (CRD) yang diinstal dan tersedia di cluster Anda:

Daftar definisi resource kustom di Explorer

Langkah berikutnya

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.