Forecastle
v1.0.146
Ramalan cuaca Forecastle memberi Anda akses ke panel kontrol tempat Anda dapat melihat aplikasi yang sedang berjalan dan mengaksesnya di Kubernetes.
Forecastle menyediakan panel kontrol terpadu, yang berfungsi sebagai gateway yang nyaman untuk melihat dan mengakses aplikasi Anda yang di-deploy di Kubernetes. Baik itu alat pemantauan, saluran CI/CD, atau aplikasi lainnya, Forecastle menghadirkan semuanya ke ujung jari Anda di satu lokasi terpusat.
Forecastle menawarkan serangkaian fungsi yang dirancang untuk menyederhanakan pengelolaan dan aksesibilitas aplikasi di lingkungan Kubernetes. Fitur utama meliputi:
Daftar Aplikasi Komprehensif : Forecastle mengumpulkan dan menampilkan aplikasi dari semua namespace yang ditentukan dalam ConfigMap, memberikan tampilan terpusat pada sumber daya Anda.
Fungsi Pencarian : Temukan aplikasi tertentu dengan cepat dengan fitur pencarian intuitif, meningkatkan pengalaman dan efisiensi pengguna.
Pengelompokan Namespace : Aplikasi diatur dengan rapi dan dikelompokkan berdasarkan namespace masing-masing, membuat navigasi dan pengelolaan menjadi lebih mudah.
Header yang Dapat Disesuaikan : Sesuaikan tampilan dan nuansa dasbor Forecastle Anda dengan opsi header yang dapat dikonfigurasi, termasuk penyesuaian judul dan skema warna.
Dukungan untuk Banyak Instans : Forecastle dirancang untuk mendukung banyak instans, mengakomodasi skenario penerapan yang bervariasi dan kompleks.
Integrasi Aplikasi Khusus : Tambahkan aplikasi non-Kubernetes atau aplikasi eksternal dengan mudah ke dasbor Anda untuk mendapatkan gambaran umum yang lebih komprehensif tentang alat dan sumber daya Anda.
ForecastleApp CRD : Memanfaatkan Definisi Sumber Daya Kustom ForecastleApp untuk menambahkan aplikasi khusus secara dinamis, yang selanjutnya meningkatkan fleksibilitas dasbor.
Pengelompokan dan URL Khusus : Atur aplikasi Anda ke dalam grup khusus dan tetapkan URL spesifik untuk navigasi dan aksesibilitas yang disesuaikan.
Informasi Aplikasi Terperinci : Setiap aplikasi dilengkapi dengan informasi terperinci, menawarkan wawasan dan detail penting secara sekilas.
Bagian ini ditujukan bagi Administrator yang ingin menerapkan Forecastle pada klaster mereka. Forecastle menawarkan opsi penerapan yang fleksibel, mengakomodasi platform Kubernetes dan OpenShift dengan mudah.
Anda memiliki pilihan untuk menerapkan Forecastle menggunakan manifes tradisional atau melalui diagram Helm. Petunjuk mendetail untuk kedua metode disediakan di bawah ini untuk memandu Anda melalui proses penerapan.
Anda bisa mendapatkan Forecastle dengan menjalankan perintah berikut di cluster Anda:
untuk Kubernet:
kubectl apply -f https://raw.githubusercontent.com/stakater/Forecastle/master/deployments/kubernetes/forecastle.yamluntuk OpenShift:
kubectl apply -f https://raw.githubusercontent.com/stakater/Forecastle/master/deployments/openshift/forecastle.yamlUntuk lingkungan Kubernetes, Anda dapat menggunakan perintah port-foward berikut untuk mengakses dasbor Forecastle:
kubectl port-forward svc/forecastle 8080:8080Harap diperhatikan bahwa Anda perlu mengonfigurasi ingress untuk mengakses Forecastle dari luar klaster berdasarkan konfigurasi ingress klaster Anda.
Untuk lingkungan OpenShift, rute default dibuat untuk layanan Forecastle. Anda dapat mengakses dasbor menggunakan URL rute.
oc get route forecastle Ubah kunci namespaceSelector di Forecastle ConfigMap untuk mencantumkan namespace yang ingin Anda pantau oleh Forecastle. Untuk petunjuk detailnya, lihat konfigurasi pemilih namespace untuk petunjuknya.
Jika Anda telah mengonfigurasi Helm di kluster Kubernetes, terapkan Forecastle menggunakan diagram Helm. Grafiknya terletak di sini.
Sesuaikan konfigurasi di value.yaml jika diperlukan dan jalankan perintah berikut:
helm install forecastle ./deployments/kubernetes/chart/forecastleForecastle menyederhanakan penemuan dan pengelolaan aplikasi di Kubernetes dan OpenShift. Ini menggunakan anotasi spesifik pada ingresses dan menawarkan berbagai opsi konfigurasi untuk penyesuaian.
Anda dapat menyesuaikan Forecastle menggunakan ConfigMap atau file value.yaml saat menerapkan dengan Helm. Di bawah ini adalah bidang yang dapat dikonfigurasi:
| Bidang | Keterangan | Bawaan | Jenis |
|---|---|---|---|
| namespaceSelector | Pemilih namespace berbutir halus yang menggunakan kombinasi namespace berkode keras serta pemilih label | apapun: benar | Pemilih Ruang Nama |
| headerLatar Belakang | Warna latar belakang header (Ditentukan dengan cara CSS) | batal | rangkaian |
| headerLatar Depan | Warna latar depan header (Ditentukan dengan cara CSS) | batal | rangkaian |
| judul | Judul untuk dasbor perkiraan | "Prakiraan - Stakater" | rangkaian |
| nama contoh | Nama contoh peramalan | "" | rangkaian |
| aplikasi khusus | Daftar aplikasi khusus yang ingin Anda tambahkan ke instance perkiraan | {} | []Aplikasi Khusus |
| crdDiaktifkan | Mengaktifkan atau menonaktifkan ForecastleApp CRD | BENAR | bodoh |
Memilih namespace untuk dipantau Forecastle, baik dengan mencantumkan namespace tertentu atau menggunakan pemilih label.
| Bidang | Keterangan | Bawaan | Jenis |
|---|---|---|---|
| setiap | Boolean menjelaskan apakah semua namespace dipilih, berbeda dengan daftar yang membatasinya | PALSU | bodoh |
| labelSelector | Filter namespace berdasarkan tipe kubernetes metav1.LabelSelector | batal | metav1.LabelSelector |
| nama pertandingan | Daftar nama namespace | batal | []rangkaian |
Catatan: Jika Anda menentukan labelSelector dan matchNames , Forecastle akan menggabungkan semua namespace yang cocok dan menggunakannya.
Memungkinkan penambahan aplikasi non-Kubernetes atau eksternal ke Forecastle. Ini adalah fitur yang sangat berguna terutama ketika aplikasi Anda didistribusikan baik di dalam maupun di luar kubernetes. Anda dapat meneruskan serangkaian aplikasi khusus di dalam konfigurasi.
| Bidang | Keterangan | Jenis |
|---|---|---|
| nama | Nama aplikasi khusus | Rangkaian |
| ikon | URL ikon untuk aplikasi khusus | Rangkaian |
| url | URL aplikasi khusus | Rangkaian |
| kelompok | Grup untuk aplikasi khusus | Rangkaian |
| properti | Properti Tambahan aplikasi sebagai peta | peta[string]string |
| jaringanDibatasi | Apakah aplikasi dibatasi jaringan atau tidak | bodoh |
Di bawah ini adalah contoh bagaimana Anda dapat mengonfigurasi Forecastle menggunakan kombinasi pemilih namespace dan aplikasi khusus:
namespaceSelector :
labelSelector :
matchLabels :
component : redis
matchExpressions :
- {key: tier, operator: In, values: [cache]}
matchNames :
- test
title :
headerBackground :
headerForeground : " #ffffff "
instanceName : " Hello "
crdEnabled : false
customApps :
- name : Hello
icon : http://hello
url : http://helloicon
group : Test
properties :
Version : 1.0Konfigurasi ini menunjukkan cara menyetel pemilih namespace, menyesuaikan tampilan header, mengaktifkan atau menonaktifkan fitur CRD, dan menambahkan aplikasi kustom dengan properti tertentu.
Desain Forecastle memungkinkan untuk menjalankan banyak instance, memberikan skalabilitas dan fleksibilitas dalam lingkungan yang beragam. Inilah cara Anda dapat menskalakan Forecastle secara efektif.
Penerapan Dasar : Untuk menjalankan beberapa instance Forecastle, terapkan setiap instance dalam namespace terpisah. Tentukan daftar namespace untuk setiap instance untuk memantau masuknya.
Konfigurasi Instance Bernama : Untuk kontrol lebih besar atas aplikasi mana yang ditampilkan dalam instance tertentu (terlepas dari namespacenya), konfigurasikan setiap instance Forecastle dengan nama unik menggunakan pengaturan instanceName di konfigurasi Forecastle.
Tampilan Instans Khusus Aplikasi : Setelah memberi nama instans Anda, gunakan anotasi forecastle.stakater.com/instance pada ingress Anda. Anotasi ini menentukan aplikasi mana yang muncul di instance Forecastle mana.
Tampilan Beberapa Instans : Satu aplikasi (ingress) dapat muncul di beberapa dasbor Forecastle. Misalnya, jika Anda memiliki dua instance bernama dev-dashboard dan prod-dashboard, menambahkan dev-dashboard,prod-dashboard dalam anotasi instance ingress akan memastikan aplikasi terlihat di kedua dashboard.
Penamaan Unik di Helm : Saat menerapkan instance Forecastle melalui Helm, pastikan setiap instance memiliki nilai nameOverride yang unik (defaultnya adalah Forecastle). Langkah ini penting untuk menghindari konflik antara sumber daya global seperti ClusterRole dan ClusterRoleBinding.
Bagian ini ditujukan bagi Pengguna yang ingin menggunakan Forecastle di lingkungan Kubernetes mereka.
Forecastle mengidentifikasi aplikasi melalui anotasi yang ditambahkan ke ingress Kubernetes. Berikut cara menambahkan anotasi yang diperlukan:
| Anotasi | Keterangan | Diperlukan |
|---|---|---|
forecastle.stakater.com/expose | Tambahkan ini dengan nilai true pada masuknya aplikasi yang ingin Anda tampilkan di Forecastle | true |
forecastle.stakater.com/icon | Ikon/URL Gambar aplikasi; Ikon repo koleksi ikon/logo/gambar | false |
forecastle.stakater.com/appName | Nama khusus untuk aplikasi Anda. Gunakan jika Anda tidak ingin menggunakan nama ingress | false |
forecastle.stakater.com/group | Nama grup khusus. Gunakan jika Anda ingin aplikasi ditampilkan di grup yang berbeda dari namespace tempat aplikasi dijalankan | false |
forecastle.stakater.com/instance | Daftar nama instance perkiraan yang dipisahkan koma tempat Anda ingin aplikasi ini muncul. Gunakan saat Anda memiliki beberapa dasbor perkiraan | false |
forecastle.stakater.com/url | URL untuk aplikasi perkiraan (Ini akan menggantikan URL masuknya). Itu HARUS dimulai dengan skema yaitu, http:// atau https:// | false |
forecastle.stakater.com/properties | Daftar pasangan key:value yang dipisahkan koma untuk properti. Ini akan muncul sebagai daftar aplikasi yang dapat diperluas | false |
forecastle.stakater.com/network-restricted | Tentukan apakah aplikasi dibatasi jaringan atau tidak (benar atau salah) | false |
Cara lain Forecastle meningkatkan kemampuan Anda untuk mengintegrasikan aplikasi secara dinamis adalah dengan menggunakan Definisi Sumber Daya Kustom ForecastleApp (CRD). Fitur ini menambahkan lapisan fleksibilitas, memungkinkan Anda memisahkan konfigurasi aplikasi dari pengaturan Ingress dan konfigurasi Forecastle sendiri.
Membuat Aplikasi Forecastle:
Untuk membuat ForecastleApp, gunakan templat berikut sebagai panduan. Konfigurasi ini memungkinkan Anda menentukan nama aplikasi, grup, ikon, URL, dan properti tambahan:
apiVersion : forecastle.stakater.com/v1alpha1
kind : ForecastleApp
metadata :
name : app-name
spec :
name : My Awesome App
group : dev
icon : https://icon-url
url : http://app-url
networkRestricted : false
properties :
Version : " 1.0 "
instance : " " # Optional ForecastleApp CRD mendukung penemuan URL otomatis dari sumber daya Kubernetes tertentu, seperti:
Untuk memanfaatkan fitur ini, tambahkan bidang urlFrom ke spesifikasi ForecastleApp Anda seperti: Harap dicatat bahwa jenis sumber daya yang ingin Anda temukan harus berada dalam namespace yang sama dengan ForecastleApp CR.
apiVersion : forecastle.stakater.com/v1alpha1
kind : ForecastleApp
metadata :
name : app-name
spec :
name : My Awesome App
group : dev
icon : https://icon-url
urlFrom : # This is new
ingressRef :
name : my-app-ingressKonfigurasi ini menginstruksikan Forecastle untuk mengambil URL aplikasi langsung dari sumber daya Ingress yang ditentukan, sehingga menyederhanakan penerapan dan konfigurasi.
Catatan: Untuk menggunakan fitur CRD, pastikan fitur tersebut diaktifkan dengan mengatur crdEnabled: true di konfigurasi Forecastle atau dengan mengaktifkannya di diagram Helm.
Silakan gunakan pelacak masalah untuk melaporkan bug atau permintaan fitur file apa pun.
PR dipersilahkan. Secara umum, kami mengikuti alur kerja Git "fork-and-pull".
CATATAN: Pastikan untuk menggabungkan yang terbaru dari "upstream" sebelum membuat permintaan tarik!
Ada pertanyaan? Ajukan masalah GitHub.
Bergabunglah dan bicaralah dengan kami di saluran #tools-imc untuk mendiskusikan Forecastle
Lihat Permintaan Tarik kami yang tertutup.
Apache2 © Stakater
Istilah "Forecastle" berasal dari kosakata maritim, mengacu pada dek atas kapal yang terletak di haluan, tepat di depan tiang depan. Secara historis, ini adalah tempat para pelaut bernavigasi dan mengamati lautan luas di depan.
Dalam konteks proyek kami, kami mengadopsi nama ini sebagai metafora untuk peran yang dimainkan Forecastle di dunia Kubernetes. Sama seperti prakiraan kapal, Ramalan cuaca kami bertindak sebagai pusat observasi dan panel kendali. Ini memberi pengguna gambaran komprehensif tentang semua aplikasi yang berjalan di Kubernetes, khususnya aplikasi yang ditandai dengan anotasi khusus. Forecastle dirancang untuk menjadi dasbor Kubernetes Anda, memberikan tampilan yang jelas dan akses mudah ke aplikasi yang Anda terapkan, seperti seorang pelaut yang mengamati laut dari haluan kapal.
Forecastle dikelola oleh Stakater. Suka itu? Silakan beritahu kami di [email protected]
Lihat proyek kami yang lain atau hubungi kami jika ada layanan profesional dan pertanyaan di [email protected]
