Update CLI references

Added sw-manager CLI guide.
Updated dcmanager, fm, and system CLI guides.
Changed tabs to spaces in fm guide.
Fixed merge conflict.

Change-Id: I20a8d4e1569b64a07a6ce6685c167bba71ea24e3
Signed-off-by: MCamp859 <maryx.camp@intel.com>

doc/source/cli_ref/dcmanager.rst

@@ -6,7 +6,7 @@ dcmanager
 Manager APIs. :command:`dcmanager` is applicable only in the `SystemController`
 region of the central cloud in a distributed cloud configuration.
 
-This page documents the :command:`dcmanager` command in StarlingX R3.0.
+This page documents the :command:`dcmanager` command.
 
 .. contents::
    :local:
@@ -58,11 +58,11 @@ Displays the aggregated counts of critical, major, minor, and warning alarms
 across all subclouds.
 
 ``alarm summary``
-	List alarm summaries of subclouds.
+  List alarm summaries of subclouds.
 
-***************************************
+*******************************
-Distributed cloud subcloud installation
+Distributed subcloud management
-***************************************
+*******************************
 
 This set of commands provides subcloud management, including basic add, delete,
 list, show, and update operations on a subcloud.
@@ -75,32 +75,58 @@ list, show, and update operations on a subcloud.
   optionally run a deployment playbook.
 
 ``subcloud delete``
-	Delete subcloud details from the database.
+  Delete subcloud details from the database.
+
+``subcloud-deploy show``
+    Show the uploaded deployment files.
 
 ``subcloud-deploy upload``
-    Upload the optional deployment playbook, helm chart, and overrides to be
+    Upload the subcloud deployment files.
-    used with ``subcloud add``.
+
+``subcloud-group add``
+   Add a new subcloud group.
+
+``subcloud-group delete``
+   Delete subcloud group details from the database.
+
+``subcloud-group list``
+   List subcloud groups.
+
+``subcloud-group list-subclouds``
+   List subclouds referencing a subcloud group.
+
+``subcloud-group show``
+   Show the details of a subcloud group.
+
+``subcloud-group update``
+   Update attributes of a subcloud group.
 
 ``subcloud list``
-	List subclouds.
+  List subclouds.
 
 ``subcloud manage``
-	Manage a subcloud. Enables the active synchronization of data between the
+  Manage a subcloud. Enables the active synchronization of data between the
-	central cloud and the subcloud.
+  central cloud and the subcloud.
 
 ``subcloud reconfig``
   Re-run the deployment playbook on a subcloud using an updated configuration
   file.
 
+``subcloud reinstall``
+    Reinstall a subcloud.
+
+``subcloud restore``
+    Restore a subcloud.
+
 ``subcloud show``
-	Show the details of a subcloud.
+  Show the details of a subcloud.
 
 ``subcloud unmanage``
-	Unmanage a subcloud. Disables the active synchronization of data between the
+  Unmanage a subcloud. Disables the active synchronization of data between the
-	central cloud and the subcloud.
+  central cloud and the subcloud.
 
 ``subcloud update``
-	Update attributes of a subcloud.
+  Update attributes of a subcloud.
 
 ***********************************
 Distributed cloud patching/updating
@@ -116,34 +142,80 @@ and all hosts of subclouds. :command:`patch-strategy` commands orchestrate
 software updates across an entire distributed cloud solution.
 
 ``patch-strategy abort``
-	Abort a patch strategy.
+  Abort a patch strategy.
 
 ``patch-strategy apply``
-	Apply a patch strategy.
+  Apply a patch strategy.
 
 ``patch-strategy create``
-	Create a patch strategy.
+  Create a patch strategy.
 
 ``patch-strategy delete``
-	Delete patch strategy from the database.
+  Delete patch strategy from the database.
 
 ``patch-strategy show``
-	Show the details of a patch strategy for a subcloud.
+  Show the details of a patch strategy for a subcloud.
 
 ``patch-strategy-config delete``
-	Delete per subcloud patch options.
+  Delete per subcloud patch options.
 
 ``patch-strategy-config list``
-	List patch options.
+  List patch options.
 
 ``patch-strategy-config show``
-	Show patch options, defaults or per subcloud.
+  Show patch options, defaults or per subcloud.
 
 ``patch-strategy-config update``
-	Update patch options, defaults or per subcloud.
+  Update patch options, defaults or per subcloud.
 
 ``strategy-step list``
-	List strategy steps.
+  List strategy steps.
 
 ``strategy-step show``
-	Show the details of a strategy step.
+  Show the details of a strategy step.
+
+***********************************
+Distributed cloud firmware updating
+***********************************
+
+The following set of commands create, apply, and monitor the orchestration of
+N3000 |FPGA| firmware load updating across all subclouds and all hosts of
+subclouds.
+
+``fw-update-strategy abort``
+    Abort a firmware update strategy.
+
+``fw-update-strategy apply``
+    Apply a firmware update strategy.
+
+``fw-update-strategy create``
+    Create a firmware update strategy.
+
+``fw-update-strategy delete``
+    Delete firmware update strategy from the database.
+
+``fw-update-strategy show``
+    Show the details of a firmware update strategy for a subcloud.
+
+**********************************************
+Distributed cloud Kubernetes version upgrading
+**********************************************
+
+The following set of commands create, apply, and monitor the orchestration of
+Kubernetes version upgrading across all subclouds and all hosts of subclouds.
+
+``kube-upgrade-strategy abort``
+    Abort a Kubernetes upgrade strategy.
+
+``kube-upgrade-strategy apply``
+    Apply a Kubernetes upgrade strategy.
+
+``kube-upgrade-strategy create``
+    Create a Kubernetes upgrade strategy.
+
+``kube-upgrade-strategy delete``
+    Delete Kubernetes upgrade strategy from the database.
+
+``kube-upgrade-strategy show``
+    Show the details of a Kubernetes upgrade strategy for a subcloud.
+

doc/source/cli_ref/fm.rst

@@ -4,7 +4,7 @@ fm
 
 :command:`fm` is the command-line interface for Fault Management.
 
-This page documents the :command:`fm` command in StarlingX R3.0.
+This page documents the :command:`fm` command.
 
 .. contents::
    :local:
@@ -56,7 +56,7 @@ The fault management (fm) alarm and event type commands enable the display of
 active alarms and historical events.
 
 ``alarm-delete``
-	Delete an active alarm.
+  Delete an active alarm.
 
 ``alarm-list``
   List all active alarms.
@@ -71,22 +71,22 @@ active alarms and historical events.
   attention in order to clear the alarm.
 
 ``alarm-summary``
-	Show a summary of active alarms.
+  Show a summary of active alarms.
 
 ``event-list``
-	List event logs. Displays alarm sets, alarm clears, and customer log type events.
+  List event logs. Displays alarm sets, alarm clears, and customer log type events.
 
 ``event-show``
-	Show a event log. Displays alarm sets, alarm clears, and customer log type events.
+  Show a event log. Displays alarm sets, alarm clears, and customer log type events.
 
 ``event-suppress``
-	Suppress specified event IDs.
+  Suppress specified event IDs.
 
 ``event-suppress-list``
-	List Suppressed event IDs
+  List Suppressed event IDs
 
 ``event-unsuppress``
-	Unsuppress specified event IDs.
+  Unsuppress specified event IDs.
 
 ``event-unsuppress-all``
-	Unsuppress all event IDs.
+  Unsuppress all event IDs.

doc/source/cli_ref/index.rst

@@ -9,4 +9,5 @@ Reference for the StarlingX project command line interface (CLI).
 
    dcmanager
    fm
+   sw-manager
    system

doc/source/cli_ref/sw-manager.rst

@@ -0,0 +1,139 @@
+==========
+sw-manager
+==========
+
+:command:`sw-manager` is the command-line interface for the VIM Orchestration
+APIs.
+
+This page documents the :command:`sw-manager` command.
+
+.. contents::
+   :local:
+   :depth: 2
+
+----------------
+sw-manager usage
+----------------
+
+::
+
+    sw-manager [-h] [--debug] [--os-auth-url OS_AUTH_URL]
+               [--os-project-name OS_PROJECT_NAME]
+               [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
+               [--os-username OS_USERNAME] [--os-password OS_PASSWORD]
+               [--os-user-domain-name OS_USER_DOMAIN_NAME]
+               [--os-region-name OS_REGION_NAME]
+               [--os-interface OS_INTERFACE]
+               <subcommand> ...
+
+For a list of all :command:`sw-manager` subcommands, enter:
+
+::
+
+    sw-manager -h
+
+-----------
+Subcommands
+-----------
+
+For a full description of usage and optional arguments for a specific
+:command:`sw-manager` command, enter:
+
+::
+
+    sw-manager SUBCOMMAND [ COMMAND ] -h
+
+*******************
+Patch orchestration
+*******************
+
+The patch-strategy commands create, apply and monitor the orchestration of
+software patch application (or updates) across all hosts of a StarlingX cluster.
+
+``patch-strategy create``
+    Create a strategy.
+
+``patch-strategy delete``
+    Delete a strategy.
+
+``patch-strategy apply``
+    Apply a strategy.
+
+``patch-strategy abort``
+    Abort a strategy.
+
+``patch-strategy show``
+    Show a strategy.
+
+*********************
+Upgrade orchestration
+*********************
+
+.. note::
+
+   The following commands are not yet supported.
+
+The upgrade-strategy commands create, apply and monitor the orchestration of
+software upgrades across all hosts of a StarlingX cluster.
+
+``upgrade-strategy create``
+    Create a strategy.
+
+``upgrade-strategy delete``
+    Delete a strategy.
+
+``upgrade-strategy apply``
+    Apply a strategy.
+
+``upgrade-strategy abort``
+    Abort a strategy.
+
+``upgrade-strategy show``
+    Show a strategy.
+
+*****************************
+Firmware update orchestration
+*****************************
+
+The ``fw-update-strategy`` commands create, apply, and monitor the orchestration
+of Intel N3000 |FPGA| |PAC| user load image updates across all hosts of a
+StarlingX cluster.
+
+``fw-update-strategy create``
+    Create a strategy.
+
+``fw-update-strategy delete``
+    Delete a strategy.
+
+``fw-update-strategy apply``
+    Apply a strategy.
+
+``fw-update-strategy abort``
+    Abort a strategy.
+
+``fw-update-strategy show``
+    Show a strategy.
+
+********************************
+Kubernetes upgrade orchestration
+********************************
+
+The kube-upgrade-strategy commands create, apply and monitor the
+orchestration of Kubernetes version upgrades across all hosts of a StarlingX
+cluster.
+
+``kube-upgrade-strategy create``
+    Create a strategy.
+
+``kube-upgrade-strategy delete``
+    Delete a strategy.
+
+``kube-upgrade-strategy apply``
+    Apply a strategy.
+
+``kube-upgrade-strategy abort``
+    Abort a strategy.
+
+``kube-upgrade-strategy show``
+    Show a strategy.
+

doc/source/cli_ref/system.rst

@@ -72,6 +72,9 @@ for a variety of |prod| use cases. For example:
 ``certificate-show``
     Show certificate details.
 
+``certificate-uninstall``
+    Uninstall certificate; only applicable to trusted certificate authority(s).
+
 ********************************
 Local Docker registry management
 ********************************
@@ -127,9 +130,14 @@ These commands primarily support the ability to resize the file systems.
 Use :command:`host-fs-*` commands to manage un-synchronized file systems on
 controller and worker nodes.
 
-Use :command:`controllerfs-*` commands to manage drbd-synchronized file systems
+Use :command:`controllerfs-*` commands to manage |DRBD|-synchronized file
-on controller
+systems on controller nodes.
-nodes.
+
+``host-fs-add``
+    Add an optional host file system; e.g. image-conversion file system.
+
+``host-fs-delete``
+    Delete an optional host file system; e.g. image-conversion file system.
 
 ``host-fs-list``
     Show list of host file systems.
@@ -150,10 +158,10 @@ nodes.
     Show details of a controller file system.
 
 ``drbdsync-modify``
-    Modify DRBD sync rate parameters.
+    Modify |DRBD| sync rate parameters.
 
 ``drbdsync-show``
-    Show DRBD sync config details.
+    Show |DRBD| sync config details.
 
 ********************
 System configuration
@@ -164,7 +172,7 @@ The following set of commands enable configuration of:
 * Basic system attributes
 * OAM IP address(es), subnet, and gateway
 * Remote DNS servers for |prod| hosts
-* Time synchronization protocols, for example: NPT and/or PTP
+* Time synchronization protocols, for example: |NTP| and/or |PTP|
 
 ``modify``
     Modify system attributes.
@@ -184,6 +192,9 @@ The following set of commands enable configuration of:
 ``ntp-show``
     Show NTP (Network Time Protocol) attributes.
 
+``ptp-apply``
+    Apply modified PTP attributes to hosts.
+
 ``ptp-modify``
     Modify PTP attributes.
 
@@ -233,7 +244,7 @@ Host IPMI configuration and management
 
 The :command:`host-sensor*` commands provide the ability to:
 
-* Display the sensors collected from hosts over IPMI.
+* Display the sensors collected from hosts over |IPMI|.
 * Define thresholds.
 * Configure behavior when thresholds are crossed (for example ignore, log, or
   reset).
@@ -618,37 +629,40 @@ The following set of commands is used to configure and manage Ceph OSDs, Ceph
 tiers, and Ceph storage cluster backends.
 
 ``ceph-mon-add``
+    Add a ceph monitor to a specific host.
 
 ``ceph-mon-delete``
+    Delete a ceph monitor from a specific host.
 
 ``ceph-mon-list``
     List Ceph mons.
 
 ``ceph-mon-modify``
+    Modify parameters of a ceph monitor on a specific host.
 
 ``ceph-mon-show``
     Show ceph_mon of a specific host.
 
 ``cluster-list``
-    List clusters.
+    List ceph clusters.
 
 ``cluster-show``
-    Show cluster attributes.
+    Show ceph cluster attributes.
 
 ``host-stor-add``
-    Add a storage to a host.
+    Add a ceph storage disk (i.e. journal or |OSD|) to a host.
 
 ``host-stor-delete``
-    Delete a stor.
+    Delete a ceph storage disk (i.e. journal or |OSD|) from a host.
 
 ``host-stor-list``
-    List host storage.
+    List ceph storage disks (i.e. journal or |OSD|) of a host.
 
 ``host-stor-show``
-    Show storage attributes.
+    Show attributes of a ceph storage disk (i.e. journal or |OSD|) on a host.
 
 ``host-stor-update``
-    Modify journal attributes for OSD.
+    Modify ceph journal or |OSD| attributes.
 
 ``storage-backend-add``
     Add a storage backend.
@@ -914,3 +928,101 @@ Software upgrade commands
 
 ``health-query-upgrade``
     Run the health check for an upgrade.
+
+*************************************
+Host FPGA Configuration - Intel N3000
+*************************************
+
+The following set of commands allow you to update the Intel N3000 |FPGA| |PAC|
+user image on StarlingX hosts.
+
+For more information, see
+:doc:`N3000 Overview </node_management/kubernetes/hardware_acceleration_devices/n3000-overview>`.
+
+
+``host-device-image-update``
+    Update device image on a host.
+
+``host-device-image-update-abort``
+    Abort device image update on a host.
+
+``device-image-apply``
+    Apply the device image.
+
+``device-image-delete``
+    Delete a device image.
+
+``device-image-list``
+    List device images.
+
+``device-image-remove``
+    Remove the device image.
+
+``device-image-show``
+   Show device image details.
+
+``device-image-upload``
+    Upload a device image.
+
+``device-image-state-list``
+    List image to device mapping with status.
+
+``device-label-list``
+    List all device labels.
+
+``host-device-label-assign``
+    Assign a label to a device of a host.
+
+``host-device-label-list``
+    List device labels.
+
+``host-device-label-remove``
+    Remove a device label from a device of a host.
+
+**************************
+Kubernetes version upgrade
+**************************
+
+The following set of commands allow you to upgrade the version of Kubernetes.
+For more information, see
+:doc:`Kubernetes upgrade </configuration/k8s_upgrade>`.
+
+``kube-host-upgrade``
+    Perform Kubernetes upgrade for a host.
+
+``kube-host-upgrade-list``
+    List Kubernetes upgrade info for hosts.
+
+``health-query-kube-upgrade``
+    Run the health check for a Kubernetes upgrade.
+
+``host-label-list``
+    List Kubernetes labels assigned to a host.
+
+``kube-cluster-list``
+    List all Kubernetes clusters.
+
+``kube-cluster-show``
+    Show Kubernetes cluster details.
+
+``kube-version-list``
+    List all Kubernetes versions.
+
+``kube-version-show``
+    Show Kubernetes version details.
+
+``kube-upgrade-complete``
+    Complete a Kubernetes upgrade.
+
+``kube-upgrade-delete``
+    Delete a Kubernetes upgrade.
+
+``kube-upgrade-download-images``
+    Download Kubernetes images.
+
+``kube-upgrade-networking``
+    Upgrade Kubernetes networking.
+
+``kube-upgrade-show``
+    Show Kubernetes upgrade details and attributes.
+