Pyaptly

Automates the creation and managment of aptly mirrors and snapshots based on toml input files.

Important: Currently under heavy development:

• For for the old version switch to the master branch

• Main branch builds contain alpha packages, see Artifacts

Why & How

Aptly is great tool for creating Debian repositories. But as soon as it’s required to maintain repositories for different environments it gets very complicated fast.

This is where Pyaptly comes in. First of all, a single config.toml can be used to define mirrors, snapshots and publishes instead of using command line arguments. The definition includes exactly how the entities are created and updated.

Secondly, aptly isn’t really layed out to have retention policies. Updating a snapshot will lose the information of the previous state. That means it’s hard to roll back to a previous state if required. This problem is fixed by using fix timestamps in snapshot names. That behaviour also allows to define a fixed update spacing. It’s possible to say for example “only update this snapshot once a week”.

Example commands

Initialize a new aptly server.

pyaptly mirror mirrors.toml create
pyaptly mirror mirrors.toml update
pyaptly snapshot mirrors.toml create
pyaptly publish mirrors.toml create

Update mirrors and snapshots and switch publish endpoints with automatic-update: true to the new snapshots.

pyaptly mirror mirrors.toml update
pyaptly snapshot mirrors.toml create
pyaptly publish mirrors.toml create
pyaptly publish mirrors.toml update

Manually trigger a switch to the new snapshots for the publish endpoint ubuntu/stable.

pyaptly publish mirrors.toml update -n ubuntu/stable

Debugging

The most interesting mode for users is not --debug but --info which shows all commands executed.

> pyaptly legacy -- --info --config pyaptly/tests/repo.toml repo create
Command call
  cmd:         gpg --no-default-keyring --keyring trustedkeys.gpg --list-keys --with-colons -> 0
  stdout:     'tru::1:1709575833:0:3:1:5
               pub:-:255:22:2841988729C7F3FF:1701882080:::-:::scESC:::::ed25519:::0:
               fpr:::::::::6380C07FF6496016E01CF4522841988729C7F3FF:
               uid:-::::1701882080::5BBE9C7E7AA5EEE3538F66274125D69FA727FD1E::Pyaptly Test 01 <test01@pyaptly.nowhere>::::::::::0:
               sub:-:255:18:0A1CBEF26FE4F36E:1701882080::::::e:::::cv25519::
               fpr:::::::::9EE64E40A5E3530D3E18A97C0A1CBEF26FE4F36E:
               pub:-:255:22:EC54D33E5B5EBE98:1701882297:::-:::scESC:::::ed25519:::0:
               fpr:::::::::660D45228AB6B59CCE48AFB3EC54D33E5B5EBE98:
               uid:-::::1701882297::F3EF71B78669C0FC259A4078151BDC5815A6015D::Pyaptly Test 02 <test02@pyaptly.nowhere>::::::::::0:
               sub:-:255:18:042FE0F5BB743B60:1701882297::::::e:::::cv25519::
               fpr:::::::::AE58B62134E02AF8E5D55FF4042FE0F5BB743B60:'
Command call
  cmd:         aptly repo list -raw -> 0
  stderr:     'Config file not found, creating default config at /root/.aptly.conf'
Command call
  cmd:         aptly mirror list -raw -> 0
Command call
  cmd:         aptly snapshot list -raw -> 0
Command call
  cmd:         aptly publish list -raw -> 0
Command call
  cmd:         aptly repo -architectures=amd64,i386 -distribution=stable -component=main create centrify -> 0
  stdout:     'Local repo [centrify] successfully added.
               You can run 'aptly repo add centrify ...' to add packages to repository.'

Commands that fail are always displayed in red on a tty, but that actually only happens if something is broken.

Contents:

• Pyaptly
  • Why & How
  • Example commands
  • Debugging
• Getting Started
  • Installation
  • Aptly Mirror
    • updating mirrors
  • Snapshots
    • Basic snapshots
    • Snapshots with retention
  • Publish
• Pyaptly Configuration Schema
  • Properties
  • Definitions
  • Examples
• Command Line Reference
  • pyaptly
    • Usage
    • Options
    • CLI Help
  • pyaptly legacy
    • Usage
    • Options
    • CLI Help
  • pyaptly mirror
    • Usage
    • Options
    • CLI Help
  • pyaptly publish
    • Usage
    • Options
    • CLI Help
  • pyaptly repo
    • Usage
    • Options
    • CLI Help
  • pyaptly snapshot
    • Usage
    • Options
    • CLI Help
  • pyaptly toml-to-toml
    • Usage
    • Options
    • CLI Help
  • pyaptly yaml-to-toml
    • Usage
    • Options
    • CLI Help
• Code Reference
  • Main
    • main()
    • prepare()
    • setup_logger()
  • Mirror
    • add_gpg_keys()
    • cmd_mirror_create()
    • cmd_mirror_update()
    • mirror()
  • Repo
    • repo()
    • repo_cmd_create()
  • Snapshot
    • clone_snapshot()
    • cmd_snapshot_create()
    • cmd_snapshot_update()
    • dependents_of_snapshot()
    • rotate_snapshot()
    • snapshot()
    • snapshot_spec_to_name()
  • Publish
    • publish()
    • publish_cmd_create()
    • publish_cmd_update()
  • State Reader
    • SystemStateReader
  • Util
    • PyaptlyCliError
    • format_run_result()
    • get_default_keyserver()
    • indent_out()
    • parse_aptly_show_command()
    • run_command()
    • unit_or_list_to_list()

PyAptly automates the creation and managment of aptly mirrors and snapshots.

Configuration is based on toml input files.

pyaptly.init_hypothesis()

Initialize hypothesis profile if hypothesis is available.