[services] Let users set the port for process-compose #2299
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mikeland73
approved these changes
Sep 25, 2024
internal/services/manager.go
Outdated
| BinPath string | ||
| ExtraFlags []string | ||
| Background bool | ||
| PCPort int |
internal/services/ports.go
Outdated
| return configPort, nil | ||
| } | ||
|
|
||
| if portStr, exists := os.LookupEnv("PC_PORT_NUM"); exists { |
There was a problem hiding this comment.
Thoughts on naming this DEVBOX_PC_PORT_NUM
Reasons:
- If user sets
PC_PORT_NUMoutside of devbox, it's going to make starting devbox services on multiple projects fail. Since this is the env name set by process compose itself, it's not unreasonable that people will set it. - Keeping track of env variables is easier if we prefix them
- Avoids collisions
internal/services/ports.go
Outdated
| return port > 1024 && disallowedPorts[port] == "" | ||
| } | ||
|
|
||
| func isPortAvailable(port int) bool { |
There was a problem hiding this comment.
Make getAvailablePort call this.
internal/services/ports.go
Outdated
| if port <= 0 { | ||
| return 0, fmt.Errorf("invalid PC_PORT_NUM environment variable: ports cannot be less than 0") | ||
| } | ||
| return port, nil |
There was a problem hiding this comment.
return port, isPortAvailable(port) so you don't have to call it outside.
internal/services/manager.go
Outdated
Comment on lines
137
to
138
| if !isPortAvailable(port) { | ||
| return fmt.Errorf("port %d is already in use", port) |
There was a problem hiding this comment.
remove, call inside selectPort
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Users can set the port that process-compose runs on when they use
devbox services. If they do not specify a port, we default to randomly picking an open port with low risk of conflictUsers can specify their process-compose port by:
--pcport, -pflag when runningdevbox services up.PC_PORT_NUMenvironment variable. This variable can be set in the projectsdevbox.jsonif you want to always use the same port for process-compose. This is overridden by the--pcportflag.How was it tested?
In the MySQL example:
devbox services up -b -p 8080, orPC_PORT_NUM devbox services up -b,I can verify that process-compose is running on my 8080 with
curl localhost:8080/processesand seeing the list of expected processes.