mod/designtool/README.md

   1 # DCAE MOD's Design tool
   2
   3 ## License
   4
   5 Copyright 2020 AT&T Intellectual Property. All rights reserved.
   6
   7 This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
   8
   9 Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
  10
  11
  12 ## Description
  13
  14 DCAE MOD's DCAE design tool is based on Nifi 1.9.2 with modifications
  15 made by the DCAE MOD team.
  16
  17 ## Development
  18
  19 The designtool-web module contains the modified versions of Nifi files, along
  20 with a Dockerfile and a script (sh/applypatches.sh) for replacing them in
  21 the nifi Docker image, to produce the design tool Docker image.
  22
  23 If the set of modified files changes, then the Dockerfile, the script, and
  24 potentially the pom.xml may require changes.
  25
  26 In particular, note that the Nifi build creates 2 "bin" files, one for nifi
  27 itself and the other for the nifi-toolkit, which are expanded into separate
  28 directories in the nifi image.  Contained in the "bin" files are "nar" files,
  29 which contain "jar" and "war" files.  And, inside the nifi-web-ui "war" file
  30 are several "-all.js" and "-all.css" files, containing minified aggregations
  31 of the various js and css source files.  The applypatches script needs to
  32 appropriately patch these nar, war, jar, all.js, and all-css files (some of
  33 which also have gzipped versions).
  34
  35 The nifi-war-to-jar module builds a jar archive from the classes in the
  36 nifi-web-api war archive, that the modified files in the designtool-web
  37 module can be compiled against.