-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Replace ComputeExternalAddress by param Server.ExternalWebUrl and rename Server.Port and Server.Address #378
Replace ComputeExternalAddress by param Server.ExternalWebUrl and rename Server.Port and Server.Address #378
Conversation
bec35f4
to
0be7d1b
Compare
@haoming29 Do we want to clarify |
That's even more interesting because I thought I think the reason why changing I would suggest that I will clarify the intent for |
Then we should probably add something for the weburl? Which needs to be different than |
@turetske I've added clarification to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Closes #372
The
ComputeExternalAddress()
seems to be less useful if we simply assignedServer.Hostname
+Server.Port
as the default return value of the function, so I replace the function by directly setting the default value ofServer.ExternalAddress
, and, of course, maintaining the url type.Later while I making the changes to the codebase, I figured that those three config names (
Server.Port
,Server.Address
,Server.ExternalAddress
) are very broad and can cause confusion when people try to use them. So I decided to rename them to better reflect what they meant:Server.Port
->Server.WebPort
: In our codebase,Server.Port
is used to setup web engine and serves as the port for various web related services (Prometheus, IssuerURL, etc). So I figured it's better to call itServer.WebPort
to be dinstinct withXrootD.Port
Server.Address
->Server.WebHost
:Server.Address
is only used when we setup web engine so it's better call itWebHost
Server.ExternalAddress
->Server.ExternalWebUrl
: per description, this value is an URL that can represent the server's web service for external users, so it makes sense to name it as what it's intended to do.This is a potential breaking change, but given the fact that we haven't started distributing our server instances, it shouldn't hurt too much if we put it in the release note.
Testing Instructions
Run your servers and go to
origin
and the web ui can load as expected. Note your console output for all the servers and there shouldn't be any errors. Now change theServer.ExternalAddress
tohttps://${Server.Hostname}:${Server.Port}
where the ${} is the value of the config names, and re-run all servers and they should still work as expected.