sfctl compose
建立、刪除和管理 Docker Compose 應用程式。
命令
| 命令 | 描述 |
|---|---|
| create | 建立 Service Fabric 撰寫部署。 |
| 清單 | 取得在 Service Fabric 叢集中建立的撰寫部署清單。 |
| remove | 從叢集刪除現有的 Service Fabric 撰寫部署。 |
| status | 取得 Service Fabric 撰寫部署的相關信息。 |
| 升級 | 開始升級 Service Fabric 叢集中的撰寫部署。 |
| upgrade-rollback | 開始復原 Service Fabric 叢集中的撰寫部署升級。 |
| upgrade-status | 取得在此 Service Fabric 撰寫部署上執行的最新升級詳細數據。 |
sfctl compose create
建立 Service Fabric 撰寫部署。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的名稱。 |
| --file-path [必要] | 目標 Docker Compose 檔案的路徑。 |
| --encrypted-pass | 不使用提示輸入容器登錄密碼，而是使用已加密的傳遞片語。 |
| --has-pass | 將提示輸入容器登錄的密碼。 |
| --timeout -t | 預設值：60。 |
| --使用者 | 線上到容器登錄的用戶名稱。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose list
取得在 Service Fabric 叢集中建立的撰寫部署清單。
取得在 Service Fabric 叢集中建立或程式中所建立之撰寫部署的狀態。 回應包含撰寫部署的名稱、狀態和其他詳細數據。 如果部署清單不符合頁面，則會傳回一頁的結果，以及接續令牌，可用來取得下一頁。
引數
| Argument | 描述 |
|---|---|
| --continuation-token | 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。 |
| --max-results | 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose remove
從叢集刪除現有的 Service Fabric 撰寫部署。
刪除現有的 Service Fabric 撰寫部署。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的身分識別。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose status
取得 Service Fabric 撰寫部署的相關信息。
傳回在 Service Fabric 叢集中建立或正在建立的撰寫部署狀態，其名稱符合指定為 參數的部署。 回應包含部署的名稱、狀態和其他詳細數據。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的身分識別。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose 升級
開始升級 Service Fabric 叢集中的撰寫部署。
驗證提供的升級參數，並在參數有效時開始升級部署。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的名稱。 |
| --file-path [必要] | 目標 Docker 撰寫檔案的路徑。 |
| --default-svc-type-health-map | JSON 編碼字典，描述用來評估服務健康情況的健康情況原則。 |
| --encrypted-pass | 不使用提示輸入容器登錄密碼，而是使用已加密的傳遞片語。 |
| --failure-action | 可能的值包括：『Invalid』、『Rollback』、『Manual』。 |
| --force-restart | 即使程式代碼版本未變更，在升級期間仍會強制重新啟動進程。 升級只會變更組態或數據。 |
| --has-pass | 將提示輸入容器登錄的密碼。 |
| --health-check-retry | 嘗試執行健康情況檢查應用程式或叢集是否狀況不良之間的時間長度。 |
| --health-check-stable | 在升級繼續進入下一個升級網域之前，應用程式或叢集必須維持狀況良好的時間長度。 它會先解譯為代表 ISO 8601 持續時間的字串。 如果失敗，則會解譯為代表總毫秒數的數字。 |
| --health-check-wait | 開始健康狀態檢查程式之前，完成升級網域之後要等待的時間長度。 |
| --replica-set-check | 封鎖升級網域處理的時間上限，並避免在發生非預期的問題時遺失可用性。 當此逾時到期時，不論可用性遺失問題為何，升級網域的處理都會繼續。 逾時會在每個升級網域開始時重設。 有效值介於 0 與42949672925之間。 |
| --svc-type-health-map | JSON 編碼的物件清單，這些物件描述用來評估不同服務類型健康情況的健康情況原則。 |
| --timeout -t | 預設值：60。 |
| --unhealthy-app | 報告錯誤之前，允許的應用程式狀況不良百分比上限。 例如，若要允許 10% 的應用程式狀況不良，此值會是 10。 百分比代表在叢集視為錯誤之前，可能狀況不良的應用程式最大容許百分比。 如果遵守百分比，但至少有一個狀況不良的應用程式，則健康情況會評估為Warning。 這是藉由將狀況不良的應用程式數目除以叢集中應用程式實例總數來計算。 |
| --upgrade-domain-timeout | 執行 FailureAction 之前，每個升級網域必須完成的時間長度。 它會先解譯為代表 ISO 8601 持續時間的字串。 如果失敗，則會解譯為代表總毫秒數的數字。 |
| --upgrade-kind | 默認值：滾動。 |
| --upgrade-mode | 可能的值包括：'Invalid'、'UnmonitoredAuto'、'UnmonitoredManual'、'Monitored'。 默認值：UnmonitoredAuto。 |
| --upgrade-timeout | 執行 FailureAction 之前，整體升級必須完成的時間量。 它會先解譯為代表 ISO 8601 持續時間的字串。 如果失敗，則會解譯為代表總毫秒數的數字。 |
| --使用者 | 線上到容器登錄的用戶名稱。 |
| --warning-as-error | 指出是否以與錯誤相同的嚴重性來處理警告。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose upgrade-rollback
開始復原 Service Fabric 叢集中的撰寫部署升級。
復原 Service Fabric 撰寫部署升級。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的身分識別。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl compose upgrade-status
取得在此 Service Fabric 撰寫部署上執行的最新升級詳細數據。
傳回撰寫部署升級狀態的相關信息，以及協助偵錯應用程式健康情況問題的詳細數據。
引數
| Argument | 描述 |
|---|---|
| --deployment-name [必要] | 部署的身分識別。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |