[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://redhat-cluster/{cman.templates}



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

> Template: cman/upgrade-warning         
[...]
> + version 2.0, please refer to http://wiki.debian.org/UpgradeRHCSV1toV2.

Just in case people cut and paste it including the punctuation:

    version 2.0, please refer to "http://wiki.debian.org/UpgradeRHCSV1toV2";.

> Package: redhat-cluster-suite         
[...]
> I think that ALL packages are missing a common paragraph describing
> *what* Redhat cluster suite is..... Anyone feeling like proposing one?

It would have to be something like:

   This package is part of the Red Hat Cluster Suite, a complete
   high-availability solution.

(stitched together from a redhat.com blurb), but this is a bit
inadequate, so I haven't included it in my patch.

> Package: cman         
[...]
> +Description: Red Hat cluster suite - cluster manager
>   CMAN is a symmetric general-purpose cluster manager. It consists of
>   a connection manager that handles cluster membership management,
>   messaging among the cluster nodes, event notification, quorum and
>   state transitions. Another part of CMAN is a service manager that
>   handles service groups.

This boils down to "It consists of (a), which does foo, bar and baz.
P.S.: there's also a (b)."  It's simpler to explain (b) first:

    CMAN is a symmetric general-purpose cluster manager. It provides a
    service manager that handles service groups, plus a connection manager
    that handles cluster membership management, messaging among the
    cluster nodes, event notification, quorum and state transitions.

I don't quite follow the foo-bar-baz bit, though.  It seems to be:

    a connection manager that handles
     - cluster membership management,
     - messaging among the cluster nodes,
     - event notification,
     - quorum
    and
     - state transitions.

But what does it mean to say that it "handles [...] quorum"?

> - This package contains only userspace tools for controlling the actual
> + This package provides only userspace tools for controlling the
>   cluster manager.
> 
> "actual"? Is there any need for that word?

It's mildly informal; try "the cluster manager itself"?

> Package: redhat-cluster-source         
[...]
> + This package provides the source necessary for compiling the Red Hat
>   cluster suite out-of-tree kernel modules gfs and gnbd against the 
> - linux tree.
> + Linux kernel source tree.
> 
> "linux tree" is incorrect, imho. That's the Linux kernel source tree,
> I think

RHCS isn't Section: devel, so it would be good if it could avoid
this jargon - only dogs and programmers do things against trees.
Unfortunately I'm not confident I can translate "compiling an
out-of-tree module against a source tree" into English...

Then some other package descriptions have odd glitches:

 Package: gfs-tools         
 [...]
  The Global File System allows a cluster of machines to concurrently access
  shared storage hardware like SANs or iSCSI and network block devices. GFS
- can be deployed to build high available services without the single point
- of failure a file server would be.
+ can be deployed to build high-availability services without the single point
+ of failure of a file server.

(Ditto in gfs2-tools)

- Note: the package requires gfs2-tools installed and it's known to work fine
- even if GFS2 is highly experimental and *MUST NOT* be used in production
- enviroment yet.
+ Note: the package requires gfs2-tools installed; this is known to be
+ reliable even though the GFS2 kernel modules themselves are highly
+ experimental and *MUST NOT* be used in a production enviroment yet.

 Package: gfs2-tools
 [...]
  This package contains userspace tools for creating and managing global
- file systems. GFS2 itself is a set of kernel modules.
+ file systems.
  .         
- GFS2 *MUST NOT* be used in production enviroment yet.
+ The GFS2 kernel modules themselves are highly experimental and *MUST NOT*
+ be used in a production enviroment yet.

(Phrased to match gfs-tools above)

 Package: gnbd-client         
 [...]
- GNBD allows to use block devices over the network. It is a modified
- version of the linux network block device for the use within a cluster
- environment.
+ GNBD allows block devices to be used over the network. It is a modified
+ version of the Linux network block device for use within a cluster environment.

(And likewise for gnbd-server.)  Sometimes I think we should just
outlaw the use of the word "allow" outside of license texts.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../redhat-cluster.old/debian/cman.templates	2007-12-29 22:14:58.000000000 +0000
+++ debian/cman.templates	2008-01-07 23:24:23.000000000 +0000
@@ -1,14 +1,11 @@
 Template: cman/upgrade-warning
 Type: boolean
 Default: false
-_Description: Do you want to abort now?
+_Description: Abort the potentially disruptive upgrade of Red Hat Cluster Suite?
  The new version 2.0 of the Red Hat Cluster Suite is not compatible with 
  the currently installed one. Upgrading these packages without stopping 
- the complete cluster can cause filesystem corruption on shared storage 
+ the complete cluster can cause file system corruption on shared storage 
  devices.
  .
  For instructions on how to safely upgrade the Red Hat Cluster Suite to
- version 2.0, please refer to the following document:
- .
- http://wiki.debian.org/UpgradeRHCSV1toV2
- .
+ version 2.0, please refer to "http://wiki.debian.org/UpgradeRHCSV1toV2";.
--- ../redhat-cluster.old/debian/control	2007-12-29 22:15:00.000000000 +0000
+++ debian/control	2008-01-07 23:42:46.000000000 +0000
@@ -12,7 +12,7 @@
 Priority: optional
 Architecture: all
 Depends: cman, gfs-tools, gfs2-tools, rgmanager, clvm
-Description: Red Hat cluster suite (meta package)
+Description: Red Hat cluster suite - meta package
  The only scope for this package is to install the full Red Hat Cluster Suite
  in one shot. It is safe to remove it.
 
@@ -23,54 +23,59 @@
 Depends: ${shlibs:Depends}, python, openais (>= 0.82-2)
 Conflicts: magma, libmagma1, libmagma-dev, ccs, fence, libiddev-dev, fence-gnbd, gulm, libgulm1, libgulm-dev, magma-plugins
 Replaces: ccs, fence, fence-gnbd
-Description: cluster manager
- CMAN is a symmetric general-purpose cluster manager. It consists of
- a connection manager that handles cluster membership management,
- messaging among the cluster nodes, event notification, quorum and
- state transitions. Another part of CMAN is a service manager that
- handles service groups.
+Description: Red Hat cluster suite - cluster manager
+ CMAN is a symmetric general-purpose cluster manager. It provides a
+ service manager that handles service groups, plus a connection manager
+ that handles cluster membership management, messaging among the
+ cluster nodes, event notification, quorum and state transitions.
  .
- This package contains only userspace tools for controlling the actual
- cluster manager.
+ This package provides only userspace tools for controlling the
+ cluster manager itself.
 
 Package: libcman2
 Section: libs
 Architecture: any
 Depends: ${shlibs:Depends}
-Description: cluster manager - libraries
- cman provides a general purpose, openais based, cluster manager.
+Description: Red Hat cluster suite - cluster manager libraries
+ CMAN is a symmetric general-purpose cluster manager. It provides a
+ service manager that handles service groups, plus a connection manager
+ that handles cluster membership management, messaging among the
+ cluster nodes, event notification, quorum and state transitions.
  .
- This package contains the client libraries.
+ This package provides the client libraries.
 
 Package: libcman-dev
 Section: libdevel
 Architecture: any
 Depends: libcman2 (= ${binary:Version})
-Description: cluster manager - development files
- cman provides a general purpose, openais based, cluster manager.
+Description: Red Hat cluster suite - cluster manager development files
+ CMAN is a symmetric general-purpose cluster manager. It provides a
+ service manager that handles service groups, plus a connection manager
+ that handles cluster membership management, messaging among the
+ cluster nodes, event notification, quorum and state transitions.
  .
- This package contains the files needed for developing applications.
+ This package provides the files needed for developing applications.
 
 Package: libdlm2
 Section: libs
 Architecture: any
 Depends: ${shlibs:Depends}
-Description: distributed lock manager - library
+Description: Red Hat cluster suite - distributed lock manager library
  DLM is a symmetric general-purpose distributed lock manager. It is
  used for example by GFS and the distributed volume manager.
  .
- This is the client library for applications using the lock manager.
- The lock manager itself is a kernel module.
+ This package provides a client library for applications using the
+ lock manager. The lock manager itself is a kernel module.
 
 Package: libdlm-dev
 Section: libdevel
 Architecture: any
 Depends: libdlm2 (= ${binary:Version})
-Description: distributed lock manager - development files
+Description: Red Hat cluster suite - distributed lock manager development files
  DLM is a symmetric general-purpose distributed lock manager. It is
  used for example by GFS and the distributed volume manager.
  .
- This package contains the files needed for developing applications
+ This package provides the files needed for developing applications
  that use the lock manager.
 
 Package: gfs-tools
@@ -78,63 +83,62 @@
 Depends: ${shlibs:Depends}, psmisc, gfs2-tools
 Recommends: redhat-cluster-modules
 Section: admin
-Description: global file system tools 
+Description: Red Hat cluster suite - global file system tools 
  The Global File System allows a cluster of machines to concurrently access
  shared storage hardware like SANs or iSCSI and network block devices. GFS
- can be deployed to build high available services without the single point
- of failure a file server would be.
+ can be deployed to build high-availability services without the single point
+ of failure of a file server.
  .
- This package contains userspace tools for creating and managing global
+ This package provides userspace tools for creating and managing global
  file systems. GFS itself is a set of kernel modules.
  .
- Note: the package requires gfs2-tools installed and it's known to work fine
- even if GFS2 is highly experimental and *MUST NOT* be used in production
- enviroment yet.
+ Note: the package requires gfs2-tools installed; this is known to be
+ reliable even though the GFS2 kernel modules themselves are highly
+ experimental and *MUST NOT* be used in a production enviroment yet.
 
 Package: gfs2-tools
 Architecture: any
 Depends: ${shlibs:Depends}, psmisc
 Section: admin
-Description: global file system 2 tools (EXPERIMENTAL)
+Description: Red Hat cluster suite - global file system 2 tools
  The Global File System 2 allows a cluster of machines to concurrently access
  shared storage hardware like SANs or iSCSI and network block devices. GFS
- can be deployed to build high available services without the single point
- of failure a file server would be.
+ can be deployed to build high-availability services without the single point
+ of failure of a file server.
  .
- This package contains userspace tools for creating and managing global
- file systems. GFS2 itself is a set of kernel modules.
+ This package provides userspace tools for creating and managing global
+ file systems.
  .
- GFS2 *MUST NOT* be used in production enviroment yet.
+ The GFS2 kernel modules themselves are highly experimental and *MUST NOT*
+ be used in a production enviroment yet.
 
 Package: gnbd-client
 Section: admin
 Architecture: any
 Depends: ${shlibs:Depends}
 Recommends: fence-gnbd (= ${binary:Version}), redhat-cluster-modules
-Description: global network block device - client tools
- GNBD allows to use block devices over the network. It is a modified
- version of the linux network block device for the use within a cluster
- environment.
+Description: Red Hat cluster suite - global network block device client tools
+ GNBD allows block devices to be used over the network. It is a modified
+ version of the Linux network block device for use within a cluster environment.
  .
- This package contains userspace tools for running GNBD clients.
+ This package provides userspace tools for running GNBD clients.
 
 Package: gnbd-server
 Section: admin
 Architecture: any
 Depends: ${shlibs:Depends}
 Recommends: fence-gnbd (= ${binary:Version})
-Description: global network block device - server tools
- GNBD allows to use block devices over the network. It is a modified
- version of the linux network block device for the use within a cluster
- environment.
+Description: Red Hat cluster suite - global network block device server tools
+ GNBD allows block devices to be used over the network. It is a modified
+ version of the Linux network block device for use within a cluster environment.
  .
- This package contains userspace tools for running GNBD servers.
+ This package provides userspace tools for running GNBD servers.
 
 Package: rgmanager
 Architecture: any
 Depends: ${shlibs:Depends}, cman (= ${binary:Version}), iproute, iputils-arping, iputils-ping, nfs-kernel-server, nfs-common
 Conflicts: nfs-user-server
-Description: clustered resource group manager
+Description: Red Hat cluster suite - clustered resource group manager
  Resource Group Manager provides high availability of critical server
  applications in the event of planned or unplanned system downtime.
 
@@ -142,6 +146,6 @@
 Architecture: all
 Depends: bzip2
 Description: Red Hat cluster suite - kernel modules source
- This package contains the source necessary for compiling the Red Hat
+ This package provides the source necessary for compiling the Red Hat
  cluster suite out-of-tree kernel modules gfs and gnbd against the 
- linux tree.
+ Linux kernel source tree.
Template: cman/upgrade-warning
Type: boolean
Default: false
_Description: Abort the potentially disruptive upgrade of Red Hat Cluster Suite?
 The new version 2.0 of the Red Hat Cluster Suite is not compatible with 
 the currently installed one. Upgrading these packages without stopping 
 the complete cluster can cause file system corruption on shared storage 
 devices.
 .
 For instructions on how to safely upgrade the Red Hat Cluster Suite to
 version 2.0, please refer to "http://wiki.debian.org/UpgradeRHCSV1toV2";.
Source: redhat-cluster
Section: admin
Priority: optional
Maintainer: Debian Kernel Team <debian-kernel@lists.debian.org>
Uploaders: Bastian Blank <waldi@debian.org>, Frederik Sch�fs@debian.org>
Standards-Version: 3.7.3.0
Build-Depends: dpatch, debhelper (>= 4.2.28), libxml2-dev, libncurses5-dev, libopenais-dev (>= 0.82-2), libvolume-id-dev (>=  0.105-4), linux-libc-dev (>= 2.6.22-6), libvirt-dev (>= 0.3.0) [amd64 i386], libnss3-dev [amd64 i386], libnspr4-dev [amd64 i386], bzip2, libslang2-dev
Build-Conflicts: libccs-dev, libcman-dev (<= 2.0), libdlm-dev (<= 2.0), libcman2, libdlm2

Package: redhat-cluster-suite
Section: admin
Priority: optional
Architecture: all
Depends: cman, gfs-tools, gfs2-tools, rgmanager, clvm
Description: Red Hat cluster suite - meta package
 The only scope for this package is to install the full Red Hat Cluster Suite
 in one shot. It is safe to remove it.

Package: cman
Architecture: any
Section: admin
Pre-Depends: debconf | debconf-2.0
Depends: ${shlibs:Depends}, python, openais (>= 0.82-2)
Conflicts: magma, libmagma1, libmagma-dev, ccs, fence, libiddev-dev, fence-gnbd, gulm, libgulm1, libgulm-dev, magma-plugins
Replaces: ccs, fence, fence-gnbd
Description: Red Hat cluster suite - cluster manager
 CMAN is a symmetric general-purpose cluster manager. It provides a
 service manager that handles service groups, plus a connection manager
 that handles cluster membership management, messaging among the
 cluster nodes, event notification, quorum and state transitions.
 .
 This package provides only userspace tools for controlling the
 cluster manager itself.

Package: libcman2
Section: libs
Architecture: any
Depends: ${shlibs:Depends}
Description: Red Hat cluster suite - cluster manager libraries
 CMAN is a symmetric general-purpose cluster manager. It provides a
 service manager that handles service groups, plus a connection manager
 that handles cluster membership management, messaging among the
 cluster nodes, event notification, quorum and state transitions.
 .
 This package provides the client libraries.

Package: libcman-dev
Section: libdevel
Architecture: any
Depends: libcman2 (= ${binary:Version})
Description: Red Hat cluster suite - cluster manager development files
 CMAN is a symmetric general-purpose cluster manager. It provides a
 service manager that handles service groups, plus a connection manager
 that handles cluster membership management, messaging among the
 cluster nodes, event notification, quorum and state transitions.
 .
 This package provides the files needed for developing applications.

Package: libdlm2
Section: libs
Architecture: any
Depends: ${shlibs:Depends}
Description: Red Hat cluster suite - distributed lock manager library
 DLM is a symmetric general-purpose distributed lock manager. It is
 used for example by GFS and the distributed volume manager.
 .
 This package provides a client library for applications using the
 lock manager. The lock manager itself is a kernel module.

Package: libdlm-dev
Section: libdevel
Architecture: any
Depends: libdlm2 (= ${binary:Version})
Description: Red Hat cluster suite - distributed lock manager development files
 DLM is a symmetric general-purpose distributed lock manager. It is
 used for example by GFS and the distributed volume manager.
 .
 This package provides the files needed for developing applications
 that use the lock manager.

Package: gfs-tools
Architecture: any
Depends: ${shlibs:Depends}, psmisc, gfs2-tools
Recommends: redhat-cluster-modules
Section: admin
Description: Red Hat cluster suite - global file system tools 
 The Global File System allows a cluster of machines to concurrently access
 shared storage hardware like SANs or iSCSI and network block devices. GFS
 can be deployed to build high-availability services without the single point
 of failure of a file server.
 .
 This package provides userspace tools for creating and managing global
 file systems. GFS itself is a set of kernel modules.
 .
 Note: the package requires gfs2-tools installed; this is known to be
 reliable even though the GFS2 kernel modules themselves are highly
 experimental and *MUST NOT* be used in a production enviroment yet.

Package: gfs2-tools
Architecture: any
Depends: ${shlibs:Depends}, psmisc
Section: admin
Description: Red Hat cluster suite - global file system 2 tools
 The Global File System 2 allows a cluster of machines to concurrently access
 shared storage hardware like SANs or iSCSI and network block devices. GFS
 can be deployed to build high-availability services without the single point
 of failure of a file server.
 .
 This package provides userspace tools for creating and managing global
 file systems.
 .
 The GFS2 kernel modules themselves are highly experimental and *MUST NOT*
 be used in a production enviroment yet.

Package: gnbd-client
Section: admin
Architecture: any
Depends: ${shlibs:Depends}
Recommends: fence-gnbd (= ${binary:Version}), redhat-cluster-modules
Description: Red Hat cluster suite - global network block device client tools
 GNBD allows block devices to be used over the network. It is a modified
 version of the Linux network block device for use within a cluster environment.
 .
 This package provides userspace tools for running GNBD clients.

Package: gnbd-server
Section: admin
Architecture: any
Depends: ${shlibs:Depends}
Recommends: fence-gnbd (= ${binary:Version})
Description: Red Hat cluster suite - global network block device server tools
 GNBD allows block devices to be used over the network. It is a modified
 version of the Linux network block device for use within a cluster environment.
 .
 This package provides userspace tools for running GNBD servers.

Package: rgmanager
Architecture: any
Depends: ${shlibs:Depends}, cman (= ${binary:Version}), iproute, iputils-arping, iputils-ping, nfs-kernel-server, nfs-common
Conflicts: nfs-user-server
Description: Red Hat cluster suite - clustered resource group manager
 Resource Group Manager provides high availability of critical server
 applications in the event of planned or unplanned system downtime.

Package: redhat-cluster-source
Architecture: all
Depends: bzip2
Description: Red Hat cluster suite - kernel modules source
 This package provides the source necessary for compiling the Red Hat
 cluster suite out-of-tree kernel modules gfs and gnbd against the 
 Linux kernel source tree.

Reply to: