301 lines
9.3 KiB
Python
301 lines
9.3 KiB
Python
# Copyright 2010 Jacob Kaplan-Moss
|
|
|
|
# Copyright 2011 OpenStack LLC.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""
|
|
Server interface.
|
|
"""
|
|
|
|
import urllib
|
|
from novaclient.v1_1 import base
|
|
|
|
REBOOT_SOFT, REBOOT_HARD = 'SOFT', 'HARD'
|
|
|
|
|
|
class Server(base.Resource):
|
|
def __repr__(self):
|
|
return "<Server: %s>" % self.name
|
|
|
|
def delete(self):
|
|
"""
|
|
Delete (i.e. shut down and delete the image) this server.
|
|
"""
|
|
self.manager.delete(self)
|
|
|
|
def update(self, name=None):
|
|
"""
|
|
Update the name or the password for this server.
|
|
|
|
:param name: Update the server's name.
|
|
:param password: Update the root password.
|
|
"""
|
|
self.manager.update(self, name)
|
|
|
|
def create_image(self, name, metadata=None):
|
|
"""
|
|
Create an image based on this server.
|
|
|
|
:param name: The name of the image to create
|
|
:param metadata: The metadata to associated with the image.
|
|
"""
|
|
self.manager.create_image(self, name, metadata)
|
|
|
|
def change_password(self, password):
|
|
"""
|
|
Update the root password on this server.
|
|
|
|
:param password: The password to set.
|
|
"""
|
|
self.manager.change_password(self, password)
|
|
|
|
def reboot(self, type=REBOOT_SOFT):
|
|
"""
|
|
Reboot the server.
|
|
|
|
:param type: either :data:`REBOOT_SOFT` for a software-level reboot,
|
|
or `REBOOT_HARD` for a virtual power cycle hard reboot.
|
|
"""
|
|
self.manager.reboot(self, type)
|
|
|
|
def rebuild(self, image):
|
|
"""
|
|
Rebuild -- shut down and then re-image -- this server.
|
|
|
|
:param image: the :class:`Image` (or its ID) to re-image with.
|
|
"""
|
|
self.manager.rebuild(self, image)
|
|
|
|
def resize(self, flavor):
|
|
"""
|
|
Resize the server's resources.
|
|
|
|
:param flavor: the :class:`Flavor` (or its ID) to resize to.
|
|
|
|
Until a resize event is confirmed with :meth:`confirm_resize`, the old
|
|
server will be kept around and you'll be able to roll back to the old
|
|
flavor quickly with :meth:`revert_resize`. All resizes are
|
|
automatically confirmed after 24 hours.
|
|
"""
|
|
self.manager.resize(self, flavor)
|
|
|
|
def confirm_resize(self):
|
|
"""
|
|
Confirm that the resize worked, thus removing the original server.
|
|
"""
|
|
self.manager.confirm_resize(self)
|
|
|
|
def revert_resize(self):
|
|
"""
|
|
Revert a previous resize, switching back to the old server.
|
|
"""
|
|
self.manager.revert_resize(self)
|
|
|
|
@property
|
|
def public_ip(self):
|
|
"""
|
|
Shortcut to get this server's primary public IP address.
|
|
"""
|
|
if len(self.addresses['public']) == 0:
|
|
return ""
|
|
return self.addresses['public']
|
|
|
|
@property
|
|
def private_ip(self):
|
|
"""
|
|
Shortcut to get this server's primary private IP address.
|
|
"""
|
|
if len(self.addresses['private']) == 0:
|
|
return ""
|
|
return self.addresses['private']
|
|
|
|
@property
|
|
def image_id(self):
|
|
"""
|
|
Shortcut to get the image identifier.
|
|
"""
|
|
return self.image["id"]
|
|
|
|
@property
|
|
def flavor_id(self):
|
|
"""
|
|
Shortcut to get the flavor identifier.
|
|
"""
|
|
return self.flavor["id"]
|
|
|
|
|
|
|
|
|
|
class ServerManager(base.BootingManagerWithFind):
|
|
resource_class = Server
|
|
|
|
def get(self, server):
|
|
"""
|
|
Get a server.
|
|
|
|
:param server: ID of the :class:`Server` to get.
|
|
:rtype: :class:`Server`
|
|
"""
|
|
return self._get("/servers/%s" % base.getid(server), "server")
|
|
|
|
def list(self, detailed=True, search_opts=None):
|
|
"""
|
|
Get a list of servers.
|
|
Optional detailed returns details server info.
|
|
Optional reservation_id only returns instances with that
|
|
reservation_id.
|
|
|
|
:rtype: list of :class:`Server`
|
|
"""
|
|
if search_opts is None:
|
|
search_opts = {}
|
|
qparams = {}
|
|
# only use values in query string if they are set
|
|
for opt, val in search_opts.iteritems():
|
|
if val:
|
|
qparams[opt] = val
|
|
|
|
query_string = "?%s" % urllib.urlencode(qparams) if qparams else ""
|
|
|
|
detail = ""
|
|
if detailed:
|
|
detail = "/detail"
|
|
return self._list("/servers%s%s" % (detail, query_string), "servers")
|
|
|
|
def create(self, name, image, flavor, meta=None, files=None):
|
|
"""
|
|
Create (boot) a new server.
|
|
|
|
:param name: Something to name the server.
|
|
:param image: The :class:`Image` to boot with.
|
|
:param flavor: The :class:`Flavor` to boot onto.
|
|
:param meta: A dict of arbitrary key/value metadata to store for this
|
|
server. A maximum of five entries is allowed, and both
|
|
keys and values must be 255 characters or less.
|
|
:param files: A dict of files to overrwrite on the server upon boot.
|
|
Keys are file names (i.e. ``/etc/passwd``) and values
|
|
are the file contents (either as a string or as a
|
|
file-like object). A maximum of five entries is allowed,
|
|
and each file must be 10k or less.
|
|
"""
|
|
return self._boot("/servers", "server", name, image, flavor,
|
|
meta=meta, files=files)
|
|
|
|
def update(self, server, name=None):
|
|
"""
|
|
Update the name or the password for a server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to update.
|
|
:param name: Update the server's name.
|
|
"""
|
|
if name is None:
|
|
return
|
|
|
|
body = {
|
|
"server": {
|
|
"name": name,
|
|
},
|
|
}
|
|
|
|
self._update("/servers/%s" % base.getid(server), body)
|
|
|
|
def delete(self, server):
|
|
"""
|
|
Delete (i.e. shut down and delete the image) this server.
|
|
"""
|
|
self._delete("/servers/%s" % base.getid(server))
|
|
|
|
def reboot(self, server, type=REBOOT_SOFT):
|
|
"""
|
|
Reboot a server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
:param type: either :data:`REBOOT_SOFT` for a software-level reboot,
|
|
or `REBOOT_HARD` for a virtual power cycle hard reboot.
|
|
"""
|
|
self._action('reboot', server, {'type': type})
|
|
|
|
def create_image(self, server, name, metadata=None):
|
|
"""
|
|
Create an image based on this server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to create image from.
|
|
:param name: The name of the image to create
|
|
:param metadata: The metadata to associated with the image.
|
|
"""
|
|
body = {
|
|
"name": name,
|
|
"metadata": metadata or {},
|
|
}
|
|
self._action('createImage', server, body)
|
|
|
|
def change_password(self, server, password):
|
|
"""
|
|
Update the root password on a server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
:param password: The password to set.
|
|
"""
|
|
body = {
|
|
"adminPass": password,
|
|
}
|
|
self._action('changePassword', server, body)
|
|
|
|
def rebuild(self, server, image):
|
|
"""
|
|
Rebuild -- shut down and then re-image -- a server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
:param image: the :class:`Image` (or its ID) to re-image with.
|
|
"""
|
|
self._action('rebuild', server, {'imageRef': base.getid(image)})
|
|
|
|
def resize(self, server, flavor):
|
|
"""
|
|
Resize a server's resources.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
:param flavor: the :class:`Flavor` (or its ID) to resize to.
|
|
|
|
Until a resize event is confirmed with :meth:`confirm_resize`, the old
|
|
server will be kept around and you'll be able to roll back to the old
|
|
flavor quickly with :meth:`revert_resize`. All resizes are
|
|
automatically confirmed after 24 hours.
|
|
"""
|
|
self._action('resize', server, {'flavorRef': base.getid(flavor)})
|
|
|
|
def confirm_resize(self, server):
|
|
"""
|
|
Confirm that the resize worked, thus removing the original server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
"""
|
|
self._action('confirmResize', server)
|
|
|
|
def revert_resize(self, server):
|
|
"""
|
|
Revert a previous resize, switching back to the old server.
|
|
|
|
:param server: The :class:`Server` (or its ID) to share onto.
|
|
"""
|
|
self._action('revertResize', server)
|
|
|
|
def _action(self, action, server, info=None):
|
|
"""
|
|
Perform a server "action" -- reboot/rebuild/resize/etc.
|
|
"""
|
|
self.api.client.post('/servers/%s/action' % base.getid(server),
|
|
body={action: info})
|