name : cc_yum_add_repo.py # Copyright (C) 2012 Yahoo! Inc. # # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. """Yum Add Repo: Add yum repository configuration to the system""" import io import logging import os from configparser import ConfigParser from cloudinit import util from cloudinit.cloud import Cloud from cloudinit.config import Config from cloudinit.config.schema import MetaSchema from cloudinit.settings import PER_INSTANCE meta: MetaSchema = { "id": "cc_yum_add_repo", "distros": [ "almalinux", "azurelinux", "centos", "cloudlinux", "eurolinux", "fedora", "mariner", "openeuler", "OpenCloudOS", "openmandriva", "photon", "rhel", "rocky", "TencentOS", "virtuozzo", ], "frequency": PER_INSTANCE, "activate_by_schema_keys": ["yum_repos"], } LOG = logging.getLogger(__name__) def _canonicalize_id(repo_id: str) -> str: """Canonicalize repo id. The sole name convention for repo ids is to not contain namespaces, and typically the separator used is `-`. More info: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/sec-setting_repository_options :param repo_id: Repo id to convert. :return: Canonical repo id. """ return repo_id.replace(" ", "-") def _format_repo_value(val): if isinstance(val, (bool)): # Seems like yum prefers 1/0 return str(int(val)) if isinstance(val, (list, tuple)): # Can handle 'lists' in certain cases # See: https://linux.die.net/man/5/yum.conf return "\n".join([_format_repo_value(v) for v in val]) if not isinstance(val, str): return str(val) return val # TODO(harlowja): move to distro? # See man yum.conf def _format_repository_config(repo_id, repo_config): to_be = ConfigParser() to_be.add_section(repo_id) # Do basic translation of the items -> values for k, v in repo_config.items(): # For now assume that people using this know # the format of yum and don't verify keys/values further to_be.set(repo_id, k, _format_repo_value(v)) to_be_stream = io.StringIO() to_be.write(to_be_stream) to_be_stream.seek(0) lines = to_be_stream.readlines() lines.insert(0, "# Created by cloud-init on %s\n" % (util.time_rfc2822())) return "".join(lines) def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None: repos = cfg.get("yum_repos") if not repos: LOG.debug( "Skipping module named %s, no 'yum_repos' configuration found", name, ) return repo_base_path = util.get_cfg_option_str( cfg, "yum_repo_dir", "/etc/yum.repos.d/" ) repo_locations = {} repo_configs = {} for repo_id, repo_config in repos.items(): canon_repo_id = _canonicalize_id(repo_id) repo_fn_pth = os.path.join(repo_base_path, "%s.repo" % (canon_repo_id)) if os.path.exists(repo_fn_pth): LOG.info( "Skipping repo %s, file %s already exists!", repo_id, repo_fn_pth, ) continue elif canon_repo_id in repo_locations: LOG.info( "Skipping repo %s, file %s already pending!", repo_id, repo_fn_pth, ) continue if not repo_config: repo_config = {} # Do some basic sanity checks/cleaning n_repo_config = {} for k, v in repo_config.items(): k = k.lower().strip().replace("-", "_") if k: n_repo_config[k] = v repo_config = n_repo_config missing_required = 0 req_fields = ["baseurl", "metalink", "mirrorlist"] for req_field in req_fields: if req_field not in repo_config: missing_required += 1 if missing_required == len(req_fields): LOG.warning( "Repository %s should contain atleast one of the" " following configuration entries: %s, skipping!", repo_id, ", ".join(req_fields), ) else: repo_configs[canon_repo_id] = repo_config repo_locations[canon_repo_id] = repo_fn_pth for c_repo_id, path in repo_locations.items(): repo_blob = _format_repository_config( c_repo_id, repo_configs.get(c_repo_id) ) util.write_file(path, repo_blob)