diskimage-builder/elements/pypi
Ghe Rivero 91977e7c8f Warning when using pypi element without a mirror
Using only a local filesystem mirror could lead opaque errors.
Print a warning message in this situations.

Change-Id: I5f77151ea928868f4c441e8a1bb2eb0966b21832
Closes-Bug: #1297948
2014-11-25 11:41:11 +01:00
..
extra-data.d Use DIB_IMAGE_CACHE everywhere 2014-10-05 13:58:32 -07:00
post-install.d set -u and -o pipefail everywhere 2014-05-06 15:51:07 -05:00
pre-install.d Warning when using pypi element without a mirror 2014-11-25 11:41:11 +01:00
README.md Remove docs about deprecated pypi-mirror tool 2014-08-28 11:33:52 +10:00

Inject a PyPI mirror

Use a custom PyPI mirror to build images. The default is to bind mount one from ~/.cache/image-create/pypi/mirror into the build environment as mirror URL file:///tmp/pypi. The element temporarily overwrites /root/.pip.conf and .pydistutils.cfg to use it.

When online, the official pypi.python.org pypi index is supplied as an extra-url, so uncached dependencies will still be available. When offline, only the mirror is used - be warned that a stale mirror will cause build failures. To disable the pypi.python.org index without using --offline (e.g. when working behind a corporate firewall that prohibits pypi.python.org) set DIB_NO_PYPI_PIP to any non-empty value.

To use an arbitrary mirror set PYPI_MIRROR_URL=http[s]://somevalue/

Additional mirrors can be added by exporting PYPI_MIRROR_URL_1=... etc. Only the one mirror can be used by easy-install, but since wheels need to be in the first mirror to be used, the last listed mirror is used as the pydistutils index. NB: The sort order for these variables is a simple string sort - if you have more than 9 additional mirrors, some care will be needed.

A typical use of this element is thus: export PYPI_MIRROR_URL=http://site/pypi/Ubuntu-13.10 export PYPI_MIRROR_URL_1=http://site/pypi/ export PYPI_MIRROR_URL_2=file:///tmp/pypi

devpi-server can be useful in making a partial PyPI mirror suitable for building images. For instance:

The next time packages are installed, they'll be cached on the local devpi server; subsequent runs pointed at the same mirror will use the local cache if the upstream can't be contacted.

Note that this process only has the server running temporarily; see Quickstart: Permanent install on server/laptop guide from the devpi developers for more information on a more permanent setup.