Name: acme-freight-recommendation
Owner: International Business Machines
Description: null
Created: 2017-04-06 20:37:33.0
Updated: 2017-06-09 20:35:56.0
Pushed: 2017-07-10 15:52:05.0
Homepage: null
Size: 1647
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
| master | | | —– | —– | | dev | |
This service is part of the larger Acme Freight project.
This service monitors the weather conditions around retail stores and makes recommendations on additional shipments of goods.
It is built with OpenWhisk highlighting how OpenWhisk can be used to implement a backend API. The OpenWhisk actions are:
Recommend - given weather conditions, it evaluates the impact of the weather on shipments and stocks and makes recommendations for additional shipments, rerouting, etc.
Retrieve - returns the recommendations to be considered by a retail store manager.
Acknowledge - marks the recommendations as processed (approved or rejected) by a retail store manager.
Observations - returns weather conditions at a given location.
Notify - formats recommendations for notification messages.
For demo purpose, the Recommend action can be called interactively to inject a weather event into the system.
If you do not already have a Bluemix account, sign up here
The recommendation service depends on the Controller and ERP microservices. Make sure to deploy them first.
In Bluemix, create an instance of the Weather Company Data service
reate-service weatherinsights Free-v2 acme-freight-weatherinsights
Create a set of credentials for this service
reate-service-key acme-freight-weatherinsights for-openwhisk
View the credentials and take note of the url
value
ervice-key acme-freight-weatherinsights for-openwhisk
Create an instance of Cloudant to store the recommendations
reate-service cloudantNoSQLDB Lite acme-freight-recommendation-db
Create a set of credentials for this service
reate-service-key acme-freight-recommendation-db for-openwhisk
View the credentials and take note of the url
value
ervice-key acme-freight-recommendation-db for-openwhisk
Clone the app to your local environment from your terminal using the following command:
clone https://github.com/ibm/acme-freight-recommendation.git
cd
into the checkout directory
Copy the file named template-local.env into local.env
emplate-local.env local.env
In local.env, update the location of the CONTROLLER_SERVICE, the url of the Weather Company Data service, the url of the Cloudant database.
Get the dependencies, and use webpack module bundler to create our final .js actions in the dist
folder.
install
run build
Ensure your OpenWhisk command line interface is property configured with:
list
This shows the packages, actions, triggers and rules currently deployed in your OpenWhisk namespace.
Deploy the OpenWhisk artifacts
ploy.sh --install
Note: the script can also be used to –uninstall the OpenWhisk artifacts to –update the artifacts if you change the action code, or simply with –env to show the environment variables set in local.env.
| File | Description |
| —- | ———– |
|deploy.sh|Helper script to create the recommendations database, install, uninstall, update the OpenWhisk trigger, actions, rules.|
|template-local.env|Contains environment variables used by the deployment script. Duplicate this file into local.env
to customize it for your environment.|
|package.json|List dependencies used by the actions and the build process.|
|webpack.config.js|Webpack configuration used to build OpenWhisk actions. This allows the actions to use modules (module versions) not packaged natively by OpenWhisk. Make sure to add explicit dependencies in the package.json for specific module versions used by the actions. The webpack build will look at the “dependencies” and webpack them. If a module is not listen in “dependencies” it is assumed to be provided by OpenWhisk.|
|recommend.js|Entry point for the Recommend action.|
|prepare-for-slack.js|Entry point for the Notify action. It formats newly added recommendations into a text suitable for a Slack post message.|
|retrieve.js|Entry point for the Retrieve action.|
|acknowledge.js|Entry point for the Acknowledge action.|
|observations.js|Entry point for the Observations action.|
|test|Unit test for the actions to be executed outside of OpenWhisk.|
Polling activations is good start to debug the OpenWhisk action execution. Run
activation poll
and invoke actions.
See LICENSE for license information.