sfctl compose
Skapa, ta bort och hantera Docker Compose-program.
Kommandon
Kommando | beskrivning |
---|---|
skapa | Skapar en Service Fabric Compose-distribution. |
lista | Hämtar listan över sammansatta distributioner som skapats i Service Fabric-klustret. |
ta bort | Tar bort en befintlig Service Fabric-distribution från klustret. |
status | Hämtar information om en Service Fabric Compose-distribution. |
uppgradera | Börjar uppgradera en sammansatt distribution i Service Fabric-klustret. |
upgrade-rollback | Börjar återställa en uppgradering av skrivdistributionen i Service Fabric-klustret. |
upgrade-status | Hämtar information om den senaste uppgraderingen som utförs på den här Service Fabric Compose-distributionen. |
sfctl compose create
Skapar en Service Fabric Compose-distribution.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Namnet på distributionen. |
--file-path [Krävs] | Sökväg till Docker Compose-målfilen. |
--encrypted-pass | I stället för att fråga efter ett lösenord för containerregistret använder du en redan krypterad lösenordsfras. |
--has-pass | Frågar efter ett lösenord till containerregistret. |
--timeout -t | Standard: 60. |
--användare | Användarnamn för att ansluta till containerregistret. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose-lista
Hämtar listan över sammansatta distributioner som skapats i Service Fabric-klustret.
Hämtar status för de sammansatta distributioner som skapades eller håller på att skapas i Service Fabric-klustret. Svaret innehåller namn, status och annan information om de sammansatta distributionerna. Om listan över distributioner inte får plats på en sida returneras en sida med resultat samt en fortsättningstoken som kan användas för att hämta nästa sida.
Argument
Argument | beskrivning |
---|---|
--continuation-token | Parametern fortsättningstoken används för att hämta nästa uppsättning resultat. En fortsättningstoken med ett värde som inte är tomt ingår i API:ets svar när resultatet från systemet inte får plats i ett enda svar. När det här värdet skickas till nästa API-anrop returnerar API:et nästa uppsättning resultat. Om det inte finns några ytterligare resultat innehåller fortsättningstoken inget värde. Värdet för den här parametern ska inte vara URL-kodat. |
--max-results | Det maximala antalet resultat som ska returneras som en del av de sidiga frågorna. Den här parametern definierar den övre gränsen för det antal resultat som returneras. Resultatet som returneras kan vara mindre än det angivna maximala resultatet om de inte får plats i meddelandet enligt de maximala begränsningarna för meddelandestorlek som definierats i konfigurationen. Om den här parametern är noll eller inte har angetts innehåller den sidvända frågan så många resultat som möjligt som får plats i returmeddelandet. |
--timeout -t | Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta tills den begärda åtgärden har slutförts. Standardvärdet för den här parametern är 60 sekunder. Standard: 60. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose remove
Tar bort en befintlig Service Fabric-distribution från klustret.
Tar bort en befintlig Service Fabric Compose-distribution.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Distributionens identitet. |
--timeout -t | Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta tills den begärda åtgärden har slutförts. Standardvärdet för den här parametern är 60 sekunder. Standard: 60. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose status
Hämtar information om en Service Fabric Compose-distribution.
Returnerar statusen för den sammansättningsdistribution som skapades eller som håller på att skapas i Service Fabric-klustret och vars namn matchar det som anges som parametern. Svaret innehåller namn, status och annan information om distributionen.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Distributionens identitet. |
--timeout -t | Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta tills den begärda åtgärden har slutförts. Standardvärdet för den här parametern är 60 sekunder. Standard: 60. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose upgrade
Börjar uppgradera en sammansatt distribution i Service Fabric-klustret.
Validerar de angivna uppgraderingsparametrarna och börjar uppgradera distributionen om parametrarna är giltiga.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Namnet på distributionen. |
--file-path [Krävs] | Sökväg till docker-målfilen. |
--default-svc-type-health-map | JSON-kodad ordlista som beskriver hälsoprincipen som används för att utvärdera hälsotillståndet för tjänster. |
--encrypted-pass | I stället för att fråga efter ett lösenord för containerregistret använder du en redan krypterad lösenordsfras. |
--failure-action | Möjliga värden är: 'Invalid', 'Rollback', 'Manual'. |
--force-restart | Processer startas om kraftigt under uppgraderingen även när kodversionen inte har ändrats. Uppgraderingen ändrar endast konfiguration eller data. |
--has-pass | Frågar efter ett lösenord till containerregistret. |
--health-check-retry | Hur lång tid det tar mellan försök att utföra hälsokontroller om programmet eller klustret inte är felfritt. |
--health-check-stable | Hur lång tid programmet eller klustret måste vara felfria innan uppgraderingen fortsätter till nästa uppgraderingsdomän. Den tolkas först som en sträng som representerar en ISO 8601-varaktighet. Om det misslyckas tolkas det som ett tal som representerar det totala antalet millisekunder. |
--health-check-wait | Hur lång tid det tar att vänta efter att ha slutfört en uppgraderingsdomän innan du påbörjar hälsokontrollprocessen. |
--replica-set-check | Den maximala tiden för att blockera bearbetning av en uppgraderingsdomän och förhindra förlust av tillgänglighet när det uppstår oväntade problem. När tidsgränsen går ut fortsätter bearbetningen av uppgraderingsdomänen oavsett problem med tillgänglighetsförlust. Tidsgränsen återställs i början av varje uppgraderingsdomän. Giltiga värden är mellan 0 och 42949672925 inkluderande. |
--svc-type-health-map | JSON-kodad lista över objekt som beskriver de hälsoprinciper som används för att utvärdera hälsotillståndet för olika tjänsttyper. |
--timeout -t | Standard: 60. |
--unhealthy-app | Den maximala tillåtna procentandelen program som inte är felfria innan ett fel rapporteras. Om du till exempel vill tillåta att 10 % av programmen inte är felfria är det här värdet 10. Procentandelen representerar den maximala tillåtna procentandelen program som kan vara felfria innan klustret betraktas som ett fel. Om procentandelen respekteras men det finns minst ett program med feltillstånd utvärderas hälsotillståndet som Varning. Detta beräknas genom att dividera antalet program som inte är felfria jämfört med det totala antalet programinstanser i klustret. |
--upgrade-domain-timeout | Hur lång tid varje uppgraderingsdomän måste slutföras innan FailureAction körs. Den tolkas först som en sträng som representerar en ISO 8601-varaktighet. Om det misslyckas tolkas det som ett tal som representerar det totala antalet millisekunder. |
--upgrade-kind | Standard: Rullande. |
--upgrade-mode | Möjliga värden är: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Standard: UnmonitoredAuto. |
--upgrade-timeout | Hur lång tid den övergripande uppgraderingen måste slutföras innan FailureAction körs. Den tolkas först som en sträng som representerar en ISO 8601-varaktighet. Om det misslyckas tolkas det som ett tal som representerar det totala antalet millisekunder. |
--användare | Användarnamn för att ansluta till containerregistret. |
--warning-as-error | Anger om varningar behandlas med samma allvarlighetsgrad som fel. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose upgrade-rollback
Börjar återställa en uppgradering av skrivdistributionen i Service Fabric-klustret.
Återställ en service fabric-distributionsuppgradering.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Distributionens identitet. |
--timeout -t | Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta tills den begärda åtgärden har slutförts. Standardvärdet för den här parametern är 60 sekunder. Standard: 60. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
sfctl compose upgrade-status
Hämtar information om den senaste uppgraderingen som utförs på den här Service Fabric Compose-distributionen.
Returnerar information om tillståndet för uppgraderingen av skrivdistributionen tillsammans med information för att felsöka problem med programhälsa.
Argument
Argument | beskrivning |
---|---|
--deployment-name [Krävs] | Distributionens identitet. |
--timeout -t | Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta tills den begärda åtgärden har slutförts. Standardvärdet för den här parametern är 60 sekunder. Standard: 60. |
Globala argument
Argument | beskrivning |
---|---|
--felsöka | Öka loggningsverositeten för att visa alla felsökningsloggar. |
--help -h | Visa det här hjälpmeddelandet och avsluta. |
--output -o | Utdataformat. Tillåtna värden: json, jsonc, table, tsv. Standard: json. |
--fråga | JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i. |
--mångordig | Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar. |
Nästa steg
- Konfigurera Service Fabric CLI.
- Lär dig hur du använder Service Fabric CLI med hjälp av exempelskripten.