Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about resources searchable by title #3552

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

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

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants