Browse Source

Merge "Update README.md with information on initializing disks"

Zuul 10 months ago
parent
commit
a8b50bff6f
1 changed files with 22 additions and 10 deletions
  1. 22
    10
      README.md

+ 22
- 10
README.md View File

@@ -5,8 +5,8 @@ Ceph is a distributed storage and network file system designed to provide
5 5
 excellent performance, reliability, and scalability.
6 6
 
7 7
 This charm deploys additional Ceph OSD storage service units and should be
8
-used in conjunction with the 'ceph' charm to scale out the amount of storage
9
-available in a Ceph cluster.
8
+used in conjunction with the 'ceph-mon' charm to scale out the amount of
9
+storage available in a Ceph cluster.
10 10
 
11 11
 Usage
12 12
 =====
@@ -18,6 +18,10 @@ cluster::
18 18
         A list of devices that the charm will attempt to detect, initialise and
19 19
         activate as ceph storage.
20 20
 
21
+        If the charm detects pre-existing data on a device it will go into a
22
+        blocked state and the operator must resolve the situation utilizing the
23
+        `list-disks`, `zap-disk` and/or `blacklist-*` actions.
24
+
21 25
         This this can be a superset of the actual storage devices presented to
22 26
         each service unit and can be changed post ceph-osd deployment using
23 27
         `juju set`.
@@ -25,20 +29,28 @@ cluster::
25 29
 For example::
26 30
 
27 31
     ceph-osd:
32
+      options:
28 33
         osd-devices: /dev/vdb /dev/vdc /dev/vdd /dev/vde
29 34
 
30
-Boot things up by using::
35
+Example utilizing Juju storage::
36
+
37
+    ceph-osd:
38
+      storage:
39
+        osd-devices: cinder,20G
31 40
 
32
-    juju deploy -n 3 --config ceph.yaml ceph
41
+Please refer to [Juju Storage Documentation](https://docs.jujucharms.com/devel/en/charms-storage) for details on support for various storage providers and cloud substrates.
33 42
 
34
-You can then deploy this charm by simple doing::
43
+How to deploy::
35 44
 
36
-    juju deploy -n 10 --config ceph.yaml ceph-osd
37
-    juju add-relation ceph-osd ceph
45
+    juju deploy -n 3 ceph-osd
46
+    juju deploy ceph-mon --to lxd:0
47
+    juju add-unit ceph-mon --to lxd:1
48
+    juju add-unit ceph-mon --to lxd:2
49
+    juju add-relation ceph-osd ceph-mon
38 50
 
39
-Once the ceph charm has bootstrapped the cluster, it will notify the ceph-osd
40
-charm which will scan for the configured storage devices and add them to the
41
-pool of available storage.
51
+Once the 'ceph-mon' charm has bootstrapped the cluster, it will notify the
52
+ceph-osd charm which will scan for the configured storage devices and add them
53
+to the pool of available storage.
42 54
 
43 55
 Network Space support
44 56
 =====================

Loading…
Cancel
Save