ServiceFabricComposeDeploy@0 - Tâche de déploiement de Service Fabric Compose v0

Utilisez cette tâche pour déployer une application Docker Compose sur un cluster Service Fabric. Cette tâche déploie une application Azure Service Fabric sur un cluster en fonction des paramètres définis dans le fichier Compose.

Syntax

# Service Fabric Compose deploy v0
# Deploy a Docker Compose application to an Azure Service Fabric cluster.
- task: ServiceFabricComposeDeploy@0
  inputs:
    clusterConnection: # string. Alias: serviceConnectionName. Required. Cluster Service Connection. 
    composeFilePath: '**/docker-compose.yml' # string. Required. Compose File Path. Default: **/docker-compose.yml.
    applicationName: 'fabric:/Application1' # string. Required. Application Name. Default: fabric:/Application1.
  # Registry Settings
    registryCredentials: 'AzureResourceManagerEndpoint' # 'AzureResourceManagerEndpoint' | 'ContainerRegistryEndpoint' | 'UsernamePassword' | 'None'. Required. Registry Credentials Source. Default: AzureResourceManagerEndpoint.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpointName. Optional. Use when registryCredentials = ContainerRegistryEndpoint. Docker Registry Service Connection. 
    azureSubscription: # string. Alias: azureSubscriptionEndpoint. Required when registryCredentials = AzureResourceManagerEndpoint. Azure subscription. 
    #registryUserName: # string. Optional. Use when registryCredentials = UsernamePassword. Registry User Name. 
    #registryPassword: # string. Optional. Use when registryCredentials = UsernamePassword. Registry Password. 
    #passwordEncrypted: true # boolean. Optional. Use when registryCredentials = UsernamePassword. Password Encrypted. Default: true.
  # Advanced Settings
    #upgrade: false # boolean. Upgrade. Default: false.
    #deployTimeoutSec: # string. Deploy Timeout (s). 
    #removeTimeoutSec: # string. Remove Timeout (s). 
    #getStatusTimeoutSec: # string. Get Status Timeout (s).
# Service Fabric Compose Deploy v0
# Deploy a docker-compose application to a Service Fabric cluster.
- task: ServiceFabricComposeDeploy@0
  inputs:
    clusterConnection: # string. Alias: serviceConnectionName. Required. Cluster Service Connection. 
    composeFilePath: '**/docker-compose.yml' # string. Required. Compose File Path. Default: **/docker-compose.yml.
    applicationName: 'fabric:/Application1' # string. Required. Application Name. Default: fabric:/Application1.
  # Registry Settings
    registryCredentials: 'AzureResourceManagerEndpoint' # 'AzureResourceManagerEndpoint' | 'ContainerRegistryEndpoint' | 'UsernamePassword' | 'None'. Required. Registry Credentials Source. Default: AzureResourceManagerEndpoint.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpointName. Optional. Use when registryCredentials = ContainerRegistryEndpoint. Docker Registry Service Connection. 
    azureSubscription: # string. Alias: azureSubscriptionEndpoint. Required when registryCredentials = AzureResourceManagerEndpoint. Azure subscription. 
    #registryUserName: # string. Optional. Use when registryCredentials = UsernamePassword. Registry User Name. 
    #registryPassword: # string. Optional. Use when registryCredentials = UsernamePassword. Registry Password. 
    #passwordEncrypted: true # boolean. Optional. Use when registryCredentials = UsernamePassword. Password Encrypted. Default: true.
  # Advanced Settings
    #upgrade: false # boolean. Upgrade. Default: false.
    #deployTimeoutSec: # string. Deploy Timeout (s). 
    #removeTimeoutSec: # string. Remove Timeout (s). 
    #getStatusTimeoutSec: # string. Get Status Timeout (s).

Entrées

clusterConnection - Connexion au service de cluster
Alias d’entrée : serviceConnectionName. string. Obligatoire.

Spécifie une connexion de service Azure Service Fabric à utiliser pour se connecter au cluster. Choisissez Manage d’inscrire une nouvelle connexion de service.


composeFilePath - Composer le chemin d’accès au fichier
string. Obligatoire. Valeur par défaut : **/docker-compose.yml.

Spécifie le chemin d’accès au fichier de composition qui doit être déployé. Les variables et les caractères génériques peuvent être utilisés dans le chemin d’accès. Exemple : $(System.DefaultWorkingDirectory)/**/drop/projectartifacts/**/docker-compose.yml.

Notes

La combinaison de fichiers de composition n’est pas prise en charge dans le cadre de cette tâche.


applicationName - Nom de l’application
string. Obligatoire. Valeur par défaut : fabric:/Application1.

Spécifie le nom de l’application Service Fabric de l’application déployée. Utilisez-le fabric:/ comme préfixe. Les noms d’application au sein d’un cluster Service Fabric doivent être uniques.


registryCredentials - Source des informations d’identification du Registre
string. Obligatoire. Valeurs autorisées : AzureResourceManagerEndpoint (connexion de service Azure Resource Manager), ContainerRegistryEndpoint (connexion au service Container Registry), UsernamePassword (nom d’utilisateur et mot de passe), None. Valeur par défaut : AzureResourceManagerEndpoint.

Spécifie comment les informations d’identification du registre de conteneurs Docker seront fournies à la tâche de déploiement. Les valeurs autorisées sont les suivantes :

  • AzureResourceManagerEndpoint(Connexion de service Azure Resource Manager) : utilise azureSubscription pour obtenir un ID et une clé de principal de service pour un Azure Container Registry.
  • ContainerRegistryEndpoint (Connexion au service Container Registry) : utilise dockerRegistryConnection pour sélectionner une connexion de service de registre Docker. Si un certificat correspondant à l’empreinte numérique du certificat de serveur dans la connexion de service de cluster est installé sur l’agent de build, il sera utilisé pour chiffrer le mot de passe ; sinon, le mot de passe n’est pas chiffré.
  • UsernamePassword (Nom d’utilisateur et mot de passe) : utilise registryUsername et registryPassword pour stocker le nom d’utilisateur et le mot de passe du registre Docker. Les mots de passe doivent être chiffrés à l’aide de Invoke-ServiceFabricEncryptText avec l’option Password Encrypted . Si les mots de passe ne sont pas chiffrés avec Invoke-ServiceFabricEncryptTextet qu’un certificat correspondant à l’empreinte numérique du certificat de serveur dans la connexion de cluster est installé sur l’agent de build, le certificat est utilisé pour chiffrer le mot de passe. Sinon, le mot de passe n’est pas chiffré et est envoyé en texte clair.
  • None: aucune information d’identification de Registre n’est fournie. Il est utilisé pour accéder aux registres de conteneurs publics.

dockerRegistryConnection - Connexion au service Docker Registry
Alias d’entrée : dockerRegistryEndpointName. string. facultatif. Utilisez quand registryCredentials = ContainerRegistryEndpoint.

Spécifie une connexion au service de registre Docker. Si un certificat correspondant à l’empreinte numérique du certificat de serveur dans la connexion de service de cluster est installé sur l’agent de build, il sera utilisé pour chiffrer le mot de passe ; sinon, le mot de passe n’est pas chiffré.


azureSubscription - Abonnement Azure
Alias d’entrée : azureSubscriptionEndpoint. string. Nécessaire lorsque registryCredentials = AzureResourceManagerEndpoint.

Spécifie un abonnement Azure.


registryUserName - Nom d’utilisateur du registre
string. facultatif. Utilisez quand registryCredentials = UsernamePassword.

Spécifie le nom d’utilisateur du registre Docker.


registryPassword - Mot de passe du registre
string. facultatif. Utilisez quand registryCredentials = UsernamePassword.

Spécifie le mot de passe du registre Docker. Si le mot de passe n’est pas chiffré, il est recommandé d’utiliser une variable secrète de pipeline de mise en production personnalisée pour le stocker.


passwordEncrypted - Mot de passe chiffré
boolean. facultatif. Utilisez quand registryCredentials = UsernamePassword. Valeur par défaut : true.

Chiffre votre mot de passe à l’aide de Invoke-ServiceFabricEncryptText. Si vous ne chiffrez pas votre mot de passe et qu’un certificat correspondant à l’empreinte numérique du certificat de serveur dans la connexion au service de cluster est installé sur l’agent de build, il sera utilisé pour chiffrer le mot de passe ; sinon, une erreur se produit.


upgrade - Améliorer
boolean. Valeur par défaut : false.

Met à niveau un déploiement existant au lieu de le supprimer.


deployTimeoutSec - Déployer le(s) délai(s) d’expiration
string.

Spécifie le délai d’expiration, en secondes, pour le déploiement de l’application.


removeTimeoutSec - Supprimer le(s) délai(s) d’expiration
string.

Spécifie le délai d’expiration, en secondes, pour la suppression d’une application existante.


getStatusTimeoutSec - Obtenir le(s) délai(s) d’attente d’état
string.

Spécifie le délai d’attente, en secondes, pour obtenir le status d’une application existante.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche pour déployer une application Docker-compose sur un cluster Service Fabric. Cette tâche déploie une application Azure Service Fabric sur un cluster en fonction des paramètres définis dans le fichier de composition.

Notes

Cette tâche est actuellement en préversion et nécessite une préversion de Service Fabric qui prend en charge compose deploy. Consultez Prise en charge du déploiement Docker Compose dans Azure Service Fabric.

Service Fabric

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : Cmd
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 1.95.0 ou version ultérieure
Catégorie de la tâche Déployer