Update docs/installation-guide.rst for typo and update the overview.rst. 23/4023/2
authorXiaohua Zhang <xiaohua.zhang@windriver.com>
Tue, 2 Jun 2020 12:20:25 +0000 (08:20 -0400)
committerXiaohua Zhang <xiaohua.zhang@windriver.com>
Tue, 2 Jun 2020 12:52:33 +0000 (08:52 -0400)
Issue-ID: INF-16

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

docs/installation-guide.rst
docs/overview.rst

index e8dc09b..ae524a9 100644 (file)
@@ -100,7 +100,7 @@ Software Installation and Deployment
 `````````````````````````````````````````````
 
 2.1 First Login
-```````````````
+'''''''''''''''
 Example:
 
 ::
@@ -112,10 +112,10 @@ Example:
     ping 8.8.8.8 
 
 2.3 Login the server through SSH
-````````````````````````````````
+''''''''''''''''''''''''''''''''
 
 2.4 Prepare the localhost.yml for bootstrap
-```````````````````````````````````````````
+'''''''''''''''''''''''''''''''''''''''''''
 
 Example:
 
@@ -140,7 +140,7 @@ Example:
     docker_https_proxy: https://xxx.xxx.xxx.xxx:8080
 
 2.5 Run the bootstrap
-`````````````````````
+'''''''''''''''''''''
 
 Use the following command:
 
@@ -156,7 +156,7 @@ After the bootstrap successfully finish, it will show as following:
     localhost                  : ok=256  changed=135  unreachable=0    failed=0    skipped=220  rescued=0    ignored=0
 
 2.6 Configure the OAM network
-`````````````````````````````
+'''''''''''''''''''''''''''''
 
 Example:
 
@@ -239,7 +239,7 @@ Example:
   +--------------+--------------------------------------+--------+--------------+
   
 2.7 Configure the NTP server
-````````````````````````````
+''''''''''''''''''''''''''''
 
 Example:
 
@@ -263,7 +263,7 @@ Example:
   +--------------+--------------------------------------+
   
 2.8 Configure the Storage by using the second hard drive as ceph backend
-````````````````````````````````````````````````````````````````````````
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 Example:
 
@@ -332,8 +332,9 @@ Example:
   +--------------------------------------+----------+-------+-----------------------+--------------------------------------+-------------------------------------------------------+--------------+------------------+-----------+
   
 2.9 Configure the SR-IOV enabled network
-````````````````````````````````````````
-It need :
+''''''''''''''''''''''''''''''''''''''''
+
+It needs :
   - assign the label of SR-IOV
   - change the CPU policy to static
   - change the hugepage setting
@@ -649,7 +650,7 @@ Example:
   +------------------+--------------------------------------+
   
 2.10 Unlock the server
-``````````````````````
+''''''''''''''''''''''
 
 Example:
 
@@ -745,7 +746,7 @@ Example:
 ````````````````````````````
 
 3.1 After controller-0 is rebooted and up running, download the DPDK
-````````````````````````````````````````````````````````````````````
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 ::
 
@@ -770,8 +771,8 @@ Example:
 
   sudo ln -s dpdk-stable-17.11.10 dpdk-stable
 
-3.1 Prepare the yaml file for the network assignment container
-``````````````````````````````````````````````````````````````
+3.2 Prepare the yaml file for the network assignment container
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 The following the exmaple of the yaml file:
 
@@ -804,8 +805,8 @@ The following the exmaple of the yaml file:
   > }'
   > EOF
 
-3.2 Run the network assignent container for the 2 VFs
-`````````````````````````````````````````````````````
+3.3 Run the network assignent container for the 2 VFs
+'''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 ::
 
@@ -813,8 +814,8 @@ The following the exmaple of the yaml file:
   networkattachmentdefinition.k8s.cni.cncf.io/sriov-data-dpdk-0 created
   networkattachmentdefinition.k8s.cni.cncf.io/sriov-data-dpdk-1 created
 
-3.3 Prepare the VF container yaml file
-``````````````````````````````````````
+3.4 Prepare the VF container yaml file
+''''''''''''''''''''''''''''''''''''''
 
 ::
 
@@ -884,8 +885,8 @@ The following the exmaple of the yaml file:
   >       path: /usr/src/
   > EOF
 
-3.4 Run the VF container
-````````````````````````
+3.5 Run the VF container
+''''''''''''''''''''''''
 
 Start the VF container.
 
@@ -1020,6 +1021,7 @@ Build the test_pmd application
   Press enter to continue ...
 
 Check the VF PCI information:
+
 ::
 
   root@pod-with-dpdk-vfs-0:/usr/src/dpdk# printenv | grep PCIDEVICE_INTEL_COM
@@ -1027,6 +1029,7 @@ Check the VF PCI information:
   PCIDEVICE_INTEL_COM_PCI_SRIOV_NET_PHYSNET0=0000:05:11.0
 
 Exit from pod back to host to find which VFs are assigned to this pod by check the pci address:
+
 ::
 
   [root@controller-0 sysadmin(keystone_admin)]# ls -l /sys/class/net/ens2f0/device/virtfn*
@@ -1152,4 +1155,4 @@ References
 - `StarlingX`_
 
 .. _`StarlingX`: https://docs.starlingx.io/
-          
\ No newline at end of file
+          
index 79c3143..94b9dd4 100644 (file)
@@ -38,129 +38,129 @@ 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.
+   Framework for infrastructure services to raise and persist alarm and event data.
    
-    Set, clear and query customer alarms
+     - Set, clear and query customer alarms
 
-    Generate customer logs for significant events
+     - Generate customer logs for significant events
 
-   Maintains an Active Alarm List
+   Maintains an Active Alarm List
 
-   Provides REST API to query alarms and events, also available through SNMP traps
+   Provides REST API to query alarms and events, also available through SNMP traps
 
-   Support for alarm suppression
+   Support for alarm suppression
 
-   Operator alarms
+   Operator alarms
 
-    On platform nodes and resources
+     - On platform nodes and resources
 
-    On hosted virtual resources
+     - On hosted virtual resources
 
-   Operator logs - Event List
+   Operator logs - Event List
 
-    Logging of sets/clears of alarms
+     - Logging of sets/clears of alarms
 
-    Related to platform nodes and resources
+     - Related to platform nodes and resources
     
-    Related to hosted virtual resources
+     - Related to hosted virtual resources
 
 2. Configuration Management
 
-   Manages Installation and Commissioning
+   Manages Installation and Commissioning
    
-    Auto-discover of new nodes
+     - Auto-discover of new nodes
 
-    Full Infrastructure management
+     - Full Infrastructure management
 
-    Manage installation parameters (i.e. console, root disks)
+     - Manage installation parameters (i.e. console, root disks)
 
-   Nodal Configuration
+   Nodal Configuration
 
-    Node role, role profiles
+     - Node role, role profiles
 
-    Core, memory (including huge page) assignments
+     - Core, memory (including huge page) assignments
 
-    Network Interfaces and storage assignments
+     - Network Interfaces and storage assignments
 
-   Hardware Discovery
+   Hardware Discovery
 
-    CPU/cores, SMT, processors, memory, huge pages
+     - CPU/cores, SMT, processors, memory, huge pages
 
-    Storage, ports
+     - Storage, ports
 
-    GPUs, storage, Crypto/compression H/W
+     - GPUs, storage, Crypto/compression H/W
 
 3. Software Management
 
-   Manages Installation and Commissioning
+   Manages Installation and Commissioning
 
-    Auto-discover of new nodes
+     - Auto-discover of new nodes
 
-    Full Infrastructure management
+     - Full Infrastructure management
 
-    Manage installation parameters (i.e. console, root disks)
+     - Manage installation parameters (i.e. console, root disks)
 
-   Nodal Configuration
+   Nodal Configuration
 
-    Node role, role profiles
+     - Node role, role profiles
 
-    Core, memory (including huge page) assignments
+     - Core, memory (including huge page) assignments
 
-    Network Interfaces and storage assignments
+     - Network Interfaces and storage assignments
 
-   Hardware Discovery
+   Hardware Discovery
 
-    CPU/cores, SMT, processors, memory, huge pages
+     - CPU/cores, SMT, processors, memory, huge pages
 
-    Storage, ports
+     - Storage, ports
 
-    GPUs, storage, Crypto/compression H/W
+     - GPUs, storage, Crypto/compression H/W
 4. Host Management
 
-   Full life-cycle and availability management of the physical hosts
+   Full life-cycle and availability management of the physical hosts
 
-   Detects and automatically handles host failures and initiates recovery
+   Detects and automatically handles host failures and initiates recovery
 
-   Monitoring and fault reporting for:
+   Monitoring and fault reporting for:
 
-    Cluster connectivity
+     - Cluster connectivity
 
-    Critical process failures
+     - Critical process failures
 
-    Resource utilization thresholds, interface states
+     - Resource utilization thresholds, interface states
 
-    H/W fault / sensors, host watchdog
+     - H/W fault / sensors, host watchdog
 
-    Activity progress reporting
+     - Activity progress reporting
 
-   Interfaces with board management (BMC)
+   Interfaces with board management (BMC)
 
-    For out of band reset
+     - For out of band reset
 
-    Power-on/off
+     - Power-on/off
 
-    H/W sensor monitoring
+     - H/W sensor monitoring
 5. Service Management
 
-   Manages high availability of critical infrastructure and cluster services
+   Manages high availability of critical infrastructure and cluster services
 
-    Supports many redundancy models: N, or N+M
+     - Supports many redundancy models: N, or N+M
 
-    Active or passive monitoring of services
+     - Active or passive monitoring of services
 
-    Allows for specifying the impact of a service failure and escalation policy
+     - Allows for specifying the impact of a service failure and escalation policy
 
-    Automatically recovers failed services
+     - Automatically recovers failed services
 
-   Uses multiple messaging paths to avoid split-brain communication failures
+   Uses multiple messaging paths to avoid split-brain communication failures
 
-    Up to 3 independent communication paths
+     - Up to 3 independent communication paths
 
-    LAG can also be configured for multi-link protection of each path
+     - LAG can also be configured for multi-link protection of each path
 
-    Messages are authenticated using HMAC
+     - Messages are authenticated using HMAC
 
-    SHA-512 if configured / enabled on an interface by-interface basis
+     - 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.
@@ -192,4 +192,5 @@ 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>