Synnefo » snf-ganeti

#

#

# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

# General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

# 02110-1301, USA.

"""Module dealing with command line parsing"""

import sys

import textwrap

import os.path

import time

import logging

from cStringIO import StringIO

from ganeti import utils

from ganeti import errors

from ganeti import constants

from ganeti import opcodes

from ganeti import luxi

from ganeti import ssconf

from ganeti import rpc

from ganeti import ssh

from ganeti import compat

from ganeti import netutils

from optparse import (OptionParser, TitledHelpFormatter,

                      Option, OptionValueError)

__all__ = [

  # Command line options

  "ADD_UIDS_OPT",

  "ALLOCATABLE_OPT",

  "ALL_OPT",

  "AUTO_PROMOTE_OPT",

  "AUTO_REPLACE_OPT",

  "BACKEND_OPT",

  "BLK_OS_OPT",

  "CAPAB_MASTER_OPT",

  "CAPAB_VM_OPT",

  "CLEANUP_OPT",

  "CLUSTER_DOMAIN_SECRET_OPT",

  "CONFIRM_OPT",

  "CP_SIZE_OPT",

  "DEBUG_OPT",

  "DEBUG_SIMERR_OPT",

  "DISKIDX_OPT",

  "DISK_OPT",

  "DISK_TEMPLATE_OPT",

  "DRAINED_OPT",

  "DRY_RUN_OPT",

  "DRBD_HELPER_OPT",

  "EARLY_RELEASE_OPT",

  "ENABLED_HV_OPT",

  "ERROR_CODES_OPT",

  "FIELDS_OPT",

  "FILESTORE_DIR_OPT",

  "FILESTORE_DRIVER_OPT",

  "FORCE_OPT",

  "FORCE_VARIANT_OPT",

  "GLOBAL_FILEDIR_OPT",

  "HID_OS_OPT",

  "HVLIST_OPT",

  "HVOPTS_OPT",

  "HYPERVISOR_OPT",

  "IALLOCATOR_OPT",

  "DEFAULT_IALLOCATOR_OPT",

  "IDENTIFY_DEFAULTS_OPT",

  "IGNORE_CONSIST_OPT",

  "IGNORE_FAILURES_OPT",

  "IGNORE_OFFLINE_OPT",

  "IGNORE_REMOVE_FAILURES_OPT",

  "IGNORE_SECONDARIES_OPT",

  "IGNORE_SIZE_OPT",

  "INTERVAL_OPT",

  "MAC_PREFIX_OPT",

  "MAINTAIN_NODE_HEALTH_OPT",

  "MASTER_NETDEV_OPT",

  "MC_OPT",

  "MIGRATION_MODE_OPT",

  "NET_OPT",

  "NEW_CLUSTER_CERT_OPT",

  "NEW_CLUSTER_DOMAIN_SECRET_OPT",

  "NEW_CONFD_HMAC_KEY_OPT",

  "NEW_RAPI_CERT_OPT",

  "NEW_SECONDARY_OPT",

  "NIC_PARAMS_OPT",

  "NODE_LIST_OPT",

  "NODE_PLACEMENT_OPT",

  "NODEGROUP_OPT",

  "NODRBD_STORAGE_OPT",

  "NOHDR_OPT",

  "NOIPCHECK_OPT",

  "NO_INSTALL_OPT",

  "NONAMECHECK_OPT",

  "NOLVM_STORAGE_OPT",

  "NOMODIFY_ETCHOSTS_OPT",

  "NOMODIFY_SSH_SETUP_OPT",

  "NONICS_OPT",

  "NONLIVE_OPT",

  "NONPLUS1_OPT",

  "NOSHUTDOWN_OPT",

  "NOSTART_OPT",

  "NOSSH_KEYCHECK_OPT",

  "NOVOTING_OPT",

  "NWSYNC_OPT",

  "ON_PRIMARY_OPT",

  "ON_SECONDARY_OPT",

  "OFFLINE_OPT",

  "OSPARAMS_OPT",

  "OS_OPT",

  "OS_SIZE_OPT",

  "PREALLOC_WIPE_DISKS_OPT",

  "PRIMARY_IP_VERSION_OPT",

  "PRIORITY_OPT",

  "RAPI_CERT_OPT",

  "READD_OPT",

  "REBOOT_TYPE_OPT",

  "REMOVE_INSTANCE_OPT",

  "REMOVE_UIDS_OPT",

  "RESERVED_LVS_OPT",

  "ROMAN_OPT",

  "SECONDARY_IP_OPT",

  "SELECT_OS_OPT",

  "SEP_OPT",

  "SHOWCMD_OPT",

  "SHUTDOWN_TIMEOUT_OPT",

  "SINGLE_NODE_OPT",

  "SRC_DIR_OPT",

  "SRC_NODE_OPT",

  "SUBMIT_OPT",

  "STATIC_OPT",

  "SYNC_OPT",

  "TAG_SRC_OPT",

  "TIMEOUT_OPT",

  "UIDPOOL_OPT",

  "USEUNITS_OPT",

  "USE_REPL_NET_OPT",

  "VERBOSE_OPT",

  "VG_NAME_OPT",

  "YES_DOIT_OPT",

  # Generic functions for CLI programs

  "GenericMain",

  "GenericInstanceCreate",

  "GetClient",

  "GetOnlineNodes",

  "JobExecutor",

  "JobSubmittedException",

  "ParseTimespec",

  "RunWhileClusterStopped",

  "SubmitOpCode",

  "SubmitOrSend",

  "UsesRPC",

  # Formatting functions

  "ToStderr", "ToStdout",

  "FormatError",

  "GenerateTable",

  "AskUser",

  "FormatTimestamp",

  "FormatLogMessage",

  # Tags functions

  "ListTags",

  "AddTags",

  "RemoveTags",

  # command line options support infrastructure

  "ARGS_MANY_INSTANCES",

  "ARGS_MANY_NODES",

  "ARGS_NONE",

  "ARGS_ONE_INSTANCE",

  "ARGS_ONE_NODE",

  "ARGS_ONE_OS",

  "ArgChoice",

  "ArgCommand",

  "ArgFile",

  "ArgHost",

  "ArgInstance",

  "ArgJobId",

  "ArgNode",

  "ArgOs",

  "ArgSuggest",

  "ArgUnknown",

  "OPT_COMPL_INST_ADD_NODES",

  "OPT_COMPL_MANY_NODES",

  "OPT_COMPL_ONE_IALLOCATOR",

  "OPT_COMPL_ONE_INSTANCE",

  "OPT_COMPL_ONE_NODE",

  "OPT_COMPL_ONE_NODEGROUP",

  "OPT_COMPL_ONE_OS",

  "cli_option",

  "SplitNodeOption",

  "CalculateOSNames",

  "ParseFields",

  "COMMON_CREATE_OPTS",

  ]

NO_PREFIX = "no_"

UN_PREFIX = "-"

#: Priorities (sorted)

_PRIORITY_NAMES = [

  ("low", constants.OP_PRIO_LOW),

  ("normal", constants.OP_PRIO_NORMAL),

  ("high", constants.OP_PRIO_HIGH),

  ]

#: Priority dictionary for easier lookup

# TODO: Replace this and _PRIORITY_NAMES with a single sorted dictionary once

# we migrate to Python 2.6

_PRIONAME_TO_VALUE = dict(_PRIORITY_NAMES)

class _Argument:

  def __init__(self, min=0, max=None): # pylint: disable-msg=W0622

    self.min = min

    self.max = max

  def __repr__(self):

    return ("<%s min=%s max=%s>" %

            (self.__class__.__name__, self.min, self.max))

class ArgSuggest(_Argument):

  """Suggesting argument.

  Value can be any of the ones passed to the constructor.

  """

  # pylint: disable-msg=W0622

  def __init__(self, min=0, max=None, choices=None):

    _Argument.__init__(self, min=min, max=max)

    self.choices = choices

  def __repr__(self):

    return ("<%s min=%s max=%s choices=%r>" %

            (self.__class__.__name__, self.min, self.max, self.choices))

class ArgChoice(ArgSuggest):

  """Choice argument.

  Value can be any of the ones passed to the constructor. Like L{ArgSuggest},

  but value must be one of the choices.

  """

class ArgUnknown(_Argument):

  """Unknown argument to program (e.g. determined at runtime).

  """

class ArgInstance(_Argument):

  """Instances argument.

  """

class ArgNode(_Argument):

  """Node argument.

  """

class ArgJobId(_Argument):

  """Job ID argument.

  """

class ArgFile(_Argument):

  """File path argument.

  """

class ArgCommand(_Argument):

  """Command argument.

  """

class ArgHost(_Argument):

  """Host argument.

  """

class ArgOs(_Argument):

  """OS argument.

  """

ARGS_NONE = []

ARGS_MANY_INSTANCES = [ArgInstance()]

ARGS_MANY_NODES = [ArgNode()]

ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)]

ARGS_ONE_NODE = [ArgNode(min=1, max=1)]

ARGS_ONE_OS = [ArgOs(min=1, max=1)]

def _ExtractTagsObject(opts, args):

  """Extract the tag type object.

  Note that this function will modify its args parameter.

  """

  if not hasattr(opts, "tag_type"):

    raise errors.ProgrammerError("tag_type not passed to _ExtractTagsObject")

  kind = opts.tag_type

  if kind == constants.TAG_CLUSTER:

    retval = kind, kind

  elif kind == constants.TAG_NODE or kind == constants.TAG_INSTANCE:

    if not args:

      raise errors.OpPrereqError("no arguments passed to the command")

    name = args.pop(0)

    retval = kind, name

  else:

    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)

  return retval

def _ExtendTags(opts, args):

  """Extend the args if a source file has been given.

  This function will extend the tags with the contents of the file

  passed in the 'tags_source' attribute of the opts parameter. A file

  named '-' will be replaced by stdin.

  """

  fname = opts.tags_source

  if fname is None:

    return

  if fname == "-":

    new_fh = sys.stdin

  else:

    new_fh = open(fname, "r")

  new_data = []

  try:

    # we don't use the nice 'new_data = [line.strip() for line in fh]'

    # because of python bug 1633941

    while True:

      line = new_fh.readline()

      if not line:

        break

      new_data.append(line.strip())

  finally:

    new_fh.close()

  args.extend(new_data)

def ListTags(opts, args):

  """List the tags on a given object.

  This is a generic implementation that knows how to deal with all

  three cases of tag objects (cluster, node, instance). The opts

  argument is expected to contain a tag_type field denoting what

  object type we work on.

  """

  kind, name = _ExtractTagsObject(opts, args)

  cl = GetClient()

  result = cl.QueryTags(kind, name)

  result = list(result)

  result.sort()

  for tag in result:

    ToStdout(tag)

def AddTags(opts, args):

  """Add tags on a given object.

  This is a generic implementation that knows how to deal with all

  three cases of tag objects (cluster, node, instance). The opts

  argument is expected to contain a tag_type field denoting what

  object type we work on.

  """

  kind, name = _ExtractTagsObject(opts, args)

  _ExtendTags(opts, args)

  if not args:

    raise errors.OpPrereqError("No tags to be added")

  op = opcodes.OpAddTags(kind=kind, name=name, tags=args)

  SubmitOpCode(op, opts=opts)

def RemoveTags(opts, args):

  """Remove tags from a given object.

  This is a generic implementation that knows how to deal with all

  three cases of tag objects (cluster, node, instance). The opts

  argument is expected to contain a tag_type field denoting what

  object type we work on.

  """

  kind, name = _ExtractTagsObject(opts, args)

  _ExtendTags(opts, args)

  if not args:

    raise errors.OpPrereqError("No tags to be removed")

  op = opcodes.OpDelTags(kind=kind, name=name, tags=args)

  SubmitOpCode(op, opts=opts)

def check_unit(option, opt, value): # pylint: disable-msg=W0613

  """OptParsers custom converter for units.

  """

  try:

    return utils.ParseUnit(value)

  except errors.UnitParseError, err:

    raise OptionValueError("option %s: %s" % (opt, err))

def _SplitKeyVal(opt, data):

  """Convert a KeyVal string into a dict.

  This function will convert a key=val[,...] string into a dict. Empty

  values will be converted specially: keys which have the prefix 'no_'

  will have the value=False and the prefix stripped, the others will

  have value=True.

  @type opt: string

  @param opt: a string holding the option name for which we process the

      data, used in building error messages

  @type data: string

  @param data: a string of the format key=val,key=val,...

  @rtype: dict

  @return: {key=val, key=val}

  @raises errors.ParameterError: if there are duplicate keys

  """

  kv_dict = {}

  if data:

    for elem in utils.UnescapeAndSplit(data, sep=","):

      if "=" in elem:

        key, val = elem.split("=", 1)

      else:

        if elem.startswith(NO_PREFIX):

          key, val = elem[len(NO_PREFIX):], False

        elif elem.startswith(UN_PREFIX):

          key, val = elem[len(UN_PREFIX):], None

        else:

          key, val = elem, True

      if key in kv_dict:

        raise errors.ParameterError("Duplicate key '%s' in option %s" %

                                    (key, opt))

      kv_dict[key] = val

  return kv_dict

def check_ident_key_val(option, opt, value):  # pylint: disable-msg=W0613

  """Custom parser for ident:key=val,key=val options.

  This will store the parsed values as a tuple (ident, {key: val}). As such,

  multiple uses of this option via action=append is possible.

  """

  if ":" not in value:

    ident, rest = value, ''

  else:

    ident, rest = value.split(":", 1)

  if ident.startswith(NO_PREFIX):

    if rest:

      msg = "Cannot pass options when removing parameter groups: %s" % value

      raise errors.ParameterError(msg)

    retval = (ident[len(NO_PREFIX):], False)

  elif ident.startswith(UN_PREFIX):

    if rest:

      msg = "Cannot pass options when removing parameter groups: %s" % value

      raise errors.ParameterError(msg)

    retval = (ident[len(UN_PREFIX):], None)

  else:

    kv_dict = _SplitKeyVal(opt, rest)

    retval = (ident, kv_dict)

  return retval

def check_key_val(option, opt, value):  # pylint: disable-msg=W0613

  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.

  """

  return _SplitKeyVal(opt, value)

def check_bool(option, opt, value): # pylint: disable-msg=W0613

  """Custom parser for yes/no options.

  This will store the parsed value as either True or False.

  """

  value = value.lower()

  if value == constants.VALUE_FALSE or value == "no":

    return False

  elif value == constants.VALUE_TRUE or value == "yes":

    return True

  else:

    raise errors.ParameterError("Invalid boolean value '%s'" % value)

# completion_suggestion is normally a list. Using numeric values not evaluating

# to False for dynamic completion.

(OPT_COMPL_MANY_NODES,

 OPT_COMPL_ONE_NODE,

 OPT_COMPL_ONE_INSTANCE,

 OPT_COMPL_ONE_OS,

 OPT_COMPL_ONE_IALLOCATOR,

 OPT_COMPL_INST_ADD_NODES,

 OPT_COMPL_ONE_NODEGROUP) = range(100, 107)

OPT_COMPL_ALL = frozenset([

  OPT_COMPL_MANY_NODES,

  OPT_COMPL_ONE_NODE,

  OPT_COMPL_ONE_INSTANCE,

  OPT_COMPL_ONE_OS,

  OPT_COMPL_ONE_IALLOCATOR,

  OPT_COMPL_INST_ADD_NODES,

  OPT_COMPL_ONE_NODEGROUP,

  ])

class CliOption(Option):

  """Custom option class for optparse.

  """

  ATTRS = Option.ATTRS + [

    "completion_suggest",

    ]

  TYPES = Option.TYPES + (

    "identkeyval",

    "keyval",

    "unit",

    "bool",

    )

  TYPE_CHECKER = Option.TYPE_CHECKER.copy()

  TYPE_CHECKER["identkeyval"] = check_ident_key_val

  TYPE_CHECKER["keyval"] = check_key_val

  TYPE_CHECKER["unit"] = check_unit

  TYPE_CHECKER["bool"] = check_bool

# optparse.py sets make_option, so we do it for our own option class, too

cli_option = CliOption

_YORNO = "yes|no"

DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count",

                       help="Increase debugging level")

NOHDR_OPT = cli_option("--no-headers", default=False,

                       action="store_true", dest="no_headers",

                       help="Don't display column headers")

SEP_OPT = cli_option("--separator", default=None,

                     action="store", dest="separator",

                     help=("Separator between output fields"

                           " (defaults to one space)"))

USEUNITS_OPT = cli_option("--units", default=None,

                          dest="units", choices=('h', 'm', 'g', 't'),

                          help="Specify units for output (one of hmgt)")

FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store",

                        type="string", metavar="FIELDS",

                        help="Comma separated list of output fields")

FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true",

                       default=False, help="Force the operation")

CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true",

                         default=False, help="Do not require confirmation")

IGNORE_OFFLINE_OPT = cli_option("--ignore-offline", dest="ignore_offline",

                                  action="store_true", default=False,

                                  help=("Ignore offline nodes and do as much"

                                        " as possible"))

TAG_SRC_OPT = cli_option("--from", dest="tags_source",

                         default=None, help="File with tag names")

SUBMIT_OPT = cli_option("--submit", dest="submit_only",

                        default=False, action="store_true",

                        help=("Submit the job and return the job ID, but"

                              " don't wait for the job to finish"))

SYNC_OPT = cli_option("--sync", dest="do_locking",

                      default=False, action="store_true",

                      help=("Grab locks while doing the queries"

                            " in order to ensure more consistent results"))

DRY_RUN_OPT = cli_option("--dry-run", default=False,

                         action="store_true",

                         help=("Do not execute the operation, just run the"

                               " check steps and verify it it could be"

                               " executed"))

VERBOSE_OPT = cli_option("-v", "--verbose", default=False,

                         action="store_true",

                         help="Increase the verbosity of the operation")

DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False,

                              action="store_true", dest="simulate_errors",

                              help="Debugging option that makes the operation"

                              " treat most runtime checks as failed")

NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",

                        default=True, action="store_false",

                        help="Don't wait for sync (DANGEROUS!)")

DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template",

                               help="Custom disk setup (diskless, file,"

                               " plain or drbd)",

                               default=None, metavar="TEMPL",

                               choices=list(constants.DISK_TEMPLATES))

NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",

                        help="Do not create any network cards for"

                        " the instance")

FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",

                               help="Relative path under default cluster-wide"

                               " file storage dir to store file-based disks",

                               default=None, metavar="<DIR>")

FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver",

                                  help="Driver to use for image files",

                                  default="loop", metavar="<DRIVER>",

                                  choices=list(constants.FILE_DRIVER))

IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="<NAME>",

                            help="Select nodes for the instance automatically"

                            " using the <NAME> iallocator plugin",

                            default=None, type="string",

                            completion_suggest=OPT_COMPL_ONE_IALLOCATOR)

DEFAULT_IALLOCATOR_OPT = cli_option("-I", "--default-iallocator",

                            metavar="<NAME>",

                            help="Set the default instance allocator plugin",

                            default=None, type="string",

                            completion_suggest=OPT_COMPL_ONE_IALLOCATOR)

OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run",

                    metavar="<os>",

                    completion_suggest=OPT_COMPL_ONE_OS)

OSPARAMS_OPT = cli_option("-O", "--os-parameters", dest="osparams",

                         type="keyval", default={},

                         help="OS parameters")

FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant",

                               action="store_true", default=False,

                               help="Force an unknown variant")

NO_INSTALL_OPT = cli_option("--no-install", dest="no_install",

                            action="store_true", default=False,

                            help="Do not install the OS (will"

                            " enable no-start)")

BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams",

                         type="keyval", default={},

                         help="Backend parameters")

HVOPTS_OPT =  cli_option("-H", "--hypervisor-parameters", type="keyval",

                         default={}, dest="hvparams",

                         help="Hypervisor parameters")

HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor",

                            help="Hypervisor and hypervisor options, in the"

                            " format hypervisor:option=value,option=value,...",

                            default=None, type="identkeyval")

HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams",

                        help="Hypervisor and hypervisor options, in the"

                        " format hypervisor:option=value,option=value,...",

                        default=[], action="append", type="identkeyval")

NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True,

                           action="store_false",

                           help="Don't check that the instance's IP"

                           " is alive")