c4bbb6f3bc
We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b
55 lines
2.2 KiB
ReStructuredText
55 lines
2.2 KiB
ReStructuredText
====
|
|
pypi
|
|
====
|
|
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](https://git.openstack.org/cgit/openstack-infra/pypi-mirro://pypi.python.org/pypi/devpi-server)
|
|
can be useful in making a partial PyPI mirror suitable for building images. For
|
|
instance:
|
|
|
|
* pip install -U devpi
|
|
|
|
* devpi-server quickstart
|
|
|
|
* devpi use http://machinename:3141
|
|
|
|
* Re-export your variables to point at the new mirror:
|
|
|
|
export PYPI\_MIRROR\_URL=http://machinename:3141/
|
|
unset PYPI\__MIRROR\_URL\_1
|
|
unset PYPI\__MIRROR\_URL\_1
|
|
|
|
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](http://doc.devpi.net/latest/quickstart-server.html) guide from
|
|
the devpi developers for more information on a more permanent setup.
|