diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/platform/configuration.rst | 2 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 6 | ||||
| -rw-r--r-- | docs/platform/human-interfaces.rst | 2 | ||||
| -rw-r--r-- | docs/platform/index.rst | 2 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 8 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes.rst | 66 |
9 files changed, 69 insertions, 25 deletions
diff --git a/docs/index.rst b/docs/index.rst index 7767fb9..0a16914 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,6 @@ as well as the release notes of Holmes in this document. .. toctree:: :maxdepth: 1 - + platform/index.rst release-notes.rst diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index 39bb8d1..80a3496 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -5,7 +5,7 @@ Holmes Architecture ------------------- -Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Guilin release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy. +Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Honolulu release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy. .. image:: images/overall-architecture-in-onap.png diff --git a/docs/platform/configuration.rst b/docs/platform/configuration.rst index f3308e7..01893a4 100644 --- a/docs/platform/configuration.rst +++ b/docs/platform/configuration.rst @@ -4,5 +4,5 @@ Configuration ------------- -No machanism for customized configurtions is provided in the Guilin release. Such functionalities will be provided in the future if necessary. +No machanism for customized configurtions is provided in the Honolulu release. Such functionalities will be provided in the future if necessary. diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 7b06e0e..9c0a0ff 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -4,7 +4,7 @@ Consumed APIs ------------- -In the Guilin release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. +In the Honolulu release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. DCAE ^^^^ @@ -30,10 +30,10 @@ In order to get the correlation between different alarms with the help of the to #. Query a VM by ID: - ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}`` + ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}`` More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.action?pageId=13598793>`_. - + DMaaP ^^^^^ diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst index fd5409a..24142a2 100644 --- a/docs/platform/human-interfaces.rst +++ b/docs/platform/human-interfaces.rst @@ -7,7 +7,7 @@ Human Interfaces Target Users ^^^^^^^^^^^^ -The human interfaces provided in the Guilin release by Holmes is intended for the developers rather than the end users. +The human interfaces provided in the Honolulu release by Holmes is intended for the developers rather than the end users. Interface Type ^^^^^^^^^^^^^^ diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 441d0a9..f279434 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -7,7 +7,7 @@ Holmes provides alarm correlation and analysis for Telecom cloud infrastructure .. toctree:: :maxdepth: 1 - + architecture.rst offeredapis.rst consumedapis.rst diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 1b8d51e..ee3f2e5 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -4,7 +4,7 @@ Installation ------------ -In the Guilin release, Holmes is deployed as an analytic application by the DCAE controller. So the users do not have to install it on their own. +In the Honolulu release, Holmes is deployed as an analytic application by the DCAE controller. So the users do not have to install it on their own. In case the users want to deploy Holmes independently, the steps for the installation is as follows. @@ -13,7 +13,7 @@ Prerequisites #. MSB must be installed and started. The user knows the IP address of the MSB API gateway service. #. PostgreSQL must be installed and started. For the guidance on how to run a PostgreSQL, please refer to `Offical Repository of PostgreSQL <https://hub.docker.com/_/postgres/>`_. - + **While setting up PostgreSQL, a database and a user named 'holmes' must be created. The corresponding password shuold be set to 'holmespwd'. Otherwise, Holmes could not be started up successfully.** Steps @@ -21,7 +21,7 @@ Steps #. Start the rule management module of Holmes using the command below: - ``sudo docker run --name holmes-rule-management -p 9101:9101 -p 9201:9201 -p 9104:9104 -p 9105:9105 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false nexus3.onap.org:10001/onap/holmes/rule-management`` + ``sudo docker run --name holmes-rule-management -p 9101:9101 -p 9201:9201 -p 9104:9104 -p 9105:9105 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false nexus3.onap.org:10001/onap/holmes/rule-management`` #. Start the engine manamgement module of Holmes using the command below: @@ -35,7 +35,7 @@ Check the Status of Holmes After the installation, you have to check whether Holmes is alive or not using the health-check API. -#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-rule-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the rule management module of Holmes has been spun up and registered to MSB successfully. +#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-rule-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the rule management module of Holmes has been spun up and registered to MSB successfully. #. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-engine-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the engine management module of Holmes has been spun up and registered to MSB successfully. diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst index 9a09b8e..68cd46e 100644 --- a/docs/platform/log-and-diagnostic-info.rst +++ b/docs/platform/log-and-diagnostic-info.rst @@ -4,7 +4,7 @@ Logging & Diagnostic Information --------------------------------- -In the Guilin release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running. +In the Honolulu release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running. Where to Access Information ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -17,7 +17,7 @@ There are two ways for a user to get the logs. ``sudo docker logs holmes-rule-mgmt`` Then the logs will be displayed in the command window. - + * Get into the docker containers by running ``sudo docker exec -it ${docker-name} sh``. Go to the path ``/var/log/ONAP/holmes/`` and find the logs there. Error / Warning Messages diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 06d1e94..33cecf8 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,6 +11,50 @@ and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure or degradation of services by digging into the ocean of events collected from different levels of the telecom cloud. +Version: 8.0.1 +-------------- + +:Release Date: 2021-04-01 + + +**New Features** + +- `HOLMES-380 <https://jira.onap.org/browse/HOLMES-380>`_ Migrate Holmes deployment to Helm + +**Bug Fixes** + +N/A + +**Known Issues** + +- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module. +- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future. + +**Security Issues** + +HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. + +Quick Links: + - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ + + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ + + +**Upgrade Notes** + +N/A + + +**Deprecation Notes** + +N/A + + +**Other** + +N/A + + Version: 7.0.1 -------------- @@ -33,11 +77,11 @@ Version: 7.0.1 **Security Issues** -HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. +HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. Quick Links: - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ @@ -76,11 +120,11 @@ N/A **Security Issues** -HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. +HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. Quick Links: - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ @@ -122,11 +166,11 @@ Added some tools to support the extended CCVPN use case: **Security Issues** -HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. +HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. Quick Links: - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ @@ -176,9 +220,9 @@ HOLMES code has been formally scanned during build time using NexusIQ and all Cr Quick Links: - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ - + - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_ @@ -216,7 +260,7 @@ Besides, Holmes has been enhanced to meet the platform maturity requirements. Th - Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data. -- Security: Holmes has updated all its APIs to support the HTTPS protocol. +- Security: Holmes has updated all its APIs to support the HTTPS protocol. **Bug Fixes** @@ -233,9 +277,9 @@ HOLMES code has been formally scanned during build time using NexusIQ and all Cr Quick Links: - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ - + - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_ |