2023-04-04 22:26:42 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "The wiki for Rocky Linux Core SIG." >
< link rel = "canonical" href = "https://sig-core.rocky.page/documentation/references/empanadas_common/" >
< link rel = "prev" href = "../" >
< link rel = "next" href = "../empanadas_config/" >
< link rel = "icon" href = "../../../assets/images/favicon.png" >
2023-05-16 15:05:23 +00:00
< meta name = "generator" content = "mkdocs-1.4.3, mkdocs-material-9.1.12" >
2023-04-04 22:26:42 +00:00
< title > Empanadas common.py Configuration - SIG/Core Wiki< / title >
2023-05-16 15:05:23 +00:00
< link rel = "stylesheet" href = "../../../assets/stylesheets/main.85bb2934.min.css" >
2023-04-04 22:26:42 +00:00
2023-05-16 15:05:23 +00:00
< link rel = "stylesheet" href = "../../../assets/stylesheets/palette.a6bdf11c.min.css" >
2023-04-04 22:26:42 +00:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( "../../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
< / head >
2023-04-04 22:32:38 +00:00
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "teal" data-md-color-accent = "teal" >
2023-04-04 22:26:42 +00:00
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#config-items" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "../../.." title = "SIG/Core Wiki" class = "md-header__button md-logo" aria-label = "SIG/Core Wiki" data-md-component = "logo" >
< img src = "../../../assets/icon-white.svg" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
SIG/Core Wiki
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Empanadas common.py Configuration
< / span >
< / div >
< / div >
< / div >
2023-05-16 15:05:23 +00:00
< form class = "md-header__option" data-md-component = "palette" >
2023-04-04 22:26:42 +00:00
2023-05-16 15:05:23 +00:00
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = "default" data-md-color-primary = "teal" data-md-color-accent = "teal" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_2" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z" / > < / svg >
< / label >
2023-04-04 22:26:42 +00:00
2023-05-16 15:05:23 +00:00
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = "slate" data-md-color-primary = "teal" data-md-color-accent = "teal" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_2" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z" / > < / svg >
< / label >
2023-04-04 22:26:42 +00:00
2023-05-16 15:05:23 +00:00
< / form >
2023-04-04 22:26:42 +00:00
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< div class = "md-search__suggest" data-md-component = "search-suggest" > < / div >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://git.resf.org/sig_core/wiki" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-07 20:11:33 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2023-04-04 22:26:42 +00:00
< / div >
< div class = "md-source__repository" >
sig_core/wiki
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary md-nav--integrated" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "../../.." title = "SIG/Core Wiki" class = "md-nav__button md-logo" aria-label = "SIG/Core Wiki" data-md-component = "logo" >
< img src = "../../../assets/icon-white.svg" alt = "logo" >
< / a >
SIG/Core Wiki
< / label >
< div class = "md-nav__source" >
< a href = "https://git.resf.org/sig_core/wiki" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-07 20:11:33 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2023-04-04 22:26:42 +00:00
< / div >
< div class = "md-source__repository" >
sig_core/wiki
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../.." class = "md-nav__link" >
SIG/Core
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../members/" class = "md-nav__link" >
Members
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../what_we_do/" class = "md-nav__link" >
What We Do
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" checked >
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
Documentation
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Documentation
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../" class = "md-nav__link" >
2023-04-07 20:11:33 +00:00
Release General Overview
2023-04-04 22:26:42 +00:00
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4_2" >
< label class = "md-nav__link" for = "__nav_4_2" id = "__nav_4_2_label" tabindex = "0" >
Composing Releases
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_4_2" >
< span class = "md-nav__icon md-icon" > < / span >
Composing Releases
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../compose/" class = "md-nav__link" >
2023-04-14 01:02:27 +00:00
Composing and Managing Releases
2023-04-04 22:26:42 +00:00
< / a >
< / li >
2023-04-05 08:10:32 +00:00
< li class = "md-nav__item" >
< a href = "../../compose/koji/" class = "md-nav__link" >
Manual Updates in Koji
< / a >
< / li >
2023-04-04 22:26:42 +00:00
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../empanadas/" class = "md-nav__link" >
Empanadas
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../peridot/" class = "md-nav__link" >
Peridot
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4_5" checked >
< label class = "md-nav__link" for = "__nav_4_5" id = "__nav_4_5_label" tabindex = "0" >
References
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_5_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4_5" >
< span class = "md-nav__icon md-icon" > < / span >
References
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../" class = "md-nav__link" >
References
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Empanadas common.py Configuration
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Empanadas common.py Configuration
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#config-items" class = "md-nav__link" >
Config Items
< / a >
< nav class = "md-nav" aria-label = "Config Items" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#configrlmacro" class = "md-nav__link" >
config.rlmacro
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configdist" class = "md-nav__link" >
config.dist
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configarch" class = "md-nav__link" >
config.arch
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configdate_stamp" class = "md-nav__link" >
config.date_stamp
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configcompose_root" class = "md-nav__link" >
config.compose_root
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configstaging_root" class = "md-nav__link" >
config.staging_root
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configproduction_root" class = "md-nav__link" >
config.production_root
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configcategory_stub" class = "md-nav__link" >
config.category_stub
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configsig_category_stub" class = "md-nav__link" >
config.sig_category_stub
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configrepo_base_url" class = "md-nav__link" >
config.repo_base_url
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configmock_work_root" class = "md-nav__link" >
config.mock_work_root
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configcontainer" class = "md-nav__link" >
config.container
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configdistname" class = "md-nav__link" >
config.distname
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configshortname" class = "md-nav__link" >
config.shortname
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configtranslators" class = "md-nav__link" >
config.translators
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configaws_region" class = "md-nav__link" >
config.aws_region
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configbucket" class = "md-nav__link" >
config.bucket
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configbucket_url" class = "md-nav__link" >
config.bucket_url
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#allowed_type_variants-items" class = "md-nav__link" >
allowed_type_variants items
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#reference-example" class = "md-nav__link" >
Reference Example
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../empanadas_config/" class = "md-nav__link" >
Empanadas config yaml Configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../empanadas_sig_config/" class = "md-nav__link" >
Empanadas SIG yaml Configuration
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_5" >
< label class = "md-nav__link" for = "__nav_5" id = "__nav_5_label" tabindex = "0" >
SOP
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_5_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_5" >
< span class = "md-nav__icon md-icon" > < / span >
SOP
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../../sop/" class = "md-nav__link" >
SOP (Standard Operationg Procedures)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../sop/sop_release/" class = "md-nav__link" >
Release Procedures
< / a >
< / li >
2023-04-05 03:22:21 +00:00
< li class = "md-nav__item" >
< a href = "../../../sop/sop_compose_8/" class = "md-nav__link" >
Compose and Repo Sync for Rocky Linux 8
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../sop/sop_compose/" class = "md-nav__link" >
Compose and Repo Sync for Rocky Linux and Peridot
< / a >
< / li >
2023-04-05 08:10:32 +00:00
< li class = "md-nav__item" >
< a href = "../../../sop/sop_compose_sig/" class = "md-nav__link" >
Compose and Repo Sync for Rocky Linux Special Interest Groups
< / a >
< / li >
2023-04-04 22:26:42 +00:00
< li class = "md-nav__item" >
< a href = "../../../sop/sop_upstream_prep_checklist/" class = "md-nav__link" >
Generalized Prep Checklist for Upcoming Releases
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../sop/sop_mirrormanager2/" class = "md-nav__link" >
Mirror Manager
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 > Empanadas common.py Configuration< / h1 >
< p > The < code > common.py< / code > configuration contains dictionaries and classes that dictate
most of the functionality of empanadas.< / p >
< h2 id = "config-items" > Config Items< a class = "headerlink" href = "#config-items" title = "Permanent link" > ¶ < / a > < / h2 >
< p > type: Dictionary< / p >
< h3 id = "configrlmacro" > config.rlmacro< a class = "headerlink" href = "#configrlmacro" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Empanadas expects to run on an EL system. This is part of the
general check up. It should not be hardcoded and use the rpm python module.< / p >
< h3 id = "configdist" > config.dist< a class = "headerlink" href = "#configdist" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: Was the original tag placed in mock configs. This combines < code > el< / code >
with the rpm python module expansion. This is no longer required. The
option is still available for future use.< / p >
< h3 id = "configarch" > config.arch< a class = "headerlink" href = "#configarch" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: The architecture of the current running system. This is checked
against the supported architectures in general release configurations. This
should not be hardcoded.< / p >
< h3 id = "configdate_stamp" > config.date_stamp< a class = "headerlink" href = "#configdate_stamp" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Date time stamp in the form of YYYYMMDD.HHMMSS. This should not be
hardcoded.< / p >
< h3 id = "configcompose_root" > config.compose_root< a class = "headerlink" href = "#configcompose_root" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Root path of composes on the system running empanadas.< / p >
< h3 id = "configstaging_root" > config.staging_root< a class = "headerlink" href = "#configstaging_root" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: For future use. Root path of staging repository location where
content will be synced to.< / p >
< h3 id = "configproduction_root" > config.production_root< a class = "headerlink" href = "#configproduction_root" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: For future use. Root path of production repository location where
content will be synced to from staging.< / p >
< h3 id = "configcategory_stub" > config.category_stub< a class = "headerlink" href = "#configcategory_stub" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: For future use. Stub path that is appended to < code > staging_root< / code > and
< code > production_root< / code > .< / p >
< p > example: < code > mirror/pub/rocky< / code > < / p >
< h3 id = "configsig_category_stub" > config.sig_category_stub< a class = "headerlink" href = "#configsig_category_stub" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: For future use. Stub path that is appended to < code > staging_root< / code > and
< code > production_root< / code > for SIG content.< / p >
< p > example: < code > mirror/pub/sig< / code > < / p >
< h3 id = "configrepo_base_url" > config.repo_base_url< a class = "headerlink" href = "#configrepo_base_url" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: URL to the base url's where the repositories live. This is
typically to a peridot instance. This is supplemented by the configuration
< code > project_id< / code > parameter.< / p >
< p > Note that this does not have to be a peridot instance. The combination of this
value and < code > project_id< / code > can be sufficient enough for empanadas to perform its
work.< / p >
< h3 id = "configmock_work_root" > config.mock_work_root< a class = "headerlink" href = "#configmock_work_root" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Hardcoded path to where ISO work is performed within a mock chroot.
This is the default path created by mock and it is recommended not to change
this.< / p >
< p > example: < code > /builddir< / code > < / p >
< h3 id = "configcontainer" > config.container< a class = "headerlink" href = "#configcontainer" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: This is the container used to perform all operations in podman.< / p >
< p > example: < code > centos:stream9< / code > < / p >
< h3 id = "configdistname" > config.distname< a class = "headerlink" href = "#configdistname" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Name of the distribution you are building or building for.< / p >
< p > example: < code > Rocky Linux< / code > < / p >
< h3 id = "configshortname" > config.shortname< a class = "headerlink" href = "#configshortname" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: True< / p >
< p > description: Short name of the distribution you are building or building for.< / p >
< p > example: < code > Rocky< / code > < / p >
< h3 id = "configtranslators" > config.translators< a class = "headerlink" href = "#configtranslators" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: Dictionary< / p >
< p > required: True< / p >
< p > description: Translates Linux architectures to golang architectures. Reserved
for future use.< / p >
< h3 id = "configaws_region" > config.aws_region< a class = "headerlink" href = "#configaws_region" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: Region you are working in with AWS or onprem cloud that supports
this variable.< / p >
< p > example: < code > us-east-2< / code > < / p >
< h3 id = "configbucket" > config.bucket< a class = "headerlink" href = "#configbucket" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: Name of the S3-compatible bucket that is used to pull images from.
Requires < code > aws_region< / code > .< / p >
< h3 id = "configbucket_url" > config.bucket_url< a class = "headerlink" href = "#configbucket_url" title = "Permanent link" > ¶ < / a > < / h3 >
< p > type: String< / p >
< p > required: False< / p >
< p > description: URL of the S3-compatible bucket that is used to pull images from.< / p >
< h2 id = "allowed_type_variants-items" > allowed_type_variants items< a class = "headerlink" href = "#allowed_type_variants-items" title = "Permanent link" > ¶ < / a > < / h2 >
< p > type: Dictionary< / p >
< p > description: Key value pairs of cloud or image variants. The value is either
< code > None< / code > or a list type.< / p >
< h2 id = "reference-example" > Reference Example< a class = "headerlink" href = "#reference-example" title = "Permanent link" > ¶ < / a > < / h2 >
< div class = "highlight" > < pre > < span > < / span > < code > config = {
" rlmacro" : rpm.expandMacro(' %rhel' ),
" dist" : ' el' + rpm.expandMacro(' %rhel' ),
" arch" : platform.machine(),
" date_stamp" : time.strftime(" %Y%m%d.%H%M%S" , time.localtime()),
" compose_root" : " /mnt/compose" ,
" staging_root" : " /mnt/repos-staging" ,
" production_root" : " /mnt/repos-production" ,
" category_stub" : " mirror/pub/rocky" ,
" sig_category_stub" : " mirror/pub/sig" ,
" repo_base_url" : " https://yumrepofs.build.resf.org/v1/projects" ,
" mock_work_root" : " /builddir" ,
" container" : " centos:stream9" ,
" distname" : " Rocky Linux" ,
" shortname" : " Rocky" ,
" translators" : {
" x86_64" : " amd64" ,
" aarch64" : " arm64" ,
" ppc64le" : " ppc64le" ,
" s390x" : " s390x" ,
" i686" : " 386"
},
" aws_region" : " us-east-2" ,
" bucket" : " resf-empanadas" ,
" bucket_url" : " https://resf-empanadas.s3.us-east-2.amazonaws.com"
}
ALLOWED_TYPE_VARIANTS = {
" Azure" : None,
" Container" : [" Base" , " Minimal" , " UBI" ],
" EC2" : None,
" GenericCloud" : None,
" Vagrant" : [" Libvirt" , " Vbox" ],
" OCP" : None
}
< / code > < / pre > < / div >
< hr >
< div class = "md-source-file" >
< small >
Last update:
2022-10-21
< / small >
< / div >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
< div class = "md-copyright__highlight" >
2023-04-15 15:16:38 +00:00
Copyright © 2023 Rocky Enterprise Software Foundation
2023-04-04 22:26:42 +00:00
< / div >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : "../../.." , "features" : [ "search.highlight" , "search.suggest" , "toc.integrate" ] , "search" : "../../../assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
2023-05-16 15:05:23 +00:00
< script src = "../../../assets/javascripts/bundle.c2be25ad.min.js" > < / script >
2023-04-04 22:26:42 +00:00
< / body >
< / html >
