Skip to content
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.

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

docs: Added default listening port intent #11530

Open
wants to merge 2 commits into
base: release/3.10
Choose a base branch
from

Conversation

geekgao
Copy link

@geekgao geekgao commented Aug 27, 2024

Description

Fixes # (issue)

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. doc Documentation things labels Aug 27, 2024
|9180|Admin API|
|9091|Prometheus metrics export|
|9100|TCP traffic|
|9200|UDP traffic|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

@geekgao geekgao Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed this commit.
30bfa97

Found that the port was already mentioned in the existing documentation.
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels 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)
Copy link
Member

@kayx23 kayx23 Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@kayx23 kayx23 added the wait for update wait for the author's response in this issue/PR label Sep 4, 2024
Copy link

github-actions bot commented Nov 3, 2024

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the [email protected] list. Thank you for your contributions.

@github-actions github-actions bot added the stale label Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things size:XS This PR changes 0-9 lines, ignoring generated files. stale wait for update wait for the author's response in this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants