bootstrap/config.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (C) Catalyst.Net Ltd 2019
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 """
  19 Manage dependencies and bootstrap environments for Samba.
  20
  21 Config file for packages and templates.
  22
  23 Update the lists in this file to require new packages in the
  24 container images used in GitLab CI
  25
  26 Author: Joe Guo <joeg@catalyst.net.nz>
  27 """
  28 import os
  29 from os.path import abspath, dirname, join
  30 HERE = abspath(dirname(__file__))
  31 # output dir for rendered files
  32 OUT = join(HERE, 'generated-dists')
  33
  34
  35 # pkgs with same name in all packaging systems
  36 COMMON = [
  37     'acl',
  38     'attr',
  39     'autoconf',
  40     'binutils',
  41     'bison',
  42     'ccache',
  43     'curl',
  44     'chrpath',
  45     'flex',
  46     'gcc',
  47     'gdb',
  48     'git',
  49     'gzip',
  50     'hostname',
  51     'htop',
  52     'jq',
  53     'lcov',
  54     'make',
  55     'patch',
  56     'perl',
  57     'psmisc',  # for pstree in test
  58     'rng-tools',
  59     'rsync',
  60     'sed',
  61     'sudo',  # docker images has no sudo by default
  62     'tar',
  63     'tree',
  64     'wget',
  65 ]
  66
  67
  68 # define pkgs for all packaging systems in parallel
  69 # make it easier to find missing ones
  70 # use latest ubuntu and fedora as defaults
  71 # deb, rpm, ...
  72 PKGS = [
  73     # NAME1-dev, NAME2-devel
  74     ('lmdb-utils', 'lmdb'),
  75     ('mingw-w64', 'mingw64-gcc'),
  76     ('zlib1g-dev', 'zlib-devel'),
  77     ('libbsd-dev', 'libbsd-devel'),
  78     ('liburing-dev', 'liburing-devel'),
  79     ('libarchive-dev', 'libarchive-devel'),
  80     ('libblkid-dev', 'libblkid-devel'),
  81     ('libcap-dev', 'libcap-devel'),
  82     ('libacl1-dev', 'libacl-devel'),
  83     ('libattr1-dev', 'libattr-devel'),
  84
  85     # libNAME1-dev, NAME2-devel
  86     ('libpopt-dev', 'popt-devel'),
  87     ('libreadline-dev', 'readline-devel'),
  88     ('libjansson-dev', 'jansson-devel'),
  89     ('liblmdb-dev', 'lmdb-devel'),
  90     ('libncurses5-dev', 'ncurses-devel'),
  91     # NOTE: Debian 7+ or Ubuntu 16.04+
  92     ('libsystemd-dev', 'systemd-devel'),
  93     ('libkrb5-dev', 'krb5-devel'),
  94     ('libldap2-dev', 'openldap-devel'),
  95     ('libcups2-dev', 'cups-devel'),
  96     ('libpam0g-dev', 'pam-devel'),
  97     ('libgpgme11-dev', 'gpgme-devel'),
  98     # NOTE: Debian 8+ and Ubuntu 14.04+
  99     ('libgnutls28-dev', 'gnutls-devel'),
 100     ('gnutls-bin', 'gnutls-utils'),
 101     ('libtasn1-bin', 'libtasn1-tools'),
 102     ('libtasn1-dev', 'libtasn1-devel'),
 103     ('', 'quota-devel'),
 104     ('uuid-dev', 'libuuid-devel'),
 105     ('libjs-jquery', ''),
 106     ('libavahi-common-dev', 'avahi-devel'),
 107     ('libdbus-1-dev', 'dbus-devel'),
 108     ('libpcap-dev', 'libpcap-devel'),
 109     ('libunwind-dev', 'libunwind-devel'),  # for back trace
 110     ('libglib2.0-dev', 'glib2-devel'),
 111     ('libicu-dev', 'libicu-devel'),
 112     ('heimdal-multidev', ''),
 113
 114     # NAME1, NAME2
 115     # for debian, locales provide locale support with language packs
 116     # ubuntu split language packs to language-pack-xx
 117     # for centos, glibc-common provide locale support with language packs
 118     # fedora split language packs  to glibc-langpack-xx
 119     ('locales', 'glibc-common'),  # required for locale
 120     ('language-pack-en', 'glibc-langpack-en'),  # we need en_US.UTF-8
 121     ('bind9utils', 'bind-utils'),
 122     ('dnsutils', ''),
 123     ('xsltproc', 'libxslt'),
 124     ('krb5-user', 'krb5-workstation'),
 125     ('krb5-config', ''),
 126     ('krb5-kdc', 'krb5-server'),
 127     ('apt-utils', 'yum-utils'),
 128     ('pkg-config', 'pkgconfig'),
 129     ('procps', 'procps-ng'),  # required for the free cmd in tests
 130     ('lsb-release', 'lsb-release'),  # we need lsb_release to show info
 131     ('', 'rpcgen'),  # required for test
 132     # refer: https://fedoraproject.org/wiki/Changes/SunRPCRemoval
 133     ('', 'libtirpc-devel'),  # for <rpc/rpc.h> header on fedora
 134     ('', 'rpcsvc-proto-devel'), # for <rpcsvc/rquota.h> header
 135     ('mawk', 'gawk'),
 136     ('', 'mold'),
 137     ('', 'ShellCheck'),
 138     ('', 'shfmt'),
 139     ('', 'crypto-policies-scripts'),
 140
 141     ('python3', 'python3'),
 142     ('python3-cryptography', 'python3-cryptography'), # for krb5 tests
 143     ('python3-dev', 'python3-devel'),
 144     ('python3-dbg', ''),
 145     ('python3-iso8601', 'python3-iso8601'),
 146     ('python3-gpg', 'python3-gpg'),  # defaults to ubuntu/fedora latest
 147     ('python3-markdown', 'python3-markdown'),
 148     ('python3-dnspython', 'python3-dns'),
 149     ('python3-pexpect', ''),  # for wintest only
 150     ('python3-pyasn1', 'python3-pyasn1'), # for krb5 tests
 151     ('python3-setproctitle', 'python3-setproctitle'),
 152     ('python3-requests', 'python3-requests'), # for cert auto enroll
 153
 154     ('', 'python3-libsemanage'),
 155     ('', 'python3-policycoreutils'),
 156
 157     # perl
 158     ('libparse-yapp-perl', 'perl-Parse-Yapp'),
 159     ('libjson-perl', 'perl-JSON'),
 160     ('', 'perl-JSON-Parse'),
 161     ('perl-modules', ''),
 162     ('', 'perl-FindBin'),
 163     ('', 'perl-Archive-Tar'),
 164     ('', 'perl-ExtUtils-MakeMaker'),
 165     ('', 'perl-Test-Base'),
 166     ('', 'perl-generators'),
 167     ('', 'perl-interpreter'),
 168
 169     # fs
 170     ('xfslibs-dev', 'xfsprogs-devel'), # for xfs quota support
 171     ('', 'glusterfs-api-devel'),
 172     ('glusterfs-common', 'glusterfs-devel'),
 173     ('libcephfs-dev', 'libcephfs-devel'),
 174
 175     # spotlight
 176     ('libtracker-sparql-2.0-dev', 'tracker-devel'),
 177
 178     # misc
 179     # @ means group for rpm, use fedora as rpm default
 180     ('build-essential', '@development-tools'),
 181     ('debhelper', ''),
 182     # rpm has no pkg for docbook-xml
 183     ('docbook-xml', 'docbook-dtds'),
 184     ('docbook-xsl', 'docbook-style-xsl'),
 185     ('libkeyutils-dev', 'keyutils-libs-devel'),
 186     ('', 'which'),
 187     ('xz-utils', 'xz')
 188 ]
 189
 190
 191 DEB_PKGS = COMMON + [pkg for pkg, _ in PKGS if pkg]
 192 RPM_PKGS = COMMON + [pkg for _, pkg in PKGS if pkg]
 193
 194 GENERATED_MARKER = r"""
 195 #
 196 # This file is generated by 'bootstrap/template.py --render'
 197 # See also bootstrap/config.py
 198 #
 199 """
 200
 201
 202 APT_BOOTSTRAP = r"""
 203 #!/bin/bash
 204 {GENERATED_MARKER}
 205 set -xueo pipefail
 206
 207 export DEBIAN_FRONTEND=noninteractive
 208 apt-get -y update
 209
 210 apt-get -y install \
 211     {pkgs}
 212
 213 apt-get -y autoremove
 214 apt-get -y autoclean
 215 apt-get -y clean
 216 """
 217
 218
 219 YUM_BOOTSTRAP = r"""
 220 #!/bin/bash
 221 {GENERATED_MARKER}
 222 set -xueo pipefail
 223
 224 yum update -y
 225 yum install -y epel-release
 226 yum install -y yum-plugin-copr
 227 yum copr enable -y sergiomb/SambaAD
 228 yum update -y
 229
 230 yum install -y \
 231     {pkgs}
 232
 233 yum clean all
 234
 235 if [ ! -f /usr/bin/python3 ]; then
 236     ln -sf /usr/bin/python3.6 /usr/bin/python3
 237 fi
 238 """
 239
 240 CENTOS8S_YUM_BOOTSTRAP = r"""
 241 #!/bin/bash
 242 {GENERATED_MARKER}
 243 set -xueo pipefail
 244
 245 yum update -y
 246 yum install -y dnf-plugins-core
 247 yum install -y epel-release
 248
 249 yum -v repolist all
 250 yum config-manager --set-enabled powertools -y
 251
 252 yum update -y
 253
 254 yum install -y \
 255     --setopt=install_weak_deps=False \
 256     {pkgs}
 257
 258 yum clean all
 259 """
 260
 261 DNF_BOOTSTRAP = r"""
 262 #!/bin/bash
 263 {GENERATED_MARKER}
 264 set -xueo pipefail
 265
 266 dnf update -y
 267
 268 dnf install -y \
 269     --setopt=install_weak_deps=False \
 270     {pkgs}
 271
 272 dnf clean all
 273
 274 update-crypto-policies --set DEFAULT:AD-SUPPORT
 275 """
 276
 277 DNF_BOOTSTRAP_MIT = r"""
 278 #!/bin/bash
 279 {GENERATED_MARKER}
 280 set -xueo pipefail
 281
 282 dnf update -y
 283 dnf install -y dnf-plugins-core
 284 dnf copr -y enable abbra/krb5-test
 285 dnf update -y
 286
 287 dnf install -y \
 288     --setopt=install_weak_deps=False \
 289     {pkgs}
 290
 291 dnf clean all
 292 """
 293
 294 ZYPPER_BOOTSTRAP = r"""
 295 #!/bin/bash
 296 {GENERATED_MARKER}
 297 set -xueo pipefail
 298
 299 zypper --non-interactive refresh
 300 zypper --non-interactive update
 301 zypper --non-interactive install \
 302     --no-recommends \
 303     system-user-nobody \
 304     {pkgs}
 305
 306 zypper --non-interactive clean
 307
 308 if [ -f /usr/lib/mit/bin/krb5-config ]; then
 309     ln -sf /usr/lib/mit/bin/krb5-config /usr/bin/krb5-config
 310 fi
 311 """
 312
 313 # A generic shell script to setup locale
 314 LOCALE_SETUP = r"""
 315 #!/bin/bash
 316 {GENERATED_MARKER}
 317 set -xueo pipefail
 318
 319 # refer to /usr/share/i18n/locales
 320 INPUTFILE=en_US
 321 # refer to /usr/share/i18n/charmaps
 322 CHARMAP=UTF-8
 323 # locale to generate in /usr/lib/locale
 324 # glibc/localedef will normalize UTF-8 to utf8, follow the naming style
 325 LOCALE=$INPUTFILE.utf8
 326
 327 # if locale is already correct, exit
 328 ( locale | grep LC_ALL | grep -i $LOCALE ) && exit 0
 329
 330 # if locale not available, generate locale into /usr/lib/locale
 331 if ! ( locale --all-locales | grep -i $LOCALE )
 332 then
 333     # no-archive means create its own dir
 334     localedef --inputfile $INPUTFILE --charmap $CHARMAP --no-archive $LOCALE
 335 fi
 336
 337 # update locale conf and global env file
 338 # set both LC_ALL and LANG for safe
 339
 340 # update conf for Debian family
 341 FILE=/etc/default/locale
 342 if [ -f $FILE ]
 343 then
 344     echo LC_ALL="$LOCALE" > $FILE
 345     echo LANG="$LOCALE" >> $FILE
 346 fi
 347
 348 # update conf for RedHat family
 349 FILE=/etc/locale.conf
 350 if [ -f $FILE ]
 351 then
 352     # LC_ALL is not valid in this file, set LANG only
 353     echo LANG="$LOCALE" > $FILE
 354 fi
 355
 356 # update global env file
 357 FILE=/etc/environment
 358 if [ -f $FILE ]
 359 then
 360     # append LC_ALL if not exist
 361     grep LC_ALL $FILE || echo LC_ALL="$LOCALE" >> $FILE
 362     # append LANG if not exist
 363     grep LANG $FILE || echo LANG="$LOCALE" >> $FILE
 364 fi
 365 """
 366
 367
 368 DOCKERFILE = r"""
 369 {GENERATED_MARKER}
 370 FROM {docker_image}
 371
 372 # pass in with --build-arg while build
 373 ARG SHA1SUM
 374 RUN [ -n $SHA1SUM ] && echo $SHA1SUM > /sha1sum.txt
 375
 376 ADD *.sh /tmp/
 377 # need root permission, do it before USER samba
 378 RUN /tmp/bootstrap.sh && /tmp/locale.sh
 379
 380 # if ld.gold exists, force link it to ld
 381 RUN set -x; ! LD_GOLD=$(which ld.gold) || {{ LD=$(which ld) && ln -sf $LD_GOLD $LD && test -x $LD && echo "$LD is now $LD_GOLD"; }}
 382 # if ld.mold exists, force link it to ld (prefer mold over gold! ;-)
 383 RUN set -x; ! LD_MOLD=$(which ld.mold) || {{ LD=$(which ld) && ln -sf $LD_MOLD $LD && test -x $LD && echo "$LD is now $LD_MOLD"; }}
 384
 385 # make test can not work with root, so we have to create a new user
 386 RUN useradd -m -U -s /bin/bash samba && \
 387     mkdir -p /etc/sudoers.d && \
 388     echo "samba ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/samba
 389
 390 USER samba
 391 WORKDIR /home/samba
 392 # samba tests rely on this
 393 ENV USER=samba LC_ALL=en_US.utf8 LANG=en_US.utf8 LANGUAGE=en_US
 394 """
 395
 396 # Vagrantfile snippet for each dist
 397 VAGRANTFILE_SNIPPET = r"""
 398     config.vm.define "{name}" do |v|
 399         v.vm.box = "{vagrant_box}"
 400         v.vm.hostname = "{name}"
 401         v.vm.provision :shell, path: "{name}/bootstrap.sh"
 402         v.vm.provision :shell, path: "{name}/locale.sh"
 403     end
 404 """
 405
 406 # global Vagrantfile with snippets for all dists
 407 VAGRANTFILE_GLOBAL = r"""
 408 {GENERATED_MARKER}
 409
 410 Vagrant.configure("2") do |config|
 411     config.ssh.insert_key = false
 412
 413 {vagrantfile_snippets}
 414
 415 end
 416 """
 417
 418
 419 DEB_DISTS = {
 420     'debian11': {
 421         'docker_image': 'debian:11',
 422         'vagrant_box': 'debian/bullseye64',
 423         'replace': {
 424             'language-pack-en': '',   # included in locales
 425         }
 426     },
 427     'ubuntu1804': {
 428         'docker_image': 'ubuntu:18.04',
 429         'vagrant_box': 'ubuntu/bionic64',
 430         'replace': {
 431             'liburing-dev': '',   # not available
 432         }
 433     },
 434     'ubuntu1804-32bit': {
 435         'docker_image': 'registry-1.docker.io/i386/ubuntu:18.04',
 436         'vagrant_box': 'ubuntu/bionic32',
 437         'replace': {
 438             'liburing-dev': '',   # not available
 439         }
 440     },
 441     'ubuntu2004': {
 442         'docker_image': 'ubuntu:20.04',
 443         'vagrant_box': 'ubuntu/focal64',
 444         'replace': {
 445             'liburing-dev': '',   # not available
 446         }
 447     },
 448     'ubuntu2204': {
 449         'docker_image': 'ubuntu:22.04',
 450         'vagrant_box': 'ubuntu/jammy64',
 451         'replace': {
 452             'libtracker-sparql-2.0-dev': '',  # only tracker 3.x is available
 453         },
 454     }
 455 }
 456
 457
 458 RPM_DISTS = {
 459     'centos7': {
 460         'docker_image': 'centos:7',
 461         'vagrant_box': 'centos/7',
 462         'bootstrap': YUM_BOOTSTRAP,
 463         'replace': {
 464             'lsb-release': 'redhat-lsb',
 465             'python3': 'python36',
 466             'python3-cryptography': 'python36-cryptography',
 467             'python3-devel': 'python36-devel',
 468             'python3-dns': 'python36-dns',
 469             'python3-pyasn1': 'python36-pyasn1',
 470             'python3-gpg': 'python36-gpg',
 471             'python3-iso8601' : 'python36-iso8601',
 472             'python3-markdown': 'python36-markdown',
 473             'python3-requests': 'python36-requests',
 474             # although python36-devel is available
 475             # after epel-release installed
 476             # however, all other python3 pkgs are still python36-ish
 477             'python2-gpg': 'pygpgme',
 478             '@development-tools': '"@Development Tools"',  # add quotes
 479             'glibc-langpack-en': '',  # included in glibc-common
 480             'glibc-locale-source': '',  # included in glibc-common
 481             # update perl core modules on centos
 482             # fix: Can't locate Archive/Tar.pm in @INC
 483             'perl': 'perl-core',
 484             'perl-FindBin': '',
 485             'rpcsvc-proto-devel': '',
 486             'glusterfs-api-devel': '',
 487             'glusterfs-devel': '',
 488             'libcephfs-devel': '',
 489             'gnutls-devel': 'compat-gnutls37-devel',
 490             'gnutls-utils': 'compat-gnutls37-utils',
 491             'liburing-devel': '',   # not available
 492             'python3-setproctitle': 'python36-setproctitle',
 493             'tracker-devel': '', # do not install
 494             'mold': '',
 495             'ShellCheck': '',
 496             'shfmt': '',
 497         }
 498     },
 499     'centos8s': {
 500         'docker_image': 'quay.io/centos/centos:stream8',
 501         'vagrant_box': 'centos/stream8',
 502         'bootstrap': CENTOS8S_YUM_BOOTSTRAP,
 503         'replace': {
 504             'lsb-release': 'redhat-lsb',
 505             '@development-tools': '"@Development Tools"',  # add quotes
 506             'lcov': '', # does not exist
 507             'perl-JSON-Parse': '', # does not exist?
 508             'perl-Test-Base': 'perl-Test-Simple',
 509             'perl-FindBin': '',
 510             'liburing-devel': '', # not available yet, Add me back, once available!
 511             'mold': '',
 512             'ShellCheck': '',
 513             'shfmt': '',
 514         }
 515     },
 516     'fedora38': {
 517         'docker_image': 'quay.io/fedora/fedora:38',
 518         'vagrant_box': 'fedora/38-cloud-base',
 519         'bootstrap': DNF_BOOTSTRAP,
 520         'replace': {
 521             'lsb-release': 'redhat-lsb',
 522             'perl-FindBin': '',
 523             'python3-iso8601': 'python3-dateutil',
 524             'libtracker-sparql-2.0-dev': '',  # only tracker 3.x is available
 525         }
 526     },
 527     'opensuse154': {
 528         'docker_image': 'opensuse/leap:15.4',
 529         'vagrant_box': 'opensuse/openSUSE-15.4-x86_64',
 530         'bootstrap': ZYPPER_BOOTSTRAP,
 531         'replace': {
 532             '@development-tools': '',
 533             'dbus-devel': 'dbus-1-devel',
 534             'docbook-style-xsl': 'docbook-xsl-stylesheets',
 535             'glibc-common': 'glibc-locale',
 536             'glibc-locale-source': 'glibc-i18ndata',
 537             'glibc-langpack-en': '',
 538             'jansson-devel': 'libjansson-devel',
 539             'keyutils-libs-devel': 'keyutils-devel',
 540             'krb5-workstation': 'krb5-client',
 541             'python3-libsemanage': 'python3-semanage',
 542             'openldap-devel': 'openldap2-devel',
 543             'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
 544             'perl-JSON-Parse': 'perl-JSON-XS',
 545             'perl-generators': '',
 546             'perl-interpreter': '',
 547             'perl-FindBin': '',
 548             'procps-ng': 'procps',
 549             'python3-iso8601': 'python3-python-dateutil',
 550             'python3-dns': 'python3-dnspython',
 551             'python3-markdown': 'python3-Markdown',
 552             'quota-devel': '',
 553             'glusterfs-api-devel': '',
 554             'gnutls-utils': 'gnutls',
 555             'libtasn1-tools': '', # asn1Parser is part of libtasn1
 556             'mold': '',
 557             'shfmt': '',
 558             'yum-utils': '',
 559         }
 560     }
 561 }
 562
 563
 564 DEB_FAMILY = {
 565     'name': 'deb',
 566     'pkgs': DEB_PKGS,
 567     'bootstrap': APT_BOOTSTRAP,  # family default
 568     'dists': DEB_DISTS,
 569 }
 570
 571
 572 RPM_FAMILY = {
 573     'name': 'rpm',
 574     'pkgs': RPM_PKGS,
 575     'bootstrap': YUM_BOOTSTRAP,  # family default
 576     'dists': RPM_DISTS,
 577 }
 578
 579
 580 YML_HEADER = r"""
 581 ---
 582 packages:
 583 """
 584
 585
 586 def expand_family_dists(family):
 587     dists = {}
 588     for name, config in family['dists'].items():
 589         config = config.copy()
 590         config['name'] = name
 591         config['home'] = join(OUT, name)
 592         config['family'] = family['name']
 593         config['GENERATED_MARKER'] = GENERATED_MARKER
 594
 595         # replace dist specific pkgs
 596         replace = config.get('replace', {})
 597         pkgs = []
 598         for pkg in family['pkgs']:
 599             pkg = replace.get(pkg, pkg)  # replace if exists or get self
 600             if pkg:
 601                 pkgs.append(pkg)
 602         pkgs.sort()
 603
 604         lines = ['  - {}'.format(pkg) for pkg in pkgs]
 605         config['packages.yml'] = YML_HEADER.lstrip() + os.linesep.join(lines)
 606
 607         sep = ' \\' + os.linesep + '    '
 608         config['pkgs'] = sep.join(pkgs)
 609
 610         # get dist bootstrap template or fall back to family default
 611         bootstrap_template = config.get('bootstrap', family['bootstrap'])
 612         config['bootstrap.sh'] = bootstrap_template.format(**config).strip()
 613         config['locale.sh'] = LOCALE_SETUP.format(**config).strip()
 614
 615         config['Dockerfile'] = DOCKERFILE.format(**config).strip()
 616         # keep the indent, no strip
 617         config['vagrantfile_snippet'] = VAGRANTFILE_SNIPPET.format(**config)
 618
 619         dists[name] = config
 620     return dists
 621
 622
 623 # expanded config for dists
 624 DEB_DISTS_EXP = expand_family_dists(DEB_FAMILY)
 625 RPM_DISTS_EXP = expand_family_dists(RPM_FAMILY)
 626
 627 # assemble all together
 628 DISTS = {}
 629 DISTS.update(DEB_DISTS_EXP)
 630 DISTS.update(RPM_DISTS_EXP)
 631
 632
 633 def render_vagrantfile(dists):
 634     """
 635     Render all snippets for each dist into global Vagrantfile.
 636
 637     Vagrant supports multiple vms in one Vagrantfile.
 638     This make it easier to manage the fleet, e.g:
 639
 640     start all: vagrant up
 641     start one: vagrant up ubuntu1804
 642
 643     All other commands apply to above syntax, e.g.: status, destroy, provision
 644     """
 645     # sort dists by name and put all vagrantfile snippets together
 646     snippets = [
 647         dists[dist]['vagrantfile_snippet']
 648         for dist in sorted(dists.keys())]
 649
 650     return VAGRANTFILE_GLOBAL.format(
 651             vagrantfile_snippets=''.join(snippets),
 652             GENERATED_MARKER=GENERATED_MARKER
 653             )
 654
 655
 656 VAGRANTFILE = render_vagrantfile(DISTS)
 657
 658
 659 # data we need to expose
 660 __all__ = ['DISTS', 'VAGRANTFILE', 'OUT']