Coverage Report
| File | Stmts | Miss | Cover | Missing |
|---|---|---|---|---|
| idsse/common | ||||
| init.py | 0 | 0 | 100% | |
| aws_utils.py | 91 | 7 | 7 | 92% |
| config.py | 69 | 5 | 5 | 93% |
| json_message.py | 24 | 1 | 1 | 96% |
| log_util.py | 41 | 3 | 3 | 93% |
| path_builder.py | 128 | 10 | 10 | 92% |
| rabbitmq_utils.py | 202 | 88 | 88 | 56% |
| utils.py | 122 | 10 | 10 | 92% |
| validate_schema.py | 40 | 0 | 100% | |
| idsse/common/sci | ||||
| init.py | 0 | 0 | 100% | |
| bit_pack.py | 84 | 3 | 3 | 96% |
| geo_image.py | 236 | 17 | 17 | 93% |
| grid_proj.py | 95 | 1 | 1 | 99% |
| netcdf_io.py | 48 | 0 | 100% | |
| utils.py | 10 | 0 | 100% | |
| vectaster.py | 190 | 17 | 17 | 91% |
| TOTAL | 1380 | 162 | 88% | |
The idss-engine-commons project is responsible for defining all implicit common dependencies that are used by the apps that make up the IDSS Engine Project distributed system. This
repository should be used to house elements that are common across multiple projects to encourage reuse.
The complete twelve-factors methodologies that the IDSS Engine Project adheres to can be found in the umbrella idss-engine repository. The subset of the twelve factors that follows are specifics to this app only.
To support some standardization and best practices for IDSS Engine, developers should following the logging guide found here
The subsections below outline how to build the common images within this project. All microservices built with Docker are done within the idss-engine/build directory.
Recommended Tags development
:devstable release:releaseie.:aldertargeted environment:aws
Any python based microservice within IDSS Engine should use the following image as its base
From the IDSS Engine project root directory idss-engine/build/<env>/<arch>/:
$ docker-compose build python_base
Image Name
idsse/commons/python-base:<tag>
Any python based microservice within IDSS Engine that requires python scientific packages (numpy, netcdf, etc) should use the following image as its base. This base image also includes common python utilities that other services can utilize. For specifics on what these utilities are, see the README within the idsse_commons directory.
From the IDSS Engine project root directory idss-engine/build/<env>/<arch>/:
$ docker-compose build python_base_sci
Image Name
idsse/commons/python-base-sci:<tag>
The IDSS Engine can be deployed with Docker and/or Kubernetes. If developers are deploying locally with Docker, they can create their own RabbitMQ service as follows:
Developer Note if deploying in a kubernetes cluster, it is not necessary to build this image as it will be done via a Helm Chart
From the IDSS Engine project root directory idss-engine/build/<env>/<arch>/:
$ docker-compose build rabbit_mq
Development Image Name idss.engine.commons.rabbitmq.server:<tag>
Packaged/Deployed Image Name idsse/commons/rabbitmq:<tag>
The IDSS Engine can be deployed with Docker and/or Kubernetes. If developers are deploying locally with Docker, they can create their own RabbitMQ service as follows:
Developer Note if deploying in a kubernetes cluster, it is not necessary to build this image as it will be done via a Helm Chart
From the IDSS Engine project root directory idss-engine/build/<env>/<arch>/:
$ docker-compose build couch_db
Development Image Name idss.engine.commons.couchbase.server:<tag>
Packaged/Deployed Image Name idsse/commons/couchdb:<tag>
See the Build, Release, Run section within the umbrella project documentation: [idss-engine](https://github.com/NOAA-GSL/idss-engine/blob/main/README.md#running-idss-engine)