You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/11/01 13:20:21 UTC
[GitHub] [apisix] hf400159 opened a new pull request, #8227: docs: update admin api English doc
hf400159 opened a new pull request, #8227:
URL: https://github.com/apache/apisix/pull/8227
### 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
[GitHub] [apisix] SylviaBABY merged pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
SylviaBABY merged PR #8227:
URL: https://github.com/apache/apisix/pull/8227
--
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
[GitHub] [apisix] hf400159 commented on a diff in pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #8227:
URL: https://github.com/apache/apisix/pull/8227#discussion_r1035446698
##########
docs/en/latest/admin-api.md:
##########
@@ -1349,3 +1349,65 @@ Stream Route resource request address: /apisix/admin/stream_routes/{id}
| protocol.conf | False | Configuration | Protocol-specific configuration. | |
To learn more about filtering in stream proxies, check [this](./stream-proxy.md#more-route-match-options) document.
+
+## kms
+
+kms means `Secrets Management`, which could use any secret manager supported, e.g. `vault`.
+
+### kms API
+
+kms resource request address:: /apisix/admin/kms/{secretmanager}/{id}
Review Comment:
Let's not modify it now, let us modify it together in the next version.
--
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
[GitHub] [apisix] juzhiyuan commented on pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on PR #8227:
URL: https://github.com/apache/apisix/pull/8227#issuecomment-1328774355
@hf400159 also this one
--
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
[GitHub] [apisix] hf400159 commented on pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
hf400159 commented on PR #8227:
URL: https://github.com/apache/apisix/pull/8227#issuecomment-1330187204
> @hf400159 also this one
@juzhiyuan fixed
--
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
[GitHub] [apisix] juzhiyuan commented on a diff in pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #8227:
URL: https://github.com/apache/apisix/pull/8227#discussion_r1034386568
##########
docs/en/latest/admin-api.md:
##########
@@ -21,13 +29,41 @@ title: Admin API
#
-->
+## Description
+
The Admin API lets users control their deployed Apache APISIX instance. The [architecture design](./architecture-design/apisix.md) gives an idea about how everything fits together.
-By default, the Admin API listens to port `9180` when APISIX is launched. This can be changed by modifying your configuration file ([conf/config.yaml](https://github.com/apache/apisix/blob/master/conf/config.yaml)).
+## Configuration
+
+When APISIX is started, the Admin API will listen on port `9180` by default and take the API prefixed with `/apisix/admin`.
+
+Therefore, to avoid conflicts between your designed API and `/apisix/admin`, you can modify the configuration file [`/conf/config.yaml`](https://github.com/apache/apisix/blob/master/ conf/config.yaml) to modify the default listening port.
+
+APISIX supports setting the IP access allowlist of Admin API to prevent APISIX from being illegally accessed and attacked. You can configure the IP addresses to allow access in the `deployment.admin.allow_admin` option in the `./conf/config.yaml` file.
+
+The `X-API-KEY` shown below refers to the `deployment.admin.admin_key.key` in the `./conf/config.yaml` file, which is the access token for the Admin API.
+
+:::tip
-**Note**: Mentions of `X-API-KEY` in this document refers to `deployment.admin.admin_key.key`—the access token for Admin API—in your configuration file.
+It is recommended that you modify the default listening port, IP access allowlist and Admin API token of the Admin API to ensure the security of your API.
Review Comment:
```suggestion
For security reasons, please modify the default `admin_key`, and check the `allow_admin` IP access list.
```
##########
docs/en/latest/admin-api.md:
##########
@@ -21,13 +29,41 @@ title: Admin API
#
-->
+## Description
+
The Admin API lets users control their deployed Apache APISIX instance. The [architecture design](./architecture-design/apisix.md) gives an idea about how everything fits together.
-By default, the Admin API listens to port `9180` when APISIX is launched. This can be changed by modifying your configuration file ([conf/config.yaml](https://github.com/apache/apisix/blob/master/conf/config.yaml)).
+## Configuration
+
+When APISIX is started, the Admin API will listen on port `9180` by default and take the API prefixed with `/apisix/admin`.
+
+Therefore, to avoid conflicts between your designed API and `/apisix/admin`, you can modify the configuration file [`/conf/config.yaml`](https://github.com/apache/apisix/blob/master/ conf/config.yaml) to modify the default listening port.
Review Comment:
```suggestion
Therefore, to avoid conflicts between your designed API and `/apisix/admin`, you can modify the configuration file [`/conf/config.yaml`](https://github.com/apache/apisix/blob/master/conf/config.yaml) to modify the default listening port.
```
--
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
[GitHub] [apisix] hf400159 commented on pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
hf400159 commented on PR #8227:
URL: https://github.com/apache/apisix/pull/8227#issuecomment-1330256677
> The Admin API page is too long to read and use 🤣🤣 I suggest separating it into smaller parts in the future.
I will divide the Admin API documentation into several small parts in the next version of the documentation.
--
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
[GitHub] [apisix] juzhiyuan commented on a diff in pull request #8227: docs: update admin api English doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #8227:
URL: https://github.com/apache/apisix/pull/8227#discussion_r1035432430
##########
docs/en/latest/admin-api.md:
##########
@@ -1349,3 +1349,65 @@ Stream Route resource request address: /apisix/admin/stream_routes/{id}
| protocol.conf | False | Configuration | Protocol-specific configuration. | |
To learn more about filtering in stream proxies, check [this](./stream-proxy.md#more-route-match-options) document.
+
+## kms
+
+kms means `Secrets Management`, which could use any secret manager supported, e.g. `vault`.
+
+### kms API
+
+kms resource request address:: /apisix/admin/kms/{secretmanager}/{id}
Review Comment:
```suggestion
kms resource request address: /apisix/admin/kms/{secretmanager}/{id}
```
##########
docs/en/latest/admin-api.md:
##########
@@ -1349,3 +1349,65 @@ Stream Route resource request address: /apisix/admin/stream_routes/{id}
| protocol.conf | False | Configuration | Protocol-specific configuration. | |
To learn more about filtering in stream proxies, check [this](./stream-proxy.md#more-route-match-options) document.
+
+## kms
+
+kms means `Secrets Management`, which could use any secret manager supported, e.g. `vault`.
+
+### kms API
+
+kms resource request address:: /apisix/admin/kms/{secretmanager}/{id}
Review Comment:
Also, should we add a ``` around API?
--
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