|
75 | 75 | { |
76 | 76 | "title": "TUNING & BEHAVIOR", |
77 | 77 | "start": 2161, |
78 | | - "end": 2304, |
| 78 | + "end": 2312, |
79 | 79 | "description": "" |
80 | 80 | }, |
81 | 81 | { |
82 | 82 | "title": "MISCELLANEOUS", |
83 | | - "start": 2305, |
84 | | - "end": 2426, |
| 83 | + "start": 2313, |
| 84 | + "end": 2434, |
85 | 85 | "description": "Additional settings inherited from lua-nginx-module allowing for more\nflexibility and advanced usage.\n\nSee the lua-nginx-module documentation for more information:\nhttps://github.com/openresty/lua-nginx-module\n" |
86 | 86 | }, |
87 | 87 | { |
88 | 88 | "title": "KONG MANAGER", |
89 | | - "start": 2427, |
90 | | - "end": 2702, |
| 89 | + "start": 2435, |
| 90 | + "end": 2710, |
91 | 91 | "description": "\nThe Admin GUI for Kong Enterprise.\n\n" |
92 | 92 | }, |
93 | 93 | { |
94 | 94 | "title": "Konnect", |
95 | | - "start": 2703, |
96 | | - "end": 2709, |
| 95 | + "start": 2711, |
| 96 | + "end": 2717, |
97 | 97 | "description": "" |
98 | 98 | }, |
99 | 99 | { |
100 | 100 | "title": "Analytics for Konnect", |
101 | | - "start": 2710, |
102 | | - "end": 2730, |
| 101 | + "start": 2718, |
| 102 | + "end": 2738, |
103 | 103 | "description": "" |
104 | 104 | }, |
105 | 105 | { |
106 | 106 | "title": "ADMIN SMTP CONFIGURATION", |
107 | | - "start": 2731, |
108 | | - "end": 2745, |
| 107 | + "start": 2739, |
| 108 | + "end": 2753, |
109 | 109 | "description": "" |
110 | 110 | }, |
111 | 111 | { |
112 | 112 | "title": "GENERAL SMTP CONFIGURATION", |
113 | | - "start": 2746, |
114 | | - "end": 2796, |
| 113 | + "start": 2754, |
| 114 | + "end": 2804, |
115 | 115 | "description": "" |
116 | 116 | }, |
117 | 117 | { |
118 | 118 | "title": "DATA & ADMIN AUDIT", |
119 | | - "start": 2797, |
120 | | - "end": 2842, |
| 119 | + "start": 2805, |
| 120 | + "end": 2850, |
121 | 121 | "description": "When enabled, Kong will store detailed audit data regarding Admin API and\ndatabase access. In most cases, updates to the database are associated with\nAdmin API requests. As such, database object audit log data is tied to a\ngiven HTTP request via a unique identifier, providing built-in association of\nAdmin API and database traffic.\n\n" |
122 | 122 | }, |
123 | 123 | { |
124 | 124 | "title": "ROUTE COLLISION DETECTION/PREVENTION", |
125 | | - "start": 2843, |
126 | | - "end": 2890, |
| 125 | + "start": 2851, |
| 126 | + "end": 2898, |
127 | 127 | "description": "" |
128 | 128 | }, |
129 | 129 | { |
130 | 130 | "title": "DATABASE ENCRYPTION & KEYRING MANAGEMENT", |
131 | | - "start": 2891, |
132 | | - "end": 3119, |
| 131 | + "start": 2899, |
| 132 | + "end": 3127, |
133 | 133 | "description": "When enabled, Kong will transparently encrypt sensitive fields, such as consumer\ncredentials, TLS private keys, and RBAC user tokens, among others. A full list\nof encrypted fields is available from the Kong Enterprise documentation site.\nEncrypted data is transparently decrypted before being displayed to the Admin\nAPI or made available to plugins or core routing logic.\n\nWhile this feature is GA, do note that we currently do not provide normal semantic\nversioning compatibility guarantees on the keyring feature's APIs in that Kong may\nmake a breaking change to the feature in a minor version. Also note that\nmismanagement of keyring data may result in irrecoverable data loss.\n\n" |
134 | 134 | }, |
135 | 135 | { |
136 | 136 | "title": "CLUSTER FALLBACK CONFIGURATION", |
137 | | - "start": 3120, |
138 | | - "end": 3179, |
| 137 | + "start": 3128, |
| 138 | + "end": 3187, |
139 | 139 | "description": "" |
140 | 140 | }, |
141 | 141 | { |
142 | 142 | "title": "REQUEST DEBUGGING", |
143 | | - "start": 3180, |
144 | | - "end": 3242, |
| 143 | + "start": 3188, |
| 144 | + "end": 3250, |
145 | 145 | "description": "Request debugging is a mechanism that allows admins to collect the timing of\nproxy path requests in the response header (X-Kong-Request-Debug-Output)\nand optionally, the error log.\n\nThis feature provides insights into the time spent within various components of Kong,\nsuch as plugins, DNS resolution, load balancing, and more. It also provides contextual\ninformation such as domain names tried during these processes.\n\n" |
146 | 146 | } |
147 | 147 | ], |
|
1201 | 1201 | }, |
1202 | 1202 | "vault_hcv_auth_method": { |
1203 | 1203 | "defaultValue": "token", |
1204 | | - "description": "Defines the authentication mechanism when\nconnecting to the Hashicorp Vault service.\nAccepted values are: `token`,\n`kubernetes`, `approle`, `cert` or `oauth2`.\n", |
| 1204 | + "description": "Defines the authentication mechanism when\nconnecting to the Hashicorp Vault service.\nAccepted values are: `token`,\n`kubernetes`, `approle`, `cert` or `jwt`.\n", |
1205 | 1205 | "sectionTitle": "VAULTS" |
1206 | 1206 | }, |
1207 | 1207 | "vault_hcv_kube_role": { |
|
1259 | 1259 | "description": "The contents of the private key for use in\nHashicorp Vault auth if\n`auth_method` is set to `cert`.\n", |
1260 | 1260 | "sectionTitle": "VAULTS" |
1261 | 1261 | }, |
1262 | | - "vault_hcv_oauth2_role_name": { |
| 1262 | + "vault_hcv_jwt_role": { |
1263 | 1263 | "defaultValue": null, |
1264 | | - "description": "The configured role name in HashiCorp Vault\nfor OAuth2 auth.\nWhen creating the role in HashiCorp Vault, make sure\nthat the `role_type` is `jwt` and the `token_policies`\nhave permissions to read the secrets.\n", |
| 1264 | + "description": "The configured role name in HashiCorp Vault\nfor JWT auth.\nWhen creating the role in HashiCorp Vault, make sure\nthat the `role_type` is `jwt` and the `token_policies`\nhave permissions to read the secrets.\n", |
1265 | 1265 | "sectionTitle": "VAULTS" |
1266 | 1266 | }, |
1267 | 1267 | "vault_hcv_oauth2_token_endpoint": { |
1268 | 1268 | "defaultValue": null, |
1269 | | - "description": "The OAuth2 token endpoint for Hashicorp Vault's OAuth2 auth method.\n", |
| 1269 | + "description": "The OAuth2 token endpoint for Hashicorp Vault's JWT auth method.\n", |
1270 | 1270 | "sectionTitle": "VAULTS" |
1271 | 1271 | }, |
1272 | 1272 | "vault_hcv_oauth2_client_id": { |
|
1384 | 1384 | "description": "A boolean value that controls whether the PDK\nfunction `kong.response.exit` can stop further\nplugin execution within the header_filter phase.\nIf 'on', it would interrupt the execution flow\nof plugins in header_filter phase.\n", |
1385 | 1385 | "sectionTitle": "TUNING & BEHAVIOR" |
1386 | 1386 | }, |
| 1387 | + "via_header_comply_rfc": { |
| 1388 | + "defaultValue": "off", |
| 1389 | + "description": "When enabled, the `Via` header added by Kong\nto proxied requests and responses will not\ninclude the Kong version number (like `1.1 kong`).\nPreviously `Via` header includes dashes `-` in it\n(like `1.1 kong/3.13.0.0-enterprise-edition`),\nwhich is not allowed by RFC 9001 and may cause\nissues with some HTTP servers.\n", |
| 1390 | + "sectionTitle": "TUNING & BEHAVIOR" |
| 1391 | + }, |
1387 | 1392 | "lua_ssl_trusted_certificate": { |
1388 | 1393 | "defaultValue": "system", |
1389 | 1394 | "description": "Comma-separated list of certificate authorities\nfor Lua cosockets in PEM format.\n\nThe special value `system` attempts to search for the\n\"usual default\" provided by each distro, according\nto an arbitrary heuristic. In the current implementation,\nthe following pathnames will be tested in order,\nand the first one found will be used:\n\n- `/etc/ssl/certs/ca-certificates.crt` (Debian/Ubuntu/Gentoo)\n- `/etc/pki/tls/certs/ca-bundle.crt` (Fedora/RHEL 6)\n- `/etc/ssl/ca-bundle.pem` (OpenSUSE)\n- `/etc/pki/tls/cacert.pem` (OpenELEC)\n- `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem` (CentOS/RHEL 7)\n- `/etc/ssl/cert.pem` (OpenBSD, Alpine)\n\n`system` can be used by itself or in conjunction with other\nCA file paths.\n\nWhen `pg_ssl_verify` is enabled, these\ncertificate authority files will be\nused for verifying Kong's database connections.\n\nCertificates can be configured on this property\nwith any of the following values:\n- `system`\n- absolute path to the certificate\n- certificate content\n- base64 encoded certificate content\n\nSee https://github.com/openresty/lua-nginx-module#lua_ssl_trusted_certificate\n", |
|
0 commit comments