From 3dc060db63eb97c017746c88dcba7a805452e543 Mon Sep 17 00:00:00 2001 From: ChiZhang Date: Wed, 7 Jan 2015 17:42:38 +0800 Subject: [PATCH] refresh README.md and install script Change-Id: I547111874c42e41599eb0b031fc68b3eb5897c40 --- cinderproxy/README.md | 72 +++++++++++++++---- cinderproxy/installation/install.sh | 2 +- .../cinder/timestamp-query-patch/README.md | 2 +- 3 files changed, 59 insertions(+), 17 deletions(-) diff --git a/cinderproxy/README.md b/cinderproxy/README.md index 189743d..72884b2 100644 --- a/cinderproxy/README.md +++ b/cinderproxy/README.md @@ -8,18 +8,18 @@ Openstack Cinder Proxy Key modules ----------- -* The new cinder proxy module cinder_proxy,which treats cascaded Cinder as its cinder volume, convert the internal request message from the message bus to restful API calling to cascaded Cinder: +* The new Cinder-Proxy module cinder_proxy,which treats cascaded Cinder as its cinder volume, convert the internal request message from the message bus to restful API calling to cascaded Cinder: cinder/volume/cinder_proxy.py Requirements ------------ -* openstack-cinder-volume-2014.1-14.1 has been installed +* openstack-cinder-volume-juno has been installed Installation ------------ -We provide two ways to install the cinder proxy code. In this section, we will guide you through installing the cinder proxy with the minimum configuration. +We provide two ways to install the Cinder-Proxy code. In this section, we will guide you through installing the Cinder-Proxy with the minimum configuration. * **Note:** @@ -45,21 +45,23 @@ We provide two ways to install the cinder proxy code. In this section, we will g volume_sync_interval=5 voltype_sync_interval=3600 pagination_limit=50 + volume_sync_timestamp_flag=True cinder_tenant_name=$CASCADED_ADMIN_TENANT cinder_tenant_id=$CASCADED_ADMIN_ID cinder_username=$CASCADED_ADMIN_NAME cinder_password=$CASCADED_ADMIN_PASSWORD keystone_auth_url=http://$GLOBAL_KEYSTONE_IP:5000/v2.0/ + glance_cascading_flag=True cascading_glance_url=$CASCADING_GLANCE cascaded_glance_url=http://$CASCADED_GLANCE cascaded_available_zone=$CASCADED_AVAILABLE_ZONE cascaded_region_name=$CASCADED_REGION_NAME ``` - - Restart the cinder proxy. + - Restart the Cinder-Proxy. ```service openstack-cinder-volume restart``` - - Done. The cinder proxy should be working with a demo configuration. + - Done. The Cinder-Proxy should be working with a demo configuration. * **Automatic Installation** @@ -72,7 +74,7 @@ We provide two ways to install the cinder proxy code. In this section, we will g ``` (replace the $... with actual directory name.) - - Done. The installation code should setup the cinder proxy with the minimum configuration below. Check the "Configurations" section for a full configuration guide. + - Done. The installation code should setup the Cinder-Proxy with the minimum configuration below. Check the "Configurations" section for a full configuration guide. ``` [DEFAULT] ... @@ -83,11 +85,13 @@ We provide two ways to install the cinder proxy code. In this section, we will g volume_sync_interval=5 voltype_sync_interval=3600 pagination_limit=50 + volume_sync_timestamp_flag=True cinder_tenant_name=$CASCADED_ADMIN_TENANT cinder_tenant_id=$CASCADED_ADMIN_ID cinder_username=$CASCADED_ADMIN_NAME cinder_password=$CASCADED_ADMIN_PASSWORD keystone_auth_url=http://$GLOBAL_KEYSTONE_IP:5000/v2.0/ + glance_cascading_flag=True cascading_glance_url=$CASCADING_GLANCE cascaded_glance_url=http://$CASCADED_GLANCE cascaded_available_zone=$CASCADED_AVAILABLE_ZONE @@ -109,7 +113,7 @@ We provide two ways to install the cinder proxy code. In this section, we will g Configurations -------------- -* This is a (default) configuration sample for the cinder proxy. Please add/modify these options in /etc/cinder/cinder.conf. +* This is a (default) configuration sample for the Cinder-Proxy. Please add/modify these options in /etc/cinder/cinder.conf. * Note: - Please carefully make sure that options in the configuration file are not duplicated. If an option name already exists, modify its value instead of adding a new one of the same name. - Please refer to the 'Configuration Details' section below for proper configuration and usage of costs and constraints. @@ -123,19 +127,54 @@ Configurations #Options defined in cinder.volume.manager # -# Default driver to use for the cinder proxy (string value) +# Default driver to use for the Cinder-Proxy (string value) volume_manager=cinder.volume.cinder_proxy.CinderProxy +#The period time used by Cinder-Proxy to determine how often volume status +#is synchronized between cascading and cascaded cinder (integer value, default 5) +volume_sync_interval=5 -#The cascading level keystone component service url, by which the cinder proxy +#The period time used by Cinder-Proxy to control how often volume types +#is synchronized between cascading and cascaded cinder (integer value, default 3600) +voltype_sync_interval=3600 + +#The length of volume list used by Cinder-Proxy to control each pagination volume query +#for Cinder-Proxy between cascading and cascaded cinder (integer value, default 50) +pagination_limit=50 + +#The switch flag used by Cinder-Proxy to determine whether to use time-stamp when synchronize +#volume status.( boolean value, default true) +volume_sync_timestamp_flag=True + +#The cascaded level tenant name, which will be set as a parameter when cascaded cinder +#client is constructed by Cinder-Proxy +cinder_tenant_name=$CASCADED_ADMIN_TENANT + +#The cascaded level tenant id, which will be set as a parameter when cascaded cinder +#client is constructed by Cinder-Proxy +cinder_tenant_id=$CASCADED_ADMIN_ID + +#The cascaded level user name, which will be set as a parameter when cascaded cinder +#client is constructed by Cinder-Proxy +cinder_username=$CASCADED_ADMIN_NAME + +#The cascaded level user password, which will be set as a parameter when cascaded cinder +#client is constructed by Cinder-Proxy +cinder_password=$CASCADED_ADMIN_PASSWORD + +#The cascading level keystone component service url, by which the Cinder-Proxy #can access to cascading level keystone service keystone_auth_url=$keystone_auth_url -#The cascading level glance component service url, by which the cinder proxy +#The switch flag used by Cinder-Proxy to determine glance is used OpenStack-cascading solution. +#(boolean value, default true) +glance_cascading_flag=True + +#The cascading level glance component service url, by which the Cinder-Proxy #can access to cascading level glance service cascading_glance_url=$CASCADING_GLANCE -#The cascaded level glance component service url, by which the cinder proxy +#The cascaded level glance component service url, by which the Cinder-Proxy #can judge whether the cascading glance image has a location for this cascaded glance cascaded_glance_url=http://$CASCADED_GLANCE @@ -145,10 +184,13 @@ cascaded_region_name=$CASCADED_REGION_NAME #The cascaded level available zone name, which will be set as a parameter when #forward request to cascaded level cinder. Please pay attention to that value of -#cascaded_available_zone of cinder-proxy must be the same as storage_availability_zone in -#the cascaded level node. And cinder-proxy should be configured to the same storage_availability_zone. -#this configuration could be removed in the future to just use the cinder-proxy storage_availability_zone -#configuration item. but it is up to the admin to make sure the storage_availability_zone in cinder-proxy#and casacdede cinder keep the same value. +#cascaded_available_zone of Cinder-Proxy must be the same as storage_availability_zone in +#the cascaded level node. And Cinder-Proxy should be configured to the same storage_availability_zone. +#this configuration could be removed in the future to just use the Cinder-Proxy storage_availability_zone +#configuration item. but it is up to the admin to make sure the storage_availability_zone in Cinder-Proxy +#and cascaded cinder keep the same value. cascaded_available_zone=$CASCADED_AVAILABLE_ZONE + + diff --git a/cinderproxy/installation/install.sh b/cinderproxy/installation/install.sh index 7fabe03..014a34e 100644 --- a/cinderproxy/installation/install.sh +++ b/cinderproxy/installation/install.sh @@ -19,7 +19,7 @@ _CINDER_DIR="/usr/lib64/python2.6/site-packages/cinder" _CINDER_INSTALL_LOG="/var/log/cinder/cinder-proxy/installation/install.log" # please set the option list set in cinder configure file -_CINDER_CONF_OPTION=("volume_manager=cinder.volume.cinder_proxy.CinderProxy volume_sync_interval=5 voltype_sync_interval=3600 periodic_interval=5 cinder_tenant_name=admin cinder_tenant_id=1234 pagination_limit=50 cinder_username=admin cinder_password=1234 keystone_auth_url=http://10.67.148.210:5000/v2.0/ glance_cascading_flag=False cascading_glance_url=10.67.148.210:9292 cascaded_glance_url=http://10.67.148.201:9292 cascaded_cinder_url=http://10.67.148.201:8776/v2/%(project_id)s cascaded_region_name=Region_AZ1 cascaded_available_zone=AZ1") +_CINDER_CONF_OPTION=("volume_manager=cinder.volume.cinder_proxy.CinderProxy volume_sync_interval=5 voltype_sync_interval=3600 periodic_interval=5 volume_sync_timestamp_flag=True cinder_tenant_name=admin cinder_tenant_id=1234 pagination_limit=50 cinder_username=admin cinder_password=1234 keystone_auth_url=http://10.67.148.210:5000/v2.0/ glance_cascading_flag=False cascading_glance_url=10.67.148.210:9292 cascaded_glance_url=http://10.67.148.201:9292 cascaded_cinder_url=http://10.67.148.201:8776/v2/%(project_id)s cascaded_region_name=Region_AZ1 cascaded_available_zone=AZ1") # if you did not make changes to the installation files, # please do not edit the following directories. diff --git a/juno-patches/cinder/timestamp-query-patch/README.md b/juno-patches/cinder/timestamp-query-patch/README.md index 7413006..7c10313 100644 --- a/juno-patches/cinder/timestamp-query-patch/README.md +++ b/juno-patches/cinder/timestamp-query-patch/README.md @@ -39,7 +39,7 @@ We provide two ways to install the timestamp query patch code. In this section, - restart cinder api service - - Done. The cinder proxy should be working with a demo configuration. + - Done. The Cinder-Proxy should be working with a demo configuration. * **Automatic Installation**