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 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="gkehub_v1beta.html">GKE Hub API</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.features.html">features</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a new Feature.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a Feature.</p>
<p class="toc_element">
<code><a href="#get">get(name, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Feature.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Features in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing Feature.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code>
<pre>Adds a new Feature.
Args:
parent: string, Required. The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Feature represents the settings and status of any Fleet Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
"labels": { # Labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"cloudbuild": { # **Cloud Build**: Configurations for each Cloud Build enabled cluster. # Cloud Build-specific spec
"securityPolicy": "A String", # Whether it is allowed to run the privileged builds on the cluster or not.
"version": "A String", # Version of the cloud build software on the cluster.
},
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"fleetobservability": { # **FleetObservability**: The membership-specific input for FleetObservability feature. # Fleet observability membership spec
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly.
"type": "A String", # Type specifies which type of origin is set.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # Per-membership state for this feature. # ClusterUpgrade state.
"ignored": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default. # Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
"upgrades": [ # Actual upgrade state against desired.
{ # ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
"binauthzState": { # State for Binauthz # Output only. Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # Output only. This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name.
"configSyncState": { # State information for ConfigSync # Output only. Current sync status
"clusterLevelStopSyncingState": "A String", # Output only. Whether syncing resources to the cluster is stopped at the cluster level.
"crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster.
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Output only. Information about the deployment of ConfigSync, including the version of the various Pods deployed
"admissionWebhook": "A String", # Deployment state of admission-webhook
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"otelCollector": "A String", # Deployment state of otel-collector
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"errors": [ # Output only. Errors pertaining to the installation of Config Sync.
{ # Errors pertaining to the installation of Config Sync
"errorMessage": "A String", # A string representing the user facing error message
},
],
"reposyncCrd": "A String", # Output only. The state of the Reposync CRD
"rootsyncCrd": "A String", # Output only. The state of the RootSync CRD
"state": "A String", # Output only. The state of CS This field summarizes the other fields in this message.
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # Output only. The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # Output only. The version of ConfigSync deployed
"admissionWebhook": "A String", # Version of the deployed admission-webhook pod
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"otelCollector": "A String", # Version of the deployed otel-collector pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Output only. Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Output only. Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # Output only. PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.
},
"migration": { # State for the migration of PolicyController from ACM -> PoCo Hub. # Record state of ACM -> PoCo Hub migration for this feature.
"copyTime": "A String", # Last time this membership spec was copied to PoCo feature.
"stage": "A String", # Stage of the migration.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"fleetobservability": { # **FleetObservability**: Membership-specific Feature state for fleetobservability. # Fleet observability membership state.
},
"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
"failureReason": "A String", # The reason of the failure.
"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"state": "A String", # Deployment state on this member
},
"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific state.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"policycontroller": { # **Policy Controller**: State for a single cluster. # Policycontroller-specific state.
"componentStates": { # Currently these include (also serving as map keys): 1. "admission" 2. "audit" 3. "mutation"
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"policyContentState": { # The state of the policy controller policy content # The overall content state observed by the Hub Feature controller.
"bundleStates": { # The state of the any bundles included in the chosen version of the manifest
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"referentialSyncConfigState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the referential data sync configuration. This could represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
"templateLibraryState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the template library
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"state": "A String", # The overall Policy Controller lifecycle state observed by the Hub Feature controller.
},
"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.
"conditions": [ # Output only. List of conditions reported for this membership.
{ # Condition being reported.
"code": "A String", # Unique identifier of the condition which describes the condition recognizable to the user.
"details": "A String", # A short summary about the issue.
"documentationLink": "A String", # Links contains actionable information.
"severity": "A String", # Severity level of the condition.
},
],
"controlPlaneManagement": { # Status of control plane management. # Output only. Status of control plane management
"details": [ # Explanation of state.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"implementation": "A String", # Output only. Implementation of managed control plane.
"state": "A String", # LifecycleState of control plane management.
},
"dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management.
"details": [ # Explanation of the status.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # Lifecycle status of data plane management.
},
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # ScopeFeatureSpec contains feature specs for a fleet scope.
},
},
"scopeStates": { # Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.
"a_key": { # ScopeFeatureState contains Scope-wide Feature status information.
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Scope.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused.
"appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec.
},
"clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec.
"gkeUpgradeOverrides": [ # Allow users to override some properties of each GKE upgrade.
{ # Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to override for the specified upgrade (name + version). Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Required. Which upgrade to override. Required.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upstreamFleets": [ # This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
"A String",
],
},
"dataplanev2": { # **Dataplane V2**: Spec # DataplaneV2 feature spec.
"enableEncryption": True or False, # Enable dataplane-v2 based encryption for multiple clusters.
},
"fleetobservability": { # **Fleet Observability**: The Hub-wide input for the FleetObservability feature. # FleetObservability feature spec.
"loggingConfig": { # LoggingConfig defines the configuration for different types of logs. # Specified if fleet logging feature is enabled for the entire fleet. If UNSPECIFIED, fleet logging feature is disabled for the entire fleet.
"defaultConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the default routing config to logs not specified in other configs.
"mode": "A String", # mode configures the logs routing mode.
},
"fleetScopeLogsConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the routing config to all logs for all fleet scopes.
"mode": "A String", # mode configures the logs routing mode.
},
},
},
"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. # RBAC Role Binding Actuation feature spec
"allowedCustomRoles": [ # The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.
"A String",
],
},
},
"state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade feature. # ClusterUpgrade fleet-level state.
"downstreamFleets": [ # This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
"A String",
],
"gkeState": { # GKEUpgradeFeatureState contains feature states for GKE clusters in the scope. # Feature state for GKE clusters.
"conditions": [ # Current conditions of the feature.
{ # GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.
"reason": "A String", # Reason why the feature is in this status.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # Type of the condition, for example, "ready".
"updateTime": "A String", # Last timestamp the condition was updated.
},
],
"upgradeState": [ # Upgrade state. It will eventually replace `state`.
{ # GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.
"stats": { # Number of GKE clusters in each status code.
"a_key": "A String",
},
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"ignored": { # A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: `projects/{p}/locations/{l}/membership/{m}`.
"a_key": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
},
},
"fleetobservability": { # **FleetObservability**: Hub-wide Feature for FleetObservability feature. state. # FleetObservability feature state.
"logging": { # Feature state for logging feature. # The feature state of default logging.
"defaultLog": { # Base state for fleet observability feature. # The base feature state of fleet default log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
"scopeLog": { # Base state for fleet observability feature. # The base feature state of fleet scope log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
"monitoring": { # Feature state for monitoring feature. # The feature state of fleet monitoring.
"state": { # Base state for fleet observability feature. # The base feature state of fleet monitoring feature.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. # RBAC Role Binding Actuation feature state
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"unreachable": [ # Output only. List of locations that could not be reached while fetching this feature.
"A String",
],
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}
featureId: string, The ID of the feature to create.
requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
<pre>Removes a Feature.
Args:
name: string, Required. The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
force: boolean, If set to true, the delete will ignore any outstanding resources for this Feature (that is, `FeatureState.has_resources` is set to true). These resources will NOT be cleaned up or modified in any way.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Gets details of a single Feature.
Args:
name: string, Required. The Feature resource name in the format `projects/*/locations/*/features/*` (required)
returnPartialSuccess: boolean, Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Feature represents the settings and status of any Fleet Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
"labels": { # Labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"cloudbuild": { # **Cloud Build**: Configurations for each Cloud Build enabled cluster. # Cloud Build-specific spec
"securityPolicy": "A String", # Whether it is allowed to run the privileged builds on the cluster or not.
"version": "A String", # Version of the cloud build software on the cluster.
},
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"fleetobservability": { # **FleetObservability**: The membership-specific input for FleetObservability feature. # Fleet observability membership spec
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly.
"type": "A String", # Type specifies which type of origin is set.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # Per-membership state for this feature. # ClusterUpgrade state.
"ignored": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default. # Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
"upgrades": [ # Actual upgrade state against desired.
{ # ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
"binauthzState": { # State for Binauthz # Output only. Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # Output only. This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name.
"configSyncState": { # State information for ConfigSync # Output only. Current sync status
"clusterLevelStopSyncingState": "A String", # Output only. Whether syncing resources to the cluster is stopped at the cluster level.
"crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster.
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Output only. Information about the deployment of ConfigSync, including the version of the various Pods deployed
"admissionWebhook": "A String", # Deployment state of admission-webhook
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"otelCollector": "A String", # Deployment state of otel-collector
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"errors": [ # Output only. Errors pertaining to the installation of Config Sync.
{ # Errors pertaining to the installation of Config Sync
"errorMessage": "A String", # A string representing the user facing error message
},
],
"reposyncCrd": "A String", # Output only. The state of the Reposync CRD
"rootsyncCrd": "A String", # Output only. The state of the RootSync CRD
"state": "A String", # Output only. The state of CS This field summarizes the other fields in this message.
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # Output only. The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # Output only. The version of ConfigSync deployed
"admissionWebhook": "A String", # Version of the deployed admission-webhook pod
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"otelCollector": "A String", # Version of the deployed otel-collector pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Output only. Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Output only. Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # Output only. PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.
},
"migration": { # State for the migration of PolicyController from ACM -> PoCo Hub. # Record state of ACM -> PoCo Hub migration for this feature.
"copyTime": "A String", # Last time this membership spec was copied to PoCo feature.
"stage": "A String", # Stage of the migration.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"fleetobservability": { # **FleetObservability**: Membership-specific Feature state for fleetobservability. # Fleet observability membership state.
},
"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
"failureReason": "A String", # The reason of the failure.
"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"state": "A String", # Deployment state on this member
},
"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific state.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"policycontroller": { # **Policy Controller**: State for a single cluster. # Policycontroller-specific state.
"componentStates": { # Currently these include (also serving as map keys): 1. "admission" 2. "audit" 3. "mutation"
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"policyContentState": { # The state of the policy controller policy content # The overall content state observed by the Hub Feature controller.
"bundleStates": { # The state of the any bundles included in the chosen version of the manifest
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"referentialSyncConfigState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the referential data sync configuration. This could represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
"templateLibraryState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the template library
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"state": "A String", # The overall Policy Controller lifecycle state observed by the Hub Feature controller.
},
"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.
"conditions": [ # Output only. List of conditions reported for this membership.
{ # Condition being reported.
"code": "A String", # Unique identifier of the condition which describes the condition recognizable to the user.
"details": "A String", # A short summary about the issue.
"documentationLink": "A String", # Links contains actionable information.
"severity": "A String", # Severity level of the condition.
},
],
"controlPlaneManagement": { # Status of control plane management. # Output only. Status of control plane management
"details": [ # Explanation of state.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"implementation": "A String", # Output only. Implementation of managed control plane.
"state": "A String", # LifecycleState of control plane management.
},
"dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management.
"details": [ # Explanation of the status.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # Lifecycle status of data plane management.
},
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # ScopeFeatureSpec contains feature specs for a fleet scope.
},
},
"scopeStates": { # Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.
"a_key": { # ScopeFeatureState contains Scope-wide Feature status information.
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Scope.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused.
"appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec.
},
"clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec.
"gkeUpgradeOverrides": [ # Allow users to override some properties of each GKE upgrade.
{ # Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to override for the specified upgrade (name + version). Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Required. Which upgrade to override. Required.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upstreamFleets": [ # This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
"A String",
],
},
"dataplanev2": { # **Dataplane V2**: Spec # DataplaneV2 feature spec.
"enableEncryption": True or False, # Enable dataplane-v2 based encryption for multiple clusters.
},
"fleetobservability": { # **Fleet Observability**: The Hub-wide input for the FleetObservability feature. # FleetObservability feature spec.
"loggingConfig": { # LoggingConfig defines the configuration for different types of logs. # Specified if fleet logging feature is enabled for the entire fleet. If UNSPECIFIED, fleet logging feature is disabled for the entire fleet.
"defaultConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the default routing config to logs not specified in other configs.
"mode": "A String", # mode configures the logs routing mode.
},
"fleetScopeLogsConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the routing config to all logs for all fleet scopes.
"mode": "A String", # mode configures the logs routing mode.
},
},
},
"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. # RBAC Role Binding Actuation feature spec
"allowedCustomRoles": [ # The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.
"A String",
],
},
},
"state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade feature. # ClusterUpgrade fleet-level state.
"downstreamFleets": [ # This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
"A String",
],
"gkeState": { # GKEUpgradeFeatureState contains feature states for GKE clusters in the scope. # Feature state for GKE clusters.
"conditions": [ # Current conditions of the feature.
{ # GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.
"reason": "A String", # Reason why the feature is in this status.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # Type of the condition, for example, "ready".
"updateTime": "A String", # Last timestamp the condition was updated.
},
],
"upgradeState": [ # Upgrade state. It will eventually replace `state`.
{ # GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.
"stats": { # Number of GKE clusters in each status code.
"a_key": "A String",
},
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"ignored": { # A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: `projects/{p}/locations/{l}/membership/{m}`.
"a_key": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
},
},
"fleetobservability": { # **FleetObservability**: Hub-wide Feature for FleetObservability feature. state. # FleetObservability feature state.
"logging": { # Feature state for logging feature. # The feature state of default logging.
"defaultLog": { # Base state for fleet observability feature. # The base feature state of fleet default log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
"scopeLog": { # Base state for fleet observability feature. # The base feature state of fleet scope log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
"monitoring": { # Feature state for monitoring feature. # The feature state of fleet monitoring.
"state": { # Base state for fleet observability feature. # The base feature state of fleet monitoring feature.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. # RBAC Role Binding Actuation feature state
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"unreachable": [ # Output only. List of locations that could not be reached while fetching this feature.
"A String",
],
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Lists Features in a given project and location.
Args:
parent: string, Required. The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required)
filter: string, Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar
orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
pageSize: integer, When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
returnPartialSuccess: boolean, Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `GkeHub.ListFeatures` method.
"nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return.
"resources": [ # The list of matching Features
{ # Feature represents the settings and status of any Fleet Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
"labels": { # Labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"cloudbuild": { # **Cloud Build**: Configurations for each Cloud Build enabled cluster. # Cloud Build-specific spec
"securityPolicy": "A String", # Whether it is allowed to run the privileged builds on the cluster or not.
"version": "A String", # Version of the cloud build software on the cluster.
},
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"fleetobservability": { # **FleetObservability**: The membership-specific input for FleetObservability feature. # Fleet observability membership spec
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly.
"type": "A String", # Type specifies which type of origin is set.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # Per-membership state for this feature. # ClusterUpgrade state.
"ignored": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default. # Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
"upgrades": [ # Actual upgrade state against desired.
{ # ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
"binauthzState": { # State for Binauthz # Output only. Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # Output only. This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name.
"configSyncState": { # State information for ConfigSync # Output only. Current sync status
"clusterLevelStopSyncingState": "A String", # Output only. Whether syncing resources to the cluster is stopped at the cluster level.
"crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster.
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Output only. Information about the deployment of ConfigSync, including the version of the various Pods deployed
"admissionWebhook": "A String", # Deployment state of admission-webhook
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"otelCollector": "A String", # Deployment state of otel-collector
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"errors": [ # Output only. Errors pertaining to the installation of Config Sync.
{ # Errors pertaining to the installation of Config Sync
"errorMessage": "A String", # A string representing the user facing error message
},
],
"reposyncCrd": "A String", # Output only. The state of the Reposync CRD
"rootsyncCrd": "A String", # Output only. The state of the RootSync CRD
"state": "A String", # Output only. The state of CS This field summarizes the other fields in this message.
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # Output only. The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # Output only. The version of ConfigSync deployed
"admissionWebhook": "A String", # Version of the deployed admission-webhook pod
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"otelCollector": "A String", # Version of the deployed otel-collector pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Output only. Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Output only. Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # Output only. PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.
},
"migration": { # State for the migration of PolicyController from ACM -> PoCo Hub. # Record state of ACM -> PoCo Hub migration for this feature.
"copyTime": "A String", # Last time this membership spec was copied to PoCo feature.
"stage": "A String", # Stage of the migration.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"fleetobservability": { # **FleetObservability**: Membership-specific Feature state for fleetobservability. # Fleet observability membership state.
},
"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
"failureReason": "A String", # The reason of the failure.
"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"state": "A String", # Deployment state on this member
},
"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific state.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"policycontroller": { # **Policy Controller**: State for a single cluster. # Policycontroller-specific state.
"componentStates": { # Currently these include (also serving as map keys): 1. "admission" 2. "audit" 3. "mutation"
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"policyContentState": { # The state of the policy controller policy content # The overall content state observed by the Hub Feature controller.
"bundleStates": { # The state of the any bundles included in the chosen version of the manifest
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"referentialSyncConfigState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the referential data sync configuration. This could represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
"templateLibraryState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the template library
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"state": "A String", # The overall Policy Controller lifecycle state observed by the Hub Feature controller.
},
"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.
"conditions": [ # Output only. List of conditions reported for this membership.
{ # Condition being reported.
"code": "A String", # Unique identifier of the condition which describes the condition recognizable to the user.
"details": "A String", # A short summary about the issue.
"documentationLink": "A String", # Links contains actionable information.
"severity": "A String", # Severity level of the condition.
},
],
"controlPlaneManagement": { # Status of control plane management. # Output only. Status of control plane management
"details": [ # Explanation of state.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"implementation": "A String", # Output only. Implementation of managed control plane.
"state": "A String", # LifecycleState of control plane management.
},
"dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management.
"details": [ # Explanation of the status.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # Lifecycle status of data plane management.
},
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # ScopeFeatureSpec contains feature specs for a fleet scope.
},
},
"scopeStates": { # Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.
"a_key": { # ScopeFeatureState contains Scope-wide Feature status information.
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Scope.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused.
"appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec.
},
"clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec.
"gkeUpgradeOverrides": [ # Allow users to override some properties of each GKE upgrade.
{ # Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to override for the specified upgrade (name + version). Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Required. Which upgrade to override. Required.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upstreamFleets": [ # This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
"A String",
],
},
"dataplanev2": { # **Dataplane V2**: Spec # DataplaneV2 feature spec.
"enableEncryption": True or False, # Enable dataplane-v2 based encryption for multiple clusters.
},
"fleetobservability": { # **Fleet Observability**: The Hub-wide input for the FleetObservability feature. # FleetObservability feature spec.
"loggingConfig": { # LoggingConfig defines the configuration for different types of logs. # Specified if fleet logging feature is enabled for the entire fleet. If UNSPECIFIED, fleet logging feature is disabled for the entire fleet.
"defaultConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the default routing config to logs not specified in other configs.
"mode": "A String", # mode configures the logs routing mode.
},
"fleetScopeLogsConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the routing config to all logs for all fleet scopes.
"mode": "A String", # mode configures the logs routing mode.
},
},
},
"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. # RBAC Role Binding Actuation feature spec
"allowedCustomRoles": [ # The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.
"A String",
],
},
},
"state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade feature. # ClusterUpgrade fleet-level state.
"downstreamFleets": [ # This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
"A String",
],
"gkeState": { # GKEUpgradeFeatureState contains feature states for GKE clusters in the scope. # Feature state for GKE clusters.
"conditions": [ # Current conditions of the feature.
{ # GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.
"reason": "A String", # Reason why the feature is in this status.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # Type of the condition, for example, "ready".
"updateTime": "A String", # Last timestamp the condition was updated.
},
],
"upgradeState": [ # Upgrade state. It will eventually replace `state`.
{ # GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.
"stats": { # Number of GKE clusters in each status code.
"a_key": "A String",
},
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"ignored": { # A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: `projects/{p}/locations/{l}/membership/{m}`.
"a_key": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
},
},
"fleetobservability": { # **FleetObservability**: Hub-wide Feature for FleetObservability feature. state. # FleetObservability feature state.
"logging": { # Feature state for logging feature. # The feature state of default logging.
"defaultLog": { # Base state for fleet observability feature. # The base feature state of fleet default log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
"scopeLog": { # Base state for fleet observability feature. # The base feature state of fleet scope log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
"monitoring": { # Feature state for monitoring feature. # The feature state of fleet monitoring.
"state": { # Base state for fleet observability feature. # The base feature state of fleet monitoring feature.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. # RBAC Role Binding Actuation feature state
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"unreachable": [ # Output only. List of locations that could not be reached while fetching this feature.
"A String",
],
"updateTime": "A String", # Output only. When the Feature resource was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing Feature.
Args:
name: string, Required. The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Feature represents the settings and status of any Fleet Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
"labels": { # Labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"cloudbuild": { # **Cloud Build**: Configurations for each Cloud Build enabled cluster. # Cloud Build-specific spec
"securityPolicy": "A String", # Whether it is allowed to run the privileged builds on the cluster or not.
"version": "A String", # Version of the cloud build software on the cluster.
},
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"fleetobservability": { # **FleetObservability**: The membership-specific input for FleetObservability feature. # Fleet observability membership spec
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads.
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Optional. Enables automatic Service Mesh management.
},
"origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly.
"type": "A String", # Type specifies which type of origin is set.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # Per-membership state for this feature. # ClusterUpgrade state.
"ignored": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default. # Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
"upgrades": [ # Actual upgrade state against desired.
{ # ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
"binauthzState": { # State for Binauthz # Output only. Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # Output only. This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name.
"configSyncState": { # State information for ConfigSync # Output only. Current sync status
"clusterLevelStopSyncingState": "A String", # Output only. Whether syncing resources to the cluster is stopped at the cluster level.
"crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster.
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Output only. Information about the deployment of ConfigSync, including the version of the various Pods deployed
"admissionWebhook": "A String", # Deployment state of admission-webhook
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"otelCollector": "A String", # Deployment state of otel-collector
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"errors": [ # Output only. Errors pertaining to the installation of Config Sync.
{ # Errors pertaining to the installation of Config Sync
"errorMessage": "A String", # A string representing the user facing error message
},
],
"reposyncCrd": "A String", # Output only. The state of the Reposync CRD
"rootsyncCrd": "A String", # Output only. The state of the RootSync CRD
"state": "A String", # Output only. The state of CS This field summarizes the other fields in this message.
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # Output only. The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # Output only. The version of ConfigSync deployed
"admissionWebhook": "A String", # Version of the deployed admission-webhook pod
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"otelCollector": "A String", # Version of the deployed otel-collector pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Output only. Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Optional. Binauthz conifguration for the cluster. Deprecated: This field will be ignored and should not be set.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster.
"deploymentOverrides": [ # Optional. Configuration for deployment overrides.
{ # Configuration for a deployment override.
"containers": [ # Optional. The containers of the deployment resource to be overridden.
{ # Configuration for a container override.
"containerName": "A String", # Required. The name of the container.
"cpuLimit": "A String", # Optional. The cpu limit of the container.
"cpuRequest": "A String", # Optional. The cpu request of the container.
"memoryLimit": "A String", # Optional. The memory limit of the container.
"memoryRequest": "A String", # Optional. The memory request of the container.
},
],
"deploymentName": "A String", # Required. The name of the deployment resource to be overridden.
"deploymentNamespace": "A String", # Required. The namespace of the deployment resource to be overridden.
},
],
"enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.
"syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.
"syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"sourceFormat": "A String", # Optional. Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode.
"stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"management": "A String", # Optional. Enables automatic Feature management.
"policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Optional. Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Output only. Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # Output only. PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.
},
"migration": { # State for the migration of PolicyController from ACM -> PoCo Hub. # Record state of ACM -> PoCo Hub migration for this feature.
"copyTime": "A String", # Last time this membership spec was copied to PoCo feature.
"stage": "A String", # Stage of the migration.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"fleetobservability": { # **FleetObservability**: Membership-specific Feature state for fleetobservability. # Fleet observability membership state.
},
"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
"failureReason": "A String", # The reason of the failure.
"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
"identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options.
"diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface.
"enabled": True or False, # Determines whether to enable the diagnostic interface.
"expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.
},
"sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service.
},
},
"state": "A String", # Deployment state on this member
},
"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific state.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"policycontroller": { # **Policy Controller**: State for a single cluster. # Policycontroller-specific state.
"componentStates": { # Currently these include (also serving as map keys): 1. "admission" 2. "audit" 3. "mutation"
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"policyContentState": { # The state of the policy controller policy content # The overall content state observed by the Hub Feature controller.
"bundleStates": { # The state of the any bundles included in the chosen version of the manifest
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"referentialSyncConfigState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the referential data sync configuration. This could represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
"templateLibraryState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the template library
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"state": "A String", # The overall Policy Controller lifecycle state observed by the Hub Feature controller.
},
"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.
"conditions": [ # Output only. List of conditions reported for this membership.
{ # Condition being reported.
"code": "A String", # Unique identifier of the condition which describes the condition recognizable to the user.
"details": "A String", # A short summary about the issue.
"documentationLink": "A String", # Links contains actionable information.
"severity": "A String", # Severity level of the condition.
},
],
"controlPlaneManagement": { # Status of control plane management. # Output only. Status of control plane management
"details": [ # Explanation of state.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"implementation": "A String", # Output only. Implementation of managed control plane.
"state": "A String", # LifecycleState of control plane management.
},
"dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management.
"details": [ # Explanation of the status.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # Lifecycle status of data plane management.
},
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # ScopeFeatureSpec contains feature specs for a fleet scope.
},
},
"scopeStates": { # Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.
"a_key": { # ScopeFeatureState contains Scope-wide Feature status information.
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Scope.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused.
"appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec.
},
"clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec.
"gkeUpgradeOverrides": [ # Allow users to override some properties of each GKE upgrade.
{ # Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to override for the specified upgrade (name + version). Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Required. Which upgrade to override. Required.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upstreamFleets": [ # This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
"A String",
],
},
"dataplanev2": { # **Dataplane V2**: Spec # DataplaneV2 feature spec.
"enableEncryption": True or False, # Enable dataplane-v2 based encryption for multiple clusters.
},
"fleetobservability": { # **Fleet Observability**: The Hub-wide input for the FleetObservability feature. # FleetObservability feature spec.
"loggingConfig": { # LoggingConfig defines the configuration for different types of logs. # Specified if fleet logging feature is enabled for the entire fleet. If UNSPECIFIED, fleet logging feature is disabled for the entire fleet.
"defaultConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the default routing config to logs not specified in other configs.
"mode": "A String", # mode configures the logs routing mode.
},
"fleetScopeLogsConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the routing config to all logs for all fleet scopes.
"mode": "A String", # mode configures the logs routing mode.
},
},
},
"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. # RBAC Role Binding Actuation feature spec
"allowedCustomRoles": [ # The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.
"A String",
],
},
},
"state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade feature. # ClusterUpgrade fleet-level state.
"downstreamFleets": [ # This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
"A String",
],
"gkeState": { # GKEUpgradeFeatureState contains feature states for GKE clusters in the scope. # Feature state for GKE clusters.
"conditions": [ # Current conditions of the feature.
{ # GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.
"reason": "A String", # Reason why the feature is in this status.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # Type of the condition, for example, "ready".
"updateTime": "A String", # Last timestamp the condition was updated.
},
],
"upgradeState": [ # Upgrade state. It will eventually replace `state`.
{ # GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.
"stats": { # Number of GKE clusters in each status code.
"a_key": "A String",
},
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"ignored": { # A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: `projects/{p}/locations/{l}/membership/{m}`.
"a_key": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
},
},
"fleetobservability": { # **FleetObservability**: Hub-wide Feature for FleetObservability feature. state. # FleetObservability feature state.
"logging": { # Feature state for logging feature. # The feature state of default logging.
"defaultLog": { # Base state for fleet observability feature. # The base feature state of fleet default log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
"scopeLog": { # Base state for fleet observability feature. # The base feature state of fleet scope log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
"monitoring": { # Feature state for monitoring feature. # The feature state of fleet monitoring.
"state": { # Base state for fleet observability feature. # The base feature state of fleet monitoring feature.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
},
"rbacrolebindingactuation": { # **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. # RBAC Role Binding Actuation feature state
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"unreachable": [ # Output only. List of locations that could not be reached while fetching this feature.
"A String",
],
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}
requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Mask of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>
</div>
</body></html>
|