Skip to content

fix: improve init error message for port usage #1582

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.

Sign up for GitHub

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

Open
vvaswani wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: improve init error message for port usage #1582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions pkg/standalone/standalone.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,28 @@ const (
schedulerEtcdPort = 2379

daprVersionsWithScheduler = ">= 1.14.x"

portInUseHint = "Stop the process/container using that port or use `dapr init --network <name>` to avoid host port mapping."
)

var (
defaultImageRegistryName string
isAirGapInit bool
)

func ensureHostPortsAvailable(component string, ports []int, extraHint string) error {
for _, port := range ports {
if err := utils.CheckIfPortAvailable(port); err != nil {
message := fmt.Sprintf("cannot start %s because host port %d is already in use", component, port)
if extraHint != "" {
message = fmt.Sprintf("%s. %s", message, extraHint)
}
return errors.New(message)
}
}
return nil
}

type configuration struct {
APIVersion string `yaml:"apiVersion"`
Kind string `yaml:"kind"`
Expand Down Expand Up @@ -387,6 +402,14 @@ func runZipkin(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
// do not create container again if it exists.
args = append(args, "start", zipkinContainerName)
} else {
if info.dockerNetwork == "" {
err = ensureHostPortsAvailable("Zipkin tracing", []int{9411}, portInUseHint+" To skip Zipkin, use `dapr init --slim`.")
if err != nil {
errorChan <- err
return
}
}

imageName, err = resolveImageURI(daprImageInfo{
ghcrImageName: zipkinGhcrImageName,
dockerHubImageName: zipkinDockerImageName,
Expand Down Expand Up @@ -453,6 +476,14 @@ func runRedis(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
// do not create container again if it exists.
args = append(args, "start", redisContainerName)
} else {
if info.dockerNetwork == "" {
err = ensureHostPortsAvailable("Redis state store", []int{6379}, portInUseHint+" To skip Redis, use `dapr init --slim`.")
if err != nil {
errorChan <- err
return
}
}

imageName, err = resolveImageURI(daprImageInfo{
ghcrImageName: redisGhcrImageName,
dockerHubImageName: redisDockerImageName,
Expand Down Expand Up @@ -515,6 +546,18 @@ func runPlacementService(wg *sync.WaitGroup, errorChan chan<- error, info initIn
errorChan <- fmt.Errorf("%s container exists or is running. %s", placementContainerName, errInstallTemplate)
return
}

if info.dockerNetwork == "" {
osPort := 50005
if runtime.GOOS == daprWindowsOS {
osPort = 6050
}
err = ensureHostPortsAvailable("placement service", []int{osPort, healthPort, metricPort}, portInUseHint)
if err != nil {
errorChan <- err
return
}
}
var image string

imgInfo := daprImageInfo{
Expand Down Expand Up @@ -610,6 +653,18 @@ func runSchedulerService(wg *sync.WaitGroup, errorChan chan<- error, info initIn
errorChan <- fmt.Errorf("%s container exists or is running. %s", schedulerContainerName, errInstallTemplate)
return
}

if info.dockerNetwork == "" {
osPort := 50006
if runtime.GOOS == daprWindowsOS {
osPort = 6060
}
err = ensureHostPortsAvailable("scheduler service", []int{osPort, schedulerEtcdPort, schedulerHealthPort, schedulerMetricPort}, portInUseHint)
if err != nil {
errorChan <- err
return
}
}
var image string

imgInfo := daprImageInfo{
Expand Down