diskimage-builder/doc/source/developer/caches.rst
Antoine Musso f22a5a8b91 doc: migrate from README.rst to Sphinx
The README.rst has a lot of information that has been duplicated in the
Sphinx maintained documentation (3600330).

Remove dupes from README.rst
Point to http://docs.openstack.org/developer/diskimage-builder/

Change summary:

=====================+======================================
README.md            | Sphinx document
section              |
=====================+======================================
Installation         | installation.rst
---------------------+--------------------------------------
Invocation           | invocation.rst
---------------------+--------------------------------------
Requirements         | installation.rst Speedups
---------------------+--------------------------------------
Caches/offline       | caches.rst + changes from 849e9cb2
                     | fix some markup
---------------------+--------------------------------------
Install Types        | install_types.rst
---------------------+--------------------------------------
Writing an element   | developing_elements.rst + fe7823a2
                     | `Testing element` from b9b6640f
                     | `3rd party elements' from f1e7bf3a
---------------------+--------------------------------------
Existing elements    | elements.rst
---------------------+--------------------------------------
What tools are there | components.rst
---------------------+--------------------------------------
Design               | design.rst
---------------------+--------------------------------------

Change-Id: I578daa8e3a8d876b3ee3c9a748d7c8aa2bf7a0b7
2015-09-10 16:55:39 +10:00

43 lines
1.4 KiB
ReStructuredText

Caches and offline mode
=======================
Since retrieving and transforming operating system image files, git
repositories, Python or Ruby packages, and so on can be a significant overhead,
we cache many of the inputs to the build process.
The cache location is read from DIB\_IMAGE\_CACHE. :ref:`developing-elements`
describes the interface within disk-image-builder for caching.
When invoking disk-image-builder, the ``--offline`` option will instruct
disk-image-builder to not refresh cached resources.
Note that we don't maintain operating system package caches, instead depending
on your local infrastructure (e.g. Squid cache, or an APT or Yum proxy) to
facilitate caching of that layer, so you need to arrange independently for
offline mode. For more information about setting up a squid proxy, consult the
`TripleO documentation
<http://docs.openstack.org/developer/tripleo-incubator/devtest_setup.html#f3>`_.
Base images
-----------
These are cached by the standard elements - fedora, redhat, ubuntu,
debian and opensuse.
source-repositories
-------------------
Git repositories and tarballs obtained via the source-repositories element will
be cached.
C and C++ compilation
---------------------
Ccache is configured by the base element. Any compilation that honours ccache
will be cached.
PyPI
----
The pypi element will bind mount a PyPI mirror from the cache dir and configure
pip and easy-install to use it.