Please find, for review, the debconf templates and packages descriptions for the slapos.tool.format source package.
This review will last from Monday, May 09, 2011 to Thursday, May 19, 2011.
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, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- slapos.tool.format.old/debian/templates 2011-05-03 22:14:20.004753417 +0200
+++ slapos.tool.format/debian/templates 2011-05-08 15:27:29.114401208 +0200
@@ -1,23 +1,24 @@
Template: slapformat/master_url
Type: string
-_Description: The HTTP or HTTPS URL where the master node can be reached:
+_Description: Master node URL:
Maybe we could add an extended description saying something like
Please enter the URL where the master node can be reached. This can
be either an HTTP or HTTPS URL.
.
If you use an HTTPS URL, you must put the
corresponding key and certificate respectively in
/etc/slapos/ssl/slapos.key and /etc/slapos/ssl/slapos.crt.
These files should be readable by the root user only.
And thus get rid of the note that follows.
Template: slapformat/master_url_with_ssl_note
Type: note
-_Description: Note about HTTPS master URL
- As you entered an HTTPS URL for the master node, you *must* put the
+_Description: Master node key and certificate mandatory
+ As you entered an HTTPS URL for the master node, you must put the
corresponding key and certificate respectively in
/etc/slapos/ssl/slapos.key and /etc/slapos/ssl/slapos.crt.
.
- Also, make sure that the key is only readable by root user!
+ These files should be readable by the root user only.
Template: slapformat/computer_id
Type: string
-_Description: ID to uniquely identifies this computer on the master:
+_Description: ID on the master:
+ Please enter a unique identifier for this computer on the master node.
Let's use an extended description
Template: slapformat/partition_amount
Type: string
-_Description: The number of partition available on this computer:
+_Description: Number of Computer Partitions on this computer:
A Computer Partition (CP) is an instance of a Software Release
(SR). You can now define how many instances will be available on this
computer.
I used case for CP as this seems to be how it's meant to be.
@@ -29,15 +30,14 @@
Template: slapformat/ipv4_local_network
Type: string
_Description: Local IPv4 network to be used for Computer Partitions:
- Each Computer Partition (CP) must a local IPv4 took from the network
- given here in CIDR notation.
+ Each Computer Partition (CP) must use specific IPv4 settings. Please
+ enter these settings here, in CIDR notation.
Maybe my rewrite doesn't make it clear this should be an IPv4
*network* address.
Template: slapformat/bridge_note
Type: note
-_Description: Note about network configuration
- Before actually using slapformat script, you *must* set up a bridge
- that will be used by the Computer Partitions and IPv6 must be
- enabled (in most cases, it is already enabled by default though).
+_Description: Network configuration note
+ Before using slapformat script, you must set up a network bridge
+ to be used by the Computer Partitions and enable IPv6.
.
- You can find examples of setting it up in
+ You can find more information in
/usr/share/doc/slapformat/README.Debian.
Tentative rewrite of this note...even though I consider it abusive..:-)
--- slapos.tool.format.old/debian/control 2011-05-03 22:14:20.004753417 +0200
+++ slapos.tool.format/debian/control 2011-05-08 15:31:37.687633717 +0200
@@ -21,10 +21,9 @@
bridge-utils,
uml-utilities
Breaks: ${python:Breaks}
-Description: Prepare a client for deploying a SaaS system with SLAPos
- Slapformat is supposed to be ran before Slapgrid in order to prepare
- a SLAPos client. At the end a report is generated and information are
- sent to configured SlapOS server.
+Description: utility to prepare SLAPos SaaS clients
Synopsis should not be a sentence
+ The Slapformat utility should be used before Slapgrid in order to prepare
+ SLAPos clients. It generates a preparation report and sends needed
+ information to the SlapOS server.
It's unclear to me whether this is the report that's sent to the server...
.
- SLAPos provides support for deploying a SaaS (Software as a Service)
- system.
+ SLAPos systems are SaaS (Software as a Service) solutions.
Simplified....
--
Template: slapformat/master_url Type: string _Description: Master node URL: Template: slapformat/master_url_with_ssl_note Type: note _Description: Master node key and certificate mandatory As you entered an HTTPS URL for the master node, you must put the corresponding key and certificate respectively in /etc/slapos/ssl/slapos.key and /etc/slapos/ssl/slapos.crt. . These files should be readable by the root user only. Template: slapformat/computer_id Type: string _Description: ID on the master: Please enter a unique identifier for this computer on the master node. Template: slapformat/partition_amount Type: string _Description: Number of Computer Partitions on this computer: A Computer Partition (CP) is an instance of a Software Release (SR). You can now define how many instances will be available on this computer. . Note that the Software Releases will be stored in /var/lib/slapos/software/, whereas the Computer Partition will be stored in /var/lib/slapos/instance/. Template: slapformat/ipv4_local_network Type: string _Description: Local IPv4 network to be used for Computer Partitions: Each Computer Partition (CP) must use specific IPv4 settings. Please enter these settings here, in CIDR notation. Template: slapformat/bridge_note Type: note _Description: Network configuration note Before using slapformat script, you must set up a network bridge to be used by the Computer Partitions and enable IPv6. . You can find more information in /usr/share/doc/slapformat/README.Debian.
--- slapos.tool.format.old/debian/templates 2011-05-03 22:14:20.004753417 +0200
+++ slapos.tool.format/debian/templates 2011-05-08 15:27:29.114401208 +0200
@@ -1,23 +1,24 @@
Template: slapformat/master_url
Type: string
-_Description: The HTTP or HTTPS URL where the master node can be reached:
+_Description: Master node URL:
Template: slapformat/master_url_with_ssl_note
Type: note
-_Description: Note about HTTPS master URL
- As you entered an HTTPS URL for the master node, you *must* put the
+_Description: Master node key and certificate mandatory
+ As you entered an HTTPS URL for the master node, you must put the
corresponding key and certificate respectively in
/etc/slapos/ssl/slapos.key and /etc/slapos/ssl/slapos.crt.
.
- Also, make sure that the key is only readable by root user!
+ These files should be readable by the root user only.
Template: slapformat/computer_id
Type: string
-_Description: ID to uniquely identifies this computer on the master:
+_Description: ID on the master:
+ Please enter a unique identifier for this computer on the master node.
Template: slapformat/partition_amount
Type: string
-_Description: The number of partition available on this computer:
+_Description: Number of Computer Partitions on this computer:
A Computer Partition (CP) is an instance of a Software Release
(SR). You can now define how many instances will be available on this
computer.
@@ -29,15 +30,14 @@
Template: slapformat/ipv4_local_network
Type: string
_Description: Local IPv4 network to be used for Computer Partitions:
- Each Computer Partition (CP) must a local IPv4 took from the network
- given here in CIDR notation.
+ Each Computer Partition (CP) must use specific IPv4 settings. Please
+ enter these setting here, in CIDR notation.
Template: slapformat/bridge_note
Type: note
-_Description: Note about network configuration
- Before actually using slapformat script, you *must* set up a bridge
- that will be used by the Computer Partitions and IPv6 must be
- enabled (in most cases, it is already enabled by default though).
+_Description: Network configuration note
+ Before using slapformat script, you must set up a network bridge
+ to be used by the Computer Partitions and enable IPv6.
.
- You can find examples of setting it up in
+ You can find more information in
/usr/share/doc/slapformat/README.Debian.
--- slapos.tool.format.old/debian/control 2011-05-03 22:14:20.004753417 +0200
+++ slapos.tool.format/debian/control 2011-05-08 15:31:37.687633717 +0200
@@ -21,10 +21,9 @@
bridge-utils,
uml-utilities
Breaks: ${python:Breaks}
-Description: Prepare a client for deploying a SaaS system with SLAPos
- Slapformat is supposed to be ran before Slapgrid in order to prepare
- a SLAPos client. At the end a report is generated and information are
- sent to configured SlapOS server.
+Description: utility to prepare SLAPos SaaS clients
+ The Slapformat utility should be used before Slapgrid in order to prepare
+ SLAPos clients. It generates a preparation report and sends needed
+ information to the SlapOS server.
.
- SLAPos provides support for deploying a SaaS (Software as a Service)
- system.
+ SLAPos systems are SaaS (Software as a Service) solutions.
Source: slapos.tool.format
Maintainer: Arnaud Fontaine <arnau@debian.org>
Uploaders: Python Applications Packaging Team <python-apps-team@lists.alioth.debian.org>
Section: net
Priority: optional
Build-Depends: python-setuptools (>= 0.6b3),
python (>= 2.6.6-3~),
python2.6,
debhelper (>= 7.4.3)
Build-Depends-Indep: po-debconf
Standards-Version: 3.9.2
X-Python-Version: 2.6
Homepage: http://www.slapos.org
Vcs-Svn: svn://svn.debian.org/python-apps/packages/slapos.tool.format/trunk/
Vcs-Browser: http://svn.debian.org/viewsvn/python-apps/packages/slapos.tool.format/trunk/
Package: slapformat
Architecture: all
Depends: ${misc:Depends},
${python:Depends},
bridge-utils,
uml-utilities
Breaks: ${python:Breaks}
Description: utility to prepare SLAPos SaaS clients
The Slapformat utility should be used before Slapgrid in order to prepare
SLAPos clients. It generates a preparation report and sends needed
information to the SlapOS server.
.
SLAPos systems are SaaS (Software as a Service) solutions.
Attachment:
signature.asc
Description: Digital signature