Bug 2265490 - [DOCS] Change in "ceph callhome show" command
Summary: [DOCS] Change in "ceph callhome show" command
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Documentation
Version: 7.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: 7.0z1
Assignee: Rivka Pollack
QA Contact: Sayalee
Akash Raj
URL:
Whiteboard:
Depends On: 2243795
Blocks: 2260311
TreeView+ depends on / blocked
 
Reported: 2024-02-22 10:43 UTC by Rivka Pollack
Modified: 2024-04-15 11:33 UTC (History)
15 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 2243795
Environment:
Last Closed: 2024-03-07 14:50:50 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHCEPH-8362 0 None None None 2024-02-22 10:45:11 UTC

Description Rivka Pollack 2024-02-22 10:43:35 UTC
Update https://ibmdocs-test.dcs.ibm.com/docs/en/storage-ceph/7?topic=interface-using-call-home
- command in last row of the table
- check if there is any other references to `call home show user info` command. 

Replace `call home show user info` with `call home get user info`


+++ This bug was initially created as a clone of Bug #2243795 +++

Description of problem:
=======================
On running the "ceph callhome show" command, the user should get an option of reports that are available for checking.

# ceph callhome show
no valid command found; 2 closest matches:
callhome show <report_type>
callhome show user info
Error EINVAL: invalid command


Version-Release number of selected component (if applicable):
=============================================================
# dnf info cephadm
Updating Subscription Management repositories.
Last metadata expiration check: 3:18:32 ago on Thu Oct 12 23:32:29 2023.
Installed Packages
Name         : cephadm
Epoch        : 2
Version      : 18.2.0
Release      : 69.el9cp
Architecture : noarch
Size         : 231 k
Source       : cephadm-18.2.0-69.el9cp.src.rpm
Repository   : @System
From repo    : IBM-CEPH-7.0-20231002.ci.0
Summary      : Utility to bootstrap Ceph clusters
URL          : https://ceph.io
License      : LGPL-2.1
Description  : Utility to bootstrap a Ceph cluster and manage Ceph daemons deployed
             : with systemd and podman.


How reproducible:
================
Always


Steps to Reproduce:
==================
1. Deploy a IBM Ceph Storage 7 cluster
2. Enable call_home_agent on the cluster
3. From CLI, run the "ceph callhome show" commnad


Actual results:
===============
If no key is passed to the command, it returns output as -
# ceph callhome show
no valid command found; 2 closest matches:
callhome show <report_type>
callhome show user info
Error EINVAL: invalid command


Expected results:
=================
The ceph callhome show command does not provide any info on the available report options 

Whereas, the ceph callhome send command does that-
# ceph callhome send
Invalid command: missing required parameter report_type(<string>)
callhome send <report_type> :  Command for sending the report requested. Available reports: inventory, status, last_contact Example:     ceph callhome send inventory
Error EINVAL: invalid command

We should add similar info to the "show" command as well.

--- Additional comment from Juan Miguel Olmo on 2023-12-12 16:48:29 UTC ---

Fix available in: https://github.ibm.com/ceph/ceph/pull/41

Unfortunately  the existence of two "callhome show" commands hide the "help" of these commands:
Example:

```
# ceph callhome show
no valid command found; 2 closest matches:
callhome show <report_type>
callhome show user info
Error EINVAL: invalid command
```
I have decided to change the prefix used to show the user info (now is "callhome get user info"). In this way we only have one "callhome show" command, and therefore the help info for every command is shown properly:

Example:
```
[ceph: root@chatest-node-00 /]# ceph callhome show
Invalid command: missing required parameter report_type(<string>)
callhome show <report_type> :  Prints the report requested. Available reports: inventory, status, last_contact, performance Example:     ceph callhome show inventory
Error EINVAL: invalid command
```

```
[ceph: root@chatest-node-00 /]# ceph callhome send
Invalid command: missing required parameter report_type(<string>)
callhome send <report_type> :  Command for sending the report requested. Available reports: inventory, status, last_contact, performance Example:     ceph callhome send inventory
Error EINVAL: invalid command
```

```
[ceph: root@chatest-node-00 /]# ceph callhome get          
no valid command found; 1 closest matches:
callhome get user info
```

--- Additional comment from Yaarit Hatuka on 2023-12-13 02:30:48 UTC ---

Changing the target release to 7.0z1.

Changing the status from POST to ASSIGNED since the fix has not landed yet in GitLab.

--- Additional comment from Yaarit Hatuka on 2024-01-19 20:29:11 UTC ---

GitLab's ceph-7.1-rhel-patches MR:
https://gitlab.cee.redhat.com/ceph/ceph/-/merge_requests/471

GitLab's ceph-7.0-rhel-patches MR:
https://gitlab.cee.redhat.com/ceph/ceph/-/merge_requests/472

--- Additional comment from Rivka Pollack on 2024-01-30 12:34:35 UTC ---

Do we want to add this to the release notes content?
Please update the Doc Type and Doc Text advanced fields. Thank you

--- Additional comment from  on 2024-01-31 04:31:42 UTC ---

Move to ON_QA when we have an IBM ceph build with ceph-18.2.0-144.el9cp.

Thomas

--- Additional comment from Ken Dreyer (Red Hat) on 2024-02-01 20:53:11 UTC ---

GitLab MR 471 is present in today's 7.1 IBM compose (IBM-CEPH-7.1-202402011813.ci.0 and cp.stg.icr.io/cp/ibm-ceph/ceph-7-rhel9:7-16).

Justin and I have not yet begun the 7.0 z1 builds for IBM.

--- Additional comment from Ken Dreyer (Red Hat) on 2024-02-14 16:41:28 UTC ---

IBM Ceph 7.0z1 builds are available now https://github.ibm.com/ceph/ibm-tools/issues/326

--- Additional comment from Sayalee on 2024-02-19 17:38:10 UTC ---

On_QA validation:
=================

IBM ceph version - 18.2.0-144.el9cp


Steps performed -

1) Deploy a IBM Ceph storage cluster
2) Enable CallHome on the cluster
3) Use the old command - "#ceph callhome show user info"; to view the callhome user information
4) Use the new command as introduced with this bug - "#ceph callhome get user info"; to view the callhome user information


Observations -

# ceph mgr module ls
MODULE
balancer              on (always on)
crash                 on (always on)
devicehealth          on (always on)
orchestrator          on (always on)
pg_autoscaler         on (always on)
progress              on (always on)
rbd_support           on (always on)
status                on (always on)
telemetry             on (always on)
volumes               on (always on)
call_home_agent       on
cephadm               on
dashboard             on
iostat                on


# ceph callhome show user info
Invalid command: unused arguments: ['info']
callhome show <report_type> :  Prints the report requested. Available reports: inventory, status, last_contact Example:     ceph callhome show inventory
Error EINVAL: invalid command


# ceph callhome get
no valid command found; 1 closest matches:
callhome get user info
Error EINVAL: invalid command


# ceph callhome get user info
{"IBM_call_home": {"icn": "ABCD123", "customer_first_name": "Test1", "customer_last_name": "Last1", "customer_phone": "6187264872", "customer_address": "None", "customer_email": "hello123", "customer_company_name": "None", "customer_country_code": "None"}, "IBM_storage_insights": {"owner_ibm_id": "", "owner_company_name": "", "owner_first_name": "", "owner_last_name": "", "owner_email": "", "owner_tenant_id": ""}}



* The command "ceph callhome show user info" has been modified to reflect the options  "inventory, status, last_contact" as expected
* The newly added command "ceph callhome get" correctly reflects the option "user info"
* The command "ceph callhome get user info" is working as expected.
* Moving the bug to verified.

--- Additional comment from Rivka Pollack on 2024-02-19 19:40:02 UTC ---

Please fill in the Doc Type and Doc Type for the 7.0z1 release notes.
If no release notes documentation is needed, choose No docs update from the Doc Type dropdown.
Thanks!

--- Additional comment from Rivka Pollack on 2024-02-21 17:43:29 UTC ---

Hi,

Please mark if we want this as an enhancement or removed functionality? (I suggest one of the two).


Note You need to log in before you can comment on or make changes to this bug.