Skip to content

Commit 078d39c

Browse files
mohamadaldawamnahmohamadaldawamnah
committed
addressing comment
1 parent fa5963d commit 078d39c

12 files changed

+158
-159
lines changed

‎config/crd/bases/k8s.nginx.org_globalconfigurations.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ spec:
3939
metadata:
4040
type: object
4141
spec:
42-
description: GlobalConfigurationSpec is the spec of the GlobalConfiguration
43-
resource.
42+
description: The GlobalConfigurationSpec resource defines the global configuration
43+
parameters of the Ingress Controller.
4444
properties:
4545
listeners:
4646
description: Listeners field of the GlobalConfigurationSpec resource
@@ -51,7 +51,7 @@ spec:
5151
description: Specifies the IPv4 address to listen on.
5252
type: string
5353
ipv6:
54-
description: ipv6 addresses that NGINX will listen on.
54+
description: ipv6 addresse that NGINX will listen on.
5555
type: string
5656
name:
5757
description: The name of the listener. The name must be unique

‎config/crd/bases/k8s.nginx.org_policies.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ spec:
353353
description: |-
354354
The key to which the rate limit is applied. Can contain text, variables, or a combination of them.
355355
Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are
356-
$binary_remote_addr , $request_uri , $request_method , $url , $http_ , $args , $arg_, $cookie_ ,$jwt_claim_ .
356+
$binary_remote_addr, $request_uri, $request_method, $url, $http_, $args, $arg_, $cookie_,$jwt_claim_ .
357357
type: string
358358
logLevel:
359359
description: Sets the desired logging level for cases when the
@@ -450,7 +450,7 @@ spec:
450450
type: object
451451
type: object
452452
status:
453-
description: status field of the Policy resource
453+
description: the status of the Policy resource
454454
properties:
455455
message:
456456
description: The message of the current state of the resource. It

‎config/crd/bases/k8s.nginx.org_transportservers.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ spec:
110110
type: string
111111
type: object
112112
upstreamParameters:
113-
description: The UpstreamParameters are set on stream context
113+
description: UpstreamParameters defines parameters for an upstream.
114114
properties:
115115
connectTimeout:
116116
description: The timeout for establishing a connection with a
@@ -148,7 +148,7 @@ spec:
148148
backup:
149149
description: 'The name of the backup service of type ExternalName.
150150
This will be used when the primary servers are unavailable.
151-
Note: The parameter cannot be used along with the random ,
151+
Note: The parameter cannot be used along with the random,
152152
hash or ip_hash load balancing methods.'
153153
type: string
154154
backupPort:
@@ -256,7 +256,7 @@ spec:
256256
type: array
257257
type: object
258258
status:
259-
description: status field of the TransportServer resource
259+
description: The status of the TransportServer resource
260260
properties:
261261
message:
262262
description: The message of the current state of the resource. It
@@ -266,10 +266,10 @@ spec:
266266
description: The reason of the current state of the resource.
267267
type: string
268268
state:
269-
description: 'Represents the current state of the resource. There
270-
are three possible values: Valid, Invalid and Warning. Valid indicates
271-
that the resource has been validated and accepted by the Ingress
272-
Controller. Invalid means the resource failed validation or'
269+
description: 'Represents the current state of the resource. Possible
270+
values: Valid (resource validated and accepted), Invalid (validation
271+
failed or config reload failed), or Warning (validated but may work
272+
in degraded state).'
273273
type: string
274274
type: object
275275
type: object

‎config/crd/bases/k8s.nginx.org_virtualserverroutes.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -660,9 +660,9 @@ spec:
660660
an optional namespace.
661661
properties:
662662
name:
663-
description: "The name of a policy. If the policy doesn’t
663+
description: The name of a policy. If the policy doesn’t
664664
exist or invalid, NGINX will respond with an error response
665-
with the 500 status code.\tv"
665+
with the 500 status code.
666666
type: string
667667
namespace:
668668
description: The namespace of a policy. If not specified,
@@ -1095,7 +1095,7 @@ spec:
10951095
exist, NGINX will assume the service has zero endpoints and
10961096
return a 502 response for requests for this upstream. For
10971097
NGINX Plus only, services of type ExternalName are also supported
1098-
(check the prerequisites ).
1098+
.
10991099
type: string
11001100
sessionCookie:
11011101
description: The SessionCookie field configures session persistence
@@ -1113,7 +1113,7 @@ spec:
11131113
type: boolean
11141114
expires:
11151115
description: The time for which a browser should keep the
1116-
cookie. Can be set to the special value max , which will
1116+
cookie. Can be set to the special value max, which will
11171117
cause the cookie to expire on 31 Dec 2037 23:55:55 GMT.
11181118
type: string
11191119
httpOnly:

‎config/crd/bases/k8s.nginx.org_virtualservers.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ spec:
153153
optional namespace.
154154
properties:
155155
name:
156-
description: "The name of a policy. If the policy doesn’t exist
156+
description: The name of a policy. If the policy doesn’t exist
157157
or invalid, NGINX will respond with an error response with
158-
the 500 status code.\tv"
158+
the 500 status code.
159159
type: string
160160
namespace:
161161
description: The namespace of a policy. If not specified, the
@@ -747,9 +747,9 @@ spec:
747747
an optional namespace.
748748
properties:
749749
name:
750-
description: "The name of a policy. If the policy doesn’t
750+
description: The name of a policy. If the policy doesn’t
751751
exist or invalid, NGINX will respond with an error response
752-
with the 500 status code.\tv"
752+
with the 500 status code.
753753
type: string
754754
namespace:
755755
description: The namespace of a policy. If not specified,
@@ -1284,7 +1284,7 @@ spec:
12841284
exist, NGINX will assume the service has zero endpoints and
12851285
return a 502 response for requests for this upstream. For
12861286
NGINX Plus only, services of type ExternalName are also supported
1287-
(check the prerequisites ).
1287+
.
12881288
type: string
12891289
sessionCookie:
12901290
description: The SessionCookie field configures session persistence
@@ -1302,7 +1302,7 @@ spec:
13021302
type: boolean
13031303
expires:
13041304
description: The time for which a browser should keep the
1305-
cookie. Can be set to the special value max , which will
1305+
cookie. Can be set to the special value max, which will
13061306
cause the cookie to expire on 31 Dec 2037 23:55:55 GMT.
13071307
type: string
13081308
httpOnly:

‎deploy/crds.yaml‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ spec:
135135
metadata:
136136
type: object
137137
spec:
138-
description: GlobalConfigurationSpec is the spec of the GlobalConfiguration
139-
resource.
138+
description: The GlobalConfigurationSpec resource defines the global configuration
139+
parameters of the Ingress Controller.
140140
properties:
141141
listeners:
142142
description: Listeners field of the GlobalConfigurationSpec resource
@@ -147,7 +147,7 @@ spec:
147147
description: Specifies the IPv4 address to listen on.
148148
type: string
149149
ipv6:
150-
description: ipv6 addresses that NGINX will listen on.
150+
description: ipv6 addresse that NGINX will listen on.
151151
type: string
152152
name:
153153
description: The name of the listener. The name must be unique
@@ -524,7 +524,7 @@ spec:
524524
description: |-
525525
The key to which the rate limit is applied. Can contain text, variables, or a combination of them.
526526
Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are
527-
$binary_remote_addr , $request_uri , $request_method , $url , $http_ , $args , $arg_, $cookie_ ,$jwt_claim_ .
527+
$binary_remote_addr, $request_uri, $request_method, $url, $http_, $args, $arg_, $cookie_,$jwt_claim_ .
528528
type: string
529529
logLevel:
530530
description: Sets the desired logging level for cases when the
@@ -621,7 +621,7 @@ spec:
621621
type: object
622622
type: object
623623
status:
624-
description: status field of the Policy resource
624+
description: the status of the Policy resource
625625
properties:
626626
message:
627627
description: The message of the current state of the resource. It
@@ -754,7 +754,7 @@ spec:
754754
type: string
755755
type: object
756756
upstreamParameters:
757-
description: The UpstreamParameters are set on stream context
757+
description: UpstreamParameters defines parameters for an upstream.
758758
properties:
759759
connectTimeout:
760760
description: The timeout for establishing a connection with a
@@ -792,7 +792,7 @@ spec:
792792
backup:
793793
description: 'The name of the backup service of type ExternalName.
794794
This will be used when the primary servers are unavailable.
795-
Note: The parameter cannot be used along with the random ,
795+
Note: The parameter cannot be used along with the random,
796796
hash or ip_hash load balancing methods.'
797797
type: string
798798
backupPort:
@@ -900,7 +900,7 @@ spec:
900900
type: array
901901
type: object
902902
status:
903-
description: status field of the TransportServer resource
903+
description: The status of the TransportServer resource
904904
properties:
905905
message:
906906
description: The message of the current state of the resource. It
@@ -910,10 +910,10 @@ spec:
910910
description: The reason of the current state of the resource.
911911
type: string
912912
state:
913-
description: 'Represents the current state of the resource. There
914-
are three possible values: Valid, Invalid and Warning. Valid indicates
915-
that the resource has been validated and accepted by the Ingress
916-
Controller. Invalid means the resource failed validation or'
913+
description: 'Represents the current state of the resource. Possible
914+
values: Valid (resource validated and accepted), Invalid (validation
915+
failed or config reload failed), or Warning (validated but may work
916+
in degraded state).'
917917
type: string
918918
type: object
919919
type: object
@@ -1583,9 +1583,9 @@ spec:
15831583
an optional namespace.
15841584
properties:
15851585
name:
1586-
description: "The name of a policy. If the policy doesn’t
1586+
description: The name of a policy. If the policy doesn’t
15871587
exist or invalid, NGINX will respond with an error response
1588-
with the 500 status code.\tv"
1588+
with the 500 status code.
15891589
type: string
15901590
namespace:
15911591
description: The namespace of a policy. If not specified,
@@ -2018,7 +2018,7 @@ spec:
20182018
exist, NGINX will assume the service has zero endpoints and
20192019
return a 502 response for requests for this upstream. For
20202020
NGINX Plus only, services of type ExternalName are also supported
2021-
(check the prerequisites ).
2021+
.
20222022
type: string
20232023
sessionCookie:
20242024
description: The SessionCookie field configures session persistence
@@ -2036,7 +2036,7 @@ spec:
20362036
type: boolean
20372037
expires:
20382038
description: The time for which a browser should keep the
2039-
cookie. Can be set to the special value max , which will
2039+
cookie. Can be set to the special value max, which will
20402040
cause the cookie to expire on 31 Dec 2037 23:55:55 GMT.
20412041
type: string
20422042
httpOnly:
@@ -2300,9 +2300,9 @@ spec:
23002300
optional namespace.
23012301
properties:
23022302
name:
2303-
description: "The name of a policy. If the policy doesn’t exist
2303+
description: The name of a policy. If the policy doesn’t exist
23042304
or invalid, NGINX will respond with an error response with
2305-
the 500 status code.\tv"
2305+
the 500 status code.
23062306
type: string
23072307
namespace:
23082308
description: The namespace of a policy. If not specified, the
@@ -2894,9 +2894,9 @@ spec:
28942894
an optional namespace.
28952895
properties:
28962896
name:
2897-
description: "The name of a policy. If the policy doesn’t
2897+
description: The name of a policy. If the policy doesn’t
28982898
exist or invalid, NGINX will respond with an error response
2899-
with the 500 status code.\tv"
2899+
with the 500 status code.
29002900
type: string
29012901
namespace:
29022902
description: The namespace of a policy. If not specified,
@@ -3431,7 +3431,7 @@ spec:
34313431
exist, NGINX will assume the service has zero endpoints and
34323432
return a 502 response for requests for this upstream. For
34333433
NGINX Plus only, services of type ExternalName are also supported
3434-
(check the prerequisites ).
3434+
.
34353435
type: string
34363436
sessionCookie:
34373437
description: The SessionCookie field configures session persistence
@@ -3449,7 +3449,7 @@ spec:
34493449
type: boolean
34503450
expires:
34513451
description: The time for which a browser should keep the
3452-
cookie. Can be set to the special value max , which will
3452+
cookie. Can be set to the special value max, which will
34533453
cause the cookie to expire on 31 Dec 2037 23:55:55 GMT.
34543454
type: string
34553455
httpOnly:

‎docs/crd/k8s.nginx.org_globalconfigurations.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ The `.spec` object supports the following fields:
1616
| Field | Type | Description |
1717
|---|---|---|
1818
| `listeners` | `array` | Listeners field of the GlobalConfigurationSpec resource |
19-
| `listeners[].ipv4` | `string` | Ipv4 and ipv6 addresses that NGINX will listen on. Defaults to listening on all available IPv4 and IPv6 addresses. |
20-
| `listeners[].ipv6` | `string` | Ipv6 addresses that NGINX will listen on. |
19+
| `listeners[].ipv4` | `string` | Specifies the IPv4 address to listen on. |
20+
| `listeners[].ipv6` | `string` | Ipv6 addresse that NGINX will listen on. |
2121
| `listeners[].name` | `string` | The name of the listener. The name must be unique across all listeners. |
22-
| `listeners[].passSNI` | `boolean` | Custom SNI processing for listener. Allows listener to be used as a passthrough for SNI processing |
2322
| `listeners[].port` | `integer` | The port on which the listener will accept connections. |
2423
| `listeners[].protocol` | `string` | The protocol of the listener. For example, HTTP. |
2524
| `listeners[].ssl` | `boolean` | Whether the listener will be listening for SSL connections |

‎docs/crd/k8s.nginx.org_policies.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The `.spec` object supports the following fields:
7474
| `rateLimit.condition.variables[].name` | `string` | The name of the variable to match against. |
7575
| `rateLimit.delay` | `integer` | The delay parameter specifies a limit at which excessive requests become delayed. If not set all excessive requests are delayed. |
7676
| `rateLimit.dryRun` | `boolean` | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. |
77-
| `rateLimit.key` | `string` | The key to which the rate limit is applied. Can contain text, variables, or a combination of them. Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are $binary_remote_addr,$request_uri,$request_method,$url,$http_, $args,$arg_,$cookie_,$jwt_claim_. |
77+
| `rateLimit.key` | `string` | The key to which the rate limit is applied. Can contain text, variables, or a combination of them. Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are $binary_remote_addr, $request_uri, $request_method, $url, $http_, $args, $arg_, $cookie_,$jwt_claim_ . |
7878
| `rateLimit.logLevel` | `string` | Sets the desired logging level for cases when the server refuses to process requests due to rate exceeding, or delays request processing. Allowed values are info, notice, warn or error. Default is error. |
7979
| `rateLimit.noDelay` | `boolean` | Disables the delaying of excessive requests while requests are being limited. Overrides delay if both are set. |
8080
| `rateLimit.rate` | `string` | The rate of requests permitted. The rate is specified in requests per second (r/s) or requests per minute (r/m). |

0 commit comments

Comments
 (0)