...
Sub-Components
Please refer to the Resources and Repositories page.
Architecture
High level architecture diagram
...
Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
- Document current upgrade component strategy
- For the application itself, since it's based on microservices, it's easy to replace the docker containers with the required version. The main focus for upgrade is to adapt the application to the database related changes. To achieve, we intend to add new DDLs as script files with a specific version number into the new docker image, assuring that each new image has all DDLs (which reflect the changes on the database) contained in older images. We use the version number of the script files as a trace to upgrade our application by running the script files contained in the image version by version.
- SECCOM Perform Software Composition Analysis - Vulnerability tables
- We'll check and update the vulnerability table of Holmes before each milestone comes. The corresponding ticket could be found in JIRA backlog.
- SECCOM Password removal from OOM HELM charts
- There's no password in OOM HELM chart for HOLMES.
- SECCOM HTTPS communication vs. HTTP
- There's a switch for users within Holmes to decide whether they want to enable HTTP or not. By default, HTTP is disabled for Holmes containers. But users could enable it by changing the parameter when running the docker container.
API Incoming Dependencies
List the API this project is expecting from other projects.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Data Movement as a Platform APIs | DMaaP message sub/pub related APIs which will be used by Holmes to collect the data from and publish data to DMaaP topics. | |||
| Resource Query | Query different resource information from A&AI. All A&AI operations are implemented in the form of RESTful APIs. I'm using "Resource Query" as a general name for the APIs in case there will be too many APIs listed here. | AAI API | ||
| DCAE APIs | APIs used for service registration and discovery. | DCAE API Documentation | ||
Service Registration/Un-registration Service Discovery | The APIs used to register/un-register a micro-service to/from MSB . The APIs used to discover another micro-service via MSB. | Microservice Bus API Documentation |
API Outgoing Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Rule Creating | This API is intended for creating a rule in the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Rule Modifying | This API is intended for modifying a rule in the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Rule Deleting | This API is intended for deleting a rule from the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Rule Query | This API is intended for querying rules from the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Health Check | This API is used by other components to check whether Holmes is working. |
| August, 24th, 2017 | Health Check - Dublin |
Third Party Products Dependencies
...
Please update any risk on the centralized wiki page - Frankfurt Risks
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
...