# Copyright (c) 2020 Dermot Bradley # # Author: Dermot Bradley <dermot_bradley@yahoo.com> # # This file is part of cloud-init. See LICENSE file for license information. """Apk Configure: Configures apk repositories file.""" import logging from textwrap import dedent from cloudinit import temp_utils, templater, util from cloudinit.cloud import Cloud from cloudinit.config import Config from cloudinit.config.schema import MetaSchema, get_meta_doc from cloudinit.settings import PER_INSTANCE LOG = logging.getLogger(__name__) # If no mirror is specified then use this one DEFAULT_MIRROR = "https://alpine.global.ssl.fastly.net/alpine" REPOSITORIES_TEMPLATE = """\ ## template:jinja # # Created by cloud-init # # This file is written on first boot of an instance # {{ alpine_baseurl }}/{{ alpine_version }}/main {% if community_enabled -%} {{ alpine_baseurl }}/{{ alpine_version }}/community {% endif -%} {% if testing_enabled -%} {% if alpine_version != 'edge' %} # # Testing - using with non-Edge installation may cause problems! # {% endif %} {{ alpine_baseurl }}/edge/testing {% endif %} {% if local_repo != '' %} # # Local repo # {{ local_repo }}/{{ alpine_version }} {% endif %} """ frequency = PER_INSTANCE distros = ["alpine"] meta: MetaSchema = { "id": "cc_apk_configure", "name": "APK Configure", "title": "Configure apk repositories file", "description": dedent( """\ This module handles configuration of the /etc/apk/repositories file. .. note:: To ensure that apk configuration is valid yaml, any strings containing special characters, especially ``:`` should be quoted. """ ), "distros": distros, "examples": [ dedent( """\ # Keep the existing /etc/apk/repositories file unaltered. apk_repos: preserve_repositories: true """ ), dedent( """\ # Create repositories file for Alpine v3.12 main and community # using default mirror site. apk_repos: alpine_repo: community_enabled: true version: 'v3.12' """ ), dedent( """\ # Create repositories file for Alpine Edge main, community, and # testing using a specified mirror site and also a local repo. apk_repos: alpine_repo: base_url: 'https://some-alpine-mirror/alpine' community_enabled: true testing_enabled: true version: 'edge' local_repo_base_url: 'https://my-local-server/local-alpine' """ ), ], "frequency": frequency, "activate_by_schema_keys": ["apk_repos"], } __doc__ = get_meta_doc(meta) def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None: """ Call to handle apk_repos sections in cloud-config file. @param name: The module name "apk_configure" from cloud.cfg @param cfg: A nested dict containing the entire cloud config contents. @param cloud: The CloudInit object in use. @param log: Pre-initialized Python logger object to use for logging. @param _args: Any module arguments from cloud.cfg """ # If there is no "apk_repos" section in the configuration # then do nothing. apk_section = cfg.get("apk_repos") if not apk_section: LOG.debug( "Skipping module named %s, no 'apk_repos' section found", name ) return # If "preserve_repositories" is explicitly set to True in # the configuration do nothing. if util.get_cfg_option_bool(apk_section, "preserve_repositories", False): LOG.debug( "Skipping module named %s, 'preserve_repositories' is set", name ) return # If there is no "alpine_repo" subsection of "apk_repos" present in the # configuration then do nothing, as at least "version" is required to # create valid repositories entries. alpine_repo = apk_section.get("alpine_repo") if not alpine_repo: LOG.debug( "Skipping module named %s, no 'alpine_repo' configuration found", name, ) return # If there is no "version" value present in configuration then do nothing. alpine_version = alpine_repo.get("version") if not alpine_version: LOG.debug( "Skipping module named %s, 'version' not specified in alpine_repo", name, ) return local_repo = apk_section.get("local_repo_base_url", "") _write_repositories_file(alpine_repo, alpine_version, local_repo) def _write_repositories_file(alpine_repo, alpine_version, local_repo): """ Write the /etc/apk/repositories file with the specified entries. @param alpine_repo: A nested dict of the alpine_repo configuration. @param alpine_version: A string of the Alpine version to use. @param local_repo: A string containing the base URL of a local repo. """ repo_file = "/etc/apk/repositories" alpine_baseurl = alpine_repo.get("base_url", DEFAULT_MIRROR) params = { "alpine_baseurl": alpine_baseurl, "alpine_version": alpine_version, "community_enabled": alpine_repo.get("community_enabled"), "testing_enabled": alpine_repo.get("testing_enabled"), "local_repo": local_repo, } tfile = temp_utils.mkstemp(prefix="template_name-", suffix=".tmpl") template_fn = tfile[1] # Filepath is second item in tuple util.write_file(template_fn, content=REPOSITORIES_TEMPLATE) LOG.debug("Generating Alpine repository configuration file: %s", repo_file) templater.render_to_file(template_fn, repo_file, params) # Clean up temporary template util.del_file(template_fn)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
schemas | Folder | 0755 |
|
|
__init__.py | File | 14 B | 0644 |
|
cc_ansible.py | File | 8.69 KB | 0644 |
|
cc_apk_configure.py | File | 5.66 KB | 0644 |
|
cc_apt_configure.py | File | 41.99 KB | 0644 |
|
cc_apt_pipelining.py | File | 2.71 KB | 0644 |
|
cc_bootcmd.py | File | 2.85 KB | 0644 |
|
cc_byobu.py | File | 3.65 KB | 0644 |
|
cc_ca_certs.py | File | 9.13 KB | 0644 |
|
cc_chef.py | File | 13.77 KB | 0644 |
|
cc_disable_ec2_metadata.py | File | 2.03 KB | 0644 |
|
cc_disk_setup.py | File | 32.36 KB | 0644 |
|
cc_fan.py | File | 3.02 KB | 0644 |
|
cc_final_message.py | File | 3.39 KB | 0644 |
|
cc_growpart.py | File | 21.03 KB | 0644 |
|
cc_grub_dpkg.py | File | 6.65 KB | 0644 |
|
cc_install_hotplug.py | File | 3.81 KB | 0644 |
|
cc_keyboard.py | File | 2.38 KB | 0644 |
|
cc_keys_to_console.py | File | 3.61 KB | 0644 |
|
cc_landscape.py | File | 5.31 KB | 0644 |
|
cc_locale.py | File | 1.86 KB | 0644 |
|
cc_lxd.py | File | 18.14 KB | 0644 |
|
cc_mcollective.py | File | 6.1 KB | 0644 |
|
cc_migrator.py | File | 3.49 KB | 0644 |
|
cc_mounts.py | File | 19.71 KB | 0644 |
|
cc_ntp.py | File | 20.69 KB | 0644 |
|
cc_package_update_upgrade_install.py | File | 4.54 KB | 0644 |
|
cc_phone_home.py | File | 5.48 KB | 0644 |
|
cc_power_state_change.py | File | 7.41 KB | 0644 |
|
cc_puppet.py | File | 14.1 KB | 0644 |
|
cc_reset_rmc.py | File | 4.47 KB | 0644 |
|
cc_resizefs.py | File | 10.73 KB | 0644 |
|
cc_resolv_conf.py | File | 4.98 KB | 0644 |
|
cc_rh_subscription.py | File | 16.97 KB | 0644 |
|
cc_rightscale_userdata.py | File | 4.28 KB | 0644 |
|
cc_rsyslog.py | File | 13.48 KB | 0644 |
|
cc_runcmd.py | File | 2.9 KB | 0644 |
|
cc_salt_minion.py | File | 5.88 KB | 0644 |
|
cc_scripts_per_boot.py | File | 1.66 KB | 0644 |
|
cc_scripts_per_instance.py | File | 1.81 KB | 0644 |
|
cc_scripts_per_once.py | File | 1.76 KB | 0644 |
|
cc_scripts_user.py | File | 1.85 KB | 0644 |
|
cc_scripts_vendor.py | File | 2.29 KB | 0644 |
|
cc_seed_random.py | File | 4.72 KB | 0644 |
|
cc_set_hostname.py | File | 5.13 KB | 0644 |
|
cc_set_passwords.py | File | 10.97 KB | 0644 |
|
cc_snap.py | File | 6.3 KB | 0644 |
|
cc_spacewalk.py | File | 3.43 KB | 0644 |
|
cc_ssh.py | File | 14.86 KB | 0644 |
|
cc_ssh_authkey_fingerprints.py | File | 4.22 KB | 0644 |
|
cc_ssh_import_id.py | File | 6.12 KB | 0644 |
|
cc_timezone.py | File | 1.46 KB | 0644 |
|
cc_ubuntu_advantage.py | File | 17 KB | 0644 |
|
cc_ubuntu_autoinstall.py | File | 4.5 KB | 0644 |
|
cc_ubuntu_drivers.py | File | 4.56 KB | 0644 |
|
cc_update_etc_hosts.py | File | 5.16 KB | 0644 |
|
cc_update_hostname.py | File | 3.87 KB | 0644 |
|
cc_users_groups.py | File | 8.57 KB | 0644 |
|
cc_wireguard.py | File | 9.22 KB | 0644 |
|
cc_write_files.py | File | 6.66 KB | 0644 |
|
cc_write_files_deferred.py | File | 1.68 KB | 0644 |
|
cc_yum_add_repo.py | File | 7.45 KB | 0644 |
|
cc_zypper_add_repo.py | File | 6.59 KB | 0644 |
|
modules.py | File | 11.74 KB | 0644 |
|
schema.py | File | 54.85 KB | 0644 |
|