SWAMPy

✎ CARVE FLESH

EDITING: cc_apt_pipelining.py

# Copyright (C) 2011 Canonical Ltd.
#
# Author: Ben Howard <ben.howard@canonical.com>
#
# This file is part of cloud-init. See LICENSE file for license information.

"""
Apt Pipelining
--------------
**Summary:** configure apt pipelining

This module configures apt's ``Acquite::http::Pipeline-Depth`` option, which
controls how apt handles HTTP pipelining. It may be useful for pipelining to be
disabled, because some web servers, such as S3 do not pipeline properly (LP:
#948461). The ``apt_pipelining`` config key may be set to ``false`` to disable
pipelining altogether. This is the default behavior. If it is set to ``none``,
``unchanged``, or ``os``, no change will be made to apt configuration and the
default setting for the distro will be used. The pipeline depth can also be
manually specified by setting ``apt_pipelining`` to a number. However, this is
not recommended.

**Internal name:** ``cc_apt_pipelining``

**Module frequency:** per instance

**Supported distros:** ubuntu, debian

**Config keys**::
    apt_pipelining: <false/none/unchanged/os/number>
"""

from cloudinit.settings import PER_INSTANCE
from cloudinit import util

frequency = PER_INSTANCE

distros = ['ubuntu', 'debian']

DEFAULT_FILE = "/etc/apt/apt.conf.d/90cloud-init-pipelining"

APT_PIPE_TPL = ("//Written by cloud-init per 'apt_pipelining'\n"
                'Acquire::http::Pipeline-Depth "%s";\n')

# Acquire::http::Pipeline-Depth can be a value
# from 0 to 5 indicating how many outstanding requests APT should send.
# A value of zero MUST be specified if the remote host does not properly linger
# on TCP connections - otherwise data corruption will occur.

def handle(_name, cfg, _cloud, log, _args):

apt_pipe_value = util.get_cfg_option_str(cfg, "apt_pipelining", 'os')
    apt_pipe_value_s = str(apt_pipe_value).lower().strip()

if apt_pipe_value_s == "false":
        write_apt_snippet("0", log, DEFAULT_FILE)
    elif apt_pipe_value_s in ("none", "unchanged", "os"):
        return
    elif apt_pipe_value_s in [str(b) for b in range(0, 6)]:
        write_apt_snippet(apt_pipe_value_s, log, DEFAULT_FILE)
    else:
        log.warning("Invalid option for apt_pipelining: %s", apt_pipe_value)

def write_apt_snippet(setting, log, f_name):
    """Writes f_name with apt pipeline depth 'setting'."""

file_contents = APT_PIPE_TPL % (setting)
    util.write_file(f_name, file_contents)
    log.debug("Wrote %s with apt pipeline depth setting %s", f_name, setting)

# vi: ts=4 expandtab

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __pycache__/	DIR	—	2026-02-25 16:32
📄 __init__.py	PY	1.4 KB	2021-03-19 14:37	EDIT
📄 cc_apk_configure.py	PY	9.3 KB	2021-03-19 14:37	EDIT
📄 cc_apt_configure.py	PY	39.9 KB	2021-03-19 14:37	EDIT
📄 cc_apt_pipelining.py	PY	2.4 KB	2021-03-19 14:37	EDIT
📄 cc_bootcmd.py	PY	3.5 KB	2021-03-19 14:37	EDIT
📄 cc_byobu.py	PY	3.1 KB	2021-03-19 14:37	EDIT
📄 cc_ca_certs.py	PY	6.4 KB	2021-03-19 14:37	EDIT
📄 cc_chef.py	PY	23.6 KB	2021-03-19 14:37	EDIT
📄 cc_debug.py	PY	3.1 KB	2021-03-19 14:37	EDIT
📄 cc_disable_ec2_metadata.py	PY	1.6 KB	2021-03-19 14:37	EDIT
📄 cc_disk_setup.py	PY	33.1 KB	2021-03-19 14:37	EDIT
📄 cc_emit_upstart.py	PY	2 KB	2021-03-19 14:37	EDIT
📄 cc_fan.py	PY	2.9 KB	2021-03-19 14:37	EDIT
📄 cc_final_message.py	PY	2.4 KB	2021-03-19 14:37	EDIT
📄 cc_foo.py	PY	2.1 KB	2021-03-19 14:37	EDIT
📄 cc_growpart.py	PY	11.6 KB	2021-03-19 14:37	EDIT
📄 cc_grub_dpkg.py	PY	4.9 KB	2021-03-19 14:37	EDIT
📄 cc_keys_to_console.py	PY	2.8 KB	2021-03-19 14:37	EDIT
📄 cc_landscape.py	PY	4 KB	2021-03-19 14:37	EDIT
📄 cc_locale.py	PY	2.2 KB	2021-03-19 14:37	EDIT
📄 cc_lxd.py	PY	10.5 KB	2021-03-19 14:37	EDIT
📄 cc_mcollective.py	PY	5.1 KB	2021-03-19 14:37	EDIT
📄 cc_migrator.py	PY	3.1 KB	2021-03-19 14:37	EDIT
📄 cc_mounts.py	PY	17.7 KB	2021-03-19 14:37	EDIT
📄 cc_ntp.py	PY	21.6 KB	2021-03-19 14:37	EDIT
📄 cc_package_update_upgrade_install.py	PY	4.1 KB	2021-03-19 14:37	EDIT
📄 cc_phone_home.py	PY	4 KB	2021-03-19 14:37	EDIT
📄 cc_power_state_change.py	PY	7.5 KB	2021-03-19 14:37	EDIT
📄 cc_puppet.py	PY	8.9 KB	2021-03-19 14:37	EDIT
📄 cc_refresh_rmc_and_interface.py	PY	5.1 KB	2021-03-19 14:37	EDIT
📄 cc_reset_rmc.py	PY	4.1 KB	2021-03-19 14:37	EDIT
📄 cc_resizefs.py	PY	9.7 KB	2021-03-19 14:37	EDIT
📄 cc_resolv_conf.py	PY	3.4 KB	2021-03-19 14:37	EDIT
📄 cc_rh_subscription.py	PY	15.7 KB	2021-03-19 14:37	EDIT
📄 cc_rightscale_userdata.py	PY	3.7 KB	2021-03-19 14:37	EDIT
📄 cc_rsyslog.py	PY	14.1 KB	2021-03-19 14:37	EDIT
📄 cc_runcmd.py	PY	3.1 KB	2021-03-19 14:37	EDIT
📄 cc_salt_minion.py	PY	4.7 KB	2021-03-19 14:37	EDIT
📄 cc_scripts_per_boot.py	PY	1.2 KB	2021-03-19 14:37	EDIT
📄 cc_scripts_per_instance.py	PY	1.4 KB	2021-03-19 14:37	EDIT
📄 cc_scripts_per_once.py	PY	1.3 KB	2021-03-19 14:37	EDIT
📄 cc_scripts_user.py	PY	1.4 KB	2021-03-19 14:37	EDIT
📄 cc_scripts_vendor.py	PY	1.4 KB	2021-03-19 14:37	EDIT
📄 cc_seed_random.py	PY	4.6 KB	2021-03-19 14:37	EDIT
📄 cc_set_hostname.py	PY	3.4 KB	2021-03-19 14:37	EDIT
📄 cc_set_passwords.py	PY	8.5 KB	2021-03-19 14:37	EDIT
📄 cc_snap.py	PY	8.7 KB	2021-03-19 14:37	EDIT
📄 cc_spacewalk.py	PY	2.9 KB	2021-03-19 14:37	EDIT
📄 cc_ssh.py	PY	12.8 KB	2021-03-19 14:37	EDIT
📄 cc_ssh_authkey_fingerprints.py	PY	3.4 KB	2021-03-19 14:37	EDIT
📄 cc_ssh_import_id.py	PY	2.9 KB	2021-03-19 14:37	EDIT
📄 cc_timezone.py	PY	1.1 KB	2021-03-19 14:37	EDIT
📄 cc_ubuntu_advantage.py	PY	6.1 KB	2025-07-28 18:21	EDIT
📄 cc_ubuntu_drivers.py	PY	5.7 KB	2021-03-19 14:37	EDIT
📄 cc_update_etc_hosts.py	PY	3.3 KB	2021-03-19 14:37	EDIT
📄 cc_update_hostname.py	PY	1.6 KB	2021-03-19 14:37	EDIT
📄 cc_users_groups.py	PY	7.4 KB	2021-03-19 14:37	EDIT
📄 cc_write_files.py	PY	8.8 KB	2021-03-19 14:37	EDIT
📄 cc_yum_add_repo.py	PY	4.2 KB	2021-03-19 14:37	EDIT
📄 cc_zypper_add_repo.py	PY	7.6 KB	2021-03-19 14:37	EDIT
📄 schema.py	PY	19.1 KB	2021-03-19 14:37	EDIT