Documentation ¶
Overview ¶
Package flags defines all the flags hotsub can accept. Any flags must be defined under this package.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var AwsEC2InstanceType = cli.StringFlag{
Name: "aws-ec2-instance-type",
Usage: `AWS EC2 instance type. If specified, all --min-cores and --min-ram would be ignored.`,
Value: "t2.micro",
}
AwsEC2InstanceType ...
var AwsRegion = cli.StringFlag{
Name: "aws-region",
Usage: `AWS region name in which AmazonEC2 instances would be launched`,
Value: "ap-northeast-1",
}
AwsRegion ...
Name: "aws-shared-instance-type",
Usage: `Shared Instance Type on AWS`,
Value: "m4.4xlarge",
}AwsSharedInstanceType ...
var AwsSubnetID = cli.StringFlag{
Name: "aws-subnet-id",
Usage: `Subnet ID in which computing VMs are launched`,
}
AwsSubnetID ...
var AwsVpcID = cli.StringFlag{
Name: "aws-vpc-id",
Usage: `VPC ID on which computing VMs are launched`,
}
AwsVpcID ...
var CWLFileFlag = cli.StringFlag{
Name: "cwl",
Usage: "CWL file to run your workflow",
}
CWLFileFlag specifies CWL file.
var CWLParamFlag = cli.StringSliceFlag{
Name: "cwl-job",
Usage: "Parameter files for CWL",
}
CWLParamFlag represents parameter files of CWL
var Concurrency = cli.Int64Flag{
Name: "concurrency,C",
Usage: `Throttle concurrency number for running jobs`,
Value: 8,
}
var Disksize = cli.UintFlag{
Name: "disk-size",
Usage: `Size of data disk to attach for each job in GB.`,
Value: 64,
}
Disksize ...
var Env = cli.StringSliceFlag{
Name: "env,E",
Usage: `Environment variables to pass to all the workflow containers`,
}
Env flag allows to provide environment variables to each container, instead of using "--env" in tasks file. This flag is expected to be used for specifying common environment variables to containers, but at the same time, which is specific for project or every command line.
var GoogleProject = cli.StringFlag{
Name: "google-project",
Usage: "Project ID for GCP",
}
GoogleProject ...
var GoogleZone = cli.StringFlag{
Name: "google-zone",
Usage: "GCP service zone name",
Value: "asia-northeast1-a",
}
GoogleZone ...
var Image = cli.StringFlag{
Name: "image",
Usage: `Image name from Docker Hub or other Docker image service.`,
Value: "ubuntu:14.04",
}
Image ...
var IncludeFlag = cli.StringSliceFlag{
Name: "include",
Usage: "Local files to be included onto workflow container",
}
IncludeFlag represents local files to be included onto workflow container.
var Index = []cli.Flag{ Verbose, LogDirectory, Concurrency, Provider, Tasks, Image, Script, Shared, Keep, Env, Disksize, SharedDataDisksize, AwsRegion, AwsEC2InstanceType, AwsSharedInstanceType, AwsVpcID, AwsSubnetID, GoogleProject, GoogleZone, CWLFileFlag, CWLParamFlag, WDLFileFlag, WDLJobFileFlag, IncludeFlag, }
Index lists and exports all the flags so that hotsub can use them.
var Keep = cli.BoolFlag{
Name: "keep",
Usage: `Keep instances created for computing event after everything gets done`,
}
Keep ...
var LogDirectory = cli.StringFlag{
Name: "log-dir",
Usage: `Path to log directory where stdout/stderr log files will be placed (default: "${cwd}/logs/${time}")`,
}
var Provider = cli.StringFlag{
Name: "provider,p",
Usage: `Job service provider, either of [aws, gcp, vbox, hyperv]`,
Value: "aws",
}
var Script = cli.StringFlag{
Name: "script",
Usage: `Local path to a script to run inside the job's Docker container. (required)`,
}
Script ...
Name: "shared,S",
Usage: `Shared data URL on cloud storage bucket. (e.g. s3://~)`,
}Shared ...
Name: "shareddata-disksize",
Usage: `Disk size of shared data instance (in GB)`,
Value: 64,
}SharedDataDisksize ...
var Tasks = cli.StringFlag{
Name: "tasks",
Usage: `Path to CSV of task parameters, expected to specify --env, --input, --input-recursive and --output-recursive. (required)`,
}
Tasks ...
var Template = []cli.Flag{ cli.StringFlag{ Name: "name,n", Usage: "Template project name", Value: "helloworld", }, cli.StringFlag{ Name: "dir,d", Usage: "Directory to create this template", Value: ".", }, }
Template is a flag list for "template" subcommand.
var Verbose = cli.BoolFlag{
Name: "verbose,v",
Usage: `Print verbose log for operation.`,
}
var WDLFileFlag = cli.StringFlag{
Name: "wdl",
Usage: "WDL file to run your workflow",
}
WDLFileFlag specifies WDL file.
var WDLJobFileFlag = cli.StringSliceFlag{
Name: "wdl-job",
Usage: "Parameter files for WDL",
}
WDLJobFileFlag represents parameter files of WDL
Functions ¶
This section is empty.
Types ¶
This section is empty.