tao12345666333 commented on code in PR #1018: URL: https://github.com/apache/apisix-ingress-controller/pull/1018#discussion_r876794421
########## docs/en/latest/practices/enable-authentication-and-restriction.md: ########## @@ -29,34 +29,126 @@ Consumers are used for the authentication method controlled by Apache APISIX, if ### Authentication -#### [`keyAuth`](https://apisix.apache.org/docs/apisix/plugins/key-auth/) +#### Key Auth -Consumers add their key either in a header `apikey` to authenticate their requests. +Consumers add their key either in a header or query string parameter to authenticate their requests. For more information about `Key Auth`, please refer to [APISIX key-auth](https://apisix.apache.org/docs/apisix/plugins/key-auth/). Review Comment: ```suggestion Consumers add their key either in a header or query string parameter to authenticate their requests. For more information about `Key Auth`, please refer to [APISIX key-auth plugin](https://apisix.apache.org/docs/apisix/plugins/key-auth/). ``` ########## docs/en/latest/practices/enable-authentication-and-restriction.md: ########## @@ -29,34 +29,126 @@ Consumers are used for the authentication method controlled by Apache APISIX, if ### Authentication -#### [`keyAuth`](https://apisix.apache.org/docs/apisix/plugins/key-auth/) +#### Key Auth -Consumers add their key either in a header `apikey` to authenticate their requests. +Consumers add their key either in a header or query string parameter to authenticate their requests. For more information about `Key Auth`, please refer to [APISIX key-auth](https://apisix.apache.org/docs/apisix/plugins/key-auth/). +Also, we can using the `secretRef` field to reference a K8s Secret object so that we can avoid the hardcoded sensitive data in the ApisixConsumer object. For reference Secret use example, please refer to the [key-auth-reference-secret-object](#key-auth-reference-secret-object). + +<details> + <summary>Key Auth yaml configure</summary> ```yaml -keyAuth: - value: - key: ${key} +apiVersion: apisix.apache.org/v2beta3 +kind: ApisixConsumer +metadata: + name: ${name} +spec: + authParameter: + keyAuth: + value: + key: ${key} #required ``` -#### [`basicAuth`](https://apisix.apache.org/docs/apisix/plugins/basic-auth/) +</details> + +#### Basic Auth -Consumers add their key either in a header `Authentication` to authenticate their requests. +Consumers add their key in a header to authenticate their requests. For more information about `Basic Auth`, please refer to [APISIX basic-auth](https://apisix.apache.org/docs/apisix/plugins/basic-auth/). Review Comment: ```suggestion Consumers add their key in a header to authenticate their requests. For more information about `Basic Auth`, please refer to [APISIX basic-auth plugin](https://apisix.apache.org/docs/apisix/plugins/basic-auth/). ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
