Change Environment Variables of a Module

Using the single server deployment guide, but not deploying with Vagrant, requires to make some changes to the deplyoment descriptions in that guide. Roughly speaking, it suffices not to use the Vagrantfile proposed in that guide and to use the IP address of the host that you are deploying on instead of the IP of the Vagrant host (for example in "okapiurl" in okapi.conf or as the env var "DB_HOST"). And to use the directory folio-install/runbooks/single-server (that you have checked out from github) instead of /vagrant. But I discovered that, since mod-pubsub and Kafka came into the play (thus since Q1-2020), that's not all.

Modules start up with environment variables, and if you don't change them, the default environment variables are being used.  Some environment variables are being set in the single server prescription, namely those for connecting the modules to the database. They are being set by posting global environment variables to Okapi, like e.g. this:

curl -w '\n' -D - -X POST -H "Content-Type: application/json" -d "{\"name\":\"DB_HOST\",\"value\":\"\"}" http://localhost:9130/_/env

For mod-pubsub, this is not enough. In particular, mod-pubsub needs to connect to Kafka and uses the env vars KAFKA_HOST and KAFKA_PORT for this, as can be seen e.g. here . It also needs OKAPI_URL to be set to the correct value. The default values are connecting to the Vagrant host

I applied the following steps to change the environment variables of a module. Firstly, it depends upon whether the module has already been deployed or not :

1 When the module has already been deployed

In this case, the module first needs to be undeployed, and then re-deployed. There are two ways to do the re-deploy:

1.1 Deploying without Okapi


  1.  Create a new, running container for module pub-sub by hand (or by docker standard tools, that is) (or you might use your own deployment method)

# 1.) Pull the desired module+version out of dockerhub and build a container from the image:
docker pull folioorg/mod-pubsub:1.2.5
# 1.1) Run the container and pass the desired environment variables to it (those which are deviating from the default values)(this example is running on localhost =
docker run --detach --name mod-pubsub-1.2.5 -e KAFKA_HOST= -e OKAPI_URL="" -e DB_HOST= -e DB_PORT=5432 -e DB_USERNAME=okapi -e DB_PASSWORD=okapi25 -e DB_DATABASE=okapi folioorg/mod-pubsub:1.2.5

2. Build deployment descriptor

 First we need to find out, where in the docker network the module has been deployed (by docker); we are using "docker inspect" for this:

docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' mod-pubsub-1.2.5
cat > pubsub-deployment-descriptor.json <<END
  "srvcId" : "mod-pubsub-1.2.5",
  "instId" : "mod-pubsub-1.2.5",
  "url" : ""

3. Disable the module for the tenant :

 First do a simulation run :

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[ { "id" : "mod-pubsub-1.2.5", "action" : "disable" } ]' http://localhost:9130/_/proxy/tenants/diku/install?simulate=true

Then actually disable the module :

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[ { "id" : "mod-pubsub-1.2.5", "action" : "disable" } ]' http://localhost:9130/_/proxy/tenants/diku/install?deploy=false\&preRelease=false

If there are missing dependencies, include them in the list of modules to be disabled, e.g. like this

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[ { "id" : "mod-pubsub-1.2.5", "action" : "disable" }, 
  { "id" : "folio_plugin-find-instance-6.1.2", "action" : "disable" }, 
  { "id" : "folio_orders-3.0.3", "action" : "disable" }, ... ]' 

4.  Undeploy the module instance of mod-pubsub which has been registered as a service to Okapi (the one which is running with the wrong env vars)

# First get Service-Id and InstId of the module:
curl -w '\n' -XGET http://localhost:9130/_/discovery/modules | jq '.[] | .srvcId + "/" + .instId' | grep pubsub
curl -w '\n' -D - -XDELETE http://localhost:9130/_/discovery/modules/mod-pubsub-1.2.5/8cd2ed01-08b3-44f1-8935-ec57a65f386b
HTTP/1.1 204 No Content
Content-Type: application/json
X-Okapi-Trace: DELETE okapi-3.1.2 /_/discovery/modules/mod-pubsub-1.2.5/8cd2ed01-08b3-44f1-8935-ec57a65f386b : 204 10759321us

5.  Send the new deplyoment descriptor of mod-pubsub to $OKAPI_URL/_/discovery/modules :

curl -i -w '\n' -X POST -H 'Content-type: application/json' -d @pubsub-deployment-descriptor.json http://localhost:9130/_/discovery/modules
HTTP/1.1 201 Created
Content-Type: application/json
Location: /_/discovery/modules/mod-pubsub-1.2.5/mod-pubsub-1.2.5
X-Okapi-Trace: POST okapi-3.1.2 /_/discovery/modules : 201 9906us
content-length: 105
  "instId" : "mod-pubsub-1.2.5",
  "srvcId" : "mod-pubsub-1.2.5",
  "url" : ""

6. Re-enable the module for your tenant:

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[ { "id" : "mod-pubsub-1.2.5", "action" : "enable" } ]' http://localhost:9130/_/proxy/tenants/diku/install?simulate=true

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[ { "id" : "mod-pubsub-1.2.5", "action" : "enable" } ]' http://localhost:9130/_/proxy/tenants/diku/install?deploy=false\&preRelease=false

This will re-enable also the dependent modules that had been disabled in step 3.

Do a health check to see if everything is O.K.:

curl -w '\n' -XGET http://localhost:9130/_/discovery/health
# => All "OK"

1.2 Deploying with Okapi

To deploy with Okapi, the launch descriptor (a part of the module descriptor) needs to be re-posted  to Okapi. Okapi only lets you do that if the module has not been enabled for any tenant.

(Thanks to Florian Rueckelshausen):

You can only post the modified module descriptor to OKAPI, once the old one has been deleted.

Here is a prescription:

# 1. Copy module descriptor into a file
curl -w '\n' -D -  http://localhost:9130/_/proxy/modules/mod-pubsub-1.2.5 > pubsubdescriptor.json
# 2. Edit module descriptor


       "name": "KAFKA_HOST",
       "value": ""
       "name": "OKAPI_URL",
       "value": ""

Save modified module descriptor.
# 3. Disable the module for the tenant => Equals to step 3. of 1.1
# 4. Undeploy Pubsub
curl -w '\n' -D - -X DELETE http://localhost:9130/_/discovery/modules/mod-pubsub-1.2.5

If that doesn't work, just stop the docker container manually; maybe it hasn't been deployed by Okapi the last time, but has been manually re-started:

docker stop <container-id>
# 5. Delete module descriptor of mod-pubsub
curl -X DELETE -D - -w '\n' http://localhost:9130/_/proxy/modules/mod-pubsub-1.2.5
# 6. Send modified module descriptor to Okapi
curl -w '\n' -D - -X POST -H "Content-Type: application/json" -d @pubsubdescriptor.json http://localhost:9130/_/proxy/modules
# 7. Redploy mod-pubsub with Okapi

curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[{ "id": "mod-pubsub-1.2.5", "action": "enable"}]' http://localhost:9130/_/proxy/tenants/diku/install?simulate=true\&preRelease=false
curl -w '\n' -D - -X POST -H "Content-type: application/json" -d '[{ "id": "mod-pubsub-1.2.5", "action": "enable"}]' http://localhost:9130/_/proxy/tenants/diku/install?deploy=true\&preRelease=false\&tenantParameters=loadSample%3Dfalse%2CloadReference%3Dtrue

 # 8. Do a health check to see if everything is O.K.:

curl -w '\n' -XGET http://localhost:9130/_/discovery/health

2 When the module has not yet been deployed

This use case typically occurs when you spin up a new system or re-deploy the complete system, e.g. after a major release change.

2.1 Deployment without Okapi

Tweak the environment variables of the module in the deployment tool of your choice (e.g. in Rancher-UI, as command line parameters to "docker", ...)

2.2 Deployment with Okapi

2.2.1 Set env vars in the module descriptor (to be more precise: in the launch descriptor)

Fetch the module descriptor for a single module separately from the folio registry:

wget -O mod-pubsub-1.2.5-module-descriptor.json

Change variables therein manually; adjust the launch descriptor inside the module descriptor:

vim mod-pubsub-1.2.5-module-descriptor.json
"launchDescriptor" : {
    "dockerImage" : "folioorg/mod-pubsub:1.2.5",
    "dockerPull" : true,
    "env" : [ {
      "name" : "JAVA_OPTIONS",
      "value" : "-XX:MaxRAMPercentage=66.0 -XX:+HeapDumpOnOutOfMemoryError"
    }, {
      "name" : "DB_HOST",
      "value" : ""
    }, {
      "name" : "DB_PORT",
      "value" : "5432"
    }, {
      "name" : "DB_USERNAME",
      "value" : "okapi"
    }, {
      "name" : "DB_PASSWORD",
      "value" : "okapi25"
    }, {
      "name" : "DB_DATABASE",
      "value" : "okapi"
    }, {
      "name" : "DB_QUERYTIMEOUT",
      "value" : "60000"
    }, {
      "name" : "DB_CHARSET",
      "value" : "UTF-8"
    }, {
      "name" : "DB_MAXPOOLSIZE",
      "value" : "5"
    }, {
      "name" : "KAFKA_HOST",
      "value" : ""
    }, {
      "name" : "KAFKA_PORT",
      "value" : "9092"
    }, {
      "name" : "OKAPI_URL",
      "value" : ""
    } ],

Delete the module descriptor of mod-pubsub (this is possible, because the module has not yet been deployed and enabled):

curl -X DELETE -D - -w '\n' http://localhost:9130/_/proxy/modules/mod-pubsub-1.2.5

Send the new module descriptor to /_/proxy/modules

curl -i -w '\n' -X POST -H 'Content-type: application/json' -d @mod-pubsub-1.2.5-module-descriptor.json http://localhost:9130/_/proxy/modules

Now proceed with the standard installation prescription (Create tenant, ..., deploy and enable all modules with Okapi (deploy=true)).