4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Remote API resource implementations.
27 According to RFC2616 the main difference between PUT and POST is that
28 POST can create new resources but PUT can only create the resource the
29 URI was pointing to on the PUT request.
31 In the context of this module POST on ``/2/instances`` to change an existing
32 entity is legitimate, while PUT would not be. PUT creates a new entity (e.g. a
33 new instance) with a name specified in the request.
35 Quoting from RFC2616, section 9.6::
37 The fundamental difference between the POST and PUT requests is reflected in
38 the different meaning of the Request-URI. The URI in a POST request
39 identifies the resource that will handle the enclosed entity. That resource
40 might be a data-accepting process, a gateway to some other protocol, or a
41 separate entity that accepts annotations. In contrast, the URI in a PUT
42 request identifies the entity enclosed with the request -- the user agent
43 knows what URI is intended and the server MUST NOT attempt to apply the
44 request to some other resource. If the server desires that the request be
45 applied to a different URI, it MUST send a 301 (Moved Permanently) response;
46 the user agent MAY then make its own decision regarding whether or not to
49 So when adding new methods, if they are operating on the URI entity itself,
50 PUT should be prefered over POST.
54 # pylint: disable-msg=C0103
56 # C0103: Invalid name, since the R_* names are not conforming
58 from ganeti import opcodes
59 from ganeti import http
60 from ganeti import constants
61 from ganeti import cli
62 from ganeti import rapi
64 from ganeti import compat
65 from ganeti import ssconf
66 from ganeti.rapi import baserlib
69 _COMMON_FIELDS = ["ctime", "mtime", "uuid", "serial_no", "tags"]
70 I_FIELDS = ["name", "admin_state", "os",
73 "nic.ips", "nic.macs", "nic.modes", "nic.links", "nic.bridges",
75 "disk.sizes", "disk_usage",
76 "beparams", "hvparams",
77 "oper_state", "oper_ram", "oper_vcpus", "status",
78 "custom_hvparams", "custom_beparams", "custom_nicparams",
81 N_FIELDS = ["name", "offline", "master_candidate", "drained",
83 "mtotal", "mnode", "mfree",
84 "pinst_cnt", "sinst_cnt",
85 "ctotal", "cnodes", "csockets",
87 "pinst_list", "sinst_list",
88 "master_capable", "vm_capable",
100 "id", "ops", "status", "summary",
102 "received_ts", "start_ts", "end_ts",
105 J_FIELDS = J_FIELDS_BULK + [
110 _NR_DRAINED = "drained"
111 _NR_MASTER_CANDIATE = "master-candidate"
112 _NR_MASTER = "master"
113 _NR_OFFLINE = "offline"
114 _NR_REGULAR = "regular"
117 constants.NR_MASTER: _NR_MASTER,
118 constants.NR_MCANDIDATE: _NR_MASTER_CANDIATE,
119 constants.NR_DRAINED: _NR_DRAINED,
120 constants.NR_OFFLINE: _NR_OFFLINE,
121 constants.NR_REGULAR: _NR_REGULAR,
124 assert frozenset(_NR_MAP.keys()) == constants.NR_ALL
126 # Request data version field
127 _REQ_DATA_VERSION = "__version__"
129 # Feature string for instance creation request data version 1
130 _INST_CREATE_REQV1 = "instance-create-reqv1"
132 # Feature string for instance reinstall request version 1
133 _INST_REINSTALL_REQV1 = "instance-reinstall-reqv1"
135 # Feature string for node migration version 1
136 _NODE_MIGRATE_REQV1 = "node-migrate-reqv1"
138 # Feature string for node evacuation with LU-generated jobs
139 _NODE_EVAC_RES1 = "node-evac-res1"
141 ALL_FEATURES = frozenset([
143 _INST_REINSTALL_REQV1,
148 # Timeout for /2/jobs/[job_id]/wait. Gives job up to 10 seconds to change.
152 class R_root(baserlib.ResourceBase):
158 """Supported for legacy reasons.
164 class R_version(baserlib.ResourceBase):
165 """/version resource.
167 This resource should be used to determine the remote API version and
168 to adapt clients accordingly.
173 """Returns the remote API version.
176 return constants.RAPI_VERSION
179 class R_2_info(baserlib.ResourceBase):
184 """Returns cluster information.
187 client = self.GetClient()
188 return client.QueryClusterInfo()
191 class R_2_features(baserlib.ResourceBase):
192 """/2/features resource.
197 """Returns list of optional RAPI features implemented.
200 return list(ALL_FEATURES)
203 class R_2_os(baserlib.ResourceBase):
208 """Return a list of all OSes.
210 Can return error 500 in case of a problem.
212 Example: ["debian-etch"]
215 cl = self.GetClient()
216 op = opcodes.OpOsDiagnose(output_fields=["name", "variants"], names=[])
217 job_id = self.SubmitJob([op], cl=cl)
218 # we use custom feedback function, instead of print we log the status
219 result = cli.PollJob(job_id, cl, feedback_fn=baserlib.FeedbackFn)
220 diagnose_data = result[0]
222 if not isinstance(diagnose_data, list):
223 raise http.HttpBadGateway(message="Can't get OS list")
226 for (name, variants) in diagnose_data:
227 os_names.extend(cli.CalculateOSNames(name, variants))
232 class R_2_redist_config(baserlib.OpcodeResource):
233 """/2/redistribute-config resource.
236 PUT_OPCODE = opcodes.OpClusterRedistConf
239 class R_2_cluster_modify(baserlib.OpcodeResource):
240 """/2/modify resource.
243 PUT_OPCODE = opcodes.OpClusterSetParams
246 class R_2_jobs(baserlib.ResourceBase):
251 """Returns a dictionary of jobs.
253 @return: a dictionary with jobs id and uri.
256 client = self.GetClient()
259 bulkdata = client.QueryJobs(None, J_FIELDS_BULK)
260 return baserlib.MapBulkFields(bulkdata, J_FIELDS_BULK)
262 jobdata = map(compat.fst, client.QueryJobs(None, ["id"]))
263 return baserlib.BuildUriList(jobdata, "/2/jobs/%s",
264 uri_fields=("id", "uri"))
267 class R_2_jobs_id(baserlib.ResourceBase):
268 """/2/jobs/[job_id] resource.
272 """Returns a job status.
274 @return: a dictionary with job parameters.
276 - id: job ID as a number
277 - status: current job status as a string
278 - ops: involved OpCodes as a list of dictionaries for each
280 - opstatus: OpCodes status as a list
281 - opresult: OpCodes results as a list of lists
284 job_id = self.items[0]
285 result = self.GetClient().QueryJobs([job_id, ], J_FIELDS)[0]
287 raise http.HttpNotFound()
288 return baserlib.MapFields(J_FIELDS, result)
291 """Cancel not-yet-started job.
294 job_id = self.items[0]
295 result = self.GetClient().CancelJob(job_id)
299 class R_2_jobs_id_wait(baserlib.ResourceBase):
300 """/2/jobs/[job_id]/wait resource.
303 # WaitForJobChange provides access to sensitive information and blocks
304 # machine resources (it's a blocking RAPI call), hence restricting access.
305 GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]
308 """Waits for job changes.
311 job_id = self.items[0]
313 fields = self.getBodyParameter("fields")
314 prev_job_info = self.getBodyParameter("previous_job_info", None)
315 prev_log_serial = self.getBodyParameter("previous_log_serial", None)
317 if not isinstance(fields, list):
318 raise http.HttpBadRequest("The 'fields' parameter should be a list")
320 if not (prev_job_info is None or isinstance(prev_job_info, list)):
321 raise http.HttpBadRequest("The 'previous_job_info' parameter should"
324 if not (prev_log_serial is None or
325 isinstance(prev_log_serial, (int, long))):
326 raise http.HttpBadRequest("The 'previous_log_serial' parameter should"
329 client = self.GetClient()
330 result = client.WaitForJobChangeOnce(job_id, fields,
331 prev_job_info, prev_log_serial,
332 timeout=_WFJC_TIMEOUT)
334 raise http.HttpNotFound()
336 if result == constants.JOB_NOTCHANGED:
340 (job_info, log_entries) = result
343 "job_info": job_info,
344 "log_entries": log_entries,
348 class R_2_nodes(baserlib.ResourceBase):
349 """/2/nodes resource.
353 """Returns a list of all nodes.
356 client = self.GetClient()
359 bulkdata = client.QueryNodes([], N_FIELDS, False)
360 return baserlib.MapBulkFields(bulkdata, N_FIELDS)
362 nodesdata = client.QueryNodes([], ["name"], False)
363 nodeslist = [row[0] for row in nodesdata]
364 return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",
365 uri_fields=("id", "uri"))
368 class R_2_nodes_name(baserlib.ResourceBase):
369 """/2/nodes/[node_name] resource.
373 """Send information about a node.
376 node_name = self.items[0]
377 client = self.GetClient()
379 result = baserlib.HandleItemQueryErrors(client.QueryNodes,
380 names=[node_name], fields=N_FIELDS,
381 use_locking=self.useLocking())
383 return baserlib.MapFields(N_FIELDS, result[0])
386 class R_2_nodes_name_role(baserlib.ResourceBase):
387 """ /2/nodes/[node_name]/role resource.
391 """Returns the current node role.
396 node_name = self.items[0]
397 client = self.GetClient()
398 result = client.QueryNodes(names=[node_name], fields=["role"],
399 use_locking=self.useLocking())
401 return _NR_MAP[result[0][0]]
404 """Sets the node role.
409 if not isinstance(self.request_body, basestring):
410 raise http.HttpBadRequest("Invalid body contents, not a string")
412 node_name = self.items[0]
413 role = self.request_body
415 if role == _NR_REGULAR:
420 elif role == _NR_MASTER_CANDIATE:
422 offline = drained = None
424 elif role == _NR_DRAINED:
426 candidate = offline = None
428 elif role == _NR_OFFLINE:
430 candidate = drained = None
433 raise http.HttpBadRequest("Can't set '%s' role" % role)
435 op = opcodes.OpNodeSetParams(node_name=node_name,
436 master_candidate=candidate,
439 force=bool(self.useForce()))
441 return self.SubmitJob([op])
444 class R_2_nodes_name_evacuate(baserlib.OpcodeResource):
445 """/2/nodes/[node_name]/evacuate resource.
448 POST_OPCODE = opcodes.OpNodeEvacuate
450 def GetPostOpInput(self):
451 """Evacuate all instances off a node.
454 return (self.request_body, {
455 "node_name": self.items[0],
456 "dry_run": self.dryRun(),
460 class R_2_nodes_name_migrate(baserlib.OpcodeResource):
461 """/2/nodes/[node_name]/migrate resource.
464 POST_OPCODE = opcodes.OpNodeMigrate
466 def GetPostOpInput(self):
467 """Migrate all primary instances from a node.
471 # Support old-style requests
472 if "live" in self.queryargs and "mode" in self.queryargs:
473 raise http.HttpBadRequest("Only one of 'live' and 'mode' should"
476 if "live" in self.queryargs:
477 if self._checkIntVariable("live", default=1):
478 mode = constants.HT_MIGRATION_LIVE
480 mode = constants.HT_MIGRATION_NONLIVE
482 mode = self._checkStringVariable("mode", default=None)
488 data = self.request_body
491 "node_name": self.items[0],
495 class R_2_nodes_name_storage(baserlib.ResourceBase):
496 """/2/nodes/[node_name]/storage resource.
499 # LUNodeQueryStorage acquires locks, hence restricting access to GET
500 GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]
503 node_name = self.items[0]
505 storage_type = self._checkStringVariable("storage_type", None)
507 raise http.HttpBadRequest("Missing the required 'storage_type'"
510 output_fields = self._checkStringVariable("output_fields", None)
511 if not output_fields:
512 raise http.HttpBadRequest("Missing the required 'output_fields'"
515 op = opcodes.OpNodeQueryStorage(nodes=[node_name],
516 storage_type=storage_type,
517 output_fields=output_fields.split(","))
518 return self.SubmitJob([op])
521 class R_2_nodes_name_storage_modify(baserlib.ResourceBase):
522 """/2/nodes/[node_name]/storage/modify resource.
526 node_name = self.items[0]
528 storage_type = self._checkStringVariable("storage_type", None)
530 raise http.HttpBadRequest("Missing the required 'storage_type'"
533 name = self._checkStringVariable("name", None)
535 raise http.HttpBadRequest("Missing the required 'name'"
540 if "allocatable" in self.queryargs:
541 changes[constants.SF_ALLOCATABLE] = \
542 bool(self._checkIntVariable("allocatable", default=1))
544 op = opcodes.OpNodeModifyStorage(node_name=node_name,
545 storage_type=storage_type,
548 return self.SubmitJob([op])
551 class R_2_nodes_name_storage_repair(baserlib.ResourceBase):
552 """/2/nodes/[node_name]/storage/repair resource.
556 node_name = self.items[0]
558 storage_type = self._checkStringVariable("storage_type", None)
560 raise http.HttpBadRequest("Missing the required 'storage_type'"
563 name = self._checkStringVariable("name", None)
565 raise http.HttpBadRequest("Missing the required 'name'"
568 op = opcodes.OpRepairNodeStorage(node_name=node_name,
569 storage_type=storage_type,
571 return self.SubmitJob([op])
574 class R_2_groups(baserlib.OpcodeResource):
575 """/2/groups resource.
578 POST_OPCODE = opcodes.OpGroupAdd
580 "name": "group_name",
583 def GetPostOpInput(self):
584 """Create a node group.
587 assert not self.items
588 return (self.request_body, {
589 "dry_run": self.dryRun(),
593 """Returns a list of all node groups.
596 client = self.GetClient()
599 bulkdata = client.QueryGroups([], G_FIELDS, False)
600 return baserlib.MapBulkFields(bulkdata, G_FIELDS)
602 data = client.QueryGroups([], ["name"], False)
603 groupnames = [row[0] for row in data]
604 return baserlib.BuildUriList(groupnames, "/2/groups/%s",
605 uri_fields=("name", "uri"))
608 class R_2_groups_name(baserlib.ResourceBase):
609 """/2/groups/[group_name] resource.
613 """Send information about a node group.
616 group_name = self.items[0]
617 client = self.GetClient()
619 result = baserlib.HandleItemQueryErrors(client.QueryGroups,
620 names=[group_name], fields=G_FIELDS,
621 use_locking=self.useLocking())
623 return baserlib.MapFields(G_FIELDS, result[0])
626 """Delete a node group.
629 op = opcodes.OpGroupRemove(group_name=self.items[0],
630 dry_run=bool(self.dryRun()))
632 return self.SubmitJob([op])
635 class R_2_groups_name_modify(baserlib.OpcodeResource):
636 """/2/groups/[group_name]/modify resource.
639 PUT_OPCODE = opcodes.OpGroupSetParams
641 def GetPutOpInput(self):
642 """Changes some parameters of node group.
646 return (self.request_body, {
647 "group_name": self.items[0],
651 class R_2_groups_name_rename(baserlib.OpcodeResource):
652 """/2/groups/[group_name]/rename resource.
655 PUT_OPCODE = opcodes.OpGroupRename
657 def GetPutOpInput(self):
658 """Changes the name of a node group.
661 assert len(self.items) == 1
662 return (self.request_body, {
663 "group_name": self.items[0],
664 "dry_run": self.dryRun(),
668 class R_2_groups_name_assign_nodes(baserlib.ResourceBase):
669 """/2/groups/[group_name]/assign-nodes resource.
673 """Assigns nodes to a group.
678 op = baserlib.FillOpcode(opcodes.OpGroupAssignNodes, self.request_body, {
679 "group_name": self.items[0],
680 "dry_run": self.dryRun(),
681 "force": self.useForce(),
684 return self.SubmitJob([op])
687 def _ParseInstanceCreateRequestVersion1(data, dry_run):
688 """Parses an instance creation request version 1.
690 @rtype: L{opcodes.OpInstanceCreate}
691 @return: Instance creation opcode
700 "name": "instance_name",
703 return baserlib.FillOpcode(opcodes.OpInstanceCreate, data, override,
707 class R_2_instances(baserlib.ResourceBase):
708 """/2/instances resource.
712 """Returns a list of all available instances.
715 client = self.GetClient()
717 use_locking = self.useLocking()
719 bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
720 return baserlib.MapBulkFields(bulkdata, I_FIELDS)
722 instancesdata = client.QueryInstances([], ["name"], use_locking)
723 instanceslist = [row[0] for row in instancesdata]
724 return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
725 uri_fields=("id", "uri"))
728 """Create an instance.
733 if not isinstance(self.request_body, dict):
734 raise http.HttpBadRequest("Invalid body contents, not a dictionary")
736 # Default to request data version 0
737 data_version = self.getBodyParameter(_REQ_DATA_VERSION, 0)
739 if data_version == 0:
740 raise http.HttpBadRequest("Instance creation request version 0 is no"
742 elif data_version == 1:
743 data = self.request_body.copy()
744 # Remove "__version__"
745 data.pop(_REQ_DATA_VERSION, None)
746 op = _ParseInstanceCreateRequestVersion1(data, self.dryRun())
748 raise http.HttpBadRequest("Unsupported request data version %s" %
751 return self.SubmitJob([op])
754 class R_2_instances_name(baserlib.ResourceBase):
755 """/2/instances/[instance_name] resource.
759 """Send information about an instance.
762 client = self.GetClient()
763 instance_name = self.items[0]
765 result = baserlib.HandleItemQueryErrors(client.QueryInstances,
766 names=[instance_name],
768 use_locking=self.useLocking())
770 return baserlib.MapFields(I_FIELDS, result[0])
773 """Delete an instance.
776 op = opcodes.OpInstanceRemove(instance_name=self.items[0],
777 ignore_failures=False,
778 dry_run=bool(self.dryRun()))
779 return self.SubmitJob([op])
782 class R_2_instances_name_info(baserlib.ResourceBase):
783 """/2/instances/[instance_name]/info resource.
787 """Request detailed instance information.
790 instance_name = self.items[0]
791 static = bool(self._checkIntVariable("static", default=0))
793 op = opcodes.OpInstanceQueryData(instances=[instance_name],
795 return self.SubmitJob([op])
798 class R_2_instances_name_reboot(baserlib.ResourceBase):
799 """/2/instances/[instance_name]/reboot resource.
801 Implements an instance reboot.
805 """Reboot an instance.
807 The URI takes type=[hard|soft|full] and
808 ignore_secondaries=[False|True] parameters.
811 instance_name = self.items[0]
812 reboot_type = self.queryargs.get("type",
813 [constants.INSTANCE_REBOOT_HARD])[0]
814 ignore_secondaries = bool(self._checkIntVariable("ignore_secondaries"))
815 op = opcodes.OpInstanceReboot(instance_name=instance_name,
816 reboot_type=reboot_type,
817 ignore_secondaries=ignore_secondaries,
818 dry_run=bool(self.dryRun()))
820 return self.SubmitJob([op])
823 class R_2_instances_name_startup(baserlib.ResourceBase):
824 """/2/instances/[instance_name]/startup resource.
826 Implements an instance startup.
830 """Startup an instance.
832 The URI takes force=[False|True] parameter to start the instance
833 if even if secondary disks are failing.
836 instance_name = self.items[0]
837 force_startup = bool(self._checkIntVariable("force"))
838 no_remember = bool(self._checkIntVariable("no_remember"))
839 op = opcodes.OpInstanceStartup(instance_name=instance_name,
841 dry_run=bool(self.dryRun()),
842 no_remember=no_remember)
844 return self.SubmitJob([op])
847 def _ParseShutdownInstanceRequest(name, data, dry_run, no_remember):
848 """Parses a request for an instance shutdown.
850 @rtype: L{opcodes.OpInstanceShutdown}
851 @return: Instance shutdown opcode
854 return baserlib.FillOpcode(opcodes.OpInstanceShutdown, data, {
855 "instance_name": name,
857 "no_remember": no_remember,
861 class R_2_instances_name_shutdown(baserlib.ResourceBase):
862 """/2/instances/[instance_name]/shutdown resource.
864 Implements an instance shutdown.
868 """Shutdown an instance.
873 baserlib.CheckType(self.request_body, dict, "Body contents")
875 no_remember = bool(self._checkIntVariable("no_remember"))
876 op = _ParseShutdownInstanceRequest(self.items[0], self.request_body,
877 bool(self.dryRun()), no_remember)
879 return self.SubmitJob([op])
882 def _ParseInstanceReinstallRequest(name, data):
883 """Parses a request for reinstalling an instance.
886 if not isinstance(data, dict):
887 raise http.HttpBadRequest("Invalid body contents, not a dictionary")
889 ostype = baserlib.CheckParameter(data, "os", default=None)
890 start = baserlib.CheckParameter(data, "start", exptype=bool,
892 osparams = baserlib.CheckParameter(data, "osparams", default=None)
895 opcodes.OpInstanceShutdown(instance_name=name),
896 opcodes.OpInstanceReinstall(instance_name=name, os_type=ostype,
901 ops.append(opcodes.OpInstanceStartup(instance_name=name, force=False))
906 class R_2_instances_name_reinstall(baserlib.ResourceBase):
907 """/2/instances/[instance_name]/reinstall resource.
909 Implements an instance reinstall.
913 """Reinstall an instance.
915 The URI takes os=name and nostartup=[0|1] optional
916 parameters. By default, the instance will be started
920 if self.request_body:
922 raise http.HttpBadRequest("Can't combine query and body parameters")
924 body = self.request_body
926 # Legacy interface, do not modify/extend
928 "os": self._checkStringVariable("os"),
929 "start": not self._checkIntVariable("nostartup"),
934 ops = _ParseInstanceReinstallRequest(self.items[0], body)
936 return self.SubmitJob(ops)
939 def _ParseInstanceReplaceDisksRequest(name, data):
940 """Parses a request for an instance export.
942 @rtype: L{opcodes.OpInstanceReplaceDisks}
943 @return: Instance export opcode
947 "instance_name": name,
952 raw_disks = data["disks"]
956 if not ht.TListOf(ht.TInt)(raw_disks): # pylint: disable-msg=E1102
957 # Backwards compatibility for strings of the format "1, 2, 3"
959 data["disks"] = [int(part) for part in raw_disks.split(",")]
960 except (TypeError, ValueError), err:
961 raise http.HttpBadRequest("Invalid disk index passed: %s" % str(err))
963 return baserlib.FillOpcode(opcodes.OpInstanceReplaceDisks, data, override)
966 class R_2_instances_name_replace_disks(baserlib.ResourceBase):
967 """/2/instances/[instance_name]/replace-disks resource.
971 """Replaces disks on an instance.
974 op = _ParseInstanceReplaceDisksRequest(self.items[0], self.request_body)
976 return self.SubmitJob([op])
979 class R_2_instances_name_activate_disks(baserlib.ResourceBase):
980 """/2/instances/[instance_name]/activate-disks resource.
984 """Activate disks for an instance.
986 The URI might contain ignore_size to ignore current recorded size.
989 instance_name = self.items[0]
990 ignore_size = bool(self._checkIntVariable("ignore_size"))
992 op = opcodes.OpInstanceActivateDisks(instance_name=instance_name,
993 ignore_size=ignore_size)
995 return self.SubmitJob([op])
998 class R_2_instances_name_deactivate_disks(baserlib.ResourceBase):
999 """/2/instances/[instance_name]/deactivate-disks resource.
1003 """Deactivate disks for an instance.
1006 instance_name = self.items[0]
1008 op = opcodes.OpInstanceDeactivateDisks(instance_name=instance_name)
1010 return self.SubmitJob([op])
1013 class R_2_instances_name_prepare_export(baserlib.ResourceBase):
1014 """/2/instances/[instance_name]/prepare-export resource.
1018 """Prepares an export for an instance.
1023 instance_name = self.items[0]
1024 mode = self._checkStringVariable("mode")
1026 op = opcodes.OpBackupPrepare(instance_name=instance_name,
1029 return self.SubmitJob([op])
1032 def _ParseExportInstanceRequest(name, data):
1033 """Parses a request for an instance export.
1035 @rtype: L{opcodes.OpBackupExport}
1036 @return: Instance export opcode
1039 # Rename "destination" to "target_node"
1041 data["target_node"] = data.pop("destination")
1045 return baserlib.FillOpcode(opcodes.OpBackupExport, data, {
1046 "instance_name": name,
1050 class R_2_instances_name_export(baserlib.ResourceBase):
1051 """/2/instances/[instance_name]/export resource.
1055 """Exports an instance.
1060 if not isinstance(self.request_body, dict):
1061 raise http.HttpBadRequest("Invalid body contents, not a dictionary")
1063 op = _ParseExportInstanceRequest(self.items[0], self.request_body)
1065 return self.SubmitJob([op])
1068 def _ParseMigrateInstanceRequest(name, data):
1069 """Parses a request for an instance migration.
1071 @rtype: L{opcodes.OpInstanceMigrate}
1072 @return: Instance migration opcode
1075 return baserlib.FillOpcode(opcodes.OpInstanceMigrate, data, {
1076 "instance_name": name,
1080 class R_2_instances_name_migrate(baserlib.ResourceBase):
1081 """/2/instances/[instance_name]/migrate resource.
1085 """Migrates an instance.
1090 baserlib.CheckType(self.request_body, dict, "Body contents")
1092 op = _ParseMigrateInstanceRequest(self.items[0], self.request_body)
1094 return self.SubmitJob([op])
1097 class R_2_instances_name_failover(baserlib.ResourceBase):
1098 """/2/instances/[instance_name]/failover resource.
1102 """Does a failover of an instance.
1107 baserlib.CheckType(self.request_body, dict, "Body contents")
1109 op = baserlib.FillOpcode(opcodes.OpInstanceFailover, self.request_body, {
1110 "instance_name": self.items[0],
1113 return self.SubmitJob([op])
1116 def _ParseRenameInstanceRequest(name, data):
1117 """Parses a request for renaming an instance.
1119 @rtype: L{opcodes.OpInstanceRename}
1120 @return: Instance rename opcode
1123 return baserlib.FillOpcode(opcodes.OpInstanceRename, data, {
1124 "instance_name": name,
1128 class R_2_instances_name_rename(baserlib.ResourceBase):
1129 """/2/instances/[instance_name]/rename resource.
1133 """Changes the name of an instance.
1138 baserlib.CheckType(self.request_body, dict, "Body contents")
1140 op = _ParseRenameInstanceRequest(self.items[0], self.request_body)
1142 return self.SubmitJob([op])
1145 def _ParseModifyInstanceRequest(name, data):
1146 """Parses a request for modifying an instance.
1148 @rtype: L{opcodes.OpInstanceSetParams}
1149 @return: Instance modify opcode
1152 return baserlib.FillOpcode(opcodes.OpInstanceSetParams, data, {
1153 "instance_name": name,
1157 class R_2_instances_name_modify(baserlib.ResourceBase):
1158 """/2/instances/[instance_name]/modify resource.
1162 """Changes some parameters of an instance.
1167 baserlib.CheckType(self.request_body, dict, "Body contents")
1169 op = _ParseModifyInstanceRequest(self.items[0], self.request_body)
1171 return self.SubmitJob([op])
1174 class R_2_instances_name_disk_grow(baserlib.ResourceBase):
1175 """/2/instances/[instance_name]/disk/[disk_index]/grow resource.
1179 """Increases the size of an instance disk.
1184 op = baserlib.FillOpcode(opcodes.OpInstanceGrowDisk, self.request_body, {
1185 "instance_name": self.items[0],
1186 "disk": int(self.items[1]),
1189 return self.SubmitJob([op])
1192 class R_2_instances_name_console(baserlib.ResourceBase):
1193 """/2/instances/[instance_name]/console resource.
1196 GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]
1199 """Request information for connecting to instance's console.
1201 @return: Serialized instance console description, see
1202 L{objects.InstanceConsole}
1205 client = self.GetClient()
1207 ((console, ), ) = client.QueryInstances([self.items[0]], ["console"], False)
1210 raise http.HttpServiceUnavailable("Instance console unavailable")
1212 assert isinstance(console, dict)
1216 def _GetQueryFields(args):
1221 fields = args["fields"]
1223 raise http.HttpBadRequest("Missing 'fields' query argument")
1225 return _SplitQueryFields(fields[0])
1228 def _SplitQueryFields(fields):
1232 return [i.strip() for i in fields.split(",")]
1235 class R_2_query(baserlib.ResourceBase):
1236 """/2/query/[resource] resource.
1239 # Results might contain sensitive information
1240 GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]
1242 def _Query(self, fields, filter_):
1243 return self.GetClient().Query(self.items[0], fields, filter_).ToDict()
1246 """Returns resource information.
1248 @return: Query result, see L{objects.QueryResponse}
1251 return self._Query(_GetQueryFields(self.queryargs), None)
1254 """Submits job querying for resources.
1256 @return: Query result, see L{objects.QueryResponse}
1259 body = self.request_body
1261 baserlib.CheckType(body, dict, "Body contents")
1264 fields = body["fields"]
1266 fields = _GetQueryFields(self.queryargs)
1268 return self._Query(fields, self.request_body.get("filter", None))
1271 class R_2_query_fields(baserlib.ResourceBase):
1272 """/2/query/[resource]/fields resource.
1276 """Retrieves list of available fields for a resource.
1278 @return: List of serialized L{objects.QueryFieldDefinition}
1282 raw_fields = self.queryargs["fields"]
1286 fields = _SplitQueryFields(raw_fields[0])
1288 return self.GetClient().QueryFields(self.items[0], fields).ToDict()
1291 class _R_Tags(baserlib.ResourceBase):
1292 """ Quasiclass for tagging resources
1294 Manages tags. When inheriting this class you must define the
1300 def __init__(self, items, queryargs, req):
1301 """A tag resource constructor.
1303 We have to override the default to sort out cluster naming case.
1306 baserlib.ResourceBase.__init__(self, items, queryargs, req)
1308 if self.TAG_LEVEL == constants.TAG_CLUSTER:
1311 self.name = items[0]
1314 """Returns a list of tags.
1316 Example: ["tag1", "tag2", "tag3"]
1319 kind = self.TAG_LEVEL
1321 if kind in (constants.TAG_INSTANCE,
1322 constants.TAG_NODEGROUP,
1323 constants.TAG_NODE):
1325 raise http.HttpBadRequest("Missing name on tag request")
1327 cl = self.GetClient()
1328 if kind == constants.TAG_INSTANCE:
1329 fn = cl.QueryInstances
1330 elif kind == constants.TAG_NODEGROUP:
1334 result = fn(names=[self.name], fields=["tags"], use_locking=False)
1335 if not result or not result[0]:
1336 raise http.HttpBadGateway("Invalid response from tag query")
1339 elif kind == constants.TAG_CLUSTER:
1340 assert not self.name
1341 # TODO: Use query API?
1342 ssc = ssconf.SimpleStore()
1343 tags = ssc.GetClusterTags()
1348 """Add a set of tags.
1350 The request as a list of strings should be PUT to this URI. And
1351 you'll have back a job id.
1354 # pylint: disable-msg=W0212
1355 if "tag" not in self.queryargs:
1356 raise http.HttpBadRequest("Please specify tag(s) to add using the"
1357 " the 'tag' parameter")
1358 op = opcodes.OpTagsSet(kind=self.TAG_LEVEL, name=self.name,
1359 tags=self.queryargs["tag"], dry_run=self.dryRun())
1360 return self.SubmitJob([op])
1365 In order to delete a set of tags, the DELETE
1366 request should be addressed to URI like:
1367 /tags?tag=[tag]&tag=[tag]
1370 # pylint: disable-msg=W0212
1371 if "tag" not in self.queryargs:
1372 # no we not gonna delete all tags
1373 raise http.HttpBadRequest("Cannot delete all tags - please specify"
1374 " tag(s) using the 'tag' parameter")
1375 op = opcodes.OpTagsDel(kind=self.TAG_LEVEL, name=self.name,
1376 tags=self.queryargs["tag"], dry_run=self.dryRun())
1377 return self.SubmitJob([op])
1380 class R_2_instances_name_tags(_R_Tags):
1381 """ /2/instances/[instance_name]/tags resource.
1383 Manages per-instance tags.
1386 TAG_LEVEL = constants.TAG_INSTANCE
1389 class R_2_nodes_name_tags(_R_Tags):
1390 """ /2/nodes/[node_name]/tags resource.
1392 Manages per-node tags.
1395 TAG_LEVEL = constants.TAG_NODE
1398 class R_2_groups_name_tags(_R_Tags):
1399 """ /2/groups/[group_name]/tags resource.
1401 Manages per-nodegroup tags.
1404 TAG_LEVEL = constants.TAG_NODEGROUP
1407 class R_2_tags(_R_Tags):
1408 """ /2/tags resource.
1410 Manages cluster tags.
1413 TAG_LEVEL = constants.TAG_CLUSTER