sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
10baebe1e4
diskimage-builder/diskimage_builder/elements/debian/README.rst

46 lines
1.8 KiB
ReStructuredText
Raw Normal View History

Create docs site containing element READMEs We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b
2015-02-07 10:30:02 +00:00
======
debian
======
Use sphinx warning-is-error Sphix 1.5 (I9e7261c4124b71eeb6bddd9e21747b61bbdc16fa) includes "warning-is-error" which supersedes pbr's warnerrors. Enable this and fix up the resulting failures - trailing lines for lists in element_deps directive - missing README's that are linked - syntax error and highlighting in building instructions Change-Id: I6549551b4a9bf47076c9811a7a38a666cbea2a50
2017-03-14 00:33:01 +00:00
Create an image based on Debian. We default to unstable but
``DIB_RELEASE`` is mapped to any series of Debian.
Add support for Debian Change-Id: Ibc6bc57dea1eab295fb23cccf40b38f3fcb285c3
2014-01-11 21:43:43 +00:00
Note that the default Debian series is `unstable`, and the default
mirrors for Debian can be problematic for `unstable`. Because apt does
not handle changing Packages files well across multiple out of sync
mirrors, it is recommended that you choose a single mirror of debian,
Shift debian element to DIB_DISTRIBUTION_MIRROR The ubuntu element supports simple replacement of sources.list by using the DIB_DISTRIBUTION_MIRROR environment variable. Drag the debian element into line by supporting both DIB_DEBIAN_MIRROR and the new shiny DIB_DISTRIBUTION_MIRROR. Change-Id: I9d5f8d1e3251965b34e55929182aa601a524fe8f
2014-02-17 01:50:54 +00:00
and pass it in via `DIB_DISTRIBUTION_MIRROR`.
Add support for Debian Change-Id: Ibc6bc57dea1eab295fb23cccf40b38f3fcb285c3
2014-01-11 21:43:43 +00:00
Debian: Support additional debootstrap arguments Add support for supplying a custom keyring and debootstrap script using two new environment variables: * DIB_DEBIAN_KEYRING - Path to a gpg keyring. * DIB_DEBIAN_DEBOOTSTRAP_SCRIPT - Path to a alternative debootstrap script. Change-Id: I42e8832b435b8a77b0681b5bc9d9332bbe860cd5
2014-04-26 13:21:55 +00:00
If necessary, a custom apt keyring and debootstrap script can be
Split the debootstrap functions into an element debootstrap is not debian or ubuntu specific. We can make a debootstrap element that knows how to do all of the things, and then a debian-minimal and ubuntu-minimal image that use it. Finally, make the debian element simply be a collection of the extra things we do to make it look like a cloud-init based cloud image. Change-Id: Iaf46c8e61bf1cac9a096cbfd75d6d6a9111b701e
2015-03-22 20:11:55 +00:00
supplied to the `debootstrap` command via `DIB_APT_KEYRING` and
Debian: Support additional debootstrap arguments Add support for supplying a custom keyring and debootstrap script using two new environment variables: * DIB_DEBIAN_KEYRING - Path to a gpg keyring. * DIB_DEBIAN_DEBOOTSTRAP_SCRIPT - Path to a alternative debootstrap script. Change-Id: I42e8832b435b8a77b0681b5bc9d9332bbe860cd5
2014-04-26 13:21:55 +00:00
`DIB_DEBIAN_DEBOOTSTRAP_SCRIPT` respectively. Both options require the
use of absolute rather than relative paths.
Add support for Debian Change-Id: Ibc6bc57dea1eab295fb23cccf40b38f3fcb285c3
2014-01-11 21:43:43 +00:00
Use of this element will also require the tool 'debootstrap' to be
available on your system. It should be available on Ubuntu, Debian,
and Fedora.
Add switch to turn on caching for debian element. DIB_OFFLINE has wide-ranging effect. This patch adds a tunable that only turns on the tarball-caching behaviour specifically for the debian element. Change-Id: Idd646d7909df6907afc0eeeec1129c3f1a1f92bc
2014-04-09 14:31:57 +00:00
The `DIB_OFFLINE` or more specific `DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE`
variables can be set to prefer the use of a pre-cached root filesystem
tarball.
Add DIB_DEBOOTSTRAP_EXTRA_ARGS environment variable This allows extra arguments to be passed to the debootstrap command when creating an image using the debian element. Change-Id: I87eb856365ff6a17f051e2e56587235648328d57 Co-Authored-By: Ghe Rivero <ghe.rivero@gmail.com>
2014-05-07 04:15:30 +00:00
The `DIB_DEBOOTSTRAP_EXTRA_ARGS` environment variable may be used to
pass extra arguments to the debootstrap command used to create the
base filesystem image. If --keyring is is used in `DIB_DEBOOTSTRAP_EXTRA_ARGS`,
Split the debootstrap functions into an element debootstrap is not debian or ubuntu specific. We can make a debootstrap element that knows how to do all of the things, and then a debian-minimal and ubuntu-minimal image that use it. Finally, make the debian element simply be a collection of the extra things we do to make it look like a cloud-init based cloud image. Change-Id: Iaf46c8e61bf1cac9a096cbfd75d6d6a9111b701e
2015-03-22 20:11:55 +00:00
it will override `DIB_APT_KEYRING` if that is used as well.
Explain difference between two envvars Explain difference between 'DIB_OFFLINE' and 'DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE' Those variables are not redundant,they hava different effective ranges. However,some people may be confused about this and reported a bug. So,this difference should be writen in the README file. Closes-Bug: #1506275 Change-Id: Ie5316de41d129bf98781708954f09ef0b2592b53
2016-07-25 02:15:42 +00:00
For further information about `DIB_DEBIAN_DEBOOTSTRAP_SCRIPT` ,
`DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE` and `DIB_DEBOOTSTRAP_EXTRA_ARGS`
please consult "README.rst" of the debootstrap element.
Split the debootstrap functions into an element debootstrap is not debian or ubuntu specific. We can make a debootstrap element that knows how to do all of the things, and then a debian-minimal and ubuntu-minimal image that use it. Finally, make the debian element simply be a collection of the extra things we do to make it look like a cloud-init based cloud image. Change-Id: Iaf46c8e61bf1cac9a096cbfd75d6d6a9111b701e
2015-03-22 20:11:55 +00:00
-------------------
Note on ARM systems
-------------------
Because there is not a one-to-one mapping of `ARCH` to a kernel package, if
you are building an image for ARM on debian, you need to specify which kernel
you want in the environment variable `DIB_ARM_KERNEL`. For instance, if you want
the `linux-image-mx5` package installed, set `DIB_ARM_KERNEL` to `mx5`.
Semi-automatic doc generation of element dependency Currently there is no description of dependencies in the generated documentation of the elements: therefore a user of an element does not know which other elements are automatically included and e.g. which configuration options are available. In addition there are some copy&pastes of parts of the README.rst scattered thought different Ubuntu and Debian specific elements. This patch adds a semi-automatic generation of dependency information of all elements. Nevertheless these are not automatically included. The author of the element's README.rst can decide if and where the dependency information should appear and can use the descriptor .. element_deps:: for this. This patch adds the dependency information for some Debian and Ubuntu patches - and creates the base for later removing the duplicated parts. A call is added to element_dependencies._find_all_elements() to populate reverse dependencies for Element objects. (This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for the feature/v2 branch) Change-Id: Iebb83916fed71565071246baa550849eef40560b
2017-01-19 21:00:21 +00:00
.. element_deps::
Reference in New Issue Copy Permalink