====== CEPH: Cheatsheet! ======

^  Documentation  ^|
^Name:| CEPH: Cheatsheet!  |
^Description:| CHEATSHEET |
^Modification date :|25/01/2019|
^Owner:|dodger|
^Notify changes to:|Owner|
^Tags:| ceph, object storage|
^Scalate to:|The_fucking_bofh|

====== Cheatsheet ======

===== Admin =====

==== Health ====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph health</code> | Status of the cluster |
|<code bash>ceph health detail</code> | Detailed status of the cluster |
|<code bash>ceph -s</code> | Another way to see the status |

==== disk ====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph df</code> | ''df'' of the cluster |
|<code bash>ceph df detail</code> | Detailed usage of the cluster |



===== Object Gateway =====


^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>radosgw-admin metadata list user</code> | list current created users |
|<code bash>radosgw-admin --uid=user1 user info </code> | Show user info |
|<code bash>radosgw-admin --uid=user1 user suspend </code> | Suspend user account |
|<code bash>radosgw-admin bucket list</code> | list ALL buckets |
|<code bash>radosgw-admin bucket list --uid=userID</code> | list buckets from user |
|<code bash>radosgw-admin bucket rm --bucket=mybucket --purge-objects </code>| Drop bucket INCLUDING CONTENTS | 

===== MON =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph mon_status -f json-pretty</code> | Local monitor status  |
|<code bash>ceph --cluster=ceph --admin-daemon /var/run/ceph/ceph-mon.${THESERVER}.asok mon_status -f json-pretty</code> | Detailed mon server status, change ''${THESERVER}'' variable |

===== OSD =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph osd df</code> | osd disk usage (aka ''df'')|

===== CRUSH =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph osd crush tree</code> | view the CRUSH hierarchy |
|<code bash>ceph osd crush rule ls</code> | view the CRUSH rules |
|<code bash>ceph osd crush rule dump</code> | view the CRUSH rules definition |
|<code bash>ceph osd getcrushmap  -o crushmap.bin</code> | write //live// crushmap to ''crushmap.bin''  |
|<code bash>crushtool  -d crushmap.bin -o crushmap.txt</code> | Decompile ''crushmap.bin'' |
|<code bash>crushtool -c crushmap.txt -o crushmap.bin.new</code> | Compile crushmap |
|<code bash>ceph osd setcrushmap -i crushmap.bin.new</code> | Push new CRUSHmap to cluster |


===== POOL =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph osd pool ls</code> | list pools |
|<code bash>ceph osd pool ls detail</code> | list pools with additional info |
|<code bash>ceph osd crush rule dump</code> | view the CRUSH rules definition |
|<code bash>ceph osd pool create ${new_pool}</code> | Create ''${new_pool}'' |
|<code bash>ceph osd pool create ${new_pool} 500 500 replicated ciberterminalRule</code> | Create pool with pg_num, pgp_num, type and crush rule |
|<code bash>rados cppool ${old_pool} ${new_pool}</code> | Copy one pool to another |
|<code bash>ceph osd pool rename ${new_pool} ${old_pool}</code> | rename pool |
|<code bash>ceph osd pool ls</code> | list pools |
|<code bash>ceph osd pool ls</code> | list pools |
|<code bash>ceph osd pool set ${POOL_NAME} pg_num 500</code> | Change pg's of a pool |
|<code bash>ceph osd pool set ${POOL_NAME} crush_rule ciberterminalRule</code> | Change pg's CRUSH map |
|<code bash>ceph osd pool get ${POOL_NAME} all</code> | get options set for ''${POOL_NAME}'' |



===== MGR =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph mgr services</code> | running services |
|<code bash>ceph mgr module ls</code> | list modules for ''mgr</code> |



===== MDS (cehpfs) =====

^ ##############''cmd''############## ^ ------------------------------------------------------------------ ^
|<code bash>ceph fs ls</code> | list filesystems |
|<code bash>ceph mgr module ls</code> | list modules for ''mgr</code> |