docs/release-process/milestone-readouts/m2/sfc.rst

   1 =========================
   2 Service Function Chaining
   3 =========================
   4
   5 Please provide updates on any previously-incomplete items from prior milestone
   6 readouts.
   7
   8 Functionality Freeze:
   9 ---------------------
  10
  11 1. Final list of externally consumable APIs defined: Yes
  12
  13    - If you had Tentative APIs, have they been moved to Provisional or dropped?
  14      N/A
  15
  16    - If any of your Tentative APIs were dropped, have you notified all projects
  17      that were expecting them? N/A
  18
  19    - Also please list all dropped APIs.
  20      No APIs were dropped, but we did deprecate the RSP creation via RPC,
  21      and it will be removed in Fluorine.
  22
  23 2. Are all your inter-project dependencies resolved (i.e., have the other
  24    projects you were counting on given you what you needed)? Yes
  25
  26 3. Were there any project-specific deliverables planned for this milestone? No
  27
  28 Karaf Features Defined:
  29 -----------------------
  30
  31 1. Are all your project's features that are intended for release added to the
  32    features.xml and checked into integration git repository? No
  33
  34    There will be 2 new SFC features in Oxygen: odl-sfc-shell and odl-sfc-statistics.
  35    The odl-sfc-shell feature has been added to the integration git repo
  36    in the gerrit patch below, but the odl-sfc-statistics feature is not
  37    ready yet and will be added soon.
  38
  39    - https://git.opendaylight.org/gerrit/65684
  40
  41 2. List all top-level, user-facing, and stable Karaf features for your project.
  42
  43    - For top-level and user-facing features, please provide a one-sentence
  44      description a developer and/or user would find helpful.
  45
  46      - Top level, user-facing SFC features
  47
  48        - odl-sfc-netconf: Provides functionality to communicate with Netconf capable Service Functions.
  49        - odl-sfc-scf-openflow: SFC stand-alone openflow classifier.
  50        - odl-sfc-scf-vpp: SFC stand-alone vpp classifier.
  51        - odl-sfc-openflow-renderer: Renderer functionality for OpenFlow capable switches.
  52        - odl-sfclisp: Programs LISP capable switches.
  53        - odl-sfc-sb-rest: Implements a South Bound Rest interface to send configuration to REST-capable switches.
  54        - odl-sfc-ui: This feature is the SFC User Interface.
  55        - odl-sfc-vnfm-tacker: Tacker VNF Manager interface.
  56        - odl-sfc-ios-xe-renderer: Renderer functionality for IO XE switches that use netconf.
  57        - odl-sfc-vpp-renderer: Renderer functionality for fd.io VPP (Vector Packet Processor) switches that use netconf.
  58        - odl-sfc-pot: This feature implements a Proof of Transit for the Service Functions.
  59
  60      - Top level, non-user-facing SFC features consumed by the user-facing features above
  61
  62        - odl-sfc-genius: This feature implements the Genius utilities created by SFC project.
  63        - odl-sfc-model: This feature defines and implements the SFC data model as specified here https://datatracker.ietf.org/doc/rfc7665/
  64        - odl-sfc-pot-netconf-renderer: This feature implements the Netconf rendering for the Proof of Transit for the Service Functions.
  65        - odl-sfc-provider: This feature provides an easy-to-use interface to the sfc-model.
  66        - odl-sfc-provider-rest: This feature provides no functionality, and just installs the necessary features for SFC restconf.
  67        - odl-sfc-ovs: This feature provides functionality for SFC to communicate with OVSDB for SFF configuration.
  68        - odl-sfc-test-consumer: This feature is used for testing only.
  69
  70 Documentation:
  71 --------------
  72
  73 1. List the kinds of documentation you will provide including at least:
  74
  75    - A user guide for the SFC project.
  76    - A developer guide for the SFC project.
  77    - Release notes (mandatory) [2]_.
  78
  79 2. Have you checked in a reStructuredText outline to the docs repository? No
  80
  81 Integration and Test:
  82 ---------------------
  83
  84 1. Have you started automated system testing for your top-level features? Yes
  85
  86    - https://jenkins.opendaylight.org/releng/view/sfc/
  87
  88 2. Have you filled out basic system test plan template for each top-level
  89    feature (karaf and not karaf) and a comprehensive system test plan template
  90    including functionality, cluster, scalability, performance,
  91    longevity/stability for each stable feature? No
  92
  93    - We're not ready with this yet.
  94
  95 Project Specific:
  96 -----------------
  97
  98 1. Were there any project-specific deliverables planned for this milestone? No
  99
 100 2. Have you updated your project facts with the project type category? Yes
 101
 102 3. Do you acknowledge the changes to the RC Blocking Bug Policy [3]_? Yes
 103
 104 .. [1] Note that you can only reasonably hold a project to something if you
 105        formally asked for it during the release planning process and the project
 106        team members acknowledged that ask saying they would do it.
 107 .. [2] Release notes must be updated prior to a major release. It is a good idea
 108        to keep release notes as a living document when significant changes are
 109        made.
 110 .. [3] https://lists.opendaylight.org/pipermail/tsc/2016-December/006468.html