<pre>.. _examples:

Big picture examples
====================

Actual Pungi configuration files can get very large. This pages brings two
examples of (almost) full configuration for two different composes.

Fedora Rawhide compose
----------------------

This is a shortened configuration for Fedora Radhide compose as of 2019-10-14.

::

    release_name = &#39;Fedora&#39;
    release_short = &#39;Fedora&#39;
    release_version = &#39;Rawhide&#39;
    release_is_layered = False

    bootable = True
    comps_file = {
        &#39;scm&#39;: &#39;git&#39;,
        &#39;repo&#39;: &#39;https://pagure.io/fedora-comps.git&#39;,
        &#39;branch&#39;: &#39;master&#39;,
        &#39;file&#39;: &#39;comps-rawhide.xml&#39;,
        # Merge translations by running make. This command will generate the file.
        &#39;command&#39;: &#39;make comps-rawhide.xml&#39;
    }
    module_defaults_dir = {
        &#39;scm&#39;: &#39;git&#39;,
        &#39;repo&#39;: &#39;https://pagure.io/releng/fedora-module-defaults.git&#39;,
        &#39;branch&#39;: &#39;main&#39;,
        &#39;dir&#39;: &#39;.&#39;
    }
    # Optional module obsoletes configuration which is merged
    # into the module index and gets resolved
    module_obsoletes_dir = {
        &#39;scm&#39;: &#39;git&#39;,
        &#39;repo&#39;: &#39;https://pagure.io/releng/fedora-module-defaults.git&#39;,
        &#39;branch&#39;: &#39;main&#39;,
        &#39;dir&#39;: &#39;obsoletes&#39;
    }

    variants_file=&#39;variants-fedora.xml&#39;
    sigkeys = [&#39;12C944D0&#39;]

    # Put packages into subdirectories hashed by their initial letter.
    hashed_directories = True

    # There is a special profile for use with compose. It makes Pungi
    # authenticate automatically as rel-eng user.
    koji_profile = &#39;compose_koji&#39;

    # RUNROOT settings
    runroot = True
    runroot_channel = &#39;compose&#39;
    runroot_tag = &#39;f32-build&#39;

    # PKGSET
    pkgset_source = &#39;koji&#39;
    pkgset_koji_tag = &#39;f32&#39;
    pkgset_koji_inherit = False

    filter_system_release_packages = False

    # GATHER
    gather_method = {
        &#39;^.*&#39;: {                # For all variants
            &#39;comps&#39;: &#39;deps&#39;,    # resolve dependencies for packages from comps file
            &#39;module&#39;: &#39;nodeps&#39;, # but not for packages from modules
        }
    }
    gather_backend = &#39;dnf&#39;
    gather_profiler = True
    check_deps = False
    greedy_method = &#39;build&#39;

    repoclosure_backend = &#39;dnf&#39;

    # CREATEREPO
    createrepo_deltas = False
    createrepo_database = True
    createrepo_use_xz = True
    createrepo_extra_args = [&#39;--zck&#39;, &#39;--zck-dict-dir=/usr/share/fedora-repo-zdicts/rawhide&#39;]

    # CHECKSUMS
    media_checksums = [&#39;sha256&#39;]
    media_checksum_one_file = True
    media_checksum_base_filename = &#39;%(release_short)s-%(variant)s-%(version)s-%(arch)s-%(date)s%(type_suffix)s.%(respin)s&#39;

    # CREATEISO
    iso_hfs_ppc64le_compatible = False

    # BUILDINSTALL
    buildinstall_method = &#39;lorax&#39;
    buildinstall_skip = [
        # No installer for Modular variant
        (&#39;^Modular$&#39;, {&#39;*&#39;: True}),
        # No 32 bit installer for Everything.
        (&#39;^Everything$&#39;, {&#39;i386&#39;: True}),
    ]

    # Enables macboot on x86_64 for all variants and disables upgrade image building
    # everywhere.
    lorax_options = [
      (&#39;^.*$&#39;, {
         &#39;x86_64&#39;: {
             &#39;nomacboot&#39;: False
         },
         &#39;ppc64le&#39;: {
             # Use 3GB image size for ppc64le.
             &#39;rootfs_size&#39;: 3
         },
         &#39;*&#39;: {
             &#39;noupgrade&#39;: True
         }
      })
    ]

    additional_packages = [
        (&#39;^(Server|Everything)$&#39;, {
            &#39;*&#39;: [
                # Add all architectures of dracut package.
                &#39;dracut.*&#39;,
                # All all packages matching this pattern
                &#39;autocorr-*&#39;,
            ],
        }),

        (&#39;^Everything$&#39;, {
            # Everything should include all packages from the tag. This only
            # applies to the native arch. Multilib will still be pulled in
            # according to multilib rules.
            &#39;*&#39;: [&#39;*&#39;],
        }),
    ]

    filter_packages = [
        (&#34;^.*$&#34;, {&#34;*&#34;: [&#34;glibc32&#34;, &#34;libgcc32&#34;]}),
        (&#39;(Server)$&#39;, {
            &#39;*&#39;: [
                &#39;kernel*debug*&#39;,
                &#39;kernel-kdump*&#39;,
            ]
        }),
    ]

    multilib = [
        (&#39;^Everything$&#39;, {
            &#39;x86_64&#39;: [&#39;devel&#39;, &#39;runtime&#39;],
        })
    ]

    # These packages should never be multilib on any arch.
    multilib_blacklist = {
        &#39;*&#39;: [
            &#39;kernel&#39;, &#39;kernel-PAE*&#39;, &#39;kernel*debug*&#39;, &#39;java-*&#39;, &#39;php*&#39;, &#39;mod_*&#39;, &#39;ghc-*&#39;
        ],
    }

    # These should be multilib even if they don&#39;t match the rules defined above.
    multilib_whitelist = {
        &#39;*&#39;: [&#39;wine&#39;, &#39;*-static&#39;],
    }

    createiso_skip = [
        # Keep binary ISOs for Server, but not source ones.
        (&#39;^Server$&#39;, {&#39;src&#39;: True}),

        # Remove all other ISOs.
        (&#39;^Everything$&#39;, {&#39;*&#39;: True, &#39;src&#39;: True}),
        (&#39;^Modular$&#39;, {&#39;*&#39;: True, &#39;src&#39;: True}),
    ]

    # Image name respecting Fedora&#39;s image naming policy
    image_name_format = &#39;%(release_short)s-%(variant)s-%(disc_type)s-%(arch)s-%(version)s-%(date)s%(type_suffix)s.%(respin)s.iso&#39;
    # Use the same format for volume id
    image_volid_formats = [
        &#39;%(release_short)s-%(variant)s-%(disc_type)s-%(arch)s-%(version)s&#39;
    ]
    # Used by Pungi to replace &#39;Cloud&#39; with &#39;C&#39; (etc.) in ISO volume IDs.
    # There is a hard 32-character limit on ISO volume IDs, so we use
    # these to try and produce short enough but legible IDs. Note this is
    # duplicated in Koji for live images, as livemedia-creator does not
    # allow Pungi to tell it what volume ID to use. Note:
    # https://fedoraproject.org/wiki/User:Adamwill/Draft_fedora_image_naming_policy
    volume_id_substitutions = {
                     &#39;Beta&#39;: &#39;B&#39;,
                  &#39;Rawhide&#39;: &#39;rawh&#39;,
               &#39;Silverblue&#39;: &#39;SB&#39;,
                 &#39;Cinnamon&#39;: &#39;Cinn&#39;,
                    &#39;Cloud&#39;: &#39;C&#39;,
             &#39;Design_suite&#39;: &#39;Dsgn&#39;,
           &#39;Electronic_Lab&#39;: &#39;Elec&#39;,
               &#39;Everything&#39;: &#39;E&#39;,
           &#39;Scientific_KDE&#39;: &#39;SciK&#39;,
                 &#39;Security&#39;: &#39;Sec&#39;,
                   &#39;Server&#39;: &#39;S&#39;,
              &#39;Workstation&#39;: &#39;WS&#39;,
    }

    disc_types = {
        &#39;boot&#39;: &#39;netinst&#39;,
        &#39;live&#39;: &#39;Live&#39;,
    }

    translate_paths = [
       (&#39;/mnt/koji/compose/&#39;, &#39;https://kojipkgs.fedoraproject.org/compose/&#39;),
    ]

    # These will be inherited by live_media, live_images and image_build
    global_ksurl = &#39;git+https://pagure.io/fedora-kickstarts.git?#HEAD&#39;
    global_release = &#39;!RELEASE_FROM_LABEL_DATE_TYPE_RESPIN&#39;
    global_version = &#39;Rawhide&#39;
    # live_images ignores this in favor of live_target
    global_target = &#39;f32&#39;

    image_build = {
        &#39;^Container$&#39;: [
            {
                &#39;image-build&#39;: {
                        &#39;format&#39;: [(&#39;docker&#39;, &#39;tar.xz&#39;)],
                        &#39;name&#39;: &#39;Fedora-Container-Base&#39;,
                        &#39;kickstart&#39;: &#39;fedora-container-base.ks&#39;,
                        &#39;distro&#39;: &#39;Fedora-22&#39;,
                        &#39;disk_size&#39;: 5,
                        &#39;arches&#39;: [&#39;armhfp&#39;, &#39;aarch64&#39;, &#39;ppc64le&#39;, &#39;s390x&#39;, &#39;x86_64&#39;],
                        &#39;repo&#39;: &#39;Everything&#39;,
                        &#39;install_tree_from&#39;: &#39;Everything&#39;,
                        &#39;subvariant&#39;: &#39;Container_Base&#39;,
                        &#39;failable&#39;: [&#39;*&#39;],
                        },
                &#39;factory-parameters&#39;: {
                    &#39;dockerversion&#39;: &#34;1.10.1&#34;,
                    &#39;docker_cmd&#39;:  &#39;[ &#34;/bin/bash&#34; ]&#39;,
                    &#39;docker_env&#39;: &#39;[ &#34;DISTTAG=f32container&#34;, &#34;FGC=f32&#34;, &#34;container=oci&#34; ]&#39;,
                    &#39;docker_label&#39;: &#39;{ &#34;name&#34;: &#34;fedora&#34;, &#34;license&#34;: &#34;MIT&#34;, &#34;vendor&#34;: &#34;Fedora Project&#34;, &#34;version&#34;: &#34;32&#34;}&#39;,
                },
            },
        ],
    }

    live_media = {
        &#39;^Workstation$&#39;: [
                {
                    &#39;name&#39;: &#39;Fedora-Workstation-Live&#39;,
                    &#39;kickstart&#39;: &#39;fedora-live-workstation.ks&#39;,
                    # Variants.xml also contains aarch64 and armhfp, but there
                    # should be no live media for those arches.
                    &#39;arches&#39;: [&#39;x86_64&#39;, &#39;ppc64le&#39;],
                    &#39;failable&#39;: [&#39;ppc64le&#39;],
                    # Take packages and install tree from Everything repo.
                    &#39;repo&#39;: &#39;Everything&#39;,
                    &#39;install_tree_from&#39;: &#39;Everything&#39;,
                }
            ],
        &#39;^Spins&#39;: [
            # There are multiple media for Spins variant. They use subvariant
            # field so that they can be identified in the metadata.
            {
                &#39;name&#39;: &#39;Fedora-KDE-Live&#39;,
                &#39;kickstart&#39;: &#39;fedora-live-kde.ks&#39;,
                &#39;arches&#39;: [&#39;x86_64&#39;],
                &#39;repo&#39;: &#39;Everything&#39;,
                &#39;install_tree_from&#39;: &#39;Everything&#39;,
                &#39;subvariant&#39;: &#39;KDE&#39;

            },
            {
                &#39;name&#39;: &#39;Fedora-Xfce-Live&#39;,
                &#39;kickstart&#39;: &#39;fedora-live-xfce.ks&#39;,
                &#39;arches&#39;: [&#39;x86_64&#39;],
                &#39;failable&#39;: [&#39;*&#39;],
                &#39;repo&#39;: &#39;Everything&#39;,
                &#39;install_tree_from&#39;: &#39;Everything&#39;,
                &#39;subvariant&#39;: &#39;Xfce&#39;
            },
        ],
    }

    failable_deliverables = [
        # Installer and ISOs for server failing do not abort the compose.
        (&#39;^Server$&#39;, { 
            &#39;*&#39;: [&#39;buildinstall&#39;, &#39;iso&#39;],
        }),
        (&#39;^.*$&#39;, {
            # Buildinstall is not blocking
            &#39;src&#39;: [&#39;buildinstall&#39;],
            # Nothing on i386, ppc64le blocks the compose
            &#39;i386&#39;: [&#39;buildinstall&#39;, &#39;iso&#39;],
            &#39;ppc64le&#39;: [&#39;buildinstall&#39;, &#39;iso&#39;],
            &#39;s390x&#39;: [&#39;buildinstall&#39;, &#39;iso&#39;],
        })
    ]

    live_target = &#39;f32&#39;
    live_images_no_rename = True
    live_images = [
        (&#39;^Workstation$&#39;, {
            &#39;armhfp&#39;: {
                &#39;kickstart&#39;: &#39;fedora-arm-workstation.ks&#39;,
                &#39;name&#39;: &#39;Fedora-Workstation-armhfp&#39;,
                # Again workstation takes packages from Everything.
                &#39;repo&#39;: &#39;Everything&#39;,
                &#39;type&#39;: &#39;appliance&#39;,
                &#39;failable&#39;: True,
            }
        }),
        (&#39;^Server$&#39;, {
            # But Server has its own repo.
            &#39;armhfp&#39;: {
                &#39;kickstart&#39;: &#39;fedora-arm-server.ks&#39;,
                &#39;name&#39;: &#39;Fedora-Server-armhfp&#39;,
                &#39;type&#39;: &#39;appliance&#39;,
                &#39;failable&#39;: True,
            }
        }),
    ]

    ostree = {
        &#34;^Silverblue$&#34;: {
            &#34;version&#34;: &#34;!OSTREE_VERSION_FROM_LABEL_DATE_TYPE_RESPIN&#34;,
            # To get config, clone master branch from this repo and take
            # treefile from there.
            &#34;treefile&#34;: &#34;fedora-silverblue.yaml&#34;,
            &#34;config_url&#34;: &#34;https://pagure.io/workstation-ostree-config.git&#34;,
            &#34;config_branch&#34;: &#34;master&#34;,
            # Consume packages from Everything
            &#34;repo&#34;: &#34;Everything&#34;,
            # Don&#39;t create a reference in the ostree repo (signing automation does that).
            &#34;tag_ref&#34;: False,
            # Don&#39;t use change detection in ostree.
            &#34;force_new_commit&#34;: True,
            # Use unified core mode for rpm-ostree composes
            &#34;unified_core&#34;: True,
            # This is the location for the repo where new commit will be
            # created. Note that this is outside of the compose dir.
            &#34;ostree_repo&#34;: &#34;/mnt/koji/compose/ostree/repo/&#34;,
            &#34;ostree_ref&#34;: &#34;fedora/rawhide/${basearch}/silverblue&#34;,
            &#34;arches&#34;: [&#34;x86_64&#34;, &#34;ppc64le&#34;, &#34;aarch64&#34;],
            &#34;failable&#34;: [&#39;*&#39;],
        }
    }

    ostree_container = {
        &#34;^Sagano$&#34;: {
            &#34;treefile&#34;: &#34;fedora-tier-0-38.yaml&#34;,
            &#34;config_url&#34;: &#34;https://gitlab.com/CentOS/cloud/sagano.git&#34;,
            &#34;config_branch&#34;: &#34;main&#34;,
            # Consume packages from Everything
            &#34;repo&#34;: &#34;Everything&#34;,
            # Automatically generate a reasonable version
            &#34;version&#34;: &#34;!OSTREE_VERSION_FROM_LABEL_DATE_TYPE_RESPIN&#34;,
            # Only run this for x86_64 even if Sagano has more arches
            &#34;arches&#34;: [&#34;x86_64&#34;],
        }
    }

    ostree_installer = [
        (&#34;^Silverblue$&#34;, {
            &#34;x86_64&#34;: {
                &#34;repo&#34;: &#34;Everything&#34;,
                &#34;release&#34;: None,
                &#34;rootfs_size&#34;: &#34;8&#34;,
                # Take templates from this repository.
                &#39;template_repo&#39;: &#39;https://pagure.io/fedora-lorax-templates.git&#39;,
                &#39;template_branch&#39;: &#39;master&#39;,
                # Use following templates.
                &#34;add_template&#34;: [&#34;ostree-based-installer/lorax-configure-repo.tmpl&#34;,
                                 &#34;ostree-based-installer/lorax-embed-repo.tmpl&#34;,
                                 &#34;ostree-based-installer/lorax-embed-flatpaks.tmpl&#34;],
                # And add these variables for the templates.
                &#34;add_template_var&#34;: [
                    &#34;ostree_install_repo=https://kojipkgs.fedoraproject.org/compose/ostree/repo/&#34;,
                    &#34;ostree_update_repo=https://ostree.fedoraproject.org&#34;,
                    &#34;ostree_osname=fedora&#34;,
                    &#34;ostree_oskey=fedora-32-primary&#34;,
                    &#34;ostree_contenturl=mirrorlist=https://ostree.fedoraproject.org/mirrorlist&#34;,
                    &#34;ostree_install_ref=fedora/rawhide/x86_64/silverblue&#34;,
                    &#34;ostree_update_ref=fedora/rawhide/x86_64/silverblue&#34;,
                    &#34;flatpak_remote_name=fedora&#34;,
                    &#34;flatpak_remote_url=oci+https://registry.fedoraproject.org&#34;,
                    &#34;flatpak_remote_refs=runtime/org.fedoraproject.Platform/x86_64/f30 app/org.gnome.Baobab/x86_64/stable&#34;,
                ],
                &#39;failable&#39;: [&#39;*&#39;],
            },
        })
    ]


RCM Tools compose
-----------------

This is a small compose used to deliver packages to Red Hat internal users. The
configuration is split into two files.

::

    # rcmtools-common.conf 

    release_name = &#34;RCM Tools&#34;
    release_short = &#34;RCMTOOLS&#34;
    release_version = &#34;2.0&#34;
    release_type = &#34;updates&#34;
    release_is_layered = True
    createrepo_c = True
    createrepo_checksum = &#34;sha256&#34;

    # PKGSET
    pkgset_source = &#34;koji&#34;
    koji_profile = &#34;brew&#34;
    pkgset_koji_inherit = True


    # GENERAL SETTINGS
    bootable = False
    comps_file = &#34;rcmtools-comps.xml&#34;
    variants_file = &#34;rcmtools-variants.xml&#34;
    sigkeys = [&#34;3A3A33A3&#34;]


    # RUNROOT settings
    runroot = False


    # GATHER
    gather_method = &#34;deps&#34;
    check_deps = True

    additional_packages = [
        (&#39;.*&#39;, {
            &#39;*&#39;: [&#39;puddle&#39;, &#39;rcm-nexus&#39;],
            }
        ),
    ]

    # Set repoclosure_strictness to fatal to avoid installation dependency
    # issues in production composes
    repoclosure_strictness = [
        (&#34;^.*$&#34;, {
            &#34;*&#34;: &#34;fatal&#34;
        })
    ]


Configuration specific for different base products is split into separate files.

::

    # rcmtools-common.conf 
    from rcmtools-common import *

    # BASE PRODUCT
    base_product_name = &#34;Red Hat Enterprise Linux&#34;
    base_product_short = &#34;RHEL&#34;
    base_product_version = &#34;7&#34;

    # PKGSET
    pkgset_koji_tag = &#34;rcmtools-rhel-7-compose&#34;

    # remove i386 arch on rhel7
    tree_arches = [&#34;aarch64&#34;, &#34;ppc64le&#34;, &#34;s390x&#34;, &#34;x86_64&#34;]

    check_deps = False

    # Packages in these repos are available to satisfy dependencies inside the
    # compose, but will not be pulled in.
    gather_lookaside_repos = [
        (&#34;^Client|Client-optional$&#34;, {
            &#34;x86_64&#34;: [
                &#34;http://example.redhat.com/rhel/7/Client/x86_64/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Client/x86_64/optional/os/&#34;,
            ],
        }),
         (&#34;^Workstation|Workstation-optional$&#34;, {
            &#34;x86_64&#34;: [
                &#34;http://example.redhat.com/rhel/7/Workstation/x86_64/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Workstation/x86_64/optional/os/&#34;,
            ],
        }),
        (&#34;^Server|Server-optional$&#34;, {
            &#34;aarch64&#34;: [
                &#34;http://example.redhat.com/rhel/7/Server/aarch64/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Server/aarch64/optional/os/&#34;,
            ],
            &#34;ppc64&#34;: [
                &#34;http://example.redhat.com/rhel/7/Server/ppc64/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Server/ppc64/optional/os/&#34;,
            ],
            &#34;ppc64le&#34;: [
                &#34;http://example.redhat.com/rhel/7/Server/ppc64le/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Server/ppc64le/optional/os/&#34;,
            ],
            &#34;s390x&#34;: [
                &#34;http://example.redhat.com/rhel/7/Server/s390x/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Server/s390x/optional/os/&#34;,
            ],
            &#34;x86_64&#34;: [
                &#34;http://example.redhat.com/rhel/7/Server/x86_64/os/&#34;,
                &#34;http://example.redhat.com/rhel/7/Server/x86_64/optional/os/&#34;,
            ],
        })
    ]
</pre>