Pulp Container Plugin
=====================
The ``pulp_container`` plugin extends `pulpcore `__ to support
hosting container images and container metadata, supporting ``pull`` and ``push`` operations.
If you are just getting started, we recommend getting to know the :doc:`basic
workflows`.
Features
--------
* :ref:`Synchronize ` container image repositories hosted on Docker-hub, Google Container Registry,
Quay.io, etc., in mirror or additive mode
* :ref:`Create Versioned Repositories ` so every operation is a restorable snapshot
* :ref:`Download content on-demand ` when requested by clients to reduce disk space
* :ref:`Perform docker/podman pull ` from a container distribution served by Pulp
* :ref:`Perform docker/podman push ` to the Pulp Registry
* Curate container images by :ref:`filtering ` what is mirrored from an external repository
* Curate container images by creating repository versions with :ref:`a specific set ` of images
* :ref:`Build an OCI format image from a Containerfile ` and make it available from the Pulp Registry
* Host content either `locally or on S3 `_
* De-duplication of all saved content
Tech Preview
------------
Some additional features are being supplied as a tech preview. There is a possibility that
backwards incompatible changes will be introduced for these particular features. For a list of
features currently being supplied as tech previews only, see the :doc:`tech preview page
`.
How to use these docs
---------------------
The documentation here should be considered **the primary documentation for managing container
related content**. All relevent workflows are covered here, with references to some pulpcore
supplemental docs. Users may also find `pulpcore's conceptual docs
`_ useful.
This documentation falls into two main categories:
1. :ref:`workflows-index` shows the **major features** of the container plugin, with links to
reference docs.
2. The `REST API Docs `_ are automatically generated and provide more detailed
information for each **minor feature**, including all fields and options.
Container Workflows
-------------------
.. toctree::
:maxdepth: 1
installation
workflows/index
restapi/index
role-based-access-control
tech-preview
changes
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`