Example usages of the new `deb822_repository` Ansible module

apt-repo-playbook.yaml

---
- hosts: localhost
  connection: local
  gather_facts: true

  tasks:
    - name: Add APT repositories
      when: ansible_os_family == 'Debian'
      become: true
      block:
        - name: Add VSCode APT repository
          ansible.builtin.deb822_repository:
            name: vscode
            types: [deb]
            uris: "https://packages.microsoft.com/repos/code"
            signed_by: "https://packages.microsoft.com/keys/microsoft.asc"
            suites: [stable]
            components: [main]
            state: present
            enabled: yes

      - name: Add google APT repository
        ansible.builtin.deb822_repository:
          name: google
          types: [deb]
          uris:
            - "http://dl.google.com/linux/chrome/deb"
            - "http://dl.google.com/linux/earth/deb"
          signed_by: "https://dl.google.com/linux/linux_signing_key.pub"
          suites: [stable]
          components: [main]
          state: present
          enabled: yes

        - name: Add Kubernetes APT repository
          ansible.builtin.deb822_repository:
            name: kubernetes
            types: [deb]
            uris: "https://apt.kubernetes.io"
            signed_by: "https://packages.cloud.google.com/apt/doc/apt-key.gpg"
            suites: [kubernetes-xenial]
            components: [main]
            state: present
            enabled: yes

        - name: Add google-cloud-cli APT repository
          ansible.builtin.deb822_repository:
            name: google-cloud-cli
            types: [deb]
            uris: "https://packages.cloud.google.com/apt"
            signed_by: "https://packages.cloud.google.com/apt/doc/apt-key.gpg"
            suites: [cloud-sdk]
            components: [main]
            state: present
            enabled: yes

        - name: Add Microsoft prod APT repository (Debian)
          when: ansible_distribution == 'Debian'
          ansible.builtin.deb822_repository:
            name: packages-microsoft-com-prod
            types: [deb]
            uris: "https://packages.microsoft.com/{{ ansible_distribution|lower }}/{{ ansible_distribution_major_version }}/prod"
            signed_by: "https://packages.microsoft.com/keys/microsoft.asc"
            suites: ["{{ ansible_distribution_release|lower }}"]
            components: [main]
            state: present
            enabled: yes
            
        - name: Add Microsoft prod APT repository (Ubuntu)
          when: ansible_distribution == 'Ubuntu'
          ansible.builtin.deb822_repository:
            name: packages-microsoft-com-prod
            types: [deb]
            uris: "https://packages.microsoft.com/{{ ansible_distribution|lower }}/{{ ansible_distribution_version }}/prod"
            signed_by: "https://packages.microsoft.com/keys/microsoft.asc"
            suites: ["{{ ansible_distribution_release|lower }}"]
            components: [main]
            state: present
            enabled: yes

        - name: Add Tailscale stable APT repository
          ansible.builtin.deb822_repository:
            name: tailscale-stable
            types: [deb]
            uris: "https://pkgs.tailscale.com/stable/{{ ansible_distribution|lower }}"
            signed_by: "https://pkgs.tailscale.com/stable/{{ ansible_distribution|lower }}/{{ ansible_distribution_release|lower }}.asc"
            suites: ["{{ ansible_distribution_release|lower }}"]
            components: [main]
            state: present
            enabled: yes

        - name: Add Hashicorp Stable APT repository
          ansible.builtin.deb822_repository:
            name: hashicorp
            types: [deb]
            uris: "https://apt.releases.hashicorp.com"
            signed_by: "https://apt.releases.hashicorp.com/gpg"
            suites: ["{{ ansible_distribution_release|lower }}"]
            components: [main]
            state: present
            enabled: yes

NOTE: Requires Ansible-core 2.15+ (Ansible 8.0+)

    - name: Add Docker Module Repository
      ansible.builtin.deb822_repository:
        name: docker
        types: [deb]
        uris: "https://download.docker.com/linux/{{ ansible_distribution | lower }}"
        signed_by: "https://download.docker.com/linux/{{ ansible_distribution | lower }}/gpg"
        suites: ["{{ ansible_distribution_release | lower }}"]
        components: [stable]
        state: present
        enabled: yes

- name: Add Proxmox Repository.
  ansible.builtin.deb822_repository:
    name: proxmox
    types: [deb]
    architectures: amd64
    uris: "http://download.proxmox.com/{{ ansible_distribution | lower }}/pve"
    signed_by: "https://enterprise.proxmox.com/{{ ansible_distribution | lower }}/proxmox-release-{{ ansible_distribution_release | lower }}.gpg"
    suites: ["{{ ansible_distribution_release | lower }}"]
    components: [pve-no-subscription]
    state: present
    enabled: true

- name: Add Gitlab Repository.
  ansible.builtin.deb822_repository:
    name: gitlab
    types: [deb]
    uris: "https://packages.gitlab.com/gitlab/gitlab-ee/{{ ansible_distribution | lower }}"
    signed_by: "https://packages.gitlab.com/gitlab/gitlab-ee/gpgkey"
    suites: ["{{ ansible_distribution_release | lower }}"]
    components: [main]
    state: present
    enabled: true

- name: Add Gitlab Runner Repository.
  ansible.builtin.deb822_repository:
    name: gitlab-runner
    types: [deb]
    uris: "https://packages.gitlab.com/runner/gitlab-runner/{{ ansible_distribution | lower }}"
    signed_by: "https://packages.gitlab.com/runner/gitlab-runner/gpgkey"
    suites: ["{{ ansible_distribution_release | lower }}"]
    components: [main]
    state: present
    enabled: true

Here's how to translate installation instructions that only provide the old one-line-style source format into the new format. The old source format looks like this:

deb [signed-by=/usr/share/keyrings/example.gpg] https://example.com/dev foo bar

Here https://example.com/dev should go into uris, foo should go into suites, and bar should go into components. The path for signed-by should be ignored as the deb822_repository module figures out the path based on where it downloads the key to.

Hope this helps someone :)

The example kubernetes repo is frozen and everything moved to a none google hosted location. Can it be updated?

The example kubernetes repo is frozen and everything moved to a none google hosted location. Can it be updated?

I also had to solve this issue. This works:

      - name: Add Kubernetes APT repository
        ansible.builtin.deb822_repository:
          name: kubernetes
          types: [deb]
          uris: "https://pkgs.k8s.io/core:/stable:/v1.29/deb/"
          signed_by: "https://pkgs.k8s.io/core:/stable:/v1.29/deb/Release.key"
          suites: [/]
          state: present
          enabled: yes

NOTE: Replace v1.29 with the Kubernetes version you need.

Above docker example didn't work for me. Kept getting this error:
Malformed entry 1 in sources file /etc/apt/sources.list.d/docker.sources (Component), E:The list of sources could not be read

Had to change it to this:
- name: Add docker APT repository ansible.builtin.deb822_repository: name: docker types: [ deb ] uris: "https://download.docker.com/linux/ubuntu" signed_by: "https://download.docker.com/linux/ubuntu/gpg" suites: "{{ ansible_distribution_release }}" components: stable state: present enabled: yes

Above docker example didn't work for me. Kept getting this error: Malformed entry 1 in sources file /etc/apt/sources.list.d/docker.sources (Component), E:The list of sources could not be read

I tested the Docker task by @Sprout9 above, it works on my test. I would need to see what the output is of /etc/apt/sources.list.d/ to know what issue you faced.

However, make sure you have set gather_facts: true. Your fix does not use facts and instead references "ubuntu" directly. This is valid, however there is an advantage in using facts: the same task can work on multiple different distributions.

For reference, this is the task I use to setup the Docker repository on my personal machines and in production servers (I personally tested it on Debian 11, Debian 12, Ubuntu 22.04 LTS and Ubuntu 24.04 LTS):

- name: Add Docker APT repository
  ansible.builtin.deb822_repository:
    name: docker
    state: present
    types: [deb]
    uris: "https://download.docker.com/linux/{{ ansible_distribution|lower }}"
    suites: ["{{ ansible_distribution_release|lower }}"]
    components: [stable]
    signed_by: "https://download.docker.com/linux/debian/gpg"
    enabled: yes