Azure Service Fabric CLI

  • Artikel

Azure Service Fabric command-line interface (CLI) adalah utilitas baris perintah untuk berinteraksi dengan dan mengelola entitas Service Fabric. Service Fabric CLI dapat digunakan dengan kluster Windows atau Linux. Service Fabric CLI berjalan pada platform apa pun yang mendukung Python.

Penting

Ada dua utilitas CLI yang digunakan untuk berinteraksi dengan Service Fabric. Azure CLI digunakan untuk mengelola sumber daya Azure, seperti kluster Service Fabric yang dihost Azure. Service Fabric CLI digunakan untuk terhubung ke kluster Service Fabric secara langsung (terlepas dari lokasi hostingnya) dan mengelola kluster, aplikasi, serta layanan.

Prasyarat

Sebelum penginstalan, pastikan lingkungan Anda telah menginstal Python dan pip. Untuk informasi selengkapnya, lihat dokumentasi mulai cepat pip dan dokumentasi penginstalan Python resmi.

CLI mendukung Python versi 2.7 dan 3.6+, dengan Python 3.x direkomendasikan.

Runtime target Service Fabric

Service Fabric CLI dimaksudkan untuk mendukung versi runtime terbaru dari Service Fabric SDK. Gunakan tabel berikut untuk menentukan versi CLI mana yang akan diinstal:

Versi CLI versi runtime yang didukung
Terbaru (~=10) Terbaru (~=7.1)
9.0.0 7.1
8.0.0 6.5
7.1.0 6.4
6.0.0 6.3
5.0.0 6.2
4.0.0 6.1
3.0.0 6.0
1.1.0 5.6, 5.7

Anda dapat secara opsional menentukan versi target CLI untuk diinstal dengan memberi akhiran perintah pip install dengan ==<version>. Misalnya, untuk versi 1.1.0 sintaksnya adalah:

pip install -I sfctl==1.1.0

Ganti perintah pip install berikut dengan perintah yang disebutkan sebelumnya bila diperlukan.

Untuk informasi selengkapnya tentang rilis Service Fabric CLI, lihat dokumentasi GitHub.

Instal pip, Python, dan Service Fabric CLI

Ada banyak cara untuk menginstal pip dan Python di platform Anda. Berikut beberapa langkah untuk menyiapkan dengan cepat sistem operasi utama menggunakan Python 3 dan pip.

Windows

Untuk Windows 10, Windows Server 2016, dan Windows Server 2012 R2, gunakan instruksi instalasi resmi standar. Penginstal Python juga menginstal pip secara default.

  1. Buka halaman unduhan Python resmi, dan unduh rilis terbaru Python 3.x.

  2. Memulai penginstal.

  3. Di bagian bawah perintah, pilih Tambahkan Python 3.x ke PATH.

  4. Pilih Instal Sekarang, dan selesaikan penginstalan.

Sekarang Anda dapat membuka jendela perintah baru dan mendapatkan versi Python dan pip.

python --version
pip --version

Kemudian jalankan perintah berikut untuk menginstal Azure Service Fabric CLI (sfctl) dan lihat halaman bantuan CLI:

pip install sfctl
sfctl -h

Subsistem Ubuntu dan Windows untuk Linux

Untuk menginstal Service Fabric CLI, jalankan perintah berikut:

sudo apt-get install python3
sudo apt-get install python3-pip
pip3 install sfctl

Selanjutnya Anda dapat menguji penginstalan dengan:

sfctl -h

Jika Anda menerima pesan kesalahan bahwa perintah tidak ditemukan seperti:

sfctl: command not found

Pastikan bahwa ~/.local/bin dapat diakses dari $PATH:

export PATH=$PATH:~/.local/bin
echo "export PATH=$PATH:~/.local/bin" >> .shellrc

Jika instalasi pada subsistem Windows untuk Linux gagal dengan izin folder yang salah, mungkin perlu untuk mencoba lagi dengan izin yang ditinggikan:

sudo pip3 install sfctl

Red Hat Enterprise Linux 7.4 (dukungan pratinjau Service Fabric)

Untuk menginstal Service Fabric CLI pada Red Hat, jalankan perintah berikut:

sudo yum install -y python38
sudo yum install python38-setuptools
sudo easy_install-3.4 pip
sudo pip3 install sfctl

Untuk menguji penginstalan, Anda dapat merujuk pada langkah-langkah yang disebutkan di bagiakn Subsistem Ubuntu dan Windows untuk Linux

MacOS

Untuk MacOS, sebaiknya gunakan pengelola paket HomeBrew. Jika HomeBrew belum diinstal, instal dengan menjalankan perintah berikut:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Kemudian dari terminal, instal Python 3.x, pip, dan Service Fabric CLI terbaru dengan menjalankan perintah berikut:

brew install python3
pip3 install sfctl
sfctl -h

Sintaks CLI

Perintah selalu dia awali dengan sfctl. Untuk informasi umum tentang semua perintah yang dapat digunakan, gunakan sfctl -h. Untuk bantuan dengan satu perintah, gunakan sfctl <command> -h.

Perintah mengikuti struktur yang dapat diulang, dengan target perintah yang mendahului kata kerja atau tindakan.

sfctl <object> <action>

Dalam contoh ini, <object> adalah target untuk <action>.

Pilih kluster

Sebelum melakukan operasi apa pun, Anda harus memilih kluster yang akan disambungkan. Misalnya, untuk memilih dan menyambungkan ke kluster dengan nama testcluster.com, jalankan perintah berikut:

Peringatan

Jangan gunakan kluster Service Fabric tanpa tidak diamankan di lingkungan produksi.

sfctl cluster select --endpoint http://testcluster.com:19080

Titik akhir kluster harus dia awali dengan http atau https. Ini harus menyertakan porta untuk gateway HTTP. Port dan alamatnya sama dengan URL Service Fabric Explorer.

Untuk kluster yang diamankan dengan sertifikat, Anda dapat menentukan sertifikat bersandi PEM. Sertifikat dapat ditentukan sebagai file tunggal atau sebagai sertifikasi dan pasangan kunci. Jika sertifikat ini adalah sertifikat yang ditandatangani sendiri dan tidak ditandatangani CA, Anda dapat melewati opsi --no-verify untuk melewati verifikasi CA.

sfctl cluster select --endpoint https://testsecurecluster.com:19080 --pem ./client.pem --no-verify

Untuk informasi selengkapnya, lihat Menyambungkan ke kluster Azure Service Fabric yang aman.

Operasi dasar

Informasi koneksi kluster berlanjut di beberapa sesi Service Fabric CLI. Setelah memilih kluster Service Fabric, Anda dapat menjalankan perintah Service Fabric apa pun di kluster tersebut.

Misalnya, untuk mendapatkan status kesehatan kluster Service Fabric, gunakan perintah berikut:

sfctl cluster health

Perintah ini menghasilkan output berikut:

{
  "aggregatedHealthState": "Ok",
  "applicationHealthStates": [
    {
      "aggregatedHealthState": "Ok",
      "name": "fabric:/System"
    }
  ],
  "healthEvents": [],
  "nodeHealthStates": [
    {
      "aggregatedHealthState": "Ok",
      "id": {
        "id": "66aa824a642124089ee474b398d06a57"
      },
      "name": "_Test_0"
    }
  ],
  "unhealthyEvaluations": []
}

Tips dan pemecahan masalah

Berikut beberapa saran dan tips untuk memecahkan masalah umum.

Mengonversi sertifikat dari format PFX ke PEM

Service Fabric CLI mendukung sertifikat sisi klien sebagai file PEM (ekstensi .pem). Jika Anda menggunakan file PFX dari Windows, Anda harus mengonversi sertifikat tersebut ke format PEM. Untuk mengonversi file PFX ke file PEM, gunakan perintah berikut:

openssl pkcs12 -in certificate.pfx -out mycert.pem -nodes

Demikian pula, untuk mengonversi dari file PEM ke file PFX, Anda dapat menggunakan perintah berikut (tidak disediakan kata sandi di sini):

openssl  pkcs12 -export -out Certificates.pfx -inkey Certificates.pem -in Certificates.pem -passout pass:''

Untuk informasi selengkapnya, lihat dokumentasi OpenSSL.

Masalah koneksi

Beberapa operasi mungkin menghasilkan pesan berikut:

Failed to establish a new connection

Verifikasikan bahwa titik akhir kluster yang ditentukan tersedia dan mendengarkan. Selain itu, verifikasi bahwa Service Fabric Explorer UI tersedia di host dan port tersebut. Untuk memperbarui titik akhir, gunakan sfctl cluster select.

Log terperinci

Log terperinci seringkali berguna ketika Anda mendebug atau melaporkan masalah. Bendera --debug meningkatkan verbositas output.

Bantuan dan sintaks perintah

Untuk bantuan terkait perintah tertentu atau sekelompok perintah, gunakan bendera -h.

sfctl application -h

Berikut adalah contoh lain:

sfctl application create -h

Memperbarui Service Fabric CLI

Untuk memperbarui Service Fabric CLI, jalankan perintah berikut (ganti pip dengan pip3, tergantung apa yang Anda pilih selama penginstalan asli Anda):

pip uninstall sfctl
pip install sfctl

Langkah berikutnya