Skip to content

chore: update security docs to mention release frequency and srus - #7013

Open
blackboxsw wants to merge 8 commits into
canonical:mainfrom
blackboxsw:update-release-security-docs
Open

chore: update security docs to mention release frequency and srus#7013
blackboxsw wants to merge 8 commits into
canonical:mainfrom
blackboxsw:update-release-security-docs

Conversation

@blackboxsw

Copy link
Copy Markdown
Collaborator

Proposed Commit Message

docs(security): report security release frequency and srus use gh milestones

Also correct release schedule links

Additional Context

Test Steps

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

@github-actions github-actions Bot added the documentation This Pull Request changes documentation label Aug 19, 2026
Comment thread SECURITY.md Outdated

## Supported versions

Cloud-init upstream creates [4 time-based releases per year](https://github.com/canonical/cloud-init/milestones).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this important to document? It wasn't true last year, maybe we just don't need it.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consolidated this statement and link into the following sentence

Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
@blackboxsw
blackboxsw force-pushed the update-release-security-docs branch from f5b9ba1 to 8fd50b7 Compare August 19, 2026 22:43
@blackboxsw
blackboxsw requested a review from holmanb August 19, 2026 22:44
@blackboxsw

Copy link
Copy Markdown
Collaborator Author

Added #7016 due to 340ac74 now causing format issues with separately landed 34c74ef

Comment thread SECURITY.md Outdated
Comment on lines +30 to +31
[latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to
ensure security bug fixes are published to stable Ubuntu LTS releases.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

time-based

The word "scheduled" seems more natural here.

is published to the ... Ubuntu ... release

It seems imprecise to say that a cloud-init release is published to an Ubuntu release.

to
ensure security bug fixes are published to stable Ubuntu LTS releases.

I disagree.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced scheduled, s/published/included

Each cloud-init scheduled upstream release is provided as updates to the latest Ubuntu interim release and the two most recent Ubuntu LTS releases to ensure common behavior of cloud-init on all Ubuntu standard security maintenance releases.

Comment thread SECURITY.md Outdated
[latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to
ensure security bug fixes are published to stable Ubuntu LTS releases.

If a CVE is of critical CVSS severity and affects older Ubuntu LTS releases, it will be backported to the specific release.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

Why only critical? Is this some Ubuntu-wide policy?

and affects older Ubuntu LTS releases, it will be backported to the specific release.

Are you sure? This statement is unbounded.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have listed High in there too. Ubuntu ESM CVE policy. Updated critical and high

Updated the statement:
CVEs of critical or high CVSS severity will be backported to all LTS releases and the two most recent ESM releases supported under Ubuntu Pro.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if the Ubuntu ESM CVE policy changes? Why not just link to it rather than copying it?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to lnk direcly to the ESM CVE policy doc. If it changes, our policy changes. I was thinking cloud-init may have a slightly limited view of this policy for very old ESM series to limit support exposure. But, looking at our internal CVE-related bug fixes on older cloud-init series as a guideline, the maintenance isn't currently something that is cause for concern.

Comment thread doc/rtd/explanation/hardening.rst Outdated
@holmanb holmanb self-assigned this Aug 20, 2026

@holmanb holmanb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, more comments.

Comment thread SECURITY.md Outdated

## Supported versions

Each [cloud-init scheduled upstream release](https://github.com/canonical/cloud-init/milestones) is provided as updates to the [latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure common behavior of cloud-init on all Ubuntu standard security maintenance releases.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really long, and I can easily interpret this multiple ways. Can we trim this and be more precise?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snip snip.

Comment thread doc/rtd/explanation/hardening.rst
@blackboxsw
blackboxsw requested a review from holmanb September 5, 2026 02:49
Comment thread SECURITY.md Outdated
Comment on lines +29 to +30
Each [cloud-init upstream release](https://github.com/canonical/cloud-init/milestones) is published to the
[Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure stable cloud-init behavior on recent releases.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still seems confused. Without knowing what an Ubuntu interim release is, this would be confusing to read.

Also, this file is an upstream document - why is Ubuntu-specific showing up here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ubuntu shows up here in a security context because additional work is performed by the upstream project to ensure that CVE's are properly mitigated in a known Ubuntu downstreams. Since upstream also documents the cloud-init Ubuntu SRU policy, I have simplified this text further and pointed to cloud-init stable_release_updates as well as scoping this security section to # Downstream supported versions. If other downstreams want to represent their treatment of security vulnerabilities I think this is reasonable place to document such treatment or cross link from.

Comment thread doc/rtd/explanation/hardening.rst Outdated
Comment on lines +19 to +26
To ensure the available security fixes are applied to you VMs images upon
launch, it is recommended by `Ubuntu security team guidelines`_ to update
the packages
To ensure the available security fixes are applied to images at launch,
it is recommended by `Ubuntu security team guidelines`_ to update the packages

.. note::

Ubuntu cloud images are configured by default to enable unattended-upgrades,
thus this is resolved this issue when the update gets triggered. One can
still apply this recommendation to cloud that gap and update the packages
on first boot.
Ubuntu cloud images enable unattended-upgrades by default, so this issue
resolves automatically as daily scheduled upgrades run. For images without
automated upgrades, follow this recommendation to update packages on first boot.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears self-contradictory. This first paragraph says that the Ubuntu security team guidelines recommend updating packages. The second paragraph says that Ubuntu cloud images don't need to be updated since that happens automatically.

Something like this would be more straightfoward.

Some cloud images (such as Ubuntu) are configured to automatically receive the latest security updates. Other images should use cloud-init to update packages on first boot.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion, unattended-upgrades is a distro-specific implementation detail. I have applied your suggestion.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't look like you did.

@blackboxsw blackboxsw left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this thoughtful review. I have updated both docs

Comment thread SECURITY.md Outdated
Comment on lines +29 to +30
Each [cloud-init upstream release](https://github.com/canonical/cloud-init/milestones) is published to the
[Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure stable cloud-init behavior on recent releases.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ubuntu shows up here in a security context because additional work is performed by the upstream project to ensure that CVE's are properly mitigated in a known Ubuntu downstreams. Since upstream also documents the cloud-init Ubuntu SRU policy, I have simplified this text further and pointed to cloud-init stable_release_updates as well as scoping this security section to # Downstream supported versions. If other downstreams want to represent their treatment of security vulnerabilities I think this is reasonable place to document such treatment or cross link from.

Comment thread doc/rtd/explanation/hardening.rst Outdated
Comment on lines +19 to +26
To ensure the available security fixes are applied to you VMs images upon
launch, it is recommended by `Ubuntu security team guidelines`_ to update
the packages
To ensure the available security fixes are applied to images at launch,
it is recommended by `Ubuntu security team guidelines`_ to update the packages

.. note::

Ubuntu cloud images are configured by default to enable unattended-upgrades,
thus this is resolved this issue when the update gets triggered. One can
still apply this recommendation to cloud that gap and update the packages
on first boot.
Ubuntu cloud images enable unattended-upgrades by default, so this issue
resolves automatically as daily scheduled upgrades run. For images without
automated upgrades, follow this recommendation to update packages on first boot.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion, unattended-upgrades is a distro-specific implementation detail. I have applied your suggestion.

Comment thread doc/rtd/explanation/hardening.rst Outdated
Comment on lines +19 to +26
To ensure the available security fixes are applied to you VMs images upon
launch, it is recommended by `Ubuntu security team guidelines`_ to update
the packages
To ensure the available security fixes are applied to images at launch,
it is recommended by `Ubuntu security team guidelines`_ to update the packages

.. note::

Ubuntu cloud images are configured by default to enable unattended-upgrades,
thus this is resolved this issue when the update gets triggered. One can
still apply this recommendation to cloud that gap and update the packages
on first boot.
Ubuntu cloud images enable unattended-upgrades by default, so this issue
resolves automatically as daily scheduled upgrades run. For images without
automated upgrades, follow this recommendation to update packages on first boot.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't look like you did.

Comment thread SECURITY.md Outdated
mitigations and where to obtain the fix
* An announcement is made to [GitHub Discussions](https://github.com/canonical/cloud-init/discussions)

## Downstream supported versions

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "Downstream supported versions" mean in the context of a SECURITY.md?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a more appropriate title would be Downstream security patches, Downstream vulnerability resolution or Supported downstream security updates?

The context is that I want upstream to represent how some downstreams handle CVE vulnerability resolution so we can point to it when community has questions about how Ubuntu or others deal with security vulnerabilities in cloud-init in a given distribution.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've retitled this Downstream CVE mitigation and moved the majority of the content into a specific section of ubuntu_stable_release_updates page.

The reason I felt downstreams should be represented here is to capture some of the supplemental, security-scoped work that is represented by downstreams from the single SECURITY.md page. It ensures that security-focused readers are aware of various downstream efforts or policies related to treatment of cloud-init CVEs.

Comment thread SECURITY.md Outdated

## Downstream supported versions

[Ubuntu ESM CVE policy](https://ubuntu.com/security/cves/about) is followed to determine when to backport CVEs to [Ubuntu SRU supported releases](https://docs.cloud-init.io/en/latest/reference/ubuntu_stable_release_updates.html).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to determine when to backport CVEs

I really hope that we aren't backporting CVEs.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. We are resolving CVEs when they affect stable supported releases. updated text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This Pull Request changes documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants