openstack ice版文档horizon整理（页面resize）

问题导读
1、你如何理解所有页面的url链接都由urls.py处理？
2、如何获取初始化数据？
3、拼接一个url地址，代码是如何实现的？





系统整体页面：



代码结构：


horizon采用django框架编写（django是一个强大的mvc 框架。具体参考djangobook中文版 http://djangobook.py3k.cn/2.0/。）


左侧面板布局：


代码：

vim /usr/share/openstack-dashboard/openstack_dashboard/dashboards/admin/dashboard.py
复制代码

实例列表布局：

 vim /usr/share/openstack-dashboard/openstack_dashboard/dashboards/project/instances/tables.py
复制代码

上述三个按钮在table_actions中定义。



上述按钮在row_actions中定义。

第一部分：openstack_dashboard调用流程
接下来以resize instance 为例：



重点关注下图url链接：



1、urls.py层代码分析：

所有页面的url链接都由urls.py处理：

vim /usr/share/openstack-dashboard/openstack_dashboard/dashboards/project/instances/urls.py
复制代码

找到risize对应的url行。调用views.ResizeView.as_view().


2、views.py层代码分析详解--跟进到views层的ResizeView：

#说明resize功能使用workflow工作，下一步详解，请参考：workflow-1.1
workflow_class = project_workflows.ResizeInstance

#执行成功跳转到horizon:project:instances:index链接文件：下一步详解，请参考：模板页面-1.1
success_url = reverse_lazy("horizon:project:instances:index")
复制代码

#这个函数返回的值给context这个字典，这个字典里的值可以在html中取到
    @memoized.memoized_method
    def get_object(self, *args, **kwargs):
        instance_id = self.kwargs['instance_id']
        try:#根据实例id获取实例，下一步详解，下一步api调用流程请参考：“horizon中实例resize的API调用步骤详解“（与之类似）。
            instance = api.nova.server_get(self.request, instance_id)
            flavor_id = instance.flavor['id']
            flavors = self.get_flavors()
            if flavor_id in flavors:
                instance.flavor_name = flavors[flavor_id].name
            else:
                flavor = api.nova.flavor_get(self.request, flavor_id)
                instance.flavor_name = flavor.name
        except Exception:
            redirect = reverse("horizon:project:instances:index")
            msg = _('Unable to retrieve instance details.')
            exceptions.handle(self.request, msg, redirect=redirect)
        return instance
复制代码

#这个函数主要用来填充context字典，该字典可以和对应的html模板传参
    def get_context_data(self, **kwargs):
        context = super(ResizeView, self).get_context_data(**kwargs)
        context["instance_id"] = self.kwargs['instance_id']
        return context
复制代码

#获取flavors list
    @memoized.memoized_method
    def get_flavors(self, *args, **kwargs):
        try:
             #获取数据库中已存在的flavors，下一步api调用流程请参考：“horizon中实例resize的API调用步骤详解“（与之类似）。
            flavors = api.nova.flavor_list(self.request)
            return SortedDict((str(flavor.id), flavor) for flavor in flavors)
        except Exception:
            redirect = reverse("horizon:project:instances:index")
            exceptions.handle(self.request,
                _('Unable to retrieve flavors.'), redirect=redirect)
复制代码

#获取初始化数据，为对应的表单forms.py提供数据。（譬如下拉框数据如下图1。）
    def get_initial(self):
        initial = super(ResizeView, self).get_initial()
        _object = self.get_object()
        if _object:
            initial.update({'instance_id': self.kwargs['instance_id'],
                'name': getattr(_object, 'name', None),
                'old_flavor_id': _object.flavor['id'],
                'old_flavor_name': getattr(_object, 'flavor_name', ''),
                'flavors': self.get_flavors()}) #此处调用上处get_flavors函数
        return initial
复制代码

图1：



1、详解resize功能的workflow机制：

class ResizeView类中：workflow_class = project_workflows.ResizeInstance
vim /usr/share/openstack-dashboard/openstack_dashboard/dashboards/project/instances/workflows/resize_instance.py
复制代码

#成功与失败的弹出消息及成功之后的跳转url地址。
success_message = _('Scheduled resize of instance "%s".')
failure_message = _('Unable to resize instance "%s".') 
 success_url = "horizon:project:instances:index"

#完成resize工作流两个步骤：（如下图2）
default_steps = (SetFlavorChoice, create_instance.SetAdvanced)

#格式化状态消息输出
    def format_status_message(self, message):
        return message % self.context.get('name', 'unknown instance')
#完成resize工作流两个步骤：（如下图2）
    @sensitive_variables('context')
    def handle(self, request, context):
#从views.py层中的context字典获取数据
        instance_id = context.get('instance_id', None) 
        flavor = context.get('flavor', None)
        disk_config = context.get('disk_config', None)
        try: #页面点击确认resize按钮，调用api resize 实例。本步骤将重点分析。下一步详情，请参考horizon中实例resize的API调用步骤详解：
            api.nova.server_resize(request, instance_id, flavor, disk_config)
            return True
        except Exception:
            exceptions.handle(request)
            return False
复制代码

图2：



模板页面-1.1:
模板页面文件位置：

vim /usr/share/openstack-dashboard/openstack_dashboard/dashboards/project/instances/templates/instances/index.html
复制代码

其中%%代表要替换掉的变量（若有疑问自行参考djangobook文档）。
table.render：表示将model层的数据渲染到页面。

horizon中实例resize的API调用步骤详解：
接着上述workflow中resize

api.nova.server_resize(request, instance_id, flavor, disk_config)
复制代码

根据import原则找到api文件：

vim /usr/share/openstack-dashboard/openstack_dashboard/api/__init__.py
复制代码

此处将base、ceilometer、keystone等 都导入进来了。
跟踪到nova.api代码中：找到server_resize方法：

def server_resize(request, instance_id, flavor, disk_config=None, **kwargs):
    novaclient(request).servers.resize(instance_id, flavor,
                                       disk_config, **kwargs)
复制代码

#拼装client，组装url参数（包括keystone的token，以及调用v1_1、还是v3版本的novaclient参数等等）
def novaclient(request):
    insecure = getattr(settings, 'OPENSTACK_SSL_NO_VERIFY', False)
    cacert = getattr(settings, 'OPENSTACK_SSL_CACERT', None)
    LOG.debug('novaclient connection created using token "%s" and url "%s"' %
              (request.user.token.id, base.url_for(request, 'compute')))
#根据返回的c知道接下来调用的是novaclient代码：因此上述方法server_resize调用novaclient中server.py中的resize方法
复制代码

下述流程则参考以下的novaclientAPI调用流程。

    c = nova_client.Client(request.user.username,
                           request.user.token.id,
                           project_id=request.user.tenant_id,
                           auth_url=base.url_for(request, 'compute'),
                           insecure=insecure,
                           cacert=cacert,
                           http_log_debug=settings.DEBUG)
    c.client.auth_token = request.user.token.id
    c.client.management_url = base.url_for(request, 'compute')
    return c
复制代码

第二部分：novaclientAPI调用流程
从dashboard代码入口开始：

def server_resize(request, instance_id, flavor, disk_config=None, **kwargs):
    novaclient(request).servers.resize(instance_id, flavor,
                                       disk_config, **kwargs)
复制代码

下图为novaclient的代码结构：
接着调用novaclient模块中v1_1里面的services.py文件resize方法。


manage里面的resize方法：




调用action方法：



#下面两句代码拼接一个url地址

url = '/servers/%s/action' % base.getid(server)
        return self.api.client.post(url, body=body)
#发送url，通过wsgi调用nova代码。
复制代码

分析的不错，适合初学者，不过，里面也有几处错误：
下图为novaclient的代码结构：
接着调用novaclient模块中v1_1里面的services.py文件resize方法。（这里图片上明显是servers.py文件，后面的图片描述也错了）