summaryrefslogtreecommitdiffstats
path: root/doc/ceph-volume/drive-group.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ceph-volume/drive-group.rst')
-rw-r--r--doc/ceph-volume/drive-group.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/ceph-volume/drive-group.rst b/doc/ceph-volume/drive-group.rst
new file mode 100644
index 000000000..4b2b8ed94
--- /dev/null
+++ b/doc/ceph-volume/drive-group.rst
@@ -0,0 +1,12 @@
+.. _ceph-volume-drive-group:
+
+``drive-group``
+===============
+The drive-group subcommand allows for passing :ref:'drivegroups' specifications
+straight to ceph-volume as json. ceph-volume will then attempt to deploy this
+drive groups via the batch subcommand.
+
+The specification can be passed via a file, string argument or on stdin.
+See the subcommand help for further details::
+
+ # ceph-volume drive-group --help