Documentation

    PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.19

    Documentation for other releases can be found by using the version selector in the top right of any doc page.

    debootstrap

    Install a minimal Debian/Ubuntu base system into a directory using debootstrap.

    Attributes

    check_mode:
      support: full
    

    Parameters

    Parameter Required Type Values Description
    arch   string   Architecture for the installation (e.g., amd64, arm64).
    components   array   Components to include in the installation. [default: ["main"]]
    exclude   string   Comma-separated list of packages to exclude.
    executable   string   Path of the debootstrap binary to use. [default: "debootstrap"]
    include   string   Comma-separated list of packages to include.
    keep_debootstrap_dir   boolean   Keep /debootstrap directory after installation. [default: false]
    keyring   string   Path to keyring file for archive signing keys.
    mirror   string   Archive mirror URL (e.g., http://archive.ubuntu.com/ubuntu).
    no_check_gpg   boolean   Skip GPG signature verification. [default: false]
    no_resolve_deps   boolean   Don’t resolve dependencies. [default: false]
    second_stage   boolean   Run second stage after first stage (for foreign architectures). [default: false]
    second_stage_target   string   Target directory for second stage (for foreign architectures).
    suite true string   Distribution codename (e.g., noble, jammy, bookworm, bullseye).
    target true string   Target directory for the base system installation.
    unpack_tarball   string   Extract from tarball instead of downloading.
    variant   string minbase
    buildd
    fakechroot
    scratch
    Bootstrap variant to use. [default: "minbase"]

    Example

    - name: Install Ubuntu Noble base system
      debootstrap:
        target: /mnt
        suite: noble
        mirror: http://archive.ubuntu.com/ubuntu
        arch: amd64
        variant: minbase
        components:
          - main
          - universe
        include:
          - linux-image-generic
          - locales
          - sudo
          - openssh-server
    
    - name: Install from Hetzner image tarball
      debootstrap:
        target: /mnt
        suite: noble
        unpack_tarball: /root/.oldroot/nfs/images/Ubuntu-2404-noble-amd64-base.tar.gz
    
    - name: Install Debian Bookworm
      debootstrap:
        target: /mnt
        suite: bookworm
        mirror: http://deb.debian.org/debian
        variant: minbase
    
    - name: Run second stage for foreign architecture
      debootstrap:
        target: /mnt
        suite: noble
        second_stage: true
        second_stage_target: /mnt