You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "geekgao (via GitHub)" <gi...@apache.org> on 2024/08/27 04:05:46 UTC

[PR] docs: Added default listening port intent [apisix]

geekgao opened a new pull request, #11530:
URL: https://github.com/apache/apisix/pull/11530

   ### Description
   
   <!-- Please include a summary of the change and which issue is fixed. -->
   <!-- Please also include relevant motivation and context. -->
   
   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](https://github.com/apache/apisix/tree/master#community) first)
   
   <!--
   
   Note
   
   1. Mark the PR as draft until it's ready to be reviewed.
   2. Always add/update tests for any changes unless you have a good reason.
   3. Always update the documentation to reflect the changes made in the PR.
   4. Make a new commit to resolve conversations instead of `push -f`.
   5. To resolve merge conflicts, merge master instead of rebasing.
   6. Use "request review" to notify the reviewer after making changes.
   7. Only a reviewer can mark a conversation as resolved.
   
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on code in PR #11530:
URL: https://github.com/apache/apisix/pull/11530#discussion_r1734615272


##########
docs/en/latest/getting-started/README.md:
##########
@@ -37,6 +37,17 @@ 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.
 
+This table contains the main APISIX default ports and their uses. Each row clearly lists the port number and its corresponding function.
+|**PORT**|**Purpose**|
+| ----- | ----- |
+|9080|HTTP Request|
+|9443|HTTPS Request|
+|9180|Admin API|
+|9091|Prometheus metrics export|
+|9100|TCP traffic|
+|9200|UDP traffic|

Review 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.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "geekgao (via GitHub)" <gi...@apache.org>.
geekgao commented on code in PR #11530:
URL: https://github.com/apache/apisix/pull/11530#discussion_r1735921962


##########
docs/en/latest/getting-started/README.md:
##########
@@ -37,6 +37,17 @@ 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.
 
+This table contains the main APISIX default ports and their uses. Each row clearly lists the port number and its corresponding function.
+|**PORT**|**Purpose**|
+| ----- | ----- |
+|9080|HTTP Request|
+|9443|HTTPS Request|
+|9180|Admin API|
+|9091|Prometheus metrics export|
+|9100|TCP traffic|
+|9200|UDP traffic|

Review Comment:
   I changed this commit.
   https://github.com/apache/apisix/pull/11530/commits/30bfa97d77cbe1bca0fb023eee423672147a36bc



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on code in PR #11530:
URL: https://github.com/apache/apisix/pull/11530#discussion_r1735999366


##########
docs/en/latest/getting-started/README.md:
##########
@@ -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) 

Review 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.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #11530: docs: Added default listening port intent
URL: https://github.com/apache/apisix/pull/11530


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #11530:
URL: https://github.com/apache/apisix/pull/11530#issuecomment-2453368365

   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 dev@apisix.apache.org list. Thank you for your contributions.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "geekgao (via GitHub)" <gi...@apache.org>.
geekgao commented on code in PR #11530:
URL: https://github.com/apache/apisix/pull/11530#discussion_r1735921962


##########
docs/en/latest/getting-started/README.md:
##########
@@ -37,6 +37,17 @@ 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.
 
+This table contains the main APISIX default ports and their uses. Each row clearly lists the port number and its corresponding function.
+|**PORT**|**Purpose**|
+| ----- | ----- |
+|9080|HTTP Request|
+|9443|HTTPS Request|
+|9180|Admin API|
+|9091|Prometheus metrics export|
+|9100|TCP traffic|
+|9200|UDP traffic|

Review Comment:
   I changed this commit.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on code in PR #11530:
URL: https://github.com/apache/apisix/pull/11530#discussion_r1735999366


##########
docs/en/latest/getting-started/README.md:
##########
@@ -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) 

Review 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).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: Added default listening port intent [apisix]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #11530:
URL: https://github.com/apache/apisix/pull/11530#issuecomment-2565271216

   This pull request/issue has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org