Merge pull request #576 from dheerajng/master

Adding NetScaler supported HTTP methods in the enums of CRD definitions

Author: subashd

crd/auth/README.md

@@ -150,7 +150,7 @@ The following are the attributes for policies with resource format:
 | Attribute | Description |
 | --------- | ----------- |
 | `path` | An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/`.  |
-| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. </br>**Note:** The traffic is selected if the incoming request URI matches with any of the paths AND any of the listed methods. If the method is not specified then the path alone is used for the traffic selection criteria.|
+| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. </br>**Note:** The traffic is selected if the incoming request URI matches with any of the paths AND any of the listed methods. If the method is not specified then the path alone is used for the traffic selection criteria.|
 | `provider` | Specifies the authentication mechanism that needs to be used. If the authentication mechanism is not provided, then authentication is not performed.|
 
 The following attributes are for authentication policies with expression format:
@@ -176,7 +176,7 @@ The following are the attributes for authorization policies with resource format
 | Attribute | Description |
 | --------- | ----------- |
 | `path` | An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/`.  |
-| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. |
+| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. |
 | `claims` | Specifies the claims required to access a specific API endpoint. `name` indicates the claim name and `values` indicate the required permissions. You can have more than one claim. If an empty list is specified, it implies that authorization is not required. </br> **Note:** Any claim that needs to be used for authorization, should be saved as part of authentication.|
 
 The following are the attributes for authorization policies with expression format:

crd/auth/auth-crd.yaml

@@ -461,7 +461,7 @@ spec:
                             type: array
                             items:
                               type: string
-                              enum: ['GET', 'PUT', 'POST','DELETE']
+                              enum: ['GET', 'PUT', 'POST', 'DELETE', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT', 'UNKNOWN_METHOD']
                         required:
                           - path
                     expression:
@@ -501,7 +501,7 @@ spec:
                             type: array
                             items:
                               type: string
-                              enum: ['GET', 'PUT', 'POST','DELETE']
+                              enum: ['GET', 'PUT', 'POST', 'DELETE', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT', 'UNKNOWN_METHOD']
                           claims:
                             description: 'authorization scopes required for selected resource saved as claims or attributes'
                             type: array

crd/bot/bot-crd.yaml

@@ -69,7 +69,7 @@ spec:
                     description: "List of http methods to inspect"
                     items:
                       type: string
-                      enum: ['GET', 'PUT', 'POST','DELETE']
+                      enum: ['GET', 'PUT', 'POST', 'DELETE', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT', 'UNKNOWN_METHOD']
                   header:
                     type: array
                     description: "List of http headers to inspect"

crd/ratelimit/README.md

@@ -20,7 +20,7 @@ The following table lists the various attributes provided in the Rate limit CRD:
 | CRD attribute | Description |
 | ---------- | ----------- |
 | `servicename` | The list of Kubernetes services to which you want to apply the rate limit policies. |
-| `selector_keys` | The traffic selector keys that filter the traffic to identify the API requests against which the throttling is applied and monitored. </br> </br>**Note:** The `selector_keys` is an optional attribute. You can choose to configure zero, one or more of the selector keys. If more than one selector keys are configured then it is considered as a logical AND expression.</br></br> In this version of the Rate limit CRD, `selector_keys` provides the `basic` configuration section that you can use to configure the following commonly used traffic characteristics as the keys against which the configured limits are monitored and throttled:</br></br> - **path:** An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/` </br> - **method:** An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. </br> - **header_name:** HTTP header that has the unique API client or user identifier. For example, `X-apikey` which comes with a unique API-key that identifies the API client sending the request. </br>- **per_client_ip:** Allows you to monitor and apply the configured threshold to each API request received per unique client IP address. |
+| `selector_keys` | The traffic selector keys that filter the traffic to identify the API requests against which the throttling is applied and monitored. </br> </br>**Note:** The `selector_keys` is an optional attribute. You can choose to configure zero, one or more of the selector keys. If more than one selector keys are configured then it is considered as a logical AND expression.</br></br> In this version of the Rate limit CRD, `selector_keys` provides the `basic` configuration section that you can use to configure the following commonly used traffic characteristics as the keys against which the configured limits are monitored and throttled:</br></br> - **path:** An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/` </br> - **method:** An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. </br> - **header_name:** HTTP header that has the unique API client or user identifier. For example, `X-apikey` which comes with a unique API-key that identifies the API client sending the request. </br>- **per_client_ip:** Allows you to monitor and apply the configured threshold to each API request received per unique client IP address. |
 | `req_threshold` | The maximum number of requests that are allowed in the given time slice (request rate). |
 | `timeslice` | The time interval specified in microseconds (multiple of 10 s), during which the requests are monitored against the configured limits. If not specified it defaults to 1000 milliseconds. |
 | `limittype` | It allows you to configure the following type of throttling algorithms that you want to use to apply the limit: </br> - burst </br> - smooth.  The default is the ***burst*** mode.

crd/ratelimit/ratelimit-crd.yaml

@@ -64,7 +64,7 @@ spec:
                         type: array
                         items:
                           type: string
-                          enum: ['GET', 'PUT', 'POST','DELETE']
+                          enum: ['GET', 'PUT', 'POST', 'DELETE', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT', 'UNKNOWN_METHOD']
                       header_name:
                         description: "HTTP header that identifies the unique API client for e.g. X-apikey"
                         type: string

crd/waf/waf-crd.yaml

@@ -88,7 +88,7 @@ spec:
                     description: "List of http methods to inspect"
                     items:
                       type: string
-                      enum: ['GET', 'PUT', 'POST','DELETE']
+                      enum: ['GET', 'PUT', 'POST', 'DELETE', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT', 'UNKNOWN_METHOD']
                   header:
                     type: array
                     description: "List of http headers to inspect"

docs/crds/auth.md

@@ -150,7 +150,7 @@ The following are the attributes for policies with resource format:
 | Attribute | Description |
 | --------- | ----------- |
 | `path` | An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/`.  |
-| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. </br>**Note:** The traffic is selected if the incoming request URI matches with any of the paths AND any of the listed methods. If the method is not specified then the path alone is used for the traffic selection criteria.|
+| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. </br>**Note:** The traffic is selected if the incoming request URI matches with any of the paths AND any of the listed methods. If the method is not specified then the path alone is used for the traffic selection criteria.|
 | `provider` | Specifies the authentication mechanism that needs to be used. If the authentication mechanism is not provided, then authentication is not performed.|
 
 The following attributes are for authentication policies with expression format:
@@ -176,7 +176,7 @@ The following are the attributes for authorization policies with resource format
 | Attribute | Description |
 | --------- | ----------- |
 | `path` | An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/`.  |
-| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. |
+| `method` | An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. |
 | `claims` | Specifies the claims required to access a specific API endpoint. `name` indicates the claim name and `values` indicate the required permissions. You can have more than one claim. If an empty list is specified, it implies that authorization is not required. </br> **Note:** Any claim that needs to be used for authorization, should be saved as part of authentication.|
 
 The following are the attributes for authorization policies with expression format:

docs/crds/bot.md

@@ -43,7 +43,7 @@ The following table lists the various attributes provided in the Bot CRD:
 | `signatures` | Location of external bot signature file. |
 | `target` | Determines which traffic to be inspected by the bot. If you do not specify the traffic targeted, every traffic is inspected by default. |
 | `paths` | List of HTTP URLs to be inspected. |
-| `method` | List of HTTP methods to be inspected. |
+| `method` | List of HTTP methods to be inspected. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT.|
 | `header` | List of HTTP headers to be inspected. |
 
 ## Deploy the Bot CRD

docs/crds/rate-limit.md

@@ -20,7 +20,7 @@ The following table lists the various attributes provided in the Rate limit CRD:
 | CRD attribute | Description |
 | ---------- | ----------- |
 | `servicename` | The list of Kubernetes services to which you want to apply the rate limit policies. |
-| `selector_keys` | The traffic selector keys that filter the traffic to identify the API requests against which the throttling is applied and monitored. </br> </br>**Note:** The `selector_keys` is an optional attribute. You can choose to configure zero, one or more of the selector keys. If more than one selector keys are configured then it is considered as a logical AND expression.</br></br> In this version of the Rate limit CRD, `selector_keys` provides the `basic` configuration section that you can use to configure the following commonly used traffic characteristics as the keys against which the configured limits are monitored and throttled:</br></br> - **path:** An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/` </br> - **method:** An array of HTTP methods. Allowed values are GET, PUT, POST, or DELETE. </br> - **header_name:** HTTP header that has the unique API client or user identifier. For example, `X-apikey` which comes with a unique API-key that identifies the API client sending the request. </br>- **per_client_ip:** Allows you to monitor and apply the configured threshold to each API request received per unique client IP address. |
+| `selector_keys` | The traffic selector keys that filter the traffic to identify the API requests against which the throttling is applied and monitored. </br> </br>**Note:** The `selector_keys` is an optional attribute. You can choose to configure zero, one or more of the selector keys. If more than one selector keys are configured then it is considered as a logical AND expression.</br></br> In this version of the Rate limit CRD, `selector_keys` provides the `basic` configuration section that you can use to configure the following commonly used traffic characteristics as the keys against which the configured limits are monitored and throttled:</br></br> - **path:** An array of URL path prefixes that refer to a specific API endpoint. For example, `/api/v1/products/` </br> - **method:** An array of HTTP methods. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT. </br> - **header_name:** HTTP header that has the unique API client or user identifier. For example, `X-apikey` which comes with a unique API-key that identifies the API client sending the request. </br>- **per_client_ip:** Allows you to monitor and apply the configured threshold to each API request received per unique client IP address. |
 | `req_threshold` | The maximum number of requests that are allowed in the given time slice (request rate). |
 | `timeslice` | The time interval specified in microseconds (multiple of 10 s), during which the requests are monitored against the configured limits. If not specified it defaults to 1000 milliseconds. |
 | `limittype` | It allows you to configure the following type of throttling algorithms that you want to use to apply the limit: </br> - burst </br> - smooth.  The default is the ***burst*** mode.

docs/crds/waf.md

@@ -79,7 +79,7 @@ The following table lists the various attributes provided in the WAF CRD:
 | `ip_reputation` | Enables the IP reputation feature. |
 | `target` | Determines the traffic to be inspected by the WAF. If you do not specify the traffic targeted, all traffic is inspected by default. |
 | `paths` | Specifies the list of HTTP URLs to be inspected. |
-| `method` | Specifies the list of HTTP methods to be inspected. |
+| `method` | Specifies the list of HTTP methods to be inspected. Allowed values are GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE or CONNECT.|
 | `header` | Specifies the list of HTTP headers to be inspected. |