Skip to content

[lightspeed] Add new plugin for RH command-line-assistant#4070

Open
jcastill wants to merge 1 commit intososreport:mainfrom
jcastill:jcastillo-lightspeed-cla
Open

[lightspeed] Add new plugin for RH command-line-assistant#4070
jcastill wants to merge 1 commit intososreport:mainfrom
jcastill:jcastillo-lightspeed-cla

Conversation

@jcastill
Copy link
Copy Markdown
Member

@jcastill jcastill commented Jul 7, 2025

This commit creates the plugin for RHEL Lightspeed Command Line Assistant.

Related: RSPEED-549, RHEL-102037


Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines

  • Is the commit message split over multiple lines and hard-wrapped at 72 characters?
  • Is the subject and message clear and concise?
  • Does the subject start with [plugin_name] if submitting a plugin patch or a [section_name] if part of the core sosreport code?
  • Does the commit contain a Signed-off-by: First Lastname email@example.com?
  • Are any related Issues or existing PRs properly referenced via a Closes (Issue) or Resolved (PR) line?
  • Are all passwords or private data gathered by this PR obfuscated?

@jcastill
Copy link
Copy Markdown
Member Author

jcastill commented Jul 7, 2025

Work in progress for now. I'm reviewing what needs to be obfuscated (for now, only db passwords, but waiting for confirmation) and log captures.

@packit-as-a-service
Copy link
Copy Markdown

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

  • sudo yum install -y dnf-plugins-core on RHEL 8
  • sudo dnf install -y dnf-plugins-core on Fedora
  • dnf copr enable packit/sosreport-sos-4070
  • And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

Comment thread sos/report/plugins/lightspeed.py Outdated
services = ('clad',)

def setup(self):
self.add_copy_spec("/etc/xdg/command-line-assistant/config.toml")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

T see the file has (commented out by default, unsure if supported) options:

# In order to use postgresql, uncomment the following settings:
# [database]
# type = "postgresql"
# host = "localhost"
# port = "5432"
# username = "your-user"
# password = "your-password"
# database = "history"

# Or, to use mysql, uncomment the following:
# [database]
# type = "mysql"
# host = "localhost"
# port = "3306"
# username = "your-user"
# password = "your-password"
# database = "history"

so shall we scrub passwords from it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

passwords for sure, but I'm waiting to see if something else needs to be scrubbed. Do you prefer if I add the postproc now and expand it later?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let add it later, no need now.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to push a new change with the updated commands requested in the new ticket, and I'll start working on obfuscating the passwords.
I'll leave this PR still in draft because we need to discuss the database collection

@jcastill jcastill force-pushed the jcastillo-lightspeed-cla branch from d81a715 to 0a7f3ca Compare October 20, 2025 09:14
Comment thread sos/report/plugins/lightspeed.py Outdated
def setup(self):
self.add_copy_spec([
"/etc/xdg/command-line-assistant/config.toml",
"/var/lib/command-line-assistant/history.db",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth putting this under a plugopt, disabled by default - it can contain some potentially sensitive information.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both files, or just the db?
I imagine just the db, and for the config I can add the usual obfuscation of passwords, right?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed!

@jcastill jcastill force-pushed the jcastillo-lightspeed-cla branch from 0a7f3ca to 583fc53 Compare October 24, 2025 09:34
@arif-ali
Copy link
Copy Markdown
Member

This is still in draft, is this reviewable?

@jcastill
Copy link
Copy Markdown
Member Author

@arif-ali if you have the bandwith then yes, please.
It's in draft because we are waiting for internal testing and the original reporter to answer some questions.

@jcastill
Copy link
Copy Markdown
Member Author

jcastill commented Mar 5, 2026

Finally got an ack from RH engineering, and I'm just waiting for review of the plugin name. As soon as it's done, I'll move this out of draft.

@jcastill jcastill force-pushed the jcastillo-lightspeed-cla branch from 583fc53 to ed8e6bb Compare March 5, 2026 09:29
@packit-as-a-service
Copy link
Copy Markdown

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

  • sudo dnf install -y 'dnf*-command(copr)'
  • dnf copr enable packit/sosreport-sos-4070
  • And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

@jcastill jcastill changed the title [lightspeed] Add new plugin for RH Lightspeed [lightspeed] Add new plugin for RH command-line-assistant Apr 9, 2026
@jcastill
Copy link
Copy Markdown
Member Author

jcastill commented Apr 9, 2026

The lightspeed product will now have two tools, and command-line-assistant is one of them. I'll push a new commit with this change and prepare it for review

This commit creates the plugin for RHEL Lightspeed
Command Line Assistant.

Related: RSPEED-549, RHEL-102037, RHEL-122242

Signed-off-by: Jose Castillo <jcastillo@redhat.com>
@jcastill jcastill force-pushed the jcastillo-lightspeed-cla branch from ed8e6bb to 0dde803 Compare April 9, 2026 11:27
@jcastill jcastill marked this pull request as ready for review April 9, 2026 11:44
@jcastill jcastill added Kind/New plugin New plugin being added Kind/report Changes to the report component labels Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Kind/New plugin New plugin being added Kind/report Changes to the report component

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants