Merge pull request canonical#250 from sabaini/doc/command-ref

Doc: add commands reference

docs/.wordlist.txt

@@ -4,6 +4,7 @@ APIs
 balancer
 Charmhub
 CLI
+DB
 dropdown
 Diátaxis
 EBS
@@ -18,6 +19,8 @@ Juju
 Kubernetes
 Kubeflow
 Makefile
+MicroCeph
+microceph
 MyST
 namespace
 namespaces
@@ -33,6 +36,7 @@ subdirectories
 subtree
 subfolders
 UI
+WAL
 Jira
 VM
 YAML

docs/reference/commands/disable.rst

@@ -0,0 +1,29 @@
+===========
+``disable``
+===========
+
+Disables a feature on the cluster
+
+Usage:
+
+.. code-block:: none
+
+   microceph disable [flags]
+   microceph disable [command]
+
+Available Commands:
+
+.. code-block:: none
+
+   rgw         Disable the RGW service on this node
+
+Global flags:
+
+.. code-block:: none
+
+   -d, --debug       Show all debug messages
+   -h, --help        Print help
+       --state-dir   Path to store state information
+   -v, --verbose     Show all information messages
+       --version     Print version number
+

docs/reference/commands/disk.rst

@@ -8,7 +8,7 @@ Usage:
 
 .. code-block:: none
 
-   microceph disk [options]
+   microceph disk [flags]
    microceph disk [command]
 
 Available commands:
@@ -19,7 +19,7 @@ Available commands:
    list        List servers in the cluster
    remove      Remove a Ceph disk (OSD)
 
-Global options:
+Global flags:
 
 .. code-block:: none
 
@@ -29,23 +29,65 @@ Global options:
    -v, --verbose     Show all information messages
        --version     Print version number
 
-``remove``
-----------
 
-Removes a single disk from the cluster.
+``add``
+-------
+
+Adds a disk to the cluster, alongside optional devices for write-ahead logging and database management.
+
+Usage:
+
+.. code-block:: none
+
+   microceph disk add <PATH> [flags]
+
+Flags:
+
+.. code-block:: none
+
+   --db-device string    The device used for the DB
+   --db-encrypt          Encrypt the DB device prior to use
+   --db-wipe             Wipe the DB device prior to use
+   --encrypt             Encrypt the disk prior to use
+   --wal-device string   The device used for WAL
+   --wal-encrypt         Encrypt the WAL device prior to use
+   --wal-wipe            Wipe the WAL device prior to use
+   --wipe                Wipe the disk prior to use
+
 
 .. note::
 
-   The ``remove`` command is currently only supported in channel
-   ``latest/edge`` of the :command:`microceph` snap.
+   Only the data device is mandatory. The WAL and DB devices can improve
+   performance by delegating the management of some subsystems to additional
+   block devices. The WAL block device stores the internal journal whereas
+   the DB one stores metadata. Using either of those should be advantageous
+   as long as they are faster than the data device. WAL should take priority
+   over DB if there isn't enough storage for both.
 
-Syntax:
+``list``
+--------
+
+List servers in the cluster
+
+Usage:
+
+.. code-block:: none
+
+   microceph disk list [flags]
+
+
+``remove``
+----------
+
+Removes a single disk from the cluster.
+
+Usage:
 
 .. code-block:: none
 
-   microceph disk remove <osd-id> [options]
+   microceph disk remove <osd-id> [flags]
 
-Options:
+Flags:
 
 .. code-block:: none
 

docs/reference/commands/enable.rst

@@ -0,0 +1,111 @@
+==========
+``enable``
+==========
+
+Enables a feature or service on the cluster.
+
+Usage:
+
+.. code-block:: none
+
+   microceph enable [flags]
+   microceph enable [command]
+
+Available commands:
+
+.. code-block:: none
+
+   mds         Enable the MDS service on the --target server (default: this server)
+   mgr         Enable the MGR service on the --target server (default: this server)
+   mon         Enable the MON service on the --target server (default: this server)
+   rgw         Enable the RGW service on the --target server (default: this server)
+
+Global flags:
+
+.. code-block:: none
+
+   -d, --debug       Show all debug messages
+   -h, --help        Print help
+       --state-dir   Path to store state information
+   -v, --verbose     Show all information messages
+       --version     Print version number
+
+``mds``
+-------
+
+Enables the MDS service on the --target server (default: this server).
+
+Usage:
+
+.. code-block:: none
+
+   microceph enable mds [--target <server>] [--wait <bool>] [flags]
+   
+
+Flags:
+
+.. code-block:: none
+
+   --target string   Server hostname (default: this server)
+   --wait            Wait for mds service to be up. (default true)
+   
+
+``mgr``
+-------
+
+Enables the MGR service on the --target server (default: this server).
+
+Usage:
+
+.. code-block:: none
+
+   microceph enable mgr [--target <server>] [--wait <bool>] [flags]
+   
+
+Flags:
+
+.. code-block:: none
+
+   --target string   Server hostname (default: this server)
+   --wait            Wait for mgr service to be up. (default true)
+   
+
+``mon``
+-------
+
+Enables the MON service on the --target server (default: this server).
+
+Usage:
+
+.. code-block:: none
+
+   microceph enable mon [--target <server>] [--wait <bool>] [flags]
+   
+
+Flags:
+
+.. code-block:: none
+
+   --target string   Server hostname (default: this server)
+   --wait            Wait for mon service to be up. (default true)
+   
+
+``rgw``
+-------
+
+Enables the RGW service on the --target server (default: this server).
+
+Usage:
+
+.. code-block:: none
+
+   microceph enable rgw [--port <port>] [--target <server>] [--wait <bool>] [flags]
+   
+
+Flags:
+
+.. code-block:: none
+
+   --port int        Service port (default: 80) (default 80)
+   --target string   Server hostname (default: this server)
+   --wait            Wait for rgw service to be up. (default true)

docs/reference/commands/help.rst

@@ -0,0 +1,22 @@
+========
+``help``
+========
+
+Help provides help for any command in the application.
+Simply type microceph help [path to command] for full details.
+
+Usage:
+
+.. code-block:: none
+
+   microceph help [command] [flags]
+
+Global flags:
+
+.. code-block:: none
+
+   -d, --debug       Show all debug messages
+   -h, --help        Print help
+       --state-dir   Path to store state information
+   -v, --verbose     Show all information messages
+       --version     Print version number

docs/reference/commands/init.rst

@@ -0,0 +1,21 @@
+========
+``init``
+========
+
+Initialises MicroCeph (in interactive mode).
+
+Usage:
+
+.. code-block:: none
+
+   microceph init [flags]
+
+Global flags:
+
+.. code-block:: none
+
+   -d, --debug       Show all debug messages
+   -h, --help        Print help
+       --state-dir   Path to store state information
+   -v, --verbose     Show all information messages
+       --version     Print version number

docs/reference/commands/status.rst

@@ -0,0 +1,22 @@
+==========
+``status``
+==========
+
+Reports the status of the cluster.
+
+Usage:
+
+.. code-block:: none
+
+   microceph status [flags]
+
+Global flags:
+
+.. code-block:: none
+
+   -d, --debug       Show all debug messages
+   -h, --help        Print help
+       --state-dir   Path to store state information
+   -v, --verbose     Show all information messages
+       --version     Print version number
+