starlingx/docs
Code Issues Proposed changes

Add intro sentence to CLI sections

Browse Source 
Add intro sentences to all CLI sections to provide context/usage info.

Patch: grammar and spelling corrections.

Story: 2006888
Task: 37713

Change-Id: Ie3e4f7278ceffadaedbe582644da8b600e851658
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-12-10 11:55:56 -08:00
parent 50ee21ab29
commit 5b3a6c016a
4 changed files with 185 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/cli_ref/dcmanager.rst
View File

@ -3,7 +3,8 @@ dcmanager
=========
:command:`dcmanager` is the command-line interface for the Distributed Cloud
Manager APIs.
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.
@ -53,6 +54,9 @@ For a full description of usage and optional arguments for a specific
Distributed cloud centralized alarms
************************************
Displays the aggregated counts of critical, major, minor, and warning alarms
across all subclouds.
``alarm summary``
List alarm summaries of subclouds.
@ -60,9 +64,15 @@ Distributed cloud centralized alarms
Distributed cloud subcloud installation
***************************************
This set of commands provides subcloud management, including basic add, delete,
list, show, and update operations on a subcloud.
``subcloud add``
Add a new subcloud.
Note that this command will create the subcloud in the central cloud's
database as well as run the Ansible bootstrap playbook on the new subcloud.
``subcloud delete``
Delete subcloud details from the database.
@ -70,25 +80,32 @@ Distributed cloud subcloud installation
List subclouds.
``subcloud manage``
Manage a subcloud.
Manage a subcloud. Refers to whether or not the subcloud is being actively
synchronized with the central cloud.
``subcloud show``
Show the details of a subcloud.
``subcloud unmanage``
Unmanage a subcloud.
Unmanage a subcloud. Refers to whether or not the subcloud is being actively
synchronized with the central cloud.
``subcloud update``
Update attributes of a subcloud.
***************************************
Distributed cloud patching and updating
***************************************
***********************************
Distributed cloud patching/updating
***********************************
.. important::
The following commands are not supported upstream.
The :command:`patch-strategy` commands create, apply, and monitor the
orchestration of software patch application (or updates) across all subclouds
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.

21
doc/source/cli_ref/fm.rst
View File

@ -52,32 +52,41 @@ For a full description of usage and optional arguments for a specific
Alarm and event display
***********************
The fault management (fm) alarm and event type commands enable the display of
active alarms and historical events.
``alarm-delete``
Delete an active alarm.
``alarm-list``
List all active alarms.
An active alarm is an alarm that is currently set and typically needs operator
attention in order to clear the alarm.
``alarm-show``
Show an active alarm.
An active alarm is an alarm that is currently set and typically needs operator
attention in order to clear the alarm.
``alarm-summary``
Show a summary of active alarms.
``event-list``
List event logs.
List event logs. Displays alarm sets, alarm clears, and customer log type events.
``event-show``
Show a event log.
Show a event log. Displays alarm sets, alarm clears, and customer log type events.
``event-suppress``
Suppress specified event ID's.
Suppress specified event IDs.
``event-suppress-list``
List Suppressed event ID's
List Suppressed event IDs
``event-unsuppress``
Unsuppress specified event ID's.
Unsuppress specified event IDs.
``event-unsuppress-all``
Unsuppress all event ID's.
Unsuppress all event IDs.

2
doc/source/cli_ref/index.rst
View File

@ -2,7 +2,7 @@
CLI Reference
=============
StarlingX project command line utility reference.
Reference for the StarlingX project command line interface (CLI).
.. toctree::
:maxdepth: 1

198
doc/source/cli_ref/system.rst
View File

@ -55,6 +55,14 @@ For a full description of usage and optional arguments for a specific
Certificate management
**********************
Certificate management commands allow you to install custom certificates
for a variety of StarlingX use cases. For example:
* StarlingX REST APIs and StarlingX Horizon web server.
* StarlingX local Docker registry.
* OpenStack REST APIs and OpenStack Horizon web server.
* StarlingX trusted certificate authority(s).
``certificate-install``
Install certificate.
@ -68,6 +76,10 @@ Certificate management
Local Docker registry management
********************************
Local Docker registry management commands enable you to remove images and
free disk resources consumed by the local Docker registry. This is required if
the local Docker registry's file system (`docker-distribution`) becomes full.
``registry-garbage-collect``
Run the registry garbage collector.
@ -84,6 +96,15 @@ Local Docker registry management
Host/controller file system configuration
*****************************************
Host/controller file system configuration commands manage file systems on hosts.
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
compute nodes.
Use :command:`controllerfs-*` commands to manage drbd-synchronized file systems on controller
nodes.
``host-fs-list``
Show list of host file systems.
@ -112,6 +133,13 @@ Host/controller file system configuration
System configuration
********************
The following set of commands enable configuration of:
* Basic system attributes
* OAM IP address(es), subnet, and gateway
* Remote DNS servers for StarlingX hosts
* Time synchronization protocols, for example: NPT and/or PTP
``modify``
Modify system attributes.
@ -146,6 +174,15 @@ System configuration
System configuration service-parameter
**************************************
Service parameters provide a generic mechanism to configure a variety of
configurable parameters in StarlingX, including:
* HTTP and HTTPS ports
* StarlingX Horizon authentication lockout parameters
* StarlingX Keystone token expiration
* StarlingX host management parameters such as heartbeat intervals and host boot
timeouts
``service-parameter-add``
Add service parameter.
@ -168,6 +205,13 @@ System configuration service-parameter
Host IPMI configuration and management
**************************************
The :command:`host-sensor*` commands provide the ability to:
* Display the sensors collected from hosts over IPMI.
* Define thresholds.
* Configure behavior when thresholds are crossed (for example ignore, log, or
reset).
``host-sensor-list``
List sensors.
@ -193,6 +237,13 @@ Host IPMI configuration and management
Application management
**********************
StarlingX provides an application package management that combines Airship
Armada and Kubernetes Helm. The StarlingX application management provides:
* System Helm overrides to automatically apply StarlingX applications according
to the particular StarlingX configuration currently running.
* Management for user specified Helm overrides.
``helm-chart-attribute-modify``
Modify Helm chart attributes.
@ -236,6 +287,10 @@ Application management
SNMP configuration
******************
StarlingX supports a simple SNMPv2c agent. All fault management alarms and events
are sent out as SNMP traps. SNMP GET requests are supported in an active alarm
table and a historical events table.
``snmp-comm-add``
Add a new SNMP community.
@ -265,6 +320,11 @@ SNMP configuration
Host configuration
******************
Host commands manage the general configuration of a StarlingX host. This
includes assignment of CPU cores to platform or hosted applications, the
configuration of amount and size for memory huge pages, and the configuration of
Kubernetes node labels.
``host-list``
List hosts.
@ -315,6 +375,10 @@ Host configuration
Host operational commands
*************************
The following set of commands provides operational host commands, including
taking a host in and out of service (lock/unlock), resetting a host, rebooting a
host, and powering a host on and off.
``host-lock``
Lock a host.
@ -343,6 +407,9 @@ Host operational commands
Host interface configuration
****************************
The following set of commands manages the display and configuration of host
interfaces.
``host-ethernet-port-list``
List host Ethernet ports.
@ -350,31 +417,39 @@ Host interface configuration
Show host Ethernet port attributes.
``host-port-list``
List host ports.
List host ports. Displays the L1 host ports and their attributes.
``host-port-show``
Show host port details.
Show host port details. Displays the L1 host ports and their attributes.
``host-if-add``
Add an interface.
Add an interface. Adds L2 host interfaces (Ethernet, VLAN, and
LAG type L2 host interfaces).
``host-if-delete``
Delete an interface.
Delete an interface. Deletes L2 host interfaces (Ethernet, VLAN, and
LAG type L2 host interfaces).
``host-if-list``
List interfaces.
List interfaces. Displays L2 host interfaces (Ethernet, VLAN, and
LAG type L2 host interfaces).
``host-if-modify``
Modify interface attributes.
Modify interface attributes. Modifies L2 host interfaces (Ethernet, VLAN, and
LAG type L2 host interfaces).
``host-if-show``
Show interface attributes.
Show interface attributes. Displays L2 host interfaces (Ethernet, VLAN, and
LAG type L2 host interfaces).
****************************************************
Host platform L2 network, IP addressing, and routing
****************************************************
The following set of commands defines types of L2 platform networks, assignment
of L2 platform networks to interfaces, and configuration of L3 IP interfaces and
routing.
``network-add``
Add a network.
@ -442,6 +517,11 @@ Host platform L2 network, IP addressing, and routing
Host data networks
******************
The following set of commands defines types of L2 data networks and assignment of
L2 data networks to interfaces. Data networks represent the underlying L2
networks for Kubernetes SRIOV/PCIPASSTHROUGH network attachments or OpenStack
tenant networks.
``datanetwork-add``
Add a data network.
@ -473,6 +553,9 @@ Host data networks
Host disk configuration
***********************
The following set of commands enables the display and configuration of host disks,
volume groups, and disk partitions.
``host-disk-list``
List disks.
@ -482,21 +565,6 @@ Host disk configuration
``host-disk-wipe``
Wipe disk and GPT format it.
``host-stor-add``
Add a storage to a host.
``host-stor-delete``
Delete a stor.
``host-stor-list``
List host storage.
``host-stor-show``
Show storage attributes.
``host-stor-update``
Modify journal attributes for OSD.
``host-lvg-add``
Add a local volume group.
@ -524,12 +592,6 @@ Host disk configuration
``host-pv-show``
Show physical volume attributes.
``cluster-list``
List clusters.
``cluster-show``
Show cluster attributes.
``host-disk-partition-add``
Add a disk partition to a disk of a specified host.
@ -545,25 +607,46 @@ Host disk configuration
``host-disk-partition-show``
Show disk partition attributes.
``storage-tier-add``
Add a storage tier to a disk of a specified cluster.
``storage-tier-delete``
Delete a storage tier.
``storage-tier-list``
List storage tiers.
``storage-tier-modify``
Modify the attributes of a storage tier.
``storage-tier-show``
Show storage tier attributes.
******************
CEPH configuration
******************
The following set of commands is used to configure and manage CEPH OSDs, CEPH
tiers, and CEPH storage cluster backends.
``ceph-mon-add``
``ceph-mon-delete``
``ceph-mon-list``
List CEPH mons.
``ceph-mon-modify``
``ceph-mon-show``
Show ceph_mon of a specific host.
``cluster-list``
List clusters.
``cluster-show``
Show cluster attributes.
``host-stor-add``
Add a storage to a host.
``host-stor-delete``
Delete a stor.
``host-stor-list``
List host storage.
``host-stor-show``
Show storage attributes.
``host-stor-update``
Modify journal attributes for OSD.
``storage-backend-add``
Add a storage backend.
@ -579,23 +662,27 @@ CEPH configuration
``storage-backend-show``
Show a storage backend.
``ceph-mon-add``
``storage-tier-add``
Add a storage tier to a disk of a specified cluster.
``ceph-mon-delete``
``storage-tier-delete``
Delete a storage tier.
``ceph-mon-list``
List ceph mons.
``storage-tier-list``
List storage tiers.
``ceph-mon-modify``
``storage-tier-modify``
Modify the attributes of a storage tier.
``ceph-mon-show``
Show ceph_mon of a specific host.
``storage-tier-show``
Show storage tier attributes.
**************************
Host PCI device management
**************************
Host PCI device management commands (not including NICs).
The following set of commands provides host PCI device management (not including
NICs).
``host-device-list``
List devices.
@ -610,6 +697,9 @@ Host PCI device management commands (not including NICs).
Host LLDP operational commands
******************************
The following set of commands displays neighbor information learned from the
Link Layer Discovery Protocol (LLDP), which runs on all host interfaces.
``host-lldp-agent-list``
List host LLDP agents.
@ -626,6 +716,10 @@ Host LLDP operational commands
Controller services management
******************************
The following set of commands enables display of services running on the StarlingX
controllers/masters. Optional services can be enabled or disabled using these
commands.
``servicenode-list``
List service nodes.