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

Many parameters under Server are missing components #1803

Open
jhiemstrawisc opened this issue Dec 6, 2024 · 1 comment
Open

Many parameters under Server are missing components #1803

jhiemstrawisc opened this issue Dec 6, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jhiemstrawisc
Copy link
Member

I noticed this while writing the issue for #1802 -- many of the Server.XYZ config params are missing at least one server component. For example:

name: Server.ExternalWebUrl
description: |+
  A URL indicating the Pelican web interface and internal web APIs address as it appears externally.

  Port number will be stripped if it's 443, from `Server.WebPort` or directly set through `Server.ExternalWebUrl`.
type: url
default: https://${Server.Hostname}:${Server.WebPort} (for ${Server.WebPort} != 443)
components: ["origin", "director", "registry"]

Caches also have a WebUI affected by this, but the cache as not listed as a component.

If there are Server.XYZ config params that really don't apply to one of our server components, we might need to think about this naming convention.

@jhiemstrawisc jhiemstrawisc added the documentation Improvements or additions to documentation label Dec 6, 2024
@jhiemstrawisc jhiemstrawisc added this to the v7.13.0 milestone Dec 6, 2024
@jhiemstrawisc
Copy link
Member Author

Another note -- we should mark Server.Modules as hidden because the CLI tool it mentions (pelican serve) is also hidden. It also doesn't affect all components, so that should be corrected for our internal docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants