← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1847302] [NEW] doc: need admin guide for the image cache

 

Public bug reported:

There is no documentation for the image cache, so we should add one to
the admin guide.

I think a relatively simple beginning would include:

- A high level description of what an image cache is, where it lives,
and the benefits.

- Which compute drivers support image cache (that's not detailed here
either: https://docs.openstack.org/nova/latest/user/support-
matrix.html), this is any driver that supports the "has_imagecache"
driver capability (currently libvirt, hyperv and vmware).

- The related configuration options since the options are not in a
particular config option group they are all spread across DEFAULT
(moving those to an [imagecache] group would probably be useful as well
outside the docs change).

More advanced topics could be things like known issues/limitations
(maybe mdbooth can help here), some of which is probably covered in this
spec:

https://specs.openstack.org/openstack/nova-specs/specs/ussuri/approved
/image-precache-support.html

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: doc image-cache

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1847302

Title:
  doc: need admin guide for the image cache

Status in OpenStack Compute (nova):
  New

Bug description:
  There is no documentation for the image cache, so we should add one to
  the admin guide.

  I think a relatively simple beginning would include:

  - A high level description of what an image cache is, where it lives,
  and the benefits.

  - Which compute drivers support image cache (that's not detailed here
  either: https://docs.openstack.org/nova/latest/user/support-
  matrix.html), this is any driver that supports the "has_imagecache"
  driver capability (currently libvirt, hyperv and vmware).

  - The related configuration options since the options are not in a
  particular config option group they are all spread across DEFAULT
  (moving those to an [imagecache] group would probably be useful as
  well outside the docs change).

  More advanced topics could be things like known issues/limitations
  (maybe mdbooth can help here), some of which is probably covered in
  this spec:

  https://specs.openstack.org/openstack/nova-specs/specs/ussuri/approved
  /image-precache-support.html

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1847302/+subscriptions