flags

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2018 License: GPL-3.0 Imports: 1 Imported by: 0

README

This package collects all the definitions of hotsub command line flags/options.

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

View Source
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 ...

View Source
var AwsRegion = cli.StringFlag{
	Name:  "aws-region",
	Usage: `AWS region name in which AmazonEC2 instances would be launched`,
	Value: "ap-northeast-1",
}

AwsRegion ...

View Source
var AwsSharedInstanceType = cli.StringFlag{
	Name:  "aws-shared-instance-type",
	Usage: `Shared Instance Type on AWS`,
	Value: "m4.4xlarge",
}

AwsSharedInstanceType ...

View Source
var AwsSubnetID = cli.StringFlag{
	Name:  "aws-subnet-id",
	Usage: `Subnet ID in which computing VMs are launched`,
}

AwsSubnetID ...

View Source
var AwsVpcID = cli.StringFlag{
	Name:  "aws-vpc-id",
	Usage: `VPC ID on which computing VMs are launched`,
}

AwsVpcID ...

View Source
var CWLFileFlag = cli.StringFlag{
	Name:  "cwl",
	Usage: "CWL file to run your workflow",
}

CWLFileFlag specifies CWL file.

View Source
var CWLParamFlag = cli.StringSliceFlag{
	Name:  "cwl-job",
	Usage: "Parameter files for CWL",
}

CWLParamFlag represents parameter files of CWL

View Source
var Concurrency = cli.Int64Flag{
	Name:  "concurrency,C",
	Usage: `Throttle concurrency number for running jobs`,
	Value: 8,
}
View Source
var Disksize = cli.UintFlag{
	Name:  "disk-size",
	Usage: `Size of data disk to attach for each job in GB.`,
	Value: 64,
}

Disksize ...

View Source
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.

View Source
var GoogleProject = cli.StringFlag{
	Name:  "google-project",
	Usage: "Project ID for GCP",
}

GoogleProject ...

View Source
var GoogleZone = cli.StringFlag{
	Name:  "google-zone",
	Usage: "GCP service zone name",
	Value: "asia-northeast1-a",
}

GoogleZone ...

View Source
var Image = cli.StringFlag{
	Name:  "image",
	Usage: `Image name from Docker Hub or other Docker image service.`,
	Value: "ubuntu:14.04",
}

Image ...

View Source
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.

Index lists and exports all the flags so that hotsub can use them.

View Source
var Keep = cli.BoolFlag{
	Name:  "keep",
	Usage: `Keep instances created for computing event after everything gets done`,
}

Keep ...

View Source
var LogDirectory = cli.StringFlag{
	Name:  "log-dir",
	Usage: `Path to log directory where stdout/stderr log files will be placed (default: "${cwd}/logs/${time}")`,
}
View Source
var Provider = cli.StringFlag{
	Name:  "provider,p",
	Usage: `Job service provider, either of [aws, gcp, vbox, hyperv]`,
	Value: "aws",
}
View Source
var Script = cli.StringFlag{
	Name:  "script",
	Usage: `Local path to a script to run inside the job's Docker container. (required)`,
}

Script ...

View Source
var Shared = cli.StringSliceFlag{
	Name:  "shared,S",
	Usage: `Shared data URL on cloud storage bucket. (e.g. s3://~)`,
}

Shared ...

View Source
var SharedDataDisksize = cli.IntFlag{
	Name:  "shareddata-disksize",
	Usage: `Disk size of shared data instance (in GB)`,
	Value: 64,
}

SharedDataDisksize ...

View Source
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 ...

View Source
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.

View Source
var Verbose = cli.BoolFlag{
	Name:  "verbose,v",
	Usage: `Print verbose log for operation.`,
}
View Source
var WDLFileFlag = cli.StringFlag{
	Name:  "wdl",
	Usage: "WDL file to run your workflow",
}

WDLFileFlag specifies WDL file.

View Source
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL