openstack
/
diskimage-builder
Code Issues Proposed changes
diskimage-builder/elements/pypi
History
James Polley 341c42ba83 Remove docs about deprecated pypi-mirror tool 
The pypi-mirror tool is no longer supported by the infra team, or
reccomended for installs, and is known to have various bugs that will
not be fixed.

Remove mentions of it from the docs and point people at devpi-server
instead.

Change-Id: Ieedb8bf9bee2f5932edac6b9747e645d0f4eb08c
 		2014-08-28 11:33:52 +10:00
..
extra-data.d Always bind-mount pypi mirror if dir exists 2014-06-26 14:49:06 +12:00
post-install.d set -u and -o pipefail everywhere 2014-05-06 15:51:07 -05:00
pre-install.d Permit use of wheel mirrors in pypi element. 2014-03-25 16:48:18 +13:00
README.md Remove docs about deprecated pypi-mirror tool 2014-08-28 11:33:52 +10:00

README.md

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.