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

Refs #29830 - Move discovery plugin docs to RDOC and split out advanced parameters #626

Merged
merged 1 commit into from
Oct 15, 2020

Conversation

ehelms
Copy link
Member

@ehelms ehelms commented Oct 12, 2020

No description provided.

Copy link
Contributor

@wbclark wbclark left a comment

Choose a reason for hiding this comment

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

I think that as long as we are making these changes, we could improve the documentation of these parameters a bit.

manifests/plugin/discovery.pp Outdated Show resolved Hide resolved
manifests/plugin/discovery.pp Outdated Show resolved Hide resolved
#
# $tftp_root:: tftp root to install image into
#
# $source_url:: source URL to download from
Copy link
Contributor

Choose a reason for hiding this comment

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

Outside the scope of this PR, but:

I'd argue that this should in fact refer to the full URL of the file. I don't see the use case for having 2 separate parameters and simply concatenating them. It maybe makes our job a little easier as we refer to the $image_name separately for example at

} ~> exec { "untar ${image_name}":
but it would be better for the user to have $source_url and $image_name combined to a single parameter I think.

Copy link
Member

Choose a reason for hiding this comment

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

I disagree. For example, you mirror it somewhere and only change the base URL while still using the same imagine name as upstream. Another example could be branding where you change the source URL to your company name. It also makes the code a lot harder because now you need to split some URL. That's always painful and a good source of bugs. Given these are advanced parameters, I wouldn't change this.

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

@ekohl ekohl changed the title Move discovery plugin docs to RDOC and split out advanced parameters Refs #29830 - Move discovery plugin docs to RDOC and split out advanced parameters Oct 15, 2020
@ekohl ekohl merged commit 9501f8b into theforeman:master Oct 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants