View a markdown version of this page

Création d'une version du flux de travail - AWS HealthOmics
Création d'une version du flux de travail à l'aide de la consoleCréation d'une version du flux de travail à l'aide de la CLICréation d'une version du flux de travail à l'aide d'un SDKVérifier l'état d'une version du flux de travail

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création d'une version du flux de travail

Lorsque vous créez une nouvelle version d'un flux de travail, vous devez spécifier les valeurs de configuration pour la nouvelle version. Il n'hérite d'aucune valeur de configuration du flux de travail.

Lorsque vous créez la version, indiquez un nom de version unique pour ce flux de travail. Vous ne pouvez pas modifier le nom après HealthOmics crée la version.

Le nom de la version doit commencer par une lettre ou un chiffre et peut inclure des lettres majuscules et minuscules, des chiffres, des traits d'union, des points et des traits de soulignement. La longueur maximale est de 64 caractères. Par exemple, vous pouvez utiliser un schéma de dénomination simple, tel que version1, version2, version3. Vous pouvez également faire correspondre les versions de votre flux de travail à vos propres conventions de version internes, telles que 2.7.0, 2.7.1, 2.7.2.

Vous pouvez également utiliser le champ de description de la version pour ajouter des remarques sur cette version. Par exemple : Fix for syntax error in workflow definition.

Note

N'incluez aucune information personnelle identifiable (PII) dans le nom de la version. Les noms des versions apparaissent dans l'ARN de la version du workflow.

HealthOmics attribue un ARN unique à la version du flux de travail. L'ARN est unique en fonction de la combinaison de l'ID du flux de travail et du nom de version.

Avertissement

Après avoir supprimé une version du flux de travail, HealthOmics vous permet de réutiliser le nom de version pour une autre version du flux de travail. La meilleure pratique consiste à ne pas réutiliser les noms de version. Si vous réutilisez un nom, le flux de travail et chaque version possèdent un UUID unique que vous pouvez utiliser pour la provenance.

Création d'une version du flux de travail à l'aide de la console

Étapes pour créer une version du flux de travail

  1. Ouvrez la console HealthOmics .

  2. Si nécessaire, ouvrez le volet de navigation de gauche (≡). Choisissez Flux de travail privés.

  3. Sur le Flux de travail privés page, choisissez le flux de travail pour la nouvelle version.

  4. Sur le Détails du flux de travail page, choisissez Créer une nouvelle version.

  5. Sur le Créer une version page, fournissez les informations suivantes :

    1. Nom de la version: entrez un nom unique pour la version du flux de travail dans l'ensemble du flux de travail.

    2. Description de la version (facultatif) : Vous pouvez utiliser le champ de description pour ajouter des remarques sur cette version.

  6. Dans le Définition du flux de travail panneau, fournissez les informations suivantes :

    1. Langue du flux de travail (facultatif) : Sélectionnez la langue de spécification pour la version du flux de travail. Dans le cas contraire, HealthOmics détermine la langue à partir de la définition du flux de travail.

    2. Pour Source de définition du flux de travail, choisissez d'importer le dossier de définition depuis un Git-based référentiel, un emplacement Amazon S3 ou depuis un lecteur local.

      1. Pour Importer depuis un service de référentiel:

        Note

        HealthOmics prend en charge les référentiels publics et privés pour GitHub, GitLab, Bitbucket, GitHub self-managed, GitLab self-managed.

        1. Choisissez un Raccordement pour connecter votre AWS ressources vers le référentiel externe. Pour créer une connexion, voir Connectez-vous à des référentiels de code externes.

          Note

          Les clients du TLV région doit créer une connexion dans le IAD région (us-east-1) pour créer un flux de travail.

        2. Dans ID complet du référentiel, entrez l'ID de votre référentiel en tant qu'utilisateur-name/repo-nom. Vérifiez que vous avez accès aux fichiers de ce référentiel.

        3. Dans Référence de la source (facultatif), entrez une référence à la source du référentiel (branche, balise ou ID de validation). HealthOmics utilise la branche par défaut si aucune référence source n'est spécifiée.

        4. Dans Exclure les modèles de fichiers, entrez les modèles de fichiers pour exclure des dossiers, des fichiers ou des extensions spécifiques. Cela permet de gérer la taille des données lors de l'importation de fichiers de référentiel. Il y a un maximum de 50 motifs, et les motifs doivent suivre les syntaxe du modèle glob. Par exemple :

          1. tests/

          2. *.jpeg

          3. large_data.zip

      2. Pour Sélectionnez le dossier de définition dans S3:

        1. Entrez l'emplacement Amazon S3 qui contient le dossier de définition du flux de travail compressé. Le compartiment Amazon S3 doit se trouver dans la même région que le flux de travail.

        2. Si le compartiment Amazon S3 n'appartient pas à votre compte, entrez le nom du propriétaire du compartiment AWS identifiant de compte dans le ID de compte du propriétaire du compartiment S3. Ces informations sont nécessaires pour que HealthOmics peut vérifier la propriété du bucket.

      3. Pour Sélectionnez le dossier de définition à partir d'une source locale:

        1. Entrez l'emplacement du lecteur local du dossier de définition du flux de travail compressé.

    3. Chemin du fichier de définition du flux de travail principal (facultatif) : entrez le chemin du fichier depuis le dossier ou le référentiel de définitions de flux de travail compressé vers le main dossier. Ce paramètre n'est pas obligatoire s'il n'y a qu'un seul fichier dans le dossier de définition du flux de travail ou si le fichier principal est nommé « main ».

  7. Dans le Fichier README panneau (facultatif), sélectionnez Source du fichier README et fournissez les informations suivantes :

    • Pour Importer depuis un service de référentiel, dans Chemin du fichier README, entrez le chemin d'accès au fichier README dans le référentiel.

    • Pour Sélectionnez un fichier dans S3, dans Fichier README dans S3, entrez l'URI Amazon S3 pour le fichier README.

    • Pour Sélectionnez un fichier à partir d'une source locale: dans README - facultatif, a choisi Choisissez un fichier pour sélectionner le fichier markdown (.md) à charger.

  8. Dans le Configuration de stockage d'exécution par défaut panneau, indiquez le type de stockage et la capacité de stockage d'exécution par défaut pour les exécutions qui utilisent ce flux de travail :

    1. Exécuter le type de stockage: choisissez si vous souhaitez utiliser le stockage statique ou dynamique par défaut pour le stockage d'exécution temporaire. La valeur par défaut est le stockage statique.

    2. Gérer la capacité de stockage (facultatif) : pour le type de stockage d'exécution statique, vous pouvez entrer la quantité de stockage d'exécution par défaut requise pour ce flux de travail. La valeur par défaut de ce paramètre est de 1 200 GiB. Vous pouvez modifier ces valeurs par défaut lorsque vous démarrez une course.

  9. Balises (facultatif) : vous pouvez associer jusqu'à 50 balises à cette version du flux de travail.

  10. Choisissez Suivant.

  11. Sur le Ajouter des paramètres de flux de travail page (facultatif), sélectionnez Source de paramètres:

    1. Pour Analyse à partir du fichier de définition du flux de travail, HealthOmics analysera automatiquement les paramètres du flux de travail à partir du fichier de définition du flux de travail.

    2. Pour Fournir un modèle de paramètres à partir du référentiel Git, utilisez le chemin d'accès au fichier modèle de paramètres depuis votre référentiel.

    3. Pour Sélectionnez un fichier JSON à partir de la source locale, téléchargez un JSON fichier provenant d'une source locale qui spécifie les paramètres.

    4. Pour Entrez manuellement les paramètres du flux de travail, entrez manuellement les noms et les descriptions des paramètres.

  12. Dans le Aperçu des paramètres panneau, vous pouvez consulter ou modifier les paramètres de cette version du flux de travail. Si vous restaurez JSON fichier, vous perdez toutes les modifications locales que vous avez apportées.

  13. Sur le Remappage de l'URI du conteneur page, dans la Règles de mappage panneau, vous pouvez définir des règles de mappage d'URI pour votre flux de travail.

    Pour Source du fichier de mappage, sélectionnez l'une des options suivantes :

    • Aucune — Aucune règle de mappage n'est requise.

    • Sélectionnez un fichier JSON dans S3 — Spécifiez l'emplacement S3 du fichier de mappage.

    • Sélectionnez un fichier JSON à partir d'une source locale — Spécifiez l'emplacement du fichier de mappage sur votre appareil local.

    • Entrez manuellement les mappages — entrez les mappages de registre et les mappages d'images dans le Cartographies panneau.

  14. La console affiche Cartographies panneau. Si vous avez choisi un fichier source de mappage, la console affiche les valeurs du fichier.

    1. Dans Mappages de registres, vous pouvez modifier les mappages ou ajouter des mappages (maximum de 20 mappages de registre).

      Chaque mappage de registre contient les champs suivants :

      • URL du registre en amont — L'URI du registre en amont.

      • Préfixe du référentiel ECR — Le préfixe du référentiel à utiliser dans le référentiel privé Amazon ECR.

      • (Facultatif) Préfixe du référentiel en amont — Le préfixe du référentiel dans le registre en amont.

      • (Facultatif) ID de compte ECR — ID de compte du compte propriétaire de l'image du conteneur en amont.

      • (Facultatif) ARN d'identification — L'ARN du secret Secrets Manager qui contient vos informations d'identification pour le registre. Obligatoire pour les registres que le cache d'extraction Amazon ECR ne prend pas en charge, tels que Seqera, NVIDIA NGC, Google Artifact Registry et Google Container Registry. Pour plus d’informations, consultez Utilisation de registres tiers non pris en charge par le cache d'extraction.

    2. Dans Mappages d'images, vous pouvez modifier les mappages d'images ou ajouter des mappages (maximum de 100 mappages d'images).

      Chaque mappage d'image contient les champs suivants :

      • Image source — Spécifie l'URI de l'image source dans le registre en amont.

      • Image de destination — Spécifie l'URI de l'image correspondante dans le registre privé Amazon ECR.

  15. Choisissez Suivant.

  16. Vérifiez la configuration de la version, puis choisissez Créer une version.

Lorsque la version est créée, la console revient à la page détaillée du flux de travail et affiche la nouvelle version dans Flux de travail et versions table.

Création d'une version du flux de travail à l'aide de la CLI

Vous pouvez créer une version du flux de travail à l'aide du CreateWorkflowVersion Fonctionnement de l'API. Pour les paramètres facultatifs, HealthOmics utilise les valeurs par défaut suivantes :

Paramètre Par défaut
Engine Déterminé à partir de la définition du flux de travail
Type de stockage STATIC
Capacité de stockage (pour le stockage statique) 1 200 Go
Principal Déterminé en fonction du contenu du dossier de définition du flux de travail. Pour plus de détails, consultez HealthOmics exigences de définition du flux de travail.
Accélérateurs Aucune
Étiquettes Aucune

L'exemple de CLI suivant crée une version de flux de travail avec le stockage statique comme stockage d'exécution par défaut :

aws omics create-workflow-version \
--workflow-id 1234567  \
--version-name "my_version" \
--engine WDL \
--definition-zip fileb://workflow-crambam.zip \
--description "my version description" \
--main file://workflow-params.json \
--parameter-template file://workflow-params.json \
--storage-type='STATIC'   \
--storage-capacity 1200   \
--tags example123=string  \
--accelerators GPU

Si votre fichier de définition de flux de travail se trouve dans un dossier Amazon S3, entrez l'emplacement à l'aide du definition-uri paramètre au lieu de definition-zip. Pour plus d'informations, voir CreateWorkflowVersion dans AWS HealthOmics Référence d'API.

Vous recevez la réponse suivante à create-workflow-version demande.

{
  "workflowId": "1234567",
  "versionName": "my_version",
  "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567/version/3",
  "status": "ACTIVE",
  "tags": {
    "environment": "production",
    "owner": "team-alpha"
  },
  "uuid": "0ac9a563-355c-fc7a-1b47-a115167af8a2"
}

Création d'une version du flux de travail à l'aide d'un SDK

Vous pouvez créer un flux de travail à l'aide de l'un des kits de développement logiciel.

L'exemple suivant montre comment créer une version de flux de travail à l'aide du SDK Python.

import boto3

omics = boto3.client('omics')

with open('definition.zip', 'rb') as f:
   definition = f.read()

response = omics.create_workflow_version(
   workflowId='1234567',
   versionName='my_version',
   requestId='my_request_1'
   definitionZip=definition,
   parameterTemplate={ ... }
)

Vérifier l'état d'une version du flux de travail

Après avoir créé la version de votre flux de travail, vous pouvez vérifier son statut et afficher d'autres détails du flux de travail à l'aide de obtenir la version du flux de travail, comme indiqué.

aws omics get-workflow-version 
--workflow-id 9876543
--version-name "my_version"

La réponse vous donne les détails de votre flux de travail, y compris l'état, comme indiqué.

{
  "workflowId": "1234567",
  "versionName": "3.0.0",
  "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567/version/3.0.0",
  "status": "ACTIVE",
  "description": ...
  "uuid": "0ac9a563-355c-fc7a-1b47-a115167af8a2"
}

Avant de pouvoir démarrer une exécution avec cette version de flux de travail, le statut doit passer à ACTIVE.