From 8111fc40aaefe1cb63fc895d5fbdd7309ea1a49f Mon Sep 17 00:00:00 2001 From: Gregory Haynes Date: Tue, 7 Apr 2015 18:20:51 +0000 Subject: [PATCH] Improved apt-sources README Cleaning up the apt-sources README to be easier to consume. Also removing some tripleo references from the README. Change-Id: I6937fd5cd51288b36890dde214701bcef1d61381 --- elements/apt-sources/README.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/elements/apt-sources/README.rst b/elements/apt-sources/README.rst index 1e0171a2..9400d8da 100644 --- a/elements/apt-sources/README.rst +++ b/elements/apt-sources/README.rst @@ -2,20 +2,16 @@ apt-sources =========== +Specify an apt sources.list file which is used during image building and then +remains on the image when it is run. -This element overrides the default sources.list. +Environment Variables +--------------------- -For APT based systems, if your network connection is slow for the default -sources.list in the upstream cloud image, you can define `DIB_APT_SOURCES` with -your favorite sources.list to override it, before running devtest.sh. - -The new sources.list will take effect at build time and run time. - -If you want to use this element with tripleo-incubator scripts, set `NODE_DIST` -/ `SEED_DIB_EXTRA_ARGS` / `UNDERCLOUD_DIB_EXTRA_ARGS` / -`OVERCLOUD_CONTROL_DIB_EXTRA_ARGS` / `OVERCLOUD_COMPUTE_DIB_EXTRA_ARGS` to make -it take effect at the appropriate time. - -For instance, before running devtest.sh: - export `DIB_APT_SOURCES`=/etc/apt/sources.list - export `NODE_DIST`="ubuntu apt-sources" +DIB_APT_SOURCES + :Required: No + :Default: None (Does not replace sources.list file) + :Description: Path to a file on the build host which is used in place of + ``/etc/apt/sources.list`` + :Example: ``DIB_APT_SOURCES=/etc/apt/sources.list`` will use the same + sources.list as the build host.