[Openstack-devel] Bug#708658: [RFR] templates://cinder/{cinder-common.templates, cinder-api.templates}

Christian PERRIER bubulle at debian.org
Sat Jun 1 05:28:13 UTC 2013


Please find, for review, the debconf templates for the cinder source package.

Please note that similar templates reviewed for other
Openstack-related packages will not be recommented here.

This review will last from Saturday, June 01, 2013 to Tuesday, June 11, 2013.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.

Rationale:
--- cinder.old/debian/cinder-common.templates	2013-05-17 11:01:17.385948883 +0300
+++ cinder/debian/cinder-common.templates	2013-05-24 12:03:00.498293991 +0300
@@ -1,7 +1,7 @@
 Template: cinder/start_services
 Type: boolean
 Default: true
-_Description: Start cinder services at boot?
+_Description: Start Cinder services at boot?
  Please choose whether you want to start Cinder services when the
  machine is booted up.

Standardize on capitalizing the software name.
 
@@ -9,44 +9,46 @@
 Type: boolean
 Default: false
 _Description: Set up a database for Cinder?
- No database has been set up for Cinder to use. If you want
- to set one up now, please make sure you have all needed
- information:
+ No database has been set up for Cinder to use. Before
+ continuing, you should make sure you have the following information:

Capitalize and small reformulation

  .
-  * the host name of the database server (which must allow TCP
-    connections from this machine);
-  * a username and password to access the database;
-  * the type of database management software you want to use.
+  * the type of database that you want to use;
+  * the database server host name (that server must allow TCP connections from this
+    machine);
+  * a user name and password to access the database.

Change the order of needed information to be more logical.

username-->user name


  .
- If you don't choose this option, no database will be set up and Cinder
- will use regular SQLite support.
+ If some of these requirements are missing, do not choose this option and run with
+ regular SQLite support.

I'm not user about "regular" being the right word here. I guess that
SQLite database is the default for the software, maybe.

  .
- You can change this setting later on by running "dpkg-reconfigure
- -plow cinder-common".
+ You can change this setting later on by running "dpkg-reconfigure -plow
+ cinder".

Ooops, that's an error of mine, I guess. I'll revert that..:-)
 
 Template: cinder/auth-host
 Type: string
 Default: 127.0.0.1
-_Description: Auth server hostname:
- Please specify the URL of your Cinder authentication server. Typically 
- this is also the URL of your OpenStack Identity Service (Keystone).
+_Description: Authentication server hostname:
+ Please specify the hostname of the authentication server. Typically
+ this is also the hostname of the OpenStack Identity Service (Keystone).

Please correct me if I'm mistaken but what's expected here is not a
URL, but a hostname or an IP address.
 
-Template: cinder/admin-tenant-name
+Template: glance/admin-tenant-name
 Type: string
 Default: admin
-_Description: Auth server tenant name:
+_Description: Authentication server tenant name:
+ Please specify the authentication server tenant name.

Frankly speaking, I have no idea what a "tenant" is and didn't change
that but, maybe some explanation could help. I guess that people
involved in Openstack mysteries know about that but debconf templates
should avoid jargon as much as possible.

Also add a long description. We always try to have one.
 
 Template: cinder/admin-user
 Type: string
 Default: admin
-_Description: Auth server username:
+_Description: Authentication server user name:
+ Please specify the username to use with the authentication server.
 
 Template: cinder/admin-password
 Type: password
-_Description: Auth server password:
+_Description: Authentication server password:
+ Please specify the password to use with the authentication server.


In both these, also add a long description.
 
 Template: cinder/volume_group
 Type: string
 _Description: Cinder volume group:
- Please specify the name of the LVM volume group (vg) on which Cinder
+ Please specify the name of the LVM volume group on which Cinder
  will create partitions.

I don't really see the need to repeat the VG acronym in
parenthesis. If that has to be kept, it should at least be using capitals.

--- cinder.old/debian/cinder-api.templates	2013-05-17 11:01:17.385948883 +0300
+++ cinder/debian/cinder-api.templates	2013-05-24 11:32:18.281774784
+0300

These changes are similar to those in Ceilometer.

@@ -1,31 +1,30 @@
 Template: cinder/register-endpoint
 Type: boolean
 Default: false
-_Description: Register Cinder in the keystone endpoint catalog?
- Each Openstack services (each API) should be registered in order to be
+_Description: Register Cinder in the Keystone endpoint catalog?
+ Each Openstack service (each API) should be registered in order to be
  accessible. This is done using "keystone service-create" and "keystone
- endpoint-create". Select if you want to run these commands now.
+ endpoint-create". This can be done automatically now.
  .
- Note that you will need to have an up and running keystone server on which to
- connect using the Keystone auth token.
+ Note that you will need to have an up and running Keystone server on which to
+ connect using the Keystone authentication token.
 
 Template: cinder/keystone-ip
 Type: string
-_Description: Keystone IP address:
- Enter the IP address of your keystone server, so that cinder-api can
+_Description: Keystone server IP address:
+ Please enter the IP address of the Keystone server, so that cinder-api can
  contact Keystone to do the Cinder service and endpoint creation.
 
 Template: cinder/keystone-auth-token
 Type: password
-_Description: Keystone Auth Token:
- To configure its endpoint in Keystone, cinder-api needs the Keystone auth
- token.
+_Description: Keystone authentication token:
+ To configure its endpoint in Keystone, cinder-api needs the Keystone
+ authentication token.
 
 Template: cinder/endpoint-ip
 Type: string
 _Description: Cinder endpoint IP address:
- Enter the IP address that will be used to contact Cinder (eg: the Cinder
- endpoint IP address).
+ Please enter the IP address that will be used to contact Cinder.
  .
  This IP address should be accessible from the clients that will use this
  service, so if you are installing a public cloud, this should be a public

-- 


-------------- next part --------------
Template: cinder/start_services
Type: boolean
Default: true
_Description: Start Cinder services at boot?
 Please choose whether you want to start Cinder services when the
 machine is booted up.

Template: cinder/configure_db
Type: boolean
Default: false
_Description: Set up a database for Cinder?
 No database has been set up for Cinder to use. Before
 continuing, you should make sure you have the following information:
 .
  * the type of database that you want to use;
  * the database server host name (that server must allow TCP connections from this
    machine);
  * a user name and password to access the database.
 .
 If some of these requirements are missing, do not choose this option and run with
 regular SQLite support.
 .
 You can change this setting later on by running "dpkg-reconfigure -plow
 cinder".

Template: cinder/auth-host
Type: string
Default: 127.0.0.1
_Description: Authentication server hostname:
 Please specify the hostname of the authentication server. Typically
 this is also the hostname of the OpenStack Identity Service (Keystone).

Template: glance/admin-tenant-name
Type: string
Default: admin
_Description: Authentication server tenant name:
 Please specify the authentication server tenant name.

Template: cinder/admin-user
Type: string
Default: admin
_Description: Authentication server user name:
 Please specify the username to use with the authentication server.

Template: cinder/admin-password
Type: password
_Description: Authentication server password:
 Please specify the password to use with the authentication server.

Template: cinder/volume_group
Type: string
_Description: Cinder volume group:
 Please specify the name of the LVM volume group on which Cinder
 will create partitions.
-------------- next part --------------
Template: cinder/register-endpoint
Type: boolean
Default: false
_Description: Register Cinder in the Keystone endpoint catalog?
 Each Openstack service (each API) should be registered in order to be
 accessible. This is done using "keystone service-create" and "keystone
 endpoint-create". This can be done automatically now.
 .
 Note that you will need to have an up and running Keystone server on which to
 connect using the Keystone authentication token.

Template: cinder/keystone-ip
Type: string
_Description: Keystone server IP address:
 Please enter the IP address of the Keystone server, so that cinder-api can
 contact Keystone to do the Cinder service and endpoint creation.

Template: cinder/keystone-auth-token
Type: password
_Description: Keystone authentication token:
 To configure its endpoint in Keystone, cinder-api needs the Keystone
 authentication token.

Template: cinder/endpoint-ip
Type: string
_Description: Cinder endpoint IP address:
 Please enter the IP address that will be used to contact Cinder.
 .
 This IP address should be accessible from the clients that will use this
 service, so if you are installing a public cloud, this should be a public
 IP address.

Template: cinder/region-name
Type: string
Default: regionOne
_Description: Name of the region to register:
 Openstack can be used using availability zones, with each region representing
 a location. Please enter the zone that you wish to use when registering the
 endpoint.
-------------- next part --------------
--- cinder.old/debian/cinder-common.templates	2013-05-17 11:01:17.385948883 +0300
+++ cinder/debian/cinder-common.templates	2013-05-24 12:03:00.498293991 +0300
@@ -1,7 +1,7 @@
 Template: cinder/start_services
 Type: boolean
 Default: true
-_Description: Start cinder services at boot?
+_Description: Start Cinder services at boot?
  Please choose whether you want to start Cinder services when the
  machine is booted up.
 
@@ -9,44 +9,46 @@
 Type: boolean
 Default: false
 _Description: Set up a database for Cinder?
- No database has been set up for Cinder to use. If you want
- to set one up now, please make sure you have all needed
- information:
+ No database has been set up for Cinder to use. Before
+ continuing, you should make sure you have the following information:
  .
-  * the host name of the database server (which must allow TCP
-    connections from this machine);
-  * a username and password to access the database;
-  * the type of database management software you want to use.
+  * the type of database that you want to use;
+  * the database server host name (that server must allow TCP connections from this
+    machine);
+  * a user name and password to access the database.
  .
- If you don't choose this option, no database will be set up and Cinder
- will use regular SQLite support.
+ If some of these requirements are missing, do not choose this option and run with
+ regular SQLite support.
  .
- You can change this setting later on by running "dpkg-reconfigure
- -plow cinder-common".
+ You can change this setting later on by running "dpkg-reconfigure -plow
+ cinder".
 
 Template: cinder/auth-host
 Type: string
 Default: 127.0.0.1
-_Description: Auth server hostname:
- Please specify the URL of your Cinder authentication server. Typically 
- this is also the URL of your OpenStack Identity Service (Keystone).
+_Description: Authentication server hostname:
+ Please specify the hostname of the authentication server. Typically
+ this is also the hostname of the OpenStack Identity Service (Keystone).
 
-Template: cinder/admin-tenant-name
+Template: glance/admin-tenant-name
 Type: string
 Default: admin
-_Description: Auth server tenant name:
+_Description: Authentication server tenant name:
+ Please specify the authentication server tenant name.
 
 Template: cinder/admin-user
 Type: string
 Default: admin
-_Description: Auth server username:
+_Description: Authentication server user name:
+ Please specify the username to use with the authentication server.
 
 Template: cinder/admin-password
 Type: password
-_Description: Auth server password:
+_Description: Authentication server password:
+ Please specify the password to use with the authentication server.
 
 Template: cinder/volume_group
 Type: string
 _Description: Cinder volume group:
- Please specify the name of the LVM volume group (vg) on which Cinder
+ Please specify the name of the LVM volume group on which Cinder
  will create partitions.
--- cinder.old/debian/cinder-api.templates	2013-05-17 11:01:17.385948883 +0300
+++ cinder/debian/cinder-api.templates	2013-05-24 11:32:18.281774784 +0300
@@ -1,31 +1,30 @@
 Template: cinder/register-endpoint
 Type: boolean
 Default: false
-_Description: Register Cinder in the keystone endpoint catalog?
- Each Openstack services (each API) should be registered in order to be
+_Description: Register Cinder in the Keystone endpoint catalog?
+ Each Openstack service (each API) should be registered in order to be
  accessible. This is done using "keystone service-create" and "keystone
- endpoint-create". Select if you want to run these commands now.
+ endpoint-create". This can be done automatically now.
  .
- Note that you will need to have an up and running keystone server on which to
- connect using the Keystone auth token.
+ Note that you will need to have an up and running Keystone server on which to
+ connect using the Keystone authentication token.
 
 Template: cinder/keystone-ip
 Type: string
-_Description: Keystone IP address:
- Enter the IP address of your keystone server, so that cinder-api can
+_Description: Keystone server IP address:
+ Please enter the IP address of the Keystone server, so that cinder-api can
  contact Keystone to do the Cinder service and endpoint creation.
 
 Template: cinder/keystone-auth-token
 Type: password
-_Description: Keystone Auth Token:
- To configure its endpoint in Keystone, cinder-api needs the Keystone auth
- token.
+_Description: Keystone authentication token:
+ To configure its endpoint in Keystone, cinder-api needs the Keystone
+ authentication token.
 
 Template: cinder/endpoint-ip
 Type: string
 _Description: Cinder endpoint IP address:
- Enter the IP address that will be used to contact Cinder (eg: the Cinder
- endpoint IP address).
+ Please enter the IP address that will be used to contact Cinder.
  .
  This IP address should be accessible from the clients that will use this
  service, so if you are installing a public cloud, this should be a public
-------------- next part --------------
Source: cinder
Section: net
Priority: extra
Maintainer: PKG OpenStack <openstack-devel at lists.alioth.debian.org>
Uploaders: Loic Dachary (OuoU) <loic at debian.org>,
           Julien Danjou <acid at debian.org>,
           Thomas Goirand <zigo at debian.org>,
           Ghe Rivero <ghe.rivero at stackops.com>,
           Mehdi Abaakouk <sileht at sileht.net>
Build-Depends: debhelper (>= 8.0.0),
 po-debconf,
 python-all (>= 2.6.6-3~),
 openstack-pkg-tools
Build-Depends-Indep: pep8 (>= 1.3.3),
 pylint,
 python-amqplib,
 python-anyjson,
 python-argparse,
 python-babel,
 python-cheetah,
 python-coverage,
 python-daemon,
 python-eventlet (>= 0.9.17),
 python-glanceclient (>= 1:0.5.0),
 python-greenlet,
 python-hp3parclient,
 python-iso8601,
 python-keystoneclient (>= 1:0.2.0),
 python-kombu,
 python-lockfile,
 python-lxml,
 python-migrate,
 python-mock,
 python-mox,
 python-mysqldb,
 python-netaddr,
 python-nose,
 python-oslo.config,
 python-paramiko,
 python-paste,
 python-pastedeploy,
 python-psycopg2,
 python-routes,
 python-rtslib,
 python-setuptools,
 python-setuptools-git,
 python-sphinx,
 python-sqlalchemy,
 python-stevedore (>= 0.7),
 python-suds,
 python-swiftclient,
 python-webob (>= 1.2.3),
Standards-Version: 3.9.4
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/cinder.git;a=summary
Vcs-Git: git://anonscm.debian.org/openstack/cinder.git
Homepage: http://cinder.openstack.org/

Package: python-cinder
Section: python
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends: ${python:Depends},
 python-amqplib,
 python-anyjson,
 python-argparse,
 python-babel,
 python-cheetah,
 python-daemon,
 python-eventlet (>= 0.9.17),
 python-glanceclient (>= 1:0.5.0),
 python-greenlet,
 python-iso8601,
 python-keystoneclient (>= 1:0.2.0),
 python-kombu,
 python-lockfile,
 python-lxml,
 python-migrate,
 python-mysqldb,
 python-netaddr,
 python-oslo.config,
 python-paramiko,
 python-paste,
 python-pastedeploy,
 python-routes,
 python-rtslib,
 python-sqlalchemy,
 python-stevedore (>= 0.7),
 python-suds,
 python-swiftclient,
 python-webob (>= 1.2.3),
 ${misc:Depends}
Description: OpenStack block storage system - Python libraries
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains the Python libraries that are parts of Cinder.

Package: cinder-common
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends:
 adduser,
 python-cinder (= ${binary:Version}),
 debconf,
 dbconfig-common,
 ${misc:Depends},
 ${python:Depends}
Provides: ${python:Provides}
Description: OpenStack block storage system - common files
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains common files and configuration that are
 needed by all the daemon packages of Cinder.

Package: cinder-api
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends: adduser, ${ostack-lsb-base}, debconf, cinder-common (= ${binary:Version}), ${python:Depends}, ${misc:Depends}, python-keystoneclient
Description: OpenStack block storage system - API server
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains the API server on which client will connect.

Package: cinder-volume
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends:
 adduser,
 ${ostack-lsb-base},
 cinder-common (= ${binary:Version}),
 lvm2,
 tgt,
 qemu-utils,
 ${misc:Depends},
 ${python:Depends}
Suggests: ceph-common
Description: OpenStack block storage system - Volume server
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains the Volume server which will actually do the storage.

Package: cinder-scheduler
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends: ${ostack-lsb-base}, cinder-common (= ${binary:Version}), ${python:Depends}, ${misc:Depends}
Description: OpenStack block storage system - Scheduler server
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains the Scheduler server.

Package: cinder-backup
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends: adduser, ${ostack-lsb-base}, cinder-common (= ${binary:Version}), ${misc:Depends}, ${python:Depends}
Description: OpenStack block storage system - Backup server
 Cinder is a block storage as service system for the Openstack cloud computing
 suite. It re-implements the features of nova-volume, which it directly
 replaces.
 .
 Cinder use LVM partitions of your volume servers in order to provide iSCSI
 permanent block storage devices for your virtual machines running on Nova.
 .
 This package contains the Cinder backup service.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/openstack-devel/attachments/20130601/c210c2d7/attachment.pgp>


More information about the Openstack-devel mailing list