View a markdown version of this page

Eine Workflow-Version erstellen - AWS HealthOmics

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Eine 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 vom Workflow.

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

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 Versionskonventionen wie 2.7.0, 2.7.1, 2.7.2 zuordnen.

Verwenden Sie optional das Feld mit der Versionsbeschreibung, um Hinweise zu dieser Version hinzuzufügen. Beispiel: Fix for syntax error in workflow definition.

Anmerkung

Fügen Sie dem Versionsnamen keine persönlich identifizierbaren Informationen (PII) hinzu. 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 ermöglicht es Ihnen, den Versionsnamen für eine andere Workflow-Version wiederzuverwenden. Es hat sich bewährt, Versionsnamen nicht wiederzuverwenden. Wenn Sie einen Namen wiederverwenden, haben der Workflow und jede Version eine eindeutige UUID, die Sie für die Herkunft verwenden können.

Erstellen Sie mithilfe der Konsole eine Workflow-Version

Schritte zum Erstellen einer Workflow-Version
  1. Öffnen Sie die HealthOmics -Konsole.

  2. Öffnen Sie bei Bedarf den linken Navigationsbereich (≡). Wählen Sie Private Workflows.

  3. Auf der Private Arbeitsabläufe Seite, wählen Sie den Workflow für die neue Version.

  4. Auf der Einzelheiten zum Arbeitsablauf Seite, wählen Sie Neue Version erstellen.

  5. Auf der Version erstellen Seite, geben Sie die folgenden Informationen an:

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

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

  6. In der Workflow-Definition Panel, geben Sie die folgenden Informationen an:

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

    2. Für Quelle der Workflow-Definition, wählen Sie, ob Sie den Definitionsordner aus einem importieren möchten Git-based Repository, einen Amazon S3-Standort oder von einem lokalen Laufwerk.

      1. Für Aus einem Repository-Service importieren:

        Anmerkung

        HealthOmics unterstützt öffentliche und private Repositorien für GitHub, GitLab, Bitbucket, GitHub self-managed, GitLab self-managed.

        1. Wähle ein Verbindung um deine zu verbinden AWS Ressourcen für das externe Repository. Informationen zum Herstellen einer Verbindung finden Sie unter Stellen Sie eine Verbindung zu externen Code-Repositorys her.

          Anmerkung

          Kunden in der TLV Region muss eine Verbindung herstellen in der IAD Region (us-east-1), um einen Arbeitsablauf zu erstellen.

        2. In Vollständige Repository-ID, gib deine Repository-ID als user- einname/repo-Name. Stellen Sie sicher, dass Sie Zugriff auf die Dateien in diesem Repository haben.

        3. In Quellenangabe (optional), geben Sie eine Repository-Quellreferenz ein (Branch-, Tag- oder Commit-ID). HealthOmics verwendet den Standard-Branch, wenn keine Quellreferenz angegeben ist.

        4. In Dateimuster ausschließen, geben Sie 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 den Syntax des Glob-Musters. Beispiel:

          1. tests/

          2. *.jpeg

          3. large_data.zip

      2. Für Wählen Sie den Definitionsordner aus S3:

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

        2. Wenn Ihr Konto nicht Eigentümer des Amazon S3-Buckets ist, geben Sie den des Bucket-Besitzers ein AWS Konto-ID im Konto-ID des S3-Bucket-Besitzers. Diese Information ist erforderlich, damit HealthOmics kann den Besitz des Buckets überprüfen.

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

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

    3. Hauptpfad der Workflow-Definitionsdatei (optional): Geben Sie den Dateipfad vom komprimierten Workflow-Definitionsordner oder -repository zum main datei. Dieser Parameter ist nicht erforderlich, wenn der Workflow-Definitionsordner nur eine Datei enthält oder wenn die Hauptdatei den Namen „main“ trägt.

  7. In der README-Datei (optionales) Bedienfeld, wählen Sie das Quelle der README-Datei und geben Sie die folgenden Informationen an:

    • Für Aus einem Repository-Service importieren, in README-Dateipfad, geben Sie den Pfad zur README-Datei im Repository ein.

    • Für Wählen Sie eine Datei aus S3, in README-Datei in S3, geben Sie die Amazon S3-URI für die README-Datei ein.

    • Für Wählen Sie eine Datei aus einer lokalen Quelle: in README — optional, wähle Wählen Sie eine Datei um die Markdown-Datei (.md) zum Hochladen auszuwählen.

  8. In der Standard-Run-Speicherkonfiguration Panel, geben Sie den Standard-Laufspeichertyp und die Kapazität für Läufe an, die diesen Workflow verwenden:

    1. Speichertyp ausführen: Wählen Sie, ob Sie statischen oder dynamischen Speicher als Standard für den temporären Laufspeicher verwenden möchten. Die Standardeinstellung ist statischer Speicher.

    2. Führen Sie die Speicherkapazität aus (optional): Für den Speichertyp „Static Run“ können Sie die Standardmenge an Run-Speicher 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.

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

  10. Wählen Sie Weiter aus.

  11. Auf der Fügen Sie Workflow-Parameter hinzu (optional) Seite, wählen Sie die Quelle des Parameters:

    1. Für Aus der Workflow-Definitionsdatei analysieren, HealthOmics analysiert automatisch die Workflow-Parameter aus der Workflow-Definitionsdatei.

    2. Für Geben Sie eine Parametervorlage aus dem Git-Repository an, verwenden Sie den Pfad zur Parameter-Vorlagendatei aus Ihrem Repository.

    3. Für Wählen Sie eine JSON-Datei aus der lokalen Quelle, lade eine hoch JSON Datei aus einer lokalen Quelle, die die Parameter angibt.

    4. Für Geben Sie Workflow-Parameter manuell ein, geben Sie Parameternamen und Beschreibungen manuell ein.

  12. In der Parameter-Vorschau Im Bedienfeld können Sie die Parameter für diese Workflow-Version überprüfen oder ändern. Wenn Sie das wiederherstellen JSON Datei, verlieren Sie alle lokalen Änderungen, die Sie vorgenommen haben.

  13. Auf der Neuzuordnung von Container-URIs Seite, in der Regeln für die Zuordnung Im Panel können Sie URI-Zuordnungsregeln für Ihren Workflow definieren.

    Für Quelle der Zuordnungsdatei, wählen Sie eine der folgenden Optionen:

    • Keine — Keine Zuordnungsregeln erforderlich.

    • Wählen Sie eine JSON-Datei aus S3 — Geben Sie den S3-Speicherort für die Zuordnungsdatei an.

    • Wählen Sie eine JSON-Datei aus einer lokalen Quelle — Geben Sie den Speicherort der Zuordnungsdatei auf Ihrem lokalen Gerät an.

    • Geben Sie die Zuordnungen manuell ein — geben Sie die Registrierungszuordnungen und Image-Zuordnungen in das Zuordnungen Panel.

  14. Die Konsole zeigt die Zuordnungen Panel. Wenn Sie eine Mapping-Quelldatei ausgewählt haben, zeigt die Konsole die Werte aus der Datei an.

    1. In Zuordnungen in der Registrierung, Sie können die Zuordnungen bearbeiten oder Zuordnungen hinzufügen (maximal 20 Registrierungszuordnungen).

      Jede Registrierungszuordnung enthält die folgenden Felder:

      • URL der Upstream-Registrierung — Die URI der Upstream-Registrierung.

      • ECR-Repository-Präfix — Das Repository-Präfix, das im privaten Amazon ECR-Repository verwendet werden soll.

      • (Fakultativ) Präfix für das vorgelagerte — Das Präfix des Repositorys in der Upstream-Registrierung.

      • (Fakultativ) ECR-Konto-ID — Konto-ID des Kontos, dem das Upstream-Container-Image gehört.

      • (Fakultativ) ARN für Anmeldeinformationen — Der ARN des Secrets Manager-Geheimnisses, das Ihre Anmeldeinformationen für die Registrierung enthält. Erforderlich für Registries, die Amazon ECR Pull-Through-Cache nicht unterstützt, wie Seqera, NVIDIA NGC, Google Artifact Registry und Google Container Registry. Weitere Informationen finden Sie unter Verwendung von Drittanbieter-Registrierungen, die vom Pull-Through-Cache nicht unterstützt werden.

    2. In Bildzuordnungen, Sie können die Bildzuordnungen bearbeiten oder Zuordnungen hinzufügen (maximal 100 Bildzuordnungen).

      Jede Bildzuordnung enthält die folgenden Felder:

      • Quellbild — Gibt den URI des Quellbilds in der Upstream-Registrierung an.

      • Zielbild — Gibt den URI des entsprechenden Images in der privaten Amazon ECR-Registrierung an.

  15. Wählen Sie Weiter aus.

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

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

Erstellen Sie eine Workflow-Version mit der CLI

Sie können eine Workflow-Version mit dem erstellen CreateWorkflowVersion API-Betrieb. Für optionale Parameter HealthOmics verwendet 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 bestimmt. Details hierzu finden Sie unter HealthOmics Anforderungen an die Workflow-Definition.
Accelerators Keine
Tags (Markierungen) Keine

Das folgende CLI-Beispiel erstellt eine Workflow-Version mit statischem Speicher als Standard-Ausführungsspeicher:

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-Ordner befindet, geben Sie den Speicherort mithilfe der definition-uri Parameter statt definition-zip. Weitere Informationen finden Sie unter CreateWorkflowVersion in der AWS HealthOmics 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 mithilfe eines SDK

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

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 mithilfe von get-workflow-version, wie gezeigt.

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

Die Antwort enthält Ihre Workflow-Details, einschließlich des Status, wie abgebildet.

{ "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 zu ACTIVE.