Workflow-Version erstellen

Wenn Sie eine neue Version eines Workflows erstellen, müssen Sie die Konfigurationswerte für die neue Version angeben. Es erbt keine Konfigurationswerte aus dem Workflow.

Wenn Sie die Version erstellen, geben Sie einen Versionsnamen an, der für diesen Workflow eindeutig ist. Sie können den Namen nicht ändern, nachdem die Version HealthOmics erstellt wurde.

Der Versionsname muss mit einem Buchstaben oder einer Zahl beginnen und kann Groß- und Kleinbuchstaben, Zahlen, Bindestriche, Punkte und Unterstriche enthalten. Die maximale Länge beträgt 64 Zeichen. Sie können beispielsweise ein einfaches Benennungsschema wie Version1, Version2, Version3 verwenden. Sie können Ihre Workflow-Versionen auch Ihren eigenen internen Versionierungskonventionen wie 2.7.0, 2.7.1, 2.7.2 zuordnen.

Verwenden Sie optional das Feld für die Versionsbeschreibung, um Anmerkungen zu dieser Version hinzuzufügen. Beispiel: Fix for syntax error in workflow definition.

Anmerkung

Nehmen Sie keine persönlich identifizierbaren Informationen (PII) in den Versionsnamen auf. Versionsnamen werden im ARN der Workflow-Version angezeigt.

HealthOmics weist der Workflow-Version einen eindeutigen ARN zu. Der ARN ist aufgrund der Kombination aus Workflow-ID und Versionsname eindeutig.

Warnung

Nachdem Sie eine Workflow-Version gelöscht haben, HealthOmics können Sie den Versionsnamen für eine andere Workflow-Version wiederverwenden. Es hat sich bewährt, Versionsnamen nicht wiederzuverwenden. Wenn Sie einen Namen wiederverwenden, haben der Workflow und jede Version eine eindeutige UUID, die Sie als Herkunft verwenden können.

Erstellen Sie mithilfe der Konsole eine Workflow-Version

Schritte zum Erstellen eines Workflows

1. Öffnen Sie die HealthOmics -Konsole.

2. Wählen Sie oben links den Navigationsbereich (•) und wählen Sie Private Workflows aus.

3. Wählen Sie auf der Seite Private Workflows den Workflow für die neue Version aus.

4. Wählen Sie auf der Seite mit den Workflow-Details die Option Neue Version erstellen aus.

5. Geben Sie auf der Seite Version erstellen die folgenden Informationen ein:

   1. Versionsname: Geben Sie einen Namen für die Workflow-Version ein, der für den gesamten Workflow eindeutig ist.

   2. Versionsbeschreibung (optional): Sie können das Beschreibungsfeld verwenden, um Hinweise zu dieser Version hinzuzufügen.

6. Geben Sie im Bereich Workflow-Definition die folgenden Informationen ein:

   1. Workflow-Sprache (optional): Wählen Sie die Spezifikationssprache für die Workflow-Version aus. Andernfalls HealthOmics bestimmt die Sprache anhand der Workflow-Definition.

   2. Wählen Sie unter Workflow-Definitionsquelle, ob Sie den Definitionsordner aus einem Git-basierten Repository, einem Amazon S3 S3-Speicherort oder von einem lokalen Laufwerk importieren möchten.

      1. Für den Import aus einem Repository-Service:

         Anmerkung

         HealthOmics unterstützt öffentliche und private Repositorys fürGitHub,GitLab,, BitbucketGitHub self-managed,GitLab self-managed.

         1. Wählen Sie eine Verbindung, um Ihre AWS Ressourcen mit dem externen Repository zu verbinden. Informationen zum Herstellen einer Verbindung finden Sie unterConnect mit externen Code-Repositorys her.

            Anmerkung

            Kunden in der TLV Region müssen eine Verbindung in der Region IAD (us-east-1) herstellen, um einen Workflow zu erstellen.

         2. Geben Sie unter Vollständige Repository-ID Ihre Repository-ID als Benutzername/Repository-Name ein. Stellen Sie sicher, dass Sie Zugriff auf die Dateien in diesem Repository haben.

         3. Geben Sie im Feld Quellverweis (optional) eine Repository-Quellenreferenz ein (Branch-, Tag- oder Commit-ID). HealthOmics verwendet den Standardzweig, wenn kein Quellverweis angegeben ist.

         4. Geben Sie im Feld Dateimuster ausschließen die Dateimuster ein, um bestimmte Ordner, Dateien oder Erweiterungen auszuschließen. Dies hilft bei der Verwaltung der Datengröße beim Import von Repository-Dateien. Es gibt maximal 50 Muster, und die Muster müssen der Glob-Pattern-Syntax folgen. Zum Beispiel:

            1. tests/

            2. *.jpeg

            3. large_data.zip

      2. Für Select Definition Folder aus S3:

         1. Geben Sie den Amazon S3 S3-Speicherort ein, der den komprimierten Workflow-Definitionsordner enthält. Der Amazon S3 S3-Bucket muss sich in derselben Region wie der Workflow befinden.

         2. Wenn Ihr Konto nicht Eigentümer des Amazon S3 S3-Buckets ist, geben Sie die Konto-ID des Bucket-Besitzers in die AWS Konto-ID des S3-Bucket-Besitzers ein. Diese Informationen sind erforderlich, um die Inhaberschaft des Buckets verifizieren zu HealthOmics können.

      3. Für Wählen Sie den Definitionsordner aus einer lokalen Quelle aus:

         1. Geben Sie den Speicherort des komprimierten Workflow-Definitionsordners auf dem lokalen Laufwerk ein.

   3. Haupt-Workflow-Definitionsdateipfad (optional): Geben Sie den Dateipfad vom komprimierten Workflow-Definitionsordner oder Repository zur main Datei ein. Dieser Parameter ist nicht erforderlich, wenn der Workflow-Definitionsordner nur eine Datei enthält oder wenn die Hauptdatei den Namen „main“ hat.

7. Geben Sie im Bereich Konfiguration des Standard-Laufspeichers den Standardspeichertyp und die Kapazität für Läufe an, die diesen Workflow verwenden:

   1. Speichertyp ausführen: Wählen Sie aus, ob statischer oder dynamischer Speicher als Standard für den temporären Laufspeicher verwendet werden soll. Die Standardeinstellung ist statischer Speicher.

   2. Laufspeicherkapazität (optional): Für den statischen Laufspeichertyp können Sie die Standardmenge an Laufspeicher eingeben, die für diesen Workflow erforderlich ist. Der Standardwert für diesen Parameter ist 1200 GiB. Sie können diese Standardwerte überschreiben, wenn Sie einen Lauf starten.

8. Tags (optional): Sie können dieser Workflow-Version bis zu 50 Tags zuordnen.

9. Wählen Sie Weiter aus.

10. Wählen Sie auf der Seite Workflow-Parameter hinzufügen (optional) die Parameterquelle aus:

    1. Bei Aus Workflow-Definitionsdatei analysieren: HealthOmics Analysiert automatisch die Workflow-Parameter aus der Workflow-Definitionsdatei.

    2. Verwenden Sie für Parametervorlage aus dem Git-Repository bereitstellen den Pfad zur Parametervorlagendatei aus Ihrem Repository.

    3. Laden Sie für „JSON-Datei aus lokaler Quelle auswählen“ eine JSON Datei aus einer lokalen Quelle hoch, die die Parameter angibt.

    4. Geben Sie für Workflow-Parameter manuell eingeben die Parameternamen und Beschreibungen manuell ein.

11. Im Bereich Parametervorschau können Sie die Parameter für diese Workflow-Version überprüfen oder ändern. Wenn Sie die JSON Datei wiederherstellen, gehen alle lokalen Änderungen verloren, die Sie vorgenommen haben.

12. Wählen Sie Weiter aus.

13. Überprüfen Sie die Versionskonfiguration und wählen Sie dann Version erstellen.

Wenn die Version erstellt wurde, kehrt die Konsole zur Workflow-Detailseite zurück und zeigt die neue Version in der Tabelle Workflows und Versionen an.

Erstellen Sie eine Workflow-Version mit der CLI

Sie können mithilfe der CreateWorkflowVersion API-Operation eine Workflow-Version erstellen. HealthOmics Verwendet für optionale Parameter die folgenden Standardwerte:

Parameter	Standard
Engine	Wird anhand der Workflow-Definition bestimmt
Speichertyp	STATIC
Speicherkapazität (für statischen Speicher)	1200 GiB
Main (Haupt)	Wird anhand des Inhalts des Workflow-Definitionsordners ermittelt. Details hierzu finden Sie unter HealthOmics Anforderungen an die Workflow-Definition.
Accelerators	Keine
Tags	Keine

Das folgende CLI-Beispiel erstellt eine Workflow-Version mit statischem Speicher als Standard-Run-Storage:

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

Wenn sich Ihre Workflow-Definitionsdatei in einem Amazon S3 S3-Ordner befindet, geben Sie den Speicherort mit dem definition-uri Parameter anstelle von eindefinition-zip. Weitere Informationen finden Sie CreateWorkflowVersionin der HealthOmics AWS-API-Referenz.

Sie erhalten die folgende Antwort auf die create-workflow-version Anfrage.

{
  "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"
}   

Erstellen Sie eine Workflow-Version mit einem SDK

Sie können einen Workflow mit einem der erstellen SDKs.

Das folgende Beispiel zeigt, wie eine Workflow-Version mit dem Python-SDK erstellt wird.

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={ ... }
)     

Überprüfen Sie den Status einer Workflow-Version

Nachdem Sie Ihre Workflow-Version erstellt haben, können Sie den Status überprüfen und weitere Details des Workflows get-workflow-versionwie in der Abbildung gezeigt anzeigen.

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

In der Antwort erhalten Sie Ihre Workflow-Details, einschließlich des Status, wie in der Abbildung dargestellt.

{
  "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"
}   

Bevor Sie einen Lauf mit dieser Workflow-Version starten können, muss der Status auf geändert werdenACTIVE.