CloudinitUpdates

Differences between revisions 1 and 2
Revision 1 as of 2017-02-01 17:49:46
Size: 1682
Editor: powersj
Comment:
Revision 2 as of 2017-08-17 21:46:02
Size: 3875
Editor: powersj
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
'''DRAFT DRAFT DRAFT''' '''DRAFT''' '''DRAFT''' '''DRAFT''' '''DRAFT''' '''DRAFT'''
Line 3: Line 3:
This document describes the policy for updating Cloud-init in a stable supported distro, including LTS. This document describes the policy for updating cloud-init in a stable, supported release.
Line 5: Line 5:
Cloud-init is... cloud-init is initialization software used for standing up cloud instances. It can help setup, configure, and customize an instance during boot.

In order to closely align with the MAAS product and the needs of cloud providers (e.g. AWS, Azure, GWS) cloud-init needs to be periodically updated in order to enable new features. Therefore, the following types of changes are allowed as long as the conditions outlined below are met:

   * Bug fixes
   * New features

In the event of a change breaking backwards compatibility, then SRU team approval will need to be obtained.

== Requesting the SRU ==
The SRU should be done with a single process bug, instead of individual bug reports for individual bug fixes. The one bug should have the following:

   * The SRU should be requested per the StableReleaseUpdates documented process
   * The template at the end of this document should be used and all ‘TODO’ filled out
   * References to each bug fixed by the SRU should be included in the changelog and major changes called out in the SRU template, especially where changed behavior is not backwards compatible.
   * For each release (e.g. trusty, xenial, etc.) that is proposed to be updated by the SRU a link to the results of integration testing of specific test cases for at least the following data sources must be provided: nocloud, lxd, ec2, azure, gce
   * Any architecture specific fixes need to be noted and architecture specific test results included
   * Any packaging changes (e.g. a dependency change) need to be stated
   * If any manual testing occurs it should also be documented. See LP# 1588052 as an example.
Line 8: Line 26:
=== Merge QA ===
This is the mandatory QA process that the proposed packages have to pass. The following requirements must be met:
=== Merges ===
Updates to cloud-init trunk go through the following process:
Line 11: Line 29:
   * Every change needs to be covered by a Launchpad bug to track all changes
   * Every bug must have:
      * A bzr branch attached with the fix + changes covered by unit tests
      * Link to successful run of integration tests based on the bzr branch
      * Reviewed and approved by a member of the development team
      * Branch set to the committed state
   * All unit tests and style tests ran and passed successfully
   * Code coverage of changes or code coverage % either no change or increased(?)
   * Reviewed and approved by a member of the development team
   * Daily integration tests on trunk
   * Successful run of unit tests and style tests based on the branch
   * Branch set to the committed state
Line 20: Line 34:
=== Packaging QA ===
TBD
=== Packaging ===
The following describes the requirements for each package generated for the SRU.
Line 23: Line 37:
== Requesting the SRU ==
The SRU should be requested per the StableReleaseUpdates documented process.
For each package generated a successful completion of cloud-init integration tests, as described below, using the proposed package with no unexplained errors or failures
Line 26: Line 39:
The SRU should be done with a single process bug for this stable release exception, instead of individual bug reports for individual bug fixes. Individual bugs may be referenced in the change log, but in that case each of those bugs will need to be independently verified and commented on for the SRU to be considered complete. === Integration Tests ===
TODO
Line 28: Line 42:
The description of the bug should contain links to automatic testing results (e.g. Jenkins test runs) so that anyone can verify the testing that occurred and the results. Additionally, the SRU bug should be verbose in documenting any manual testing that occurs. See [[https://bugs.launchpad.net/ubuntu/+source/snapd/+bug/1588052 | LP# 1588052]] as an example
Line 30: Line 43:
=== SRU Template ===
TBD
== SRU Template ==
{{{
== Begin SRU Template ==
[Impact]
This release sports both bug-fixes and new features and we would like to
make sure all of our supported customers have access to these
improvements. The notable ones are:

   * <TODO: Create list with LP: # included>

See the changelog entry below for a full list of changes and bugs.

[Test Case]
The following development and SRU process was followed:
https://wiki.ubuntu.com/CloudinitUpdates

The cloud-init team will be in charge of attaching the artifacts and
console output of the appropriate run to the bug. cloud-init team
members will not mark ‘verification-done’ until this has happened.

[Regression Potential]
In order to mitigate the regression potential, the results of the
aforementioned integration tests are attached to this bug.

<TODO: attach cloud-init-proposed test artifacts from tests for each release on nocloud datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on lxd datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on ec2 datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on gce datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on azure datasource>

[Discussion]
<TODO: other background>

== End SRU Template ==

<TODO: Paste in change log entry>
}}}

DRAFT DRAFT DRAFT DRAFT DRAFT

This document describes the policy for updating cloud-init in a stable, supported release.

cloud-init is initialization software used for standing up cloud instances. It can help setup, configure, and customize an instance during boot.

In order to closely align with the MAAS product and the needs of cloud providers (e.g. AWS, Azure, GWS) cloud-init needs to be periodically updated in order to enable new features. Therefore, the following types of changes are allowed as long as the conditions outlined below are met:

  • Bug fixes
  • New features

In the event of a change breaking backwards compatibility, then SRU team approval will need to be obtained.

Requesting the SRU

The SRU should be done with a single process bug, instead of individual bug reports for individual bug fixes. The one bug should have the following:

  • The SRU should be requested per the StableReleaseUpdates documented process

  • The template at the end of this document should be used and all ‘TODO’ filled out
  • References to each bug fixed by the SRU should be included in the changelog and major changes called out in the SRU template, especially where changed behavior is not backwards compatible.
  • For each release (e.g. trusty, xenial, etc.) that is proposed to be updated by the SRU a link to the results of integration testing of specific test cases for at least the following data sources must be provided: nocloud, lxd, ec2, azure, gce
  • Any architecture specific fixes need to be noted and architecture specific test results included
  • Any packaging changes (e.g. a dependency change) need to be stated
  • If any manual testing occurs it should also be documented. See LP# 1588052 as an example.

QA Process

Merges

Updates to cloud-init trunk go through the following process:

  • Reviewed and approved by a member of the development team
  • Daily integration tests on trunk
  • Successful run of unit tests and style tests based on the branch
  • Branch set to the committed state

Packaging

The following describes the requirements for each package generated for the SRU.

For each package generated a successful completion of cloud-init integration tests, as described below, using the proposed package with no unexplained errors or failures

Integration Tests

TODO

SRU Template

== Begin SRU Template ==
[Impact]
This release sports both bug-fixes and new features and we would like to
make sure all of our supported customers have access to these
improvements. The notable ones are:

   * <TODO: Create list with LP: # included>

See the changelog entry below for a full list of changes and bugs.

[Test Case]
The following development and SRU process was followed:
https://wiki.ubuntu.com/CloudinitUpdates

The cloud-init team will be in charge of attaching the artifacts and
console output of the appropriate run to the bug.  cloud-init team
members will not mark ‘verification-done’ until this has happened.

[Regression Potential]
In order to mitigate the regression potential, the results of the
aforementioned integration tests are attached to this bug.

<TODO: attach cloud-init-proposed test artifacts from tests for each release on nocloud datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on lxd datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on ec2 datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on gce datasource>
<TODO: attach cloud-init-proposed test artifacts from tests for each release on azure datasource>

[Discussion]
<TODO: other background>

== End SRU Template ==

<TODO: Paste in change log entry>

CloudinitUpdates (last edited 2019-01-25 18:26:38 by chad.smith)