Project

General

Profile

Actions

Bug #61753

closed

Better help message for cephfs-journal-tool -help command for --rank option.

Added by Manish Yathnalli 11 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Category:
Correctness/Safety
Target version:
% Done:

100%

Source:
Community (dev)
Tags:
backport_processed
Backport:
reef,quincy,pacific
Regression:
No
Severity:
3 - minor
Reviewed:
06/21/2023
Affected Versions:
ceph-qa-suite:
fs
Component(FS):
tools
Labels (FS):
Pull request ID:
Crash signature (v1):
Crash signature (v2):

Description

Current help message looks like this.

cephfs-journal-tool -h
Usage: 
  cephfs-journal-tool [options] journal <command>
    <command>:
      inspect
      import <path> [--force]
      export <path>
      reset [--force]
  cephfs-journal-tool [options] header <get|set> <field> <value>
    <field>: [trimmed_pos|expire_pos|write_pos|pool_id]
  cephfs-journal-tool [options] event <effect> <selector> <output> [special options]
    <selector>:
      --range=<start>..<end>
      --path=<substring>
      --inode=<integer>
      --type=<UPDATE|OPEN|SESSION...><
      --frag=<ino>.<frag> [--dname=<dentry string>]
      --client=<session id integer>
    <effect>: [get|recover_dentries|splice]
    <output>: [summary|list|binary|json] [--path <path>]

General options:
  --rank=filesystem:mds-rank|all Journal rank (mandatory)
  --journal=<mdlog|purge_queue>  Journal type (purge_queue means
                                 this journal is used to queue for purge operation,
                                 default is mdlog, and only mdlog support event mode)

Special options
  --alternate-pool <name>     Alternative metadata pool to target
                              when using recover_dentries.
  --conf/-c FILE    read configuration from the given configuration file
  --id ID           set ID portion of my name
  --name/-n TYPE.ID set name
  --cluster NAME    set cluster name (default: ceph)
  --setuser USER    set uid to user or uid (and gid to user's gid)
  --setgroup GROUP  set gid to group or gid
  --version         show version and quit

The option --rank=filesystem:mds-rank|all seems like we can pass all or filesystem:rank, but passing all does not work.

sudo cephfs-journal-tool --rank all journal inspect 
Error ((22) Invalid argument)

We need to pass it with filesystem
➜  ~ sudo cephfs-journal-tool --rank sep:all journal inspect 
Overall journal integrity: OK

We need to modify the help message to look like this
--rank=filesystem:{mds-rank|all}

Related issues 3 (0 open3 closed)

Copied to CephFS - Backport #61803: pacific: Better help message for cephfs-journal-tool -help command for --rank option.ResolvedVenky ShankarActions
Copied to CephFS - Backport #61804: quincy: Better help message for cephfs-journal-tool -help command for --rank option.ResolvedVenky ShankarActions
Copied to CephFS - Backport #61805: reef: Better help message for cephfs-journal-tool -help command for --rank option.ResolvedVenky ShankarActions
Actions #1

Updated by Manish Yathnalli 11 months ago

  • Status changed from New to In Progress
  • Assignee set to Manish Yathnalli
  • % Done changed from 0 to 20
Actions #2

Updated by Manish Yathnalli 11 months ago

  • Status changed from In Progress to Fix Under Review
Actions #3

Updated by Venky Shankar 11 months ago

  • Status changed from Fix Under Review to Pending Backport
  • Target version set to v19.0.0
  • Backport set to reef,quincy,pacific
Actions #4

Updated by Venky Shankar 11 months ago

  • Pull request ID set to 52149
Actions #5

Updated by Backport Bot 11 months ago

  • Copied to Backport #61803: pacific: Better help message for cephfs-journal-tool -help command for --rank option. added
Actions #6

Updated by Backport Bot 11 months ago

  • Copied to Backport #61804: quincy: Better help message for cephfs-journal-tool -help command for --rank option. added
Actions #7

Updated by Backport Bot 11 months ago

  • Copied to Backport #61805: reef: Better help message for cephfs-journal-tool -help command for --rank option. added
Actions #8

Updated by Backport Bot 11 months ago

  • Tags set to backport_processed
Actions #10

Updated by Konstantin Shalygin 6 months ago

  • Status changed from Pending Backport to Resolved
  • % Done changed from 20 to 100
Actions

Also available in: Atom PDF