Class Hierarchy

• starcluster.optcomplete.AllCompleter: Completes by listing all possible files in current directory.
• starcluster.optcomplete.CmdComplete: Simple default base class implementation for a subcommand that supports command completion.
  • starcluster.cli.CmdBase
    • starcluster.cli.CmdCreateImage: createimage [options] <instance-id> <image_name> <bucket>
    • starcluster.cli.CmdCreateVolume: createvolume [options] <volume_size> <volume_zone>
    • starcluster.cli.CmdListBuckets: listbuckets
    • starcluster.cli.CmdListClusters: listclusters
    • starcluster.cli.CmdListImages: listimages [options]
    • starcluster.cli.CmdListInstances: listinstances [options]
    • starcluster.cli.CmdListPublic: listpublic
    • starcluster.cli.CmdListSpots: listspots
    • starcluster.cli.CmdListVolumes: listvolumes
    • starcluster.cli.CmdListZones: listzones
    • starcluster.cli.CmdRemoveImage: removeami [options] <imageid>
    • starcluster.cli.CmdRemoveVolume: removevolume [options] <volume_id>
    • starcluster.cli.CmdRunPlugin: runplugin <plugin_name> <cluster_tag>
    • starcluster.cli.CmdShell: shell
    • starcluster.cli.CmdShowBucket: showbucket <bucket>
    • starcluster.cli.CmdShowConsole: showconsole <instance-id>
    • starcluster.cli.CmdShowImage: showimage <image_id>
    • starcluster.cli.CmdSpotHistory: spothistory [options] <instance_type>
    • starcluster.cli.CmdSshInstance: sshintance [options] <instance-id>
    • starcluster.cli.CmdSshMaster: sshmaster [options] <cluster>
    • starcluster.cli.CmdSshNode: sshnode <cluster> <node>
    • starcluster.cli.CmdStart: start [options] <cluster_tag>
    • starcluster.cli.CmdStop: stop [options] <cluster>
• starcluster.cli.CmdHelp: help
• starcluster.optcomplete.DirCompleter: Completes by listing subdirectories only.
• logging.Filterer: A base class for loggers and handlers which allows them to share common code.
  • logging.Handler: Handler instances dispatch logging events to specific destinations.
    • logging.StreamHandler: A handler class which writes logging records, appropriately formatted, to a stream.
      • starcluster.logger.ConsoleLogger
• starcluster.optcomplete.ListCompleter: Completes by filtering using a fixed list of strings.
• starcluster.optcomplete.NoneCompleter: Generates empty completion list.
• starcluster.optcomplete.RegexCompleter: Completes by filtering all possible files with the given list of regexps.
• object: The most base type
  • exceptions.BaseException: Common base class for all exceptions
    • exceptions.Exception: Common base class for all non-exit exceptions.
      • starcluster.exception.BaseException
        • starcluster.exception.AWSError
          • starcluster.exception.AMIDoesNotExist
          • starcluster.exception.EC2CertDoesNotExist
          • starcluster.exception.EC2CertRequired
          • starcluster.exception.EC2PrivateKeyDoesNotExist
          • starcluster.exception.EC2PrivateKeyRequired
          • starcluster.exception.InstanceDoesNotExist
          • starcluster.exception.InstanceNotRunning
          • starcluster.exception.InvalidBucketName
          • starcluster.exception.InvalidImageName
          • starcluster.exception.KeyPairDoesNotExist
          • starcluster.exception.SecurityGroupDoesNotExist
          • starcluster.exception.SpotHistoryError
          • starcluster.exception.VolumeDoesNotExist
          • starcluster.exception.ZoneDoesNotExist
        • starcluster.exception.CancelledCreateImage
        • starcluster.exception.CancelledCreateVolume
        • starcluster.exception.CancelledStartRequest
        • starcluster.exception.ClusterDoesNotExist: Exception raised when user requests a running cluster that does not exist
        • starcluster.exception.ClusterExists
        • starcluster.exception.ClusterReceiptError: Raised when Cluster class fails to create a receipt on the master node
        • starcluster.exception.ClusterTemplateDoesNotExist: Exception raised when user requests a cluster template that does not exist
        • starcluster.exception.ConfigError: Base class for all config related errors
          • starcluster.exception.ConfigHasNoSections
          • starcluster.exception.ConfigNotFound
          • starcluster.exception.ConfigSectionMissing
          • starcluster.exception.KeyNotFound
          • starcluster.exception.MultipleDefaultTemplates
          • starcluster.exception.NoDefaultTemplateFound
          • starcluster.exception.PluginNotFound
        • starcluster.exception.ExperimentalFeature
        • starcluster.exception.InvalidDevice
        • starcluster.exception.InvalidIsoDate
        • starcluster.exception.InvalidPartition
        • starcluster.exception.PluginError: Base class for plugin errors
          • starcluster.exception.PluginLoadError: Raised when an error is encountered while loading a plugin
          • starcluster.exception.PluginSyntaxError: Raised when plugin contains syntax errors
        • starcluster.exception.SSHError: Base class for all SSH related errors
          • starcluster.exception.SSHAuthException: Raised when an ssh connection fails to authenticate
          • starcluster.exception.SSHConnectionError: Raised when ssh fails to to connect to a host (socket error)
        • starcluster.exception.SSHNoCredentialsError
        • starcluster.exception.ValidationError: Base class for validation related errors
          • starcluster.exception.ClusterValidationError: Cluster validation related errors
            • starcluster.exception.IncompatibleSettings: Raised when two or more settings conflict with each other
            • starcluster.exception.InvalidZone: Raised when user specified a zone that is not the same as the zone of the volumes being attached
            • starcluster.exception.VolumesZoneError
      • exceptions.StandardError: Base class for all standard Python exceptions that do not represent interpreter exiting.
        • exceptions.AssertionError: Assertion failed.
  • starcluster.cluster.Cluster
  • starcluster.clustersetup.ClusterSetup: ClusterSetup Interface
    • starcluster.clustersetup.DefaultClusterSetup: Default ClusterSetup implementation for StarCluster
    • starcluster.tests.mytestplugin.SetupClass
    • starcluster.tests.mytestplugin.SetupClass2
    • starcluster.tests.mytestplugin.SetupClass3
  • starcluster.ssh.Connection: Establishes an ssh connection to a remote host using either password or private key authentication.
  • starcluster.image.EC2ImageCreator: Class for creating a new AMI from a running instance
  • starcluster.awsutils.EasyAWS
    • starcluster.awsutils.EasyEC2
    • starcluster.awsutils.EasyS3
  • starcluster.node.Node: This class represents a single compute node in a StarCluster.
  • starcluster.config.StarClusterConfig: Loads StarCluster configuration settings defined in config_file which defaults to ~/.starclustercfg
  • unittest.TestCase: A class whose instances are single test cases.
    • starcluster.tests.StarClusterTest
      • starcluster.tests.test_cluster_validation.TestClusterValidation
      • starcluster.tests.test_config.TestStarClusterConfig
  • starcluster.volume.VolumeCreator
  • threading._Verbose
    • threading.Thread
      • starcluster.spinner.Spinner
  • dict: dict() -> new empty dictionary.
    • starcluster.utils.AttributeDict: Subclass of dict that allows read-only attribute-like access to dictionary key/values