[Python-apps-team] Bug#710444: [RFR] templates://cloud-init/{cloud-init.templates}

Justin B Rye justin.byam.rye at gmail.com
Thu Jun 6 08:55:46 UTC 2013


Christian PERRIER wrote:
>  Template: cloud-init/datasources
>  Type: multiselect
>  Default: NoCloud, ConfigDrive, OVF, MAAS
>  Choices-C: NoCloud, ConfigDrive, OVF, MAAS, Ec2
> +__Choices: /var/lib/cloud/seed only, Openstack Config Drive, OVF Transports, Ubuntu MAAS, EC2 Metadata service
> +_Description: Data sources to read from:
>   Cloud-init supports searching different "Data Sources" for information
>   that it uses to configure a cloud instance.
>   .
> + Please note that "Ec2 Metadata service" should be used only if
> + the EC2 metadata service is present. Otherwise, it will trigger
> + a very noticeable timeout on boot.

The Choices-C string is "Ec2", but that should be an uppercase C in
"Ec2 Metadata service".  (Or maybe even "EC²", but nobody seems to use
that.)

> --- cloud-init.old/debian/control	2013-05-30 22:31:36.110064510 +0200
> +++ cloud-init/debian/control	2013-06-02 19:19:32.031153108 +0200
> @@ -41,13 +41,11 @@
>           python-requests,
>           ${misc:Depends}
>  Description: configuration and customization of cloud instances
> - Framework and tool written in Python to handle early initialization of a
> + This package provides a framework and tool written in Python to handle early initialization of a
>   cloud instance. Cloud-init can for example set a default locale and a host
>   name, generate SSH private host keys, add SSH keys to a user's
>   authorized_keys so they can log in, and set up ephemeral mount points.

I'd also make that "a default locale and hostname", so I might as well
re-wrap the paragraph.  And just to make it flow better I'll start with
"Cloud-init provides..." and start the second sentence with "it".
That way this can serve as boilerplate if a cloud-init-doc package
ever turns up.

>   .
>   Cloud-init's behavior can be configured via user-data, given by the user at
>   instance launch time.

Using the transparent coinage "user-data" and then defining it is
repetitive; it would be simpler just to say "can be configured via
data given by the user".  (Meanwhile the version of this text on the
homepage makes the word "user-data" a link to some 404ing page at
Amazon).

> - .
> - See upstream project for more details:
> - https://help.ubuntu.com/community/CloudInit
> +
> 
> First paragraph make a real sentence.
> 
> The last paragraph more belongs to a Homepage: field, imho.

Except there's also a Homepage pointing at launchpad, whereas this is
a documentation link.  Oh, no, wait, the homepage says all its docs
are at http://cloudinit.readthedocs.org/, and doesn't have any
pointers towards help.ubuntu.com.  Docufragmentation, already?
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru cloud-init-0.7.2.pristine/debian/cloud-init.templates cloud-init-0.7.2/debian/cloud-init.templates
--- cloud-init-0.7.2.pristine/debian/cloud-init.templates	2013-05-28 08:01:14.000000000 +0100
+++ cloud-init-0.7.2/debian/cloud-init.templates	2013-06-06 09:22:42.679092385 +0100
@@ -2,11 +2,11 @@
 Type: multiselect
 Default: NoCloud, ConfigDrive, OVF, MAAS
 Choices-C: NoCloud, ConfigDrive, OVF, MAAS, Ec2
-Choices: NoCloud: Reads info from /var/lib/cloud/seed only, ConfigDrive: Reads data from Openstack Config Drive, OVF: Reads data from OVF Transports, MAAS: Reads data from Ubuntu MAAS, Ec2: reads data from EC2 Metadata service
-_Description: Which data sources should be searched?
+__Choices: /var/lib/cloud/seed only, Openstack Config Drive, OVF Transports, Ubuntu MAAS, EC2 Metadata service
+_Description: Data sources to read from:
  Cloud-init supports searching different "Data Sources" for information
  that it uses to configure a cloud instance.
  .
- Warning: Only select 'Ec2' if this system will be run on a system with
- the EC2 metadata service present.  Doing so incorrectly will result in
- a substantial timeout on boot.
+ Please note that "EC2 Metadata service" should be used only if
+ the EC2 metadata service is present. Otherwise, it will trigger
+ a very noticeable timeout on boot.
diff -ru cloud-init-0.7.2.pristine/debian/control cloud-init-0.7.2/debian/control
--- cloud-init-0.7.2.pristine/debian/control	2013-05-29 07:20:59.000000000 +0100
+++ cloud-init-0.7.2/debian/control	2013-06-06 09:53:27.685395973 +0100
@@ -41,13 +41,10 @@
          python-requests,
          ${misc:Depends}
 Description: configuration and customization of cloud instances
- Framework and tool written in Python to handle early initialization of a
- cloud instance. Cloud-init can for example set a default locale and a host
- name, generate SSH private host keys, add SSH keys to a user's
+ Cloud-init provides a framework and tool written in Python to handle early
+ initialization of a cloud instance. It can for example set a default locale
+ and hostname, generate SSH private host keys, add SSH keys to a user's
  authorized_keys so they can log in, and set up ephemeral mount points.
  .
- Cloud-init's behavior can be configured via user-data, given by the user at
+ Cloud-init's behavior can be configured via data given by the user at
  instance launch time.
- .
- See upstream project for more details:
- https://help.ubuntu.com/community/CloudInit
-------------- next part --------------
Template: cloud-init/datasources
Type: multiselect
Default: NoCloud, ConfigDrive, OVF, MAAS
Choices-C: NoCloud, ConfigDrive, OVF, MAAS, Ec2
__Choices: /var/lib/cloud/seed only, Openstack Config Drive, OVF Transports, Ubuntu MAAS, EC2 Metadata service
_Description: Data sources to read from:
 Cloud-init supports searching different "Data Sources" for information
 that it uses to configure a cloud instance.
 .
 Please note that "EC2 Metadata service" should be used only if
 the EC2 metadata service is present. Otherwise, it will trigger
 a very noticeable timeout on boot.
-------------- next part --------------
Source: cloud-init
Maintainer: Python Applications Packaging Team <python-apps-team at lists.alioth.debian.org>
Uploaders: Charles Plessy <plessy at debian.org>,
           Miguel Landaeta <miguel at miguel.cc>,
           Julien Danjou <acid at debian.org>,
           Thomas Goirand <zigo at debian.org>
Section: admin
Priority: optional
Build-Depends: debhelper (>= 9),
               po-debconf,
               pyflakes,
               pylint,
               python,
               python-nose,
               python-mocker,
               python-configobj,
               python-oauth,
               python-boto (>= 2.3),
               python-cheetah,
               python-setuptools,
               python-yaml
Standards-Version: 3.9.3
Vcs-Browser: http://anonscm.debian.org/viewvc/python-apps/packages/cloud-init/trunk/
Vcs-Svn: svn://anonscm.debian.org/python-apps/packages/cloud-init/trunk/
Homepage: https://launchpad.net/cloud-init

Package: cloud-init
Architecture: all
Depends: lsb-base,
         ifupdown,
         procps,
         python,
         python (>= 2.7) | python-argparse,
         python-cheetah,
         python-configobj,
         python-oauth,
         python-software-properties,
         python-yaml,
         python-boto (>= 2.3),
         python-prettytable,
         python-requests,
         ${misc:Depends}
Description: configuration and customization of cloud instances
 Cloud-init provides a framework and tool written in Python to handle early
 initialization of a cloud instance. It can for example set a default locale
 and hostname, generate SSH private host keys, add SSH keys to a user's
 authorized_keys so they can log in, and set up ephemeral mount points.
 .
 Cloud-init's behavior can be configured via data given by the user at
 instance launch time.


More information about the Python-apps-team mailing list