Release6/catalog-search-functions.md

   1 # Catalogue Search Functions #
   2
   3 ## Proposer ##
   4
   5 Francisco Rodriguez (Indra)
   6
   7 ## Type ##
   8
   9 **Feature**
  10
  11 ## Target MDG/TF ##
  12
  13 osmclient, NBI
  14
  15 ## Description ##
  16
  17 Invoking service primitives on a Network Service or getting Monitoring
  18 Parameters requires to provide the nsrid or vnfrid, which are returned after
  19 instantiation. If the system that invokes the primitives later is not the one
  20 that launched the instantiation, the nsr-id/vnfr-id will not be available.
  21
  22 In order to retrieve those ids is necessary to have a method that returns a
  23 single VNFR or NSR, looking by Network Service Name, instead of the existing
  24 operation that returns the whole catalog.
  25
  26 ## Design ##
  27 Design pad: https://osm.etsi.org/pad/p/feature1400
  28
  29 While this feature is not implemented, the python osmclient library can be
  30 leveraged to do a search by name. Behind the scenes, the osmclient library
  31 is getting the whole catalogue and picking the requested record from name.
  32
  33 The SO will add the capability to specify a search with any non-key fields.
  34 This has the benefit of being more future proof. This capability will be used
  35 in combination with a new function at osmclient for doing a lookup with
  36 filtering capabilities.
  37
  38 ## Demo or definition of done ##
  39
  40 An external application such as a provisioning system will be able to use the
  41 northbound interface to "create a new corporation" by recovering the relevant
  42 NSR first.