AWS omics documentation change
Summary
Expanded workflow creation requirements, added ECR container images and Sentieon licenses, updated workflow update capabilities, and clarified file upload options
Security assessment
Added guidance to store container images in private ECR repositories, which is a security best practice. However, there is no evidence of addressing a specific security vulnerability.
Diff
diff --git a/omics/latest/dev/creating-private-workflows.md b/omics/latest/dev/creating-private-workflows.md index 3307126ac..126afe018 100644 --- a//omics/latest/dev/creating-private-workflows.md +++ b//omics/latest/dev/creating-private-workflows.md @@ -7 +7 @@ -To create a private workflow, you require the following inputs: +To create a private workflow, you need: @@ -9 +9 @@ To create a private workflow, you require the following inputs: - * A workflow definition file written in WDL, Nextflow, or CWL. For more information, see [Workflow definition files in HealthOmics](./workflow-definition-files.html). + * **Workflow definition file** : A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in `.zip` format. For more information, see [Workflow definition files](./workflow-definition-files.html) in HealthOmics. @@ -11 +11 @@ To create a private workflow, you require the following inputs: - * A parameter template file written in JSON. For more information, see [Parameter template files for HealthOmics workflows](./parameter-templates.html). + * **Parameter template file** (optional): A parameter template file written in JSON. Create the file to define the run parameters, or HealthOmics generates the parameter template for you. For more information, see [Parameter template files for HealthOmics workflows](./parameter-templates.html). @@ -12,0 +13 @@ To create a private workflow, you require the following inputs: + * **Amazon ECR container images** : Create container images for the workflow and store them in a private Amazon ECR repository. @@ -13,0 +15 @@ To create a private workflow, you require the following inputs: + * **Sentieon licenses** (optional): Request a Sentieon license to use the Sentieon software in private workflows. @@ -16 +17,0 @@ To create a private workflow, you require the following inputs: -If your workflow definition file is larger than 4 MiB (zipped), upload it to an Amazon S3 folder, and specify the Amazon S3 location when you create the workflow. @@ -18 +18,0 @@ If your workflow definition file is larger than 4 MiB (zipped), upload it to an -After you create a workflow, you can change only a few of the configuration values. To change other information in the workflow, you can either create a new workflow or a new version of the workflow. @@ -20 +20,27 @@ After you create a workflow, you can change only a few of the configuration valu -You can use workflow versioning to organize and structure you workflows. Versions also help you to manage the introduction of iterative workflow updates. For more information about versions, see [Create a workflow version](./workflows-version-create.html). +For workflow definition files larger than 4 MiB (zipped), choose one of these options during workflow creation: + + * Upload to an Amazon Simple Storage Service folder and specify the location. + + * Upload to an external repository (max size 1 GiB) and specify the repository details. + + + + +After you create a workflow, you can update the following workflow information with the `UpdateWorkflow` operation: + + * Name + + * Description + + * Default storage type + + * Default storage capacity (with workflow ID) + + * README.md file + + + + +To change other information in the workflow, create a new workflow or workflow version. + +Use workflow versioning to organize and structure you workflows. Versions also help you to manage the introduction of iterative workflow updates. For more information about versions, see [Create a workflow version](./workflows-version-create.html).