Ringkasan Cloud Code untuk IntelliJ Kubernetes

Halaman ini menyajikan ringkasan pengembangan Kubernetes di Cloud Code.

Menggunakan Kubernetes Explorer di Cloud Code

Kubernetes Explorer memungkinkan Anda mengakses informasi tentang cluster, node, beban kerja, dan lainnya, langsung dari IDE Anda. Anda juga dapat menetapkan konteks saat ini, melakukan streaming dan melihat log, membuka terminal interaktif, dan mencari deskripsi resource dengan Kubernetes Explorer.

Cloud Code Kubernetes explorer

Cloud Code menggunakan file kubeconfig default, yang terletak dalam direktori $HOME/.kube di MacOS/Linux atau %USERPROFILE%\.kube di Windows, untuk mengambil resource Kubernetes. Anda dapat beralih atau menambahkan file Kubeconfig baru dari dalam Kubernetes Explorer. File Kubeconfig adalah file YAML yang berisi detail, sertifikat, dan token rahasia cluster Kubernetes Anda untuk melakukan autentikasi 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 telah mengonfigurasi file konfigurasi kubectl 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:

  • Aplikasi Kubernetes baru dari ikon contoh Membuat aplikasi Kubernetes baru dari sampel
  • Muat ulang ikon penjelajah Muat ulang Penjelajah
  • ikon buka dokumen Membuka dokumentasi Kubernetes Cloud Code di browser web

Tindakan proses debug Kubernetes umum lainnya, yang dapat diakses melalui ikonnya di Kubernetes Explorer, adalah:

  • Ikon Run Jalankan konfigurasi Run/Debug saat ini.
  • Ikon debug Luncurkan konfigurasi run dalam mode debug.
  • Ikon berhenti debug Menghentikan sesi proses debug yang 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 Copy resource name.

Salin nama resource menggunakan menu klik kanan

Muat ulang referensi

Kubernetes Explorer memantau perubahan dan secara otomatis dimuat ulang untuk mencerminkan perubahan. Untuk memaksa pemuatan ulang resource Kubernetes guna mengambil informasi terbarunya, klik kanan resource, lalu pilih Refresh.

Memuat ulang pod menggunakan menu klik kanan

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

Menjelaskan sumber daya

Untuk menampilkan detail resource non-cluster apa pun, klik kanan resource, lalu pilih Jelaskan. Informasi resource dibacakan di panel konsol Kubernetes Explorer.

Menjelaskan opsi yang tersedia saat mengklik kanan resource yang sesuai dalam Kubernetes Explorer dan memilih Deskripsikan

Untuk melihat detail fasilitas, Anda juga dapat mengklik resource apa pun. Jika telah melampirkan metadata, metadata tersebut tersedia di panel Resource Details di Kubernetes Explorer.

Melihat metadata resource dalam panel Resource Details 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 di file skaffold.yaml Anda.
  • 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. Baca dokumentasi referensi CLI Skaffold untuk mengetahui daftar lengkap variabel lingkungan Skaffold yang tersedia.
  • Banyaknya pembacaan - memungkinkan Anda menyetel tingkat panjang output pada trace, debug, info, warn, error, atau fatal. Tingkat panjang default adalah warn.

Opsi Kubernetes

  • Konteks Deployment - menunjukkan konteks Kubernetes yang digunakan untuk men-deploy aplikasi Anda. Jika konteks deployment tidak ditentukan, perilaku default akan di-deploy ke konteks sistem Anda saat ini, jika ada.

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

    • Men-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.
    • Beralih konteks dan deploy ke - mengubah konteks saat ini di sistem Anda ke konteks yang ditentukan setelah deployment.

      Memilih konteks deployment Kubernetes dalam konfigurasi Kubernetes Cloud Code

  • Hapus deployment saat selesai - menghapus deployment Kubernetes saat proses dihentikan. Setelan ini merupakan perilaku default. Atau, Anda dapat mengalihkan setelan ini untuk mencegah deployment dihapus

Menyesuaikan konfigurasi peluncuran

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

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

Lihat 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 View Remote YAML.

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

Melihat YAML pod dengan mengklik kanan labelnya di Kubernetes Explorer dan memilih 'View Remote YAML'

Lihat log

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

Setelah aplikasi Anda di-build dan berjalan dalam mode reguler atau pengembangan, Anda akan dapat memantau streaming log dari aplikasi dari dalam IDE.

Melihat log streaming dari aplikasi Hello World Java

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

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

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

    Tindakan ini 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 memulai/berhenti/peringatan, dan hijau untuk status sehat yang diinginkan.

    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 Explain.

    Mendeskripsikan opsi yang tersedia saat mengklik kanan resource yang sesuai dalam panel Kubernetes Explorer dan memilih Deskripsikan

Meluncurkan terminal

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

Membuka terminal interaktif

Tindakan khusus resource

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

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

Panel Kubernetes Explorer terbuka menggunakan tab di taskbar sisi kanan

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

Menjelaskan opsi yang tersedia saat mengklik kanan resource yang sesuai di panel Kubernetes Explorer dan memilih Deskripsikan

Cluster

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

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

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

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

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

    Menetapkan cluster sebagai konteks saat ini dengan Kubernetes Explorer

Kubernetes Explorer akan otomatis dimuat ulang dan Anda akan melihat simbol Kubernetes di samping cluster yang sesuai.

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

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

Namespace

  • Tetapkan sebagai konteks saat ini: Menetapkan namespace ke aktif sedemikian rupa sehingga konteks kubectl yang Anda konfigurasikan 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 sebelah namespace untuk menandakan bahwa namespace merupakan 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 minikube atau cluster GKE. Jika Anda tidak melihat opsi Set as current context untuk namespace tertentu dan ingin membuat konteks untuknya, gunakan perintah kubectl config set-context di terminal Anda untuk menetapkan konteks dengan cluster, pengguna, dan namespace yang Anda inginkan.

Pod

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

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

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

Container

  • Melihat log: Melihat log dari container ke konsol Kubernetes Explorer.
  • Mendapatkan Terminal: Dapatkan terminal untuk container di konsol Kubernetes Explorer.
Melakukan streaming log dari container menggunakan menu klik kanan untuk menghasilkan log ke dalam Kubernetes Explorer Console

Deployment

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

    Deployment langsung 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 berjalan dengan baik dan memiliki ketersediaan minimum.
Ikon deployment hijau 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 responsif.

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 selanjutnya

Dapatkan dukungan

Untuk mengirimkan masukan atau melaporkan masalah di IntelliJ IDE, buka Alat > Cloud Code > Bantuan / Tentang > Kirim masukan atau laporkan masalah untuk melaporkan masalah di GitHub, atau ajukan pertanyaan di Stack Overflow.