docs: Added default listening port intent #11530
Open
Conversation
This file contains 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
dosubot
bot
added
size:S
kayx23
reviewed
Aug 28, 2024
| |9180|Admin API| | ||
| |9091|Prometheus metrics export| | ||
| |9100|TCP traffic| | ||
| |9200|UDP traffic| |
There was a problem hiding this comment.
The quickstart script opens these ports by default:
-p9080:9080 -p9180:9180 -p9443:9443/tcp -p9443:9443/udp -p9090:9092 -p9100:9100 -p9091:9091
9200 is not open for UDP.
There was a problem hiding this comment.
I changed this commit.
30bfa97
5 tasks
Found that the port was already mentioned in the existing documentation.
dosubot
bot
added
size:XS
kayx23
reviewed
Aug 29, 2024
| @@ -37,6 +37,10 @@ curl -sL https://run.api7.ai/apisix/quickstart | sh | |||
|
|
|||
| The script should start two Docker containers, _apisix-quickstart_ and _etcd_. APISIX uses etcd to save and synchronize configurations. Both the etcd and the APISIX use [**host**](https://docs.docker.com/network/host/) Docker network mode. That is, the APISIX can be accessed from local. | |||
|
|
|||
| You can see that a number of ports are listened to by default, and the purpose of these default ports can be referenced: | |||
| [Port Reference](https://docs.api7.ai/apisix/networking/port-reference) | |||
There was a problem hiding this comment.
This doc is only accurate if you install APISIX directly on host. The container started by the script only maps a few ports (details mentioned in the comment above). The mapping to host isn't exactly the same as the original (e.g. -p9090:9092) though I can't remember why.
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.
Description
Fixes # (issue)
Checklist