Update overview.rst 27/3927/1
authorXiaohua Zhang <xiaohua.zhang@windriver.com>
Mon, 1 Jun 2020 02:53:54 +0000 (22:53 -0400)
committerXiaohua Zhang <xiaohua.zhang@windriver.com>
Mon, 1 Jun 2020 02:53:54 +0000 (22:53 -0400)
Issue-ID: INF-16

Signed-off-by: Xiaohua Zhang <xiaohua.zhang@windriver.com>
Change-Id: I587f3c04c83aea39637cf56b2e0272bdc6db4741

docs/overview.rst

index f4be9c2..79c3143 100644 (file)
@@ -38,16 +38,134 @@ In the Bronze release, the following components and services are enabled:
 
 1. Fault Management
 
+   Framework for infrastructure services to raise and persist alarm and event data.
+   
+    Set, clear and query customer alarms
+
+    Generate customer logs for significant events
+
+   Maintains an Active Alarm List
+
+   Provides REST API to query alarms and events, also available through SNMP traps
+
+   Support for alarm suppression
+
+   Operator alarms
+
+    On platform nodes and resources
+
+    On hosted virtual resources
+
+   Operator logs - Event List
+
+    Logging of sets/clears of alarms
+
+    Related to platform nodes and resources
+    
+    Related to hosted virtual resources
+
 2. Configuration Management
 
+   Manages Installation and Commissioning
+   
+    Auto-discover of new nodes
+
+    Full Infrastructure management
+
+    Manage installation parameters (i.e. console, root disks)
+
+   Nodal Configuration
+
+    Node role, role profiles
+
+    Core, memory (including huge page) assignments
+
+    Network Interfaces and storage assignments
+
+   Hardware Discovery
+
+    CPU/cores, SMT, processors, memory, huge pages
+
+    Storage, ports
+
+    GPUs, storage, Crypto/compression H/W
+
 3. Software Management
 
+   Manages Installation and Commissioning
+
+    Auto-discover of new nodes
+
+    Full Infrastructure management
+
+    Manage installation parameters (i.e. console, root disks)
+
+   Nodal Configuration
+
+    Node role, role profiles
+
+    Core, memory (including huge page) assignments
+
+    Network Interfaces and storage assignments
+
+   Hardware Discovery
+
+    CPU/cores, SMT, processors, memory, huge pages
+
+    Storage, ports
+
+    GPUs, storage, Crypto/compression H/W
 4. Host Management
 
+   Full life-cycle and availability management of the physical hosts
+
+   Detects and automatically handles host failures and initiates recovery
+
+   Monitoring and fault reporting for:
+
+    Cluster connectivity
+
+    Critical process failures
+
+    Resource utilization thresholds, interface states
+
+    H/W fault / sensors, host watchdog
+
+    Activity progress reporting
+
+   Interfaces with board management (BMC)
+
+    For out of band reset
+
+    Power-on/off
+
+    H/W sensor monitoring
 5. Service Management
 
+   Manages high availability of critical infrastructure and cluster services
+
+    Supports many redundancy models: N, or N+M
+
+    Active or passive monitoring of services
+
+    Allows for specifying the impact of a service failure and escalation policy
+
+    Automatically recovers failed services
+
+   Uses multiple messaging paths to avoid split-brain communication failures
+
+    Up to 3 independent communication paths
+
+    LAG can also be configured for multi-link protection of each path
+
+    Messages are authenticated using HMAC
+
+    SHA-512 if configured / enabled on an interface by-interface basis
 6. Support the ansible bootstrap to implement the zero touch provisioning
 
+Enable the ansible configuration functions for infrastructure itself including the image installation and service configuration.
+
+
 NOTE: These features leverage the StarlingX (www.starlingx.io). And in Bronze release, these features are only avalaible for IA platform.
 
 NOTE: In this release single server solution is supported only. All the functionalities include controller functions, storage functions and compute functions are integrated in the single server.  
@@ -74,4 +192,4 @@ Contact info
 ------------
 If you need support or add new features/components, please feel free to contact the following:
 - Jackie Huang <jackie.huang@windriver.com>
-- Xiaohua Zhang <xiaohua.zhang@windriver.com>
+- Xiaohua Zhang <xiaohua.zhang@windriver.com>