/kubectl-rook-ceph

Krew plugin to run kubectl commands with rook-ceph

Primary LanguageShellApache License 2.0Apache-2.0

Rook

kubectl-rook-ceph

Provide common management and troubleshooting tools for the Rook Ceph storage provider as a Krew plugin.

Install

To install the plugin, run:

kubectl krew install rook-ceph

Usage

kubectl rook-ceph <root-args> <command> <command-args>

Root args

  • --namespace | -n: the Kubernetes namespace in which the CephCluster resides (default: rook-ceph)
  • --operator-namespace | -o: the Kubernetes namespace in which the rook operator resides (default: rook-ceph)
  • --context: the name of the Kubernetes context to be used
  • --help | -h: Output help text

Commands

  • ceph <args> : Run a Ceph CLI command. Supports any arguments the ceph command supports. See Ceph docs for more.

  • rbd <args> : Call a 'rbd' CLI command with arbitrary args"

  • mons : Print mon endpoints"

  • operator

    • restart : Restart the Rook-Ceph operator
    • set <property> <value> : Set the property in the rook-ceph-operator-config configmap.

  • rook

    • version : Print the version of Rook"
    • status : Print the phase and/or conditions of every CR in the namespace"
    • status all : Print the phase and conditions of all CRs
    • status <CR> : Print the phase and conditions of CRs of a specific type, such as cephobjectstore, cephfilesystem, etc

  • help : Output help text

Examples

Run a Ceph Command

Any ceph command can be run with the plugin. This example gets the ceph status:

kubectl rook-ceph ceph status
 cluster:
   id:     a1ac6554-4cc8-4c3b-a8a3-f17f5ec6f529
   health: HEALTH_OK

 services:
   mon: 3 daemons, quorum a,b,c (age 11m)
   mgr: a(active, since 10m)
   mds: 1/1 daemons up, 1 hot standby
   osd: 3 osds: 3 up (since 10m), 3 in (since 8d)

 data:
   volumes: 1/1 healthy
   pools:   6 pools, 137 pgs
   objects: 34 objects, 4.1 KiB
   usage:   58 MiB used, 59 GiB / 59 GiB avail
   pgs:     137 active+clean

 io:
   client:   1.2 KiB/s rd, 2 op/s rd, 0 op/s wr

Restart the Operator

kubectl rook-ceph operator restart
deployment.apps/rook-ceph-operator restarted

Rook Version

kubectl rook-ceph rook version
rook: v1.8.0-alpha.0.267.g096dabfa6
go: go1.16.13

Ceph Versions

kubectl rook-ceph ceph versions
{
    "mon": {
        "ceph version 16.2.7 (dd0603118f56ab514f133c8d2e3adfc983942503) pacific (stable)": 1
    },
    "mgr": {
        "ceph version 16.2.7 (dd0603118f56ab514f133c8d2e3adfc983942503) pacific (stable)": 1
    },
    "osd": {
        "ceph version 16.2.7 (dd0603118f56ab514f133c8d2e3adfc983942503) pacific (stable)": 1
    },
    "mds": {},
    "overall": {
        "ceph version 16.2.7 (dd0603118f56ab514f133c8d2e3adfc983942503) pacific (stable)": 3
    }
}

Contributing

We welcome contributions. See the Rook Contributing Guide to get started.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Contact

Please use the following to reach members of the community:

Licensing

Rook is under the Apache 2.0 license.

FOSSA Status