release-notes/src/main/asciidoc/user_guide/user_guide.adoc

   1 == User guide
   2
   3 === Running Honeycomb
   4 link:user_running_honeycomb.html[Running Honeycomb]
   5
   6 === Troubleshooting
   7 link:user_troubleshooting.html[Troubleshooting]
   8
   9 === Honeycomb and ODL
  10 link:user_honeycomb_and_ODL.html[Mounting Honeycomb in ODL]
  11
  12 === Configuration files
  13 Honeycomb's configuration files present within its distribution:
  14
  15 * Honeycomb infra:
  16 ** {project-git-web}/infra/minimal-distribution/src/main/resources/honeycomb-minimal-resources/config/honeycomb.json?h={project-branch}[Honeycomb base configuration]
  17 * Honeycomb vpp plugins commons:
  18 ** {project-git-web}/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json?h={project-branch}[VPP plugins common configuration]
  19 * V3PO plugin:
  20 ** {project-git-web}/v3po/v3po2vpp/src/main/resources/honeycomb-minimal-resources/config/v3po.json?h={project-branch}[V3PO plugin for Honeycomb configuration]
  21 * LISP plugin
  22 ** {project-git-web}/lisp/lisp2vpp/src/main/resources/honeycomb-minimal-resources/config/lisp.json?h={project-branch}[LISP plugin for Honeycomb configuration]
  23 * NSH plugin:
  24 ** {project-git-web}/nsh/impl/src/main/resources/honeycomb-minimal-resources/config/vppnsh.json?h={project-branch}[NSH_SFC plugin for Honeycomb configuration]
  25 * iOAM plugin:
  26 ** {project-git-web}/ioam/impl/src/main/resources/honeycomb-minimal-resources/config/vppioam.json?h={project-branch}[IOAM plugin for Honeycomb configuration]
  27
  28 === YANG models
  29
  30 * V3PO plugin
  31 ** {project-git-web}/v3po/api/src/main/yang?h={project-branch}[V3PO YANG models]
  32 * LISP plugin
  33 ** {project-git-web}/lisp/api/src/main/yang?h={project-branch}[LISP YANG models]
  34 * NSH plugin
  35 ** {project-git-web}/nsh/api/src/main/yang?h={project-branch}[NSH YANG models]
  36 * NAT plugin
  37 ** {project-git-web}/nat/nat-api/src/main/yang?h={project-branch}[NAT YANG models]
  38 * iOAM plugin
  39 ** {project-git-web}/ioam/api/src/main/yang?h={project-branch}[IOAM YANG models]
  40 * Context models
  41 ** {project-git-web}/vpp-common/naming-context-api/src/main/yang?h={project-branch}[Context YANG models]
  42
  43 === POSTMAN collections
  44
  45 * V3PO plugin
  46 ** {project-git-web}/v3po/postman_rest_collection.json?h={project-branch}[V3PO postman collection]
  47 * LISP plugin
  48 ** {project-git-web}/lisp/lisp_postman_rest_collection.json?h={project-branch}[LISP postman collection]
  49 * NSH plugin
  50 ** {project-git-web}/nsh/nsh_postman_rest_collection.json?h={project-branch}[NSH postman collection]
  51 * NAT plugin
  52 ** {project-git-web}/nat/postman_rest_collection.json?h={project-branch}[NAT postman collection]
  53 * iOAM plugin
  54 ** {project-git-web}/ioam/ioam_trace_postman_collection.json?h={project-branch}[IOAM postman collection]