sfctl compose

Creare, eliminare e gestire applicazioni Docker Compose.

Comandi

Comando Descrizione
create Crea una distribuzione di composizione di Service Fabric.
list Mostra l'elenco di distribuzioni di composizione create nel cluster di Service Fabric.
remove Elimina una distribuzione di composizione Service Fabric esistente dal cluster.
status Mostra informazioni su una distribuzione di composizione Service Fabric.
aggiornamento Avvia l'aggiornamento di una distribuzione di composizione nel cluster di Service Fabric.
upgrade-rollback Avvia il rollback di un aggiornamento di una distribuzione Compose nel cluster di Service Fabric.
upgrade-status Mostra i dettagli dell'aggiornamento più recente eseguito sulla distribuzione Compose per Service Fabric corrente.

sfctl compose create

Crea una distribuzione di composizione di Service Fabric.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] Nome della distribuzione.
--file-path [Obbligatorio] Percorso al file di destinazione Docker Compose.
--encrypted-pass Invece di richiedere una password di registro contenitori, usare una passphrase già crittografata.
--has-pass Richiederà una password al registro contenitori.
--timeout -t Predefinito: 60.
--user Nome utente per connettersi al registro contenitori.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose list

Mostra l'elenco di distribuzioni di composizione create nel cluster di Service Fabric.

Mostra lo stato delle distribuzioni di composizione che sono state create oppure sono in corso di creazione nel cluster di Service Fabric. La risposta include il nome, lo stato e altri dettagli relativi alle distribuzioni di composizione. Se l'elenco di distribuzioni non rientra in una pagina, vengono restituiti una pagina di risultati e un token di continuazione, che può essere usato per accedere alla pagina successiva.

Argomenti

Argomento Descrizione
--continuation-token Il parametro del token di continuazione viene utilizzato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto è incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla successiva chiamata API, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene alcun valore. Il valore di questo parametro non deve essere codificato in URL.
--max-results Il numero massimo di risultati che devono essere restituiti come parte delle query di paging. Questo parametro definisce il limite massimo di risultati restituiti. Se non rientrano nel messaggio in base ai limiti di dimensione massima per i messaggi definiti nella configurazione, il numero dei risultati restituiti può essere inferiore al numero massimo di risultati specificato. Se questo parametro è uguale a zero o non specificato, le query di paging includono il numero massimo di risultati possibili che rientrano nel messaggio restituito.
--timeout -t Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Predefinito: 60.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose remove

Elimina una distribuzione di composizione Service Fabric esistente dal cluster.

Elimina una distribuzione di composizione Service Fabric esistente dal cluster.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] L'identità della distribuzione.
--timeout -t Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Predefinito: 60.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose status

Mostra informazioni su una distribuzione di composizione Service Fabric.

Restituisce lo stato della distribuzione di composizione che è stata creata o è in corso di creazione nel cluster di Service Fabric e il cui nome corrisponde a quello specificato come parametro. La risposta include il nome, lo stato e altri dettagli relativi alla distribuzione.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] L'identità della distribuzione.
--timeout -t Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Predefinito: 60.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose upgrade

Avvia l'aggiornamento di una distribuzione di composizione nel cluster di Service Fabric.

Convalida i parametri di aggiornamento forniti e avvia l'aggiornamento della distribuzione se i parametri sono validi.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] Nome della distribuzione.
--file-path [Obbligatorio] Percorso al file di destinazione Docker Compose.
--default-svc-type-health-map Dizionario con codifica JSON che descrive i criteri di integrità usati per valutare l'integrità dei servizi.
--encrypted-pass Invece di richiedere una password di registro contenitori, usare una passphrase già crittografata.
--failure-action I valori possibili sono: 'Invalid', 'Rollback', 'Manual'.
--force-restart I processi vengono riavviati in modo forzato durante l'aggiornamento anche quando la versione del codice non è stata modificata.

L'aggiornamento modifica solo la configurazione o i dati.
--has-pass Richiederà una password al registro contenitori.
--health-check-retry Intervallo di tempo tra i tentativi di esecuzione dei controlli integrità se l'applicazione o il cluster non è integro.
--health-check-stable Tempo di attesa per cui l'applicazione o il cluster devono rimanere integri prima di passare al dominio di aggiornamento successivo.

Viene prima interpretato come stringa che rappresenta una durata ISO 8601. Se l'esito è negativo, viene interpretato come numero che rappresenta il numero totale di millisecondi.
--health-check-wait Intervallo di tempo di attesa dopo il completamento di un dominio di aggiornamento prima di avviare il processo dei controlli integrità.
--replica-set-check Tempo massimo per bloccare l'elaborazione di un dominio di aggiornamento ed evitare la perdita di disponibilità quando si verificano problemi imprevisti.

Quando il timeout scade, l'elaborazione del dominio di aggiornamento procede indipendentemente dai problemi di perdita di disponibilità. Il timeout viene reimpostato all'inizio di ogni dominio di aggiornamento. I valori validi sono compresi tra 0 e 42949672925 inclusi.
--svc-type-health-map Elenco con codifica JSON di oggetti che descrivono i criteri di integrità usati per valutare l'integrità dei diversi tipi di servizio.
--timeout -t Predefinito: 60.
--unhealthy-app Percentuale massima consentita di applicazioni non integre prima che venga segnalato un errore.

Ad esempio, per consentire il 10% di applicazioni non integre, questo valore deve corrispondere a 10. La percentuale rappresenta la percentuale massima tollerata di applicazioni che possono risultare non integre prima che per il cluster venga impostato lo stato Error. Se la percentuale viene rispettata ma esiste almeno un'applicazione non integra, l'integrità viene valutata come Avviso. Tale valore viene calcolato dividendo il numero delle applicazioni non integre per il numero totale di istanze di applicazione nel cluster.
--upgrade-domain-timeout Tempo necessario al completamento di ogni dominio di aggiornamento prima dell'esecuzione di FailureAction.

Viene prima interpretato come stringa che rappresenta una durata ISO 8601. Se l'esito è negativo, viene interpretato come numero che rappresenta il numero totale di millisecondi.
--upgrade-kind Predefinito: in sequenza.
--upgrade-mode I valori possibili sono: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Predefinito: UnmonitoredAuto.
--upgrade-timeout Tempo necessario al completamento dell'aggiornamento prima dell'esecuzione di FailureAction.

Viene prima interpretato come stringa che rappresenta una durata ISO 8601. Se l'esito è negativo, viene interpretato come numero che rappresenta il numero totale di millisecondi.
--user Nome utente per connettersi al registro contenitori.
--warning-as-error Indica se gli avvisi vengono considerati con lo stesso livello di gravità degli errori.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose upgrade-rollback

Avvia il rollback di un aggiornamento di una distribuzione Compose nel cluster di Service Fabric.

Consente di eseguire il rollback di un aggiornamento di una distribuzione Compose di Service Fabric.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] L'identità della distribuzione.
--timeout -t Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Predefinito: 60.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

sfctl compose upgrade-status

Mostra i dettagli dell'aggiornamento più recente eseguito sulla distribuzione Compose per Service Fabric corrente.

Restituisce le informazioni sullo stato dell'aggiornamento della distribuzione di composizione, con dettagli che agevolano il debug dei problemi di integrità dell'applicazione.

Argomenti

Argomento Descrizione
--deployment-name [Obbligatorio] L'identità della distribuzione.
--timeout -t Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Predefinito: 60.

Argomenti globali

Argomento Descrizione
--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
--help -h Visualizza questo messaggio della guida ed esce.
--output -o Formato di output. Valori consentiti: json, jsonc, table, tsv. Valore predefinito: json.
--query Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
--verbose Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Passaggi successivi

  • Configurare l'interfaccia della riga di comando di Service Fabric.
  • Informazioni su come usare l'interfaccia della riga di comando Service Fabric usando gli script di esempio.