Azure Service Fabric CLI

Artikel
06/01/2023

Azure Service Fabric-kommandoradsgränssnittet (CLI) är ett kommandoradsverktyg för att interagera med och hantera Service Fabric-enheter. Service Fabric CLI kan användas med antingen Windows- eller Linux-kluster. Service Fabric CLI kan köras på valfri plattform där Python stöds.

Viktigt

Det finns två CLI-verktyg som används för att interagera med Service Fabric. Azure CLI används för att hantera Azure-resurser, till exempel ett Azure-baserat Service Fabric-kluster. Service Fabric CLI används för att ansluta direkt till Service Fabric-klustret (oavsett var det finns) och hantera klustret, programmen och tjänsterna.

Förutsättningar

Kontrollera att din miljö har både Python och pip installerade före installationen. Mer information finns i snabbstartdokumentationen för pip och den officiella dokumentationen för installation av Python.

CLI stöder Python-versionerna 2.7 och 3.6+, med Python 3.x rekommenderat.

Service Fabric-mål-runtime

Service Fabric CLI är tänkt att stödja den senaste runtime-versionen av Service Fabric SDK. Använd följande tabell för att fastställa vilken version av CLI som ska installeras:

CLI-version	runtime-version som stöds
Senaste (~=10)	Senaste (~=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

Alternativt kan du ange en målversion av CLI för installation genom att ange suffixet ==<version> för kommandot pip install. Till exempel skulle syntaxen för version 1.1.0 vara:

pip install -I sfctl==1.1.0

Ersätt följande pip install-kommando med det tidigare nämnda kommandot vid behov.

Mer information om Service Fabric CLI-versioner finns i GitHub-dokumentationen.

Installera pip, Python och Service Fabric CLI

Du kan installera pip och Python på din plattform på många olika sätt. Följande är anvisningar för att snabbt komma igång med Python 3 och pip på populära operativsystem.

Windows

I Windows 10, Windows Server 2016 och Windows Server 2012 R2 använder du de officiella anvisningarna för standardinstallation. Python-installationsprogrammet installerar även pip som standard.

Gå till den officiella python-nedladdningssidan och ladda ned den senaste versionen av Python 3.x.
Starta installationsprogrammet.
Längst ned i prompten väljer du Lägg till Python 3.x i PATH.
Välj Installera nu och slutför installationen.

Nu kan du öppna ett nytt kommandofönster och hämta versionen för Python och pip.

python --version
pip --version

Kör sedan följande kommando för att installera Azure Service Fabric CLI (sfctl) och visa CLI-hjälpsidan:

pip install sfctl
sfctl -h

Ubuntu- och Windows-undersystem for Linux

Kör sedan följande kommandon för att installera Service Fabric CLI:

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

Sedan kan du testa installationen med:

sfctl -h

Om du får ett felmeddelande om att ett kommando inte hittas, t.ex:

sfctl: command not found

Kontrollera att ~/.local/bin är åtkomligt från $PATH:

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

Om installationen på Windows-undersystemet för Linux misslyckas med felaktiga mappbehörigheter kan du behöva försöka igen med förhöjda behörigheter:

sudo pip3 install sfctl

Red Hat Enterprise Linux 7.4 (stöd för förhandsversion av Service Fabric)

Installera Service Fabric CLI på Red Hat genom att köra följande kommandon:

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

Om du vill testa installationen kan du läsa stegen i avsnittet Ubuntu och Windows-undersystem för Linux

MacOS

För MacOS rekommenderar vi att du använder HomeBrew-pakethanteraren. Installera HomeBrew om det inte är installerat genom att köra följande kommando:

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

Installera sedan den senaste Python 3.x, pip och Service Fabric CLI från terminalen genom att köra följande kommandon:

brew install python3
pip3 install sfctl
sfctl -h

CLI-syntax

Kommandon inleds alltid med prefixet sfctl. För allmän information om alla kommandon du kan använda använder du sfctl -h. För hjälp med ett enda kommando, använd sfctl <command> -h.

Kommandon följer en upprepningsbar struktur, där kommandots mål står före verbet eller åtgärden.

sfctl <object> <action>

I det här exemplet är <object> målet för <action>.

Välj ett kluster

Innan du kan utföra några åtgärder måste du välja ett kluster att ansluta till. Kör till exempel följande kommando för att välja och ansluta till klustret med namnet testcluster.com:

Varning

Använd inte oskyddade Service Fabric-kluster i produktionsmiljöer.

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

Klusterslutpunkten måste föregås av http eller https. Det måste innehålla porten för HTTP-gateway. Den här porten och adressen är samma som webbadressen för Service Fabric Explorer.

För kluster som skyddas med ett certifikat kan du ange ett PEM-kodat certifikat. Certifikatet kan anges som en enda fil eller ett par med certifikat och nyckel. Om det är ett självsignerat certifikat som inte är signerat av en certifikatutfärdare kan du använda alternativet --no-verify för att kringgå verifiering av certifikatutfärdare.

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

Mer information finns i Ansluta till ett Azure Service Fabric-kluster.

Grundläggande åtgärder

Klustrets anslutningsinformation bevaras mellan olika Service Fabric CLI-sessioner. När du har valt ett Service Fabric-kluster kan du köra alla Service Fabric-kommandon på klustret.

Om du till exempel vill se hälsotillståndet för Service Fabric-klustret kör du följande kommando:

sfctl cluster health

Kommandot ger följande utdata:

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

Tips och felsökning

Här följer några förslag och tips för lösning av vanliga problem.

Konvertera ett certifikat från PFX till PEM

Service Fabric CLI har stöd för certifikat på klientsidan i form av PEM-filer (.pem-filtillägg). Om du använder PFX-filer från Windows måste du konvertera dessa certifikat till PEM-format. Om du vill konvertera en PFX-fil till en PEM-fil använder du följande kommando:

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

Om du ska konvertera från en PEM-fil till en PFX-fil kan du på samma sätt använda följande kommando (inga lösenord anges här):

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

Mer information finns i OpenSSL-dokumentationen.

Anslutningsproblem

Vissa åtgärder kan generera följande meddelande:

Failed to establish a new connection

Kontrollera att den angivna kluster-slutpunkten är tillgänglig och lyssnar. Kontrollera också att gränssnittet för Service Fabric Explorer kan nås på denna värd och port. Använd sfctl cluster select till att uppdatera slutpunkten.

Detaljerade loggar

Detaljerade loggar är ofta användbara när du felsöker eller rapporterar problem. Flaggan --debug ökar utförligheten i utdata.

Hjälp och syntax för kommandon

Om du vill ha hjälp med ett visst kommando eller en grupp med kommandon, använder du flaggan -h.

sfctl application -h

Här är ett annat exempel:

sfctl application create -h

Uppdatera Service Fabric CLI

Om du vill uppdatera Service Fabric CLI kör du följande kommandon (ersätt pip med pip3 beroende på vad du valde under den ursprungliga installationen):

pip uninstall sfctl
pip install sfctl