8000 address more feedback · nginx/kubernetes-ingress@2a1009a · GitHub
[go: up one dir, main page]

Skip to content

Commit 2a1009a

Browse files
committed
address more feedback
1 parent a01acf5 commit 2a1009a

File tree

2 files changed

+17
-17
lines changed
  • examples/custom-resources

2 files changed

+17
-17
lines changed

examples/custom-resources/rate-limit-tiered-apikey/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ limit Policies, grouped in a tier, using the API Key client name as the key to t
1515
IC_IP=XXX.YYY.ZZZ.III
1616
```
1717
<!-- markdownlint-disable MD029 -->
18-
3. Save the HTTP port of the Ingress Controller into a shell variable:
18+
3. Save the HTTP port of NGINX Ingress Controller into a shell variable:
1919
<!-- markdownlint-enable MD029 -->
2020
```shell
2121
IC_HTTP_PORT=<port number>
@@ -29,34 +29,34 @@ Create the application deployments and services:
2929
kubectl apply -f coffee.yaml
3030
```
3131

32-
## Deploy the Rate Limit Policies
32+
## Deploy the rate limit Policies
3333

3434
In this step, we create three Policies:
3535

36-
- one with the name `api-key-policy` which defines the API Key Policy
37-
- one with the name `rate-limit-apikey-premium`, that allows 5 requests per second coming from a request containing an API Key with a client name that ends with `premium`
38-
- one with the name `rate-limit-apikey-basic` that allows 1 request per second coming from a request containing an API Key with a client name that ends with `basic`
36+
- `api-key-policy` which defines the API Key Policy
37+
- `rate-limit-apikey-premium`, that allows 5 requests per second coming from a request containing an API Key with a client name that ends with `premium`
38+
- `rate-limit-apikey-basic` that allows 1 request per second coming from a request containing an API Key with a client name that ends with `basic`
3939

4040
The `rate-limit-apikey-basic` Policy is also the default policy if the API Key client name does not match a tier.
4141

42-
Create the policies:
42+
Create the Policies:
4343

4444
```shell
4545
kubectl apply -f api-key-policy.yaml
4646
kubectl apply -f rate-limits.yaml
4747
```
4848

49-
## Deploy the API Key Secret
49+
## Deploy the API key authentication Secret
5050

51-
Create a secret of type `nginx.org/apikey` with the name `api-key-client-secret` that will be used for authorization on the server level.
51+
Create a Secret of type `nginx.org/apikey` with the name `api-key-client-secret` that will be used for authorization on the server level.
5252

53-
This secret will contain a mapping of client names to base64 encoded API Keys.
53+
This Secret will contain a mapping of client names to base64 encoded API Keys.
5454

5555
```shell
5656
kubectl apply -f api-key-secret.yaml
5757
```
5858

59-
## Configure Load Balancing
59+
## Configure load balancing
6060

6161
Create a VirtualServer resource for the web application:
6262

examples/custom-resources/rate-limit-tiered-request-method/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ limit Policies, grouped in a tier, using the client IP address as the key to the
1313
IC_IP=XXX.YYY.ZZZ.III
1414
```
1515
<!-- markdownlint-disable MD029 -->
16-
3. Save the HTTP port of the Ingress Controller into a shell variable:
16+
3. Save the HTTP port of NGINX Ingress Controller into a shell variable:
1717
<!-- markdownlint-enable MD029 -->
1818
```shell
1919
IC_HTTP_PORT=<port number>
@@ -27,22 +27,22 @@ Create the application deployments and services:
2727
kubectl apply -f coffee.yaml
2828
```
2929

30-
## Deploy the Rate Limit Policies
30+
## Deploy the rate limit Policies
3131

3232
In this step, we create two Policies:
3333

34-
- one with the name `rate-limit-request-method-get-head`, that allows 5 requests per second coming from a request containing the `GET` or `HEAD` request methods.
35-
- one with the name `rate-limit-request-method-put-post-patch-delete` that allows 1 request per second coming from a request containing the `POST`, `PUT`, `PATCH` or `DELETE` request methods.
34+
- `rate-limit-request-method-get-head`, that allows 5 requests per second coming from a request containing the `GET` or `HEAD` request methods.
35+
- `rate-limit-request-method-put-post-patch-delete` that allows 1 request per second coming from a request containing the `POST`, `PUT`, `PATCH` or `DELETE` request methods.
3636

37-
The `rate-limit-request-method-put-post-patch-delete` Policy is also the default policy if the request method does not match a tier.
37+
The `rate-limit-request-method-put-post-patch-delete` Policy is also the default Policy if the request method does not match a tier.
3838

39-
Create the policies:
39+
Create the Policies:
4040

4141
```shell
4242
kubectl apply -f rate-limits.yaml
4343
```
4444

45-
## Configure Load Balancing
45+
## Configure load balancing
4646

4747
Create a VirtualServer resource for the web application:
4848

0 commit comments

Comments
 (0)
0