[Pkg-puppet-devel] [RFR] templates://mcollective/{mcollective-common.templates, mcollective.templates}
Justin B Rye
jbr at edlug.org.uk
Thu Sep 22 13:00:45 UTC 2011
Christian PERRIER wrote:
> Template: mcollective/security_psk
[...]
> +_Description: Pre-shared key for all MCollective instances:
> + Please specify the pre-shared key that should be used between
> + MCollective instances.
>
> PSK is too jargonic, so let's expand. With my changes, the concept of
> "security" disappeared. Not sure if it is worth keeping.
Well, what do you ever need a key for other than security?
But I'd be in favour of capitalising "Pre-Shared Key", to draw the
reader's attention to the fact that a pre-shared key is a PSK. Here's
an ultra-terse version:
_Description: MCollective PSK:
Please specify the Pre-Shared Key that should be used between
MCollective instances.
> Template: mcollective/stomp_host
[...]
> +_Description: Hostname of the ActiveMQ host:
> + Please specify the hostname or IP address of the Message Queue
> server (Apache ActiceMQ).
^
Typo in the last line: ^
Given that it doesn't necessarily need the hostname, just a way of
identifying the host, maybe this should be just:
_Description: ActiveMQ host:
Please specify the hostname or IP address of the Apache Active
Message Queue server.
> Template: mcollective/stomp_port
[...]
> +_Description: Port of the ActiveMQ instance:
> + Please specify the listening port of the Message Queue server (Apache ActiveMQ).
Likewise:
_Description: ActiveMQ port
Please specify the listening port of the Apache Active Message
Queue server.
> Template: mcollective/stomp_user
[...]
> +_Description: STOMP user name:
^
"User name" != "username". If the police demand a list of user names,
they won't be satisfied with "bbadmin, anon001, anon002..."
> + Please specify the username that should be used with the Message Queue server (Apache ActiveMQ).
>
> I don't really know what "STOMP" stands for. Either this is something
> completely obvious to MCollective users....or this should be explained
> in the long description.
STOMP is Simple (or Streaming) Text Orientated Messaging Protocol;
http://stomp.github.com makes everything clear except for why
mcollective needs to set up a user for it.
(It's a pity these puppeting systems couldn't use Kermit...)
I think we need to understand this better before we can say whether
it's "the username of" the ActiveMQ server, a username "used with" the
ActiveMQ server, or something else again. If this is the local
MCollective subsystem for communicating with remote servers, wouldn't
it make more sense to talk about the *MCollective* username/password
and leave out all mention of the particular messaging protocol used?
After all, the default username is "mcollective"!
But until I'm sure of that I suppose my version of this template is:
_Description: STOMP username:
Please specify the username that should be used with the Apache
Active Message Queue server.
> Template: mcollective/stomp_password
[...]
> +_Description: STOMP user password:
> + Please specify the password of the STOMP user on the Message Queue server (Apache ActiveMQ).
I suppose:
_Description: STOMP user password:
Please specify the password of the STOMP user on the Apache
Active Message Queue server.
> Template: mcollective/start_on_boot
[...]
> +_Description: Should MCollective be started at boot?
> + Please choose whether the MCollective daemon should be started when
> + booting this machine.
>
> Grammatical correction (hopefully correct, Justin?)
Don't we usually make this something like
_Description: Start MCollective on boot?
> More verbosity in the long description.
No need for me to fiddle with that one.
> Package: mcollective
[...]
> -Description: build server orchestration or parallel job execution systems
> - The Marionette Collective aka. mcollective is a framework
> +Description: build server/parallel job execution systems - daemon
> + The Marionette Collective, also known as "mcollective", is a framework
> to build server orchestration or parallel job execution systems.
> .
> This package contains the MCollective daemon.
The short description seems to be a garbled attempt to compress the
long description. I'm not 100% sure I follow the long version, but it
seems to me to be saying that MCollective is a framework to build (a)
"server orchestration" and/or (b) "parallel job execution" systems.
It doesn't say anything about build-servers, and it doesn't claim that
MCollective *is* the PJE systems.
Oh, wait; I was assuming it was trying to be a DevRef-compliant noun
phrase. If you read it as a sentence, it makes a plausible manpage
description line. But that just looks like another argument for our
policy of standardising on a predictable syntactic constituent class!
I'd suggest starting from scratch with something based on a more
synopsis-friendly buzzword like "cluster".
And if it's calling itself "mcollective", "MCollective", and
"Marionette Collective" interchangeably, there's probably no need to
spell it out any further.
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.
(I gather mcollective has some unmentioned connection with Puppet...
still, I suppose the full name is a hint.)
[...]
> +Description: build server/parallel job execution systems - client software
> + The Marionette Collective, also known as "mcollective", is a framework
> + to build server orchestration or parallel job execution systems.
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:
> + This package provides the MCollective client utilities:
>
> Let's use less trivial language..:-)
>
> - mco
> - mc-rpc
> - mc-facts
It hardly needs to be bulleted, but let's standardise those dashes
into asterisks anyway.
[...]
> +Description: build server/parallel job execution systems - common files
> + The Marionette Collective, also known as "mcollective", is a framework
> to build server orchestration or parallel job execution systems.
> .
Ditto...
> - Common files for mcollective packages.
> + The package provides the common files for mcollective packages.
This package provides common files for MCollective.
(There's strictly only one mcollective package.)
> +Description: build server/parallel job execution systems - documentation
> The Marionette Collective aka. mcollective is a framework
> to build server orchestration or parallel job execution systems.
> .
> - Documentation package.
> + The package provides the documentation for Marionette Collective.
This package provides documentation for the MCollective packages.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
-------------- next part --------------
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: ActiveMQ host:
Please specify the hostname or IP address of the Apache Active
Message Queue server.
Template: mcollective/stomp_port
Type: string
Default: 6163
_Description: ActiveMQ port:
Please specify the listening port of the Apache Active Message Queue
server.
Template: mcollective/stomp_user
Type: string
Default: mcollective
_Description: STOMP username:
Please specify the username that should be used with the Apache
Active Message Queue server.
Template: mcollective/stomp_password
Type: password
Default: marionette
_Description: STOMP user password:
Please specify the password of the STOMP user on the Apache Active
Message Queue server.
-------------- next part --------------
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.
-------------- next part --------------
Source: mcollective
Section: utils
Priority: optional
Maintainer: Puppet Package Maintainers <pkg-puppet-devel at lists.alioth.debian.org>
Uploaders: Jonas Genannt <jonas.genannt at capi2name.de>, Micah Anderson <micah at 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.
-------------- next part --------------
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-22 13:43:35.281961131 +0100
@@ -1,31 +1,34 @@
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: ActiveMQ host:
+ Please specify the hostname or IP address of the Apache Active
+ Message Queue server.
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: ActiveMQ port:
+ Please specify the listening port of the Apache Active 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: STOMP username:
+ Please specify the username that should be used with the Apache
+ Active 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: STOMP user password:
+ Please specify the password of the STOMP user on the Apache Active
+ 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.
More information about the Pkg-puppet-devel
mailing list