diff options
Diffstat (limited to 'ice-server/README.MD')
| -rw-r--r-- | ice-server/README.MD | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/ice-server/README.MD b/ice-server/README.MD new file mode 100644 index 0000000..87a5341 --- /dev/null +++ b/ice-server/README.MD @@ -0,0 +1,32 @@ +Introduction: +============= +This document provides the required steps for running the +heat validation rest service in a development environment. +If you only want to run it, go to distribution directory. + +Installation steps: +==================== +Install following software: +- python 3.4 or latest + +Configuration steps: +==================== +you can override the defaults settings (declared in default_settings.py) +if needed by pointing the env variable ICE_SETTINGS to a file +with the appropriate values : + +``$ export ICE_SETTINGS='/path/to/my/production/settings.py'`` + +How to run? +=========== + - In command console, cd to directory where this service is installed + - use virtualenv if needed + - ``$ pip install -r requirements.txt`` + - check that everything is ok by running unit tests : ``$ tox`` + - ``$ python app.py`` + - Once service is started, from MSB service, verify that "ice-test" is reported from GET request on "/openoapi/microservices/v1/services" + +Debug/development Mode +========== + debug mode is activated by default + in debug mode, the swagger ui is available on http://127.0.0.1:5000/onapapi/ice/v1/ui
\ No newline at end of file |