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

Re: [Pkg-puppet-devel] [RFR] templates://mcollective/{mcollective-common.templates, mcollective.templates}



Russ Allbery wrote:
> Justin B Rye <jbr@edlug.org.uk> writes:
>> Jonas Genannt wrote:
>>> So it have to be nambed STOMP username/password.
> 
>> If this logic applied to the username and password it would apply
>> equally to all of the other variables there, too.
> 
> Well, calling it the MCollective username and password just seems wrong.
> It's not a password for MCollective.  It's a password for connecting to
> the STOMP server.

Remember, my revised template didn't actually have it as "MCollective
username/password"; I was still trying to work out what the best term
was.  But I was assuming it would be creating a local user account
named "mcollective", which I gather isn't the case.
 
>> Which means we shouldn't be asking for "the port number of the Message
>> Queue server"; we should be asking for "the port number for the STOMP
>> plugin"... and that seems ridiculous.
> 
> Why is that ridiculous?  Unlike the above, those are at least both names
> for the same thing.  STOMP is the protocol, and message queue is the
> function.  So that's just two different ways of naming the same thing.

The reason it seems ridiculous is that debconf templates are meant to
be trying to communicate in easily comprehensible terms, not merely
say things that are technically true.

Christian's version is inconsistent, referring to the "Port of the
ActiveMQ instance" but the "STOMP user name".  I'd recommend
standardising on one term for the server, and I'd prefer to call it
the "Message Queue server" rather than the "STOMP server" for at least
two reasons:
 1) it's possible to guess that ActiveMQ is a Message Queue server;
 2) the protocol name seems like an obscure implementation detail.

I'll try again - revised patch attached.  However, I suspect this
attempt may be trimming details that would be useful to the kind of
sysadmin who understands the subject well enough to use MCollective.
Are there any places where it would be useful to add extra references
to STOMP, Apache ActiveMQ, or MCollective?
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
Source: mcollective
Section: utils
Priority: optional
Maintainer: Puppet Package Maintainers <pkg-puppet-devel@lists.alioth.debian.org>
Uploaders: Jonas Genannt <jonas.genannt@capi2name.de>, Micah Anderson <micah@debian.org>
Build-Depends: debhelper (>= 8)
Standards-Version: 3.9.2
Homepage: http://projects.puppetlabs.com/projects/mcollective
Vcs-Git: git://git.debian.org/git/pkg-puppet/mcollective.git
Vcs-Browser: http://git.debian.org/?p=pkg-puppet/mcollective.git

Package: mcollective
Architecture: all
Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
Suggests: activemq
Recommends: mcollective-client
Description: Marionette Collective clustering framework - server
 The Marionette Collective is a framework for building server
 orchestration and parallel job execution systems.
 .
 This package contains the MCollective daemon.

Package: mcollective-client
Architecture: all
Suggests: mcollective
Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
Description: Marionette Collective clustering framework - clients
 The Marionette Collective is a framework for building server
 orchestration and parallel job execution systems.
 .
 This package provides the MCollective client utilities:
  * mco
  * mc-rpc
  * mc-facts
  * mc-find-hosts
  * mc-ping
  * mc-call-agent
  * mc-controller
  * mc-inventory

Package: mcollective-common
Architecture: all
Suggests: mcollective-doc
Depends: ${misc:Depends}, ruby | ruby-interpreter, rubygems, libstomp-ruby, libsystemu-ruby, ruby-json
Description: Marionette Collective clustering framework - common files
 The Marionette Collective is a framework for building server
 orchestration and parallel job execution systems.
 .
 This package provides common files for MCollective.

Package: mcollective-doc
Architecture: all
Section: doc
Depends: ${misc:Depends}
Description: Marionette Collective clustering framework - documentation
 The Marionette Collective is a framework for building server
 orchestration and parallel job execution systems.
 .
 This package provides documentation for MCollective.
Template: mcollective/security_psk
Type: string
Default: unset
_Description: MCollective PSK:
 Please specify the Pre-Shared Key that should be used between
 MCollective instances.

Template: mcollective/stomp_host
Type: string
Default: localhost
_Description: Message Queue server host:
 Please specify the hostname or IP address of the Message Queue server
 for MCollective.

Template: mcollective/stomp_port
Type: string
Default: 6163
_Description: Message Queue server port:
 Please specify the listening port of the Message Queue server.

Template: mcollective/stomp_user
Type: string
Default: mcollective
_Description: Message Queue server username:
 Please specify the username that should be used with the Message
 Queue server.

Template: mcollective/stomp_password
Type: password
Default: marionette
_Description: Message Queue server password:
 Please specify the password that should be used with the Message
 Queue server.
Template: mcollective/start_on_boot
Type: boolean
Default: false
_Description: Start MCollective on boot?
 Please choose whether the MCollective daemon should be started when
 booting this machine.
diff -ru old/control new/control
--- old/control	2011-09-17 11:38:17.885960613 +0100
+++ new/control	2011-09-22 13:52:32.225960502 +0100
@@ -14,9 +14,9 @@
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
 Suggests: activemq
 Recommends: mcollective-client
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution systems.
+Description: Marionette Collective clustering framework - server
+ The Marionette Collective is a framework for building server
+ orchestration and parallel job execution systems.
  .
  This package contains the MCollective daemon.
 
@@ -24,36 +24,36 @@
 Architecture: all
 Suggests: mcollective
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution system
+Description: Marionette Collective clustering framework - clients
+ The Marionette Collective is a framework for building server
+ orchestration and parallel job execution systems.
  .
- This package contains the MCollective client stuff:
-  - mco
-  - mc-rpc
-  - mc-facts
-  - mc-find-hosts
-  - mc-ping
-  - mc-call-agent
-  - mc-controller
-  - mc-inventory
+ This package provides the MCollective client utilities:
+  * mco
+  * mc-rpc
+  * mc-facts
+  * mc-find-hosts
+  * mc-ping
+  * mc-call-agent
+  * mc-controller
+  * mc-inventory
 
 Package: mcollective-common
 Architecture: all
 Suggests: mcollective-doc
 Depends: ${misc:Depends}, ruby | ruby-interpreter, rubygems, libstomp-ruby, libsystemu-ruby, ruby-json
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution systems.
+Description: Marionette Collective clustering framework - common files
+ The Marionette Collective is a framework for building server
+ orchestration and parallel job execution systems.
  .
- Common files for mcollective packages.
+ This package provides common files for MCollective.
 
 Package: mcollective-doc
 Architecture: all
 Section: doc
 Depends: ${misc:Depends}
-Description: Documentation for mcollective
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution systems.
+Description: Marionette Collective clustering framework - documentation
+ The Marionette Collective is a framework for building server
+ orchestration and parallel job execution systems.
  .
- Documentation package.
+ This package provides documentation for MCollective.
diff -ru old/mcollective-common.templates new/mcollective-common.templates
--- old/mcollective-common.templates	2011-09-17 11:38:11.589961090 +0100
+++ new/mcollective-common.templates	2011-09-27 23:56:28.342298557 +0100
@@ -1,31 +1,33 @@
 Template: mcollective/security_psk
 Type: string
 Default: unset
-_Description: Security PSK key for all MCollective instances:
- Please specify the psk for security within your MCollective
- instances
+_Description: MCollective PSK:
+ Please specify the Pre-Shared Key that should be used between
+ MCollective instances.
 
 Template: mcollective/stomp_host
 Type: string
 Default: localhost
-_Description: Hostname of your ActiveMQ host:
- Please specify the hostname/ip address of your Message Queue
- server (Apache ActiceMQ).
+_Description: Message Queue server host:
+ Please specify the hostname or IP address of the Message Queue server
+ for MCollective.
 
 Template: mcollective/stomp_port
 Type: string
 Default: 6163
-_Description: Port of your ActiveMQ instance:
- Please specify the port of your Message Queue server (Apache ActiveMQ).
+_Description: Message Queue server port:
+ Please specify the listening port of the Message Queue server.
 
 Template: mcollective/stomp_user
 Type: string
 Default: mcollective
-_Description: STOMP user from your ActiveMQ instance:
- Please specify the username of your Message Queue server (Apache ActiveMQ).
+_Description: Message Queue server username:
+ Please specify the username that should be used with the Message
+ Queue server.
 
 Template: mcollective/stomp_password
 Type: password
 Default: marionette
-_Description: STOMP password from your ActiveMQ instance:
- Please specify the password of your Message Queue server (Apache ActiveMQ).
+_Description: Message Queue server password:
+ Please specify the password that should be used with the Message
+ Queue server.
diff -ru old/mcollective.templates new/mcollective.templates
--- old/mcollective.templates	2011-09-17 11:38:14.329960487 +0100
+++ new/mcollective.templates	2011-09-22 13:44:11.297960323 +0100
@@ -1,5 +1,6 @@
 Template: mcollective/start_on_boot
 Type: boolean
 Default: false
-_Description: Should MCollective started onboot?
- Start MCollective daemon onboot.
+_Description: Start MCollective on boot?
+ Please choose whether the MCollective daemon should be started when
+ booting this machine.

Reply to: