doc: describe product_id's output and purpose

Document the "productid" files that Pungi creates when the user
configures the "product_id" setting. Describe where to find the
"productid" files, and how they relate to subscription-manager.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
This commit is contained in:
Ken Dreyer 2019-01-02 14:16:03 -05:00
parent 5f6dcb37f6
commit 7c45157a92

View File

@ -433,8 +433,13 @@ Options
**product_id** = None
(:ref:`scm_dict <scm_support>`) -- If specified, it should point to a
directory with certificates ``<variant_uid>-<arch>-*.pem``. This
certificate will be injected into the repository.
directory with certificates ``<variant_uid>-<arch>-*.pem``. Pungi will
copy each certificate file into the relevant Yum repositories as a
``productid`` file in the ``repodata`` directories. The purpose of these
``productid`` files is to expose the product data to `subscription-manager
<https://github.com/candlepin/subscription-manager>`_.
subscription-manager inclues a "product-id" Yum plugin that can read these
``productid`` certificate files from each Yum repository.
**product_id_allow_missing** = False
(*bool*) -- When ``product_id`` is used and a certificate for some variant