Synnefo » snf-ganeti » ganeti-local

#

#

# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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.

"""Remote API resource implementations.

PUT or POST?

============

According to RFC2616 the main difference between PUT and POST is that

POST can create new resources but PUT can only create the resource the

URI was pointing to on the PUT request.

In the context of this module POST on ``/2/instances`` to change an existing

entity is legitimate, while PUT would not be. PUT creates a new entity (e.g. a

new instance) with a name specified in the request.

Quoting from RFC2616, section 9.6::

  The fundamental difference between the POST and PUT requests is reflected in

  the different meaning of the Request-URI. The URI in a POST request

  identifies the resource that will handle the enclosed entity. That resource

  might be a data-accepting process, a gateway to some other protocol, or a

  separate entity that accepts annotations. In contrast, the URI in a PUT

  request identifies the entity enclosed with the request -- the user agent

  knows what URI is intended and the server MUST NOT attempt to apply the

  request to some other resource. If the server desires that the request be

  applied to a different URI, it MUST send a 301 (Moved Permanently) response;

  the user agent MAY then make its own decision regarding whether or not to

  redirect the request.

So when adding new methods, if they are operating on the URI entity itself,

PUT should be prefered over POST.

"""

# pylint: disable-msg=C0103

# C0103: Invalid name, since the R_* names are not conforming

from ganeti import opcodes

from ganeti import http

from ganeti import constants

from ganeti import cli

from ganeti import rapi

from ganeti import ht

from ganeti import compat

from ganeti.rapi import baserlib

_COMMON_FIELDS = ["ctime", "mtime", "uuid", "serial_no", "tags"]

I_FIELDS = ["name", "admin_state", "os",

            "pnode", "snodes",

            "disk_template",

            "nic.ips", "nic.macs", "nic.modes", "nic.links", "nic.bridges",

            "network_port",

            "disk.sizes", "disk_usage",

            "beparams", "hvparams",

            "oper_state", "oper_ram", "oper_vcpus", "status",

            "custom_hvparams", "custom_beparams", "custom_nicparams",

            ] + _COMMON_FIELDS

N_FIELDS = ["name", "offline", "master_candidate", "drained",

            "dtotal", "dfree",

            "mtotal", "mnode", "mfree",

            "pinst_cnt", "sinst_cnt",

            "ctotal", "cnodes", "csockets",

            "pip", "sip", "role",

            "pinst_list", "sinst_list",

            "master_capable", "vm_capable",

            "group.uuid",

            ] + _COMMON_FIELDS

G_FIELDS = [

  "alloc_policy",

  "name",

  "node_cnt",

  "node_list",

  ] + _COMMON_FIELDS

J_FIELDS_BULK = [

  "id", "ops", "status", "summary",

  "opstatus",

  "received_ts", "start_ts", "end_ts",

  ]

J_FIELDS = J_FIELDS_BULK + [

  "oplog",

  "opresult",

  ]

_NR_DRAINED = "drained"

_NR_MASTER_CANDIATE = "master-candidate"

_NR_MASTER = "master"

_NR_OFFLINE = "offline"

_NR_REGULAR = "regular"

_NR_MAP = {

  constants.NR_MASTER: _NR_MASTER,

  constants.NR_MCANDIDATE: _NR_MASTER_CANDIATE,

  constants.NR_DRAINED: _NR_DRAINED,

  constants.NR_OFFLINE: _NR_OFFLINE,

  constants.NR_REGULAR: _NR_REGULAR,

  }

assert frozenset(_NR_MAP.keys()) == constants.NR_ALL

# Request data version field

_REQ_DATA_VERSION = "__version__"

# Feature string for instance creation request data version 1

_INST_CREATE_REQV1 = "instance-create-reqv1"

# Feature string for instance reinstall request version 1

_INST_REINSTALL_REQV1 = "instance-reinstall-reqv1"

# Feature string for node migration version 1

_NODE_MIGRATE_REQV1 = "node-migrate-reqv1"

# Feature string for node evacuation with LU-generated jobs

_NODE_EVAC_RES1 = "node-evac-res1"

ALL_FEATURES = frozenset([

  _INST_CREATE_REQV1,

  _INST_REINSTALL_REQV1,

  _NODE_MIGRATE_REQV1,

  _NODE_EVAC_RES1,

  ])

# Timeout for /2/jobs/[job_id]/wait. Gives job up to 10 seconds to change.

_WFJC_TIMEOUT = 10

class R_root(baserlib.R_Generic):

  """/ resource.

  """

  @staticmethod

  def GET():

    """Supported for legacy reasons.

    """

    return None

class R_version(baserlib.R_Generic):

  """/version resource.

  This resource should be used to determine the remote API version and

  to adapt clients accordingly.

  """

  @staticmethod

  def GET():

    """Returns the remote API version.

    """

    return constants.RAPI_VERSION

class R_2_info(baserlib.R_Generic):

  """/2/info resource.

  """

  @staticmethod

  def GET():

    """Returns cluster information.

    """

    client = baserlib.GetClient()

    return client.QueryClusterInfo()

class R_2_features(baserlib.R_Generic):

  """/2/features resource.

  """

  @staticmethod

  def GET():

    """Returns list of optional RAPI features implemented.

    """

    return list(ALL_FEATURES)

class R_2_os(baserlib.R_Generic):

  """/2/os resource.

  """

  @staticmethod

  def GET():

    """Return a list of all OSes.

    Can return error 500 in case of a problem.

    Example: ["debian-etch"]

    """

    cl = baserlib.GetClient()

    op = opcodes.OpOsDiagnose(output_fields=["name", "variants"], names=[])

    job_id = baserlib.SubmitJob([op], cl)

    # we use custom feedback function, instead of print we log the status

    result = cli.PollJob(job_id, cl, feedback_fn=baserlib.FeedbackFn)

    diagnose_data = result[0]

    if not isinstance(diagnose_data, list):

      raise http.HttpBadGateway(message="Can't get OS list")

    os_names = []

    for (name, variants) in diagnose_data:

      os_names.extend(cli.CalculateOSNames(name, variants))

    return os_names

class R_2_redist_config(baserlib.R_Generic):

  """/2/redistribute-config resource.

  """

  @staticmethod

  def PUT():

    """Redistribute configuration to all nodes.

    """

    return baserlib.SubmitJob([opcodes.OpClusterRedistConf()])

class R_2_cluster_modify(baserlib.R_Generic):

  """/2/modify resource.

  """

  def PUT(self):

    """Modifies cluster parameters.

    @return: a job id

    """

    op = baserlib.FillOpcode(opcodes.OpClusterSetParams, self.request_body,

                             None)

    return baserlib.SubmitJob([op])

class R_2_jobs(baserlib.R_Generic):

  """/2/jobs resource.

  """

  def GET(self):

    """Returns a dictionary of jobs.

    @return: a dictionary with jobs id and uri.

    """

    client = baserlib.GetClient()

    if self.useBulk():

      bulkdata = client.QueryJobs(None, J_FIELDS_BULK)

      return baserlib.MapBulkFields(bulkdata, J_FIELDS_BULK)

    else:

      jobdata = map(compat.fst, client.QueryJobs(None, ["id"]))

      return baserlib.BuildUriList(jobdata, "/2/jobs/%s",

                                   uri_fields=("id", "uri"))

class R_2_jobs_id(baserlib.R_Generic):

  """/2/jobs/[job_id] resource.

  """

  def GET(self):

    """Returns a job status.

    @return: a dictionary with job parameters.

        The result includes:

            - id: job ID as a number

            - status: current job status as a string

            - ops: involved OpCodes as a list of dictionaries for each

              opcodes in the job

            - opstatus: OpCodes status as a list

            - opresult: OpCodes results as a list of lists

    """

    job_id = self.items[0]

    result = baserlib.GetClient().QueryJobs([job_id, ], J_FIELDS)[0]

    if result is None:

      raise http.HttpNotFound()

    return baserlib.MapFields(J_FIELDS, result)

  def DELETE(self):

    """Cancel not-yet-started job.

    """

    job_id = self.items[0]

    result = baserlib.GetClient().CancelJob(job_id)

    return result

class R_2_jobs_id_wait(baserlib.R_Generic):

  """/2/jobs/[job_id]/wait resource.

  """

  # WaitForJobChange provides access to sensitive information and blocks

  # machine resources (it's a blocking RAPI call), hence restricting access.

  GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]

  def GET(self):

    """Waits for job changes.

    """

    job_id = self.items[0]

    fields = self.getBodyParameter("fields")

    prev_job_info = self.getBodyParameter("previous_job_info", None)

    prev_log_serial = self.getBodyParameter("previous_log_serial", None)

    if not isinstance(fields, list):

      raise http.HttpBadRequest("The 'fields' parameter should be a list")

    if not (prev_job_info is None or isinstance(prev_job_info, list)):

      raise http.HttpBadRequest("The 'previous_job_info' parameter should"

                                " be a list")

    if not (prev_log_serial is None or

            isinstance(prev_log_serial, (int, long))):

      raise http.HttpBadRequest("The 'previous_log_serial' parameter should"

                                " be a number")

    client = baserlib.GetClient()

    result = client.WaitForJobChangeOnce(job_id, fields,

                                         prev_job_info, prev_log_serial,

                                         timeout=_WFJC_TIMEOUT)

    if not result:

      raise http.HttpNotFound()

    if result == constants.JOB_NOTCHANGED:

      # No changes

      return None

    (job_info, log_entries) = result

    return {

      "job_info": job_info,

      "log_entries": log_entries,

      }

class R_2_nodes(baserlib.R_Generic):

  """/2/nodes resource.

  """

  def GET(self):

    """Returns a list of all nodes.

    """

    client = baserlib.GetClient()

    if self.useBulk():

      bulkdata = client.QueryNodes([], N_FIELDS, False)

      return baserlib.MapBulkFields(bulkdata, N_FIELDS)

    else:

      nodesdata = client.QueryNodes([], ["name"], False)

      nodeslist = [row[0] for row in nodesdata]

      return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",

                                   uri_fields=("id", "uri"))

class R_2_nodes_name(baserlib.R_Generic):

  """/2/nodes/[node_name] resource.

  """

  def GET(self):

    """Send information about a node.

    """

    node_name = self.items[0]

    client = baserlib.GetClient()

    result = baserlib.HandleItemQueryErrors(client.QueryNodes,

                                            names=[node_name], fields=N_FIELDS,

                                            use_locking=self.useLocking())

    return baserlib.MapFields(N_FIELDS, result[0])

class R_2_nodes_name_role(baserlib.R_Generic):

  """ /2/nodes/[node_name]/role resource.

  """

  def GET(self):

    """Returns the current node role.

    @return: Node role

    """

    node_name = self.items[0]

    client = baserlib.GetClient()

    result = client.QueryNodes(names=[node_name], fields=["role"],

                               use_locking=self.useLocking())

    return _NR_MAP[result[0][0]]

  def PUT(self):

    """Sets the node role.

    @return: a job id

    """

    if not isinstance(self.request_body, basestring):

      raise http.HttpBadRequest("Invalid body contents, not a string")

    node_name = self.items[0]

    role = self.request_body

    if role == _NR_REGULAR:

      candidate = False

      offline = False

      drained = False

    elif role == _NR_MASTER_CANDIATE:

      candidate = True

      offline = drained = None

    elif role == _NR_DRAINED:

      drained = True

      candidate = offline = None

    elif role == _NR_OFFLINE:

      offline = True

      candidate = drained = None

    else:

      raise http.HttpBadRequest("Can't set '%s' role" % role)

    op = opcodes.OpNodeSetParams(node_name=node_name,

                                 master_candidate=candidate,

                                 offline=offline,

                                 drained=drained,

                                 force=bool(self.useForce()))

    return baserlib.SubmitJob([op])

class R_2_nodes_name_evacuate(baserlib.R_Generic):

  """/2/nodes/[node_name]/evacuate resource.

  """

  def POST(self):

    """Evacuate all instances off a node.

    """

    op = baserlib.FillOpcode(opcodes.OpNodeEvacuate, self.request_body, {

      "node_name": self.items[0],

      "dry_run": self.dryRun(),

      })

    return baserlib.SubmitJob([op])

class R_2_nodes_name_migrate(baserlib.R_Generic):

  """/2/nodes/[node_name]/migrate resource.

  """

  def POST(self):

    """Migrate all primary instances from a node.

    """

    node_name = self.items[0]

    if self.queryargs:

      # Support old-style requests

      if "live" in self.queryargs and "mode" in self.queryargs:

        raise http.HttpBadRequest("Only one of 'live' and 'mode' should"

                                  " be passed")

      if "live" in self.queryargs:

        if self._checkIntVariable("live", default=1):

          mode = constants.HT_MIGRATION_LIVE

        else:

          mode = constants.HT_MIGRATION_NONLIVE

      else:

        mode = self._checkStringVariable("mode", default=None)

      data = {

        "mode": mode,

        }

    else:

      data = self.request_body

    op = baserlib.FillOpcode(opcodes.OpNodeMigrate, data, {

      "node_name": node_name,

      })

    return baserlib.SubmitJob([op])

class R_2_nodes_name_storage(baserlib.R_Generic):

  """/2/nodes/[node_name]/storage resource.

  """

  # LUNodeQueryStorage acquires locks, hence restricting access to GET

  GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]

  def GET(self):

    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)

    if not storage_type:

      raise http.HttpBadRequest("Missing the required 'storage_type'"

                                " parameter")

    output_fields = self._checkStringVariable("output_fields", None)

    if not output_fields:

      raise http.HttpBadRequest("Missing the required 'output_fields'"

                                " parameter")

    op = opcodes.OpNodeQueryStorage(nodes=[node_name],

                                    storage_type=storage_type,

                                    output_fields=output_fields.split(","))

    return baserlib.SubmitJob([op])

class R_2_nodes_name_storage_modify(baserlib.R_Generic):

  """/2/nodes/[node_name]/storage/modify resource.

  """

  def PUT(self):

    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)

    if not storage_type:

      raise http.HttpBadRequest("Missing the required 'storage_type'"

                                " parameter")

    name = self._checkStringVariable("name", None)

    if not name:

      raise http.HttpBadRequest("Missing the required 'name'"

                                " parameter")

    changes = {}

    if "allocatable" in self.queryargs:

      changes[constants.SF_ALLOCATABLE] = \

        bool(self._checkIntVariable("allocatable", default=1))

    op = opcodes.OpNodeModifyStorage(node_name=node_name,

                                     storage_type=storage_type,

                                     name=name,

                                     changes=changes)

    return baserlib.SubmitJob([op])

class R_2_nodes_name_storage_repair(baserlib.R_Generic):

  """/2/nodes/[node_name]/storage/repair resource.

  """

  def PUT(self):

    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)

    if not storage_type:

      raise http.HttpBadRequest("Missing the required 'storage_type'"

                                " parameter")

    name = self._checkStringVariable("name", None)

    if not name:

      raise http.HttpBadRequest("Missing the required 'name'"

                                " parameter")

    op = opcodes.OpRepairNodeStorage(node_name=node_name,

                                     storage_type=storage_type,

                                     name=name)

    return baserlib.SubmitJob([op])

def _ParseCreateGroupRequest(data, dry_run):

  """Parses a request for creating a node group.

  @rtype: L{opcodes.OpGroupAdd}

  @return: Group creation opcode

  """

  override = {

    "dry_run": dry_run,

    }

  rename = {

    "name": "group_name",

    }

  return baserlib.FillOpcode(opcodes.OpGroupAdd, data, override,

                             rename=rename)

class R_2_groups(baserlib.R_Generic):

  """/2/groups resource.

  """

  def GET(self):

    """Returns a list of all node groups.

    """

    client = baserlib.GetClient()

    if self.useBulk():

      bulkdata = client.QueryGroups([], G_FIELDS, False)

      return baserlib.MapBulkFields(bulkdata, G_FIELDS)

    else:

      data = client.QueryGroups([], ["name"], False)

      groupnames = [row[0] for row in data]

      return baserlib.BuildUriList(groupnames, "/2/groups/%s",

                                   uri_fields=("name", "uri"))

  def POST(self):

    """Create a node group.

    @return: a job id

    """

    baserlib.CheckType(self.request_body, dict, "Body contents")

    op = _ParseCreateGroupRequest(self.request_body, self.dryRun())

    return baserlib.SubmitJob([op])

class R_2_groups_name(baserlib.R_Generic):

  """/2/groups/[group_name] resource.

  """

  def GET(self):

    """Send information about a node group.

    """

    group_name = self.items[0]

    client = baserlib.GetClient()

    result = baserlib.HandleItemQueryErrors(client.QueryGroups,

                                            names=[group_name], fields=G_FIELDS,

                                            use_locking=self.useLocking())

    return baserlib.MapFields(G_FIELDS, result[0])

  def DELETE(self):

    """Delete a node group.

    """

    op = opcodes.OpGroupRemove(group_name=self.items[0],

                               dry_run=bool(self.dryRun()))

    return baserlib.SubmitJob([op])

def _ParseModifyGroupRequest(name, data):

  """Parses a request for modifying a node group.

  @rtype: L{opcodes.OpGroupSetParams}

  @return: Group modify opcode

  """

  return baserlib.FillOpcode(opcodes.OpGroupSetParams, data, {

    "group_name": name,

    })

class R_2_groups_name_modify(baserlib.R_Generic):

  """/2/groups/[group_name]/modify resource.

  """

  def PUT(self):

    """Changes some parameters of node group.

    @return: a job id

    """

    baserlib.CheckType(self.request_body, dict, "Body contents")

    op = _ParseModifyGroupRequest(self.items[0], self.request_body)

    return baserlib.SubmitJob([op])

def _ParseRenameGroupRequest(name, data, dry_run):

  """Parses a request for renaming a node group.

  @type name: string

  @param name: name of the node group to rename

  @type data: dict

  @param data: the body received by the rename request

  @type dry_run: bool

  @param dry_run: whether to perform a dry run

  @rtype: L{opcodes.OpGroupRename}

  @return: Node group rename opcode

  """

  return baserlib.FillOpcode(opcodes.OpGroupRename, data, {

    "group_name": name,

    "dry_run": dry_run,

    })

class R_2_groups_name_rename(baserlib.R_Generic):

  """/2/groups/[group_name]/rename resource.

  """

  def PUT(self):

    """Changes the name of a node group.

    @return: a job id

    """

    baserlib.CheckType(self.request_body, dict, "Body contents")

    op = _ParseRenameGroupRequest(self.items[0], self.request_body,

                                  self.dryRun())

    return baserlib.SubmitJob([op])

class R_2_groups_name_assign_nodes(baserlib.R_Generic):

  """/2/groups/[group_name]/assign-nodes resource.

  """

  def PUT(self):

    """Assigns nodes to a group.

    @return: a job id