Skip to content

Commit

Permalink
fix(oci): re-wording - apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Sally <[email protected]>
  • Loading branch information
cjdcordeiro and s-makin authored Apr 15, 2024
1 parent 9405b18 commit e86a063
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 18 deletions.
2 changes: 1 addition & 1 deletion oci/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Ubuntu on OCI container registries

**A base container for trusted application images.** Container image provenance is a key aspect of any supply chain. The Ubuntu container image offers the ideal starting point for your application images, both in utility and trustworthiness.

**Compatible with multiple platforms and available in different flavours.** The Ubuntu container image is published as a multi-arch OCI (Open Container Initiative) image that is available for ``amd64``, ``arm``, ``arm64``, ``ppc64le`` and ``s390x``. Moreover, Ubuntu Pro is also available for containers, which means hardened and security-enhanced versions of the public Ubuntu container image are also available.
**Compatible with multiple platforms and available in different flavours.** The Ubuntu container image is published as a multi-arch Open Container Initiative (OCI) image, available for ``amd64``, ``arm``, ``arm64``, ``ppc64le`` and ``s390x``. Ubuntu Pro is also available for containers, which means hardened and security-enhanced versions of the public Ubuntu container image are also available.


.. toctree::
Expand Down
7 changes: 3 additions & 4 deletions oci/oci-explanation/ubuntu-oci-container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,19 @@
Ubuntu OCI container images
===========================

The Open Container Initiative (OCI) establishes standards for constructing container
The `Open Container Initiative (OCI) <https://opencontainers.org/>`_ establishes standards for constructing container
images that can be reliably installed across a variety of compliant host environments.

Ubuntu’s `LTS Docker Image Portfolio <https://ubuntu.com/security/docker-images>`_
provides OCI-compliant images that receive stable security updates and predictable
software updates, thus ensuring consistency in both maintenance schedule and operational
software updates, ensuring consistency in both maintenance schedule and operational
interfaces for the underlying software your software builds on.

Moreover, `Ubuntu-based containers <https://ubuntu.com/containers>`_ (like
chiselled container images) all leverage the Ubuntu container image as their
starting point, and thus also profit from its support and security commitments.

The Ubuntu container image is built from a minimal rootfs tarball. This tarball
is similar to `Ubuntu Base <https://wiki.ubuntu.com/Base>`_
but it already contains the modifications needed to make the rootfs suitable for
contains the modifications needed to make the rootfs suitable for
building OCI/Docker container images. The Ubuntu OCI rootfs tarballs are published
in `OCI partner images <https://partner-images.canonical.com/oci/>`_.
8 changes: 4 additions & 4 deletions oci/oci-explanation/ubuntu-pro-oci-container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Ubuntu Pro OCI container images
===============================


Similar to the `Ubuntu Pro images in public clouds
<https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/explanations/what_are_ubuntu_pro_cloud_instances/>`_, one can build an Ubuntu Pro container image to leverage services like ESM
(Extended Security Maintenance) and FIPS.
As with the `Ubuntu Pro images in public clouds
<https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/explanations/what_are_ubuntu_pro_cloud_instances/>`_, one can build an Ubuntu Pro container image to leverage services like
`Expanded Security Maintenance (ESM) <https://ubuntu.com/security/esm>`_ and `FIPS <https://ubuntu.com/security/fips>`_.

The easiest way to build an Ubuntu Pro container image is to make use of existing container management tools (like Docker) and enable the Pro services on top of an existing Ubuntu container image (e.g. `ubuntu:focal <https://hub.docker.com/_/ubuntu/tags?page=&page_size=&ordering=&name=focal>`_).

.. note::
Ubuntu Pro container images should be run on hosts that are already covered by an Ubuntu Pro subscription.
Please consult the `Ubuntu Pro service description <https://ubuntu.com/legal/ubuntu-pro>`_ for more details.

This process is described in detail in :ref:`this How-to guide <oci-how-to-enable-pro-services>`. The resulting Ubuntu Pro container image can then be loaded into your local Docker daemon and/or can be deployed normally as any other container image.
Find out how to enable :ref:`Ubuntu Pro services in a Dockerfile <oci-how-to-enable-pro-services>`. The resulting Ubuntu Pro container image can then be loaded into your local Docker daemon and/or can be deployed normally as any other container image.
4 changes: 2 additions & 2 deletions oci/oci-how-to/getting-started.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Getting Started
Getting started
***************

This is where to find the Ubuntu container images:
Expand Down Expand Up @@ -40,5 +40,5 @@ day, depending on whether there have been upstream changes in the Ubuntu archive
affecting the packages that constitute the container image.

**Exception**: the only exception is the official Ubuntu image in Docker Hub which,
due to the Docker's policies, cannot be submitted too regularly, and thus are
due to Docker's policies, cannot be submitted too regularly, and so are
only updated every two weeks.
7 changes: 3 additions & 4 deletions oci/oci-how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ How-to guides
*************

If you have a specific goal but are already familiar with the Ubuntu container
images, our How-to guides have more in-depth detail than our tutorials, and dig
a bit further into more advanced usages of the Ubuntu container images.
images, our how-to guides have more in-depth detail than our tutorials, and dig
a bit further into the more advanced uses of Ubuntu container images.

They'll help you achieve an end result but may require you to understand and
adapt the steps to fit your specific requirements.
Expand Down Expand Up @@ -54,8 +54,7 @@ Documentation
-------------

If you have found something missing in this documentation, or have useful
information to add whether it is a tutorial, a guide, or something else, we
compiled a couple of guides for you to facilitate your contribution.
information to add (whether it is a tutorial, a guide, or something else), this guide will help you to make your contribution.

.. toctree::
:maxdepth: 1
Expand Down
4 changes: 2 additions & 2 deletions oci/oci-reference/oci-image-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Ubuntu OCI image configuration
The definition of the Ubuntu container image follows the `OCI image format
specification <https://github.com/opencontainers/image-spec/blob/main/spec.md>`_.

Thus, as with any other container image, the Ubuntu image contains enough metadata
such that one can inspect the image without actually running the container.
So, as with any other container image, the Ubuntu image includes enough metadata
that one can inspect the image without actually running the container.

Layers
------
Expand Down
2 changes: 1 addition & 1 deletion oci/oci-tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Tutorials
*********

If you want to learn the basics from experience, then our tutorials will help
you acquire the necessary competencies from real-life examples with fully
you using real-life examples with fully
reproducible steps.


Expand Down

0 comments on commit e86a063

Please sign in to comment.