REDROOM

Navigation

Breadcrumbs

/ / lib / python3.6 / site-packages / cloudinit / config

Create

Create File | Create Folder | Upload Files | Run Command

Preview: cc_apt_pipelining.py Size: 2.71 KB

/lib/python3.6/site-packages/cloudinit/config/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: configure apt pipelining."""

import logging
from textwrap import dedent

from cloudinit import 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__)

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.

meta: MetaSchema = {
    "id": "cc_apt_pipelining",
    "name": "Apt Pipelining",
    "title": "Configure apt pipelining",
    "description": dedent(
        """\
        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).

        Value configuration options for this module are:

        * ``os``: (Default) use distro default
        * ``false`` disable pipelining altogether
        * ``<number>``: Manually specify pipeline depth. This is not recommended."""  # noqa: E501
    ),
    "distros": distros,
    "frequency": frequency,
    "examples": [
        "apt_pipelining: false",
        "apt_pipelining: os",
        "apt_pipelining: 3",
    ],
    "activate_by_schema_keys": ["apt_pipelining"],
}

__doc__ = get_meta_doc(meta)


def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None:
    apt_pipe_value = cfg.get("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)

Directory Contents

Dirs: 2 × Files: 64

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
schemas DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
cc_ansible.py	8.69 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apk_configure.py	5.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_configure.py	41.99 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_pipelining.py	2.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_bootcmd.py	2.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_byobu.py	3.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ca_certs.py	9.13 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_chef.py	13.77 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disable_ec2_metadata.py	2.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disk_setup.py	32.36 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_fan.py	3.02 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_final_message.py	3.39 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_growpart.py	21.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_grub_dpkg.py	6.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_install_hotplug.py	3.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keyboard.py	2.38 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keys_to_console.py	3.61 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_landscape.py	5.31 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_locale.py	1.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_lxd.py	18.14 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mcollective.py	6.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_migrator.py	3.49 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mounts.py	19.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ntp.py	20.84 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_package_update_upgrade_install.py	4.54 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_phone_home.py	5.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_power_state_change.py	7.41 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_puppet.py	14.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_reset_rmc.py	4.47 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resizefs.py	10.73 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resolv_conf.py	4.98 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rh_subscription.py	16.97 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rightscale_userdata.py	4.28 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_rsyslog.py	13.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_runcmd.py	2.90 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_salt_minion.py	5.88 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_boot.py	1.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_instance.py	1.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_once.py	1.76 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_user.py	1.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_vendor.py	2.29 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_seed_random.py	4.72 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_hostname.py	5.13 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_passwords.py	10.97 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_snap.py	6.30 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_spacewalk.py	3.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh.py	14.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_authkey_fingerprints.py	4.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_import_id.py	6.12 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_timezone.py	1.46 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_advantage.py	17.00 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_autoinstall.py	4.50 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_drivers.py	4.56 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_etc_hosts.py	5.16 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_hostname.py	3.87 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_users_groups.py	8.57 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_wireguard.py	9.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files.py	6.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files_deferred.py	1.68 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_yum_add_repo.py	7.45 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_zypper_add_repo.py	6.59 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
modules.py	11.74 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
schema.py	54.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
__init__.py	14 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive