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

[Justin B Rye]

Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
[...]
> Template: cinder/configure_db
[...]
> +  * 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

In fact I argue the reverse.  With things like "host name" or "pass
phrase" we can afford to use the newbie-friendly un-fused versions
that don't look like specialist jargon coinages.  But here the problem
is that we want readers to be aware that we *do* mean the jargon term,
not the sense obtained by putting together two normal English words
("root" and "raj" are usernames; "Professor Robert Alan Jessop" and
"Rajiv Subramian" are user names).  This ambiguity doesn't matter much
when it's right before the words "and password", but I'll make it
"hostname" and "username" anyway for consistency between templates.

>  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).
> 
> Please correct me if I'm mistaken but what's expected here is not a
> URL, but a hostname or an IP address.

That's certainly how I interpreted this.  It's possible we should be
asking for the "name or address", but asking for the hostname and
presenting the localhost IP address as a fallback seems intelligible
enough.
  
> -Template: cinder/admin-tenant-name
> +Template: glance/admin-tenant-name

Wait, what?  Typo?

[...]
>  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.

s/ name/name/.  Otherwise, that looks like everything...

> Package: python-cinder
[...]
> 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.

It's a block storage?  And it's as service system?  This again would
be clearer with more jargon, as:
   Cinder is a block Storage-as-a-Service system
and isn't it:                                          OpenStack ...?

And now that I've started I might as well capitalise "Nova".

>  .
>  Cinder use LVM partitions of your volume servers in order to provide iSCSI

Singular agreement: "uses".

>  permanent block storage devices for your virtual machines running on Nova.
>  .
>  This package contains the Python libraries that are parts of Cinder.

Idiomatically, even these multiple libraries only form "part" of Cinder.
 
> Package: cinder-common
[...]

Ditto, but nothing new.
 
> Package: cinder-api
[...]
>  This package contains the API server on which client will connect.

You mean "clients".  Mind you, I still think it's weird that
cloudmongers want us to make client connections on an Application
Programming Interface...
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
A non-text attachment was scrubbed...
Name: jbr.diff
Type: text/x-diff
Size: 10574 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/openstack-devel/attachments/20130601/c2d7f504/attachment.diff>
-------------- 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 --------------
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 hostname (that server must allow TCP connections from this
    machine);
  * a username 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: cinder/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 username:
 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 --------------
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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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 part 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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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 clients 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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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-a-Service system for the OpenStack cloud
 computing suite. It re-implements the features of Nova-volume, which it
 directly replaces.
 .
 Cinder uses 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.