Skip to content

Conversation

@Lennonka
Copy link
Contributor

@Lennonka Lennonka commented Jan 7, 2025

What changes are you introducing?

Adding a note to global registration for users who need to edit the registration command

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

New feature allows users to search certain resources not only by ID but also by name.
This feature was introduced to ease transition from the bootstrap script to global registration.
Documents theforeman/foreman#10351
SAT-28832 (private)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

  • I couldn't find any better place.
  • I think a formal Note is in order to emphasize this info but feel free to disagree.

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into: N/A

@github-actions
Copy link

github-actions bot commented Jan 7, 2025

@Lennonka Lennonka changed the title Add note about resources searchable by name Add note about resources searchable by title Jan 8, 2025
@Lennonka Lennonka added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Jan 8, 2025
@amolpati30
Copy link

@Lennonka
I have tested using the following URL fragment, and host registration works as expected:
hostgroup=test1%2Ftest2
location=Default%20Location
operatingsystem=RHEL%209.5
organization=Default%20Organization

@amolpati30
Copy link

We can also register a host using the following parameters. Do you think this should be added to the documentation?
location=Default+Location
operatingsystem=RHEL+9.5
organization=Default+Organization

@maximiliankolb
Copy link
Contributor

what's the use case to edit this by hand? Why make users change the way Foreman/Katello searches for resources?
Is the alternative an API endpoint that accepts org/loc/os/host group/ak and returns the registration command?

@Lennonka
Copy link
Contributor Author

Lennonka commented Jan 9, 2025

what's the use case to edit this by hand? Why make users change the way Foreman/Katello searches for resources? Is the alternative an API endpoint that accepts org/loc/os/host group/ak and returns the registration command?

@stejskalleos Can you please clarify this?

@stejskalleos
Copy link
Contributor

what's the use case to edit this by hand?

It was a feature request by one of the Foreman users.

@Lennonka
Copy link
Contributor Author

@stejskalleos @amolpati30 Ack?

@Lennonka
Copy link
Contributor Author

@maximiliankolb The use case is that one user generates a registration command, edits it and forwards it to other users who run it on hosts, for example, in various locations.
We do not force them to use this feature, we're just giving them the option to use it.

@amolpati30
Copy link

Ack from QE 👍

Copy link
Contributor

@stejskalleos stejskalleos left a comment

Choose a reason for hiding this comment

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

🍏

@Lennonka Lennonka added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Jan 15, 2025
Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

ACK; works for me. I was just curious to why users would want this.

@maximiliankolb maximiliankolb added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Jan 16, 2025
@Lennonka Lennonka merged commit d263b95 into theforeman:master Jan 17, 2025
9 checks passed
@Lennonka Lennonka deleted the search-by-name-regparams branch January 17, 2025 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants