Aggies sprint9 staging merge

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 William Welling
+Copyright (c) 2024 Texas A&M University Libraries
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -27,6 +27,109 @@ yarn okapi
 vagrant up release
 ```
 
+## Building images for deployment
+
+Update `Vagrantfile` with a synced directory to fw-cli for mod-workflow and mod-camunda development.
+
+```
+snapshot.vm.synced_folder "C:/Users/FOLIO/Development/work/FOLIO/fw-cli", "/home/vagrant/fw-cli", owner: "vagrant", group: "vagrant", mount_options: ["uid=1000", "gid=1000"]
+```
+> ***Be sure to update the host machine path.***
+
+## Running FOLIO Locally
+
+```
+vagrant up snapshot
+```
+
+Wait for Okapi to start all the modules.
+
+```
+vagrant ssh snapshot
+```
+
+Check to see if Okapi is ready.
+```
+docker logs okapi -n 100 -f
+```
+
+Goto http://localhost:3000 and login.
+
+
+## Build the jar file and descriptors on the host machine
+
+```
+cd spring-module-core
+# git checkout <branch>
+mvn clean package
+
+cd ../mod-workflow
+# git checkout <branch>
+mvn clean package
+
+cd ../mod-camunda
+# git checkout <branch>
+mvn clean package
+```
+
+## Build the docker images on the folio/snapshot vagrant docker client
+
+```
+vagrant ssh snapshot
+```
+
+From `/home/vagrant`:
+```
+cd fw-cli
+
+cd mod-workflow
+docker build -t docker.ci.folio.org/mod-workflow:1.2.0-SNAPSHOT .
+
+cd ../mod-camunda
+docker build -t docker.ci.folio.org/mod-camunda:1.2.0-SNAPSHOT .
+```
+
+> ***Update versions according to corresponding pom.xml***
+
+
+## Run mod-workflow and mod-camunda with folio/snapshot
+
+A bare minimum setup script `setup.js` is available to perform the necessary requests to run the modules with Okapi. This requires the previous steps of building jar files and module descriptors on the host and building the Docker images on the Vagrant VM.
+
+From `/home/vagrant/fw-cli`:
+```
+node ./setup.js
+```
+
+## Update user permissions for mod-workflow and mod-camunda
+
+The following permissions are required. There is additional ui-workflow permissions required when bundling and running ui-workflow with stripes. This is not yet available in folio/snapshot and is not provided here.
+
+```
+"workflow.actions.all",
+"workflow.events.all",
+"workflow.nodes.all",
+"workflow.nodes.item.post",
+"workflow.triggers.all",
+"workflow.tasks.all",
+"workflow.workflows.all",
+"camunda.history.all",
+"camunda.message.all",
+"camunda.process.all",
+"camunda.process-definition.all",
+"camunda.decision-definition.all",
+"camunda.task.all",
+"camunda.workflow-engine.workflows.all"
+```
+
+## Watch Kafka broker
+
+```
+docker run -d --name kafka-ui --user 1000:1000 -p 8080:8080 -e KAFKA_CLUSTERS_0_NAME=folio -e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=10.0.2.15:9092 -e KAFKA_CLUSTERS_0_ZOOKEEPER=10.0.2.15:2181 provectuslabs/kafka-ui:latest
+```
+
+Open http://localhost:8080 in the browser to see the kafka-ui interface.
+
 ## Running Workflow Modules Locally
 
 ```

Vagrantfile

@@ -10,38 +10,62 @@ Vagrant.configure(2) do |config|
   end
 
   config.vm.provider "virtualbox" do |vb|
-    vb.memory = 12288
-    vb.cpus = 4
-  end
-
-  # https://app.vagrantup.com/folio/boxes/snapshot-backend-core
-  config.vm.define "snapshot-backend-core", autostart: false do |snapshot_backend_core|
-    snapshot_backend_core.vm.box = "folio/snapshot-backend-core"
-  end
-
-  # https://app.vagrantup.com/folio/boxes/snapshot-core
-  config.vm.define "snapshot-core", autostart: false do |snapshot_core|
-    snapshot_core.vm.box = "folio/snapshot-core"
+    vb.memory = 36864
+    vb.cpus = 8
   end
 
   # https://app.vagrantup.com/folio/boxes/snapshot
   config.vm.define "snapshot", autostart: false do |snapshot|
     snapshot.vm.box = "folio/snapshot"
-  end
 
-  # https://app.vagrantup.com/folio/boxes/testing-backend
-  config.vm.define "testing-backend", autostart: false do |testing_backend|
-    testing_backend.vm.box = "folio/testing-backend"
-  end
+    snapshot.vm.synced_folder "C:/Users/FOLIO/fw-cli", "/home/vagrant/fw-cli", owner: "vagrant", group: "vagrant", mount_options: ["uid=1000", "gid=1000"]
 
-  # https://app.vagrantup.com/folio/boxes/testing
-  config.vm.define "testing", autostart: false do |testing|
-    testing.vm.box = "folio/testing"
+    # okapi
+    snapshot.vm.network "forwarded_port", guest: 9130, host: 9130
+    # stripes
+    snapshot.vm.network "forwarded_port", guest: 3000, host: 3000
+    # 
+    snapshot.vm.network "forwarded_port", guest: 8000, host: 8130
+    # kafka-ui
+    snapshot.vm.network "forwarded_port", guest: 8080, host: 8080
+    # postgres
+    snapshot.vm.network "forwarded_port", guest: 5432, host: 5432
+    # kafka
+    # snapshot.vm.network "forwarded_port", guest: 9092, host: 9092
+    # kafka
+    # snapshot.vm.network "forwarded_port", guest: 29092, host: 29092
+    # zookeeper
+    # snapshot.vm.network "forwarded_port", guest: 2181, host: 2181
+    #
+    # snapshot.vm.network "forwarded_port", guest: 9001, host: 9001
+    # snapshot.vm.network "forwarded_port", guest: 9002, host: 9002
   end
 
   # https://app.vagrantup.com/folio/boxes/release
   config.vm.define "release", autostart: false do |release|
     release.vm.box = "folio/release"
+
+    release.vm.synced_folder "C:/Users/FOLIO/fw-cli", "/home/vagrant/fw-cli", owner: "vagrant", group: "vagrant", mount_options: ["uid=1000", "gid=1000"]
+
+    # okapi
+    release.vm.network "forwarded_port", guest: 9130, host: 9130
+    # stripes
+    release.vm.network "forwarded_port", guest: 3000, host: 3000
+    # 
+    release.vm.network "forwarded_port", guest: 8000, host: 8130
+    # kafka-ui
+    release.vm.network "forwarded_port", guest: 8080, host: 8080
+    # postgres
+    release.vm.network "forwarded_port", guest: 5432, host: 5432
+    # kafka
+    # release.vm.network "forwarded_port", guest: 9092, host: 9092
+    # kafka
+    # release.vm.network "forwarded_port", guest: 29092, host: 29092
+    # zookeeper
+    # release.vm.network "forwarded_port", guest: 2181, host: 2181
+    #
+    # release.vm.network "forwarded_port", guest: 9001, host: 9001
+    # release.vm.network "forwarded_port", guest: 9002, host: 9002
   end
 
 end

package.json

@@ -2,7 +2,6 @@
   "name": "fw-cli",
   "version": "1.0.1",
   "description": "FOLIO Workflow CLI",
-  "author": "William Welling <[email protected]>",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
@@ -15,27 +14,28 @@
     "fw": "bin/index.js"
   },
   "dependencies": {
-    "axios": "1.6.0",
+    "axios": "1.7.7",
     "chalk": "4.1.2",
     "clear": "0.1.0",
-    "commander": "8.3.0",
+    "commander": "9.5.0",
     "compression": "1.7.4",
     "conf": "10.2.0",
-    "core-js": "3.26.1",
+    "core-js": "3.38.1",
     "cors": "2.8.5",
-    "express": "4.18.2",
-    "figlet": "1.5.2",
-    "handlebars": "4.7.7",
+    "express": "4.21.0",
+    "figlet": "1.7.0",
+    "handlebars": "4.7.8",
     "handlebars-loader": "1.7.3",
     "path": "0.12.7",
     "request": "2.88.2"
   },
   "devDependencies": {
     "@types/commander": "2.12.2",
-    "@types/core-js": "2.5.5",
-    "@types/node": "17.0.10",
-    "ts-node": "10.4.0",
+    "@types/core-js": "2.5.8",
+    "@types/node": "22.5.5",
+    "ts-node": "10.9.2",
     "tslint": "6.1.3",
-    "typescript": "4.5.5"
-  }
+    "typescript": "5.6.2"
+  },
+  "packageManager": "[email protected]+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
 }