update policy list #1374

eguzki · 2022-08-25T16:32:14Z

how to generate policy file

Run apicast

$ cat <<EOF >config.json
{
   "services": [
      {
         "proxy": {
             "hosts": ["one"],
             "proxy_rules": [],
             "api_backend": "https://echo-api.3scale.net",
             "policy_chain": []
         }
      }
   ]
}
EOF

$ docker run -ti --name apicast --rm -v $PWD/config.json:/opt/app/config.json:ro --env THREESCALE_CONFIG_FILE=/opt/app/config.json --env APICAST_LOG_LEVEL=debug --env APICAST_CONFIGURATION_LOADER=lazy --env APICAST_CONFIGURATION_CACHE=0 --env THREESCALE_DEPLOYMENT_ENV=staging --env BACKEND_ENDPOINT_OVERRIDE=http://127.0.0.1:3000 --env APICAST_WORKERS=1 quay.io/3scale/apicast:latest

Fetch policies

$ APICAST_IP=$(docker inspect apicast | yq e -P '.[0].NetworkSettings.Networks.bridge.IPAddress' -)
$ curl -v -H "Host: one" http://${APICAST_IP}:8090/policies -o policies.latest.json
# pretty print and fix string encoding issues
$ cat policies.latest.json | jq '.' > policies.latest.p.json

mayorova

Looks good 👍

doc/policies_list/3.10.0/policies.json

dfennessy · 2022-08-26T09:07:07Z

doc/policies_list/3.10.0/policies.json

+    "upstream": [
+      {
+        "name": "Upstream",
+        "summary": "Allows to modify the upstream URL of the request based on its path.",


Suggested change

"summary": "Allows to modify the upstream URL of the request based on its path.",

"summary": "This policy allows you to modify the upstream URL of the request based on its path.",

dfennessy · 2022-08-26T09:08:06Z

doc/policies_list/3.10.0/policies.json

+        "name": "Upstream",
+        "summary": "Allows to modify the upstream URL of the request based on its path.",
+        "description": [
+          "This policy allows to modify the upstream URL (scheme, host and port) of the request based on its path. ",


Suggested change

"This policy allows to modify the upstream URL (scheme, host and port) of the request based on its path. ",

"This policy allows you to modify the upstream URL (scheme, host, and port) of the request based on its path. ",

dfennessy · 2022-08-26T09:09:27Z

doc/policies_list/3.10.0/policies.json

+                "properties": {
+                  "url": {
+                    "type": "string",
+                    "description": "New URL in case of match"


Suggested change

"description": "New URL in case of match"

"description": "The new URL in case of a match."

dfennessy · 2022-08-26T09:09:51Z

doc/policies_list/3.10.0/policies.json

+                  },
+                  "regex": {
+                    "type": "string",
+                    "description": "Regular expression to be matched"


Suggested change

"description": "Regular expression to be matched"

"description": "The regular expression to be matched."

dfennessy · 2022-08-26T09:10:10Z

doc/policies_list/3.10.0/policies.json

+                ],
+                "type": "object"
+              },
+              "description": "List of rules to be applied",


Suggested change

"description": "List of rules to be applied",

"description": "The list of rules to be applied.",

dfennessy · 2022-08-26T09:11:29Z

doc/policies_list/3.10.0/policies.json

+                ],
+                "type": "string"
+              },
+              "description": "Array of HTTP methods this rule must be applied to. If left blank it will be applied to all HTTP methods",


Suggested change

"description": "Array of HTTP methods this rule must be applied to. If left blank it will be applied to all HTTP methods",

"description": "An array of HTTP methods this rule must be applied to. If left blank it will be applied to all HTTP methods.",

dfennessy · 2022-08-26T09:12:07Z

doc/policies_list/3.10.0/policies.json

+                    "type": "string"
+                  },
+                  "template": {
+                    "description": "Template in which the matched args are replaced",


Suggested change

"description": "Template in which the matched args are replaced",

"description": "Template in which the matched arguments are replaced.",

dfennessy · 2022-08-26T09:12:32Z

doc/policies_list/3.10.0/policies.json

+    ],
+    "upstream_mtls": [
+      {
+        "summary": "Certificates to be used with the upstream API",


Suggested change

"summary": "Certificates to be used with the upstream API",

"summary": "Certificates to be used with the upstream API.",

dfennessy · 2022-08-26T09:14:43Z

doc/policies_list/3.10.0/policies.json

+    "upstream_mtls": [
+      {
+        "summary": "Certificates to be used with the upstream API",
+        "description": "With this policy a new TLS connection with the upstream API will be used with the certificates set in the config",


Suggested change

"description": "With this policy a new TLS connection with the upstream API will be used with the certificates set in the config",

"description": "This policy uses a new TLS connection with the upstream API and the certificates set in the configurations.",

dfennessy · 2022-08-26T09:15:08Z

doc/policies_list/3.10.0/policies.json

+              "type": "string"
+            }
+          },
+          "description": "Built-in Upstream MTLS APIcast policy",


Suggested change

"description": "Built-in Upstream MTLS APIcast policy",

"description": "Built-in Upstream MTLS APIcast policy.",

dfennessy · 2022-08-26T09:15:49Z

doc/policies_list/3.10.0/policies.json

+    "custom_metrics": [
+      {
+        "name": "Custom Metrics",
+        "summary": "Custom metrics on Nginx post actions ",


Suggested change

"summary": "Custom metrics on Nginx post actions ",

"summary": "Custom metrics on Nginx post actions.",

dfennessy · 2022-08-26T09:22:15Z

doc/policies_list/3.10.0/policies.json

+        "name": "Custom Metrics",
+        "summary": "Custom metrics on Nginx post actions ",
+        "description": [
+          "With this policy, on post_actions the Authrep call will report any new ",


Suggested change

"With this policy, on post_actions the Authrep call will report any new ",

"With this policy, on post_actions the AuthRep call will report any new ",

dfennessy · 2022-08-26T09:22:58Z

doc/policies_list/3.10.0/policies.json

+                    "!=",
+                    "matches"
+                  ],
+                  "description": "Operation to apply. The matches op supports PCRE (Perl compatible regular expressions)",


Suggested change

"description": "Operation to apply. The matches op supports PCRE (Perl compatible regular expressions)",

"description": "Operation to apply. The matches operation supports PCRE (Perl compatible regular expressions).",

dfennessy · 2022-08-26T09:49:34Z

doc/policies_list/3.10.0/policies.json

+            "custom_metrics_rule": {
+              "properties": {
+                "increment": {
+                  "description": "How many hits should be incremented, liquid value ",


I'm not sure what this description is trying to say. Is it: This metric determines how many hits should be incremented using the liquid value?

eguzki · 2022-08-26T09:50:47Z

@dfennessy Thanks for the review. Those files are auto-generated and thus, we cannot change them. I will take your suggestions and apply them to the source files in another PR. thanks!

dfennessy · 2022-08-26T09:51:38Z

doc/policies_list/3.10.0/policies.json

+      {
+        "summary": "Controls logging.",
+        "description": [
+          "Controls logging. It allows to enable and disable access logs per ",


Suggested change

"Controls logging. It allows to enable and disable access logs per ",

"Controls logging allows you to enable and disable access logs per ",

dfennessy · 2022-08-26T09:51:54Z

doc/policies_list/3.10.0/policies.json

+        "summary": "Controls logging.",
+        "description": [
+          "Controls logging. It allows to enable and disable access logs per ",
+          "service. Also it allows to have a custom access logs format per service"


Suggested change

"service. Also it allows to have a custom access logs format per service"

"service. Also it allows to have a custom access logs format per service."

dfennessy · 2022-08-26T10:00:22Z

doc/policies_list/3.10.0/policies.json

+                          "!=",
+                          "matches"
+                        ],
+                        "description": "Match operation to compare match field with the provided value",


Suggested change

"description": "Match operation to compare match field with the provided value",

"description": "Match operation to compare match field with the provided value.",

dfennessy · 2022-08-26T10:02:18Z

doc/policies_list/3.10.0/policies.json

+    ],
+    "upstream_connection": [
+      {
+        "summary": "Allows to configure several options for the connections to the upstream",


Suggested change

"summary": "Allows to configure several options for the connections to the upstream",

"summary": "Allows you to configure several options for the connections to the upstream.",

dfennessy · 2022-08-26T10:02:41Z

doc/policies_list/3.10.0/policies.json

+    "upstream_connection": [
+      {
+        "summary": "Allows to configure several options for the connections to the upstream",
+        "description": "Allows to configure several options for the connections to the upstream",


Suggested change

"description": "Allows to configure several options for the connections to the upstream",

"description": "Allows you to configure several options for the connections to the upstream.",

dfennessy · 2022-08-26T10:03:18Z

doc/policies_list/3.10.0/policies.json

+          "properties": {
+            "send_timeout": {
+              "exclusiveMinimum": 0,
+              "description": "Timeout between two successive write operations (in seconds).",


Suggested change

"description": "Timeout between two successive write operations (in seconds).",

"description": "This is the timeout in seconds between two successive write operations.",

dfennessy · 2022-08-26T10:04:16Z

doc/policies_list/3.10.0/policies.json

+            },
+            "connect_timeout": {
+              "type": "integer",
+              "description": "Timeout for establishing a connection (in seconds)."


Suggested change

"description": "Timeout for establishing a connection (in seconds)."

"description": "This is the timeout in seconds for establishing a connection."

dfennessy · 2022-08-26T10:05:14Z

doc/policies_list/3.10.0/policies.json

+            },
+            "read_timeout": {
+              "exclusiveMinimum": 0,
+              "description": "Timeout between two successive read operations (in seconds).",


Suggested change

"description": "Timeout between two successive read operations (in seconds).",

"description": "The timeout in seconds between two successive read operations.",

dfennessy · 2022-08-26T10:05:39Z

doc/policies_list/3.10.0/policies.json

+    ],
+    "tls": [
+      {
+        "summary": "Configure TLS termination certificates",


Suggested change

"summary": "Configure TLS termination certificates",

"summary": "Configure TLS termination certificates.",

dfennessy · 2022-08-26T10:08:39Z

Some suggestions added. This is one I'll have to come back to due to the sheer size of the files, however I hope the suggestions I've made are on the right track. The suggestions are around readability and punctuation.

dfennessy · 2022-08-26T10:11:30Z

@dfennessy Thanks for the review. Those files are auto-generated and thus, we cannot change them. I will take your suggestions and apply them to the source files in another PR. thanks!

AH! I've just seen this now. Will I await the other PR and continue the suggestions there?

eguzki · 2022-08-26T12:48:38Z

@dfennessy Thanks for the review. Those files are auto-generated and thus, we cannot change them. I will take your suggestions and apply them to the source files in another PR. thanks!

AH! I've just seen this now. Will I await the other PR and continue the suggestions there?

wait for another PR, thanks

update policy list

2ce9075

eguzki assigned mayorova Aug 25, 2022

eguzki requested a review from a team as a code owner August 25, 2022 16:32

mayorova approved these changes Aug 25, 2022

View reviewed changes

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

doc/policies_list/3.10.0/policies.json Show resolved Hide resolved

dfennessy reviewed Aug 26, 2022

View reviewed changes

eguzki merged commit 45b1756 into master Aug 26, 2022

eguzki deleted the update-policy-list branch August 26, 2022 14:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update policy list #1374

update policy list #1374

eguzki commented Aug 25, 2022 •

edited

Loading

mayorova left a comment

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

eguzki commented Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022 •

edited

Loading

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy Aug 26, 2022

dfennessy commented Aug 26, 2022 •

edited

Loading

dfennessy commented Aug 26, 2022

eguzki commented Aug 26, 2022

	"summary": "Allows to modify the upstream URL of the request based on its path.",
	"summary": "This policy allows you to modify the upstream URL of the request based on its path.",

	"This policy allows to modify the upstream URL (scheme, host and port) of the request based on its path. ",
	"This policy allows you to modify the upstream URL (scheme, host, and port) of the request based on its path. ",

	"description": "New URL in case of match"
	"description": "The new URL in case of a match."

	"description": "Regular expression to be matched"
	"description": "The regular expression to be matched."

	"description": "List of rules to be applied",
	"description": "The list of rules to be applied.",

	"description": "Array of HTTP methods this rule must be applied to. If left blank it will be applied to all HTTP methods",
	"description": "An array of HTTP methods this rule must be applied to. If left blank it will be applied to all HTTP methods.",

	"description": "Template in which the matched args are replaced",
	"description": "Template in which the matched arguments are replaced.",

	"summary": "Certificates to be used with the upstream API",
	"summary": "Certificates to be used with the upstream API.",

	"description": "With this policy a new TLS connection with the upstream API will be used with the certificates set in the config",
	"description": "This policy uses a new TLS connection with the upstream API and the certificates set in the configurations.",

	"description": "Built-in Upstream MTLS APIcast policy",
	"description": "Built-in Upstream MTLS APIcast policy.",

	"summary": "Custom metrics on Nginx post actions ",
	"summary": "Custom metrics on Nginx post actions.",

	"With this policy, on post_actions the Authrep call will report any new ",
	"With this policy, on post_actions the AuthRep call will report any new ",

	"description": "Operation to apply. The matches op supports PCRE (Perl compatible regular expressions)",
	"description": "Operation to apply. The matches operation supports PCRE (Perl compatible regular expressions).",

	"Controls logging. It allows to enable and disable access logs per ",
	"Controls logging allows you to enable and disable access logs per ",

	"service. Also it allows to have a custom access logs format per service"
	"service. Also it allows to have a custom access logs format per service."

	"description": "Match operation to compare match field with the provided value",
	"description": "Match operation to compare match field with the provided value.",

	"summary": "Allows to configure several options for the connections to the upstream",
	"summary": "Allows you to configure several options for the connections to the upstream.",

	"description": "Allows to configure several options for the connections to the upstream",
	"description": "Allows you to configure several options for the connections to the upstream.",

	"description": "Timeout between two successive write operations (in seconds).",
	"description": "This is the timeout in seconds between two successive write operations.",

	"description": "Timeout for establishing a connection (in seconds)."
	"description": "This is the timeout in seconds for establishing a connection."

update policy list #1374

update policy list #1374

Conversation

eguzki commented Aug 25, 2022 • edited Loading

how to generate policy file

mayorova left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eguzki commented Aug 26, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfennessy Aug 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfennessy commented Aug 26, 2022 • edited Loading

dfennessy commented Aug 26, 2022

eguzki commented Aug 26, 2022

eguzki commented Aug 25, 2022 •

edited

Loading

dfennessy Aug 26, 2022 •

edited

Loading

dfennessy commented Aug 26, 2022 •

edited

Loading

	"description": "Timeout between two successive read operations (in seconds).",
	"description": "The timeout in seconds between two successive read operations.",

	"summary": "Configure TLS termination certificates",
	"summary": "Configure TLS termination certificates.",