Project

General

Profile

Actions

Cleanup #63612

open

get-attrs,set-attrs and rm-attrs option details are not included in the ceph-objectstore-tool help

Added by Laura Flores 6 months ago. Updated 5 months ago.

Status:
Fix Under Review
Priority:
Normal
Assignee:
-
Target version:
-
% Done:

0%

Tags:
low-hanging-fruit
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Description of problem:

The options that exist in the troubleshooting guide for getting, setting and removing object attribute keys are not included in the ceph-objectstore-tool(COT) help.

ceph-objectstore-tool --help

Allowed options:
  --help                      produce help message
  --type arg                  Arg is one of [bluestore (default), filestore, 
                              memstore]
  --data-path arg             path to object store, mandatory
  --journal-path arg          path to journal, use if tool can't find it
  --pgid arg                  PG id, mandatory for info, log, remove, export, 
                              export-remove, mark-complete, trim-pg-log, 
                              trim-pg-log-dups and mandatory for 
                              apply-layout-settings if --pool is not specified
  --pool arg                  Pool name, mandatory for apply-layout-settings if
                              --pgid is not specified
  --op arg                    Arg is one of [info, log, remove, mkfs, fsck, 
                              repair, fuse, dup, export, export-remove, import,
                              list, list-slow-omap, fix-lost, list-pgs, 
                              dump-journal, dump-super, meta-list, get-osdmap, 
                              set-osdmap, get-inc-osdmap, set-inc-osdmap, 
                              mark-complete, reset-last-complete, 
                              apply-layout-settings, update-mon-db, 
                              dump-export, trim-pg-log, trim-pg-log-dups 
                              statfs]
  --epoch arg                 epoch# for get-osdmap and get-inc-osdmap, the 
                              current epoch in use if not specified
  --file arg                  path of file to export, export-remove, import, 
                              get-osdmap, set-osdmap, get-inc-osdmap or 
                              set-inc-osdmap
  --mon-store-path arg        path of monstore to update-mon-db
  --fsid arg                  fsid for new store created by mkfs
  --target-data-path arg      path of target object store (for --op dup)
  --mountpoint arg            fuse mountpoint
  --format arg (=json-pretty) Output format which may be json, json-pretty, 
                              xml, xml-pretty
  --debug                     Enable diagnostic output to stderr
  --no-mon-config             Do not contact mons for config
  --no-superblock             Do not read superblock
  --force                     Ignore some types of errors and proceed with 
                              operation - USE WITH CAUTION: CORRUPTION POSSIBLE
                              NOW OR IN THE FUTURE
  --skip-journal-replay       Disable journal replay
  --skip-mount-omap           Disable mounting of omap
  --head                      Find head/snapdir when searching for objects by 
                              name
  --dry-run                   Don't modify the objectstore
  --tty                       Treat stdout as a tty (no binary data)
  --namespace arg             Specify namespace when searching for objects
  --rmtype arg                Specify corrupting object removal 'snapmap' or 
                              'nosnapmap' - TESTING USE ONLY
  --slow-omap-threshold arg   Threshold (in seconds) to consider omap listing 
                              slow (for op=list-slow-omap)

Positional syntax:

ceph-objectstore-tool ... <object> (get|set)-bytes [file]
ceph-objectstore-tool ... <object> set-(attr|omap) <key> [file]
ceph-objectstore-tool ... <object> (get|rm)-(attr|omap) <key>
ceph-objectstore-tool ... <object> get-omaphdr
ceph-objectstore-tool ... <object> set-omaphdr [file]
ceph-objectstore-tool ... <object> list-attrs
ceph-objectstore-tool ... <object> list-omap
ceph-objectstore-tool ... <object> remove|removeall
ceph-objectstore-tool ... <object> dump
ceph-objectstore-tool ... <object> set-size
ceph-objectstore-tool ... <object> clear-data-digest
ceph-objectstore-tool ... <object> remove-clone-metadata <cloneid>

<object> can be a JSON object description as displayed
by --op list.
<object> can be an object name which will be looked up in all
the OSD's PGs.
<object> can be the empty string ('') which with a provided pgid
specifies the pgmeta object

The optional [file] argument will read stdin or write stdout
if not specified or if '-' specified.
[ceph: root@mero006 /]#

Steps to Reproduce:
1.Configure a cluster
2.Get into OSD container and check the ceph objectstore tool help

Actions #2

Updated by Laura Flores 6 months ago

  • Translation missing: en.field_tag_list changed from test-failure to low-hanging-fruit
Actions #3

Updated by Laura Flores 6 months ago

  • Tags set to low-hanging-fruit
Actions #4

Updated by Laura Flores 5 months ago

  • Status changed from New to Fix Under Review
  • Pull request ID set to 54680
Actions

Also available in: Atom PDF