Skip to content

Commit

Permalink
Signed-off-by: sarthaksarthak9 <[email protected]> (#3024)
Browse files Browse the repository at this point in the history
update developer guide (added debugging if port 6443 error occurs)
  • Loading branch information
sarthaksarthak9 authored Dec 4, 2023
1 parent de0bef6 commit 436cdeb
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,34 @@ It has the following options to customize further steps:

`mage localdev minimal-pulsar` is what is used to test the CI pipeline, and is the recommended way to test changes to the core components of Armada.

## Debug error saying that the (port 6443 is already in use) after running mage localdev full

## Identifying the Conflict

Before making any changes, it's essential to identify which port is causing the conflict. Port 6443 is a common source of conflicts. You can check for existing bindings to this port using commands like `netstat` or `lsof`.

1. The `kind.yaml` file is where you define the configuration for your Kind clusters. To resolve port conflicts:

* Open your [kind.yaml](https://github.com/armadaproject/armada/blob/master/e2e/setup/kind.yaml) file.

2. Locate the relevant section where the `hostPort` is set. It may look something like this:


```
- containerPort: 6443 # control plane
hostPort: 6443 # exposes control plane on localhost:6443
protocol: TCP
```

* Modify the hostPort value to a port that is not in use on your system. For example:

```
- containerPort: 6443 # control plane
hostPort: 6444 # exposes control plane on localhost:6444
protocol: TCP
```
You are not limited to using port 6444; you can choose any available port that doesn't conflict with other services on your system. Select a port that suits your system configuration.

### Testing if LocalDev is working

Running `mage testsuite` will run the full test suite against the localdev cluster. This is the recommended way to test changes to the core components of Armada.
Expand Down

0 comments on commit 436cdeb

Please sign in to comment.