From 2bcdb2057188a1a1bd1731ff713631e8a30e4f20 Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Mon, 10 Jun 2013 21:18:37 -0400 Subject: Add rpc client side version control. This is a first pass at client side version control for rpc. It allows you to configure a max version of messages that clients are allowed to send. You can find one example of how clients need to adapt in the conductor rpcapi. All other changes in rpc apis since the grizzly release are not applicable to this. Some future improvements to this could be reporting the versions supported by running services and having that be discoverable via the API. We could also consider allow setting these client side version caps via the API. For now, recommended values for these config options while attempting a rolling upgrade will just have to be documented. The config options allow specifying specific rpc api version numbers if desired, but an alias of 'grizzly' is also supported. So typically at the start of a rolling upgrade you'd have: [upgrade_levels] compute=grizzly conductor=grizzly scheduler=grizzly ... etc ... And as you update all instances of a service, you would remove that bit from your configuration across the deployment using your config management system of choice. DocImpact Implements blueprint rpc-version-control. Change-Id: I2c0fd6dd7484c87823846d7c31d6525d93cd1b43 --- nova/consoleauth/rpcapi.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'nova/consoleauth') diff --git a/nova/consoleauth/rpcapi.py b/nova/consoleauth/rpcapi.py index 62aeab8da..ffc1a3de4 100644 --- a/nova/consoleauth/rpcapi.py +++ b/nova/consoleauth/rpcapi.py @@ -24,6 +24,11 @@ import nova.openstack.common.rpc.proxy CONF = cfg.CONF +rpcapi_cap_opt = cfg.StrOpt('consoleauth', + default=None, + help='Set a version cap for messages sent to consoleauth services') +CONF.register_opt(rpcapi_cap_opt, 'upgrade_levels') + class ConsoleAuthAPI(nova.openstack.common.rpc.proxy.RpcProxy): '''Client side of the consoleauth rpc API. @@ -34,6 +39,10 @@ class ConsoleAuthAPI(nova.openstack.common.rpc.proxy.RpcProxy): 1.1 - Added get_backdoor_port() 1.2 - Added instance_uuid to authorize_console, and delete_tokens_for_instance + + ... Grizzly supports message version 1.2. So, any changes to existing + methods in 2.x after that point should be done such that they can + handle the version_cap being set to 1.2. ''' # @@ -46,10 +55,17 @@ class ConsoleAuthAPI(nova.openstack.common.rpc.proxy.RpcProxy): # BASE_RPC_API_VERSION = '1.0' + VERSION_ALIASES = { + 'grizzly': '1.2', + } + def __init__(self): + version_cap = self.VERSION_ALIASES.get(CONF.upgrade_levels.consoleauth, + CONF.upgrade_levels.consoleauth) super(ConsoleAuthAPI, self).__init__( topic=CONF.consoleauth_topic, - default_version=self.BASE_RPC_API_VERSION) + default_version=self.BASE_RPC_API_VERSION, + version_cap=version_cap) def authorize_console(self, ctxt, token, console_type, host, port, internal_access_path, instance_uuid=None): -- cgit