docs/development/design/inspector-design-guideline.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ==========================
   5 Inspector Design Guideline
   6 ==========================
   7
   8 .. NOTE::
   9    This is spec draft of design guideline for inspector component.
  10    JIRA ticket to track the update and collect comments: `DOCTOR-73`_.
  11
  12 This document summarize the best practise in designing a high performance
  13 inspector to meet the requirements in `OPNFV Doctor project`_.
  14
  15 Problem Description
  16 ===================
  17
  18 Some pitfalls has be detected during the development of sample inspector, e.g.
  19 we suffered a significant `performance degrading in listing VMs in a host`_.
  20
  21 A `patch set for caching the list`_ has been committed to solve issue. When a
  22 new inspector is integrated, it would be nice to have an evaluation of existing
  23 design and give recommendations for improvements.
  24
  25 This document can be treated as a source of related blueprints in inspector
  26 projects.
  27
  28 Guidelines
  29 ==========
  30
  31 Host specific VMs list
  32 ----------------------
  33
  34 TBD, see `DOCTOR-76`_.
  35
  36 Parallel execution
  37 ------------------
  38
  39 TBD, see `discussion in mailing list`_.
  40
  41 .. _DOCTOR-73: https://jira.opnfv.org/browse/DOCTOR-73
  42 .. _OPNFV Doctor project: https://wiki.opnfv.org/doctor
  43 .. _performance degrading in listing VMs in a host: https://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-September/012591.html
  44 .. _patch set for caching the list: https://gerrit.opnfv.org/gerrit/#/c/20877/
  45 .. _DOCTOR-76: https://jira.opnfv.org/browse/DOCTOR-76
  46 .. _discussion in mailing list: https://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-October/013036.html