245 lines
9.9 KiB
Python
Executable File
245 lines
9.9 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# Copyright 2015 Red Hat, Inc.
|
|
# Copyright 2015 Lenovo
|
|
#
|
|
# 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.
|
|
|
|
# Virtual BMC for controlling OpenStack instances, based on fakebmc from
|
|
# python-pyghmi
|
|
|
|
# Sample ipmitool commands:
|
|
# ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power on
|
|
# ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power status
|
|
# ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootdev pxe|disk # noqa: E501
|
|
# ipmitool -I lanplus -U admin -P password -H 127.0.0.1 mc reset cold
|
|
|
|
import argparse
|
|
import os
|
|
import sys
|
|
import time
|
|
|
|
from novaclient import exceptions
|
|
import os_client_config
|
|
import pyghmi.ipmi.bmc as bmc
|
|
|
|
|
|
class OpenStackBmc(bmc.Bmc):
|
|
def __init__(self, authdata, port, address, instance, cache_status,
|
|
os_cloud):
|
|
super(OpenStackBmc, self).__init__(authdata,
|
|
port=port,
|
|
address=address)
|
|
self.novaclient = os_client_config.make_client('compute',
|
|
cloud=os_cloud)
|
|
self.instance = None
|
|
self.cache_status = cache_status
|
|
self.cached_status = None
|
|
self.cached_task = None
|
|
self.target_status = None
|
|
# At times the bmc service is started before important things like
|
|
# networking have fully initialized. Keep trying to find the
|
|
# instance indefinitely, since there's no point in continuing if
|
|
# we don't have an instance.
|
|
while True:
|
|
try:
|
|
self.instance = self._find_instance(instance)
|
|
if self.instance is not None:
|
|
name = self.novaclient.servers.get(self.instance).name
|
|
self.log('Managing instance: %s UUID: %s' %
|
|
(name, self.instance))
|
|
break
|
|
except Exception as e:
|
|
self.log('Exception finding instance "%s": %s' % (instance, e))
|
|
time.sleep(1)
|
|
|
|
def _find_instance(self, instance):
|
|
try:
|
|
self.novaclient.servers.get(instance)
|
|
return instance
|
|
except exceptions.NotFound:
|
|
name_regex = '^%s$' % instance
|
|
i = self.novaclient.servers.list(search_opts={'name': name_regex})
|
|
if len(i) > 1:
|
|
self.log('Ambiguous instance name %s' % instance)
|
|
sys.exit(1)
|
|
try:
|
|
return i[0].id
|
|
except IndexError:
|
|
self.log('Could not find specified instance %s' % instance)
|
|
sys.exit(1)
|
|
|
|
def get_boot_device(self):
|
|
"""Return the currently configured boot device"""
|
|
server = self.novaclient.servers.get(self.instance)
|
|
if server.metadata.get('libvirt:pxe-first'):
|
|
retval = 'network'
|
|
else:
|
|
retval = 'hd'
|
|
self.log('Reporting boot device', retval)
|
|
return retval
|
|
|
|
def set_boot_device(self, bootdevice):
|
|
"""Set the boot device for the managed instance
|
|
|
|
:param bootdevice: One of ['network', 'hd] to set the boot device to
|
|
network or hard disk respectively.
|
|
"""
|
|
server = self.novaclient.servers.get(self.instance)
|
|
if bootdevice == 'network':
|
|
self.novaclient.servers.set_meta_item(
|
|
server, 'libvirt:pxe-first', '1'
|
|
)
|
|
else:
|
|
self.novaclient.servers.set_meta_item(
|
|
server, 'libvirt:pxe-first', ''
|
|
)
|
|
self.log('Set boot device to', bootdevice)
|
|
|
|
def cold_reset(self):
|
|
# Reset of the BMC, not managed system, here we will exit the demo
|
|
self.log('Shutting down in response to BMC cold reset request')
|
|
sys.exit(0)
|
|
|
|
def _instance_active(self):
|
|
no_cached_data = (self.cached_status is None)
|
|
instance_changing_state = (self.cached_status != self.target_status)
|
|
cache_disabled = (not self.cache_status)
|
|
|
|
if (no_cached_data or instance_changing_state or cache_disabled):
|
|
instance = self.novaclient.servers.get(self.instance)
|
|
self.cached_status = instance.status
|
|
self.cached_task = getattr(instance, 'OS-EXT-STS:task_state')
|
|
|
|
instance_is_active = (self.cached_status == 'ACTIVE')
|
|
instance_is_shutoff = (self.cached_status == 'SHUTOFF')
|
|
instance_is_powering_on = (self.cached_task == 'powering-on')
|
|
|
|
return (
|
|
instance_is_active or
|
|
(instance_is_shutoff and instance_is_powering_on)
|
|
)
|
|
|
|
def get_power_state(self):
|
|
"""Returns the current power state of the managed instance"""
|
|
state = self._instance_active()
|
|
self.log('Reporting power state "%s" for instance %s' %
|
|
(state, self.instance))
|
|
return state
|
|
|
|
def power_off(self):
|
|
"""Stop the managed instance"""
|
|
# this should be power down without waiting for clean shutdown
|
|
self.target_status = 'SHUTOFF'
|
|
if self._instance_active():
|
|
try:
|
|
self.novaclient.servers.stop(self.instance)
|
|
self.log('Powered off %s' % self.instance)
|
|
except exceptions.Conflict as e:
|
|
# This can happen if we get two requests to start a server in
|
|
# short succession. The instance may then be in a powering-on
|
|
# state, which means it is invalid to start it again.
|
|
self.log('Ignoring exception: "%s"' % e)
|
|
else:
|
|
self.log('%s is already off.' % self.instance)
|
|
|
|
def power_on(self):
|
|
"""Start the managed instance"""
|
|
self.target_status = 'ACTIVE'
|
|
if not self._instance_active():
|
|
try:
|
|
self.novaclient.servers.start(self.instance)
|
|
self.log('Powered on %s' % self.instance)
|
|
except exceptions.Conflict as e:
|
|
# This can happen if we get two requests to start a server in
|
|
# short succession. The instance may then be in a powering-on
|
|
# state, which means it is invalid to start it again.
|
|
self.log('Ignoring exception: "%s"' % e)
|
|
else:
|
|
self.log('%s is already on.' % self.instance)
|
|
|
|
def power_reset(self):
|
|
"""Not implemented"""
|
|
print('WARNING: Received request for unimplemented action power_reset')
|
|
|
|
def power_shutdown(self):
|
|
"""Stop the managed instance"""
|
|
# should attempt a clean shutdown
|
|
self.target_status = 'SHUTOFF'
|
|
self.novaclient.servers.stop(self.instance)
|
|
self.log('Politely shut down %s' % self.instance)
|
|
|
|
def log(self, *msg):
|
|
"""Helper function that prints msg and flushes stdout"""
|
|
print(' '.join(msg))
|
|
sys.stdout.flush()
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(
|
|
prog='openstackbmc',
|
|
description='Virtual BMC for controlling OpenStack instance',
|
|
)
|
|
parser.add_argument('--bmcuser',
|
|
dest='bmcuser',
|
|
default=os.environ.get('BMC_USER', 'admin'),
|
|
help='Username to use for virtual BMC, defaults to '
|
|
'admin')
|
|
parser.add_argument('--bmcpass',
|
|
dest='bmcpass',
|
|
default=os.environ.get('BMC_PASSWORD', 'password'),
|
|
help='Password to use for virtual BMC, defaults to '
|
|
'password')
|
|
parser.add_argument('--port',
|
|
dest='port',
|
|
type=int,
|
|
default=os.environ.get('BMC_PORT', 623),
|
|
help='Port to listen on; defaults to 623')
|
|
parser.add_argument('--address',
|
|
dest='address',
|
|
default=os.environ.get('BMC_ADDRESS', '::'),
|
|
help='Address to bind to; defaults to ::')
|
|
parser.add_argument('--instance',
|
|
dest='instance',
|
|
default=os.environ.get('INSTANCE_ID'),
|
|
help='The uuid or name of the OpenStack instance '
|
|
'to manage')
|
|
parser.add_argument('--cache-status',
|
|
dest='cache_status',
|
|
default=False,
|
|
action='store_true',
|
|
help='Cache the status of the managed instance. This '
|
|
'can reduce load on the host cloud, but if the '
|
|
'instance status is changed outside the BMC then '
|
|
'it may become out of sync.')
|
|
parser.add_argument('--os-cloud',
|
|
dest='os_cloud',
|
|
default=os.environ.get('OS_CLOUD'),
|
|
help='Use the specified cloud from clouds.yaml. '
|
|
'Defaults to the OS_CLOUD environment variable.')
|
|
args = parser.parse_args()
|
|
# Default to ipv6 format, but if we get an ipv4 address passed in use the
|
|
# appropriate format for pyghmi to listen on it.
|
|
addr_format = '%s'
|
|
if ':' not in args.address:
|
|
addr_format = '::ffff:%s'
|
|
mybmc = OpenStackBmc({args.bmcuser: args.bmcpass}, port=args.port,
|
|
address=addr_format % args.address,
|
|
instance=args.instance,
|
|
cache_status=args.cache_status,
|
|
os_cloud=args.os_cloud)
|
|
mybmc.listen()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|