From 40447bfa0d37e92da34427674cd19063fd9651dd Mon Sep 17 00:00:00 2001 From: Tao Liu Date: Thu, 16 Aug 2018 12:05:42 -0400 Subject: [PATCH] Decouple Fault Management from stx-config Add FM rest API document Remove the alarm and log APIs from sysinv rest API document Update the collect script with the FM config file new location Story: 2002828 Task: 22747 Depends-On: https://review.openstack.org/#/c/591452/ Change-Id: Ica507af0b6b0dc137bf1e469cdaed678917f24e8 Signed-off-by: Tao Liu --- .../restapi-doc/api-ref-guides/pom.xml | 11 + .../api-ref-guides/src/bk-api-ref-fm-v1.xml | 57 +++ .../api-ref-guides/src/bk-api-ref.xml | 1 + restapi-doc/restapi-doc/api-ref/pom.xml | 11 + .../api-ref/src/docbkx/api-ref-fm-v1.xml | 30 ++ .../api-ref/src/docbkx/ch_fm-api-v1.xml | 110 ++++ .../api-ref/src/docbkx/ch_sysinv-api-v1.xml | 75 +-- .../src/docbkx/itemizedlist-service-list.xml | 4 + .../v1/api_samples/alarm-response.json | 0 .../v1/api_samples/alarm_list-request.json | 1 + .../v1/api_samples/alarm_list-response.json | 0 .../api_samples/alarm_summary-response.json | 0 .../api_samples/event_log_list-request.json | 1 + .../api_samples/event_log_list-response.json | 0 .../api_samples/event_log_show-response.json | 0 .../event_suppression_list-request.json | 1 + .../event_suppression_list-response.json | 0 .../event_suppression_modify-request.json | 0 .../event_suppression_modify-response.json | 0 .../v1/api_samples/fm-versions-response.json | 24 + .../v1/api_samples/version-get-response.json | 24 + .../api_samples/versionv1-get-response.json | 50 ++ .../api-ref/src/wadls/fm-api/v1/common.ent | 436 ++++++++++++++++ .../src/wadls/fm-api/v1/fm-api-v1.wadl | 469 ++++++++++++++++++ .../v1/api_samples/alarm_list-request.json | 1 - .../api_samples/event_log_list-request.json | 1 - .../event_suppression_list-request.json | 1 - .../api_samples/sysinv-versions-response.json | 2 +- .../v1/api_samples/version-get-response.json | 2 +- .../api_samples/versionv1-get-response.json | 30 -- .../src/wadls/sysinv-api/v1/common.ent | 308 ------------ .../wadls/sysinv-api/v1/sysinv-api-v1.wadl | 382 -------------- .../collector/scripts/collect_mask_passwords | 2 +- 33 files changed, 1235 insertions(+), 799 deletions(-) create mode 100644 restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-fm-v1.xml create mode 100644 restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-fm-v1.xml create mode 100644 restapi-doc/restapi-doc/api-ref/src/docbkx/ch_fm-api-v1.xml rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/alarm-response.json (100%) create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-request.json rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/alarm_list-response.json (100%) rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/alarm_summary-response.json (100%) create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-request.json rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/event_log_list-response.json (100%) rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/event_log_show-response.json (100%) create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-request.json rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/event_suppression_list-response.json (100%) rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/event_suppression_modify-request.json (100%) rename restapi-doc/restapi-doc/api-ref/src/wadls/{sysinv-api => fm-api}/v1/api_samples/event_suppression_modify-response.json (100%) create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/fm-versions-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/version-get-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/versionv1-get-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/common.ent create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/fm-api-v1.wadl delete mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-request.json delete mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-request.json delete mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-request.json diff --git a/restapi-doc/restapi-doc/api-ref-guides/pom.xml b/restapi-doc/restapi-doc/api-ref-guides/pom.xml index 0047e3735..f2669c716 100644 --- a/restapi-doc/restapi-doc/api-ref-guides/pom.xml +++ b/restapi-doc/restapi-doc/api-ref-guides/pom.xml @@ -154,6 +154,17 @@ SPDX-License-Identifier: Apache-2.0 api-ref-smapi-v1 + + os-api-ref-fm-v1 + + generate-pdf + + generate-sources + + bk-api-ref-fm-v1.xml + api-ref-fm-v1 + + api-ref-guides diff --git a/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-fm-v1.xml b/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-fm-v1.xml new file mode 100644 index 000000000..24ee51992 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-fm-v1.xml @@ -0,0 +1,57 @@ + + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + + Titanium Fault Management API v1 + API Reference + + + + + + + Wind River + + + + 2018 + Wind River + + Titanium Cloud + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml b/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml index 532896db5..299f16579 100644 --- a/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml +++ b/restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml @@ -49,4 +49,5 @@ SPDX-License-Identifier: Apache-2.0 + diff --git a/restapi-doc/restapi-doc/api-ref/pom.xml b/restapi-doc/restapi-doc/api-ref/pom.xml index 49b5f37ba..83b21ee68 100644 --- a/restapi-doc/restapi-doc/api-ref/pom.xml +++ b/restapi-doc/restapi-doc/api-ref/pom.xml @@ -87,6 +87,17 @@ SPDX-License-Identifier: Apache-2.0 bk-dcmanager-api-v1 + + fm-api-v1 + + generate-html + + generate-sources + + api-ref-fm-v1.xml + bk-fm-api-v1 + + os-api-ref-compute-v2-cgcs-ext diff --git a/restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-fm-v1.xml b/restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-fm-v1.xml new file mode 100644 index 000000000..fca013489 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-fm-v1.xml @@ -0,0 +1,30 @@ + + + + + Titanium Fault Management API v1 + + 2017 + Wind River + + + + + + + + + + diff --git a/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_fm-api-v1.xml b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_fm-api-v1.xml new file mode 100644 index 000000000..2884f048b --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_fm-api-v1.xml @@ -0,0 +1,110 @@ + + + + Fault Management API v1 + The API supports alarm and event collection of the cloud platform itself. + The typical port used for the FM REST API is 18002. + However, proper technique would be to look up the FM service endpoint in Keystone. + + + + + + +
+ API versions + + + + + + + + +
+ + + + + +
+ Alarms + These APIs allow the display of the Active Alarms + in the system. + + + + + + + + + + + + + + +
+ + + + + + +
+ Event Log + These APIs allow the display of the Event Log + in the system. The Event log contains both historical alarms and customer logs. + + + + + + + + +
+ + + + + + +
+ Event Suppression + These APIs allow the display of the Event Suppression state + in the system. + + + + + + + + +
+ + diff --git a/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml index 0d0aa76b7..fd01cec26 100644 --- a/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml +++ b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml @@ -16,8 +16,8 @@ SPDX-License-Identifier: Apache-2.0 SysInv API v1 Manage physical servers with the Titanium System Inventory API. This includes inventory collection and configuration of nodes, ports, interfaces, CPUs, disks, - partitions, memory, and sensors. The API also supports alarm collection for fault - events of the cloud itself as well as configuration of the cloud's SNMP interface. + partitions, memory, and sensors. The API also supports configuration of the + cloud's SNMP interface. The typical port used for the SysInv REST API is 6385. However, proper technique would be to look up the sysinv service endpoint in Keystone. @@ -633,77 +633,6 @@ configuration entity for the system. - - - - -
- Alarms - These APIs allow the display of the Active Alarms - in the system. - - - - - - - - - - - - - - -
- - - - - - -
- Event Log - These APIs allow the display of the Event Log - in the system. The Event log contains both historical alarms and customer logs. - - - - - - - - -
- - - - - - -
- Event Suppression - These APIs allow the display of the Event Suppression state - in the system. - - - - - - - - -
- - diff --git a/restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml b/restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml index 0f568bb4c..4516ec933 100644 --- a/restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml +++ b/restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -46,4 +46,8 @@ SPDX-License-Identifier: Apache-2.0 Titanium SM API Service API v1 + + Titanium Fault Management Service + API v1 + diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-request.json new file mode 100644 index 000000000..306e7969d --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-request.json @@ -0,0 +1 @@ +http://192.168.204.2:18002/v1/alarms?q.field=severity&q.op=eq&q.type=&q.value=major&include_suppress=True diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_summary-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_summary-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_summary-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_summary-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-request.json new file mode 100644 index 000000000..aad8f464b --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-request.json @@ -0,0 +1 @@ +http://192.168.204.2:18002/v1/event_log?q.field=start&q.field=end&q.op=eq&q.op=eq&q.type=&q.type=&q.value=2014-11-28T16%3A56%3A44&q.value=2014-11-28T16%3A56%3A45&limit=2 diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_show-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_show-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_show-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_show-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-request.json new file mode 100644 index 000000000..82603d52b --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-request.json @@ -0,0 +1 @@ +http://192.168.204.2:18002/v1/event_suppression diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-request.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-request.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-request.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-response.json similarity index 100% rename from restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-response.json rename to restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/fm-versions-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/fm-versions-response.json new file mode 100644 index 000000000..d5d018c38 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/fm-versions-response.json @@ -0,0 +1,24 @@ +{ + "default_version": { + "id": "v1", + "links": [ + { + "href": "http://192.168.204.2:18002/v1/", + "rel": "self" + } + ] + }, + "versions": [ + { + "id": "v1", + "links": [ + { + "href": "http://192.168.204.2:18002/v1/", + "rel": "self" + } + ] + } + ], + "name": "Fault Management API", + "description": "Fault Management is an OpenStack project which provides REST API services for alarms and logs." +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/version-get-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/version-get-response.json new file mode 100644 index 000000000..d5d018c38 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/version-get-response.json @@ -0,0 +1,24 @@ +{ + "default_version": { + "id": "v1", + "links": [ + { + "href": "http://192.168.204.2:18002/v1/", + "rel": "self" + } + ] + }, + "versions": [ + { + "id": "v1", + "links": [ + { + "href": "http://192.168.204.2:18002/v1/", + "rel": "self" + } + ] + } + ], + "name": "Fault Management API", + "description": "Fault Management is an OpenStack project which provides REST API services for alarms and logs." +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/versionv1-get-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/versionv1-get-response.json new file mode 100644 index 000000000..1746a45c2 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/versionv1-get-response.json @@ -0,0 +1,50 @@ +{ + "media_types": [ + { + "base": "application/json", + "type": "application/vnd.openstack.fm.v1+json" + } + ], + "links": [ + { + "href": "http://192.168.204.2:18002/v1/", + "rel": "self" + }, + { + "href": "http://www.windriver.com/developer/fm/dev/api-spec-v1.html", + "type": "text/html", + "rel": "describedby" + } + ], + "event_log": [ + { + "href": "http://192.168.204.2:18002/v1/event_log/", + "rel": "self" + }, + { + "href": "http://192.168.204.2:18002/event_log/", + "rel": "bookmark" + } + ], + "alarms": [ + { + "href": "http://192.168.204.2:18002/v1/alarms/", + "rel": "self" + }, + { + "href": "http://192.168.204.2:18002/alarms/", + "rel": "bookmark" + } + ], + "event_suppression": [ + { + "href": "http://192.168.204.2:18002/v1/event_suppression/", + "rel": "self" + }, + { + "href": "http://192.168.204.2:18002/event_suppression/", + "rel": "bookmark" + } + ], + "id": "v1" +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/common.ent b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/common.ent new file mode 100644 index 000000000..382e7d00d --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/common.ent @@ -0,0 +1,436 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + '> + + + + + + '> + + + + + + '> + + + + + '> + + + + + + '> + + + + + + '> + + + + + + + The universally unique identifier for this object. + + + + + For convenience, resources contain links to themselves. + This allows a client to easily obtain rather than construct + resource URIs. The following types of link relations are + associated with resources: a self link containing a versioned + link to the resource, and a bookmark link containing a permanent + link to a resource that is appropriate for long term storage. + + + + + The time when the object was created. + + + + + The time when the object was last updated. + + + '> + + + + + + + The alarm ID; each type of alarm has a unique ID. Note + the alarm_id and the entity_instance_id uniquely identify + an alarm instance. + + + + + The instance of the object raising alarm. A . separated list + of sub-entity-type=instance-value pairs, representing the containment + structure of the overall entity instance. Note + the alarm_id and the entity_instance_id uniquely identify + an alarm instance. + + + + + The text description of the alarm. + + + + + The severity of the alarm; critical, + major, minor, or warning. + + + + + The time in UTC at which the alarm has last been updated. + + + + + The unique identifier of the alarm. + + + '> + + + + The state of the alarm; set or clear + + + + + Indicates whether the alarm affects the service. + + + + + The proposed action to clear the alarm. + + + + + The type of the alarm. + + + + + The type of the object raising the alarm. A . separated list + of sub-entity-type, representing the containment structure of the + overall entity type. + + + + + The probable cause of the alarm. + + + + + Indicates whether suppression of the specific alarm is allowed. + + + '> + + + + UUID of the system. + + + + + Overall system status based on alarms present; critical, + degraded, or OK. + + + + + Count of critical alarms on the system + + + + + Count of major alarms on the system + + + + + Count of minor alarms on the system + + + + + Count of warnings on the system + + + '> + + + + + + + The event log ID; each type of event log has a unique ID. Note + the event_log_id and the entity_instance_id uniquely identify + an event log instance. + + + + + The state of the event; set, clear or log + + + + + The instance of the object generating the event log. A . separated list + of sub-entity-type=instance-value pairs, representing the containment + structure of the overall entity instance. Note + the event_log_id and the entity_instance_id uniquely identify + an event log instance. + + + + + The text description of the event log. + + + + + The severity of the event log; critical, + major, minor or warning. + + + + + The time in UTC at which the event log has last been updated. + + + + + The unique identifier of the event log. + + + + + The next attribute is the request to use to get the next n + items. It is used to paginate the event log list. + + + '> + + + + The state of the event; set, clear or log + + + + + Indicates whether the event affects the service. + + + + + The proposed action to clear the event. + + + + + The type of the event. + + + + + The type of the object raising the alarm. A . separated list + of sub-entity-type, representing the containment structure of the + overall entity type. + + + + + The probable cause of the event. + + + + + Indicates whether suppression of the specific event is allowed. + + + '> + + + + + + + The alarm ID type (event ID type) that can be suppressed or unsuppressed. + + + + + + The text description of the event type. + + + + + The suppression status for the event ID type; suppressed or unsuppressed + + + '> + + + + GET'> + PUT'> + POST'> + DELETE'> diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/fm-api-v1.wadl b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/fm-api-v1.wadl new file mode 100644 index 000000000..07689fe08 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/fm-api-v1.wadl @@ -0,0 +1,469 @@ + + + +%common;]> + + + + + + + + + + + + + + + + + + + + + + + + + + + The unique identifier of an existing active alarm. + + + + + + + + + + + + + + + + + + + + + + + + The unique identifier of an event log. + + + + + + + + + + + + + + + + + The unique identifier of an event suppression. + + + + + + + + + + + + + + + + API version details. + + + + + + + + + + + + + + + + + Lists information about all Fault Management API versions. + + + + + + + + + &commonFaults; &getFaults; + + + + + Shows details for Fault Management API v1. + + + + + + + + + &commonFaults; &getFaults; + + + + + + + + + + + + + + + Lists all active alarms based on specified query. + The supported query options are alarm_id, entity_type_id, entity_instance_id, + severity and alarm_type. + + + + + + + + This optional parameter when set to true (include_suppress=true) specifies + to include suppressed alarms in output. + + + + + + + + + + + + + + + + The list of active alarms based on the specified query. + + + &alarmListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + + Shows information about a specific alarm. + + + + + + + &alarmListShowParameters; + &alarmDetailShowParameters; + &commonListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + + Deletes a specific alarm. + NOTE Typically this command should NOT be used. I.e typically + alarms will be and should be cleared by the system + when the alarm condition clears. This command is only provided + in the event that the alarm has cleared but for some reason the + system has not removed the alarm. + + + + + + + + + + + + + Summarize all active alarms by severity. + + + + + + + + This optional parameter when set to true (include_suppress=true) specifies + to include suppressed alarms in the summations (default false). + + + + + + + + + &alarmSummaryShowParameters; + + + + + + + + &commonFaults; + + + + + + + + + + + + + Lists all event logs (historical alarms and customer logs) based on specified query. The logs + are returned in reverse chronological order. + The supported query options are event_log_id, entity_type_id, entity_instance_id, + severity, event_log_type, start and end. + + + + + + + + This parameter specifies filter rules for the logs to + be returned. + + + + + This parameter specifies the maximum number of event logs to + be returned. + + + + + This optional parameter when set to true (alarms=true) specifies + that only alarm event log records should be returned. + + + + + This optional parameter when set to true (logs=true) specifies + that only customer log records should be returned. + + + + + This optional parameter when set to true (include_suppress=true) specifies + to include suppressed alarms in output. + + + + + + + + + + + + + + + + The list of events log based on the specified query. + + + &eventLogListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + Shows information about a specific event log. + + + + + + + &eventLogListShowParameters; + &commonListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + + + + + + + + + Lists suppressed event id's. + + + + + + + + + The list of suppressed event types. + + + &EventSuppressionListShowParameters; + &commonListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + Modifies the value of an event suppression. + + + + + + + + The suppression status of an event suppression; suppressed or unsuppressed + + + + + + + + + + + + + + + + URIs to the modified event suppression. + + + + &EventSuppressionListShowParameters; + &commonListShowParameters; + + + + + + + + &postPutFaults; + + + + diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-request.json deleted file mode 100644 index 4aa914e46..000000000 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/alarm_list-request.json +++ /dev/null @@ -1 +0,0 @@ -http://192.168.204.2:6385/v1/ialarms?q.field=severity&q.op=eq&q.type=&q.value=major&include_suppress=True diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-request.json deleted file mode 100644 index f779ac846..000000000 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-request.json +++ /dev/null @@ -1 +0,0 @@ -http://192.168.204.2:6385/v1/event_log?q.field=start&q.field=end&q.op=eq&q.op=eq&q.type=&q.type=&q.value=2014-11-28T16%3A56%3A44&q.value=2014-11-28T16%3A56%3A45&limit=2 diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-request.json deleted file mode 100644 index 0de69f46a..000000000 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-request.json +++ /dev/null @@ -1 +0,0 @@ -http://192.168.204.2:6385/v1/event_suppression diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/sysinv-versions-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/sysinv-versions-response.json index 31a632c5b..964df10ec 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/sysinv-versions-response.json +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/sysinv-versions-response.json @@ -19,6 +19,6 @@ ] } ], - "description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports alarms and fault collection for the cloud itself as well as the configuration of the cloud's SNMP interface. ", + "description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports the configuration of the cloud's SNMP interface. ", "name":"Titanium SysInv API" } diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/version-get-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/version-get-response.json index 31a632c5b..964df10ec 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/version-get-response.json +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/version-get-response.json @@ -19,6 +19,6 @@ ] } ], - "description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports alarms and fault collection for the cloud itself as well as the configuration of the cloud's SNMP interface. ", + "description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports the configuration of the cloud's SNMP interface. ", "name":"Titanium SysInv API" } diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/versionv1-get-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/versionv1-get-response.json index dbb2ae95a..2ad1ad8d5 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/versionv1-get-response.json +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/versionv1-get-response.json @@ -136,36 +136,6 @@ "rel":"bookmark" } ], - "ialarms":[ - { - "href":"http://128.224.150.54:6385/v1/ialarms/", - "rel":"self" - }, - { - "href":"http://128.224.150.54:6385/ialarms/", - "rel":"bookmark" - } - ], - "event_log":[ - { - "href":"http://128.224.150.54:6385/v1/event_log/", - "rel":"self" - }, - { - "href":"http://128.224.150.54:6385/event_log/", - "rel":"bookmark" - } - ], - "event_suppression":[ - { - "href":"http://128.224.150.54:6385/v1/event_suppression/", - "rel":"self" - }, - { - "href":"http://128.224.150.54:6385/event_suppression/", - "rel":"bookmark" - } - ], "icommunity":[ { "href":"http://128.224.150.54:6385/v1/icommunity/", diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent index 334e56b65..9e3047f2b 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent @@ -1538,163 +1538,6 @@ '> - - - - - The alarm ID; each type of alarm has a unique ID. Note - the alarm_id and the entity_instance_id uniquely identify - an alarm instance. - - - - - The instance of the object raising alarm. A . separated list - of sub-entity-type=instance-value pairs, representing the containment - structure of the overall entity instance. Note - the alarm_id and the entity_instance_id uniquely identify - an alarm instance. - - - - - The text description of the alarm. - - - - - The severity of the alarm; critical, - major, minor, or warning. - - - - - The time in UTC at which the alarm has last been updated. - - - - - The unique identifier of the alarm. - - - '> - - - - The state of the alarm; set or clear - - - - - Indicates whether the alarm affects the service. - - - - - The proposed action to clear the alarm. - - - - - The type of the alarm. - - - - - The type of the object raising the alarm. A . separated list - of sub-entity-type, representing the containment structure of the - overall entity type. - - - - - The probable cause of the alarm. - - - - - Indicates whether suppression of the specific alarm is allowed. - - - '> - - - - UUID of the system. - - - - - Overall system status based on alarms present; critical, - degraded, or OK. - - - - - Count of critical alarms on the system - - - - - Count of major alarms on the system - - - - - Count of minor alarms on the system - - - - - Count of warnings on the system - - - - - '> - - - - - - - The event log ID; each type of event log has a unique ID. Note - the event_log_id and the entity_instance_id uniquely identify - an event log instance. - - - - - The state of the event; set, clear or log - - - - - The instance of the object generating the event log. A . separated list - of sub-entity-type=instance-value pairs, representing the containment - structure of the overall entity instance. Note - the event_log_id and the entity_instance_id uniquely identify - an event log instance. - - - - - The text description of the event log. - - - - - The severity of the event log; critical, - major, minor or warning. - - - - - The time in UTC at which the event log has last been updated. - - - - - The unique identifier of the event log. - - - - - The next attribute is the request to use to get the next n - items. It is used to paginate the event log list. - - - '> - - - - The state of the event; set, clear or log - - - - - Indicates whether the event affects the service. - - - - - The proposed action to clear the event. - - - - - The type of the event. - - - - - The type of the object raising the alarm. A . separated list - of sub-entity-type, representing the containment structure of the - overall entity type. - - - - - The probable cause of the event. - - - - - Indicates whether suppression of the specific event is allowed. - - - '> - - - - - - The alarm ID type (event ID type) that can be suppressed or unsuppressed. - - - - - - The text description of the event type. - - - - - The suppression status for the event ID type; suppressed or unsuppressed - - - '> - - - - - - - - - - - The unique identifier of an existing active alarm. - - - - - - - - - - - - - - @@ -581,40 +558,6 @@ SPDX-License-Identifier: Apache-2.0 - - - - - - - - - The unique identifier of an event log. - - - - - - - - - - - - - - - - - The unique identifier of an event suppression. - - - - - - - @@ -3616,140 +3559,6 @@ SPDX-License-Identifier: Apache-2.0 - - - - - - - - - - - - Lists all active alarms based on specified query. - The supported query options are alarm_id, entity_type_id, entity_instance_id, - severity and alarm_type. - - - - - - - - This optional parameter when set to true (include_suppress=true) specifies - to include suppressed alarms in output. - - - - - - - - - - - - - - - - The list of active alarms based on the specified query. - - - &alarmListShowParameters; - - - - - - - - &commonFaults; &getFaults; - - - - - - Shows information about a specific alarm. - - - - - - - &alarmListShowParameters; - &alarmDetailShowParameters; - &commonListShowParameters; - - - - - - - - &commonFaults; &getFaults; - - - - - - Deletes a specific alarm. - NOTE Typically this command should NOT be used. I.e typically - alarms will be and should be cleared by the system - when the alarm condition clears. This command is only provided - in the event that the alarm has cleared but for some reason the - system has not removed the alarm. - - - - - - - - - - - - - Summarize all active alarms by severity. - - - - - - - - This optional parameter when set to true (include_suppress=true) specifies - to include suppressed alarms in the summations (default false). - - - - - - - - - &alarmSummaryShowParameters; - - - - - - - - &commonFaults; - - - @@ -4570,197 +4379,6 @@ OAM Controller-1 IP Address. &postPutFaults; - - - - - - - - - - Lists all event logs (historical alarms and customer logs) based on specified query. The logs - are returned in reverse chronological order. - The supported query options are event_log_id, entity_type_id, entity_instance_id, - severity, event_log_type, start and end. - - - - - - - - This parameter specifies filter rules for the logs to - be returned. - - - - - This parameter specifies the maximum number of event logs to - be returned. - - - - - This optional parameter when set to true (alarms=true) specifies - that only alarm event log records should be returned. - - - - - This optional parameter when set to true (logs=true) specifies - that only customer log records should be returned. - - - - - This optional parameter when set to true (include_suppress=true) specifies - to include suppressed alarms in output. - - - - - - - - - - - - - - - - The list of events log based on the specified query. - - - &eventLogListShowParameters; - - - - - - - - &commonFaults; &getFaults; - - - - - Shows information about a specific event log. - - - - - - - &eventLogListShowParameters; - &commonListShowParameters; - - - - - - - - &commonFaults; &getFaults; - - - - - - - - - - - - Lists suppressed event id's. - - - - - - - - - The list of suppressed event types. - - - &EventSuppressionListShowParameters; - &commonListShowParameters; - - - - - - - - &commonFaults; &getFaults; - - - - - Modifies the value of an event suppression. - - - - - - - - The suppression status of an event suppression; suppressed or unsuppressed - - - - - - - - - - - - - - - - URIs to the modified event suppression. - - - - &EventSuppressionListShowParameters; - &commonListShowParameters; - - - - - - - - &postPutFaults; - - diff --git a/tools/collector/scripts/collect_mask_passwords b/tools/collector/scripts/collect_mask_passwords index b7f0e2461..0dd5fa9ab 100644 --- a/tools/collector/scripts/collect_mask_passwords +++ b/tools/collector/scripts/collect_mask_passwords @@ -13,7 +13,7 @@ for conffile in \ ${COLLECT_NAME_DIR}/etc/aodh/aodh.conf \ ${COLLECT_NAME_DIR}/etc/ceilometer/ceilometer.conf \ ${COLLECT_NAME_DIR}/etc/cinder/cinder.conf \ - ${COLLECT_NAME_DIR}/etc/fm.conf \ + ${COLLECT_NAME_DIR}/etc/fm/fm.conf \ ${COLLECT_NAME_DIR}/etc/glance/glance-api.conf \ ${COLLECT_NAME_DIR}/etc/glance/glance-registry.conf \ ${COLLECT_NAME_DIR}/etc/heat/heat.conf \