toil.utils.toilSshCluster

SSH into the toil appliance container running on the leader of the cluster.

Attributes

logger

Exceptions

NoSuchClusterException

Indicates that the specified cluster does not exist.

Functions

parser_with_common_options([provisioner_options, ...])

cluster_factory(provisioner[, clusterName, ...])

Find and instantiate the appropriate provisioner instance to make clusters in the given cloud.

set_logging_from_options(options)

main()

Module Contents

toil.utils.toilSshCluster.parser_with_common_options(provisioner_options=False, jobstore_option=True, prog=None, default_log_level=None)[source]
Parameters:

  • provisioner_options (bool)

  • jobstore_option (bool)

  • prog (Optional[str])

  • default_log_level (Optional[int])

Return type:

configargparse.ArgParser

toil.utils.toilSshCluster.cluster_factory(provisioner, clusterName=None, clusterType='mesos', zone=None, nodeStorage=50, nodeStorageOverrides=None, sseKey=None, enable_fuse=False)[source]

Find and instantiate the appropriate provisioner instance to make clusters in the given cloud.

Raises ClusterTypeNotSupportedException if the given provisioner does not implement clusters of the given type.

Parameters:

  • provisioner (str) – The cloud type of the cluster.

  • clusterName (Optional[str]) – The name of the cluster.

  • clusterType (str) – The type of cluster: ‘mesos’ or ‘kubernetes’.

  • zone (Optional[str]) – The cloud zone

  • nodeStorage (int)

  • nodeStorageOverrides (Optional[List[str]])

  • sseKey (Optional[str])

  • enable_fuse (bool)

Returns:

A cluster object for the the cloud type.

Return type:

Union[aws.awsProvisioner.AWSProvisioner, gceProvisioner.GCEProvisioner]

exception toil.utils.toilSshCluster.NoSuchClusterException(cluster_name)[source]

Bases: Exception

Indicates that the specified cluster does not exist.

Parameters:

cluster_name (str)

toil.utils.toilSshCluster.set_logging_from_options(options)[source]
Parameters:

options (Union[toil.common.Config, argparse.Namespace])

Return type:

None

toil.utils.toilSshCluster.logger
toil.utils.toilSshCluster.main()[source]
Return type:

None