gateway_api/apis/standard/httproutes.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
// WARNING: generated by kopium - manual changes will be overwritten
// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --derive=PartialEq --docs -f -
// kopium version: 0.21.1
#[allow(unused_imports)]
mod prelude {
pub use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition;
pub use kube::CustomResource;
pub use schemars::JsonSchema;
pub use serde::{Deserialize, Serialize};
}
use self::prelude::*;
/// Spec defines the desired state of HTTPRoute.
#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
#[kube(
group = "gateway.networking.k8s.io",
version = "v1",
kind = "HTTPRoute",
plural = "httproutes"
)]
#[kube(namespaced)]
#[kube(status = "HTTPRouteStatus")]
#[kube(derive = "Default")]
#[kube(derive = "PartialEq")]
pub struct HTTPRouteSpec {
/// Hostnames defines a set of hostnames that should match against the HTTP Host
/// header to select a HTTPRoute used to process the request. Implementations
/// MUST ignore any port value specified in the HTTP Host header while
/// performing a match and (absent of any applicable header modification
/// configuration) MUST forward this header unmodified to the backend.
///
/// Valid values for Hostnames are determined by RFC 1123 definition of a
/// hostname with 2 notable exceptions:
///
/// 1. IPs are not allowed.
/// 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard
/// label must appear by itself as the first label.
///
/// If a hostname is specified by both the Listener and HTTPRoute, there
/// must be at least one intersecting hostname for the HTTPRoute to be
/// attached to the Listener. For example:
///
/// * A Listener with `test.example.com` as the hostname matches HTTPRoutes
/// that have either not specified any hostnames, or have specified at
/// least one of `test.example.com` or `*.example.com`.
/// * A Listener with `*.example.com` as the hostname matches HTTPRoutes
/// that have either not specified any hostnames or have specified at least
/// one hostname that matches the Listener hostname. For example,
/// `*.example.com`, `test.example.com`, and `foo.test.example.com` would
/// all match. On the other hand, `example.com` and `test.example.net` would
/// not match.
///
/// Hostnames that are prefixed with a wildcard label (`*.`) are interpreted
/// as a suffix match. That means that a match for `*.example.com` would match
/// both `test.example.com`, and `foo.test.example.com`, but not `example.com`.
///
/// If both the Listener and HTTPRoute have specified hostnames, any
/// HTTPRoute hostnames that do not match the Listener hostname MUST be
/// ignored. For example, if a Listener specified `*.example.com`, and the
/// HTTPRoute specified `test.example.com` and `test.example.net`,
/// `test.example.net` must not be considered for a match.
///
/// If both the Listener and HTTPRoute have specified hostnames, and none
/// match with the criteria above, then the HTTPRoute is not accepted. The
/// implementation must raise an 'Accepted' Condition with a status of
/// `False` in the corresponding RouteParentStatus.
///
/// In the event that multiple HTTPRoutes specify intersecting hostnames (e.g.
/// overlapping wildcard matching and exact matching hostnames), precedence must
/// be given to rules from the HTTPRoute with the largest number of:
///
/// * Characters in a matching non-wildcard hostname.
/// * Characters in a matching hostname.
///
/// If ties exist across multiple Routes, the matching precedence rules for
/// HTTPRouteMatches takes over.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hostnames: Option<Vec<String>>,
/// ParentRefs references the resources (usually Gateways) that a Route wants
/// to be attached to. Note that the referenced parent resource needs to
/// allow this for the attachment to be complete. For Gateways, that means
/// the Gateway needs to allow attachment from Routes of this kind and
/// namespace. For Services, that means the Service must either be in the same
/// namespace for a "producer" route, or the mesh implementation must support
/// and allow "consumer" routes for the referenced Service. ReferenceGrant is
/// not applicable for governing ParentRefs to Services - it is not possible to
/// create a "producer" route for a Service in a different namespace from the
/// Route.
///
/// There are two kinds of parent resources with "Core" support:
///
/// * Gateway (Gateway conformance profile)
/// * Service (Mesh conformance profile, ClusterIP Services only)
///
/// This API may be extended in the future to support additional kinds of parent
/// resources.
///
/// ParentRefs must be _distinct_. This means either that:
///
/// * They select different objects. If this is the case, then parentRef
/// entries are distinct. In terms of fields, this means that the
/// multi-part key defined by `group`, `kind`, `namespace`, and `name` must
/// be unique across all parentRef entries in the Route.
/// * They do not select different objects, but for each optional field used,
/// each ParentRef that selects the same object must set the same set of
/// optional fields to different values. If one ParentRef sets a
/// combination of optional fields, all must set the same combination.
///
/// Some examples:
///
/// * If one ParentRef sets `sectionName`, all ParentRefs referencing the
/// same object must also set `sectionName`.
/// * If one ParentRef sets `port`, all ParentRefs referencing the same
/// object must also set `port`.
/// * If one ParentRef sets `sectionName` and `port`, all ParentRefs
/// referencing the same object must also set `sectionName` and `port`.
///
/// It is possible to separately reference multiple distinct objects that may
/// be collapsed by an implementation. For example, some implementations may
/// choose to merge compatible Gateway Listeners together. If that is the
/// case, the list of routes attached to those resources should also be
/// merged.
///
/// Note that for ParentRefs that cross namespace boundaries, there are specific
/// rules. Cross-namespace references are only valid if they are explicitly
/// allowed by something in the namespace they are referring to. For example,
/// Gateway has the AllowedRoutes field, and ReferenceGrant provides a
/// generic way to enable other kinds of cross-namespace reference.
///
///
///
///
///
///
///
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "parentRefs"
)]
pub parent_refs: Option<Vec<HTTPRouteParentRefs>>,
/// Rules are a list of HTTP matchers, filters and actions.
///
///
#[serde(default, skip_serializing_if = "Option::is_none")]
pub rules: Option<Vec<HTTPRouteRules>>,
}
/// ParentReference identifies an API object (usually a Gateway) that can be considered
/// a parent of this resource (usually a route). There are two kinds of parent resources
/// with "Core" support:
///
/// * Gateway (Gateway conformance profile)
/// * Service (Mesh conformance profile, ClusterIP Services only)
///
/// This API may be extended in the future to support additional kinds of parent
/// resources.
///
/// The API object must be valid in the cluster; the Group and Kind must
/// be registered in the cluster for this reference to be valid.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteParentRefs {
/// Group is the group of the referent.
/// When unspecified, "gateway.networking.k8s.io" is inferred.
/// To set the core API group (such as for a "Service" kind referent),
/// Group must be explicitly set to "" (empty string).
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<String>,
/// Kind is kind of the referent.
///
/// There are two kinds of parent resources with "Core" support:
///
/// * Gateway (Gateway conformance profile)
/// * Service (Mesh conformance profile, ClusterIP Services only)
///
/// Support for other resources is Implementation-Specific.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub kind: Option<String>,
/// Name is the name of the referent.
///
/// Support: Core
pub name: String,
/// Namespace is the namespace of the referent. When unspecified, this refers
/// to the local namespace of the Route.
///
/// Note that there are specific rules for ParentRefs which cross namespace
/// boundaries. Cross-namespace references are only valid if they are explicitly
/// allowed by something in the namespace they are referring to. For example:
/// Gateway has the AllowedRoutes field, and ReferenceGrant provides a
/// generic way to enable any other kind of cross-namespace reference.
///
///
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub namespace: Option<String>,
/// Port is the network port this Route targets. It can be interpreted
/// differently based on the type of parent resource.
///
/// When the parent resource is a Gateway, this targets all listeners
/// listening on the specified port that also support this kind of Route(and
/// select this Route). It's not recommended to set `Port` unless the
/// networking behaviors specified in a Route must apply to a specific port
/// as opposed to a listener(s) whose port(s) may be changed. When both Port
/// and SectionName are specified, the name and port of the selected listener
/// must match both specified values.
///
///
///
/// Implementations MAY choose to support other parent resources.
/// Implementations supporting other types of parent resources MUST clearly
/// document how/if Port is interpreted.
///
/// For the purpose of status, an attachment is considered successful as
/// long as the parent resource accepts it partially. For example, Gateway
/// listeners can restrict which Routes can attach to them by Route kind,
/// namespace, or hostname. If 1 of 2 Gateway listeners accept attachment
/// from the referencing Route, the Route MUST be considered successfully
/// attached. If no Gateway listeners accept attachment from this Route,
/// the Route MUST be considered detached from the Gateway.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
/// SectionName is the name of a section within the target resource. In the
/// following resources, SectionName is interpreted as the following:
///
/// * Gateway: Listener name. When both Port (experimental) and SectionName
/// are specified, the name and port of the selected listener must match
/// both specified values.
/// * Service: Port name. When both Port (experimental) and SectionName
/// are specified, the name and port of the selected listener must match
/// both specified values.
///
/// Implementations MAY choose to support attaching Routes to other resources.
/// If that is the case, they MUST clearly document how SectionName is
/// interpreted.
///
/// When unspecified (empty string), this will reference the entire resource.
/// For the purpose of status, an attachment is considered successful if at
/// least one section in the parent resource accepts it. For example, Gateway
/// listeners can restrict which Routes can attach to them by Route kind,
/// namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from
/// the referencing Route, the Route MUST be considered successfully
/// attached. If no Gateway listeners accept attachment from this Route, the
/// Route MUST be considered detached from the Gateway.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "sectionName"
)]
pub section_name: Option<String>,
}
/// HTTPRouteRule defines semantics for matching an HTTP request based on
/// conditions (matches), processing it (filters), and forwarding the request to
/// an API object (backendRefs).
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRules {
/// BackendRefs defines the backend(s) where matching requests should be
/// sent.
///
/// Failure behavior here depends on how many BackendRefs are specified and
/// how many are invalid.
///
/// If *all* entries in BackendRefs are invalid, and there are also no filters
/// specified in this route rule, *all* traffic which matches this rule MUST
/// receive a 500 status code.
///
/// See the HTTPBackendRef definition for the rules about what makes a single
/// HTTPBackendRef invalid.
///
/// When a HTTPBackendRef is invalid, 500 status codes MUST be returned for
/// requests that would have otherwise been routed to an invalid backend. If
/// multiple backends are specified, and some are invalid, the proportion of
/// requests that would otherwise have been routed to an invalid backend
/// MUST receive a 500 status code.
///
/// For example, if two backends are specified with equal weights, and one is
/// invalid, 50 percent of traffic must receive a 500. Implementations may
/// choose how that 50 percent is determined.
///
/// When a HTTPBackendRef refers to a Service that has no ready endpoints,
/// implementations SHOULD return a 503 for requests to that backend instead.
/// If an implementation chooses to do this, all of the above rules for 500 responses
/// MUST also apply for responses that return a 503.
///
/// Support: Core for Kubernetes Service
///
/// Support: Extended for Kubernetes ServiceImport
///
/// Support: Implementation-specific for any other resource
///
/// Support for weight: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "backendRefs"
)]
pub backend_refs: Option<Vec<HTTPRouteRulesBackendRefs>>,
/// Filters define the filters that are applied to requests that match
/// this rule.
///
/// Wherever possible, implementations SHOULD implement filters in the order
/// they are specified.
///
/// Implementations MAY choose to implement this ordering strictly, rejecting
/// any combination or order of filters that can not be supported. If implementations
/// choose a strict interpretation of filter ordering, they MUST clearly document
/// that behavior.
///
/// To reject an invalid combination or order of filters, implementations SHOULD
/// consider the Route Rules with this configuration invalid. If all Route Rules
/// in a Route are invalid, the entire Route would be considered invalid. If only
/// a portion of Route Rules are invalid, implementations MUST set the
/// "PartiallyInvalid" condition for the Route.
///
/// Conformance-levels at this level are defined based on the type of filter:
///
/// - ALL core filters MUST be supported by all implementations.
/// - Implementers are encouraged to support extended filters.
/// - Implementation-specific custom filters have no API guarantees across
/// implementations.
///
/// Specifying the same filter multiple times is not supported unless explicitly
/// indicated in the filter.
///
/// All filters are expected to be compatible with each other except for the
/// URLRewrite and RequestRedirect filters, which may not be combined. If an
/// implementation can not support other combinations of filters, they must clearly
/// document that limitation. In cases where incompatible or unsupported
/// filters are specified and cause the `Accepted` condition to be set to status
/// `False`, implementations may use the `IncompatibleFilters` reason to specify
/// this configuration error.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filters: Option<Vec<HTTPRouteRulesFilters>>,
/// Matches define conditions used for matching the rule against incoming
/// HTTP requests. Each match is independent, i.e. this rule will be matched
/// if **any** one of the matches is satisfied.
///
/// For example, take the following matches configuration:
///
/// ```text
/// matches:
/// - path:
/// value: "/foo"
/// headers:
/// - name: "version"
/// value: "v2"
/// - path:
/// value: "/v2/foo"
/// ```
///
/// For a request to match against this rule, a request must satisfy
/// EITHER of the two conditions:
///
/// - path prefixed with `/foo` AND contains the header `version: v2`
/// - path prefix of `/v2/foo`
///
/// See the documentation for HTTPRouteMatch on how to specify multiple
/// match conditions that should be ANDed together.
///
/// If no matches are specified, the default is a prefix
/// path match on "/", which has the effect of matching every
/// HTTP request.
///
/// Proxy or Load Balancer routing configuration generated from HTTPRoutes
/// MUST prioritize matches based on the following criteria, continuing on
/// ties. Across all rules specified on applicable Routes, precedence must be
/// given to the match having:
///
/// * "Exact" path match.
/// * "Prefix" path match with largest number of characters.
/// * Method match.
/// * Largest number of header matches.
/// * Largest number of query param matches.
///
/// Note: The precedence of RegularExpression path matches are implementation-specific.
///
/// If ties still exist across multiple Routes, matching precedence MUST be
/// determined in order of the following criteria, continuing on ties:
///
/// * The oldest Route based on creation timestamp.
/// * The Route appearing first in alphabetical order by
/// "{namespace}/{name}".
///
/// If ties still exist within an HTTPRoute, matching precedence MUST be granted
/// to the FIRST matching rule (in list order) with a match meeting the above
/// criteria.
///
/// When no rules matching a request have been successfully attached to the
/// parent a request is coming from, a HTTP 404 status code MUST be returned.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub matches: Option<Vec<HTTPRouteRulesMatches>>,
/// Timeouts defines the timeouts that can be configured for an HTTP request.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub timeouts: Option<HTTPRouteRulesTimeouts>,
}
/// HTTPBackendRef defines how a HTTPRoute forwards a HTTP request.
///
/// Note that when a namespace different than the local namespace is specified, a
/// ReferenceGrant object is required in the referent namespace to allow that
/// namespace's owner to accept the reference. See the ReferenceGrant
/// documentation for details.
///
/// <gateway:experimental:description>
///
/// When the BackendRef points to a Kubernetes Service, implementations SHOULD
/// honor the appProtocol field if it is set for the target Service Port.
///
/// Implementations supporting appProtocol SHOULD recognize the Kubernetes
/// Standard Application Protocols defined in KEP-3726.
///
/// If a Service appProtocol isn't specified, an implementation MAY infer the
/// backend protocol through its own means. Implementations MAY infer the
/// protocol from the Route type referring to the backend Service.
///
/// If a Route is not able to send traffic to the backend using the specified
/// protocol then the backend is considered invalid. Implementations MUST set the
/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason.
///
/// </gateway:experimental:description>
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefs {
/// Filters defined at this level should be executed if and only if the
/// request is being forwarded to the backend defined here.
///
/// Support: Implementation-specific (For broader support of filters, use the
/// Filters field in HTTPRouteRule.)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filters: Option<Vec<HTTPRouteRulesBackendRefsFilters>>,
/// Group is the group of the referent. For example, "gateway.networking.k8s.io".
/// When unspecified or empty string, core API group is inferred.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<String>,
/// Kind is the Kubernetes resource kind of the referent. For example
/// "Service".
///
/// Defaults to "Service" when not specified.
///
/// ExternalName services can refer to CNAME DNS records that may live
/// outside of the cluster and as such are difficult to reason about in
/// terms of conformance. They also may not be safe to forward to (see
/// CVE-2021-25740 for more information). Implementations SHOULD NOT
/// support ExternalName Services.
///
/// Support: Core (Services with a type other than ExternalName)
///
/// Support: Implementation-specific (Services with type ExternalName)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub kind: Option<String>,
/// Name is the name of the referent.
pub name: String,
/// Namespace is the namespace of the backend. When unspecified, the local
/// namespace is inferred.
///
/// Note that when a namespace different than the local namespace is specified,
/// a ReferenceGrant object is required in the referent namespace to allow that
/// namespace's owner to accept the reference. See the ReferenceGrant
/// documentation for details.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub namespace: Option<String>,
/// Port specifies the destination port number to use for this resource.
/// Port is required when the referent is a Kubernetes Service. In this
/// case, the port number is the service port number, not the target port.
/// For other resources, destination port might be derived from the referent
/// resource or this field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
/// Weight specifies the proportion of requests forwarded to the referenced
/// backend. This is computed as weight/(sum of all weights in this
/// BackendRefs list). For non-zero values, there may be some epsilon from
/// the exact proportion defined here depending on the precision an
/// implementation supports. Weight is not a percentage and the sum of
/// weights does not need to equal 100.
///
/// If only one backend is specified and it has a weight greater than 0, 100%
/// of the traffic is forwarded to that backend. If weight is set to 0, no
/// traffic should be forwarded for this entry. If unspecified, weight
/// defaults to 1.
///
/// Support for this field varies based on the context where used.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub weight: Option<i32>,
}
/// HTTPRouteFilter defines processing steps that must be completed during the
/// request or response lifecycle. HTTPRouteFilters are meant as an extension
/// point to express processing that may be done in Gateway implementations. Some
/// examples include request or response modification, implementing
/// authentication strategies, rate-limiting, and traffic shaping. API
/// guarantee/conformance is defined based on the type of the filter.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFilters {
/// ExtensionRef is an optional, implementation-specific extension to the
/// "filter" behavior. For example, resource "myroutefilter" in group
/// "networking.example.net"). ExtensionRef MUST NOT be used for core and
/// extended filters.
///
/// This filter can be used multiple times within the same rule.
///
/// Support: Implementation-specific
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "extensionRef"
)]
pub extension_ref: Option<HTTPRouteRulesBackendRefsFiltersExtensionRef>,
/// RequestHeaderModifier defines a schema for a filter that modifies request
/// headers.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestHeaderModifier"
)]
pub request_header_modifier: Option<HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier>,
/// RequestMirror defines a schema for a filter that mirrors requests.
/// Requests are sent to the specified destination, but responses from
/// that destination are ignored.
///
/// This filter can be used multiple times within the same rule. Note that
/// not all implementations will be able to support mirroring to multiple
/// backends.
///
/// Support: Extended
///
///
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestMirror"
)]
pub request_mirror: Option<HTTPRouteRulesBackendRefsFiltersRequestMirror>,
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestRedirect"
)]
pub request_redirect: Option<HTTPRouteRulesBackendRefsFiltersRequestRedirect>,
/// ResponseHeaderModifier defines a schema for a filter that modifies response
/// headers.
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "responseHeaderModifier"
)]
pub response_header_modifier: Option<HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier>,
/// Type identifies the type of filter to apply. As with other API fields,
/// types are classified into three conformance levels:
///
/// - Core: Filter types and their corresponding configuration defined by
/// "Support: Core" in this package, e.g. "RequestHeaderModifier". All
/// implementations must support core filters.
///
/// - Extended: Filter types and their corresponding configuration defined by
/// "Support: Extended" in this package, e.g. "RequestMirror". Implementers
/// are encouraged to support extended filters.
///
/// - Implementation-specific: Filters that are defined and supported by
/// specific vendors.
/// In the future, filters showing convergence in behavior across multiple
/// implementations will be considered for inclusion in extended or core
/// conformance levels. Filter-specific configuration for such filters
/// is specified using the ExtensionRef field. `Type` should be set to
/// "ExtensionRef" for custom filters.
///
/// Implementers are encouraged to define custom implementation types to
/// extend the core API with implementation-specific behavior.
///
/// If a reference to a custom filter type cannot be resolved, the filter
/// MUST NOT be skipped. Instead, requests that would have been processed by
/// that filter MUST receive a HTTP error response.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesBackendRefsFiltersType,
/// URLRewrite defines a schema for a filter that modifies a request during forwarding.
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "urlRewrite"
)]
pub url_rewrite: Option<HTTPRouteRulesBackendRefsFiltersUrlRewrite>,
}
/// ExtensionRef is an optional, implementation-specific extension to the
/// "filter" behavior. For example, resource "myroutefilter" in group
/// "networking.example.net"). ExtensionRef MUST NOT be used for core and
/// extended filters.
///
/// This filter can be used multiple times within the same rule.
///
/// Support: Implementation-specific
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersExtensionRef {
/// Group is the group of the referent. For example, "gateway.networking.k8s.io".
/// When unspecified or empty string, core API group is inferred.
pub group: String,
/// Kind is kind of the referent. For example "HTTPRoute" or "Service".
pub kind: String,
/// Name is the name of the referent.
pub name: String,
}
/// RequestHeaderModifier defines a schema for a filter that modifies request
/// headers.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier {
/// Add adds the given header(s) (name, value) to the request
/// before the action. It appends to any existing values associated
/// with the header name.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// add:
/// - name: "my-header"
/// value: "bar,baz"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: foo,bar,baz
#[serde(default, skip_serializing_if = "Option::is_none")]
pub add: Option<Vec<HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd>>,
/// Remove the given header(s) from the HTTP request before the action. The
/// value of Remove is a list of HTTP header names. Note that the header
/// names are case-insensitive (see
/// https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header1: foo
/// my-header2: bar
/// my-header3: baz
///
/// Config:
/// remove: ["my-header1", "my-header3"]
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header2: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub remove: Option<Vec<String>>,
/// Set overwrites the request with the given header (name, value)
/// before the action.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// set:
/// - name: "my-header"
/// value: "bar"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub set: Option<Vec<HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet>>,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// RequestMirror defines a schema for a filter that mirrors requests.
/// Requests are sent to the specified destination, but responses from
/// that destination are ignored.
///
/// This filter can be used multiple times within the same rule. Note that
/// not all implementations will be able to support mirroring to multiple
/// backends.
///
/// Support: Extended
///
///
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestMirror {
/// BackendRef references a resource where mirrored requests are sent.
///
/// Mirrored requests must be sent only to a single destination endpoint
/// within this BackendRef, irrespective of how many endpoints are present
/// within this BackendRef.
///
/// If the referent cannot be found, this BackendRef is invalid and must be
/// dropped from the Gateway. The controller must ensure the "ResolvedRefs"
/// condition on the Route status is set to `status: False` and not configure
/// this backend in the underlying implementation.
///
/// If there is a cross-namespace reference to an *existing* object
/// that is not allowed by a ReferenceGrant, the controller must ensure the
/// "ResolvedRefs" condition on the Route is set to `status: False`,
/// with the "RefNotPermitted" reason and not configure this backend in the
/// underlying implementation.
///
/// In either error case, the Message of the `ResolvedRefs` Condition
/// should be used to provide more detail about the problem.
///
/// Support: Extended for Kubernetes Service
///
/// Support: Implementation-specific for any other resource
#[serde(rename = "backendRef")]
pub backend_ref: HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef,
}
/// BackendRef references a resource where mirrored requests are sent.
///
/// Mirrored requests must be sent only to a single destination endpoint
/// within this BackendRef, irrespective of how many endpoints are present
/// within this BackendRef.
///
/// If the referent cannot be found, this BackendRef is invalid and must be
/// dropped from the Gateway. The controller must ensure the "ResolvedRefs"
/// condition on the Route status is set to `status: False` and not configure
/// this backend in the underlying implementation.
///
/// If there is a cross-namespace reference to an *existing* object
/// that is not allowed by a ReferenceGrant, the controller must ensure the
/// "ResolvedRefs" condition on the Route is set to `status: False`,
/// with the "RefNotPermitted" reason and not configure this backend in the
/// underlying implementation.
///
/// In either error case, the Message of the `ResolvedRefs` Condition
/// should be used to provide more detail about the problem.
///
/// Support: Extended for Kubernetes Service
///
/// Support: Implementation-specific for any other resource
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef {
/// Group is the group of the referent. For example, "gateway.networking.k8s.io".
/// When unspecified or empty string, core API group is inferred.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<String>,
/// Kind is the Kubernetes resource kind of the referent. For example
/// "Service".
///
/// Defaults to "Service" when not specified.
///
/// ExternalName services can refer to CNAME DNS records that may live
/// outside of the cluster and as such are difficult to reason about in
/// terms of conformance. They also may not be safe to forward to (see
/// CVE-2021-25740 for more information). Implementations SHOULD NOT
/// support ExternalName Services.
///
/// Support: Core (Services with a type other than ExternalName)
///
/// Support: Implementation-specific (Services with type ExternalName)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub kind: Option<String>,
/// Name is the name of the referent.
pub name: String,
/// Namespace is the namespace of the backend. When unspecified, the local
/// namespace is inferred.
///
/// Note that when a namespace different than the local namespace is specified,
/// a ReferenceGrant object is required in the referent namespace to allow that
/// namespace's owner to accept the reference. See the ReferenceGrant
/// documentation for details.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub namespace: Option<String>,
/// Port specifies the destination port number to use for this resource.
/// Port is required when the referent is a Kubernetes Service. In this
/// case, the port number is the service port number, not the target port.
/// For other resources, destination port might be derived from the referent
/// resource or this field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirect {
/// Hostname is the hostname to be used in the value of the `Location`
/// header in the response.
/// When empty, the hostname in the `Host` header of the request is used.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hostname: Option<String>,
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<HTTPRouteRulesBackendRefsFiltersRequestRedirectPath>,
/// Port is the port to be used in the value of the `Location`
/// header in the response.
///
/// If no port is specified, the redirect port MUST be derived using the
/// following rules:
///
/// * If redirect scheme is not-empty, the redirect port MUST be the well-known
/// port associated with the redirect scheme. Specifically "http" to port 80
/// and "https" to port 443. If the redirect scheme does not have a
/// well-known port, the listener port of the Gateway SHOULD be used.
/// * If redirect scheme is empty, the redirect port MUST be the Gateway
/// Listener port.
///
/// Implementations SHOULD NOT add the port number in the 'Location'
/// header in the following cases:
///
/// * A Location header that will use HTTP (whether that is determined via
/// the Listener protocol or the Scheme field) _and_ use port 80.
/// * A Location header that will use HTTPS (whether that is determined via
/// the Listener protocol or the Scheme field) _and_ use port 443.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
/// Scheme is the scheme to be used in the value of the `Location` header in
/// the response. When empty, the scheme of the request is used.
///
/// Scheme redirects can affect the port of the redirect, for more information,
/// refer to the documentation for the port field of this filter.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub scheme: Option<HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme>,
/// StatusCode is the HTTP status code to be used in response.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "statusCode"
)]
pub status_code: Option<i64>,
}
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirectPath {
/// ReplaceFullPath specifies the value with which to replace the full path
/// of a request during a rewrite or redirect.
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replaceFullPath"
)]
pub replace_full_path: Option<String>,
/// ReplacePrefixMatch specifies the value with which to replace the prefix
/// match of a request during a rewrite or redirect. For example, a request
/// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch
/// of "/xyz" would be modified to "/xyz/bar".
///
/// Note that this matches the behavior of the PathPrefix match type. This
/// matches full path elements. A path element refers to the list of labels
/// in the path split by the `/` separator. When specified, a trailing `/` is
/// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all
/// match the prefix `/abc`, but the path `/abcd` would not.
///
/// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch.
/// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
/// the implementation setting the Accepted Condition for the Route to `status: False`.
///
/// Request Path | Prefix Match | Replace Prefix | Modified Path
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replacePrefixMatch"
)]
pub replace_prefix_match: Option<String>,
/// Type defines the type of path modifier. Additional types may be
/// added in a future release of the API.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType,
}
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType {
ReplaceFullPath,
ReplacePrefixMatch,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme {
#[serde(rename = "http")]
Http,
#[serde(rename = "https")]
Https,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectStatusCode {
#[serde(rename = "301")]
r#_301,
#[serde(rename = "302")]
r#_302,
}
/// ResponseHeaderModifier defines a schema for a filter that modifies response
/// headers.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier {
/// Add adds the given header(s) (name, value) to the request
/// before the action. It appends to any existing values associated
/// with the header name.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// add:
/// - name: "my-header"
/// value: "bar,baz"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: foo,bar,baz
#[serde(default, skip_serializing_if = "Option::is_none")]
pub add: Option<Vec<HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd>>,
/// Remove the given header(s) from the HTTP request before the action. The
/// value of Remove is a list of HTTP header names. Note that the header
/// names are case-insensitive (see
/// https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header1: foo
/// my-header2: bar
/// my-header3: baz
///
/// Config:
/// remove: ["my-header1", "my-header3"]
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header2: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub remove: Option<Vec<String>>,
/// Set overwrites the request with the given header (name, value)
/// before the action.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// set:
/// - name: "my-header"
/// value: "bar"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub set: Option<Vec<HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet>>,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPRouteFilter defines processing steps that must be completed during the
/// request or response lifecycle. HTTPRouteFilters are meant as an extension
/// point to express processing that may be done in Gateway implementations. Some
/// examples include request or response modification, implementing
/// authentication strategies, rate-limiting, and traffic shaping. API
/// guarantee/conformance is defined based on the type of the filter.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesBackendRefsFiltersType {
RequestHeaderModifier,
ResponseHeaderModifier,
RequestMirror,
RequestRedirect,
#[serde(rename = "URLRewrite")]
UrlRewrite,
ExtensionRef,
}
/// URLRewrite defines a schema for a filter that modifies a request during forwarding.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersUrlRewrite {
/// Hostname is the value to be used to replace the Host header value during
/// forwarding.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hostname: Option<String>,
/// Path defines a path rewrite.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<HTTPRouteRulesBackendRefsFiltersUrlRewritePath>,
}
/// Path defines a path rewrite.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesBackendRefsFiltersUrlRewritePath {
/// ReplaceFullPath specifies the value with which to replace the full path
/// of a request during a rewrite or redirect.
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replaceFullPath"
)]
pub replace_full_path: Option<String>,
/// ReplacePrefixMatch specifies the value with which to replace the prefix
/// match of a request during a rewrite or redirect. For example, a request
/// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch
/// of "/xyz" would be modified to "/xyz/bar".
///
/// Note that this matches the behavior of the PathPrefix match type. This
/// matches full path elements. A path element refers to the list of labels
/// in the path split by the `/` separator. When specified, a trailing `/` is
/// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all
/// match the prefix `/abc`, but the path `/abcd` would not.
///
/// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch.
/// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
/// the implementation setting the Accepted Condition for the Route to `status: False`.
///
/// Request Path | Prefix Match | Replace Prefix | Modified Path
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replacePrefixMatch"
)]
pub replace_prefix_match: Option<String>,
/// Type defines the type of path modifier. Additional types may be
/// added in a future release of the API.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesBackendRefsFiltersUrlRewritePathType,
}
/// Path defines a path rewrite.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesBackendRefsFiltersUrlRewritePathType {
ReplaceFullPath,
ReplacePrefixMatch,
}
/// HTTPRouteFilter defines processing steps that must be completed during the
/// request or response lifecycle. HTTPRouteFilters are meant as an extension
/// point to express processing that may be done in Gateway implementations. Some
/// examples include request or response modification, implementing
/// authentication strategies, rate-limiting, and traffic shaping. API
/// guarantee/conformance is defined based on the type of the filter.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFilters {
/// ExtensionRef is an optional, implementation-specific extension to the
/// "filter" behavior. For example, resource "myroutefilter" in group
/// "networking.example.net"). ExtensionRef MUST NOT be used for core and
/// extended filters.
///
/// This filter can be used multiple times within the same rule.
///
/// Support: Implementation-specific
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "extensionRef"
)]
pub extension_ref: Option<HTTPRouteRulesFiltersExtensionRef>,
/// RequestHeaderModifier defines a schema for a filter that modifies request
/// headers.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestHeaderModifier"
)]
pub request_header_modifier: Option<HTTPRouteRulesFiltersRequestHeaderModifier>,
/// RequestMirror defines a schema for a filter that mirrors requests.
/// Requests are sent to the specified destination, but responses from
/// that destination are ignored.
///
/// This filter can be used multiple times within the same rule. Note that
/// not all implementations will be able to support mirroring to multiple
/// backends.
///
/// Support: Extended
///
///
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestMirror"
)]
pub request_mirror: Option<HTTPRouteRulesFiltersRequestMirror>,
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "requestRedirect"
)]
pub request_redirect: Option<HTTPRouteRulesFiltersRequestRedirect>,
/// ResponseHeaderModifier defines a schema for a filter that modifies response
/// headers.
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "responseHeaderModifier"
)]
pub response_header_modifier: Option<HTTPRouteRulesFiltersResponseHeaderModifier>,
/// Type identifies the type of filter to apply. As with other API fields,
/// types are classified into three conformance levels:
///
/// - Core: Filter types and their corresponding configuration defined by
/// "Support: Core" in this package, e.g. "RequestHeaderModifier". All
/// implementations must support core filters.
///
/// - Extended: Filter types and their corresponding configuration defined by
/// "Support: Extended" in this package, e.g. "RequestMirror". Implementers
/// are encouraged to support extended filters.
///
/// - Implementation-specific: Filters that are defined and supported by
/// specific vendors.
/// In the future, filters showing convergence in behavior across multiple
/// implementations will be considered for inclusion in extended or core
/// conformance levels. Filter-specific configuration for such filters
/// is specified using the ExtensionRef field. `Type` should be set to
/// "ExtensionRef" for custom filters.
///
/// Implementers are encouraged to define custom implementation types to
/// extend the core API with implementation-specific behavior.
///
/// If a reference to a custom filter type cannot be resolved, the filter
/// MUST NOT be skipped. Instead, requests that would have been processed by
/// that filter MUST receive a HTTP error response.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesFiltersType,
/// URLRewrite defines a schema for a filter that modifies a request during forwarding.
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "urlRewrite"
)]
pub url_rewrite: Option<HTTPRouteRulesFiltersUrlRewrite>,
}
/// ExtensionRef is an optional, implementation-specific extension to the
/// "filter" behavior. For example, resource "myroutefilter" in group
/// "networking.example.net"). ExtensionRef MUST NOT be used for core and
/// extended filters.
///
/// This filter can be used multiple times within the same rule.
///
/// Support: Implementation-specific
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersExtensionRef {
/// Group is the group of the referent. For example, "gateway.networking.k8s.io".
/// When unspecified or empty string, core API group is inferred.
pub group: String,
/// Kind is kind of the referent. For example "HTTPRoute" or "Service".
pub kind: String,
/// Name is the name of the referent.
pub name: String,
}
/// RequestHeaderModifier defines a schema for a filter that modifies request
/// headers.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestHeaderModifier {
/// Add adds the given header(s) (name, value) to the request
/// before the action. It appends to any existing values associated
/// with the header name.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// add:
/// - name: "my-header"
/// value: "bar,baz"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: foo,bar,baz
#[serde(default, skip_serializing_if = "Option::is_none")]
pub add: Option<Vec<HTTPRouteRulesFiltersRequestHeaderModifierAdd>>,
/// Remove the given header(s) from the HTTP request before the action. The
/// value of Remove is a list of HTTP header names. Note that the header
/// names are case-insensitive (see
/// https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header1: foo
/// my-header2: bar
/// my-header3: baz
///
/// Config:
/// remove: ["my-header1", "my-header3"]
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header2: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub remove: Option<Vec<String>>,
/// Set overwrites the request with the given header (name, value)
/// before the action.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// set:
/// - name: "my-header"
/// value: "bar"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub set: Option<Vec<HTTPRouteRulesFiltersRequestHeaderModifierSet>>,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestHeaderModifierAdd {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestHeaderModifierSet {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// RequestMirror defines a schema for a filter that mirrors requests.
/// Requests are sent to the specified destination, but responses from
/// that destination are ignored.
///
/// This filter can be used multiple times within the same rule. Note that
/// not all implementations will be able to support mirroring to multiple
/// backends.
///
/// Support: Extended
///
///
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestMirror {
/// BackendRef references a resource where mirrored requests are sent.
///
/// Mirrored requests must be sent only to a single destination endpoint
/// within this BackendRef, irrespective of how many endpoints are present
/// within this BackendRef.
///
/// If the referent cannot be found, this BackendRef is invalid and must be
/// dropped from the Gateway. The controller must ensure the "ResolvedRefs"
/// condition on the Route status is set to `status: False` and not configure
/// this backend in the underlying implementation.
///
/// If there is a cross-namespace reference to an *existing* object
/// that is not allowed by a ReferenceGrant, the controller must ensure the
/// "ResolvedRefs" condition on the Route is set to `status: False`,
/// with the "RefNotPermitted" reason and not configure this backend in the
/// underlying implementation.
///
/// In either error case, the Message of the `ResolvedRefs` Condition
/// should be used to provide more detail about the problem.
///
/// Support: Extended for Kubernetes Service
///
/// Support: Implementation-specific for any other resource
#[serde(rename = "backendRef")]
pub backend_ref: HTTPRouteRulesFiltersRequestMirrorBackendRef,
}
/// BackendRef references a resource where mirrored requests are sent.
///
/// Mirrored requests must be sent only to a single destination endpoint
/// within this BackendRef, irrespective of how many endpoints are present
/// within this BackendRef.
///
/// If the referent cannot be found, this BackendRef is invalid and must be
/// dropped from the Gateway. The controller must ensure the "ResolvedRefs"
/// condition on the Route status is set to `status: False` and not configure
/// this backend in the underlying implementation.
///
/// If there is a cross-namespace reference to an *existing* object
/// that is not allowed by a ReferenceGrant, the controller must ensure the
/// "ResolvedRefs" condition on the Route is set to `status: False`,
/// with the "RefNotPermitted" reason and not configure this backend in the
/// underlying implementation.
///
/// In either error case, the Message of the `ResolvedRefs` Condition
/// should be used to provide more detail about the problem.
///
/// Support: Extended for Kubernetes Service
///
/// Support: Implementation-specific for any other resource
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestMirrorBackendRef {
/// Group is the group of the referent. For example, "gateway.networking.k8s.io".
/// When unspecified or empty string, core API group is inferred.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<String>,
/// Kind is the Kubernetes resource kind of the referent. For example
/// "Service".
///
/// Defaults to "Service" when not specified.
///
/// ExternalName services can refer to CNAME DNS records that may live
/// outside of the cluster and as such are difficult to reason about in
/// terms of conformance. They also may not be safe to forward to (see
/// CVE-2021-25740 for more information). Implementations SHOULD NOT
/// support ExternalName Services.
///
/// Support: Core (Services with a type other than ExternalName)
///
/// Support: Implementation-specific (Services with type ExternalName)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub kind: Option<String>,
/// Name is the name of the referent.
pub name: String,
/// Namespace is the namespace of the backend. When unspecified, the local
/// namespace is inferred.
///
/// Note that when a namespace different than the local namespace is specified,
/// a ReferenceGrant object is required in the referent namespace to allow that
/// namespace's owner to accept the reference. See the ReferenceGrant
/// documentation for details.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub namespace: Option<String>,
/// Port specifies the destination port number to use for this resource.
/// Port is required when the referent is a Kubernetes Service. In this
/// case, the port number is the service port number, not the target port.
/// For other resources, destination port might be derived from the referent
/// resource or this field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestRedirect {
/// Hostname is the hostname to be used in the value of the `Location`
/// header in the response.
/// When empty, the hostname in the `Host` header of the request is used.
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hostname: Option<String>,
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<HTTPRouteRulesFiltersRequestRedirectPath>,
/// Port is the port to be used in the value of the `Location`
/// header in the response.
///
/// If no port is specified, the redirect port MUST be derived using the
/// following rules:
///
/// * If redirect scheme is not-empty, the redirect port MUST be the well-known
/// port associated with the redirect scheme. Specifically "http" to port 80
/// and "https" to port 443. If the redirect scheme does not have a
/// well-known port, the listener port of the Gateway SHOULD be used.
/// * If redirect scheme is empty, the redirect port MUST be the Gateway
/// Listener port.
///
/// Implementations SHOULD NOT add the port number in the 'Location'
/// header in the following cases:
///
/// * A Location header that will use HTTP (whether that is determined via
/// the Listener protocol or the Scheme field) _and_ use port 80.
/// * A Location header that will use HTTPS (whether that is determined via
/// the Listener protocol or the Scheme field) _and_ use port 443.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
/// Scheme is the scheme to be used in the value of the `Location` header in
/// the response. When empty, the scheme of the request is used.
///
/// Scheme redirects can affect the port of the redirect, for more information,
/// refer to the documentation for the port field of this filter.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub scheme: Option<HTTPRouteRulesFiltersRequestRedirectScheme>,
/// StatusCode is the HTTP status code to be used in response.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "statusCode"
)]
pub status_code: Option<i64>,
}
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersRequestRedirectPath {
/// ReplaceFullPath specifies the value with which to replace the full path
/// of a request during a rewrite or redirect.
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replaceFullPath"
)]
pub replace_full_path: Option<String>,
/// ReplacePrefixMatch specifies the value with which to replace the prefix
/// match of a request during a rewrite or redirect. For example, a request
/// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch
/// of "/xyz" would be modified to "/xyz/bar".
///
/// Note that this matches the behavior of the PathPrefix match type. This
/// matches full path elements. A path element refers to the list of labels
/// in the path split by the `/` separator. When specified, a trailing `/` is
/// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all
/// match the prefix `/abc`, but the path `/abcd` would not.
///
/// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch.
/// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
/// the implementation setting the Accepted Condition for the Route to `status: False`.
///
/// Request Path | Prefix Match | Replace Prefix | Modified Path
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replacePrefixMatch"
)]
pub replace_prefix_match: Option<String>,
/// Type defines the type of path modifier. Additional types may be
/// added in a future release of the API.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesFiltersRequestRedirectPathType,
}
/// Path defines parameters used to modify the path of the incoming request.
/// The modified path is then used to construct the `Location` header. When
/// empty, the request path is used as-is.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesFiltersRequestRedirectPathType {
ReplaceFullPath,
ReplacePrefixMatch,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesFiltersRequestRedirectScheme {
#[serde(rename = "http")]
Http,
#[serde(rename = "https")]
Https,
}
/// RequestRedirect defines a schema for a filter that responds to the
/// request with an HTTP redirection.
///
/// Support: Core
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesFiltersRequestRedirectStatusCode {
#[serde(rename = "301")]
r#_301,
#[serde(rename = "302")]
r#_302,
}
/// ResponseHeaderModifier defines a schema for a filter that modifies response
/// headers.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersResponseHeaderModifier {
/// Add adds the given header(s) (name, value) to the request
/// before the action. It appends to any existing values associated
/// with the header name.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// add:
/// - name: "my-header"
/// value: "bar,baz"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: foo,bar,baz
#[serde(default, skip_serializing_if = "Option::is_none")]
pub add: Option<Vec<HTTPRouteRulesFiltersResponseHeaderModifierAdd>>,
/// Remove the given header(s) from the HTTP request before the action. The
/// value of Remove is a list of HTTP header names. Note that the header
/// names are case-insensitive (see
/// https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header1: foo
/// my-header2: bar
/// my-header3: baz
///
/// Config:
/// remove: ["my-header1", "my-header3"]
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header2: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub remove: Option<Vec<String>>,
/// Set overwrites the request with the given header (name, value)
/// before the action.
///
/// Input:
/// GET /foo HTTP/1.1
/// my-header: foo
///
/// Config:
/// set:
/// - name: "my-header"
/// value: "bar"
///
/// Output:
/// GET /foo HTTP/1.1
/// my-header: bar
#[serde(default, skip_serializing_if = "Option::is_none")]
pub set: Option<Vec<HTTPRouteRulesFiltersResponseHeaderModifierSet>>,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersResponseHeaderModifierAdd {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersResponseHeaderModifierSet {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, the first entry with
/// an equivalent name MUST be considered for a match. Subsequent entries
/// with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
pub name: String,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPRouteFilter defines processing steps that must be completed during the
/// request or response lifecycle. HTTPRouteFilters are meant as an extension
/// point to express processing that may be done in Gateway implementations. Some
/// examples include request or response modification, implementing
/// authentication strategies, rate-limiting, and traffic shaping. API
/// guarantee/conformance is defined based on the type of the filter.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesFiltersType {
RequestHeaderModifier,
ResponseHeaderModifier,
RequestMirror,
RequestRedirect,
#[serde(rename = "URLRewrite")]
UrlRewrite,
ExtensionRef,
}
/// URLRewrite defines a schema for a filter that modifies a request during forwarding.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersUrlRewrite {
/// Hostname is the value to be used to replace the Host header value during
/// forwarding.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hostname: Option<String>,
/// Path defines a path rewrite.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<HTTPRouteRulesFiltersUrlRewritePath>,
}
/// Path defines a path rewrite.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesFiltersUrlRewritePath {
/// ReplaceFullPath specifies the value with which to replace the full path
/// of a request during a rewrite or redirect.
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replaceFullPath"
)]
pub replace_full_path: Option<String>,
/// ReplacePrefixMatch specifies the value with which to replace the prefix
/// match of a request during a rewrite or redirect. For example, a request
/// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch
/// of "/xyz" would be modified to "/xyz/bar".
///
/// Note that this matches the behavior of the PathPrefix match type. This
/// matches full path elements. A path element refers to the list of labels
/// in the path split by the `/` separator. When specified, a trailing `/` is
/// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all
/// match the prefix `/abc`, but the path `/abcd` would not.
///
/// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch.
/// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
/// the implementation setting the Accepted Condition for the Route to `status: False`.
///
/// Request Path | Prefix Match | Replace Prefix | Modified Path
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "replacePrefixMatch"
)]
pub replace_prefix_match: Option<String>,
/// Type defines the type of path modifier. Additional types may be
/// added in a future release of the API.
///
/// Note that values may be added to this enum, implementations
/// must ensure that unknown values will not cause a crash.
///
/// Unknown values here must result in the implementation setting the
/// Accepted Condition for the Route to `status: False`, with a
/// Reason of `UnsupportedValue`.
#[serde(rename = "type")]
pub r#type: HTTPRouteRulesFiltersUrlRewritePathType,
}
/// Path defines a path rewrite.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesFiltersUrlRewritePathType {
ReplaceFullPath,
ReplacePrefixMatch,
}
/// HTTPRouteMatch defines the predicate used to match requests to a given
/// action. Multiple match types are ANDed together, i.e. the match will
/// evaluate to true only if all conditions are satisfied.
///
/// For example, the match below will match a HTTP request only if its path
/// starts with `/foo` AND it contains the `version: v1` header:
///
/// ```text
/// match:
///
/// path:
/// value: "/foo"
/// headers:
/// - name: "version"
/// value "v1"
///
/// ```
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesMatches {
/// Headers specifies HTTP request header matchers. Multiple match values are
/// ANDed together, meaning, a request must match all the specified headers
/// to select the route.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub headers: Option<Vec<HTTPRouteRulesMatchesHeaders>>,
/// Method specifies HTTP method matcher.
/// When specified, this route will be matched only if the request has the
/// specified method.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub method: Option<HTTPRouteRulesMatchesMethod>,
/// Path specifies a HTTP request path matcher. If this field is not
/// specified, a default prefix match on the "/" path is provided.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<HTTPRouteRulesMatchesPath>,
/// QueryParams specifies HTTP query parameter matchers. Multiple match
/// values are ANDed together, meaning, a request must match all the
/// specified query parameters to select the route.
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "queryParams"
)]
pub query_params: Option<Vec<HTTPRouteRulesMatchesQueryParams>>,
}
/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request
/// headers.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesMatchesHeaders {
/// Name is the name of the HTTP Header to be matched. Name matching MUST be
/// case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
///
/// If multiple entries specify equivalent header names, only the first
/// entry with an equivalent name MUST be considered for a match. Subsequent
/// entries with an equivalent header name MUST be ignored. Due to the
/// case-insensitivity of header names, "foo" and "Foo" are considered
/// equivalent.
///
/// When a header is repeated in an HTTP request, it is
/// implementation-specific behavior as to how this is represented.
/// Generally, proxies should follow the guidance from the RFC:
/// https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding
/// processing a repeated header, with special handling for "Set-Cookie".
pub name: String,
/// Type specifies how to match against the value of the header.
///
/// Support: Core (Exact)
///
/// Support: Implementation-specific (RegularExpression)
///
/// Since RegularExpression HeaderMatchType has implementation-specific
/// conformance, implementations can support POSIX, PCRE or any other dialects
/// of regular expressions. Please read the implementation's documentation to
/// determine the supported dialect.
#[serde(default, skip_serializing_if = "Option::is_none", rename = "type")]
pub r#type: Option<HTTPRouteRulesMatchesHeadersType>,
/// Value is the value of HTTP Header to be matched.
pub value: String,
}
/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request
/// headers.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesMatchesHeadersType {
Exact,
RegularExpression,
}
/// HTTPRouteMatch defines the predicate used to match requests to a given
/// action. Multiple match types are ANDed together, i.e. the match will
/// evaluate to true only if all conditions are satisfied.
///
/// For example, the match below will match a HTTP request only if its path
/// starts with `/foo` AND it contains the `version: v1` header:
///
/// ```text
/// match:
///
/// path:
/// value: "/foo"
/// headers:
/// - name: "version"
/// value "v1"
///
/// ```
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesMatchesMethod {
#[serde(rename = "GET")]
Get,
#[serde(rename = "HEAD")]
Head,
#[serde(rename = "POST")]
Post,
#[serde(rename = "PUT")]
Put,
#[serde(rename = "DELETE")]
Delete,
#[serde(rename = "CONNECT")]
Connect,
#[serde(rename = "OPTIONS")]
Options,
#[serde(rename = "TRACE")]
Trace,
#[serde(rename = "PATCH")]
Patch,
}
/// Path specifies a HTTP request path matcher. If this field is not
/// specified, a default prefix match on the "/" path is provided.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesMatchesPath {
/// Type specifies how to match against the path Value.
///
/// Support: Core (Exact, PathPrefix)
///
/// Support: Implementation-specific (RegularExpression)
#[serde(default, skip_serializing_if = "Option::is_none", rename = "type")]
pub r#type: Option<HTTPRouteRulesMatchesPathType>,
/// Value of the HTTP path to match against.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub value: Option<String>,
}
/// Path specifies a HTTP request path matcher. If this field is not
/// specified, a default prefix match on the "/" path is provided.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesMatchesPathType {
Exact,
PathPrefix,
RegularExpression,
}
/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP
/// query parameters.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesMatchesQueryParams {
/// Name is the name of the HTTP query param to be matched. This must be an
/// exact string match. (See
/// https://tools.ietf.org/html/rfc7230#section-2.7.3).
///
/// If multiple entries specify equivalent query param names, only the first
/// entry with an equivalent name MUST be considered for a match. Subsequent
/// entries with an equivalent query param name MUST be ignored.
///
/// If a query param is repeated in an HTTP request, the behavior is
/// purposely left undefined, since different data planes have different
/// capabilities. However, it is *recommended* that implementations should
/// match against the first value of the param if the data plane supports it,
/// as this behavior is expected in other load balancing contexts outside of
/// the Gateway API.
///
/// Users SHOULD NOT route traffic based on repeated query params to guard
/// themselves against potential differences in the implementations.
pub name: String,
/// Type specifies how to match against the value of the query parameter.
///
/// Support: Extended (Exact)
///
/// Support: Implementation-specific (RegularExpression)
///
/// Since RegularExpression QueryParamMatchType has Implementation-specific
/// conformance, implementations can support POSIX, PCRE or any other
/// dialects of regular expressions. Please read the implementation's
/// documentation to determine the supported dialect.
#[serde(default, skip_serializing_if = "Option::is_none", rename = "type")]
pub r#type: Option<HTTPRouteRulesMatchesQueryParamsType>,
/// Value is the value of HTTP query param to be matched.
pub value: String,
}
/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP
/// query parameters.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, PartialEq)]
pub enum HTTPRouteRulesMatchesQueryParamsType {
Exact,
RegularExpression,
}
/// Timeouts defines the timeouts that can be configured for an HTTP request.
///
/// Support: Extended
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteRulesTimeouts {
/// BackendRequest specifies a timeout for an individual request from the gateway
/// to a backend. This covers the time from when the request first starts being
/// sent from the gateway to when the full response has been received from the backend.
///
/// Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout
/// completely. Implementations that cannot completely disable the timeout MUST
/// instead interpret the zero duration as the longest possible value to which
/// the timeout can be set.
///
/// An entire client HTTP transaction with a gateway, covered by the Request timeout,
/// may result in more than one call from the gateway to the destination backend,
/// for example, if automatic retries are supported.
///
/// The value of BackendRequest must be a Gateway API Duration string as defined by
/// GEP-2257. When this field is unspecified, its behavior is implementation-specific;
/// when specified, the value of BackendRequest must be no more than the value of the
/// Request timeout (since the Request timeout encompasses the BackendRequest timeout).
///
/// Support: Extended
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "backendRequest"
)]
pub backend_request: Option<String>,
/// Request specifies the maximum duration for a gateway to respond to an HTTP request.
/// If the gateway has not been able to respond before this deadline is met, the gateway
/// MUST return a timeout error.
///
/// For example, setting the `rules.timeouts.request` field to the value `10s` in an
/// `HTTPRoute` will cause a timeout if a client request is taking longer than 10 seconds
/// to complete.
///
/// Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout
/// completely. Implementations that cannot completely disable the timeout MUST
/// instead interpret the zero duration as the longest possible value to which
/// the timeout can be set.
///
/// This timeout is intended to cover as close to the whole request-response transaction
/// as possible although an implementation MAY choose to start the timeout after the entire
/// request stream has been received instead of immediately after the transaction is
/// initiated by the client.
///
/// The value of Request is a Gateway API Duration string as defined by GEP-2257. When this
/// field is unspecified, request timeout behavior is implementation-specific.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub request: Option<String>,
}
/// Status defines the current state of HTTPRoute.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteStatus {
/// Parents is a list of parent resources (usually Gateways) that are
/// associated with the route, and the status of the route with respect to
/// each parent. When this route attaches to a parent, the controller that
/// manages the parent must add an entry to this list when the controller
/// first sees the route and should update the entry as appropriate when the
/// route or gateway is modified.
///
/// Note that parent references that cannot be resolved by an implementation
/// of this API will not be added to this list. Implementations of this API
/// can only populate Route status for the Gateways/parent resources they are
/// responsible for.
///
/// A maximum of 32 Gateways will be represented in this list. An empty list
/// means the route has not been attached to any Gateway.
pub parents: Vec<HTTPRouteStatusParents>,
}
/// RouteParentStatus describes the status of a route with respect to an
/// associated Parent.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteStatusParents {
/// Conditions describes the status of the route with respect to the Gateway.
/// Note that the route's availability is also subject to the Gateway's own
/// status conditions and listener status.
///
/// If the Route's ParentRef specifies an existing Gateway that supports
/// Routes of this kind AND that Gateway's controller has sufficient access,
/// then that Gateway's controller MUST set the "Accepted" condition on the
/// Route, to indicate whether the route has been accepted or rejected by the
/// Gateway, and why.
///
/// A Route MUST be considered "Accepted" if at least one of the Route's
/// rules is implemented by the Gateway.
///
/// There are a number of cases where the "Accepted" condition may not be set
/// due to lack of controller visibility, that includes when:
///
/// * The Route refers to a non-existent parent.
/// * The Route is of a type that the controller does not support.
/// * The Route is in a namespace the controller does not have access to.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub conditions: Option<Vec<Condition>>,
/// ControllerName is a domain/path string that indicates the name of the
/// controller that wrote this status. This corresponds with the
/// controllerName field on GatewayClass.
///
/// Example: "example.net/gateway-controller".
///
/// The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are
/// valid Kubernetes names
/// (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
///
/// Controllers MUST populate this field when writing status. Controllers should ensure that
/// entries to status populated with their ControllerName are cleaned up when they are no
/// longer necessary.
#[serde(rename = "controllerName")]
pub controller_name: String,
/// ParentRef corresponds with a ParentRef in the spec that this
/// RouteParentStatus struct describes the status of.
#[serde(rename = "parentRef")]
pub parent_ref: HTTPRouteStatusParentsParentRef,
}
/// ParentRef corresponds with a ParentRef in the spec that this
/// RouteParentStatus struct describes the status of.
#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default, PartialEq)]
pub struct HTTPRouteStatusParentsParentRef {
/// Group is the group of the referent.
/// When unspecified, "gateway.networking.k8s.io" is inferred.
/// To set the core API group (such as for a "Service" kind referent),
/// Group must be explicitly set to "" (empty string).
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<String>,
/// Kind is kind of the referent.
///
/// There are two kinds of parent resources with "Core" support:
///
/// * Gateway (Gateway conformance profile)
/// * Service (Mesh conformance profile, ClusterIP Services only)
///
/// Support for other resources is Implementation-Specific.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub kind: Option<String>,
/// Name is the name of the referent.
///
/// Support: Core
pub name: String,
/// Namespace is the namespace of the referent. When unspecified, this refers
/// to the local namespace of the Route.
///
/// Note that there are specific rules for ParentRefs which cross namespace
/// boundaries. Cross-namespace references are only valid if they are explicitly
/// allowed by something in the namespace they are referring to. For example:
/// Gateway has the AllowedRoutes field, and ReferenceGrant provides a
/// generic way to enable any other kind of cross-namespace reference.
///
///
///
/// Support: Core
#[serde(default, skip_serializing_if = "Option::is_none")]
pub namespace: Option<String>,
/// Port is the network port this Route targets. It can be interpreted
/// differently based on the type of parent resource.
///
/// When the parent resource is a Gateway, this targets all listeners
/// listening on the specified port that also support this kind of Route(and
/// select this Route). It's not recommended to set `Port` unless the
/// networking behaviors specified in a Route must apply to a specific port
/// as opposed to a listener(s) whose port(s) may be changed. When both Port
/// and SectionName are specified, the name and port of the selected listener
/// must match both specified values.
///
///
///
/// Implementations MAY choose to support other parent resources.
/// Implementations supporting other types of parent resources MUST clearly
/// document how/if Port is interpreted.
///
/// For the purpose of status, an attachment is considered successful as
/// long as the parent resource accepts it partially. For example, Gateway
/// listeners can restrict which Routes can attach to them by Route kind,
/// namespace, or hostname. If 1 of 2 Gateway listeners accept attachment
/// from the referencing Route, the Route MUST be considered successfully
/// attached. If no Gateway listeners accept attachment from this Route,
/// the Route MUST be considered detached from the Gateway.
///
/// Support: Extended
#[serde(default, skip_serializing_if = "Option::is_none")]
pub port: Option<i32>,
/// SectionName is the name of a section within the target resource. In the
/// following resources, SectionName is interpreted as the following:
///
/// * Gateway: Listener name. When both Port (experimental) and SectionName
/// are specified, the name and port of the selected listener must match
/// both specified values.
/// * Service: Port name. When both Port (experimental) and SectionName
/// are specified, the name and port of the selected listener must match
/// both specified values.
///
/// Implementations MAY choose to support attaching Routes to other resources.
/// If that is the case, they MUST clearly document how SectionName is
/// interpreted.
///
/// When unspecified (empty string), this will reference the entire resource.
/// For the purpose of status, an attachment is considered successful if at
/// least one section in the parent resource accepts it. For example, Gateway
/// listeners can restrict which Routes can attach to them by Route kind,
/// namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from
/// the referencing Route, the Route MUST be considered successfully
/// attached. If no Gateway listeners accept attachment from this Route, the
/// Route MUST be considered detached from the Gateway.
///
/// Support: Core
#[serde(
default,
skip_serializing_if = "Option::is_none",
rename = "sectionName"
)]
pub section_name: Option<String>,
}