diff options
| -rw-r--r-- | docs/platform/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/platform/configuration.rst | 2 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 2 | ||||
| -rw-r--r-- | docs/platform/human-interfaces.rst | 2 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 7 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes.rst | 54 |
7 files changed, 63 insertions, 8 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index c952c20..915cda9 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 Kohn 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 London 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 db3dda8..c8d7169 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 Kohn release. Such functionalities will be provided in the future if necessary. +No machanism for customized configurtions is provided in the London release. Such functionalities will be provided in the future if necessary. diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index c0e1691..1861245 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -4,7 +4,7 @@ Consumed APIs ------------- -In the Kohn release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. +In the London release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. DCAE ^^^^ diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst index 3a36f4c..17cf1cb 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 Kohn release by Holmes is intended for the developers rather than the end users. +The human interfaces provided in the London release by Holmes is intended for the developers rather than the end users. Interface Type ^^^^^^^^^^^^^^ diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 26547d1..8ee231e 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -4,7 +4,7 @@ Installation ------------ -In the Kohn release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. +In the London release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. If a user wants to deploy Holmes using Helm, please refer to the OOM manual for help. @@ -27,10 +27,11 @@ Steps #. Start the engine manamgement module of Holmes using the command below: - ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hemtopics nexus3.onap.org:10001/onap/holmes/engine-management:10.0.2`` + ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -e BASE_URL=$BASE_URL -e PRE_ADDR=$PRE_ADDR -e POST_ADDR=$POST_ADDR -e AAI_ADDR=$AAI_ADDR -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hemtopics nexus3.onap.org:10001/onap/holmes/engine-management:10.0.2`` -All the interactions between Holmes and other ONAP components are routed by MSB. In order to register Holmes itself to MSB, the users have to specify the IP address of the host using the ``HOST_IP`` variable. Please note that the ``HOST_IP`` should be the IP address of the host, rather than the IP address of the containers (of which the IP address is allocated by the docker daemon). +All the interactions between Holmes and other ONAP components are routed by MSB or Ingress. In order to register Holmes itself to MSB, the users have to specify the IP address of the host using the ``HOST_IP`` variable. Please note that the ``HOST_IP`` should be the IP address of the host, rather than the IP address of the containers (of which the IP address is allocated by the docker daemon). ``ENABLE_ENCRYPT`` specifies whether HTTPS is enabled. When it is set to "false", only the HTTP schema is allowed. Otherwise, only HTTPS is allowed. ``LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES`` specifies the place where corresponding configuration files are stored. The configuration files should be organized as `files for the rule management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-rule-mgmt/resources/rules;h=e3071f02c0143bd5774967bd7148d73afeb8a17c;hb=HEAD>`_ and `files for the engine management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-engine-mgmt/resources/config;h=6a43bc35fa56731379956da08f766aa8d0abdd53;hb=HEAD>`_ (only *cfy.json* is needed in the standalone mode). +All the addresses are organized in the form of (taking A&AI as an example) ``http(s)://$PRE_ADDR$AAI_ADDR$POST_ADDR.$BASE_URL`` within Holmes. Whether TLS is enabled depends on the value of the environment variable ``ENABLE_ENCRYPT`` Check the Status of Holmes ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst index 73b5c5b..6d376db 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 Kohn 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 London 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index dd804b1..0fd8ea5 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,6 +11,60 @@ 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. +Holmes Rule Management Release Notes +==================================== + +Holmes provides alarm correlation and analysis for telecom cloud infrastructure +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: 12.0.0 +--------------- + +:Release Date: 2023-06-08 + + +**New Features** + +- `Added support for Ingress <https://jira.onap.org/browse/HOLMES-612>`_ + +**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. +- `Unable to perform CRUD operations on rules when multiple engine instances running <https://jira.onap.org/browse/HOLMES-493>`_ (a potential problem, not reproduced) +- `Inconsistency of alarm processing when multiple engine instances running <https://jira.onap.org/browse/HOLMES-494>`_ (a potential problem, not reproduced) + +**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: 11.0.0 --------------- |