Lewati ke konten utama

Platform CLI Overview

Platform command-line interface (CLI) dirancang untuk menyederhanakan interaksi dengan akun Cloud Platform Anda, memungkinkan Anda untuk menjalankan perintah yang diperlukan melalui terminal mesin lokal Anda. Ini dapat menangani sebagian besar operasi yang tersedia dari jarak jauh, melengkapi tumpukan kemampuan luas yang disediakan melalui dashboard dan platform API.

platform CLI logo

Manfaat utama di sini adalah alat otomasi canggih dan relatif sederhana yang disediakan CLI untuk pengembang. Perintah teks sederhana dapat dengan mudah dikelompokkan ke dalam skrip dan, dengan cara seperti itu, membentuk mekanisme yang kuat untuk mencapai berbagai tujuan: dari otomatisasi tugas yang paling umum dan sering, hingga memantau aplikasi dan mengelola proses DevOps yang kompleks.

Jadi, mari kita mulai dengan platform CLI installation dan ungkapkan beberapa key points penggunaannya sebelum melangkah lebih jauh.

Selanjutnya, Anda dapat mendalami dengan platform CLI tutorials untuk operasi tertentu.

CLI Installation

Untuk menginstal platform CLI di mesin lokal Anda, Anda hanya perlu menjalankan satu baris kode melalui terminal Anda:

curl -s ftp://ftp.jelastic.com/pub/cli/jelastic-cli-installer.sh | bash
catatan

Pastikan Anda memiliki Java versi 8 atau lebih tinggi yang terinstal sebelumnya. Jika Anda menggunakan Windows OS, Anda perlu menginstal lingkungan mirip Unix terlebih dahulu (misalnya Cygwin) dan menjalankan semua perintah yang sesuai dalamnya.

Akibatnya, platform CLI akan diinstal ke dalam folder jelastic yang didedikasikan di direktori home Anda. Struktur folder dan skrip bash di dalamnya mewakili hierarki platform API, yang menghasilkan kesamaan lengkap proses kerja yang sesuai, sehingga Anda dengan cepat dapat terbiasa dengan CLI kami.

Getting Started

Dasar dari platform CLI diwakili oleh arsip .jar yang dapat dieksekusi dan beberapa perintah yang telah dikonfigurasi sebelumnya (skrip bash) untuk beroperasi. Dengan bantuan perintah-perintah ini, Anda dapat memantau, mengendalikan, dan mengotomatisasi siklus hidup environment Anda.

1. Untuk memulai, autentikasi harus dilakukan. Autentikasi ini dipanggil secara otomatis saat penggunaan perintah CLI pertama, misalnya:

CLI authentication

Cukup ikuti kuesioner yang muncul, tentukan nilai yang diminta:

  • Platform URL - URL instalasi PaaS dalam format app.{hoster_domain}
  • Email - email (login) terkait dengan akun Anda
  • Password - password akun Anda

Jika data yang dimasukkan benar, Anda akan melihat logo dan versi platform yang saat ini digunakan.

tip

Autentikasi juga dapat dimulai secara manual. Misalnya, jika Anda perlu beralih sesi saat ini dan masuk sebagai pengguna lain atau pada instalasi PaaS yang berbeda. Gunakan perintah berikut:

~/jelastic/users/authentication/signin --login {email} --password {password} --platformUrl {platformUrl}
CLI environment login

Di sini, nilai yang ada di dalam kurung harus diganti dengan parameter akun yang sesuai (dijelaskan di atas). Properti “result”: 0 dalam respons yang diterima (dilingkari pada gambar di atas) berarti bahwa operasi telah berhasil dilakukan dan tanpa kesalahan. Perilaku semacam itu berlaku untuk semua perintah yang Anda jalankan.

2. Informasi tentang sesi pengguna sebenarnya (yaitu, alamat platform dan kredensial Anda) disimpan dalam file ~/.config/jelastic/jelastic.properties yang dihasilkan secara otomatis. Ini secara otomatis diambil ketika diperlukan, memungkinkan Anda untuk berkonsentrasi pada operasi yang dilakukan tanpa langkah-langkah autentikasi berulang yang diperlukan.

Secara default, perintah CLI dianggap berhasil dijalankan meskipun metode API yang dipanggil mengembalikan kesalahan. Anda dapat mengubah perilaku ini dengan parameter jelastic.non_zero_exit_code yang ditambahkan ke file konfigurasi. Ini menentukan apakah perintah CLI harus merespons dengan kode nol seperti biasa (false - nilai default) atau dengan kode non-nol ketika metode API yang dieksekusi mengembalikan kesalahan (true).

3. Jika Anda baru mengenal API kami dan memerlukan detail tentang struktur antarmuka baris perintahnya, Anda dapat mengakses file bantuan yang tertanam:

~/jelastic/help
CLI help

Di sini, Anda dapat melihat daftar hierarkis jenis perintah (metode) yang tersedia. Setiap metode memiliki folder dengan nama yang sama dengan beberapa skrip (i.e. fungsi yang tersedia) di dalamnya.

4. Untuk mendapatkan daftar semua operasi yang mungkin untuk metode tertentu, Anda dapat menggunakan perintah daftar sederhana untuk direktori yang sesuai, misalnya:

ls ~/jelastic/environment/control
CLI environment control list

Setiap fungsi yang disajikan dapat dengan mudah dipanggil menggunakan jalur lengkapnya.

5. Untuk informasi lebih lanjut tentang operasi tertentu, jalankan tanpa parameter untuk melihat daftar lengkap persyaratan yang terlewat.

CLI command help

Anda juga dapat memeriksa API documentation kami untuk mendapatkan informasi tambahan.

6. Secara default, animasi "loading" ditampilkan saat menunggu pelaksanaan perintah apa pun. Ini memberikan representasi visual dari tindakan yang sedang berlangsung.

Namun, jika Anda perlu menyimpan respons ke dalam file (misalnya untuk menggunakannya dalam beberapa tugas otomatisasi), elemen ini mungkin berlebihan dan merusak pemformatan JSON. Untuk menyembunyikan animasi pemuatan, tambahkan perintah Anda dengan argumen berikut:

--silent true

Dalam cara seperti itu, output yang diterima dapat segera digunakan oleh skrip otomatisasi Anda tanpa edit tambahan apa pun.

tip

CLI yang diinstal secara otomatis memeriksa pembaruan. Ketika versi baru tersedia, Anda akan melihat pemberitahuan yang sesuai dengan instruksi peningkatan.

Sekarang, karena Anda memiliki pengetahuan dasar tentang platform CLI, Anda dapat terus menjelajahinya sendiri.

CLI Tutorials

Memastikan manajemen jarak jauh yang berfungsi penuh, platform CLI bekerja dengan semua jenis environments dan aplikasi. Ini mendukung semua tindakan yang sesuai, dari yang paling sederhana hingga yang kompleks. Untuk mengungkapkan kemampuannya dengan menunjukkan nyata, kami mempresentasikan beberapa contoh penggunaan yang paling umum:

Selanjutnya, ketika Anda mendapatkan gambaran tentang cara bekerja dengan platform CLI dan kemungkinan yang diberikannya, Anda dapat mulai membuat skrip otomatisasi Anda sendiri untuk beberapa operasi siklus hidup environment yang sering.

Anda dapat menemukan informasi lengkap tentang semua perintah dan metode yang tersedia dalam platform API documentation.

Baca Juga