sfctl compose
Crie, exclua e gerencie aplicativos Docker Compose.
Comandos
| Comando | Description |
|---|---|
| criar | Cria uma implantação de composição do Service Fabric. |
| list | Obtém a lista de implantações de composição criadas no cluster do Service Fabric. |
| remove | Exclui uma implantação de composição do Service Fabric existente do cluster. |
| status | Obtém informações sobre uma implantação de composição do Service Fabric. |
| atualizar | Inicia a atualização de uma implantação de composição no cluster do Service Fabric. |
| upgrade-rollback | Começa a reverter uma atualização de implantação de composição no cluster do Service Fabric. |
| status de atualização | Obtém detalhes para a atualização mais recente executada nesta implantação de composição do Service Fabric. |
sfctl compose criar
Cria uma implantação de composição do Service Fabric.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | O nome da implantação. |
| --file-path [Obrigatório] | Caminho para o arquivo Docker Compose de destino. |
| --passe criptografado | Em vez de solicitar uma senha de registro de contêiner, use uma senha já criptografada. |
| --has-pass | Solicitará uma senha para o registro do contêiner. |
| --tempo limite -t | Padrão: 60. |
| --user | Nome de usuário para se conectar ao registro de contêiner. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
Lista de composição SFCTL
Obtém a lista de implantações de composição criadas no cluster do Service Fabric.
Obtém o status sobre as implantações de composição que foram criadas ou estão em processo de criação no cluster do Service Fabric. A resposta inclui o nome, o status e outros detalhes sobre as implantações de composição. Se a lista de implantações não couber em uma página, uma página de resultados será retornada, bem como um token de continuação, que pode ser usado para obter a próxima página.
Argumentos
| Argumento | Description |
|---|---|
| --continuação-token | O parâmetro de token de continuação é usado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio é incluído na resposta da API quando os resultados do sistema não cabem em uma única resposta. Quando esse valor é passado para a próxima chamada de API, a API retorna o próximo conjunto de resultados. Se não houver mais resultados, o token de continuação não conterá um valor. O valor desse parâmetro não deve ser codificado por URL. |
| --max-resultados | O número máximo de resultados a serem retornados como parte das consultas paginadas. Este parâmetro define o limite superior do número de resultados retornados. Os resultados retornados podem ser menores do que os resultados máximos especificados se eles não se encaixarem na mensagem de acordo com as restrições de tamanho máximo de mensagem definidas na configuração. Se esse parâmetro for zero ou não especificado, a consulta paginada incluirá tantos resultados quanto possível que cabem na mensagem de retorno. |
| --tempo limite -t | O tempo limite do servidor para executar a operação em segundos. Esse tempo limite especifica a duração do tempo que o cliente está disposto a aguardar a conclusão da operação solicitada. O valor padrão para esse parâmetro é 60 segundos. Padrão: 60. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
sfctl compose remover
Exclui uma implantação de composição do Service Fabric existente do cluster.
Exclui uma implantação de composição do Service Fabric existente.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | A identidade da implantação. |
| --tempo limite -t | O tempo limite do servidor para executar a operação em segundos. Esse tempo limite especifica a duração do tempo que o cliente está disposto a aguardar a conclusão da operação solicitada. O valor padrão para esse parâmetro é 60 segundos. Padrão: 60. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
status de composição sfctl
Obtém informações sobre uma implantação de composição do Service Fabric.
Retorna o status da implantação de composição que foi criada ou está em processo de criação no cluster do Service Fabric e cujo nome corresponde ao especificado como parâmetro. A resposta inclui o nome, o status e outros detalhes sobre a implantação.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | A identidade da implantação. |
| --tempo limite -t | O tempo limite do servidor para executar a operação em segundos. Esse tempo limite especifica a duração do tempo que o cliente está disposto a aguardar a conclusão da operação solicitada. O valor padrão para esse parâmetro é 60 segundos. Padrão: 60. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
Atualização do SFCTL Compose
Inicia a atualização de uma implantação de composição no cluster do Service Fabric.
Valida os parâmetros de atualização fornecidos e inicia a atualização da implantação se os parâmetros forem válidos.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | O nome da implantação. |
| --file-path [Obrigatório] | Caminho para o arquivo de composição do Docker de destino. |
| --default-svc-type-health-map | Dicionário codificado JSON que descreve a política de saúde usada para avaliar a integridade dos serviços. |
| --passe criptografado | Em vez de solicitar uma senha de registro de contêiner, use uma senha já criptografada. |
| --falha-ação | Os valores possíveis incluem: 'Inválido', 'Reversão', 'Manual'. |
| --forçar-reiniciar | Os processos são reiniciados com força durante a atualização, mesmo quando a versão do código não foi alterada. A atualização altera apenas a configuração ou os dados. |
| --has-pass | Solicitará uma senha para o registro do contêiner. |
| --saúde-check-retry | O período de tempo entre as tentativas de executar verificações de integridade se o aplicativo ou cluster não estiver íntegro. |
| --saúde-check-estável | A quantidade de tempo que o aplicativo ou cluster deve permanecer íntegro antes que a atualização prossiga para o próximo domínio de atualização. É primeiramente interpretada como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, então é interpretado como um número que representa o número total de milissegundos. |
| --saúde-check-wait | O período de tempo de espera após a conclusão de um domínio de atualização antes de iniciar o processo de verificações de integridade. |
| --réplica-set-check | A quantidade máxima de tempo para bloquear o processamento de um domínio de atualização e evitar a perda de disponibilidade quando há problemas inesperados. Quando esse tempo limite expirar, o processamento do domínio de atualização prosseguirá independentemente de problemas de perda de disponibilidade. O tempo limite é redefinido no início de cada domínio de atualização. Os valores válidos estão entre 0 e 42949672925 inclusive. |
| --svc-type-health-map | Lista codificada JSON de objetos que descrevem as diretivas de integridade usadas para avaliar a integridade de diferentes tipos de serviço. |
| --tempo limite -t | Padrão: 60. |
| --insalubridade-app | A porcentagem máxima permitida de aplicativos não íntegros antes de relatar um erro. Por exemplo, para permitir que 10% dos aplicativos não estejam íntegros, esse valor seria 10. A porcentagem representa a porcentagem máxima tolerada de aplicativos que podem não estar íntegros antes que o cluster seja considerado errado. Se a percentagem for respeitada, mas houver pelo menos uma aplicação insalubre, a saúde é avaliada como Aviso. Isso é calculado dividindo o número de aplicativos não íntegros pelo número total de instâncias de aplicativos no cluster. |
| --upgrade-domínio-timeout | A quantidade de tempo que cada domínio de atualização tem que ser concluído antes que FailureAction seja executado. É primeiramente interpretada como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, então é interpretado como um número que representa o número total de milissegundos. |
| --tipo de atualização | Padrão: Rolling. |
| --modo de atualização | Os valores possíveis incluem: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Padrão: UnmonitoredAuto. |
| --tempo limite de atualização | A quantidade de tempo que a atualização geral tem que ser concluída antes que FailureAction seja executado. É primeiramente interpretada como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, então é interpretado como um número que representa o número total de milissegundos. |
| --user | Nome de usuário para se conectar ao registro de contêiner. |
| --aviso-como-erro | Indica se os avisos são tratados com a mesma gravidade que os erros. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
sfctl compose upgrade-rollback
Começa a reverter uma atualização de implantação de composição no cluster do Service Fabric.
Reverter uma atualização de implantação de composição de malha de serviço.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | A identidade da implantação. |
| --tempo limite -t | O tempo limite do servidor para executar a operação em segundos. Esse tempo limite especifica a duração do tempo que o cliente está disposto a aguardar a conclusão da operação solicitada. O valor padrão para esse parâmetro é 60 segundos. Padrão: 60. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
sfctl compose upgrade-status
Obtém detalhes para a atualização mais recente executada nesta implantação de composição do Service Fabric.
Retorna as informações sobre o estado da atualização de implantação de composição, juntamente com detalhes para ajudar a depurar problemas de integridade do aplicativo.
Argumentos
| Argumento | Description |
|---|---|
| --deployment-name [Obrigatório] | A identidade da implantação. |
| --tempo limite -t | O tempo limite do servidor para executar a operação em segundos. Esse tempo limite especifica a duração do tempo que o cliente está disposto a aguardar a conclusão da operação solicitada. O valor padrão para esse parâmetro é 60 segundos. Padrão: 60. |
Argumentos globais
| Argumento | Description |
|---|---|
| --depuração | Aumente a verbosidade do log para mostrar todos os logs de depuração. |
| --ajuda -h | Mostrar esta mensagem de ajuda e sair. |
| --saída -o | Formato de saída. Valores permitidos: json, jsonc, table, tsv. Padrão: json. |
| --consulta | Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos. |
| --verborrágico | Aumente a verbosidade do registro. Use --debug para logs de depuração completos. |
Próximos passos
- Configure a CLI do Service Fabric.
- Saiba como usar a CLI do Service Fabric usando os scripts de exemplo.