github.com/openshift-online/ocm-sdk-go@v0.1.473/openapi/clusters_mgmt/v1/openapi.json (about) 1 { 2 "openapi": "3.0.0", 3 "info": { 4 "version": "v1", 5 "title": "clusters_mgmt", 6 "license": { 7 "name": "Apache 2.0", 8 "url": "http://www.apache.org/licenses/LICENSE-2.0" 9 }, 10 "contact": { 11 "name": "OCM Feedback", 12 "email": "ocm-feedback@redhat.com" 13 } 14 }, 15 "servers": [ 16 { 17 "description": "Production", 18 "url": "https://api.openshift.com" 19 }, 20 { 21 "description": "Stage", 22 "url": "https://api.stage.openshift.com" 23 } 24 ], 25 "paths": { 26 "/api/clusters_mgmt/v1": { 27 "get": { 28 "description": "Retrieves the version metadata.", 29 "responses": { 30 "200": { 31 "description": "Success.", 32 "content": { 33 "application/json": { 34 "schema": { 35 "$ref": "#/components/schemas/Metadata" 36 } 37 } 38 } 39 }, 40 "default": { 41 "description": "Error.", 42 "content": { 43 "application/json": { 44 "schema": { 45 "$ref": "#/components/schemas/Error" 46 } 47 } 48 } 49 } 50 } 51 } 52 }, 53 "/api/clusters_mgmt/v1/addons": { 54 "post": { 55 "description": "Create a new add-on and add it to the collection of add-ons.", 56 "requestBody": { 57 "content": { 58 "application/json": { 59 "schema": { 60 "$ref": "#/components/schemas/AddOn" 61 } 62 } 63 } 64 }, 65 "responses": { 66 "201": { 67 "description": "Success.", 68 "content": { 69 "application/json": { 70 "schema": { 71 "$ref": "#/components/schemas/AddOn" 72 } 73 } 74 } 75 }, 76 "default": { 77 "description": "Error.", 78 "content": { 79 "application/json": { 80 "schema": { 81 "$ref": "#/components/schemas/Error" 82 } 83 } 84 } 85 } 86 } 87 }, 88 "get": { 89 "description": "Retrieves the list of add-ons.", 90 "parameters": [ 91 { 92 "name": "order", 93 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the add-on instead of\nthe names of the columns of a table. For example, in order to sort the add-ons\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 94 "in": "query", 95 "schema": { 96 "type": "string" 97 } 98 }, 99 { 100 "name": "page", 101 "description": "Index of the requested page, where one corresponds to the first page.", 102 "in": "query", 103 "schema": { 104 "type": "integer", 105 "format": "int32" 106 } 107 }, 108 { 109 "name": "search", 110 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the add-on instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nadd-ons with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the add-ons\nthat the user has permission to see will be returned.", 111 "in": "query", 112 "schema": { 113 "type": "string" 114 } 115 }, 116 { 117 "name": "size", 118 "description": "Maximum number of items that will be contained in the returned page.", 119 "in": "query", 120 "schema": { 121 "type": "integer", 122 "format": "int32" 123 } 124 } 125 ], 126 "responses": { 127 "200": { 128 "description": "Success.", 129 "content": { 130 "application/json": { 131 "schema": { 132 "type": "object", 133 "properties": { 134 "items": { 135 "description": "Retrieved list of add-ons.", 136 "type": "array", 137 "items": { 138 "$ref": "#/components/schemas/AddOn" 139 } 140 }, 141 "page": { 142 "description": "Index of the requested page, where one corresponds to the first page.", 143 "type": "integer", 144 "format": "int32" 145 }, 146 "size": { 147 "description": "Maximum number of items that will be contained in the returned page.", 148 "type": "integer", 149 "format": "int32" 150 }, 151 "total": { 152 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 153 "type": "integer", 154 "format": "int32" 155 } 156 } 157 } 158 } 159 } 160 }, 161 "default": { 162 "description": "Error.", 163 "content": { 164 "application/json": { 165 "schema": { 166 "$ref": "#/components/schemas/Error" 167 } 168 } 169 } 170 } 171 } 172 } 173 }, 174 "/api/clusters_mgmt/v1/addons/{addon_id}": { 175 "delete": { 176 "description": "Deletes the add-on.", 177 "parameters": [ 178 { 179 "name": "addon_id", 180 "in": "path", 181 "schema": { 182 "type": "string" 183 }, 184 "required": true 185 } 186 ], 187 "responses": { 188 "204": { 189 "description": "Success." 190 }, 191 "default": { 192 "description": "Error.", 193 "content": { 194 "application/json": { 195 "schema": { 196 "$ref": "#/components/schemas/Error" 197 } 198 } 199 } 200 } 201 } 202 }, 203 "get": { 204 "description": "Retrieves the details of the add-on.", 205 "parameters": [ 206 { 207 "name": "addon_id", 208 "in": "path", 209 "schema": { 210 "type": "string" 211 }, 212 "required": true 213 } 214 ], 215 "responses": { 216 "200": { 217 "description": "Success.", 218 "content": { 219 "application/json": { 220 "schema": { 221 "$ref": "#/components/schemas/AddOn" 222 } 223 } 224 } 225 }, 226 "default": { 227 "description": "Error.", 228 "content": { 229 "application/json": { 230 "schema": { 231 "$ref": "#/components/schemas/Error" 232 } 233 } 234 } 235 } 236 } 237 }, 238 "patch": { 239 "description": "Updates the add-on.", 240 "parameters": [ 241 { 242 "name": "addon_id", 243 "in": "path", 244 "schema": { 245 "type": "string" 246 }, 247 "required": true 248 } 249 ], 250 "requestBody": { 251 "content": { 252 "application/json": { 253 "schema": { 254 "$ref": "#/components/schemas/AddOn" 255 } 256 } 257 } 258 }, 259 "responses": { 260 "200": { 261 "description": "Success.", 262 "content": { 263 "application/json": { 264 "schema": { 265 "$ref": "#/components/schemas/AddOn" 266 } 267 } 268 } 269 }, 270 "default": { 271 "description": "Error.", 272 "content": { 273 "application/json": { 274 "schema": { 275 "$ref": "#/components/schemas/Error" 276 } 277 } 278 } 279 } 280 } 281 } 282 }, 283 "/api/clusters_mgmt/v1/addons/{addon_id}/versions": { 284 "post": { 285 "description": "Create a new add-on version and add it to the collection of add-ons.", 286 "parameters": [ 287 { 288 "name": "addon_id", 289 "in": "path", 290 "schema": { 291 "type": "string" 292 }, 293 "required": true 294 } 295 ], 296 "requestBody": { 297 "content": { 298 "application/json": { 299 "schema": { 300 "$ref": "#/components/schemas/AddOnVersion" 301 } 302 } 303 } 304 }, 305 "responses": { 306 "201": { 307 "description": "Success.", 308 "content": { 309 "application/json": { 310 "schema": { 311 "$ref": "#/components/schemas/AddOnVersion" 312 } 313 } 314 } 315 }, 316 "default": { 317 "description": "Error.", 318 "content": { 319 "application/json": { 320 "schema": { 321 "$ref": "#/components/schemas/Error" 322 } 323 } 324 } 325 } 326 } 327 }, 328 "get": { 329 "description": "Retrieves the list of add-on versions.", 330 "parameters": [ 331 { 332 "name": "addon_id", 333 "in": "path", 334 "schema": { 335 "type": "string" 336 }, 337 "required": true 338 }, 339 { 340 "name": "order", 341 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the add-on instead of\nthe names of the columns of a table. For example, in order to sort the add-on\nversions descending by id the value should be:\n\n```sql\nid desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 342 "in": "query", 343 "schema": { 344 "type": "string" 345 } 346 }, 347 { 348 "name": "page", 349 "description": "Index of the requested page, where one corresponds to the first page.", 350 "in": "query", 351 "schema": { 352 "type": "integer", 353 "format": "int32" 354 } 355 }, 356 { 357 "name": "search", 358 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the add-on version instead\nof the names of the columns of a table. For example, in order to retrieve all the\nadd-on versions with an id starting with `0.1` the value should be:\n\n```sql\nid like '0.1.%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the add-on\nversions that the user has permission to see will be returned.", 359 "in": "query", 360 "schema": { 361 "type": "string" 362 } 363 }, 364 { 365 "name": "size", 366 "description": "Maximum number of items that will be contained in the returned page.", 367 "in": "query", 368 "schema": { 369 "type": "integer", 370 "format": "int32" 371 } 372 } 373 ], 374 "responses": { 375 "200": { 376 "description": "Success.", 377 "content": { 378 "application/json": { 379 "schema": { 380 "type": "object", 381 "properties": { 382 "items": { 383 "description": "Retrieved list of add-on versions.", 384 "type": "array", 385 "items": { 386 "$ref": "#/components/schemas/AddOnVersion" 387 } 388 }, 389 "page": { 390 "description": "Index of the requested page, where one corresponds to the first page.", 391 "type": "integer", 392 "format": "int32" 393 }, 394 "size": { 395 "description": "Maximum number of items that will be contained in the returned page.", 396 "type": "integer", 397 "format": "int32" 398 }, 399 "total": { 400 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 401 "type": "integer", 402 "format": "int32" 403 } 404 } 405 } 406 } 407 } 408 }, 409 "default": { 410 "description": "Error.", 411 "content": { 412 "application/json": { 413 "schema": { 414 "$ref": "#/components/schemas/Error" 415 } 416 } 417 } 418 } 419 } 420 } 421 }, 422 "/api/clusters_mgmt/v1/addons/{addon_id}/versions/{version_id}": { 423 "delete": { 424 "description": "Deletes the add-on version.", 425 "parameters": [ 426 { 427 "name": "addon_id", 428 "in": "path", 429 "schema": { 430 "type": "string" 431 }, 432 "required": true 433 }, 434 { 435 "name": "version_id", 436 "in": "path", 437 "schema": { 438 "type": "string" 439 }, 440 "required": true 441 } 442 ], 443 "responses": { 444 "204": { 445 "description": "Success." 446 }, 447 "default": { 448 "description": "Error.", 449 "content": { 450 "application/json": { 451 "schema": { 452 "$ref": "#/components/schemas/Error" 453 } 454 } 455 } 456 } 457 } 458 }, 459 "get": { 460 "description": "Retrieves the details of the add-on version.", 461 "parameters": [ 462 { 463 "name": "addon_id", 464 "in": "path", 465 "schema": { 466 "type": "string" 467 }, 468 "required": true 469 }, 470 { 471 "name": "version_id", 472 "in": "path", 473 "schema": { 474 "type": "string" 475 }, 476 "required": true 477 } 478 ], 479 "responses": { 480 "200": { 481 "description": "Success.", 482 "content": { 483 "application/json": { 484 "schema": { 485 "$ref": "#/components/schemas/AddOnVersion" 486 } 487 } 488 } 489 }, 490 "default": { 491 "description": "Error.", 492 "content": { 493 "application/json": { 494 "schema": { 495 "$ref": "#/components/schemas/Error" 496 } 497 } 498 } 499 } 500 } 501 }, 502 "patch": { 503 "description": "Updates the add-on version.", 504 "parameters": [ 505 { 506 "name": "addon_id", 507 "in": "path", 508 "schema": { 509 "type": "string" 510 }, 511 "required": true 512 }, 513 { 514 "name": "version_id", 515 "in": "path", 516 "schema": { 517 "type": "string" 518 }, 519 "required": true 520 } 521 ], 522 "requestBody": { 523 "content": { 524 "application/json": { 525 "schema": { 526 "$ref": "#/components/schemas/AddOnVersion" 527 } 528 } 529 } 530 }, 531 "responses": { 532 "200": { 533 "description": "Success.", 534 "content": { 535 "application/json": { 536 "schema": { 537 "$ref": "#/components/schemas/AddOnVersion" 538 } 539 } 540 } 541 }, 542 "default": { 543 "description": "Error.", 544 "content": { 545 "application/json": { 546 "schema": { 547 "$ref": "#/components/schemas/Error" 548 } 549 } 550 } 551 } 552 } 553 } 554 }, 555 "/api/clusters_mgmt/v1/aws_infrastructure_access_roles": { 556 "get": { 557 "parameters": [ 558 { 559 "name": "order", 560 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the role instead of\nthe names of the columns of a table. For example, in order to sort the roles\ndescending by dislay_name the value should be:\n\n```sql\ndisplay_name desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 561 "in": "query", 562 "schema": { 563 "type": "string" 564 } 565 }, 566 { 567 "name": "page", 568 "description": "Index of the requested page, where one corresponds to the first page.", 569 "in": "query", 570 "schema": { 571 "type": "integer", 572 "format": "int32" 573 } 574 }, 575 { 576 "name": "search", 577 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the role instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nrole with a name starting with `my`the value should be:\n\n```sql\ndisplay_name like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the roles\nthat the user has permission to see will be returned.", 578 "in": "query", 579 "schema": { 580 "type": "string" 581 } 582 }, 583 { 584 "name": "size", 585 "description": "Maximum number of items that will be contained in the returned page.", 586 "in": "query", 587 "schema": { 588 "type": "integer", 589 "format": "int32" 590 } 591 } 592 ], 593 "responses": { 594 "200": { 595 "description": "Success.", 596 "content": { 597 "application/json": { 598 "schema": { 599 "type": "object", 600 "properties": { 601 "items": { 602 "description": "Retrieved list of roles.", 603 "type": "array", 604 "items": { 605 "$ref": "#/components/schemas/AWSInfrastructureAccessRole" 606 } 607 }, 608 "page": { 609 "description": "Index of the requested page, where one corresponds to the first page.", 610 "type": "integer", 611 "format": "int32" 612 }, 613 "size": { 614 "description": "Maximum number of items that will be contained in the returned page.", 615 "type": "integer", 616 "format": "int32" 617 }, 618 "total": { 619 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 620 "type": "integer", 621 "format": "int32" 622 } 623 } 624 } 625 } 626 } 627 }, 628 "default": { 629 "description": "Error.", 630 "content": { 631 "application/json": { 632 "schema": { 633 "$ref": "#/components/schemas/Error" 634 } 635 } 636 } 637 } 638 } 639 } 640 }, 641 "/api/clusters_mgmt/v1/aws_infrastructure_access_roles/{aws_infrastructure_access_role_id}": { 642 "get": { 643 "description": "Retrieves the details of the aws infrastructure access role.", 644 "parameters": [ 645 { 646 "name": "aws_infrastructure_access_role_id", 647 "in": "path", 648 "schema": { 649 "type": "string" 650 }, 651 "required": true 652 } 653 ], 654 "responses": { 655 "200": { 656 "description": "Success.", 657 "content": { 658 "application/json": { 659 "schema": { 660 "$ref": "#/components/schemas/AWSInfrastructureAccessRole" 661 } 662 } 663 } 664 }, 665 "default": { 666 "description": "Error.", 667 "content": { 668 "application/json": { 669 "schema": { 670 "$ref": "#/components/schemas/Error" 671 } 672 } 673 } 674 } 675 } 676 } 677 }, 678 "/api/clusters_mgmt/v1/aws_inquiries/machine_types": { 679 "post": { 680 "description": "Retrieves the list of machine types in the provided region.", 681 "parameters": [ 682 { 683 "name": "page", 684 "description": "Index of the requested page, where one corresponds to the first page.", 685 "in": "query", 686 "schema": { 687 "type": "integer", 688 "format": "int32" 689 } 690 }, 691 { 692 "name": "size", 693 "description": "Maximum number of items that will be contained in the returned page.", 694 "in": "query", 695 "schema": { 696 "type": "integer", 697 "format": "int32" 698 } 699 } 700 ], 701 "requestBody": { 702 "content": { 703 "application/json": { 704 "schema": { 705 "$ref": "#/components/schemas/CloudProviderData" 706 } 707 } 708 } 709 }, 710 "responses": { 711 "200": { 712 "description": "Success.", 713 "content": { 714 "application/json": { 715 "schema": { 716 "type": "object", 717 "properties": { 718 "items": { 719 "description": "Retrieved list of machine types.", 720 "type": "array", 721 "items": { 722 "$ref": "#/components/schemas/MachineType" 723 } 724 }, 725 "page": { 726 "description": "Index of the requested page, where one corresponds to the first page.", 727 "type": "integer", 728 "format": "int32" 729 }, 730 "size": { 731 "description": "Maximum number of items that will be contained in the returned page.", 732 "type": "integer", 733 "format": "int32" 734 }, 735 "total": { 736 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 737 "type": "integer", 738 "format": "int32" 739 } 740 } 741 } 742 } 743 } 744 }, 745 "default": { 746 "description": "Error.", 747 "content": { 748 "application/json": { 749 "schema": { 750 "$ref": "#/components/schemas/Error" 751 } 752 } 753 } 754 } 755 } 756 } 757 }, 758 "/api/clusters_mgmt/v1/aws_inquiries/oidc_thumbprint": { 759 "post": { 760 "description": "Fetches/creates an OIDC Config Thumbprint from either a cluster ID, or an oidc config ID.", 761 "requestBody": { 762 "content": { 763 "application/json": { 764 "schema": { 765 "$ref": "#/components/schemas/OidcThumbprintInput" 766 } 767 } 768 } 769 }, 770 "responses": { 771 "201": { 772 "description": "Success.", 773 "content": { 774 "application/json": { 775 "schema": { 776 "$ref": "#/components/schemas/OidcThumbprint" 777 } 778 } 779 } 780 }, 781 "default": { 782 "description": "Error.", 783 "content": { 784 "application/json": { 785 "schema": { 786 "$ref": "#/components/schemas/Error" 787 } 788 } 789 } 790 } 791 } 792 } 793 }, 794 "/api/clusters_mgmt/v1/aws_inquiries/regions": { 795 "post": { 796 "description": "Retrieves the list of available regions of the cloud provider.\nIMPORTANT: This list doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available regions\nof the provider.", 797 "parameters": [ 798 { 799 "name": "page", 800 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 801 "in": "query", 802 "schema": { 803 "type": "integer", 804 "format": "int32" 805 } 806 }, 807 { 808 "name": "size", 809 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 810 "in": "query", 811 "schema": { 812 "type": "integer", 813 "format": "int32" 814 } 815 } 816 ], 817 "requestBody": { 818 "content": { 819 "application/json": { 820 "schema": { 821 "$ref": "#/components/schemas/CloudProviderData" 822 } 823 } 824 } 825 }, 826 "responses": { 827 "200": { 828 "description": "Success.", 829 "content": { 830 "application/json": { 831 "schema": { 832 "type": "object", 833 "properties": { 834 "items": { 835 "description": "Retrieved list of regions.", 836 "type": "array", 837 "items": { 838 "$ref": "#/components/schemas/CloudRegion" 839 } 840 }, 841 "page": { 842 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 843 "type": "integer", 844 "format": "int32" 845 }, 846 "size": { 847 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 848 "type": "integer", 849 "format": "int32" 850 }, 851 "total": { 852 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available regions of the provider.", 853 "type": "integer", 854 "format": "int32" 855 } 856 } 857 } 858 } 859 } 860 }, 861 "default": { 862 "description": "Error.", 863 "content": { 864 "application/json": { 865 "schema": { 866 "$ref": "#/components/schemas/Error" 867 } 868 } 869 } 870 } 871 } 872 } 873 }, 874 "/api/clusters_mgmt/v1/aws_inquiries/sts_account_roles": { 875 "post": { 876 "parameters": [ 877 { 878 "name": "page", 879 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 880 "in": "query", 881 "schema": { 882 "type": "integer", 883 "format": "int32" 884 } 885 }, 886 { 887 "name": "size", 888 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nbe the total number of STS account roles.", 889 "in": "query", 890 "schema": { 891 "type": "integer", 892 "format": "int32" 893 } 894 } 895 ], 896 "requestBody": { 897 "content": { 898 "application/json": { 899 "schema": { 900 "$ref": "#/components/schemas/AWS" 901 } 902 } 903 } 904 }, 905 "responses": { 906 "200": { 907 "description": "Success.", 908 "content": { 909 "application/json": { 910 "schema": { 911 "type": "object", 912 "properties": { 913 "aws_account_id": { 914 "description": "The AWS Account Id for the STS Account Roles", 915 "type": "string" 916 }, 917 "items": { 918 "description": "Retrieved list of STS Account Roles", 919 "type": "array", 920 "items": { 921 "$ref": "#/components/schemas/AWSSTSAccountRole" 922 } 923 }, 924 "page": { 925 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 926 "type": "integer", 927 "format": "int32" 928 }, 929 "size": { 930 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nbe the total number of STS account roles.", 931 "type": "integer", 932 "format": "int32" 933 }, 934 "total": { 935 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of STS account roles", 936 "type": "integer", 937 "format": "int32" 938 } 939 } 940 } 941 } 942 } 943 }, 944 "default": { 945 "description": "Error.", 946 "content": { 947 "application/json": { 948 "schema": { 949 "$ref": "#/components/schemas/Error" 950 } 951 } 952 } 953 } 954 } 955 } 956 }, 957 "/api/clusters_mgmt/v1/aws_inquiries/sts_credential_requests": { 958 "get": { 959 "description": "Retrieves the list of policies.", 960 "parameters": [ 961 { 962 "name": "page", 963 "description": "Index of the requested page, where one corresponds to the first page.", 964 "in": "query", 965 "schema": { 966 "type": "integer", 967 "format": "int32" 968 } 969 }, 970 { 971 "name": "size", 972 "description": "Maximum number of items that will be contained in the returned page.", 973 "in": "query", 974 "schema": { 975 "type": "integer", 976 "format": "int32" 977 } 978 } 979 ], 980 "responses": { 981 "200": { 982 "description": "Success.", 983 "content": { 984 "application/json": { 985 "schema": { 986 "type": "object", 987 "properties": { 988 "items": { 989 "description": "Retrieved list of CredRequest.", 990 "type": "array", 991 "items": { 992 "$ref": "#/components/schemas/STSCredentialRequest" 993 } 994 }, 995 "page": { 996 "description": "Index of the requested page, where one corresponds to the first page.", 997 "type": "integer", 998 "format": "int32" 999 }, 1000 "size": { 1001 "description": "Maximum number of items that will be contained in the returned page.", 1002 "type": "integer", 1003 "format": "int32" 1004 }, 1005 "total": { 1006 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1007 "type": "integer", 1008 "format": "int32" 1009 } 1010 } 1011 } 1012 } 1013 } 1014 }, 1015 "default": { 1016 "description": "Error.", 1017 "content": { 1018 "application/json": { 1019 "schema": { 1020 "$ref": "#/components/schemas/Error" 1021 } 1022 } 1023 } 1024 } 1025 } 1026 } 1027 }, 1028 "/api/clusters_mgmt/v1/aws_inquiries/sts_policies": { 1029 "get": { 1030 "description": "Retrieves the list of policies.", 1031 "parameters": [ 1032 { 1033 "name": "order", 1034 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the awsstspolicies instead of\nthe names of the columns of a table. For example, in order to sort the policies\ndescending by operator type identifier the value should be:\n\n```sql\norderBy id desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 1035 "in": "query", 1036 "schema": { 1037 "type": "string" 1038 } 1039 }, 1040 { 1041 "name": "page", 1042 "description": "Index of the requested page, where one corresponds to the first page.", 1043 "in": "query", 1044 "schema": { 1045 "type": "integer", 1046 "format": "int32" 1047 } 1048 }, 1049 { 1050 "name": "search", 1051 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the awsstspolicies instead of\nthe names of the columns of a table. For example, in order to retrieve all the\npolicies of type `operatorrole`\nshould be:\n\n```sql\npolicy_type like 'OperatorRole%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\npolicies will be returned.", 1052 "in": "query", 1053 "schema": { 1054 "type": "string" 1055 } 1056 }, 1057 { 1058 "name": "size", 1059 "description": "Maximum number of items that will be contained in the returned page.", 1060 "in": "query", 1061 "schema": { 1062 "type": "integer", 1063 "format": "int32" 1064 } 1065 } 1066 ], 1067 "responses": { 1068 "200": { 1069 "description": "Success.", 1070 "content": { 1071 "application/json": { 1072 "schema": { 1073 "type": "object", 1074 "properties": { 1075 "items": { 1076 "description": "Retrieved list of policies.", 1077 "type": "array", 1078 "items": { 1079 "$ref": "#/components/schemas/AWSSTSPolicy" 1080 } 1081 }, 1082 "page": { 1083 "description": "Index of the requested page, where one corresponds to the first page.", 1084 "type": "integer", 1085 "format": "int32" 1086 }, 1087 "size": { 1088 "description": "Maximum number of items that will be contained in the returned page.", 1089 "type": "integer", 1090 "format": "int32" 1091 }, 1092 "total": { 1093 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1094 "type": "integer", 1095 "format": "int32" 1096 } 1097 } 1098 } 1099 } 1100 } 1101 }, 1102 "default": { 1103 "description": "Error.", 1104 "content": { 1105 "application/json": { 1106 "schema": { 1107 "$ref": "#/components/schemas/Error" 1108 } 1109 } 1110 } 1111 } 1112 } 1113 } 1114 }, 1115 "/api/clusters_mgmt/v1/aws_inquiries/validate_credentials": { 1116 "post": { 1117 "description": "Manages aws creds validation.", 1118 "requestBody": { 1119 "content": { 1120 "application/json": { 1121 "schema": { 1122 "$ref": "#/components/schemas/CloudProviderData" 1123 } 1124 } 1125 } 1126 }, 1127 "responses": { 1128 "201": { 1129 "description": "Success.", 1130 "content": { 1131 "application/json": { 1132 "schema": { 1133 "$ref": "#/components/schemas/CloudProviderData" 1134 } 1135 } 1136 } 1137 }, 1138 "default": { 1139 "description": "Error.", 1140 "content": { 1141 "application/json": { 1142 "schema": { 1143 "$ref": "#/components/schemas/Error" 1144 } 1145 } 1146 } 1147 } 1148 } 1149 } 1150 }, 1151 "/api/clusters_mgmt/v1/aws_inquiries/vpcs": { 1152 "post": { 1153 "description": "Retrieves the list of available vpcs of the cloud provider for specific region.\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available vpcs\nof the provider.", 1154 "parameters": [ 1155 { 1156 "name": "page", 1157 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1158 "in": "query", 1159 "schema": { 1160 "type": "integer", 1161 "format": "int32" 1162 } 1163 }, 1164 { 1165 "name": "size", 1166 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nvpcs of the provider.", 1167 "in": "query", 1168 "schema": { 1169 "type": "integer", 1170 "format": "int32" 1171 } 1172 } 1173 ], 1174 "requestBody": { 1175 "content": { 1176 "application/json": { 1177 "schema": { 1178 "$ref": "#/components/schemas/CloudProviderData" 1179 } 1180 } 1181 } 1182 }, 1183 "responses": { 1184 "200": { 1185 "description": "Success.", 1186 "content": { 1187 "application/json": { 1188 "schema": { 1189 "type": "object", 1190 "properties": { 1191 "items": { 1192 "description": "Retrieved list of cloud VPC.", 1193 "type": "array", 1194 "items": { 1195 "$ref": "#/components/schemas/CloudVPC" 1196 } 1197 }, 1198 "page": { 1199 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1200 "type": "integer", 1201 "format": "int32" 1202 }, 1203 "size": { 1204 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nvpcs of the provider.", 1205 "type": "integer", 1206 "format": "int32" 1207 }, 1208 "total": { 1209 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available vpcs of the provider.", 1210 "type": "integer", 1211 "format": "int32" 1212 } 1213 } 1214 } 1215 } 1216 } 1217 }, 1218 "default": { 1219 "description": "Error.", 1220 "content": { 1221 "application/json": { 1222 "schema": { 1223 "$ref": "#/components/schemas/Error" 1224 } 1225 } 1226 } 1227 } 1228 } 1229 } 1230 }, 1231 "/api/clusters_mgmt/v1/cloud_providers": { 1232 "get": { 1233 "description": "Retrieves the list of cloud providers.", 1234 "parameters": [ 1235 { 1236 "name": "fetchRegions", 1237 "description": "If true, includes the regions on each provider in the output. Could slow request response time.", 1238 "in": "query", 1239 "schema": { 1240 "type": "boolean" 1241 } 1242 }, 1243 { 1244 "name": "order", 1245 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the cloud provider\ninstead of the names of the columns of a table. For example, in order to sort the\nclusters descending by name identifier the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 1246 "in": "query", 1247 "schema": { 1248 "type": "string" 1249 } 1250 }, 1251 { 1252 "name": "page", 1253 "description": "Index of the requested page, where one corresponds to the first page.", 1254 "in": "query", 1255 "schema": { 1256 "type": "integer", 1257 "format": "int32" 1258 } 1259 }, 1260 { 1261 "name": "search", 1262 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the cloud provider\ninstead of the names of the columns of a table. For example, in order to retrieve\nall the cloud providers with a name starting with `A` the value should be:\n\n```sql\nname like 'A%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the clusters\nthat the user has permission to see will be returned.", 1263 "in": "query", 1264 "schema": { 1265 "type": "string" 1266 } 1267 }, 1268 { 1269 "name": "size", 1270 "description": "Maximum number of items that will be contained in the returned page.", 1271 "in": "query", 1272 "schema": { 1273 "type": "integer", 1274 "format": "int32" 1275 } 1276 } 1277 ], 1278 "responses": { 1279 "200": { 1280 "description": "Success.", 1281 "content": { 1282 "application/json": { 1283 "schema": { 1284 "type": "object", 1285 "properties": { 1286 "items": { 1287 "description": "Retrieved list of cloud providers.", 1288 "type": "array", 1289 "items": { 1290 "$ref": "#/components/schemas/CloudProvider" 1291 } 1292 }, 1293 "page": { 1294 "description": "Index of the requested page, where one corresponds to the first page.", 1295 "type": "integer", 1296 "format": "int32" 1297 }, 1298 "size": { 1299 "description": "Maximum number of items that will be contained in the returned page.", 1300 "type": "integer", 1301 "format": "int32" 1302 }, 1303 "total": { 1304 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1305 "type": "integer", 1306 "format": "int32" 1307 } 1308 } 1309 } 1310 } 1311 } 1312 }, 1313 "default": { 1314 "description": "Error.", 1315 "content": { 1316 "application/json": { 1317 "schema": { 1318 "$ref": "#/components/schemas/Error" 1319 } 1320 } 1321 } 1322 } 1323 } 1324 } 1325 }, 1326 "/api/clusters_mgmt/v1/cloud_providers/{cloud_provider_id}": { 1327 "get": { 1328 "description": "Retrieves the details of the cloud provider.", 1329 "parameters": [ 1330 { 1331 "name": "cloud_provider_id", 1332 "in": "path", 1333 "schema": { 1334 "type": "string" 1335 }, 1336 "required": true 1337 } 1338 ], 1339 "responses": { 1340 "200": { 1341 "description": "Success.", 1342 "content": { 1343 "application/json": { 1344 "schema": { 1345 "$ref": "#/components/schemas/CloudProvider" 1346 } 1347 } 1348 } 1349 }, 1350 "default": { 1351 "description": "Error.", 1352 "content": { 1353 "application/json": { 1354 "schema": { 1355 "$ref": "#/components/schemas/Error" 1356 } 1357 } 1358 } 1359 } 1360 } 1361 } 1362 }, 1363 "/api/clusters_mgmt/v1/cloud_providers/{cloud_provider_id}/available_regions": { 1364 "post": { 1365 "description": "Retrieves the list of available regions of the cloud provider.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available regions\nof the provider.", 1366 "parameters": [ 1367 { 1368 "name": "cloud_provider_id", 1369 "in": "path", 1370 "schema": { 1371 "type": "string" 1372 }, 1373 "required": true 1374 }, 1375 { 1376 "name": "page", 1377 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1378 "in": "query", 1379 "schema": { 1380 "type": "integer", 1381 "format": "int32" 1382 } 1383 }, 1384 { 1385 "name": "size", 1386 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 1387 "in": "query", 1388 "schema": { 1389 "type": "integer", 1390 "format": "int32" 1391 } 1392 } 1393 ], 1394 "requestBody": { 1395 "content": { 1396 "application/json": { 1397 "schema": { 1398 "$ref": "#/components/schemas/AWS" 1399 } 1400 } 1401 } 1402 }, 1403 "responses": { 1404 "200": { 1405 "description": "Success.", 1406 "content": { 1407 "application/json": { 1408 "schema": { 1409 "type": "object", 1410 "properties": { 1411 "items": { 1412 "description": "Retrieved list of cloud regions.", 1413 "type": "array", 1414 "items": { 1415 "$ref": "#/components/schemas/CloudRegion" 1416 } 1417 }, 1418 "page": { 1419 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1420 "type": "integer", 1421 "format": "int32" 1422 }, 1423 "size": { 1424 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 1425 "type": "integer", 1426 "format": "int32" 1427 }, 1428 "total": { 1429 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available regions of the provider.", 1430 "type": "integer", 1431 "format": "int32" 1432 } 1433 } 1434 } 1435 } 1436 } 1437 }, 1438 "default": { 1439 "description": "Error.", 1440 "content": { 1441 "application/json": { 1442 "schema": { 1443 "$ref": "#/components/schemas/Error" 1444 } 1445 } 1446 } 1447 } 1448 } 1449 } 1450 }, 1451 "/api/clusters_mgmt/v1/cloud_providers/{cloud_provider_id}/regions": { 1452 "post": { 1453 "description": "Adds a cloud region to the database.", 1454 "parameters": [ 1455 { 1456 "name": "cloud_provider_id", 1457 "in": "path", 1458 "schema": { 1459 "type": "string" 1460 }, 1461 "required": true 1462 } 1463 ], 1464 "requestBody": { 1465 "content": { 1466 "application/json": { 1467 "schema": { 1468 "$ref": "#/components/schemas/CloudRegion" 1469 } 1470 } 1471 } 1472 }, 1473 "responses": { 1474 "201": { 1475 "description": "Success.", 1476 "content": { 1477 "application/json": { 1478 "schema": { 1479 "$ref": "#/components/schemas/CloudRegion" 1480 } 1481 } 1482 } 1483 }, 1484 "default": { 1485 "description": "Error.", 1486 "content": { 1487 "application/json": { 1488 "schema": { 1489 "$ref": "#/components/schemas/Error" 1490 } 1491 } 1492 } 1493 } 1494 } 1495 }, 1496 "get": { 1497 "description": "Retrieves the list of regions of the cloud provider.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of regions\nof the provider.", 1498 "parameters": [ 1499 { 1500 "name": "cloud_provider_id", 1501 "in": "path", 1502 "schema": { 1503 "type": "string" 1504 }, 1505 "required": true 1506 }, 1507 { 1508 "name": "page", 1509 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1510 "in": "query", 1511 "schema": { 1512 "type": "integer", 1513 "format": "int32" 1514 } 1515 }, 1516 { 1517 "name": "size", 1518 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 1519 "in": "query", 1520 "schema": { 1521 "type": "integer", 1522 "format": "int32" 1523 } 1524 } 1525 ], 1526 "responses": { 1527 "200": { 1528 "description": "Success.", 1529 "content": { 1530 "application/json": { 1531 "schema": { 1532 "type": "object", 1533 "properties": { 1534 "items": { 1535 "description": "Retrieved list of cloud providers.", 1536 "type": "array", 1537 "items": { 1538 "$ref": "#/components/schemas/CloudRegion" 1539 } 1540 }, 1541 "page": { 1542 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 1543 "type": "integer", 1544 "format": "int32" 1545 }, 1546 "size": { 1547 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 1548 "type": "integer", 1549 "format": "int32" 1550 }, 1551 "total": { 1552 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of regions of the provider.", 1553 "type": "integer", 1554 "format": "int32" 1555 } 1556 } 1557 } 1558 } 1559 } 1560 }, 1561 "default": { 1562 "description": "Error.", 1563 "content": { 1564 "application/json": { 1565 "schema": { 1566 "$ref": "#/components/schemas/Error" 1567 } 1568 } 1569 } 1570 } 1571 } 1572 } 1573 }, 1574 "/api/clusters_mgmt/v1/cloud_providers/{cloud_provider_id}/regions/{region_id}": { 1575 "delete": { 1576 "description": "Deletes the region.", 1577 "parameters": [ 1578 { 1579 "name": "cloud_provider_id", 1580 "in": "path", 1581 "schema": { 1582 "type": "string" 1583 }, 1584 "required": true 1585 }, 1586 { 1587 "name": "region_id", 1588 "in": "path", 1589 "schema": { 1590 "type": "string" 1591 }, 1592 "required": true 1593 } 1594 ], 1595 "responses": { 1596 "204": { 1597 "description": "Success." 1598 }, 1599 "default": { 1600 "description": "Error.", 1601 "content": { 1602 "application/json": { 1603 "schema": { 1604 "$ref": "#/components/schemas/Error" 1605 } 1606 } 1607 } 1608 } 1609 } 1610 }, 1611 "get": { 1612 "description": "Retrieves the details of the region.", 1613 "parameters": [ 1614 { 1615 "name": "cloud_provider_id", 1616 "in": "path", 1617 "schema": { 1618 "type": "string" 1619 }, 1620 "required": true 1621 }, 1622 { 1623 "name": "region_id", 1624 "in": "path", 1625 "schema": { 1626 "type": "string" 1627 }, 1628 "required": true 1629 } 1630 ], 1631 "responses": { 1632 "200": { 1633 "description": "Success.", 1634 "content": { 1635 "application/json": { 1636 "schema": { 1637 "$ref": "#/components/schemas/CloudRegion" 1638 } 1639 } 1640 } 1641 }, 1642 "default": { 1643 "description": "Error.", 1644 "content": { 1645 "application/json": { 1646 "schema": { 1647 "$ref": "#/components/schemas/Error" 1648 } 1649 } 1650 } 1651 } 1652 } 1653 }, 1654 "patch": { 1655 "description": "Updates the region.", 1656 "parameters": [ 1657 { 1658 "name": "cloud_provider_id", 1659 "in": "path", 1660 "schema": { 1661 "type": "string" 1662 }, 1663 "required": true 1664 }, 1665 { 1666 "name": "region_id", 1667 "in": "path", 1668 "schema": { 1669 "type": "string" 1670 }, 1671 "required": true 1672 } 1673 ], 1674 "requestBody": { 1675 "content": { 1676 "application/json": { 1677 "schema": { 1678 "$ref": "#/components/schemas/CloudRegion" 1679 } 1680 } 1681 } 1682 }, 1683 "responses": { 1684 "200": { 1685 "description": "Success.", 1686 "content": { 1687 "application/json": { 1688 "schema": { 1689 "$ref": "#/components/schemas/CloudRegion" 1690 } 1691 } 1692 } 1693 }, 1694 "default": { 1695 "description": "Error.", 1696 "content": { 1697 "application/json": { 1698 "schema": { 1699 "$ref": "#/components/schemas/Error" 1700 } 1701 } 1702 } 1703 } 1704 } 1705 } 1706 }, 1707 "/api/clusters_mgmt/v1/clusters": { 1708 "post": { 1709 "description": "Provision a new cluster and add it to the collection of clusters.\n\nSee the `register_cluster` method for adding an existing cluster.", 1710 "requestBody": { 1711 "content": { 1712 "application/json": { 1713 "schema": { 1714 "$ref": "#/components/schemas/Cluster" 1715 } 1716 } 1717 } 1718 }, 1719 "responses": { 1720 "201": { 1721 "description": "Success.", 1722 "content": { 1723 "application/json": { 1724 "schema": { 1725 "$ref": "#/components/schemas/Cluster" 1726 } 1727 } 1728 } 1729 }, 1730 "default": { 1731 "description": "Error.", 1732 "content": { 1733 "application/json": { 1734 "schema": { 1735 "$ref": "#/components/schemas/Error" 1736 } 1737 } 1738 } 1739 } 1740 } 1741 }, 1742 "get": { 1743 "description": "Retrieves the list of clusters.", 1744 "parameters": [ 1745 { 1746 "name": "order", 1747 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the cluster instead of\nthe names of the columns of a table. For example, in order to sort the clusters\ndescending by region identifier the value should be:\n\n```sql\nregion.id desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 1748 "in": "query", 1749 "schema": { 1750 "type": "string" 1751 } 1752 }, 1753 { 1754 "name": "page", 1755 "description": "Index of the requested page, where one corresponds to the first page.", 1756 "in": "query", 1757 "schema": { 1758 "type": "integer", 1759 "format": "int32" 1760 } 1761 }, 1762 { 1763 "name": "search", 1764 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the cluster instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nclusters with a name starting with `my` in the `us-east-1` region the value\nshould be:\n\n```sql\nname like 'my%' and region.id = 'us-east-1'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nclusters that the user has permission to see will be returned.", 1765 "in": "query", 1766 "schema": { 1767 "type": "string" 1768 } 1769 }, 1770 { 1771 "name": "size", 1772 "description": "Maximum number of items that will be contained in the returned page.", 1773 "in": "query", 1774 "schema": { 1775 "type": "integer", 1776 "format": "int32" 1777 } 1778 } 1779 ], 1780 "responses": { 1781 "200": { 1782 "description": "Success.", 1783 "content": { 1784 "application/json": { 1785 "schema": { 1786 "type": "object", 1787 "properties": { 1788 "items": { 1789 "description": "Retrieved list of clusters.", 1790 "type": "array", 1791 "items": { 1792 "$ref": "#/components/schemas/Cluster" 1793 } 1794 }, 1795 "page": { 1796 "description": "Index of the requested page, where one corresponds to the first page.", 1797 "type": "integer", 1798 "format": "int32" 1799 }, 1800 "size": { 1801 "description": "Maximum number of items that will be contained in the returned page.", 1802 "type": "integer", 1803 "format": "int32" 1804 }, 1805 "total": { 1806 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1807 "type": "integer", 1808 "format": "int32" 1809 } 1810 } 1811 } 1812 } 1813 } 1814 }, 1815 "default": { 1816 "description": "Error.", 1817 "content": { 1818 "application/json": { 1819 "schema": { 1820 "$ref": "#/components/schemas/Error" 1821 } 1822 } 1823 } 1824 } 1825 } 1826 } 1827 }, 1828 "/api/clusters_mgmt/v1/clusters/{cluster_id}": { 1829 "delete": { 1830 "description": "Deletes the cluster.", 1831 "parameters": [ 1832 { 1833 "name": "cluster_id", 1834 "in": "path", 1835 "schema": { 1836 "type": "string" 1837 }, 1838 "required": true 1839 }, 1840 { 1841 "name": "best_effort", 1842 "description": "BestEffort flag is used to check if the cluster deletion should be best-effort mode or not.", 1843 "in": "query", 1844 "schema": { 1845 "type": "boolean" 1846 } 1847 }, 1848 { 1849 "name": "deprovision", 1850 "description": "If false it will only delete from OCM but not the actual cluster resources.\nfalse is only allowed for OCP clusters. true by default.", 1851 "in": "query", 1852 "schema": { 1853 "type": "boolean" 1854 } 1855 }, 1856 { 1857 "name": "dry_run", 1858 "description": "Dry run flag is used to check if the operation can be completed, but won't delete.", 1859 "in": "query", 1860 "schema": { 1861 "type": "boolean" 1862 } 1863 } 1864 ], 1865 "responses": { 1866 "204": { 1867 "description": "Success." 1868 }, 1869 "default": { 1870 "description": "Error.", 1871 "content": { 1872 "application/json": { 1873 "schema": { 1874 "$ref": "#/components/schemas/Error" 1875 } 1876 } 1877 } 1878 } 1879 } 1880 }, 1881 "get": { 1882 "description": "Retrieves the details of the cluster.", 1883 "parameters": [ 1884 { 1885 "name": "cluster_id", 1886 "in": "path", 1887 "schema": { 1888 "type": "string" 1889 }, 1890 "required": true 1891 } 1892 ], 1893 "responses": { 1894 "200": { 1895 "description": "Success.", 1896 "content": { 1897 "application/json": { 1898 "schema": { 1899 "$ref": "#/components/schemas/Cluster" 1900 } 1901 } 1902 } 1903 }, 1904 "default": { 1905 "description": "Error.", 1906 "content": { 1907 "application/json": { 1908 "schema": { 1909 "$ref": "#/components/schemas/Error" 1910 } 1911 } 1912 } 1913 } 1914 } 1915 }, 1916 "patch": { 1917 "description": "Updates the cluster.", 1918 "parameters": [ 1919 { 1920 "name": "cluster_id", 1921 "in": "path", 1922 "schema": { 1923 "type": "string" 1924 }, 1925 "required": true 1926 } 1927 ], 1928 "requestBody": { 1929 "content": { 1930 "application/json": { 1931 "schema": { 1932 "$ref": "#/components/schemas/Cluster" 1933 } 1934 } 1935 } 1936 }, 1937 "responses": { 1938 "200": { 1939 "description": "Success.", 1940 "content": { 1941 "application/json": { 1942 "schema": { 1943 "$ref": "#/components/schemas/Cluster" 1944 } 1945 } 1946 } 1947 }, 1948 "default": { 1949 "description": "Error.", 1950 "content": { 1951 "application/json": { 1952 "schema": { 1953 "$ref": "#/components/schemas/Error" 1954 } 1955 } 1956 } 1957 } 1958 } 1959 } 1960 }, 1961 "/api/clusters_mgmt/v1/clusters/{cluster_id}/hibernate": { 1962 "post": { 1963 "description": "Initiates cluster hibernation. While hibernating a cluster will not consume any cloud provider infrastructure\nbut will be counted for quota.", 1964 "parameters": [ 1965 { 1966 "name": "cluster_id", 1967 "in": "path", 1968 "schema": { 1969 "type": "string" 1970 }, 1971 "required": true 1972 } 1973 ], 1974 "responses": { 1975 "200": { 1976 "description": "Success." 1977 }, 1978 "default": { 1979 "description": "Error.", 1980 "content": { 1981 "application/json": { 1982 "schema": { 1983 "$ref": "#/components/schemas/Error" 1984 } 1985 } 1986 } 1987 } 1988 } 1989 } 1990 }, 1991 "/api/clusters_mgmt/v1/clusters/{cluster_id}/resume": { 1992 "post": { 1993 "description": "Resumes from Hibernation.", 1994 "parameters": [ 1995 { 1996 "name": "cluster_id", 1997 "in": "path", 1998 "schema": { 1999 "type": "string" 2000 }, 2001 "required": true 2002 } 2003 ], 2004 "responses": { 2005 "200": { 2006 "description": "Success." 2007 }, 2008 "default": { 2009 "description": "Error.", 2010 "content": { 2011 "application/json": { 2012 "schema": { 2013 "$ref": "#/components/schemas/Error" 2014 } 2015 } 2016 } 2017 } 2018 } 2019 } 2020 }, 2021 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addon_inquiries": { 2022 "get": { 2023 "parameters": [ 2024 { 2025 "name": "cluster_id", 2026 "in": "path", 2027 "schema": { 2028 "type": "string" 2029 }, 2030 "required": true 2031 }, 2032 { 2033 "name": "order", 2034 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the add-on instead of\nthe names of the columns of a table. For example, in order to sort the add-ons\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 2035 "in": "query", 2036 "schema": { 2037 "type": "string" 2038 } 2039 }, 2040 { 2041 "name": "page", 2042 "description": "Index of the requested page, where one corresponds to the first page.", 2043 "in": "query", 2044 "schema": { 2045 "type": "integer", 2046 "format": "int32" 2047 } 2048 }, 2049 { 2050 "name": "search", 2051 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the add-on instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nadd-ons with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the add-ons\nthat the user has permission to see will be returned.", 2052 "in": "query", 2053 "schema": { 2054 "type": "string" 2055 } 2056 }, 2057 { 2058 "name": "size", 2059 "description": "Maximum number of items that will be contained in the returned page.", 2060 "in": "query", 2061 "schema": { 2062 "type": "integer", 2063 "format": "int32" 2064 } 2065 } 2066 ], 2067 "responses": { 2068 "200": { 2069 "description": "Success.", 2070 "content": { 2071 "application/json": { 2072 "schema": { 2073 "type": "object", 2074 "properties": { 2075 "items": { 2076 "description": "Retrieved list of add-ons.", 2077 "type": "array", 2078 "items": { 2079 "$ref": "#/components/schemas/AddOn" 2080 } 2081 }, 2082 "page": { 2083 "description": "Index of the requested page, where one corresponds to the first page.", 2084 "type": "integer", 2085 "format": "int32" 2086 }, 2087 "size": { 2088 "description": "Maximum number of items that will be contained in the returned page.", 2089 "type": "integer", 2090 "format": "int32" 2091 }, 2092 "total": { 2093 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2094 "type": "integer", 2095 "format": "int32" 2096 } 2097 } 2098 } 2099 } 2100 } 2101 }, 2102 "default": { 2103 "description": "Error.", 2104 "content": { 2105 "application/json": { 2106 "schema": { 2107 "$ref": "#/components/schemas/Error" 2108 } 2109 } 2110 } 2111 } 2112 } 2113 } 2114 }, 2115 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addon_inquiries/{addon_inquiry_id}": { 2116 "get": { 2117 "parameters": [ 2118 { 2119 "name": "cluster_id", 2120 "in": "path", 2121 "schema": { 2122 "type": "string" 2123 }, 2124 "required": true 2125 }, 2126 { 2127 "name": "addon_inquiry_id", 2128 "in": "path", 2129 "schema": { 2130 "type": "string" 2131 }, 2132 "required": true 2133 } 2134 ], 2135 "responses": { 2136 "200": { 2137 "description": "Success.", 2138 "content": { 2139 "application/json": { 2140 "schema": { 2141 "$ref": "#/components/schemas/AddOn" 2142 } 2143 } 2144 } 2145 }, 2146 "default": { 2147 "description": "Error.", 2148 "content": { 2149 "application/json": { 2150 "schema": { 2151 "$ref": "#/components/schemas/Error" 2152 } 2153 } 2154 } 2155 } 2156 } 2157 } 2158 }, 2159 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addon_upgrade_policies": { 2160 "post": { 2161 "description": "Adds a new addon upgrade policy to the cluster.", 2162 "parameters": [ 2163 { 2164 "name": "cluster_id", 2165 "in": "path", 2166 "schema": { 2167 "type": "string" 2168 }, 2169 "required": true 2170 } 2171 ], 2172 "requestBody": { 2173 "content": { 2174 "application/json": { 2175 "schema": { 2176 "$ref": "#/components/schemas/AddonUpgradePolicy" 2177 } 2178 } 2179 } 2180 }, 2181 "responses": { 2182 "201": { 2183 "description": "Success.", 2184 "content": { 2185 "application/json": { 2186 "schema": { 2187 "$ref": "#/components/schemas/AddonUpgradePolicy" 2188 } 2189 } 2190 } 2191 }, 2192 "default": { 2193 "description": "Error.", 2194 "content": { 2195 "application/json": { 2196 "schema": { 2197 "$ref": "#/components/schemas/Error" 2198 } 2199 } 2200 } 2201 } 2202 } 2203 }, 2204 "get": { 2205 "description": "Retrieves the list of addon upgrade policies.", 2206 "parameters": [ 2207 { 2208 "name": "cluster_id", 2209 "in": "path", 2210 "schema": { 2211 "type": "string" 2212 }, 2213 "required": true 2214 }, 2215 { 2216 "name": "page", 2217 "description": "Index of the requested page, where one corresponds to the first page.", 2218 "in": "query", 2219 "schema": { 2220 "type": "integer", 2221 "format": "int32" 2222 } 2223 }, 2224 { 2225 "name": "size", 2226 "description": "Number of items contained in the returned page.", 2227 "in": "query", 2228 "schema": { 2229 "type": "integer", 2230 "format": "int32" 2231 } 2232 } 2233 ], 2234 "responses": { 2235 "200": { 2236 "description": "Success.", 2237 "content": { 2238 "application/json": { 2239 "schema": { 2240 "type": "object", 2241 "properties": { 2242 "items": { 2243 "description": "Retrieved list of addon upgrade policy.", 2244 "type": "array", 2245 "items": { 2246 "$ref": "#/components/schemas/AddonUpgradePolicy" 2247 } 2248 }, 2249 "page": { 2250 "description": "Index of the requested page, where one corresponds to the first page.", 2251 "type": "integer", 2252 "format": "int32" 2253 }, 2254 "size": { 2255 "description": "Number of items contained in the returned page.", 2256 "type": "integer", 2257 "format": "int32" 2258 }, 2259 "total": { 2260 "description": "Total number of items of the collection.", 2261 "type": "integer", 2262 "format": "int32" 2263 } 2264 } 2265 } 2266 } 2267 } 2268 }, 2269 "default": { 2270 "description": "Error.", 2271 "content": { 2272 "application/json": { 2273 "schema": { 2274 "$ref": "#/components/schemas/Error" 2275 } 2276 } 2277 } 2278 } 2279 } 2280 } 2281 }, 2282 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addon_upgrade_policies/{addon_upgrade_policy_id}": { 2283 "delete": { 2284 "description": "Deletes the addon upgrade policy.", 2285 "parameters": [ 2286 { 2287 "name": "cluster_id", 2288 "in": "path", 2289 "schema": { 2290 "type": "string" 2291 }, 2292 "required": true 2293 }, 2294 { 2295 "name": "addon_upgrade_policy_id", 2296 "in": "path", 2297 "schema": { 2298 "type": "string" 2299 }, 2300 "required": true 2301 } 2302 ], 2303 "responses": { 2304 "204": { 2305 "description": "Success." 2306 }, 2307 "default": { 2308 "description": "Error.", 2309 "content": { 2310 "application/json": { 2311 "schema": { 2312 "$ref": "#/components/schemas/Error" 2313 } 2314 } 2315 } 2316 } 2317 } 2318 }, 2319 "get": { 2320 "description": "Retrieves the details of the addon upgrade policy.", 2321 "parameters": [ 2322 { 2323 "name": "cluster_id", 2324 "in": "path", 2325 "schema": { 2326 "type": "string" 2327 }, 2328 "required": true 2329 }, 2330 { 2331 "name": "addon_upgrade_policy_id", 2332 "in": "path", 2333 "schema": { 2334 "type": "string" 2335 }, 2336 "required": true 2337 } 2338 ], 2339 "responses": { 2340 "200": { 2341 "description": "Success.", 2342 "content": { 2343 "application/json": { 2344 "schema": { 2345 "$ref": "#/components/schemas/AddonUpgradePolicy" 2346 } 2347 } 2348 } 2349 }, 2350 "default": { 2351 "description": "Error.", 2352 "content": { 2353 "application/json": { 2354 "schema": { 2355 "$ref": "#/components/schemas/Error" 2356 } 2357 } 2358 } 2359 } 2360 } 2361 }, 2362 "patch": { 2363 "description": "Update the addon upgrade policy.", 2364 "parameters": [ 2365 { 2366 "name": "cluster_id", 2367 "in": "path", 2368 "schema": { 2369 "type": "string" 2370 }, 2371 "required": true 2372 }, 2373 { 2374 "name": "addon_upgrade_policy_id", 2375 "in": "path", 2376 "schema": { 2377 "type": "string" 2378 }, 2379 "required": true 2380 } 2381 ], 2382 "requestBody": { 2383 "content": { 2384 "application/json": { 2385 "schema": { 2386 "$ref": "#/components/schemas/AddonUpgradePolicy" 2387 } 2388 } 2389 } 2390 }, 2391 "responses": { 2392 "200": { 2393 "description": "Success.", 2394 "content": { 2395 "application/json": { 2396 "schema": { 2397 "$ref": "#/components/schemas/AddonUpgradePolicy" 2398 } 2399 } 2400 } 2401 }, 2402 "default": { 2403 "description": "Error.", 2404 "content": { 2405 "application/json": { 2406 "schema": { 2407 "$ref": "#/components/schemas/Error" 2408 } 2409 } 2410 } 2411 } 2412 } 2413 } 2414 }, 2415 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addon_upgrade_policies/{addon_upgrade_policy_id}/state": { 2416 "get": { 2417 "description": "Retrieves the details of the upgrade policy state.", 2418 "parameters": [ 2419 { 2420 "name": "cluster_id", 2421 "in": "path", 2422 "schema": { 2423 "type": "string" 2424 }, 2425 "required": true 2426 }, 2427 { 2428 "name": "addon_upgrade_policy_id", 2429 "in": "path", 2430 "schema": { 2431 "type": "string" 2432 }, 2433 "required": true 2434 } 2435 ], 2436 "responses": { 2437 "200": { 2438 "description": "Success.", 2439 "content": { 2440 "application/json": { 2441 "schema": { 2442 "$ref": "#/components/schemas/AddonUpgradePolicyState" 2443 } 2444 } 2445 } 2446 }, 2447 "default": { 2448 "description": "Error.", 2449 "content": { 2450 "application/json": { 2451 "schema": { 2452 "$ref": "#/components/schemas/Error" 2453 } 2454 } 2455 } 2456 } 2457 } 2458 }, 2459 "patch": { 2460 "description": "Update the upgrade policy state.", 2461 "parameters": [ 2462 { 2463 "name": "cluster_id", 2464 "in": "path", 2465 "schema": { 2466 "type": "string" 2467 }, 2468 "required": true 2469 }, 2470 { 2471 "name": "addon_upgrade_policy_id", 2472 "in": "path", 2473 "schema": { 2474 "type": "string" 2475 }, 2476 "required": true 2477 } 2478 ], 2479 "requestBody": { 2480 "content": { 2481 "application/json": { 2482 "schema": { 2483 "$ref": "#/components/schemas/AddonUpgradePolicyState" 2484 } 2485 } 2486 } 2487 }, 2488 "responses": { 2489 "200": { 2490 "description": "Success.", 2491 "content": { 2492 "application/json": { 2493 "schema": { 2494 "$ref": "#/components/schemas/AddonUpgradePolicyState" 2495 } 2496 } 2497 } 2498 }, 2499 "default": { 2500 "description": "Error.", 2501 "content": { 2502 "application/json": { 2503 "schema": { 2504 "$ref": "#/components/schemas/Error" 2505 } 2506 } 2507 } 2508 } 2509 } 2510 } 2511 }, 2512 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addons": { 2513 "post": { 2514 "description": "Create a new add-on installation and add it to the collection of add-on installations on the cluster.", 2515 "parameters": [ 2516 { 2517 "name": "cluster_id", 2518 "in": "path", 2519 "schema": { 2520 "type": "string" 2521 }, 2522 "required": true 2523 } 2524 ], 2525 "requestBody": { 2526 "content": { 2527 "application/json": { 2528 "schema": { 2529 "$ref": "#/components/schemas/AddOnInstallation" 2530 } 2531 } 2532 } 2533 }, 2534 "responses": { 2535 "201": { 2536 "description": "Success.", 2537 "content": { 2538 "application/json": { 2539 "schema": { 2540 "$ref": "#/components/schemas/AddOnInstallation" 2541 } 2542 } 2543 } 2544 }, 2545 "default": { 2546 "description": "Error.", 2547 "content": { 2548 "application/json": { 2549 "schema": { 2550 "$ref": "#/components/schemas/Error" 2551 } 2552 } 2553 } 2554 } 2555 } 2556 }, 2557 "get": { 2558 "description": "Retrieves the list of add-on installations.", 2559 "parameters": [ 2560 { 2561 "name": "cluster_id", 2562 "in": "path", 2563 "schema": { 2564 "type": "string" 2565 }, 2566 "required": true 2567 }, 2568 { 2569 "name": "order", 2570 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the add-on installation\ninstead of the names of the columns of a table. For example, in order to sort the\nadd-on installations descending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 2571 "in": "query", 2572 "schema": { 2573 "type": "string" 2574 } 2575 }, 2576 { 2577 "name": "page", 2578 "description": "Index of the requested page, where one corresponds to the first page.", 2579 "in": "query", 2580 "schema": { 2581 "type": "integer", 2582 "format": "int32" 2583 } 2584 }, 2585 { 2586 "name": "search", 2587 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the add-on installation\ninstead of the names of the columns of a table. For example, in order to retrieve\nall the add-on installations with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the add-on\ninstallations that the user has permission to see will be returned.", 2588 "in": "query", 2589 "schema": { 2590 "type": "string" 2591 } 2592 }, 2593 { 2594 "name": "size", 2595 "description": "Maximum number of items that will be contained in the returned page.", 2596 "in": "query", 2597 "schema": { 2598 "type": "integer", 2599 "format": "int32" 2600 } 2601 } 2602 ], 2603 "responses": { 2604 "200": { 2605 "description": "Success.", 2606 "content": { 2607 "application/json": { 2608 "schema": { 2609 "type": "object", 2610 "properties": { 2611 "items": { 2612 "description": "Retrieved list of add-on installations.", 2613 "type": "array", 2614 "items": { 2615 "$ref": "#/components/schemas/AddOnInstallation" 2616 } 2617 }, 2618 "page": { 2619 "description": "Index of the requested page, where one corresponds to the first page.", 2620 "type": "integer", 2621 "format": "int32" 2622 }, 2623 "size": { 2624 "description": "Maximum number of items that will be contained in the returned page.", 2625 "type": "integer", 2626 "format": "int32" 2627 }, 2628 "total": { 2629 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2630 "type": "integer", 2631 "format": "int32" 2632 } 2633 } 2634 } 2635 } 2636 } 2637 }, 2638 "default": { 2639 "description": "Error.", 2640 "content": { 2641 "application/json": { 2642 "schema": { 2643 "$ref": "#/components/schemas/Error" 2644 } 2645 } 2646 } 2647 } 2648 } 2649 } 2650 }, 2651 "/api/clusters_mgmt/v1/clusters/{cluster_id}/addons/{addoninstallation_id}": { 2652 "delete": { 2653 "description": "Delete an add-on installation and remove it from the collection of add-on installations on the cluster.", 2654 "parameters": [ 2655 { 2656 "name": "cluster_id", 2657 "in": "path", 2658 "schema": { 2659 "type": "string" 2660 }, 2661 "required": true 2662 }, 2663 { 2664 "name": "addoninstallation_id", 2665 "in": "path", 2666 "schema": { 2667 "type": "string" 2668 }, 2669 "required": true 2670 } 2671 ], 2672 "responses": { 2673 "204": { 2674 "description": "Success." 2675 }, 2676 "default": { 2677 "description": "Error.", 2678 "content": { 2679 "application/json": { 2680 "schema": { 2681 "$ref": "#/components/schemas/Error" 2682 } 2683 } 2684 } 2685 } 2686 } 2687 }, 2688 "get": { 2689 "description": "Retrieves the details of the add-on installation.", 2690 "parameters": [ 2691 { 2692 "name": "cluster_id", 2693 "in": "path", 2694 "schema": { 2695 "type": "string" 2696 }, 2697 "required": true 2698 }, 2699 { 2700 "name": "addoninstallation_id", 2701 "in": "path", 2702 "schema": { 2703 "type": "string" 2704 }, 2705 "required": true 2706 } 2707 ], 2708 "responses": { 2709 "200": { 2710 "description": "Success.", 2711 "content": { 2712 "application/json": { 2713 "schema": { 2714 "$ref": "#/components/schemas/AddOnInstallation" 2715 } 2716 } 2717 } 2718 }, 2719 "default": { 2720 "description": "Error.", 2721 "content": { 2722 "application/json": { 2723 "schema": { 2724 "$ref": "#/components/schemas/Error" 2725 } 2726 } 2727 } 2728 } 2729 } 2730 }, 2731 "patch": { 2732 "description": "Updates the add-on installation.", 2733 "parameters": [ 2734 { 2735 "name": "cluster_id", 2736 "in": "path", 2737 "schema": { 2738 "type": "string" 2739 }, 2740 "required": true 2741 }, 2742 { 2743 "name": "addoninstallation_id", 2744 "in": "path", 2745 "schema": { 2746 "type": "string" 2747 }, 2748 "required": true 2749 } 2750 ], 2751 "requestBody": { 2752 "content": { 2753 "application/json": { 2754 "schema": { 2755 "$ref": "#/components/schemas/AddOnInstallation" 2756 } 2757 } 2758 } 2759 }, 2760 "responses": { 2761 "200": { 2762 "description": "Success.", 2763 "content": { 2764 "application/json": { 2765 "schema": { 2766 "$ref": "#/components/schemas/AddOnInstallation" 2767 } 2768 } 2769 } 2770 }, 2771 "default": { 2772 "description": "Error.", 2773 "content": { 2774 "application/json": { 2775 "schema": { 2776 "$ref": "#/components/schemas/Error" 2777 } 2778 } 2779 } 2780 } 2781 } 2782 } 2783 }, 2784 "/api/clusters_mgmt/v1/clusters/{cluster_id}/autoscaler": { 2785 "delete": { 2786 "description": "Deletes the cluster autoscaler.", 2787 "parameters": [ 2788 { 2789 "name": "cluster_id", 2790 "in": "path", 2791 "schema": { 2792 "type": "string" 2793 }, 2794 "required": true 2795 } 2796 ], 2797 "responses": { 2798 "204": { 2799 "description": "Success." 2800 }, 2801 "default": { 2802 "description": "Error.", 2803 "content": { 2804 "application/json": { 2805 "schema": { 2806 "$ref": "#/components/schemas/Error" 2807 } 2808 } 2809 } 2810 } 2811 } 2812 }, 2813 "get": { 2814 "description": "Retrieves the autoscaler of a cluster.", 2815 "parameters": [ 2816 { 2817 "name": "cluster_id", 2818 "in": "path", 2819 "schema": { 2820 "type": "string" 2821 }, 2822 "required": true 2823 } 2824 ], 2825 "responses": { 2826 "200": { 2827 "description": "Success.", 2828 "content": { 2829 "application/json": { 2830 "schema": { 2831 "$ref": "#/components/schemas/ClusterAutoscaler" 2832 } 2833 } 2834 } 2835 }, 2836 "default": { 2837 "description": "Error.", 2838 "content": { 2839 "application/json": { 2840 "schema": { 2841 "$ref": "#/components/schemas/Error" 2842 } 2843 } 2844 } 2845 } 2846 } 2847 }, 2848 "post": { 2849 "description": "Creates a new cluster autoscaler object.", 2850 "parameters": [ 2851 { 2852 "name": "cluster_id", 2853 "in": "path", 2854 "schema": { 2855 "type": "string" 2856 }, 2857 "required": true 2858 } 2859 ], 2860 "requestBody": { 2861 "content": { 2862 "application/json": { 2863 "schema": { 2864 "$ref": "#/components/schemas/ClusterAutoscaler" 2865 } 2866 } 2867 } 2868 }, 2869 "responses": { 2870 "201": { 2871 "description": "Success.", 2872 "content": { 2873 "application/json": { 2874 "schema": { 2875 "$ref": "#/components/schemas/ClusterAutoscaler" 2876 } 2877 } 2878 } 2879 }, 2880 "default": { 2881 "description": "Error.", 2882 "content": { 2883 "application/json": { 2884 "schema": { 2885 "$ref": "#/components/schemas/Error" 2886 } 2887 } 2888 } 2889 } 2890 } 2891 }, 2892 "patch": { 2893 "description": "Updates the cluster autoscaler.", 2894 "parameters": [ 2895 { 2896 "name": "cluster_id", 2897 "in": "path", 2898 "schema": { 2899 "type": "string" 2900 }, 2901 "required": true 2902 } 2903 ], 2904 "requestBody": { 2905 "content": { 2906 "application/json": { 2907 "schema": { 2908 "$ref": "#/components/schemas/ClusterAutoscaler" 2909 } 2910 } 2911 } 2912 }, 2913 "responses": { 2914 "200": { 2915 "description": "Success.", 2916 "content": { 2917 "application/json": { 2918 "schema": { 2919 "$ref": "#/components/schemas/ClusterAutoscaler" 2920 } 2921 } 2922 } 2923 }, 2924 "default": { 2925 "description": "Error.", 2926 "content": { 2927 "application/json": { 2928 "schema": { 2929 "$ref": "#/components/schemas/Error" 2930 } 2931 } 2932 } 2933 } 2934 } 2935 } 2936 }, 2937 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws/private_link_configuration": { 2938 "get": { 2939 "description": "Retrieves the details of the configuration for the Private Link.", 2940 "parameters": [ 2941 { 2942 "name": "cluster_id", 2943 "in": "path", 2944 "schema": { 2945 "type": "string" 2946 }, 2947 "required": true 2948 } 2949 ], 2950 "responses": { 2951 "200": { 2952 "description": "Success.", 2953 "content": { 2954 "application/json": { 2955 "schema": { 2956 "$ref": "#/components/schemas/PrivateLinkConfiguration" 2957 } 2958 } 2959 } 2960 }, 2961 "default": { 2962 "description": "Error.", 2963 "content": { 2964 "application/json": { 2965 "schema": { 2966 "$ref": "#/components/schemas/Error" 2967 } 2968 } 2969 } 2970 } 2971 } 2972 } 2973 }, 2974 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws/private_link_configuration/principals": { 2975 "post": { 2976 "description": "Adds a new principal for the Private Link.", 2977 "parameters": [ 2978 { 2979 "name": "cluster_id", 2980 "in": "path", 2981 "schema": { 2982 "type": "string" 2983 }, 2984 "required": true 2985 } 2986 ], 2987 "requestBody": { 2988 "content": { 2989 "application/json": { 2990 "schema": { 2991 "$ref": "#/components/schemas/PrivateLinkPrincipal" 2992 } 2993 } 2994 } 2995 }, 2996 "responses": { 2997 "201": { 2998 "description": "Success.", 2999 "content": { 3000 "application/json": { 3001 "schema": { 3002 "$ref": "#/components/schemas/PrivateLinkPrincipal" 3003 } 3004 } 3005 } 3006 }, 3007 "default": { 3008 "description": "Error.", 3009 "content": { 3010 "application/json": { 3011 "schema": { 3012 "$ref": "#/components/schemas/Error" 3013 } 3014 } 3015 } 3016 } 3017 } 3018 }, 3019 "get": { 3020 "description": "Retrieves the list of principals.", 3021 "parameters": [ 3022 { 3023 "name": "cluster_id", 3024 "in": "path", 3025 "schema": { 3026 "type": "string" 3027 }, 3028 "required": true 3029 }, 3030 { 3031 "name": "page", 3032 "description": "Index of the requested page, where one corresponds to the first page.", 3033 "in": "query", 3034 "schema": { 3035 "type": "integer", 3036 "format": "int32" 3037 } 3038 }, 3039 { 3040 "name": "search", 3041 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the role binding\ninstead of the names of the columns of a table. For example, in order to\nretrieve role bindings with role_id AuthenticatedUser:\n\n```sql\nrole_id = 'AuthenticatedUser'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 3042 "in": "query", 3043 "schema": { 3044 "type": "string" 3045 } 3046 }, 3047 { 3048 "name": "size", 3049 "description": "Number of items contained in the returned page.", 3050 "in": "query", 3051 "schema": { 3052 "type": "integer", 3053 "format": "int32" 3054 } 3055 } 3056 ], 3057 "responses": { 3058 "200": { 3059 "description": "Success.", 3060 "content": { 3061 "application/json": { 3062 "schema": { 3063 "type": "object", 3064 "properties": { 3065 "items": { 3066 "description": "Retrieved list of principals.", 3067 "type": "array", 3068 "items": { 3069 "$ref": "#/components/schemas/PrivateLinkPrincipal" 3070 } 3071 }, 3072 "page": { 3073 "description": "Index of the requested page, where one corresponds to the first page.", 3074 "type": "integer", 3075 "format": "int32" 3076 }, 3077 "size": { 3078 "description": "Number of items contained in the returned page.", 3079 "type": "integer", 3080 "format": "int32" 3081 }, 3082 "total": { 3083 "description": "Total number of items of the collection.", 3084 "type": "integer", 3085 "format": "int32" 3086 } 3087 } 3088 } 3089 } 3090 } 3091 }, 3092 "default": { 3093 "description": "Error.", 3094 "content": { 3095 "application/json": { 3096 "schema": { 3097 "$ref": "#/components/schemas/Error" 3098 } 3099 } 3100 } 3101 } 3102 } 3103 } 3104 }, 3105 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws/private_link_configuration/principals/{principal_id}": { 3106 "delete": { 3107 "description": "Deletes the principal.", 3108 "parameters": [ 3109 { 3110 "name": "cluster_id", 3111 "in": "path", 3112 "schema": { 3113 "type": "string" 3114 }, 3115 "required": true 3116 }, 3117 { 3118 "name": "principal_id", 3119 "in": "path", 3120 "schema": { 3121 "type": "string" 3122 }, 3123 "required": true 3124 } 3125 ], 3126 "responses": { 3127 "204": { 3128 "description": "Success." 3129 }, 3130 "default": { 3131 "description": "Error.", 3132 "content": { 3133 "application/json": { 3134 "schema": { 3135 "$ref": "#/components/schemas/Error" 3136 } 3137 } 3138 } 3139 } 3140 } 3141 }, 3142 "get": { 3143 "description": "Retrieves the details of the principal.", 3144 "parameters": [ 3145 { 3146 "name": "cluster_id", 3147 "in": "path", 3148 "schema": { 3149 "type": "string" 3150 }, 3151 "required": true 3152 }, 3153 { 3154 "name": "principal_id", 3155 "in": "path", 3156 "schema": { 3157 "type": "string" 3158 }, 3159 "required": true 3160 } 3161 ], 3162 "responses": { 3163 "200": { 3164 "description": "Success.", 3165 "content": { 3166 "application/json": { 3167 "schema": { 3168 "$ref": "#/components/schemas/PrivateLinkPrincipal" 3169 } 3170 } 3171 } 3172 }, 3173 "default": { 3174 "description": "Error.", 3175 "content": { 3176 "application/json": { 3177 "schema": { 3178 "$ref": "#/components/schemas/Error" 3179 } 3180 } 3181 } 3182 } 3183 } 3184 } 3185 }, 3186 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws/role_policy_bindings": { 3187 "get": { 3188 "parameters": [ 3189 { 3190 "name": "cluster_id", 3191 "in": "path", 3192 "schema": { 3193 "type": "string" 3194 }, 3195 "required": true 3196 }, 3197 { 3198 "name": "fetchCurrent", 3199 "description": "If true, retrieves role policy binding states from AWS.", 3200 "in": "query", 3201 "schema": { 3202 "type": "boolean" 3203 } 3204 }, 3205 { 3206 "name": "page", 3207 "description": "Index of the requested page, where one corresponds to the first page.", 3208 "in": "query", 3209 "schema": { 3210 "type": "integer", 3211 "format": "int32" 3212 } 3213 }, 3214 { 3215 "name": "size", 3216 "description": "Number of items contained in the returned page.", 3217 "in": "query", 3218 "schema": { 3219 "type": "integer", 3220 "format": "int32" 3221 } 3222 } 3223 ], 3224 "responses": { 3225 "200": { 3226 "description": "Success.", 3227 "content": { 3228 "application/json": { 3229 "schema": { 3230 "type": "object", 3231 "properties": { 3232 "items": { 3233 "description": "Retrieved list of role policy bindings.", 3234 "type": "array", 3235 "items": { 3236 "$ref": "#/components/schemas/RolePolicyBinding" 3237 } 3238 }, 3239 "page": { 3240 "description": "Index of the requested page, where one corresponds to the first page.", 3241 "type": "integer", 3242 "format": "int32" 3243 }, 3244 "size": { 3245 "description": "Number of items contained in the returned page.", 3246 "type": "integer", 3247 "format": "int32" 3248 }, 3249 "total": { 3250 "description": "Total number of items of the collection.", 3251 "type": "integer", 3252 "format": "int32" 3253 } 3254 } 3255 } 3256 } 3257 } 3258 }, 3259 "default": { 3260 "description": "Error.", 3261 "content": { 3262 "application/json": { 3263 "schema": { 3264 "$ref": "#/components/schemas/Error" 3265 } 3266 } 3267 } 3268 } 3269 } 3270 } 3271 }, 3272 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws_infrastructure_access_role_grants": { 3273 "post": { 3274 "description": "Create a new AWS infrastructure access role grant and add it to the collection of\nAWS infrastructure access role grants on the cluster.", 3275 "parameters": [ 3276 { 3277 "name": "cluster_id", 3278 "in": "path", 3279 "schema": { 3280 "type": "string" 3281 }, 3282 "required": true 3283 } 3284 ], 3285 "requestBody": { 3286 "content": { 3287 "application/json": { 3288 "schema": { 3289 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrant" 3290 } 3291 } 3292 } 3293 }, 3294 "responses": { 3295 "201": { 3296 "description": "Success.", 3297 "content": { 3298 "application/json": { 3299 "schema": { 3300 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrant" 3301 } 3302 } 3303 } 3304 }, 3305 "default": { 3306 "description": "Error.", 3307 "content": { 3308 "application/json": { 3309 "schema": { 3310 "$ref": "#/components/schemas/Error" 3311 } 3312 } 3313 } 3314 } 3315 } 3316 }, 3317 "get": { 3318 "description": "Retrieves the list of AWS infrastructure access role grants.", 3319 "parameters": [ 3320 { 3321 "name": "cluster_id", 3322 "in": "path", 3323 "schema": { 3324 "type": "string" 3325 }, 3326 "required": true 3327 }, 3328 { 3329 "name": "order", 3330 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the AWS infrastructure access role grant\ninstead of the names of the columns of a table. For example, in order to sort the\nAWS infrastructure access role grants descending by user ARN the value should be:\n\n```sql\nuser_arn desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 3331 "in": "query", 3332 "schema": { 3333 "type": "string" 3334 } 3335 }, 3336 { 3337 "name": "page", 3338 "description": "Index of the requested page, where one corresponds to the first page.", 3339 "in": "query", 3340 "schema": { 3341 "type": "integer", 3342 "format": "int32" 3343 } 3344 }, 3345 { 3346 "name": "search", 3347 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the AWS infrastructure access role grant\ninstead of the names of the columns of a table. For example, in order to retrieve\nall the AWS infrastructure access role grants with a user ARN starting with `user` the value should be:\n\n```sql\nuser_arn like '%user'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the AWS\ninfrastructure access role grants that the user has permission to see will be returned.", 3348 "in": "query", 3349 "schema": { 3350 "type": "string" 3351 } 3352 }, 3353 { 3354 "name": "size", 3355 "description": "Maximum number of items that will be contained in the returned page.", 3356 "in": "query", 3357 "schema": { 3358 "type": "integer", 3359 "format": "int32" 3360 } 3361 } 3362 ], 3363 "responses": { 3364 "200": { 3365 "description": "Success.", 3366 "content": { 3367 "application/json": { 3368 "schema": { 3369 "type": "object", 3370 "properties": { 3371 "items": { 3372 "description": "Retrieved list of AWS infrastructure access role grants.", 3373 "type": "array", 3374 "items": { 3375 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrant" 3376 } 3377 }, 3378 "page": { 3379 "description": "Index of the requested page, where one corresponds to the first page.", 3380 "type": "integer", 3381 "format": "int32" 3382 }, 3383 "size": { 3384 "description": "Maximum number of items that will be contained in the returned page.", 3385 "type": "integer", 3386 "format": "int32" 3387 }, 3388 "total": { 3389 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 3390 "type": "integer", 3391 "format": "int32" 3392 } 3393 } 3394 } 3395 } 3396 } 3397 }, 3398 "default": { 3399 "description": "Error.", 3400 "content": { 3401 "application/json": { 3402 "schema": { 3403 "$ref": "#/components/schemas/Error" 3404 } 3405 } 3406 } 3407 } 3408 } 3409 } 3410 }, 3411 "/api/clusters_mgmt/v1/clusters/{cluster_id}/aws_infrastructure_access_role_grants/{aws_infrastructure_access_role_grant_id}": { 3412 "delete": { 3413 "description": "Deletes the AWS infrastructure access role grant.", 3414 "parameters": [ 3415 { 3416 "name": "cluster_id", 3417 "in": "path", 3418 "schema": { 3419 "type": "string" 3420 }, 3421 "required": true 3422 }, 3423 { 3424 "name": "aws_infrastructure_access_role_grant_id", 3425 "in": "path", 3426 "schema": { 3427 "type": "string" 3428 }, 3429 "required": true 3430 } 3431 ], 3432 "responses": { 3433 "204": { 3434 "description": "Success." 3435 }, 3436 "default": { 3437 "description": "Error.", 3438 "content": { 3439 "application/json": { 3440 "schema": { 3441 "$ref": "#/components/schemas/Error" 3442 } 3443 } 3444 } 3445 } 3446 } 3447 }, 3448 "get": { 3449 "description": "Retrieves the details of the AWS infrastructure access role grant.", 3450 "parameters": [ 3451 { 3452 "name": "cluster_id", 3453 "in": "path", 3454 "schema": { 3455 "type": "string" 3456 }, 3457 "required": true 3458 }, 3459 { 3460 "name": "aws_infrastructure_access_role_grant_id", 3461 "in": "path", 3462 "schema": { 3463 "type": "string" 3464 }, 3465 "required": true 3466 } 3467 ], 3468 "responses": { 3469 "200": { 3470 "description": "Success.", 3471 "content": { 3472 "application/json": { 3473 "schema": { 3474 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrant" 3475 } 3476 } 3477 } 3478 }, 3479 "default": { 3480 "description": "Error.", 3481 "content": { 3482 "application/json": { 3483 "schema": { 3484 "$ref": "#/components/schemas/Error" 3485 } 3486 } 3487 } 3488 } 3489 } 3490 } 3491 }, 3492 "/api/clusters_mgmt/v1/clusters/{cluster_id}/break_glass_credentials": { 3493 "post": { 3494 "description": "Adds a new break glass credential to the cluster.", 3495 "parameters": [ 3496 { 3497 "name": "cluster_id", 3498 "in": "path", 3499 "schema": { 3500 "type": "string" 3501 }, 3502 "required": true 3503 } 3504 ], 3505 "requestBody": { 3506 "content": { 3507 "application/json": { 3508 "schema": { 3509 "$ref": "#/components/schemas/BreakGlassCredential" 3510 } 3511 } 3512 } 3513 }, 3514 "responses": { 3515 "201": { 3516 "description": "Success.", 3517 "content": { 3518 "application/json": { 3519 "schema": { 3520 "$ref": "#/components/schemas/BreakGlassCredential" 3521 } 3522 } 3523 } 3524 }, 3525 "default": { 3526 "description": "Error.", 3527 "content": { 3528 "application/json": { 3529 "schema": { 3530 "$ref": "#/components/schemas/Error" 3531 } 3532 } 3533 } 3534 } 3535 } 3536 }, 3537 "delete": { 3538 "description": "Revokes all the break glass certificates signed by a specific signer.", 3539 "parameters": [ 3540 { 3541 "name": "cluster_id", 3542 "in": "path", 3543 "schema": { 3544 "type": "string" 3545 }, 3546 "required": true 3547 } 3548 ], 3549 "responses": { 3550 "204": { 3551 "description": "Success." 3552 }, 3553 "default": { 3554 "description": "Error.", 3555 "content": { 3556 "application/json": { 3557 "schema": { 3558 "$ref": "#/components/schemas/Error" 3559 } 3560 } 3561 } 3562 } 3563 } 3564 }, 3565 "get": { 3566 "description": "Retrieves the list of break glass credentials.", 3567 "parameters": [ 3568 { 3569 "name": "cluster_id", 3570 "in": "path", 3571 "schema": { 3572 "type": "string" 3573 }, 3574 "required": true 3575 }, 3576 { 3577 "name": "order", 3578 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the break glass credentials\ninstead of the the names of the columns of a table. For example, in order to sort the\ncredentials descending by identifier the value should be:\n\n```sql\nid desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 3579 "in": "query", 3580 "schema": { 3581 "type": "string" 3582 } 3583 }, 3584 { 3585 "name": "page", 3586 "description": "Index of the requested page, where one corresponds to the first page.", 3587 "in": "query", 3588 "schema": { 3589 "type": "integer", 3590 "format": "int32" 3591 } 3592 }, 3593 { 3594 "name": "search", 3595 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the break glass credentials\ninstead of the names of the columns of a table. For example, in order to retrieve all\nthe credentials with a specific username and status the following is required:\n\n```sql\nusername='user1' AND status='expired'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nbreak glass credentials that the user has permission to see will be returned.", 3596 "in": "query", 3597 "schema": { 3598 "type": "string" 3599 } 3600 }, 3601 { 3602 "name": "size", 3603 "description": "Number of items contained in the returned page.", 3604 "in": "query", 3605 "schema": { 3606 "type": "integer", 3607 "format": "int32" 3608 } 3609 } 3610 ], 3611 "responses": { 3612 "200": { 3613 "description": "Success.", 3614 "content": { 3615 "application/json": { 3616 "schema": { 3617 "type": "object", 3618 "properties": { 3619 "items": { 3620 "description": "Retrieved list of break glass credentials.", 3621 "type": "array", 3622 "items": { 3623 "$ref": "#/components/schemas/BreakGlassCredential" 3624 } 3625 }, 3626 "page": { 3627 "description": "Index of the requested page, where one corresponds to the first page.", 3628 "type": "integer", 3629 "format": "int32" 3630 }, 3631 "size": { 3632 "description": "Number of items contained in the returned page.", 3633 "type": "integer", 3634 "format": "int32" 3635 }, 3636 "total": { 3637 "description": "Total number of items of the collection.", 3638 "type": "integer", 3639 "format": "int32" 3640 } 3641 } 3642 } 3643 } 3644 } 3645 }, 3646 "default": { 3647 "description": "Error.", 3648 "content": { 3649 "application/json": { 3650 "schema": { 3651 "$ref": "#/components/schemas/Error" 3652 } 3653 } 3654 } 3655 } 3656 } 3657 } 3658 }, 3659 "/api/clusters_mgmt/v1/clusters/{cluster_id}/break_glass_credentials/{break_glass_credential_id}": { 3660 "get": { 3661 "description": "Retrieves the details of the break glass credential.", 3662 "parameters": [ 3663 { 3664 "name": "cluster_id", 3665 "in": "path", 3666 "schema": { 3667 "type": "string" 3668 }, 3669 "required": true 3670 }, 3671 { 3672 "name": "break_glass_credential_id", 3673 "in": "path", 3674 "schema": { 3675 "type": "string" 3676 }, 3677 "required": true 3678 } 3679 ], 3680 "responses": { 3681 "200": { 3682 "description": "Success.", 3683 "content": { 3684 "application/json": { 3685 "schema": { 3686 "$ref": "#/components/schemas/BreakGlassCredential" 3687 } 3688 } 3689 } 3690 }, 3691 "default": { 3692 "description": "Error.", 3693 "content": { 3694 "application/json": { 3695 "schema": { 3696 "$ref": "#/components/schemas/Error" 3697 } 3698 } 3699 } 3700 } 3701 } 3702 } 3703 }, 3704 "/api/clusters_mgmt/v1/clusters/{cluster_id}/clusterdeployment": { 3705 "delete": { 3706 "description": "Deletes the clusterdeployment.", 3707 "parameters": [ 3708 { 3709 "name": "cluster_id", 3710 "in": "path", 3711 "schema": { 3712 "type": "string" 3713 }, 3714 "required": true 3715 } 3716 ], 3717 "responses": { 3718 "204": { 3719 "description": "Success." 3720 }, 3721 "default": { 3722 "description": "Error.", 3723 "content": { 3724 "application/json": { 3725 "schema": { 3726 "$ref": "#/components/schemas/Error" 3727 } 3728 } 3729 } 3730 } 3731 } 3732 } 3733 }, 3734 "/api/clusters_mgmt/v1/clusters/{cluster_id}/control_plane/upgrade_policies": { 3735 "post": { 3736 "description": "Adds a new upgrade policy to the control plane of the cluster.", 3737 "parameters": [ 3738 { 3739 "name": "cluster_id", 3740 "in": "path", 3741 "schema": { 3742 "type": "string" 3743 }, 3744 "required": true 3745 } 3746 ], 3747 "requestBody": { 3748 "content": { 3749 "application/json": { 3750 "schema": { 3751 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3752 } 3753 } 3754 } 3755 }, 3756 "responses": { 3757 "201": { 3758 "description": "Success.", 3759 "content": { 3760 "application/json": { 3761 "schema": { 3762 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3763 } 3764 } 3765 } 3766 }, 3767 "default": { 3768 "description": "Error.", 3769 "content": { 3770 "application/json": { 3771 "schema": { 3772 "$ref": "#/components/schemas/Error" 3773 } 3774 } 3775 } 3776 } 3777 } 3778 }, 3779 "get": { 3780 "description": "Retrieves the list of upgrade policies for the control plane.", 3781 "parameters": [ 3782 { 3783 "name": "cluster_id", 3784 "in": "path", 3785 "schema": { 3786 "type": "string" 3787 }, 3788 "required": true 3789 }, 3790 { 3791 "name": "page", 3792 "description": "Index of the requested page, where one corresponds to the first page.", 3793 "in": "query", 3794 "schema": { 3795 "type": "integer", 3796 "format": "int32" 3797 } 3798 }, 3799 { 3800 "name": "size", 3801 "description": "Number of items contained in the returned page.", 3802 "in": "query", 3803 "schema": { 3804 "type": "integer", 3805 "format": "int32" 3806 } 3807 } 3808 ], 3809 "responses": { 3810 "200": { 3811 "description": "Success.", 3812 "content": { 3813 "application/json": { 3814 "schema": { 3815 "type": "object", 3816 "properties": { 3817 "items": { 3818 "description": "Retrieved list of upgrade policy.", 3819 "type": "array", 3820 "items": { 3821 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3822 } 3823 }, 3824 "page": { 3825 "description": "Index of the requested page, where one corresponds to the first page.", 3826 "type": "integer", 3827 "format": "int32" 3828 }, 3829 "size": { 3830 "description": "Number of items contained in the returned page.", 3831 "type": "integer", 3832 "format": "int32" 3833 }, 3834 "total": { 3835 "description": "Total number of items of the collection.", 3836 "type": "integer", 3837 "format": "int32" 3838 } 3839 } 3840 } 3841 } 3842 } 3843 }, 3844 "default": { 3845 "description": "Error.", 3846 "content": { 3847 "application/json": { 3848 "schema": { 3849 "$ref": "#/components/schemas/Error" 3850 } 3851 } 3852 } 3853 } 3854 } 3855 } 3856 }, 3857 "/api/clusters_mgmt/v1/clusters/{cluster_id}/control_plane/upgrade_policies/{control_plane_upgrade_policy_id}": { 3858 "delete": { 3859 "description": "Deletes the upgrade policy for the control plane.", 3860 "parameters": [ 3861 { 3862 "name": "cluster_id", 3863 "in": "path", 3864 "schema": { 3865 "type": "string" 3866 }, 3867 "required": true 3868 }, 3869 { 3870 "name": "control_plane_upgrade_policy_id", 3871 "in": "path", 3872 "schema": { 3873 "type": "string" 3874 }, 3875 "required": true 3876 } 3877 ], 3878 "responses": { 3879 "204": { 3880 "description": "Success." 3881 }, 3882 "default": { 3883 "description": "Error.", 3884 "content": { 3885 "application/json": { 3886 "schema": { 3887 "$ref": "#/components/schemas/Error" 3888 } 3889 } 3890 } 3891 } 3892 } 3893 }, 3894 "get": { 3895 "description": "Retrieves the details of the upgrade policy for the control plane.", 3896 "parameters": [ 3897 { 3898 "name": "cluster_id", 3899 "in": "path", 3900 "schema": { 3901 "type": "string" 3902 }, 3903 "required": true 3904 }, 3905 { 3906 "name": "control_plane_upgrade_policy_id", 3907 "in": "path", 3908 "schema": { 3909 "type": "string" 3910 }, 3911 "required": true 3912 } 3913 ], 3914 "responses": { 3915 "200": { 3916 "description": "Success.", 3917 "content": { 3918 "application/json": { 3919 "schema": { 3920 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3921 } 3922 } 3923 } 3924 }, 3925 "default": { 3926 "description": "Error.", 3927 "content": { 3928 "application/json": { 3929 "schema": { 3930 "$ref": "#/components/schemas/Error" 3931 } 3932 } 3933 } 3934 } 3935 } 3936 }, 3937 "patch": { 3938 "description": "Update the upgrade policy for the control plane.", 3939 "parameters": [ 3940 { 3941 "name": "cluster_id", 3942 "in": "path", 3943 "schema": { 3944 "type": "string" 3945 }, 3946 "required": true 3947 }, 3948 { 3949 "name": "control_plane_upgrade_policy_id", 3950 "in": "path", 3951 "schema": { 3952 "type": "string" 3953 }, 3954 "required": true 3955 } 3956 ], 3957 "requestBody": { 3958 "content": { 3959 "application/json": { 3960 "schema": { 3961 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3962 } 3963 } 3964 } 3965 }, 3966 "responses": { 3967 "200": { 3968 "description": "Success.", 3969 "content": { 3970 "application/json": { 3971 "schema": { 3972 "$ref": "#/components/schemas/ControlPlaneUpgradePolicy" 3973 } 3974 } 3975 } 3976 }, 3977 "default": { 3978 "description": "Error.", 3979 "content": { 3980 "application/json": { 3981 "schema": { 3982 "$ref": "#/components/schemas/Error" 3983 } 3984 } 3985 } 3986 } 3987 } 3988 } 3989 }, 3990 "/api/clusters_mgmt/v1/clusters/{cluster_id}/credentials": { 3991 "get": { 3992 "description": "Retrieves the details of the credentials of a cluster.", 3993 "parameters": [ 3994 { 3995 "name": "cluster_id", 3996 "in": "path", 3997 "schema": { 3998 "type": "string" 3999 }, 4000 "required": true 4001 } 4002 ], 4003 "responses": { 4004 "200": { 4005 "description": "Success.", 4006 "content": { 4007 "application/json": { 4008 "schema": { 4009 "$ref": "#/components/schemas/ClusterCredentials" 4010 } 4011 } 4012 } 4013 }, 4014 "default": { 4015 "description": "Error.", 4016 "content": { 4017 "application/json": { 4018 "schema": { 4019 "$ref": "#/components/schemas/Error" 4020 } 4021 } 4022 } 4023 } 4024 } 4025 } 4026 }, 4027 "/api/clusters_mgmt/v1/clusters/{cluster_id}/delete_protection": { 4028 "get": { 4029 "parameters": [ 4030 { 4031 "name": "cluster_id", 4032 "in": "path", 4033 "schema": { 4034 "type": "string" 4035 }, 4036 "required": true 4037 } 4038 ], 4039 "responses": { 4040 "200": { 4041 "description": "Success.", 4042 "content": { 4043 "application/json": { 4044 "schema": { 4045 "$ref": "#/components/schemas/DeleteProtection" 4046 } 4047 } 4048 } 4049 }, 4050 "default": { 4051 "description": "Error.", 4052 "content": { 4053 "application/json": { 4054 "schema": { 4055 "$ref": "#/components/schemas/Error" 4056 } 4057 } 4058 } 4059 } 4060 } 4061 }, 4062 "patch": { 4063 "parameters": [ 4064 { 4065 "name": "cluster_id", 4066 "in": "path", 4067 "schema": { 4068 "type": "string" 4069 }, 4070 "required": true 4071 } 4072 ], 4073 "requestBody": { 4074 "content": { 4075 "application/json": { 4076 "schema": { 4077 "$ref": "#/components/schemas/DeleteProtection" 4078 } 4079 } 4080 } 4081 }, 4082 "responses": { 4083 "200": { 4084 "description": "Success.", 4085 "content": { 4086 "application/json": { 4087 "schema": { 4088 "$ref": "#/components/schemas/DeleteProtection" 4089 } 4090 } 4091 } 4092 }, 4093 "default": { 4094 "description": "Error.", 4095 "content": { 4096 "application/json": { 4097 "schema": { 4098 "$ref": "#/components/schemas/Error" 4099 } 4100 } 4101 } 4102 } 4103 } 4104 } 4105 }, 4106 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_auth_config": { 4107 "get": { 4108 "parameters": [ 4109 { 4110 "name": "cluster_id", 4111 "in": "path", 4112 "schema": { 4113 "type": "string" 4114 }, 4115 "required": true 4116 } 4117 ], 4118 "responses": { 4119 "200": { 4120 "description": "Success.", 4121 "content": { 4122 "application/json": { 4123 "schema": { 4124 "$ref": "#/components/schemas/ExternalAuthConfig" 4125 } 4126 } 4127 } 4128 }, 4129 "default": { 4130 "description": "Error.", 4131 "content": { 4132 "application/json": { 4133 "schema": { 4134 "$ref": "#/components/schemas/Error" 4135 } 4136 } 4137 } 4138 } 4139 } 4140 } 4141 }, 4142 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_auth_config/external_auths": { 4143 "post": { 4144 "description": "Adds a new authentication to the cluster.", 4145 "parameters": [ 4146 { 4147 "name": "cluster_id", 4148 "in": "path", 4149 "schema": { 4150 "type": "string" 4151 }, 4152 "required": true 4153 } 4154 ], 4155 "requestBody": { 4156 "content": { 4157 "application/json": { 4158 "schema": { 4159 "$ref": "#/components/schemas/ExternalAuth" 4160 } 4161 } 4162 } 4163 }, 4164 "responses": { 4165 "201": { 4166 "description": "Success.", 4167 "content": { 4168 "application/json": { 4169 "schema": { 4170 "$ref": "#/components/schemas/ExternalAuth" 4171 } 4172 } 4173 } 4174 }, 4175 "default": { 4176 "description": "Error.", 4177 "content": { 4178 "application/json": { 4179 "schema": { 4180 "$ref": "#/components/schemas/Error" 4181 } 4182 } 4183 } 4184 } 4185 } 4186 }, 4187 "get": { 4188 "parameters": [ 4189 { 4190 "name": "cluster_id", 4191 "in": "path", 4192 "schema": { 4193 "type": "string" 4194 }, 4195 "required": true 4196 }, 4197 { 4198 "name": "page", 4199 "description": "Index of the requested page, where one corresponds to the first page.", 4200 "in": "query", 4201 "schema": { 4202 "type": "integer", 4203 "format": "int32" 4204 } 4205 }, 4206 { 4207 "name": "size", 4208 "description": "Number of items contained in the returned page.", 4209 "in": "query", 4210 "schema": { 4211 "type": "integer", 4212 "format": "int32" 4213 } 4214 } 4215 ], 4216 "responses": { 4217 "200": { 4218 "description": "Success.", 4219 "content": { 4220 "application/json": { 4221 "schema": { 4222 "type": "object", 4223 "properties": { 4224 "items": { 4225 "description": "Retrieved list of external authentications.", 4226 "type": "array", 4227 "items": { 4228 "$ref": "#/components/schemas/ExternalAuth" 4229 } 4230 }, 4231 "page": { 4232 "description": "Index of the requested page, where one corresponds to the first page.", 4233 "type": "integer", 4234 "format": "int32" 4235 }, 4236 "size": { 4237 "description": "Number of items contained in the returned page.", 4238 "type": "integer", 4239 "format": "int32" 4240 }, 4241 "total": { 4242 "description": "Total number of items of the collection.", 4243 "type": "integer", 4244 "format": "int32" 4245 } 4246 } 4247 } 4248 } 4249 } 4250 }, 4251 "default": { 4252 "description": "Error.", 4253 "content": { 4254 "application/json": { 4255 "schema": { 4256 "$ref": "#/components/schemas/Error" 4257 } 4258 } 4259 } 4260 } 4261 } 4262 } 4263 }, 4264 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_auth_config/external_auths/{external_auth_id}": { 4265 "delete": { 4266 "description": "Deletes the external authentication.", 4267 "parameters": [ 4268 { 4269 "name": "cluster_id", 4270 "in": "path", 4271 "schema": { 4272 "type": "string" 4273 }, 4274 "required": true 4275 }, 4276 { 4277 "name": "external_auth_id", 4278 "in": "path", 4279 "schema": { 4280 "type": "string" 4281 }, 4282 "required": true 4283 } 4284 ], 4285 "responses": { 4286 "204": { 4287 "description": "Success." 4288 }, 4289 "default": { 4290 "description": "Error.", 4291 "content": { 4292 "application/json": { 4293 "schema": { 4294 "$ref": "#/components/schemas/Error" 4295 } 4296 } 4297 } 4298 } 4299 } 4300 }, 4301 "get": { 4302 "description": "Retrieves the details of an external authentication.", 4303 "parameters": [ 4304 { 4305 "name": "cluster_id", 4306 "in": "path", 4307 "schema": { 4308 "type": "string" 4309 }, 4310 "required": true 4311 }, 4312 { 4313 "name": "external_auth_id", 4314 "in": "path", 4315 "schema": { 4316 "type": "string" 4317 }, 4318 "required": true 4319 } 4320 ], 4321 "responses": { 4322 "200": { 4323 "description": "Success.", 4324 "content": { 4325 "application/json": { 4326 "schema": { 4327 "$ref": "#/components/schemas/ExternalAuth" 4328 } 4329 } 4330 } 4331 }, 4332 "default": { 4333 "description": "Error.", 4334 "content": { 4335 "application/json": { 4336 "schema": { 4337 "$ref": "#/components/schemas/Error" 4338 } 4339 } 4340 } 4341 } 4342 } 4343 }, 4344 "patch": { 4345 "description": "Updates the external authentication.", 4346 "parameters": [ 4347 { 4348 "name": "cluster_id", 4349 "in": "path", 4350 "schema": { 4351 "type": "string" 4352 }, 4353 "required": true 4354 }, 4355 { 4356 "name": "external_auth_id", 4357 "in": "path", 4358 "schema": { 4359 "type": "string" 4360 }, 4361 "required": true 4362 } 4363 ], 4364 "requestBody": { 4365 "content": { 4366 "application/json": { 4367 "schema": { 4368 "$ref": "#/components/schemas/ExternalAuth" 4369 } 4370 } 4371 } 4372 }, 4373 "responses": { 4374 "200": { 4375 "description": "Success.", 4376 "content": { 4377 "application/json": { 4378 "schema": { 4379 "$ref": "#/components/schemas/ExternalAuth" 4380 } 4381 } 4382 } 4383 }, 4384 "default": { 4385 "description": "Error.", 4386 "content": { 4387 "application/json": { 4388 "schema": { 4389 "$ref": "#/components/schemas/Error" 4390 } 4391 } 4392 } 4393 } 4394 } 4395 } 4396 }, 4397 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration": { 4398 "get": { 4399 "description": "Retrieves the details of the external configuration.", 4400 "parameters": [ 4401 { 4402 "name": "cluster_id", 4403 "in": "path", 4404 "schema": { 4405 "type": "string" 4406 }, 4407 "required": true 4408 } 4409 ], 4410 "responses": { 4411 "200": { 4412 "description": "Success.", 4413 "content": { 4414 "application/json": { 4415 "schema": { 4416 "$ref": "#/components/schemas/ExternalConfiguration" 4417 } 4418 } 4419 } 4420 }, 4421 "default": { 4422 "description": "Error.", 4423 "content": { 4424 "application/json": { 4425 "schema": { 4426 "$ref": "#/components/schemas/Error" 4427 } 4428 } 4429 } 4430 } 4431 } 4432 } 4433 }, 4434 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/labels": { 4435 "post": { 4436 "description": "Adds a new label to the cluster.", 4437 "parameters": [ 4438 { 4439 "name": "cluster_id", 4440 "in": "path", 4441 "schema": { 4442 "type": "string" 4443 }, 4444 "required": true 4445 } 4446 ], 4447 "requestBody": { 4448 "content": { 4449 "application/json": { 4450 "schema": { 4451 "$ref": "#/components/schemas/Label" 4452 } 4453 } 4454 } 4455 }, 4456 "responses": { 4457 "201": { 4458 "description": "Success.", 4459 "content": { 4460 "application/json": { 4461 "schema": { 4462 "$ref": "#/components/schemas/Label" 4463 } 4464 } 4465 } 4466 }, 4467 "default": { 4468 "description": "Error.", 4469 "content": { 4470 "application/json": { 4471 "schema": { 4472 "$ref": "#/components/schemas/Error" 4473 } 4474 } 4475 } 4476 } 4477 } 4478 }, 4479 "get": { 4480 "description": "Retrieves the list of labels.", 4481 "parameters": [ 4482 { 4483 "name": "cluster_id", 4484 "in": "path", 4485 "schema": { 4486 "type": "string" 4487 }, 4488 "required": true 4489 }, 4490 { 4491 "name": "page", 4492 "description": "Index of the requested page, where one corresponds to the first page.", 4493 "in": "query", 4494 "schema": { 4495 "type": "integer", 4496 "format": "int32" 4497 } 4498 }, 4499 { 4500 "name": "size", 4501 "description": "Number of items contained in the returned page.", 4502 "in": "query", 4503 "schema": { 4504 "type": "integer", 4505 "format": "int32" 4506 } 4507 } 4508 ], 4509 "responses": { 4510 "200": { 4511 "description": "Success.", 4512 "content": { 4513 "application/json": { 4514 "schema": { 4515 "type": "object", 4516 "properties": { 4517 "items": { 4518 "description": "Retrieved list of labels.", 4519 "type": "array", 4520 "items": { 4521 "$ref": "#/components/schemas/Label" 4522 } 4523 }, 4524 "page": { 4525 "description": "Index of the requested page, where one corresponds to the first page.", 4526 "type": "integer", 4527 "format": "int32" 4528 }, 4529 "size": { 4530 "description": "Number of items contained in the returned page.", 4531 "type": "integer", 4532 "format": "int32" 4533 }, 4534 "total": { 4535 "description": "Total number of items of the collection.", 4536 "type": "integer", 4537 "format": "int32" 4538 } 4539 } 4540 } 4541 } 4542 } 4543 }, 4544 "default": { 4545 "description": "Error.", 4546 "content": { 4547 "application/json": { 4548 "schema": { 4549 "$ref": "#/components/schemas/Error" 4550 } 4551 } 4552 } 4553 } 4554 } 4555 } 4556 }, 4557 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/labels/{label_id}": { 4558 "delete": { 4559 "description": "Deletes the label.", 4560 "parameters": [ 4561 { 4562 "name": "cluster_id", 4563 "in": "path", 4564 "schema": { 4565 "type": "string" 4566 }, 4567 "required": true 4568 }, 4569 { 4570 "name": "label_id", 4571 "in": "path", 4572 "schema": { 4573 "type": "string" 4574 }, 4575 "required": true 4576 } 4577 ], 4578 "responses": { 4579 "204": { 4580 "description": "Success." 4581 }, 4582 "default": { 4583 "description": "Error.", 4584 "content": { 4585 "application/json": { 4586 "schema": { 4587 "$ref": "#/components/schemas/Error" 4588 } 4589 } 4590 } 4591 } 4592 } 4593 }, 4594 "get": { 4595 "description": "Retrieves the details of the label.", 4596 "parameters": [ 4597 { 4598 "name": "cluster_id", 4599 "in": "path", 4600 "schema": { 4601 "type": "string" 4602 }, 4603 "required": true 4604 }, 4605 { 4606 "name": "label_id", 4607 "in": "path", 4608 "schema": { 4609 "type": "string" 4610 }, 4611 "required": true 4612 } 4613 ], 4614 "responses": { 4615 "200": { 4616 "description": "Success.", 4617 "content": { 4618 "application/json": { 4619 "schema": { 4620 "$ref": "#/components/schemas/Label" 4621 } 4622 } 4623 } 4624 }, 4625 "default": { 4626 "description": "Error.", 4627 "content": { 4628 "application/json": { 4629 "schema": { 4630 "$ref": "#/components/schemas/Error" 4631 } 4632 } 4633 } 4634 } 4635 } 4636 }, 4637 "patch": { 4638 "description": "Update the label.", 4639 "parameters": [ 4640 { 4641 "name": "cluster_id", 4642 "in": "path", 4643 "schema": { 4644 "type": "string" 4645 }, 4646 "required": true 4647 }, 4648 { 4649 "name": "label_id", 4650 "in": "path", 4651 "schema": { 4652 "type": "string" 4653 }, 4654 "required": true 4655 } 4656 ], 4657 "requestBody": { 4658 "content": { 4659 "application/json": { 4660 "schema": { 4661 "$ref": "#/components/schemas/Label" 4662 } 4663 } 4664 } 4665 }, 4666 "responses": { 4667 "200": { 4668 "description": "Success.", 4669 "content": { 4670 "application/json": { 4671 "schema": { 4672 "$ref": "#/components/schemas/Label" 4673 } 4674 } 4675 } 4676 }, 4677 "default": { 4678 "description": "Error.", 4679 "content": { 4680 "application/json": { 4681 "schema": { 4682 "$ref": "#/components/schemas/Error" 4683 } 4684 } 4685 } 4686 } 4687 } 4688 } 4689 }, 4690 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/manifests": { 4691 "post": { 4692 "description": "Adds a new manifest to a cluster.", 4693 "parameters": [ 4694 { 4695 "name": "cluster_id", 4696 "in": "path", 4697 "schema": { 4698 "type": "string" 4699 }, 4700 "required": true 4701 } 4702 ], 4703 "requestBody": { 4704 "content": { 4705 "application/json": { 4706 "schema": { 4707 "$ref": "#/components/schemas/Manifest" 4708 } 4709 } 4710 } 4711 }, 4712 "responses": { 4713 "201": { 4714 "description": "Success.", 4715 "content": { 4716 "application/json": { 4717 "schema": { 4718 "$ref": "#/components/schemas/Manifest" 4719 } 4720 } 4721 } 4722 }, 4723 "default": { 4724 "description": "Error.", 4725 "content": { 4726 "application/json": { 4727 "schema": { 4728 "$ref": "#/components/schemas/Error" 4729 } 4730 } 4731 } 4732 } 4733 } 4734 }, 4735 "get": { 4736 "description": "Retrieves the list of manifests.", 4737 "parameters": [ 4738 { 4739 "name": "cluster_id", 4740 "in": "path", 4741 "schema": { 4742 "type": "string" 4743 }, 4744 "required": true 4745 }, 4746 { 4747 "name": "page", 4748 "description": "Index of the requested page, where one corresponds to the first page.", 4749 "in": "query", 4750 "schema": { 4751 "type": "integer", 4752 "format": "int32" 4753 } 4754 }, 4755 { 4756 "name": "size", 4757 "description": "Number of items contained in the returned page.", 4758 "in": "query", 4759 "schema": { 4760 "type": "integer", 4761 "format": "int32" 4762 } 4763 } 4764 ], 4765 "responses": { 4766 "200": { 4767 "description": "Success.", 4768 "content": { 4769 "application/json": { 4770 "schema": { 4771 "type": "object", 4772 "properties": { 4773 "items": { 4774 "description": "Retrieved list of Manifests.", 4775 "type": "array", 4776 "items": { 4777 "$ref": "#/components/schemas/Manifest" 4778 } 4779 }, 4780 "page": { 4781 "description": "Index of the requested page, where one corresponds to the first page.", 4782 "type": "integer", 4783 "format": "int32" 4784 }, 4785 "size": { 4786 "description": "Number of items contained in the returned page.", 4787 "type": "integer", 4788 "format": "int32" 4789 }, 4790 "total": { 4791 "description": "Total number of items of the collection.", 4792 "type": "integer", 4793 "format": "int32" 4794 } 4795 } 4796 } 4797 } 4798 } 4799 }, 4800 "default": { 4801 "description": "Error.", 4802 "content": { 4803 "application/json": { 4804 "schema": { 4805 "$ref": "#/components/schemas/Error" 4806 } 4807 } 4808 } 4809 } 4810 } 4811 } 4812 }, 4813 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/manifests/{manifest_id}": { 4814 "delete": { 4815 "description": "Deletes the manifest.", 4816 "parameters": [ 4817 { 4818 "name": "cluster_id", 4819 "in": "path", 4820 "schema": { 4821 "type": "string" 4822 }, 4823 "required": true 4824 }, 4825 { 4826 "name": "manifest_id", 4827 "in": "path", 4828 "schema": { 4829 "type": "string" 4830 }, 4831 "required": true 4832 } 4833 ], 4834 "responses": { 4835 "204": { 4836 "description": "Success." 4837 }, 4838 "default": { 4839 "description": "Error.", 4840 "content": { 4841 "application/json": { 4842 "schema": { 4843 "$ref": "#/components/schemas/Error" 4844 } 4845 } 4846 } 4847 } 4848 } 4849 }, 4850 "get": { 4851 "description": "Retrieves the details of the manifest.", 4852 "parameters": [ 4853 { 4854 "name": "cluster_id", 4855 "in": "path", 4856 "schema": { 4857 "type": "string" 4858 }, 4859 "required": true 4860 }, 4861 { 4862 "name": "manifest_id", 4863 "in": "path", 4864 "schema": { 4865 "type": "string" 4866 }, 4867 "required": true 4868 } 4869 ], 4870 "responses": { 4871 "200": { 4872 "description": "Success.", 4873 "content": { 4874 "application/json": { 4875 "schema": { 4876 "$ref": "#/components/schemas/Manifest" 4877 } 4878 } 4879 } 4880 }, 4881 "default": { 4882 "description": "Error.", 4883 "content": { 4884 "application/json": { 4885 "schema": { 4886 "$ref": "#/components/schemas/Error" 4887 } 4888 } 4889 } 4890 } 4891 } 4892 }, 4893 "patch": { 4894 "description": "Update the manifest.", 4895 "parameters": [ 4896 { 4897 "name": "cluster_id", 4898 "in": "path", 4899 "schema": { 4900 "type": "string" 4901 }, 4902 "required": true 4903 }, 4904 { 4905 "name": "manifest_id", 4906 "in": "path", 4907 "schema": { 4908 "type": "string" 4909 }, 4910 "required": true 4911 } 4912 ], 4913 "requestBody": { 4914 "content": { 4915 "application/json": { 4916 "schema": { 4917 "$ref": "#/components/schemas/Manifest" 4918 } 4919 } 4920 } 4921 }, 4922 "responses": { 4923 "200": { 4924 "description": "Success.", 4925 "content": { 4926 "application/json": { 4927 "schema": { 4928 "$ref": "#/components/schemas/Manifest" 4929 } 4930 } 4931 } 4932 }, 4933 "default": { 4934 "description": "Error.", 4935 "content": { 4936 "application/json": { 4937 "schema": { 4938 "$ref": "#/components/schemas/Error" 4939 } 4940 } 4941 } 4942 } 4943 } 4944 } 4945 }, 4946 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/syncsets": { 4947 "post": { 4948 "description": "Adds a new syncset to the cluster.", 4949 "parameters": [ 4950 { 4951 "name": "cluster_id", 4952 "in": "path", 4953 "schema": { 4954 "type": "string" 4955 }, 4956 "required": true 4957 } 4958 ], 4959 "requestBody": { 4960 "content": { 4961 "application/json": { 4962 "schema": { 4963 "$ref": "#/components/schemas/Syncset" 4964 } 4965 } 4966 } 4967 }, 4968 "responses": { 4969 "201": { 4970 "description": "Success.", 4971 "content": { 4972 "application/json": { 4973 "schema": { 4974 "$ref": "#/components/schemas/Syncset" 4975 } 4976 } 4977 } 4978 }, 4979 "default": { 4980 "description": "Error.", 4981 "content": { 4982 "application/json": { 4983 "schema": { 4984 "$ref": "#/components/schemas/Error" 4985 } 4986 } 4987 } 4988 } 4989 } 4990 }, 4991 "get": { 4992 "description": "Retrieves the list of syncsets.", 4993 "parameters": [ 4994 { 4995 "name": "cluster_id", 4996 "in": "path", 4997 "schema": { 4998 "type": "string" 4999 }, 5000 "required": true 5001 }, 5002 { 5003 "name": "page", 5004 "description": "Index of the requested page, where one corresponds to the first page.", 5005 "in": "query", 5006 "schema": { 5007 "type": "integer", 5008 "format": "int32" 5009 } 5010 }, 5011 { 5012 "name": "size", 5013 "description": "Number of items contained in the returned page.", 5014 "in": "query", 5015 "schema": { 5016 "type": "integer", 5017 "format": "int32" 5018 } 5019 } 5020 ], 5021 "responses": { 5022 "200": { 5023 "description": "Success.", 5024 "content": { 5025 "application/json": { 5026 "schema": { 5027 "type": "object", 5028 "properties": { 5029 "items": { 5030 "description": "Retrieved list of syncsets.", 5031 "type": "array", 5032 "items": { 5033 "$ref": "#/components/schemas/Syncset" 5034 } 5035 }, 5036 "page": { 5037 "description": "Index of the requested page, where one corresponds to the first page.", 5038 "type": "integer", 5039 "format": "int32" 5040 }, 5041 "size": { 5042 "description": "Number of items contained in the returned page.", 5043 "type": "integer", 5044 "format": "int32" 5045 }, 5046 "total": { 5047 "description": "Total number of items of the collection.", 5048 "type": "integer", 5049 "format": "int32" 5050 } 5051 } 5052 } 5053 } 5054 } 5055 }, 5056 "default": { 5057 "description": "Error.", 5058 "content": { 5059 "application/json": { 5060 "schema": { 5061 "$ref": "#/components/schemas/Error" 5062 } 5063 } 5064 } 5065 } 5066 } 5067 } 5068 }, 5069 "/api/clusters_mgmt/v1/clusters/{cluster_id}/external_configuration/syncsets/{syncset_id}": { 5070 "delete": { 5071 "description": "Deletes the syncset.", 5072 "parameters": [ 5073 { 5074 "name": "cluster_id", 5075 "in": "path", 5076 "schema": { 5077 "type": "string" 5078 }, 5079 "required": true 5080 }, 5081 { 5082 "name": "syncset_id", 5083 "in": "path", 5084 "schema": { 5085 "type": "string" 5086 }, 5087 "required": true 5088 } 5089 ], 5090 "responses": { 5091 "204": { 5092 "description": "Success." 5093 }, 5094 "default": { 5095 "description": "Error.", 5096 "content": { 5097 "application/json": { 5098 "schema": { 5099 "$ref": "#/components/schemas/Error" 5100 } 5101 } 5102 } 5103 } 5104 } 5105 }, 5106 "get": { 5107 "description": "Retrieves the details of the syncset.", 5108 "parameters": [ 5109 { 5110 "name": "cluster_id", 5111 "in": "path", 5112 "schema": { 5113 "type": "string" 5114 }, 5115 "required": true 5116 }, 5117 { 5118 "name": "syncset_id", 5119 "in": "path", 5120 "schema": { 5121 "type": "string" 5122 }, 5123 "required": true 5124 } 5125 ], 5126 "responses": { 5127 "200": { 5128 "description": "Success.", 5129 "content": { 5130 "application/json": { 5131 "schema": { 5132 "$ref": "#/components/schemas/Syncset" 5133 } 5134 } 5135 } 5136 }, 5137 "default": { 5138 "description": "Error.", 5139 "content": { 5140 "application/json": { 5141 "schema": { 5142 "$ref": "#/components/schemas/Error" 5143 } 5144 } 5145 } 5146 } 5147 } 5148 }, 5149 "patch": { 5150 "description": "Update the syncset.", 5151 "parameters": [ 5152 { 5153 "name": "cluster_id", 5154 "in": "path", 5155 "schema": { 5156 "type": "string" 5157 }, 5158 "required": true 5159 }, 5160 { 5161 "name": "syncset_id", 5162 "in": "path", 5163 "schema": { 5164 "type": "string" 5165 }, 5166 "required": true 5167 } 5168 ], 5169 "requestBody": { 5170 "content": { 5171 "application/json": { 5172 "schema": { 5173 "$ref": "#/components/schemas/Syncset" 5174 } 5175 } 5176 } 5177 }, 5178 "responses": { 5179 "200": { 5180 "description": "Success.", 5181 "content": { 5182 "application/json": { 5183 "schema": { 5184 "$ref": "#/components/schemas/Syncset" 5185 } 5186 } 5187 } 5188 }, 5189 "default": { 5190 "description": "Error.", 5191 "content": { 5192 "application/json": { 5193 "schema": { 5194 "$ref": "#/components/schemas/Error" 5195 } 5196 } 5197 } 5198 } 5199 } 5200 } 5201 }, 5202 "/api/clusters_mgmt/v1/clusters/{cluster_id}/gate_agreements": { 5203 "post": { 5204 "description": "Adds a new agreed version gate to the cluster.", 5205 "parameters": [ 5206 { 5207 "name": "cluster_id", 5208 "in": "path", 5209 "schema": { 5210 "type": "string" 5211 }, 5212 "required": true 5213 } 5214 ], 5215 "requestBody": { 5216 "content": { 5217 "application/json": { 5218 "schema": { 5219 "$ref": "#/components/schemas/VersionGateAgreement" 5220 } 5221 } 5222 } 5223 }, 5224 "responses": { 5225 "201": { 5226 "description": "Success.", 5227 "content": { 5228 "application/json": { 5229 "schema": { 5230 "$ref": "#/components/schemas/VersionGateAgreement" 5231 } 5232 } 5233 } 5234 }, 5235 "default": { 5236 "description": "Error.", 5237 "content": { 5238 "application/json": { 5239 "schema": { 5240 "$ref": "#/components/schemas/Error" 5241 } 5242 } 5243 } 5244 } 5245 } 5246 }, 5247 "get": { 5248 "description": "Retrieves the list of reasons.", 5249 "parameters": [ 5250 { 5251 "name": "cluster_id", 5252 "in": "path", 5253 "schema": { 5254 "type": "string" 5255 }, 5256 "required": true 5257 }, 5258 { 5259 "name": "page", 5260 "description": "Index of the requested page, where one corresponds to the first page.", 5261 "in": "query", 5262 "schema": { 5263 "type": "integer", 5264 "format": "int32" 5265 } 5266 }, 5267 { 5268 "name": "size", 5269 "description": "Number of items contained in the returned page.", 5270 "in": "query", 5271 "schema": { 5272 "type": "integer", 5273 "format": "int32" 5274 } 5275 } 5276 ], 5277 "responses": { 5278 "200": { 5279 "description": "Success.", 5280 "content": { 5281 "application/json": { 5282 "schema": { 5283 "type": "object", 5284 "properties": { 5285 "items": { 5286 "description": "Retrieved list of version gate agreement.", 5287 "type": "array", 5288 "items": { 5289 "$ref": "#/components/schemas/VersionGateAgreement" 5290 } 5291 }, 5292 "page": { 5293 "description": "Index of the requested page, where one corresponds to the first page.", 5294 "type": "integer", 5295 "format": "int32" 5296 }, 5297 "size": { 5298 "description": "Number of items contained in the returned page.", 5299 "type": "integer", 5300 "format": "int32" 5301 }, 5302 "total": { 5303 "description": "Total number of items of the collection.", 5304 "type": "integer", 5305 "format": "int32" 5306 } 5307 } 5308 } 5309 } 5310 } 5311 }, 5312 "default": { 5313 "description": "Error.", 5314 "content": { 5315 "application/json": { 5316 "schema": { 5317 "$ref": "#/components/schemas/Error" 5318 } 5319 } 5320 } 5321 } 5322 } 5323 } 5324 }, 5325 "/api/clusters_mgmt/v1/clusters/{cluster_id}/gate_agreements/{version_gate_agreement_id}": { 5326 "delete": { 5327 "description": "Deletes the version gate agreement.", 5328 "parameters": [ 5329 { 5330 "name": "cluster_id", 5331 "in": "path", 5332 "schema": { 5333 "type": "string" 5334 }, 5335 "required": true 5336 }, 5337 { 5338 "name": "version_gate_agreement_id", 5339 "in": "path", 5340 "schema": { 5341 "type": "string" 5342 }, 5343 "required": true 5344 } 5345 ], 5346 "responses": { 5347 "204": { 5348 "description": "Success." 5349 }, 5350 "default": { 5351 "description": "Error.", 5352 "content": { 5353 "application/json": { 5354 "schema": { 5355 "$ref": "#/components/schemas/Error" 5356 } 5357 } 5358 } 5359 } 5360 } 5361 }, 5362 "get": { 5363 "description": "Retrieves the details of the version gate agreement.", 5364 "parameters": [ 5365 { 5366 "name": "cluster_id", 5367 "in": "path", 5368 "schema": { 5369 "type": "string" 5370 }, 5371 "required": true 5372 }, 5373 { 5374 "name": "version_gate_agreement_id", 5375 "in": "path", 5376 "schema": { 5377 "type": "string" 5378 }, 5379 "required": true 5380 } 5381 ], 5382 "responses": { 5383 "200": { 5384 "description": "Success.", 5385 "content": { 5386 "application/json": { 5387 "schema": { 5388 "$ref": "#/components/schemas/VersionGateAgreement" 5389 } 5390 } 5391 } 5392 }, 5393 "default": { 5394 "description": "Error.", 5395 "content": { 5396 "application/json": { 5397 "schema": { 5398 "$ref": "#/components/schemas/Error" 5399 } 5400 } 5401 } 5402 } 5403 } 5404 } 5405 }, 5406 "/api/clusters_mgmt/v1/clusters/{cluster_id}/groups": { 5407 "get": { 5408 "description": "Retrieves the list of groups.", 5409 "parameters": [ 5410 { 5411 "name": "cluster_id", 5412 "in": "path", 5413 "schema": { 5414 "type": "string" 5415 }, 5416 "required": true 5417 }, 5418 { 5419 "name": "page", 5420 "description": "Index of the requested page, where one corresponds to the first page.", 5421 "in": "query", 5422 "schema": { 5423 "type": "integer", 5424 "format": "int32" 5425 } 5426 }, 5427 { 5428 "name": "size", 5429 "description": "Number of items contained in the returned page.", 5430 "in": "query", 5431 "schema": { 5432 "type": "integer", 5433 "format": "int32" 5434 } 5435 } 5436 ], 5437 "responses": { 5438 "200": { 5439 "description": "Success.", 5440 "content": { 5441 "application/json": { 5442 "schema": { 5443 "type": "object", 5444 "properties": { 5445 "items": { 5446 "description": "Retrieved list of groups.", 5447 "type": "array", 5448 "items": { 5449 "$ref": "#/components/schemas/Group" 5450 } 5451 }, 5452 "page": { 5453 "description": "Index of the requested page, where one corresponds to the first page.", 5454 "type": "integer", 5455 "format": "int32" 5456 }, 5457 "size": { 5458 "description": "Number of items contained in the returned page.", 5459 "type": "integer", 5460 "format": "int32" 5461 }, 5462 "total": { 5463 "description": "Total number of items of the collection.", 5464 "type": "integer", 5465 "format": "int32" 5466 } 5467 } 5468 } 5469 } 5470 } 5471 }, 5472 "default": { 5473 "description": "Error.", 5474 "content": { 5475 "application/json": { 5476 "schema": { 5477 "$ref": "#/components/schemas/Error" 5478 } 5479 } 5480 } 5481 } 5482 } 5483 } 5484 }, 5485 "/api/clusters_mgmt/v1/clusters/{cluster_id}/groups/{group_id}": { 5486 "get": { 5487 "description": "Retrieves the details of the group.", 5488 "parameters": [ 5489 { 5490 "name": "cluster_id", 5491 "in": "path", 5492 "schema": { 5493 "type": "string" 5494 }, 5495 "required": true 5496 }, 5497 { 5498 "name": "group_id", 5499 "in": "path", 5500 "schema": { 5501 "type": "string" 5502 }, 5503 "required": true 5504 } 5505 ], 5506 "responses": { 5507 "200": { 5508 "description": "Success.", 5509 "content": { 5510 "application/json": { 5511 "schema": { 5512 "$ref": "#/components/schemas/Group" 5513 } 5514 } 5515 } 5516 }, 5517 "default": { 5518 "description": "Error.", 5519 "content": { 5520 "application/json": { 5521 "schema": { 5522 "$ref": "#/components/schemas/Error" 5523 } 5524 } 5525 } 5526 } 5527 } 5528 } 5529 }, 5530 "/api/clusters_mgmt/v1/clusters/{cluster_id}/groups/{group_id}/users": { 5531 "post": { 5532 "description": "Adds a new user to the group.", 5533 "parameters": [ 5534 { 5535 "name": "cluster_id", 5536 "in": "path", 5537 "schema": { 5538 "type": "string" 5539 }, 5540 "required": true 5541 }, 5542 { 5543 "name": "group_id", 5544 "in": "path", 5545 "schema": { 5546 "type": "string" 5547 }, 5548 "required": true 5549 } 5550 ], 5551 "requestBody": { 5552 "content": { 5553 "application/json": { 5554 "schema": { 5555 "$ref": "#/components/schemas/User" 5556 } 5557 } 5558 } 5559 }, 5560 "responses": { 5561 "201": { 5562 "description": "Success.", 5563 "content": { 5564 "application/json": { 5565 "schema": { 5566 "$ref": "#/components/schemas/User" 5567 } 5568 } 5569 } 5570 }, 5571 "default": { 5572 "description": "Error.", 5573 "content": { 5574 "application/json": { 5575 "schema": { 5576 "$ref": "#/components/schemas/Error" 5577 } 5578 } 5579 } 5580 } 5581 } 5582 }, 5583 "get": { 5584 "description": "Retrieves the list of users.", 5585 "parameters": [ 5586 { 5587 "name": "cluster_id", 5588 "in": "path", 5589 "schema": { 5590 "type": "string" 5591 }, 5592 "required": true 5593 }, 5594 { 5595 "name": "group_id", 5596 "in": "path", 5597 "schema": { 5598 "type": "string" 5599 }, 5600 "required": true 5601 }, 5602 { 5603 "name": "page", 5604 "description": "Index of the requested page, where one corresponds to the first page.", 5605 "in": "query", 5606 "schema": { 5607 "type": "integer", 5608 "format": "int32" 5609 } 5610 }, 5611 { 5612 "name": "size", 5613 "description": "Number of items contained in the returned page.", 5614 "in": "query", 5615 "schema": { 5616 "type": "integer", 5617 "format": "int32" 5618 } 5619 } 5620 ], 5621 "responses": { 5622 "200": { 5623 "description": "Success.", 5624 "content": { 5625 "application/json": { 5626 "schema": { 5627 "type": "object", 5628 "properties": { 5629 "items": { 5630 "description": "Retrieved list of users.", 5631 "type": "array", 5632 "items": { 5633 "$ref": "#/components/schemas/User" 5634 } 5635 }, 5636 "page": { 5637 "description": "Index of the requested page, where one corresponds to the first page.", 5638 "type": "integer", 5639 "format": "int32" 5640 }, 5641 "size": { 5642 "description": "Number of items contained in the returned page.", 5643 "type": "integer", 5644 "format": "int32" 5645 }, 5646 "total": { 5647 "description": "Total number of items of the collection.", 5648 "type": "integer", 5649 "format": "int32" 5650 } 5651 } 5652 } 5653 } 5654 } 5655 }, 5656 "default": { 5657 "description": "Error.", 5658 "content": { 5659 "application/json": { 5660 "schema": { 5661 "$ref": "#/components/schemas/Error" 5662 } 5663 } 5664 } 5665 } 5666 } 5667 } 5668 }, 5669 "/api/clusters_mgmt/v1/clusters/{cluster_id}/groups/{group_id}/users/{user_id}": { 5670 "delete": { 5671 "description": "Deletes the user.", 5672 "parameters": [ 5673 { 5674 "name": "cluster_id", 5675 "in": "path", 5676 "schema": { 5677 "type": "string" 5678 }, 5679 "required": true 5680 }, 5681 { 5682 "name": "group_id", 5683 "in": "path", 5684 "schema": { 5685 "type": "string" 5686 }, 5687 "required": true 5688 }, 5689 { 5690 "name": "user_id", 5691 "in": "path", 5692 "schema": { 5693 "type": "string" 5694 }, 5695 "required": true 5696 } 5697 ], 5698 "responses": { 5699 "204": { 5700 "description": "Success." 5701 }, 5702 "default": { 5703 "description": "Error.", 5704 "content": { 5705 "application/json": { 5706 "schema": { 5707 "$ref": "#/components/schemas/Error" 5708 } 5709 } 5710 } 5711 } 5712 } 5713 }, 5714 "get": { 5715 "description": "Retrieves the details of the user.", 5716 "parameters": [ 5717 { 5718 "name": "cluster_id", 5719 "in": "path", 5720 "schema": { 5721 "type": "string" 5722 }, 5723 "required": true 5724 }, 5725 { 5726 "name": "group_id", 5727 "in": "path", 5728 "schema": { 5729 "type": "string" 5730 }, 5731 "required": true 5732 }, 5733 { 5734 "name": "user_id", 5735 "in": "path", 5736 "schema": { 5737 "type": "string" 5738 }, 5739 "required": true 5740 } 5741 ], 5742 "responses": { 5743 "200": { 5744 "description": "Success.", 5745 "content": { 5746 "application/json": { 5747 "schema": { 5748 "$ref": "#/components/schemas/User" 5749 } 5750 } 5751 } 5752 }, 5753 "default": { 5754 "description": "Error.", 5755 "content": { 5756 "application/json": { 5757 "schema": { 5758 "$ref": "#/components/schemas/Error" 5759 } 5760 } 5761 } 5762 } 5763 } 5764 } 5765 }, 5766 "/api/clusters_mgmt/v1/clusters/{cluster_id}/hypershift": { 5767 "get": { 5768 "description": "Retrieves the Hypershift details for a single cluster.", 5769 "parameters": [ 5770 { 5771 "name": "cluster_id", 5772 "in": "path", 5773 "schema": { 5774 "type": "string" 5775 }, 5776 "required": true 5777 } 5778 ], 5779 "responses": { 5780 "200": { 5781 "description": "Success.", 5782 "content": { 5783 "application/json": { 5784 "schema": { 5785 "$ref": "#/components/schemas/HypershiftConfig" 5786 } 5787 } 5788 } 5789 }, 5790 "default": { 5791 "description": "Error.", 5792 "content": { 5793 "application/json": { 5794 "schema": { 5795 "$ref": "#/components/schemas/Error" 5796 } 5797 } 5798 } 5799 } 5800 } 5801 }, 5802 "patch": { 5803 "description": "Updates the Hypershift details for a single cluster.", 5804 "parameters": [ 5805 { 5806 "name": "cluster_id", 5807 "in": "path", 5808 "schema": { 5809 "type": "string" 5810 }, 5811 "required": true 5812 } 5813 ], 5814 "requestBody": { 5815 "content": { 5816 "application/json": { 5817 "schema": { 5818 "$ref": "#/components/schemas/HypershiftConfig" 5819 } 5820 } 5821 } 5822 }, 5823 "responses": { 5824 "200": { 5825 "description": "Success.", 5826 "content": { 5827 "application/json": { 5828 "schema": { 5829 "$ref": "#/components/schemas/HypershiftConfig" 5830 } 5831 } 5832 } 5833 }, 5834 "default": { 5835 "description": "Error.", 5836 "content": { 5837 "application/json": { 5838 "schema": { 5839 "$ref": "#/components/schemas/Error" 5840 } 5841 } 5842 } 5843 } 5844 } 5845 } 5846 }, 5847 "/api/clusters_mgmt/v1/clusters/{cluster_id}/identity_providers": { 5848 "post": { 5849 "description": "Adds a new identity provider to the cluster.", 5850 "parameters": [ 5851 { 5852 "name": "cluster_id", 5853 "in": "path", 5854 "schema": { 5855 "type": "string" 5856 }, 5857 "required": true 5858 } 5859 ], 5860 "requestBody": { 5861 "content": { 5862 "application/json": { 5863 "schema": { 5864 "$ref": "#/components/schemas/IdentityProvider" 5865 } 5866 } 5867 } 5868 }, 5869 "responses": { 5870 "201": { 5871 "description": "Success.", 5872 "content": { 5873 "application/json": { 5874 "schema": { 5875 "$ref": "#/components/schemas/IdentityProvider" 5876 } 5877 } 5878 } 5879 }, 5880 "default": { 5881 "description": "Error.", 5882 "content": { 5883 "application/json": { 5884 "schema": { 5885 "$ref": "#/components/schemas/Error" 5886 } 5887 } 5888 } 5889 } 5890 } 5891 }, 5892 "get": { 5893 "description": "Retrieves the list of identity providers.", 5894 "parameters": [ 5895 { 5896 "name": "cluster_id", 5897 "in": "path", 5898 "schema": { 5899 "type": "string" 5900 }, 5901 "required": true 5902 }, 5903 { 5904 "name": "page", 5905 "description": "Index of the requested page, where one corresponds to the first page.", 5906 "in": "query", 5907 "schema": { 5908 "type": "integer", 5909 "format": "int32" 5910 } 5911 }, 5912 { 5913 "name": "size", 5914 "description": "Number of items contained in the returned page.", 5915 "in": "query", 5916 "schema": { 5917 "type": "integer", 5918 "format": "int32" 5919 } 5920 } 5921 ], 5922 "responses": { 5923 "200": { 5924 "description": "Success.", 5925 "content": { 5926 "application/json": { 5927 "schema": { 5928 "type": "object", 5929 "properties": { 5930 "items": { 5931 "description": "Retrieved list of identity providers.", 5932 "type": "array", 5933 "items": { 5934 "$ref": "#/components/schemas/IdentityProvider" 5935 } 5936 }, 5937 "page": { 5938 "description": "Index of the requested page, where one corresponds to the first page.", 5939 "type": "integer", 5940 "format": "int32" 5941 }, 5942 "size": { 5943 "description": "Number of items contained in the returned page.", 5944 "type": "integer", 5945 "format": "int32" 5946 }, 5947 "total": { 5948 "description": "Total number of items of the collection.", 5949 "type": "integer", 5950 "format": "int32" 5951 } 5952 } 5953 } 5954 } 5955 } 5956 }, 5957 "default": { 5958 "description": "Error.", 5959 "content": { 5960 "application/json": { 5961 "schema": { 5962 "$ref": "#/components/schemas/Error" 5963 } 5964 } 5965 } 5966 } 5967 } 5968 } 5969 }, 5970 "/api/clusters_mgmt/v1/clusters/{cluster_id}/identity_providers/{identity_provider_id}": { 5971 "delete": { 5972 "description": "Deletes the identity provider.", 5973 "parameters": [ 5974 { 5975 "name": "cluster_id", 5976 "in": "path", 5977 "schema": { 5978 "type": "string" 5979 }, 5980 "required": true 5981 }, 5982 { 5983 "name": "identity_provider_id", 5984 "in": "path", 5985 "schema": { 5986 "type": "string" 5987 }, 5988 "required": true 5989 } 5990 ], 5991 "responses": { 5992 "204": { 5993 "description": "Success." 5994 }, 5995 "default": { 5996 "description": "Error.", 5997 "content": { 5998 "application/json": { 5999 "schema": { 6000 "$ref": "#/components/schemas/Error" 6001 } 6002 } 6003 } 6004 } 6005 } 6006 }, 6007 "get": { 6008 "description": "Retrieves the details of the identity provider.", 6009 "parameters": [ 6010 { 6011 "name": "cluster_id", 6012 "in": "path", 6013 "schema": { 6014 "type": "string" 6015 }, 6016 "required": true 6017 }, 6018 { 6019 "name": "identity_provider_id", 6020 "in": "path", 6021 "schema": { 6022 "type": "string" 6023 }, 6024 "required": true 6025 } 6026 ], 6027 "responses": { 6028 "200": { 6029 "description": "Success.", 6030 "content": { 6031 "application/json": { 6032 "schema": { 6033 "$ref": "#/components/schemas/IdentityProvider" 6034 } 6035 } 6036 } 6037 }, 6038 "default": { 6039 "description": "Error.", 6040 "content": { 6041 "application/json": { 6042 "schema": { 6043 "$ref": "#/components/schemas/Error" 6044 } 6045 } 6046 } 6047 } 6048 } 6049 }, 6050 "patch": { 6051 "description": "Update identity provider in the cluster.", 6052 "parameters": [ 6053 { 6054 "name": "cluster_id", 6055 "in": "path", 6056 "schema": { 6057 "type": "string" 6058 }, 6059 "required": true 6060 }, 6061 { 6062 "name": "identity_provider_id", 6063 "in": "path", 6064 "schema": { 6065 "type": "string" 6066 }, 6067 "required": true 6068 } 6069 ], 6070 "requestBody": { 6071 "content": { 6072 "application/json": { 6073 "schema": { 6074 "$ref": "#/components/schemas/IdentityProvider" 6075 } 6076 } 6077 } 6078 }, 6079 "responses": { 6080 "200": { 6081 "description": "Success.", 6082 "content": { 6083 "application/json": { 6084 "schema": { 6085 "$ref": "#/components/schemas/IdentityProvider" 6086 } 6087 } 6088 } 6089 }, 6090 "default": { 6091 "description": "Error.", 6092 "content": { 6093 "application/json": { 6094 "schema": { 6095 "$ref": "#/components/schemas/Error" 6096 } 6097 } 6098 } 6099 } 6100 } 6101 } 6102 }, 6103 "/api/clusters_mgmt/v1/clusters/{cluster_id}/identity_providers/{identity_provider_id}/htpasswd_users": { 6104 "post": { 6105 "description": "Adds a new user to the _HTPasswd_ file.", 6106 "parameters": [ 6107 { 6108 "name": "cluster_id", 6109 "in": "path", 6110 "schema": { 6111 "type": "string" 6112 }, 6113 "required": true 6114 }, 6115 { 6116 "name": "identity_provider_id", 6117 "in": "path", 6118 "schema": { 6119 "type": "string" 6120 }, 6121 "required": true 6122 } 6123 ], 6124 "requestBody": { 6125 "content": { 6126 "application/json": { 6127 "schema": { 6128 "$ref": "#/components/schemas/HTPasswdUser" 6129 } 6130 } 6131 } 6132 }, 6133 "responses": { 6134 "201": { 6135 "description": "Success.", 6136 "content": { 6137 "application/json": { 6138 "schema": { 6139 "$ref": "#/components/schemas/HTPasswdUser" 6140 } 6141 } 6142 } 6143 }, 6144 "default": { 6145 "description": "Error.", 6146 "content": { 6147 "application/json": { 6148 "schema": { 6149 "$ref": "#/components/schemas/Error" 6150 } 6151 } 6152 } 6153 } 6154 } 6155 }, 6156 "get": { 6157 "description": "Retrieves the list of _HTPasswd_ IDP users.", 6158 "parameters": [ 6159 { 6160 "name": "cluster_id", 6161 "in": "path", 6162 "schema": { 6163 "type": "string" 6164 }, 6165 "required": true 6166 }, 6167 { 6168 "name": "identity_provider_id", 6169 "in": "path", 6170 "schema": { 6171 "type": "string" 6172 }, 6173 "required": true 6174 }, 6175 { 6176 "name": "page", 6177 "description": "Index of the requested page, where one corresponds to the first page.", 6178 "in": "query", 6179 "schema": { 6180 "type": "integer", 6181 "format": "int32" 6182 } 6183 }, 6184 { 6185 "name": "size", 6186 "description": "Number of items contained in the returned page.", 6187 "in": "query", 6188 "schema": { 6189 "type": "integer", 6190 "format": "int32" 6191 } 6192 } 6193 ], 6194 "responses": { 6195 "200": { 6196 "description": "Success.", 6197 "content": { 6198 "application/json": { 6199 "schema": { 6200 "type": "object", 6201 "properties": { 6202 "items": { 6203 "description": "Retrieved list of users of the IDP.", 6204 "type": "array", 6205 "items": { 6206 "$ref": "#/components/schemas/HTPasswdUser" 6207 } 6208 }, 6209 "page": { 6210 "description": "Index of the requested page, where one corresponds to the first page.", 6211 "type": "integer", 6212 "format": "int32" 6213 }, 6214 "size": { 6215 "description": "Number of items contained in the returned page.", 6216 "type": "integer", 6217 "format": "int32" 6218 }, 6219 "total": { 6220 "description": "Total number of items of the collection.", 6221 "type": "integer", 6222 "format": "int32" 6223 } 6224 } 6225 } 6226 } 6227 } 6228 }, 6229 "default": { 6230 "description": "Error.", 6231 "content": { 6232 "application/json": { 6233 "schema": { 6234 "$ref": "#/components/schemas/Error" 6235 } 6236 } 6237 } 6238 } 6239 } 6240 } 6241 }, 6242 "/api/clusters_mgmt/v1/clusters/{cluster_id}/identity_providers/{identity_provider_id}/htpasswd_users/import": { 6243 "post": { 6244 "description": "Adds multiple new users to the _HTPasswd_ file.", 6245 "parameters": [ 6246 { 6247 "name": "cluster_id", 6248 "in": "path", 6249 "schema": { 6250 "type": "string" 6251 }, 6252 "required": true 6253 }, 6254 { 6255 "name": "identity_provider_id", 6256 "in": "path", 6257 "schema": { 6258 "type": "string" 6259 }, 6260 "required": true 6261 } 6262 ], 6263 "requestBody": { 6264 "content": { 6265 "application/json": { 6266 "schema": { 6267 "type": "object", 6268 "properties": { 6269 "items": { 6270 "description": "List of users to add to the IDP.", 6271 "type": "array", 6272 "items": { 6273 "$ref": "#/components/schemas/HTPasswdUser" 6274 } 6275 }, 6276 "page": { 6277 "description": "Index of the requested page, where one corresponds to the first page.", 6278 "type": "integer", 6279 "format": "int32" 6280 }, 6281 "size": { 6282 "description": "Number of items contained in the returned page.", 6283 "type": "integer", 6284 "format": "int32" 6285 } 6286 } 6287 } 6288 } 6289 } 6290 }, 6291 "responses": { 6292 "200": { 6293 "description": "Success.", 6294 "content": { 6295 "application/json": { 6296 "schema": { 6297 "type": "object", 6298 "properties": { 6299 "items": { 6300 "description": "Updated list of users of the IDP.", 6301 "type": "array", 6302 "items": { 6303 "$ref": "#/components/schemas/HTPasswdUser" 6304 } 6305 }, 6306 "page": { 6307 "description": "Index of the requested page, where one corresponds to the first page.", 6308 "type": "integer", 6309 "format": "int32" 6310 }, 6311 "size": { 6312 "description": "Number of items contained in the returned page.", 6313 "type": "integer", 6314 "format": "int32" 6315 }, 6316 "total": { 6317 "description": "Total number of items of the collection.", 6318 "type": "integer", 6319 "format": "int32" 6320 } 6321 } 6322 } 6323 } 6324 } 6325 }, 6326 "default": { 6327 "description": "Error.", 6328 "content": { 6329 "application/json": { 6330 "schema": { 6331 "$ref": "#/components/schemas/Error" 6332 } 6333 } 6334 } 6335 } 6336 } 6337 } 6338 }, 6339 "/api/clusters_mgmt/v1/clusters/{cluster_id}/identity_providers/{identity_provider_id}/htpasswd_users/{htpasswd_user_id}": { 6340 "delete": { 6341 "description": "Deletes the user.", 6342 "parameters": [ 6343 { 6344 "name": "cluster_id", 6345 "in": "path", 6346 "schema": { 6347 "type": "string" 6348 }, 6349 "required": true 6350 }, 6351 { 6352 "name": "identity_provider_id", 6353 "in": "path", 6354 "schema": { 6355 "type": "string" 6356 }, 6357 "required": true 6358 }, 6359 { 6360 "name": "htpasswd_user_id", 6361 "in": "path", 6362 "schema": { 6363 "type": "string" 6364 }, 6365 "required": true 6366 } 6367 ], 6368 "responses": { 6369 "204": { 6370 "description": "Success." 6371 }, 6372 "default": { 6373 "description": "Error.", 6374 "content": { 6375 "application/json": { 6376 "schema": { 6377 "$ref": "#/components/schemas/Error" 6378 } 6379 } 6380 } 6381 } 6382 } 6383 }, 6384 "get": { 6385 "description": "Retrieves the details of the user.", 6386 "parameters": [ 6387 { 6388 "name": "cluster_id", 6389 "in": "path", 6390 "schema": { 6391 "type": "string" 6392 }, 6393 "required": true 6394 }, 6395 { 6396 "name": "identity_provider_id", 6397 "in": "path", 6398 "schema": { 6399 "type": "string" 6400 }, 6401 "required": true 6402 }, 6403 { 6404 "name": "htpasswd_user_id", 6405 "in": "path", 6406 "schema": { 6407 "type": "string" 6408 }, 6409 "required": true 6410 } 6411 ], 6412 "responses": { 6413 "200": { 6414 "description": "Success.", 6415 "content": { 6416 "application/json": { 6417 "schema": { 6418 "$ref": "#/components/schemas/HTPasswdUser" 6419 } 6420 } 6421 } 6422 }, 6423 "default": { 6424 "description": "Error.", 6425 "content": { 6426 "application/json": { 6427 "schema": { 6428 "$ref": "#/components/schemas/Error" 6429 } 6430 } 6431 } 6432 } 6433 } 6434 }, 6435 "patch": { 6436 "description": "Updates the user's password. The username is not editable", 6437 "parameters": [ 6438 { 6439 "name": "cluster_id", 6440 "in": "path", 6441 "schema": { 6442 "type": "string" 6443 }, 6444 "required": true 6445 }, 6446 { 6447 "name": "identity_provider_id", 6448 "in": "path", 6449 "schema": { 6450 "type": "string" 6451 }, 6452 "required": true 6453 }, 6454 { 6455 "name": "htpasswd_user_id", 6456 "in": "path", 6457 "schema": { 6458 "type": "string" 6459 }, 6460 "required": true 6461 } 6462 ], 6463 "requestBody": { 6464 "content": { 6465 "application/json": { 6466 "schema": { 6467 "$ref": "#/components/schemas/HTPasswdUser" 6468 } 6469 } 6470 } 6471 }, 6472 "responses": { 6473 "200": { 6474 "description": "Success.", 6475 "content": { 6476 "application/json": { 6477 "schema": { 6478 "$ref": "#/components/schemas/HTPasswdUser" 6479 } 6480 } 6481 } 6482 }, 6483 "default": { 6484 "description": "Error.", 6485 "content": { 6486 "application/json": { 6487 "schema": { 6488 "$ref": "#/components/schemas/Error" 6489 } 6490 } 6491 } 6492 } 6493 } 6494 } 6495 }, 6496 "/api/clusters_mgmt/v1/clusters/{cluster_id}/inflight_checks": { 6497 "get": { 6498 "description": "Retrieves the list of inflight checks.", 6499 "parameters": [ 6500 { 6501 "name": "cluster_id", 6502 "in": "path", 6503 "schema": { 6504 "type": "string" 6505 }, 6506 "required": true 6507 }, 6508 { 6509 "name": "page", 6510 "description": "Index of the requested page, where one corresponds to the first page.", 6511 "in": "query", 6512 "schema": { 6513 "type": "integer", 6514 "format": "int32" 6515 } 6516 }, 6517 { 6518 "name": "size", 6519 "description": "Number of items contained in the returned page.", 6520 "in": "query", 6521 "schema": { 6522 "type": "integer", 6523 "format": "int32" 6524 } 6525 } 6526 ], 6527 "responses": { 6528 "200": { 6529 "description": "Success.", 6530 "content": { 6531 "application/json": { 6532 "schema": { 6533 "type": "object", 6534 "properties": { 6535 "items": { 6536 "description": "Retrieved list of inflight checks.", 6537 "type": "array", 6538 "items": { 6539 "$ref": "#/components/schemas/InflightCheck" 6540 } 6541 }, 6542 "page": { 6543 "description": "Index of the requested page, where one corresponds to the first page.", 6544 "type": "integer", 6545 "format": "int32" 6546 }, 6547 "size": { 6548 "description": "Number of items contained in the returned page.", 6549 "type": "integer", 6550 "format": "int32" 6551 }, 6552 "total": { 6553 "description": "Total number of items of the collection.", 6554 "type": "integer", 6555 "format": "int32" 6556 } 6557 } 6558 } 6559 } 6560 } 6561 }, 6562 "default": { 6563 "description": "Error.", 6564 "content": { 6565 "application/json": { 6566 "schema": { 6567 "$ref": "#/components/schemas/Error" 6568 } 6569 } 6570 } 6571 } 6572 } 6573 } 6574 }, 6575 "/api/clusters_mgmt/v1/clusters/{cluster_id}/inflight_checks/{inflight_check_id}": { 6576 "get": { 6577 "description": "Retrieves the details of the inflight check.", 6578 "parameters": [ 6579 { 6580 "name": "cluster_id", 6581 "in": "path", 6582 "schema": { 6583 "type": "string" 6584 }, 6585 "required": true 6586 }, 6587 { 6588 "name": "inflight_check_id", 6589 "in": "path", 6590 "schema": { 6591 "type": "string" 6592 }, 6593 "required": true 6594 } 6595 ], 6596 "responses": { 6597 "200": { 6598 "description": "Success.", 6599 "content": { 6600 "application/json": { 6601 "schema": { 6602 "$ref": "#/components/schemas/InflightCheck" 6603 } 6604 } 6605 } 6606 }, 6607 "default": { 6608 "description": "Error.", 6609 "content": { 6610 "application/json": { 6611 "schema": { 6612 "$ref": "#/components/schemas/Error" 6613 } 6614 } 6615 } 6616 } 6617 } 6618 } 6619 }, 6620 "/api/clusters_mgmt/v1/clusters/{cluster_id}/ingresses": { 6621 "post": { 6622 "description": "Adds a new ingress to the cluster.", 6623 "parameters": [ 6624 { 6625 "name": "cluster_id", 6626 "in": "path", 6627 "schema": { 6628 "type": "string" 6629 }, 6630 "required": true 6631 } 6632 ], 6633 "requestBody": { 6634 "content": { 6635 "application/json": { 6636 "schema": { 6637 "$ref": "#/components/schemas/Ingress" 6638 } 6639 } 6640 } 6641 }, 6642 "responses": { 6643 "201": { 6644 "description": "Success.", 6645 "content": { 6646 "application/json": { 6647 "schema": { 6648 "$ref": "#/components/schemas/Ingress" 6649 } 6650 } 6651 } 6652 }, 6653 "default": { 6654 "description": "Error.", 6655 "content": { 6656 "application/json": { 6657 "schema": { 6658 "$ref": "#/components/schemas/Error" 6659 } 6660 } 6661 } 6662 } 6663 } 6664 }, 6665 "get": { 6666 "description": "Retrieves the list of ingresses.", 6667 "parameters": [ 6668 { 6669 "name": "cluster_id", 6670 "in": "path", 6671 "schema": { 6672 "type": "string" 6673 }, 6674 "required": true 6675 }, 6676 { 6677 "name": "page", 6678 "description": "Index of the requested page, where one corresponds to the first page.", 6679 "in": "query", 6680 "schema": { 6681 "type": "integer", 6682 "format": "int32" 6683 } 6684 }, 6685 { 6686 "name": "size", 6687 "description": "Number of items contained in the returned page.", 6688 "in": "query", 6689 "schema": { 6690 "type": "integer", 6691 "format": "int32" 6692 } 6693 } 6694 ], 6695 "responses": { 6696 "200": { 6697 "description": "Success.", 6698 "content": { 6699 "application/json": { 6700 "schema": { 6701 "type": "object", 6702 "properties": { 6703 "items": { 6704 "description": "Retrieved list of ingresses.", 6705 "type": "array", 6706 "items": { 6707 "$ref": "#/components/schemas/Ingress" 6708 } 6709 }, 6710 "page": { 6711 "description": "Index of the requested page, where one corresponds to the first page.", 6712 "type": "integer", 6713 "format": "int32" 6714 }, 6715 "size": { 6716 "description": "Number of items contained in the returned page.", 6717 "type": "integer", 6718 "format": "int32" 6719 }, 6720 "total": { 6721 "description": "Total number of items of the collection.", 6722 "type": "integer", 6723 "format": "int32" 6724 } 6725 } 6726 } 6727 } 6728 } 6729 }, 6730 "default": { 6731 "description": "Error.", 6732 "content": { 6733 "application/json": { 6734 "schema": { 6735 "$ref": "#/components/schemas/Error" 6736 } 6737 } 6738 } 6739 } 6740 } 6741 }, 6742 "patch": { 6743 "description": "Updates all ingresses", 6744 "parameters": [ 6745 { 6746 "name": "cluster_id", 6747 "in": "path", 6748 "schema": { 6749 "type": "string" 6750 }, 6751 "required": true 6752 } 6753 ], 6754 "requestBody": { 6755 "content": { 6756 "application/json": { 6757 "schema": { 6758 "type": "array", 6759 "items": { 6760 "$ref": "#/components/schemas/Ingress" 6761 } 6762 } 6763 } 6764 } 6765 }, 6766 "responses": { 6767 "200": { 6768 "description": "Success.", 6769 "content": { 6770 "application/json": { 6771 "schema": { 6772 "type": "array", 6773 "items": { 6774 "$ref": "#/components/schemas/Ingress" 6775 } 6776 } 6777 } 6778 } 6779 }, 6780 "default": { 6781 "description": "Error.", 6782 "content": { 6783 "application/json": { 6784 "schema": { 6785 "$ref": "#/components/schemas/Error" 6786 } 6787 } 6788 } 6789 } 6790 } 6791 } 6792 }, 6793 "/api/clusters_mgmt/v1/clusters/{cluster_id}/ingresses/{ingress_id}": { 6794 "delete": { 6795 "description": "Deletes the ingress.", 6796 "parameters": [ 6797 { 6798 "name": "cluster_id", 6799 "in": "path", 6800 "schema": { 6801 "type": "string" 6802 }, 6803 "required": true 6804 }, 6805 { 6806 "name": "ingress_id", 6807 "in": "path", 6808 "schema": { 6809 "type": "string" 6810 }, 6811 "required": true 6812 } 6813 ], 6814 "responses": { 6815 "204": { 6816 "description": "Success." 6817 }, 6818 "default": { 6819 "description": "Error.", 6820 "content": { 6821 "application/json": { 6822 "schema": { 6823 "$ref": "#/components/schemas/Error" 6824 } 6825 } 6826 } 6827 } 6828 } 6829 }, 6830 "get": { 6831 "description": "Retrieves the details of the ingress.", 6832 "parameters": [ 6833 { 6834 "name": "cluster_id", 6835 "in": "path", 6836 "schema": { 6837 "type": "string" 6838 }, 6839 "required": true 6840 }, 6841 { 6842 "name": "ingress_id", 6843 "in": "path", 6844 "schema": { 6845 "type": "string" 6846 }, 6847 "required": true 6848 } 6849 ], 6850 "responses": { 6851 "200": { 6852 "description": "Success.", 6853 "content": { 6854 "application/json": { 6855 "schema": { 6856 "$ref": "#/components/schemas/Ingress" 6857 } 6858 } 6859 } 6860 }, 6861 "default": { 6862 "description": "Error.", 6863 "content": { 6864 "application/json": { 6865 "schema": { 6866 "$ref": "#/components/schemas/Error" 6867 } 6868 } 6869 } 6870 } 6871 } 6872 }, 6873 "patch": { 6874 "description": "Updates the ingress.", 6875 "parameters": [ 6876 { 6877 "name": "cluster_id", 6878 "in": "path", 6879 "schema": { 6880 "type": "string" 6881 }, 6882 "required": true 6883 }, 6884 { 6885 "name": "ingress_id", 6886 "in": "path", 6887 "schema": { 6888 "type": "string" 6889 }, 6890 "required": true 6891 } 6892 ], 6893 "requestBody": { 6894 "content": { 6895 "application/json": { 6896 "schema": { 6897 "$ref": "#/components/schemas/Ingress" 6898 } 6899 } 6900 } 6901 }, 6902 "responses": { 6903 "200": { 6904 "description": "Success.", 6905 "content": { 6906 "application/json": { 6907 "schema": { 6908 "$ref": "#/components/schemas/Ingress" 6909 } 6910 } 6911 } 6912 }, 6913 "default": { 6914 "description": "Error.", 6915 "content": { 6916 "application/json": { 6917 "schema": { 6918 "$ref": "#/components/schemas/Error" 6919 } 6920 } 6921 } 6922 } 6923 } 6924 } 6925 }, 6926 "/api/clusters_mgmt/v1/clusters/{cluster_id}/kubelet_config": { 6927 "delete": { 6928 "description": "Deletes the cluster KubeletConfig", 6929 "parameters": [ 6930 { 6931 "name": "cluster_id", 6932 "in": "path", 6933 "schema": { 6934 "type": "string" 6935 }, 6936 "required": true 6937 } 6938 ], 6939 "responses": { 6940 "204": { 6941 "description": "Success." 6942 }, 6943 "default": { 6944 "description": "Error.", 6945 "content": { 6946 "application/json": { 6947 "schema": { 6948 "$ref": "#/components/schemas/Error" 6949 } 6950 } 6951 } 6952 } 6953 } 6954 }, 6955 "get": { 6956 "description": "Retrieves the KubeletConfig for a cluster", 6957 "parameters": [ 6958 { 6959 "name": "cluster_id", 6960 "in": "path", 6961 "schema": { 6962 "type": "string" 6963 }, 6964 "required": true 6965 } 6966 ], 6967 "responses": { 6968 "200": { 6969 "description": "Success.", 6970 "content": { 6971 "application/json": { 6972 "schema": { 6973 "$ref": "#/components/schemas/KubeletConfig" 6974 } 6975 } 6976 } 6977 }, 6978 "default": { 6979 "description": "Error.", 6980 "content": { 6981 "application/json": { 6982 "schema": { 6983 "$ref": "#/components/schemas/Error" 6984 } 6985 } 6986 } 6987 } 6988 } 6989 }, 6990 "post": { 6991 "description": "Creates a new cluster KubeletConfig", 6992 "parameters": [ 6993 { 6994 "name": "cluster_id", 6995 "in": "path", 6996 "schema": { 6997 "type": "string" 6998 }, 6999 "required": true 7000 } 7001 ], 7002 "requestBody": { 7003 "content": { 7004 "application/json": { 7005 "schema": { 7006 "$ref": "#/components/schemas/KubeletConfig" 7007 } 7008 } 7009 } 7010 }, 7011 "responses": { 7012 "201": { 7013 "description": "Success.", 7014 "content": { 7015 "application/json": { 7016 "schema": { 7017 "$ref": "#/components/schemas/KubeletConfig" 7018 } 7019 } 7020 } 7021 }, 7022 "default": { 7023 "description": "Error.", 7024 "content": { 7025 "application/json": { 7026 "schema": { 7027 "$ref": "#/components/schemas/Error" 7028 } 7029 } 7030 } 7031 } 7032 } 7033 }, 7034 "patch": { 7035 "description": "Updates the existing cluster KubeletConfig", 7036 "parameters": [ 7037 { 7038 "name": "cluster_id", 7039 "in": "path", 7040 "schema": { 7041 "type": "string" 7042 }, 7043 "required": true 7044 } 7045 ], 7046 "requestBody": { 7047 "content": { 7048 "application/json": { 7049 "schema": { 7050 "$ref": "#/components/schemas/KubeletConfig" 7051 } 7052 } 7053 } 7054 }, 7055 "responses": { 7056 "200": { 7057 "description": "Success.", 7058 "content": { 7059 "application/json": { 7060 "schema": { 7061 "$ref": "#/components/schemas/KubeletConfig" 7062 } 7063 } 7064 } 7065 }, 7066 "default": { 7067 "description": "Error.", 7068 "content": { 7069 "application/json": { 7070 "schema": { 7071 "$ref": "#/components/schemas/Error" 7072 } 7073 } 7074 } 7075 } 7076 } 7077 } 7078 }, 7079 "/api/clusters_mgmt/v1/clusters/{cluster_id}/kubelet_configs": { 7080 "post": { 7081 "description": "Adds a new KubeletConfig to the cluster.", 7082 "parameters": [ 7083 { 7084 "name": "cluster_id", 7085 "in": "path", 7086 "schema": { 7087 "type": "string" 7088 }, 7089 "required": true 7090 } 7091 ], 7092 "requestBody": { 7093 "content": { 7094 "application/json": { 7095 "schema": { 7096 "$ref": "#/components/schemas/KubeletConfig" 7097 } 7098 } 7099 } 7100 }, 7101 "responses": { 7102 "201": { 7103 "description": "Success.", 7104 "content": { 7105 "application/json": { 7106 "schema": { 7107 "$ref": "#/components/schemas/KubeletConfig" 7108 } 7109 } 7110 } 7111 }, 7112 "default": { 7113 "description": "Error.", 7114 "content": { 7115 "application/json": { 7116 "schema": { 7117 "$ref": "#/components/schemas/Error" 7118 } 7119 } 7120 } 7121 } 7122 } 7123 }, 7124 "get": { 7125 "description": "Retrieves the list of KubeletConfigs for the cluster.", 7126 "parameters": [ 7127 { 7128 "name": "cluster_id", 7129 "in": "path", 7130 "schema": { 7131 "type": "string" 7132 }, 7133 "required": true 7134 }, 7135 { 7136 "name": "page", 7137 "description": "Index of the requested page, where one corresponds to the first page.", 7138 "in": "query", 7139 "schema": { 7140 "type": "integer", 7141 "format": "int32" 7142 } 7143 }, 7144 { 7145 "name": "size", 7146 "description": "Number of items contained in the returned page.", 7147 "in": "query", 7148 "schema": { 7149 "type": "integer", 7150 "format": "int32" 7151 } 7152 } 7153 ], 7154 "responses": { 7155 "200": { 7156 "description": "Success.", 7157 "content": { 7158 "application/json": { 7159 "schema": { 7160 "type": "object", 7161 "properties": { 7162 "items": { 7163 "description": "Retrieved list of KubeletConfigs.", 7164 "type": "array", 7165 "items": { 7166 "$ref": "#/components/schemas/KubeletConfig" 7167 } 7168 }, 7169 "page": { 7170 "description": "Index of the requested page, where one corresponds to the first page.", 7171 "type": "integer", 7172 "format": "int32" 7173 }, 7174 "size": { 7175 "description": "Number of items contained in the returned page.", 7176 "type": "integer", 7177 "format": "int32" 7178 }, 7179 "total": { 7180 "description": "Total number of items of the collection.", 7181 "type": "integer", 7182 "format": "int32" 7183 } 7184 } 7185 } 7186 } 7187 } 7188 }, 7189 "default": { 7190 "description": "Error.", 7191 "content": { 7192 "application/json": { 7193 "schema": { 7194 "$ref": "#/components/schemas/Error" 7195 } 7196 } 7197 } 7198 } 7199 } 7200 } 7201 }, 7202 "/api/clusters_mgmt/v1/clusters/{cluster_id}/kubelet_configs/{kubelet_config_id}": { 7203 "delete": { 7204 "description": "Deletes the KubeletConfig specified by the id.", 7205 "parameters": [ 7206 { 7207 "name": "cluster_id", 7208 "in": "path", 7209 "schema": { 7210 "type": "string" 7211 }, 7212 "required": true 7213 }, 7214 { 7215 "name": "kubelet_config_id", 7216 "in": "path", 7217 "schema": { 7218 "type": "string" 7219 }, 7220 "required": true 7221 } 7222 ], 7223 "responses": { 7224 "204": { 7225 "description": "Success." 7226 }, 7227 "default": { 7228 "description": "Error.", 7229 "content": { 7230 "application/json": { 7231 "schema": { 7232 "$ref": "#/components/schemas/Error" 7233 } 7234 } 7235 } 7236 } 7237 } 7238 }, 7239 "get": { 7240 "description": "Retrieves the KubeletConfig specified by the id.", 7241 "parameters": [ 7242 { 7243 "name": "cluster_id", 7244 "in": "path", 7245 "schema": { 7246 "type": "string" 7247 }, 7248 "required": true 7249 }, 7250 { 7251 "name": "kubelet_config_id", 7252 "in": "path", 7253 "schema": { 7254 "type": "string" 7255 }, 7256 "required": true 7257 } 7258 ], 7259 "responses": { 7260 "200": { 7261 "description": "Success.", 7262 "content": { 7263 "application/json": { 7264 "schema": { 7265 "$ref": "#/components/schemas/KubeletConfig" 7266 } 7267 } 7268 } 7269 }, 7270 "default": { 7271 "description": "Error.", 7272 "content": { 7273 "application/json": { 7274 "schema": { 7275 "$ref": "#/components/schemas/Error" 7276 } 7277 } 7278 } 7279 } 7280 } 7281 }, 7282 "patch": { 7283 "description": "Updates the KubeletConfig specified by the id.", 7284 "parameters": [ 7285 { 7286 "name": "cluster_id", 7287 "in": "path", 7288 "schema": { 7289 "type": "string" 7290 }, 7291 "required": true 7292 }, 7293 { 7294 "name": "kubelet_config_id", 7295 "in": "path", 7296 "schema": { 7297 "type": "string" 7298 }, 7299 "required": true 7300 } 7301 ], 7302 "requestBody": { 7303 "content": { 7304 "application/json": { 7305 "schema": { 7306 "$ref": "#/components/schemas/KubeletConfig" 7307 } 7308 } 7309 } 7310 }, 7311 "responses": { 7312 "200": { 7313 "description": "Success.", 7314 "content": { 7315 "application/json": { 7316 "schema": { 7317 "$ref": "#/components/schemas/KubeletConfig" 7318 } 7319 } 7320 } 7321 }, 7322 "default": { 7323 "description": "Error.", 7324 "content": { 7325 "application/json": { 7326 "schema": { 7327 "$ref": "#/components/schemas/Error" 7328 } 7329 } 7330 } 7331 } 7332 } 7333 } 7334 }, 7335 "/api/clusters_mgmt/v1/clusters/{cluster_id}/limited_support_reasons": { 7336 "post": { 7337 "description": "Adds a new reason to the cluster.", 7338 "parameters": [ 7339 { 7340 "name": "cluster_id", 7341 "in": "path", 7342 "schema": { 7343 "type": "string" 7344 }, 7345 "required": true 7346 } 7347 ], 7348 "requestBody": { 7349 "content": { 7350 "application/json": { 7351 "schema": { 7352 "$ref": "#/components/schemas/LimitedSupportReason" 7353 } 7354 } 7355 } 7356 }, 7357 "responses": { 7358 "201": { 7359 "description": "Success.", 7360 "content": { 7361 "application/json": { 7362 "schema": { 7363 "$ref": "#/components/schemas/LimitedSupportReason" 7364 } 7365 } 7366 } 7367 }, 7368 "default": { 7369 "description": "Error.", 7370 "content": { 7371 "application/json": { 7372 "schema": { 7373 "$ref": "#/components/schemas/Error" 7374 } 7375 } 7376 } 7377 } 7378 } 7379 }, 7380 "get": { 7381 "description": "Retrieves the list of reasons.", 7382 "parameters": [ 7383 { 7384 "name": "cluster_id", 7385 "in": "path", 7386 "schema": { 7387 "type": "string" 7388 }, 7389 "required": true 7390 }, 7391 { 7392 "name": "page", 7393 "description": "Index of the requested page, where one corresponds to the first page.", 7394 "in": "query", 7395 "schema": { 7396 "type": "integer", 7397 "format": "int32" 7398 } 7399 }, 7400 { 7401 "name": "size", 7402 "description": "Number of items contained in the returned page.", 7403 "in": "query", 7404 "schema": { 7405 "type": "integer", 7406 "format": "int32" 7407 } 7408 } 7409 ], 7410 "responses": { 7411 "200": { 7412 "description": "Success.", 7413 "content": { 7414 "application/json": { 7415 "schema": { 7416 "type": "object", 7417 "properties": { 7418 "items": { 7419 "description": "Retrieved list of template.", 7420 "type": "array", 7421 "items": { 7422 "$ref": "#/components/schemas/LimitedSupportReason" 7423 } 7424 }, 7425 "page": { 7426 "description": "Index of the requested page, where one corresponds to the first page.", 7427 "type": "integer", 7428 "format": "int32" 7429 }, 7430 "size": { 7431 "description": "Number of items contained in the returned page.", 7432 "type": "integer", 7433 "format": "int32" 7434 }, 7435 "total": { 7436 "description": "Total number of items of the collection.", 7437 "type": "integer", 7438 "format": "int32" 7439 } 7440 } 7441 } 7442 } 7443 } 7444 }, 7445 "default": { 7446 "description": "Error.", 7447 "content": { 7448 "application/json": { 7449 "schema": { 7450 "$ref": "#/components/schemas/Error" 7451 } 7452 } 7453 } 7454 } 7455 } 7456 } 7457 }, 7458 "/api/clusters_mgmt/v1/clusters/{cluster_id}/limited_support_reasons/{limited_support_reason_id}": { 7459 "delete": { 7460 "description": "Deletes the reason.", 7461 "parameters": [ 7462 { 7463 "name": "cluster_id", 7464 "in": "path", 7465 "schema": { 7466 "type": "string" 7467 }, 7468 "required": true 7469 }, 7470 { 7471 "name": "limited_support_reason_id", 7472 "in": "path", 7473 "schema": { 7474 "type": "string" 7475 }, 7476 "required": true 7477 } 7478 ], 7479 "responses": { 7480 "204": { 7481 "description": "Success." 7482 }, 7483 "default": { 7484 "description": "Error.", 7485 "content": { 7486 "application/json": { 7487 "schema": { 7488 "$ref": "#/components/schemas/Error" 7489 } 7490 } 7491 } 7492 } 7493 } 7494 }, 7495 "get": { 7496 "description": "Retrieves the details of the reason.", 7497 "parameters": [ 7498 { 7499 "name": "cluster_id", 7500 "in": "path", 7501 "schema": { 7502 "type": "string" 7503 }, 7504 "required": true 7505 }, 7506 { 7507 "name": "limited_support_reason_id", 7508 "in": "path", 7509 "schema": { 7510 "type": "string" 7511 }, 7512 "required": true 7513 } 7514 ], 7515 "responses": { 7516 "200": { 7517 "description": "Success.", 7518 "content": { 7519 "application/json": { 7520 "schema": { 7521 "$ref": "#/components/schemas/LimitedSupportReason" 7522 } 7523 } 7524 } 7525 }, 7526 "default": { 7527 "description": "Error.", 7528 "content": { 7529 "application/json": { 7530 "schema": { 7531 "$ref": "#/components/schemas/Error" 7532 } 7533 } 7534 } 7535 } 7536 } 7537 } 7538 }, 7539 "/api/clusters_mgmt/v1/clusters/{cluster_id}/logs": { 7540 "get": { 7541 "description": "Retrieves the list of log links.", 7542 "parameters": [ 7543 { 7544 "name": "cluster_id", 7545 "in": "path", 7546 "schema": { 7547 "type": "string" 7548 }, 7549 "required": true 7550 }, 7551 { 7552 "name": "page", 7553 "description": "Index of the requested page, where one corresponds to the first page.", 7554 "in": "query", 7555 "schema": { 7556 "type": "integer", 7557 "format": "int32" 7558 } 7559 }, 7560 { 7561 "name": "size", 7562 "description": "Number of items contained in the returned page.", 7563 "in": "query", 7564 "schema": { 7565 "type": "integer", 7566 "format": "int32" 7567 } 7568 } 7569 ], 7570 "responses": { 7571 "200": { 7572 "description": "Success.", 7573 "content": { 7574 "application/json": { 7575 "schema": { 7576 "type": "object", 7577 "properties": { 7578 "items": { 7579 "description": "Retrieved list of log links.", 7580 "type": "array", 7581 "items": { 7582 "$ref": "#/components/schemas/Log" 7583 } 7584 }, 7585 "page": { 7586 "description": "Index of the requested page, where one corresponds to the first page.", 7587 "type": "integer", 7588 "format": "int32" 7589 }, 7590 "size": { 7591 "description": "Number of items contained in the returned page.", 7592 "type": "integer", 7593 "format": "int32" 7594 }, 7595 "total": { 7596 "description": "Total number of items of the collection.", 7597 "type": "integer", 7598 "format": "int32" 7599 } 7600 } 7601 } 7602 } 7603 } 7604 }, 7605 "default": { 7606 "description": "Error.", 7607 "content": { 7608 "application/json": { 7609 "schema": { 7610 "$ref": "#/components/schemas/Error" 7611 } 7612 } 7613 } 7614 } 7615 } 7616 } 7617 }, 7618 "/api/clusters_mgmt/v1/clusters/{cluster_id}/logs/install": { 7619 "get": { 7620 "description": "Retrieves the details of the log.", 7621 "parameters": [ 7622 { 7623 "name": "cluster_id", 7624 "in": "path", 7625 "schema": { 7626 "type": "string" 7627 }, 7628 "required": true 7629 }, 7630 { 7631 "name": "offset", 7632 "description": "Line offset to start logs from. if 0 retreive entire log.\nIf offset > #lines return an empty log.", 7633 "in": "query", 7634 "schema": { 7635 "type": "integer", 7636 "format": "int32" 7637 } 7638 }, 7639 { 7640 "name": "tail", 7641 "description": "Returns the number of tail lines from the end of the log.\nIf there are no line breaks or the number of lines < tail\nreturn the entire log.\nEither 'tail' or 'offset' can be set. Not both. ", 7642 "in": "query", 7643 "schema": { 7644 "type": "integer", 7645 "format": "int32" 7646 } 7647 } 7648 ], 7649 "responses": { 7650 "200": { 7651 "description": "Success.", 7652 "content": { 7653 "application/json": { 7654 "schema": { 7655 "$ref": "#/components/schemas/Log" 7656 } 7657 } 7658 } 7659 }, 7660 "default": { 7661 "description": "Error.", 7662 "content": { 7663 "application/json": { 7664 "schema": { 7665 "$ref": "#/components/schemas/Error" 7666 } 7667 } 7668 } 7669 } 7670 } 7671 } 7672 }, 7673 "/api/clusters_mgmt/v1/clusters/{cluster_id}/logs/uninstall": { 7674 "get": { 7675 "description": "Retrieves the details of the log.", 7676 "parameters": [ 7677 { 7678 "name": "cluster_id", 7679 "in": "path", 7680 "schema": { 7681 "type": "string" 7682 }, 7683 "required": true 7684 }, 7685 { 7686 "name": "offset", 7687 "description": "Line offset to start logs from. if 0 retreive entire log.\nIf offset > #lines return an empty log.", 7688 "in": "query", 7689 "schema": { 7690 "type": "integer", 7691 "format": "int32" 7692 } 7693 }, 7694 { 7695 "name": "tail", 7696 "description": "Returns the number of tail lines from the end of the log.\nIf there are no line breaks or the number of lines < tail\nreturn the entire log.\nEither 'tail' or 'offset' can be set. Not both. ", 7697 "in": "query", 7698 "schema": { 7699 "type": "integer", 7700 "format": "int32" 7701 } 7702 } 7703 ], 7704 "responses": { 7705 "200": { 7706 "description": "Success.", 7707 "content": { 7708 "application/json": { 7709 "schema": { 7710 "$ref": "#/components/schemas/Log" 7711 } 7712 } 7713 } 7714 }, 7715 "default": { 7716 "description": "Error.", 7717 "content": { 7718 "application/json": { 7719 "schema": { 7720 "$ref": "#/components/schemas/Error" 7721 } 7722 } 7723 } 7724 } 7725 } 7726 } 7727 }, 7728 "/api/clusters_mgmt/v1/clusters/{cluster_id}/machine_pools": { 7729 "post": { 7730 "description": "Adds a new machine pool to the cluster.", 7731 "parameters": [ 7732 { 7733 "name": "cluster_id", 7734 "in": "path", 7735 "schema": { 7736 "type": "string" 7737 }, 7738 "required": true 7739 } 7740 ], 7741 "requestBody": { 7742 "content": { 7743 "application/json": { 7744 "schema": { 7745 "$ref": "#/components/schemas/MachinePool" 7746 } 7747 } 7748 } 7749 }, 7750 "responses": { 7751 "201": { 7752 "description": "Success.", 7753 "content": { 7754 "application/json": { 7755 "schema": { 7756 "$ref": "#/components/schemas/MachinePool" 7757 } 7758 } 7759 } 7760 }, 7761 "default": { 7762 "description": "Error.", 7763 "content": { 7764 "application/json": { 7765 "schema": { 7766 "$ref": "#/components/schemas/Error" 7767 } 7768 } 7769 } 7770 } 7771 } 7772 }, 7773 "get": { 7774 "description": "Retrieves the list of machine pools.", 7775 "parameters": [ 7776 { 7777 "name": "cluster_id", 7778 "in": "path", 7779 "schema": { 7780 "type": "string" 7781 }, 7782 "required": true 7783 }, 7784 { 7785 "name": "page", 7786 "description": "Index of the requested page, where one corresponds to the first page.", 7787 "in": "query", 7788 "schema": { 7789 "type": "integer", 7790 "format": "int32" 7791 } 7792 }, 7793 { 7794 "name": "size", 7795 "description": "Number of items contained in the returned page.", 7796 "in": "query", 7797 "schema": { 7798 "type": "integer", 7799 "format": "int32" 7800 } 7801 } 7802 ], 7803 "responses": { 7804 "200": { 7805 "description": "Success.", 7806 "content": { 7807 "application/json": { 7808 "schema": { 7809 "type": "object", 7810 "properties": { 7811 "items": { 7812 "description": "Retrieved list of machine pools.", 7813 "type": "array", 7814 "items": { 7815 "$ref": "#/components/schemas/MachinePool" 7816 } 7817 }, 7818 "page": { 7819 "description": "Index of the requested page, where one corresponds to the first page.", 7820 "type": "integer", 7821 "format": "int32" 7822 }, 7823 "size": { 7824 "description": "Number of items contained in the returned page.", 7825 "type": "integer", 7826 "format": "int32" 7827 }, 7828 "total": { 7829 "description": "Total number of items of the collection.", 7830 "type": "integer", 7831 "format": "int32" 7832 } 7833 } 7834 } 7835 } 7836 } 7837 }, 7838 "default": { 7839 "description": "Error.", 7840 "content": { 7841 "application/json": { 7842 "schema": { 7843 "$ref": "#/components/schemas/Error" 7844 } 7845 } 7846 } 7847 } 7848 } 7849 } 7850 }, 7851 "/api/clusters_mgmt/v1/clusters/{cluster_id}/machine_pools/{machine_pool_id}": { 7852 "delete": { 7853 "description": "Deletes the machine pool.", 7854 "parameters": [ 7855 { 7856 "name": "cluster_id", 7857 "in": "path", 7858 "schema": { 7859 "type": "string" 7860 }, 7861 "required": true 7862 }, 7863 { 7864 "name": "machine_pool_id", 7865 "in": "path", 7866 "schema": { 7867 "type": "string" 7868 }, 7869 "required": true 7870 } 7871 ], 7872 "responses": { 7873 "204": { 7874 "description": "Success." 7875 }, 7876 "default": { 7877 "description": "Error.", 7878 "content": { 7879 "application/json": { 7880 "schema": { 7881 "$ref": "#/components/schemas/Error" 7882 } 7883 } 7884 } 7885 } 7886 } 7887 }, 7888 "get": { 7889 "description": "Retrieves the details of the machine pool.", 7890 "parameters": [ 7891 { 7892 "name": "cluster_id", 7893 "in": "path", 7894 "schema": { 7895 "type": "string" 7896 }, 7897 "required": true 7898 }, 7899 { 7900 "name": "machine_pool_id", 7901 "in": "path", 7902 "schema": { 7903 "type": "string" 7904 }, 7905 "required": true 7906 } 7907 ], 7908 "responses": { 7909 "200": { 7910 "description": "Success.", 7911 "content": { 7912 "application/json": { 7913 "schema": { 7914 "$ref": "#/components/schemas/MachinePool" 7915 } 7916 } 7917 } 7918 }, 7919 "default": { 7920 "description": "Error.", 7921 "content": { 7922 "application/json": { 7923 "schema": { 7924 "$ref": "#/components/schemas/Error" 7925 } 7926 } 7927 } 7928 } 7929 } 7930 }, 7931 "patch": { 7932 "description": "Updates the machine pool.", 7933 "parameters": [ 7934 { 7935 "name": "cluster_id", 7936 "in": "path", 7937 "schema": { 7938 "type": "string" 7939 }, 7940 "required": true 7941 }, 7942 { 7943 "name": "machine_pool_id", 7944 "in": "path", 7945 "schema": { 7946 "type": "string" 7947 }, 7948 "required": true 7949 } 7950 ], 7951 "requestBody": { 7952 "content": { 7953 "application/json": { 7954 "schema": { 7955 "$ref": "#/components/schemas/MachinePool" 7956 } 7957 } 7958 } 7959 }, 7960 "responses": { 7961 "200": { 7962 "description": "Success.", 7963 "content": { 7964 "application/json": { 7965 "schema": { 7966 "$ref": "#/components/schemas/MachinePool" 7967 } 7968 } 7969 } 7970 }, 7971 "default": { 7972 "description": "Error.", 7973 "content": { 7974 "application/json": { 7975 "schema": { 7976 "$ref": "#/components/schemas/Error" 7977 } 7978 } 7979 } 7980 } 7981 } 7982 } 7983 }, 7984 "/api/clusters_mgmt/v1/clusters/{cluster_id}/metric_queries/alerts": { 7985 "get": { 7986 "parameters": [ 7987 { 7988 "name": "cluster_id", 7989 "in": "path", 7990 "schema": { 7991 "type": "string" 7992 }, 7993 "required": true 7994 } 7995 ], 7996 "responses": { 7997 "200": { 7998 "description": "Success.", 7999 "content": { 8000 "application/json": { 8001 "schema": { 8002 "$ref": "#/components/schemas/AlertsInfo" 8003 } 8004 } 8005 } 8006 }, 8007 "default": { 8008 "description": "Error.", 8009 "content": { 8010 "application/json": { 8011 "schema": { 8012 "$ref": "#/components/schemas/Error" 8013 } 8014 } 8015 } 8016 } 8017 } 8018 } 8019 }, 8020 "/api/clusters_mgmt/v1/clusters/{cluster_id}/metric_queries/cluster_operators": { 8021 "get": { 8022 "parameters": [ 8023 { 8024 "name": "cluster_id", 8025 "in": "path", 8026 "schema": { 8027 "type": "string" 8028 }, 8029 "required": true 8030 } 8031 ], 8032 "responses": { 8033 "200": { 8034 "description": "Success.", 8035 "content": { 8036 "application/json": { 8037 "schema": { 8038 "$ref": "#/components/schemas/ClusterOperatorsInfo" 8039 } 8040 } 8041 } 8042 }, 8043 "default": { 8044 "description": "Error.", 8045 "content": { 8046 "application/json": { 8047 "schema": { 8048 "$ref": "#/components/schemas/Error" 8049 } 8050 } 8051 } 8052 } 8053 } 8054 } 8055 }, 8056 "/api/clusters_mgmt/v1/clusters/{cluster_id}/metric_queries/cpu_total_by_node_roles_os": { 8057 "get": { 8058 "description": "Retrieves the metrics.", 8059 "parameters": [ 8060 { 8061 "name": "cluster_id", 8062 "in": "path", 8063 "schema": { 8064 "type": "string" 8065 }, 8066 "required": true 8067 } 8068 ], 8069 "responses": { 8070 "200": { 8071 "description": "Success.", 8072 "content": { 8073 "application/json": { 8074 "schema": { 8075 "$ref": "#/components/schemas/CPUTotalsNodeRoleOSMetricNode" 8076 } 8077 } 8078 } 8079 }, 8080 "default": { 8081 "description": "Error.", 8082 "content": { 8083 "application/json": { 8084 "schema": { 8085 "$ref": "#/components/schemas/Error" 8086 } 8087 } 8088 } 8089 } 8090 } 8091 } 8092 }, 8093 "/api/clusters_mgmt/v1/clusters/{cluster_id}/metric_queries/nodes": { 8094 "get": { 8095 "parameters": [ 8096 { 8097 "name": "cluster_id", 8098 "in": "path", 8099 "schema": { 8100 "type": "string" 8101 }, 8102 "required": true 8103 } 8104 ], 8105 "responses": { 8106 "200": { 8107 "description": "Success.", 8108 "content": { 8109 "application/json": { 8110 "schema": { 8111 "$ref": "#/components/schemas/NodesInfo" 8112 } 8113 } 8114 } 8115 }, 8116 "default": { 8117 "description": "Error.", 8118 "content": { 8119 "application/json": { 8120 "schema": { 8121 "$ref": "#/components/schemas/Error" 8122 } 8123 } 8124 } 8125 } 8126 } 8127 } 8128 }, 8129 "/api/clusters_mgmt/v1/clusters/{cluster_id}/metric_queries/socket_total_by_node_roles_os": { 8130 "get": { 8131 "description": "Retrieves the metrics.", 8132 "parameters": [ 8133 { 8134 "name": "cluster_id", 8135 "in": "path", 8136 "schema": { 8137 "type": "string" 8138 }, 8139 "required": true 8140 } 8141 ], 8142 "responses": { 8143 "200": { 8144 "description": "Success.", 8145 "content": { 8146 "application/json": { 8147 "schema": { 8148 "$ref": "#/components/schemas/SocketTotalsNodeRoleOSMetricNode" 8149 } 8150 } 8151 } 8152 }, 8153 "default": { 8154 "description": "Error.", 8155 "content": { 8156 "application/json": { 8157 "schema": { 8158 "$ref": "#/components/schemas/Error" 8159 } 8160 } 8161 } 8162 } 8163 } 8164 } 8165 }, 8166 "/api/clusters_mgmt/v1/clusters/{cluster_id}/migrations": { 8167 "post": { 8168 "description": "Adds a cluster migration to the database.", 8169 "parameters": [ 8170 { 8171 "name": "cluster_id", 8172 "in": "path", 8173 "schema": { 8174 "type": "string" 8175 }, 8176 "required": true 8177 } 8178 ], 8179 "requestBody": { 8180 "content": { 8181 "application/json": { 8182 "schema": { 8183 "$ref": "#/components/schemas/ClusterMigration" 8184 } 8185 } 8186 } 8187 }, 8188 "responses": { 8189 "201": { 8190 "description": "Success.", 8191 "content": { 8192 "application/json": { 8193 "schema": { 8194 "$ref": "#/components/schemas/ClusterMigration" 8195 } 8196 } 8197 } 8198 }, 8199 "default": { 8200 "description": "Error.", 8201 "content": { 8202 "application/json": { 8203 "schema": { 8204 "$ref": "#/components/schemas/Error" 8205 } 8206 } 8207 } 8208 } 8209 } 8210 }, 8211 "get": { 8212 "parameters": [ 8213 { 8214 "name": "cluster_id", 8215 "in": "path", 8216 "schema": { 8217 "type": "string" 8218 }, 8219 "required": true 8220 }, 8221 { 8222 "name": "page", 8223 "description": "Index of the returned page, where one corresponds to the first page.", 8224 "in": "query", 8225 "schema": { 8226 "type": "integer", 8227 "format": "int32" 8228 } 8229 }, 8230 { 8231 "name": "size", 8232 "description": "Number of items that will be contained in the returned page.", 8233 "in": "query", 8234 "schema": { 8235 "type": "integer", 8236 "format": "int32" 8237 } 8238 } 8239 ], 8240 "responses": { 8241 "200": { 8242 "description": "Success.", 8243 "content": { 8244 "application/json": { 8245 "schema": { 8246 "type": "object", 8247 "properties": { 8248 "items": { 8249 "description": "Retrieved list of cluster migrations.", 8250 "type": "array", 8251 "items": { 8252 "$ref": "#/components/schemas/ClusterMigration" 8253 } 8254 }, 8255 "page": { 8256 "description": "Index of the returned page, where one corresponds to the first page.", 8257 "type": "integer", 8258 "format": "int32" 8259 }, 8260 "size": { 8261 "description": "Number of items that will be contained in the returned page.", 8262 "type": "integer", 8263 "format": "int32" 8264 }, 8265 "total": { 8266 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of migrations of the cluster.", 8267 "type": "integer", 8268 "format": "int32" 8269 } 8270 } 8271 } 8272 } 8273 } 8274 }, 8275 "default": { 8276 "description": "Error.", 8277 "content": { 8278 "application/json": { 8279 "schema": { 8280 "$ref": "#/components/schemas/Error" 8281 } 8282 } 8283 } 8284 } 8285 } 8286 } 8287 }, 8288 "/api/clusters_mgmt/v1/clusters/{cluster_id}/migrations/{migration_id}": { 8289 "get": { 8290 "description": "Retrieves the details of the cluster migration.", 8291 "parameters": [ 8292 { 8293 "name": "cluster_id", 8294 "in": "path", 8295 "schema": { 8296 "type": "string" 8297 }, 8298 "required": true 8299 }, 8300 { 8301 "name": "migration_id", 8302 "in": "path", 8303 "schema": { 8304 "type": "string" 8305 }, 8306 "required": true 8307 } 8308 ], 8309 "responses": { 8310 "200": { 8311 "description": "Success.", 8312 "content": { 8313 "application/json": { 8314 "schema": { 8315 "$ref": "#/components/schemas/ClusterMigration" 8316 } 8317 } 8318 } 8319 }, 8320 "default": { 8321 "description": "Error.", 8322 "content": { 8323 "application/json": { 8324 "schema": { 8325 "$ref": "#/components/schemas/Error" 8326 } 8327 } 8328 } 8329 } 8330 } 8331 } 8332 }, 8333 "/api/clusters_mgmt/v1/clusters/{cluster_id}/node_pools": { 8334 "post": { 8335 "description": "Adds a new node pool to the cluster.", 8336 "parameters": [ 8337 { 8338 "name": "cluster_id", 8339 "in": "path", 8340 "schema": { 8341 "type": "string" 8342 }, 8343 "required": true 8344 } 8345 ], 8346 "requestBody": { 8347 "content": { 8348 "application/json": { 8349 "schema": { 8350 "$ref": "#/components/schemas/NodePool" 8351 } 8352 } 8353 } 8354 }, 8355 "responses": { 8356 "201": { 8357 "description": "Success.", 8358 "content": { 8359 "application/json": { 8360 "schema": { 8361 "$ref": "#/components/schemas/NodePool" 8362 } 8363 } 8364 } 8365 }, 8366 "default": { 8367 "description": "Error.", 8368 "content": { 8369 "application/json": { 8370 "schema": { 8371 "$ref": "#/components/schemas/Error" 8372 } 8373 } 8374 } 8375 } 8376 } 8377 }, 8378 "get": { 8379 "description": "Retrieves the list of node pools.", 8380 "parameters": [ 8381 { 8382 "name": "cluster_id", 8383 "in": "path", 8384 "schema": { 8385 "type": "string" 8386 }, 8387 "required": true 8388 }, 8389 { 8390 "name": "order", 8391 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the node pools instead of\nthe names of the columns of a table. For example, in order to sort the node pools\ndescending by identifier the value should be:\n\n```sql\nid desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 8392 "in": "query", 8393 "schema": { 8394 "type": "string" 8395 } 8396 }, 8397 { 8398 "name": "page", 8399 "description": "Index of the requested page, where one corresponds to the first page.", 8400 "in": "query", 8401 "schema": { 8402 "type": "integer", 8403 "format": "int32" 8404 } 8405 }, 8406 { 8407 "name": "search", 8408 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the node pools instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nnode pools with replicas of two the following is required:\n\n```sql\nreplicas = 2\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nnode pools that the user has permission to see will be returned.", 8409 "in": "query", 8410 "schema": { 8411 "type": "string" 8412 } 8413 }, 8414 { 8415 "name": "size", 8416 "description": "Number of items contained in the returned page.", 8417 "in": "query", 8418 "schema": { 8419 "type": "integer", 8420 "format": "int32" 8421 } 8422 } 8423 ], 8424 "responses": { 8425 "200": { 8426 "description": "Success.", 8427 "content": { 8428 "application/json": { 8429 "schema": { 8430 "type": "object", 8431 "properties": { 8432 "items": { 8433 "description": "Retrieved list of node pools.", 8434 "type": "array", 8435 "items": { 8436 "$ref": "#/components/schemas/NodePool" 8437 } 8438 }, 8439 "page": { 8440 "description": "Index of the requested page, where one corresponds to the first page.", 8441 "type": "integer", 8442 "format": "int32" 8443 }, 8444 "size": { 8445 "description": "Number of items contained in the returned page.", 8446 "type": "integer", 8447 "format": "int32" 8448 }, 8449 "total": { 8450 "description": "Total number of items of the collection.", 8451 "type": "integer", 8452 "format": "int32" 8453 } 8454 } 8455 } 8456 } 8457 } 8458 }, 8459 "default": { 8460 "description": "Error.", 8461 "content": { 8462 "application/json": { 8463 "schema": { 8464 "$ref": "#/components/schemas/Error" 8465 } 8466 } 8467 } 8468 } 8469 } 8470 } 8471 }, 8472 "/api/clusters_mgmt/v1/clusters/{cluster_id}/node_pools/{node_pool_id}": { 8473 "delete": { 8474 "description": "Deletes the node pool.", 8475 "parameters": [ 8476 { 8477 "name": "cluster_id", 8478 "in": "path", 8479 "schema": { 8480 "type": "string" 8481 }, 8482 "required": true 8483 }, 8484 { 8485 "name": "node_pool_id", 8486 "in": "path", 8487 "schema": { 8488 "type": "string" 8489 }, 8490 "required": true 8491 } 8492 ], 8493 "responses": { 8494 "204": { 8495 "description": "Success." 8496 }, 8497 "default": { 8498 "description": "Error.", 8499 "content": { 8500 "application/json": { 8501 "schema": { 8502 "$ref": "#/components/schemas/Error" 8503 } 8504 } 8505 } 8506 } 8507 } 8508 }, 8509 "get": { 8510 "description": "Retrieves the details of the node pool.", 8511 "parameters": [ 8512 { 8513 "name": "cluster_id", 8514 "in": "path", 8515 "schema": { 8516 "type": "string" 8517 }, 8518 "required": true 8519 }, 8520 { 8521 "name": "node_pool_id", 8522 "in": "path", 8523 "schema": { 8524 "type": "string" 8525 }, 8526 "required": true 8527 } 8528 ], 8529 "responses": { 8530 "200": { 8531 "description": "Success.", 8532 "content": { 8533 "application/json": { 8534 "schema": { 8535 "$ref": "#/components/schemas/NodePool" 8536 } 8537 } 8538 } 8539 }, 8540 "default": { 8541 "description": "Error.", 8542 "content": { 8543 "application/json": { 8544 "schema": { 8545 "$ref": "#/components/schemas/Error" 8546 } 8547 } 8548 } 8549 } 8550 } 8551 }, 8552 "patch": { 8553 "description": "Updates the node pool.", 8554 "parameters": [ 8555 { 8556 "name": "cluster_id", 8557 "in": "path", 8558 "schema": { 8559 "type": "string" 8560 }, 8561 "required": true 8562 }, 8563 { 8564 "name": "node_pool_id", 8565 "in": "path", 8566 "schema": { 8567 "type": "string" 8568 }, 8569 "required": true 8570 } 8571 ], 8572 "requestBody": { 8573 "content": { 8574 "application/json": { 8575 "schema": { 8576 "$ref": "#/components/schemas/NodePool" 8577 } 8578 } 8579 } 8580 }, 8581 "responses": { 8582 "200": { 8583 "description": "Success.", 8584 "content": { 8585 "application/json": { 8586 "schema": { 8587 "$ref": "#/components/schemas/NodePool" 8588 } 8589 } 8590 } 8591 }, 8592 "default": { 8593 "description": "Error.", 8594 "content": { 8595 "application/json": { 8596 "schema": { 8597 "$ref": "#/components/schemas/Error" 8598 } 8599 } 8600 } 8601 } 8602 } 8603 } 8604 }, 8605 "/api/clusters_mgmt/v1/clusters/{cluster_id}/node_pools/{node_pool_id}/upgrade_policies": { 8606 "post": { 8607 "description": "Adds a new upgrade policy to the node pool of the cluster.", 8608 "parameters": [ 8609 { 8610 "name": "cluster_id", 8611 "in": "path", 8612 "schema": { 8613 "type": "string" 8614 }, 8615 "required": true 8616 }, 8617 { 8618 "name": "node_pool_id", 8619 "in": "path", 8620 "schema": { 8621 "type": "string" 8622 }, 8623 "required": true 8624 } 8625 ], 8626 "requestBody": { 8627 "content": { 8628 "application/json": { 8629 "schema": { 8630 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8631 } 8632 } 8633 } 8634 }, 8635 "responses": { 8636 "201": { 8637 "description": "Success.", 8638 "content": { 8639 "application/json": { 8640 "schema": { 8641 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8642 } 8643 } 8644 } 8645 }, 8646 "default": { 8647 "description": "Error.", 8648 "content": { 8649 "application/json": { 8650 "schema": { 8651 "$ref": "#/components/schemas/Error" 8652 } 8653 } 8654 } 8655 } 8656 } 8657 }, 8658 "get": { 8659 "description": "Retrieves the list of upgrade policies for the node pool.", 8660 "parameters": [ 8661 { 8662 "name": "cluster_id", 8663 "in": "path", 8664 "schema": { 8665 "type": "string" 8666 }, 8667 "required": true 8668 }, 8669 { 8670 "name": "node_pool_id", 8671 "in": "path", 8672 "schema": { 8673 "type": "string" 8674 }, 8675 "required": true 8676 }, 8677 { 8678 "name": "page", 8679 "description": "Index of the requested page, where one corresponds to the first page.", 8680 "in": "query", 8681 "schema": { 8682 "type": "integer", 8683 "format": "int32" 8684 } 8685 }, 8686 { 8687 "name": "size", 8688 "description": "Number of items contained in the returned page.", 8689 "in": "query", 8690 "schema": { 8691 "type": "integer", 8692 "format": "int32" 8693 } 8694 } 8695 ], 8696 "responses": { 8697 "200": { 8698 "description": "Success.", 8699 "content": { 8700 "application/json": { 8701 "schema": { 8702 "type": "object", 8703 "properties": { 8704 "items": { 8705 "description": "Retrieved list of upgrade policy.", 8706 "type": "array", 8707 "items": { 8708 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8709 } 8710 }, 8711 "page": { 8712 "description": "Index of the requested page, where one corresponds to the first page.", 8713 "type": "integer", 8714 "format": "int32" 8715 }, 8716 "size": { 8717 "description": "Number of items contained in the returned page.", 8718 "type": "integer", 8719 "format": "int32" 8720 }, 8721 "total": { 8722 "description": "Total number of items of the collection.", 8723 "type": "integer", 8724 "format": "int32" 8725 } 8726 } 8727 } 8728 } 8729 } 8730 }, 8731 "default": { 8732 "description": "Error.", 8733 "content": { 8734 "application/json": { 8735 "schema": { 8736 "$ref": "#/components/schemas/Error" 8737 } 8738 } 8739 } 8740 } 8741 } 8742 } 8743 }, 8744 "/api/clusters_mgmt/v1/clusters/{cluster_id}/node_pools/{node_pool_id}/upgrade_policies/{node_pool_upgrade_policy_id}": { 8745 "delete": { 8746 "description": "Deletes the upgrade policy for the node pool.", 8747 "parameters": [ 8748 { 8749 "name": "cluster_id", 8750 "in": "path", 8751 "schema": { 8752 "type": "string" 8753 }, 8754 "required": true 8755 }, 8756 { 8757 "name": "node_pool_id", 8758 "in": "path", 8759 "schema": { 8760 "type": "string" 8761 }, 8762 "required": true 8763 }, 8764 { 8765 "name": "node_pool_upgrade_policy_id", 8766 "in": "path", 8767 "schema": { 8768 "type": "string" 8769 }, 8770 "required": true 8771 } 8772 ], 8773 "responses": { 8774 "204": { 8775 "description": "Success." 8776 }, 8777 "default": { 8778 "description": "Error.", 8779 "content": { 8780 "application/json": { 8781 "schema": { 8782 "$ref": "#/components/schemas/Error" 8783 } 8784 } 8785 } 8786 } 8787 } 8788 }, 8789 "get": { 8790 "description": "Retrieves the details of the upgrade policy for the node pool.", 8791 "parameters": [ 8792 { 8793 "name": "cluster_id", 8794 "in": "path", 8795 "schema": { 8796 "type": "string" 8797 }, 8798 "required": true 8799 }, 8800 { 8801 "name": "node_pool_id", 8802 "in": "path", 8803 "schema": { 8804 "type": "string" 8805 }, 8806 "required": true 8807 }, 8808 { 8809 "name": "node_pool_upgrade_policy_id", 8810 "in": "path", 8811 "schema": { 8812 "type": "string" 8813 }, 8814 "required": true 8815 } 8816 ], 8817 "responses": { 8818 "200": { 8819 "description": "Success.", 8820 "content": { 8821 "application/json": { 8822 "schema": { 8823 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8824 } 8825 } 8826 } 8827 }, 8828 "default": { 8829 "description": "Error.", 8830 "content": { 8831 "application/json": { 8832 "schema": { 8833 "$ref": "#/components/schemas/Error" 8834 } 8835 } 8836 } 8837 } 8838 } 8839 }, 8840 "patch": { 8841 "description": "Update the upgrade policy for the node pool.", 8842 "parameters": [ 8843 { 8844 "name": "cluster_id", 8845 "in": "path", 8846 "schema": { 8847 "type": "string" 8848 }, 8849 "required": true 8850 }, 8851 { 8852 "name": "node_pool_id", 8853 "in": "path", 8854 "schema": { 8855 "type": "string" 8856 }, 8857 "required": true 8858 }, 8859 { 8860 "name": "node_pool_upgrade_policy_id", 8861 "in": "path", 8862 "schema": { 8863 "type": "string" 8864 }, 8865 "required": true 8866 } 8867 ], 8868 "requestBody": { 8869 "content": { 8870 "application/json": { 8871 "schema": { 8872 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8873 } 8874 } 8875 } 8876 }, 8877 "responses": { 8878 "200": { 8879 "description": "Success.", 8880 "content": { 8881 "application/json": { 8882 "schema": { 8883 "$ref": "#/components/schemas/NodePoolUpgradePolicy" 8884 } 8885 } 8886 } 8887 }, 8888 "default": { 8889 "description": "Error.", 8890 "content": { 8891 "application/json": { 8892 "schema": { 8893 "$ref": "#/components/schemas/Error" 8894 } 8895 } 8896 } 8897 } 8898 } 8899 } 8900 }, 8901 "/api/clusters_mgmt/v1/clusters/{cluster_id}/provision_shard": { 8902 "delete": { 8903 "description": "Delete the provision shard.", 8904 "parameters": [ 8905 { 8906 "name": "cluster_id", 8907 "in": "path", 8908 "schema": { 8909 "type": "string" 8910 }, 8911 "required": true 8912 } 8913 ], 8914 "responses": { 8915 "204": { 8916 "description": "Success." 8917 }, 8918 "default": { 8919 "description": "Error.", 8920 "content": { 8921 "application/json": { 8922 "schema": { 8923 "$ref": "#/components/schemas/Error" 8924 } 8925 } 8926 } 8927 } 8928 } 8929 }, 8930 "get": { 8931 "description": "Retrieves the details of the provision shard.", 8932 "parameters": [ 8933 { 8934 "name": "cluster_id", 8935 "in": "path", 8936 "schema": { 8937 "type": "string" 8938 }, 8939 "required": true 8940 } 8941 ], 8942 "responses": { 8943 "200": { 8944 "description": "Success.", 8945 "content": { 8946 "application/json": { 8947 "schema": { 8948 "$ref": "#/components/schemas/ProvisionShard" 8949 } 8950 } 8951 } 8952 }, 8953 "default": { 8954 "description": "Error.", 8955 "content": { 8956 "application/json": { 8957 "schema": { 8958 "$ref": "#/components/schemas/Error" 8959 } 8960 } 8961 } 8962 } 8963 } 8964 }, 8965 "patch": { 8966 "description": "Updates the details of the provision shard.", 8967 "parameters": [ 8968 { 8969 "name": "cluster_id", 8970 "in": "path", 8971 "schema": { 8972 "type": "string" 8973 }, 8974 "required": true 8975 } 8976 ], 8977 "requestBody": { 8978 "content": { 8979 "application/json": { 8980 "schema": { 8981 "$ref": "#/components/schemas/ProvisionShard" 8982 } 8983 } 8984 } 8985 }, 8986 "responses": { 8987 "200": { 8988 "description": "Success.", 8989 "content": { 8990 "application/json": { 8991 "schema": { 8992 "$ref": "#/components/schemas/ProvisionShard" 8993 } 8994 } 8995 } 8996 }, 8997 "default": { 8998 "description": "Error.", 8999 "content": { 9000 "application/json": { 9001 "schema": { 9002 "$ref": "#/components/schemas/Error" 9003 } 9004 } 9005 } 9006 } 9007 } 9008 } 9009 }, 9010 "/api/clusters_mgmt/v1/clusters/{cluster_id}/resources": { 9011 "get": { 9012 "description": "Retrieves a list of resources for a cluster in error state", 9013 "parameters": [ 9014 { 9015 "name": "cluster_id", 9016 "in": "path", 9017 "schema": { 9018 "type": "string" 9019 }, 9020 "required": true 9021 } 9022 ], 9023 "responses": { 9024 "200": { 9025 "description": "Success.", 9026 "content": { 9027 "application/json": { 9028 "schema": { 9029 "$ref": "#/components/schemas/ClusterResources" 9030 } 9031 } 9032 } 9033 }, 9034 "default": { 9035 "description": "Error.", 9036 "content": { 9037 "application/json": { 9038 "schema": { 9039 "$ref": "#/components/schemas/Error" 9040 } 9041 } 9042 } 9043 } 9044 } 9045 } 9046 }, 9047 "/api/clusters_mgmt/v1/clusters/{cluster_id}/resources/live": { 9048 "get": { 9049 "description": "Retrieves currently available cluster resources", 9050 "parameters": [ 9051 { 9052 "name": "cluster_id", 9053 "in": "path", 9054 "schema": { 9055 "type": "string" 9056 }, 9057 "required": true 9058 } 9059 ], 9060 "responses": { 9061 "200": { 9062 "description": "Success.", 9063 "content": { 9064 "application/json": { 9065 "schema": { 9066 "$ref": "#/components/schemas/ClusterResources" 9067 } 9068 } 9069 } 9070 }, 9071 "default": { 9072 "description": "Error.", 9073 "content": { 9074 "application/json": { 9075 "schema": { 9076 "$ref": "#/components/schemas/Error" 9077 } 9078 } 9079 } 9080 } 9081 } 9082 } 9083 }, 9084 "/api/clusters_mgmt/v1/clusters/{cluster_id}/status": { 9085 "get": { 9086 "parameters": [ 9087 { 9088 "name": "cluster_id", 9089 "in": "path", 9090 "schema": { 9091 "type": "string" 9092 }, 9093 "required": true 9094 } 9095 ], 9096 "responses": { 9097 "200": { 9098 "description": "Success.", 9099 "content": { 9100 "application/json": { 9101 "schema": { 9102 "$ref": "#/components/schemas/ClusterStatus" 9103 } 9104 } 9105 } 9106 }, 9107 "default": { 9108 "description": "Error.", 9109 "content": { 9110 "application/json": { 9111 "schema": { 9112 "$ref": "#/components/schemas/Error" 9113 } 9114 } 9115 } 9116 } 9117 } 9118 } 9119 }, 9120 "/api/clusters_mgmt/v1/clusters/{cluster_id}/sts_operator_roles": { 9121 "post": { 9122 "description": "Adds a new operator role to the cluster.", 9123 "parameters": [ 9124 { 9125 "name": "cluster_id", 9126 "in": "path", 9127 "schema": { 9128 "type": "string" 9129 }, 9130 "required": true 9131 } 9132 ], 9133 "requestBody": { 9134 "content": { 9135 "application/json": { 9136 "schema": { 9137 "$ref": "#/components/schemas/OperatorIAMRole" 9138 } 9139 } 9140 } 9141 }, 9142 "responses": { 9143 "201": { 9144 "description": "Success.", 9145 "content": { 9146 "application/json": { 9147 "schema": { 9148 "$ref": "#/components/schemas/OperatorIAMRole" 9149 } 9150 } 9151 } 9152 }, 9153 "default": { 9154 "description": "Error.", 9155 "content": { 9156 "application/json": { 9157 "schema": { 9158 "$ref": "#/components/schemas/Error" 9159 } 9160 } 9161 } 9162 } 9163 } 9164 }, 9165 "get": { 9166 "description": "Retrieves the list of operator roles.", 9167 "parameters": [ 9168 { 9169 "name": "cluster_id", 9170 "in": "path", 9171 "schema": { 9172 "type": "string" 9173 }, 9174 "required": true 9175 }, 9176 { 9177 "name": "page", 9178 "description": "Index of the requested page, where one corresponds to the first page.", 9179 "in": "query", 9180 "schema": { 9181 "type": "integer", 9182 "format": "int32" 9183 } 9184 }, 9185 { 9186 "name": "size", 9187 "description": "Number of items that will be contained in the returned page.", 9188 "in": "query", 9189 "schema": { 9190 "type": "integer", 9191 "format": "int32" 9192 } 9193 } 9194 ], 9195 "responses": { 9196 "200": { 9197 "description": "Success.", 9198 "content": { 9199 "application/json": { 9200 "schema": { 9201 "type": "object", 9202 "properties": { 9203 "items": { 9204 "description": "Retrieved list of operator roles.", 9205 "type": "array", 9206 "items": { 9207 "$ref": "#/components/schemas/OperatorIAMRole" 9208 } 9209 }, 9210 "page": { 9211 "description": "Index of the requested page, where one corresponds to the first page.", 9212 "type": "integer", 9213 "format": "int32" 9214 }, 9215 "size": { 9216 "description": "Number of items that will be contained in the returned page.", 9217 "type": "integer", 9218 "format": "int32" 9219 }, 9220 "total": { 9221 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 9222 "type": "integer", 9223 "format": "int32" 9224 } 9225 } 9226 } 9227 } 9228 } 9229 }, 9230 "default": { 9231 "description": "Error.", 9232 "content": { 9233 "application/json": { 9234 "schema": { 9235 "$ref": "#/components/schemas/Error" 9236 } 9237 } 9238 } 9239 } 9240 } 9241 } 9242 }, 9243 "/api/clusters_mgmt/v1/clusters/{cluster_id}/sts_operator_roles/{operator_iam_role_id}": { 9244 "delete": { 9245 "description": "Deletes the operator role.", 9246 "parameters": [ 9247 { 9248 "name": "cluster_id", 9249 "in": "path", 9250 "schema": { 9251 "type": "string" 9252 }, 9253 "required": true 9254 }, 9255 { 9256 "name": "operator_iam_role_id", 9257 "in": "path", 9258 "schema": { 9259 "type": "string" 9260 }, 9261 "required": true 9262 } 9263 ], 9264 "responses": { 9265 "204": { 9266 "description": "Success." 9267 }, 9268 "default": { 9269 "description": "Error.", 9270 "content": { 9271 "application/json": { 9272 "schema": { 9273 "$ref": "#/components/schemas/Error" 9274 } 9275 } 9276 } 9277 } 9278 } 9279 } 9280 }, 9281 "/api/clusters_mgmt/v1/clusters/{cluster_id}/sts_support_jump_role": { 9282 "get": { 9283 "parameters": [ 9284 { 9285 "name": "cluster_id", 9286 "in": "path", 9287 "schema": { 9288 "type": "string" 9289 }, 9290 "required": true 9291 } 9292 ], 9293 "responses": { 9294 "200": { 9295 "description": "Success.", 9296 "content": { 9297 "application/json": { 9298 "schema": { 9299 "$ref": "#/components/schemas/StsSupportJumpRole" 9300 } 9301 } 9302 } 9303 }, 9304 "default": { 9305 "description": "Error.", 9306 "content": { 9307 "application/json": { 9308 "schema": { 9309 "$ref": "#/components/schemas/Error" 9310 } 9311 } 9312 } 9313 } 9314 } 9315 } 9316 }, 9317 "/api/clusters_mgmt/v1/clusters/{cluster_id}/tuning_configs": { 9318 "post": { 9319 "description": "Adds a new tuning config to the cluster.", 9320 "parameters": [ 9321 { 9322 "name": "cluster_id", 9323 "in": "path", 9324 "schema": { 9325 "type": "string" 9326 }, 9327 "required": true 9328 } 9329 ], 9330 "requestBody": { 9331 "content": { 9332 "application/json": { 9333 "schema": { 9334 "$ref": "#/components/schemas/TuningConfig" 9335 } 9336 } 9337 } 9338 }, 9339 "responses": { 9340 "201": { 9341 "description": "Success.", 9342 "content": { 9343 "application/json": { 9344 "schema": { 9345 "$ref": "#/components/schemas/TuningConfig" 9346 } 9347 } 9348 } 9349 }, 9350 "default": { 9351 "description": "Error.", 9352 "content": { 9353 "application/json": { 9354 "schema": { 9355 "$ref": "#/components/schemas/Error" 9356 } 9357 } 9358 } 9359 } 9360 } 9361 }, 9362 "get": { 9363 "description": "Retrieves the list of tuning configs.", 9364 "parameters": [ 9365 { 9366 "name": "cluster_id", 9367 "in": "path", 9368 "schema": { 9369 "type": "string" 9370 }, 9371 "required": true 9372 }, 9373 { 9374 "name": "page", 9375 "description": "Index of the requested page, where one corresponds to the first page.", 9376 "in": "query", 9377 "schema": { 9378 "type": "integer", 9379 "format": "int32" 9380 } 9381 }, 9382 { 9383 "name": "size", 9384 "description": "Number of items contained in the returned page.", 9385 "in": "query", 9386 "schema": { 9387 "type": "integer", 9388 "format": "int32" 9389 } 9390 } 9391 ], 9392 "responses": { 9393 "200": { 9394 "description": "Success.", 9395 "content": { 9396 "application/json": { 9397 "schema": { 9398 "type": "object", 9399 "properties": { 9400 "items": { 9401 "description": "Retrieved list of tuning configs.", 9402 "type": "array", 9403 "items": { 9404 "$ref": "#/components/schemas/TuningConfig" 9405 } 9406 }, 9407 "page": { 9408 "description": "Index of the requested page, where one corresponds to the first page.", 9409 "type": "integer", 9410 "format": "int32" 9411 }, 9412 "size": { 9413 "description": "Number of items contained in the returned page.", 9414 "type": "integer", 9415 "format": "int32" 9416 }, 9417 "total": { 9418 "description": "Total number of items of the collection.", 9419 "type": "integer", 9420 "format": "int32" 9421 } 9422 } 9423 } 9424 } 9425 } 9426 }, 9427 "default": { 9428 "description": "Error.", 9429 "content": { 9430 "application/json": { 9431 "schema": { 9432 "$ref": "#/components/schemas/Error" 9433 } 9434 } 9435 } 9436 } 9437 } 9438 } 9439 }, 9440 "/api/clusters_mgmt/v1/clusters/{cluster_id}/tuning_configs/{tuning_config_id}": { 9441 "delete": { 9442 "description": "Deletes the tuning config.", 9443 "parameters": [ 9444 { 9445 "name": "cluster_id", 9446 "in": "path", 9447 "schema": { 9448 "type": "string" 9449 }, 9450 "required": true 9451 }, 9452 { 9453 "name": "tuning_config_id", 9454 "in": "path", 9455 "schema": { 9456 "type": "string" 9457 }, 9458 "required": true 9459 } 9460 ], 9461 "responses": { 9462 "204": { 9463 "description": "Success." 9464 }, 9465 "default": { 9466 "description": "Error.", 9467 "content": { 9468 "application/json": { 9469 "schema": { 9470 "$ref": "#/components/schemas/Error" 9471 } 9472 } 9473 } 9474 } 9475 } 9476 }, 9477 "get": { 9478 "description": "Retrieves the details of the tuning config.", 9479 "parameters": [ 9480 { 9481 "name": "cluster_id", 9482 "in": "path", 9483 "schema": { 9484 "type": "string" 9485 }, 9486 "required": true 9487 }, 9488 { 9489 "name": "tuning_config_id", 9490 "in": "path", 9491 "schema": { 9492 "type": "string" 9493 }, 9494 "required": true 9495 } 9496 ], 9497 "responses": { 9498 "200": { 9499 "description": "Success.", 9500 "content": { 9501 "application/json": { 9502 "schema": { 9503 "$ref": "#/components/schemas/TuningConfig" 9504 } 9505 } 9506 } 9507 }, 9508 "default": { 9509 "description": "Error.", 9510 "content": { 9511 "application/json": { 9512 "schema": { 9513 "$ref": "#/components/schemas/Error" 9514 } 9515 } 9516 } 9517 } 9518 } 9519 }, 9520 "patch": { 9521 "description": "Updates the tuning config.", 9522 "parameters": [ 9523 { 9524 "name": "cluster_id", 9525 "in": "path", 9526 "schema": { 9527 "type": "string" 9528 }, 9529 "required": true 9530 }, 9531 { 9532 "name": "tuning_config_id", 9533 "in": "path", 9534 "schema": { 9535 "type": "string" 9536 }, 9537 "required": true 9538 } 9539 ], 9540 "requestBody": { 9541 "content": { 9542 "application/json": { 9543 "schema": { 9544 "$ref": "#/components/schemas/TuningConfig" 9545 } 9546 } 9547 } 9548 }, 9549 "responses": { 9550 "200": { 9551 "description": "Success.", 9552 "content": { 9553 "application/json": { 9554 "schema": { 9555 "$ref": "#/components/schemas/TuningConfig" 9556 } 9557 } 9558 } 9559 }, 9560 "default": { 9561 "description": "Error.", 9562 "content": { 9563 "application/json": { 9564 "schema": { 9565 "$ref": "#/components/schemas/Error" 9566 } 9567 } 9568 } 9569 } 9570 } 9571 } 9572 }, 9573 "/api/clusters_mgmt/v1/clusters/{cluster_id}/upgrade_policies": { 9574 "post": { 9575 "description": "Adds a new upgrade policy to the cluster.", 9576 "parameters": [ 9577 { 9578 "name": "cluster_id", 9579 "in": "path", 9580 "schema": { 9581 "type": "string" 9582 }, 9583 "required": true 9584 } 9585 ], 9586 "requestBody": { 9587 "content": { 9588 "application/json": { 9589 "schema": { 9590 "$ref": "#/components/schemas/UpgradePolicy" 9591 } 9592 } 9593 } 9594 }, 9595 "responses": { 9596 "201": { 9597 "description": "Success.", 9598 "content": { 9599 "application/json": { 9600 "schema": { 9601 "$ref": "#/components/schemas/UpgradePolicy" 9602 } 9603 } 9604 } 9605 }, 9606 "default": { 9607 "description": "Error.", 9608 "content": { 9609 "application/json": { 9610 "schema": { 9611 "$ref": "#/components/schemas/Error" 9612 } 9613 } 9614 } 9615 } 9616 } 9617 }, 9618 "get": { 9619 "description": "Retrieves the list of upgrade policies.", 9620 "parameters": [ 9621 { 9622 "name": "cluster_id", 9623 "in": "path", 9624 "schema": { 9625 "type": "string" 9626 }, 9627 "required": true 9628 }, 9629 { 9630 "name": "page", 9631 "description": "Index of the requested page, where one corresponds to the first page.", 9632 "in": "query", 9633 "schema": { 9634 "type": "integer", 9635 "format": "int32" 9636 } 9637 }, 9638 { 9639 "name": "size", 9640 "description": "Number of items contained in the returned page.", 9641 "in": "query", 9642 "schema": { 9643 "type": "integer", 9644 "format": "int32" 9645 } 9646 } 9647 ], 9648 "responses": { 9649 "200": { 9650 "description": "Success.", 9651 "content": { 9652 "application/json": { 9653 "schema": { 9654 "type": "object", 9655 "properties": { 9656 "items": { 9657 "description": "Retrieved list of upgrade policy.", 9658 "type": "array", 9659 "items": { 9660 "$ref": "#/components/schemas/UpgradePolicy" 9661 } 9662 }, 9663 "page": { 9664 "description": "Index of the requested page, where one corresponds to the first page.", 9665 "type": "integer", 9666 "format": "int32" 9667 }, 9668 "size": { 9669 "description": "Number of items contained in the returned page.", 9670 "type": "integer", 9671 "format": "int32" 9672 }, 9673 "total": { 9674 "description": "Total number of items of the collection.", 9675 "type": "integer", 9676 "format": "int32" 9677 } 9678 } 9679 } 9680 } 9681 } 9682 }, 9683 "default": { 9684 "description": "Error.", 9685 "content": { 9686 "application/json": { 9687 "schema": { 9688 "$ref": "#/components/schemas/Error" 9689 } 9690 } 9691 } 9692 } 9693 } 9694 } 9695 }, 9696 "/api/clusters_mgmt/v1/clusters/{cluster_id}/upgrade_policies/{upgrade_policy_id}": { 9697 "delete": { 9698 "description": "Deletes the upgrade policy.", 9699 "parameters": [ 9700 { 9701 "name": "cluster_id", 9702 "in": "path", 9703 "schema": { 9704 "type": "string" 9705 }, 9706 "required": true 9707 }, 9708 { 9709 "name": "upgrade_policy_id", 9710 "in": "path", 9711 "schema": { 9712 "type": "string" 9713 }, 9714 "required": true 9715 } 9716 ], 9717 "responses": { 9718 "204": { 9719 "description": "Success." 9720 }, 9721 "default": { 9722 "description": "Error.", 9723 "content": { 9724 "application/json": { 9725 "schema": { 9726 "$ref": "#/components/schemas/Error" 9727 } 9728 } 9729 } 9730 } 9731 } 9732 }, 9733 "get": { 9734 "description": "Retrieves the details of the upgrade policy.", 9735 "parameters": [ 9736 { 9737 "name": "cluster_id", 9738 "in": "path", 9739 "schema": { 9740 "type": "string" 9741 }, 9742 "required": true 9743 }, 9744 { 9745 "name": "upgrade_policy_id", 9746 "in": "path", 9747 "schema": { 9748 "type": "string" 9749 }, 9750 "required": true 9751 } 9752 ], 9753 "responses": { 9754 "200": { 9755 "description": "Success.", 9756 "content": { 9757 "application/json": { 9758 "schema": { 9759 "$ref": "#/components/schemas/UpgradePolicy" 9760 } 9761 } 9762 } 9763 }, 9764 "default": { 9765 "description": "Error.", 9766 "content": { 9767 "application/json": { 9768 "schema": { 9769 "$ref": "#/components/schemas/Error" 9770 } 9771 } 9772 } 9773 } 9774 } 9775 }, 9776 "patch": { 9777 "description": "Update the upgrade policy.", 9778 "parameters": [ 9779 { 9780 "name": "cluster_id", 9781 "in": "path", 9782 "schema": { 9783 "type": "string" 9784 }, 9785 "required": true 9786 }, 9787 { 9788 "name": "upgrade_policy_id", 9789 "in": "path", 9790 "schema": { 9791 "type": "string" 9792 }, 9793 "required": true 9794 } 9795 ], 9796 "requestBody": { 9797 "content": { 9798 "application/json": { 9799 "schema": { 9800 "$ref": "#/components/schemas/UpgradePolicy" 9801 } 9802 } 9803 } 9804 }, 9805 "responses": { 9806 "200": { 9807 "description": "Success.", 9808 "content": { 9809 "application/json": { 9810 "schema": { 9811 "$ref": "#/components/schemas/UpgradePolicy" 9812 } 9813 } 9814 } 9815 }, 9816 "default": { 9817 "description": "Error.", 9818 "content": { 9819 "application/json": { 9820 "schema": { 9821 "$ref": "#/components/schemas/Error" 9822 } 9823 } 9824 } 9825 } 9826 } 9827 } 9828 }, 9829 "/api/clusters_mgmt/v1/clusters/{cluster_id}/upgrade_policies/{upgrade_policy_id}/state": { 9830 "get": { 9831 "description": "Retrieves the details of the upgrade policy state.", 9832 "parameters": [ 9833 { 9834 "name": "cluster_id", 9835 "in": "path", 9836 "schema": { 9837 "type": "string" 9838 }, 9839 "required": true 9840 }, 9841 { 9842 "name": "upgrade_policy_id", 9843 "in": "path", 9844 "schema": { 9845 "type": "string" 9846 }, 9847 "required": true 9848 } 9849 ], 9850 "responses": { 9851 "200": { 9852 "description": "Success.", 9853 "content": { 9854 "application/json": { 9855 "schema": { 9856 "$ref": "#/components/schemas/UpgradePolicyState" 9857 } 9858 } 9859 } 9860 }, 9861 "default": { 9862 "description": "Error.", 9863 "content": { 9864 "application/json": { 9865 "schema": { 9866 "$ref": "#/components/schemas/Error" 9867 } 9868 } 9869 } 9870 } 9871 } 9872 }, 9873 "patch": { 9874 "description": "Update the upgrade policy state.", 9875 "parameters": [ 9876 { 9877 "name": "cluster_id", 9878 "in": "path", 9879 "schema": { 9880 "type": "string" 9881 }, 9882 "required": true 9883 }, 9884 { 9885 "name": "upgrade_policy_id", 9886 "in": "path", 9887 "schema": { 9888 "type": "string" 9889 }, 9890 "required": true 9891 } 9892 ], 9893 "requestBody": { 9894 "content": { 9895 "application/json": { 9896 "schema": { 9897 "$ref": "#/components/schemas/UpgradePolicyState" 9898 } 9899 } 9900 } 9901 }, 9902 "responses": { 9903 "200": { 9904 "description": "Success.", 9905 "content": { 9906 "application/json": { 9907 "schema": { 9908 "$ref": "#/components/schemas/UpgradePolicyState" 9909 } 9910 } 9911 } 9912 }, 9913 "default": { 9914 "description": "Error.", 9915 "content": { 9916 "application/json": { 9917 "schema": { 9918 "$ref": "#/components/schemas/Error" 9919 } 9920 } 9921 } 9922 } 9923 } 9924 } 9925 }, 9926 "/api/clusters_mgmt/v1/clusters/{cluster_id}/vpc": { 9927 "get": { 9928 "parameters": [ 9929 { 9930 "name": "cluster_id", 9931 "in": "path", 9932 "schema": { 9933 "type": "string" 9934 }, 9935 "required": true 9936 } 9937 ], 9938 "responses": { 9939 "200": { 9940 "description": "Success.", 9941 "content": { 9942 "application/json": { 9943 "schema": { 9944 "$ref": "#/components/schemas/CloudVPC" 9945 } 9946 } 9947 } 9948 }, 9949 "default": { 9950 "description": "Error.", 9951 "content": { 9952 "application/json": { 9953 "schema": { 9954 "$ref": "#/components/schemas/Error" 9955 } 9956 } 9957 } 9958 } 9959 } 9960 } 9961 }, 9962 "/api/clusters_mgmt/v1/dns_domains": { 9963 "post": { 9964 "description": "Adds a DNS domain.", 9965 "requestBody": { 9966 "content": { 9967 "application/json": { 9968 "schema": { 9969 "$ref": "#/components/schemas/DNSDomain" 9970 } 9971 } 9972 } 9973 }, 9974 "responses": { 9975 "201": { 9976 "description": "Success.", 9977 "content": { 9978 "application/json": { 9979 "schema": { 9980 "$ref": "#/components/schemas/DNSDomain" 9981 } 9982 } 9983 } 9984 }, 9985 "default": { 9986 "description": "Error.", 9987 "content": { 9988 "application/json": { 9989 "schema": { 9990 "$ref": "#/components/schemas/Error" 9991 } 9992 } 9993 } 9994 } 9995 } 9996 }, 9997 "get": { 9998 "parameters": [ 9999 { 10000 "name": "page", 10001 "description": "Index of the requested page, where one corresponds to the first page.", 10002 "in": "query", 10003 "schema": { 10004 "type": "integer", 10005 "format": "int32" 10006 } 10007 }, 10008 { 10009 "name": "search", 10010 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the dns domain instead of\nthe names of the columns of a table. For example, in order to retrieve all the\ndns domains with a ID starting with `02a5` should be:\n\n```sql\nid like '02a5%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\ndns domains that the user has permission to see will be returned.", 10011 "in": "query", 10012 "schema": { 10013 "type": "string" 10014 } 10015 }, 10016 { 10017 "name": "size", 10018 "description": "Maximum number of items that will be contained in the returned page.", 10019 "in": "query", 10020 "schema": { 10021 "type": "integer", 10022 "format": "int32" 10023 } 10024 } 10025 ], 10026 "responses": { 10027 "200": { 10028 "description": "Success.", 10029 "content": { 10030 "application/json": { 10031 "schema": { 10032 "type": "object", 10033 "properties": { 10034 "items": { 10035 "description": "Retrieved a list of DNS domains.", 10036 "type": "array", 10037 "items": { 10038 "$ref": "#/components/schemas/DNSDomain" 10039 } 10040 }, 10041 "page": { 10042 "description": "Index of the requested page, where one corresponds to the first page.", 10043 "type": "integer", 10044 "format": "int32" 10045 }, 10046 "size": { 10047 "description": "Maximum number of items that will be contained in the returned page.", 10048 "type": "integer", 10049 "format": "int32" 10050 }, 10051 "total": { 10052 "description": "Total number of items of the collection.", 10053 "type": "integer", 10054 "format": "int32" 10055 } 10056 } 10057 } 10058 } 10059 } 10060 }, 10061 "default": { 10062 "description": "Error.", 10063 "content": { 10064 "application/json": { 10065 "schema": { 10066 "$ref": "#/components/schemas/Error" 10067 } 10068 } 10069 } 10070 } 10071 } 10072 } 10073 }, 10074 "/api/clusters_mgmt/v1/dns_domains/{dns_domain_id}": { 10075 "delete": { 10076 "description": "Delete the DNS domain.", 10077 "parameters": [ 10078 { 10079 "name": "dns_domain_id", 10080 "in": "path", 10081 "schema": { 10082 "type": "string" 10083 }, 10084 "required": true 10085 } 10086 ], 10087 "responses": { 10088 "204": { 10089 "description": "Success." 10090 }, 10091 "default": { 10092 "description": "Error.", 10093 "content": { 10094 "application/json": { 10095 "schema": { 10096 "$ref": "#/components/schemas/Error" 10097 } 10098 } 10099 } 10100 } 10101 } 10102 }, 10103 "get": { 10104 "description": "Retrieves the details of the DNS domain.", 10105 "parameters": [ 10106 { 10107 "name": "dns_domain_id", 10108 "in": "path", 10109 "schema": { 10110 "type": "string" 10111 }, 10112 "required": true 10113 } 10114 ], 10115 "responses": { 10116 "200": { 10117 "description": "Success.", 10118 "content": { 10119 "application/json": { 10120 "schema": { 10121 "$ref": "#/components/schemas/DNSDomain" 10122 } 10123 } 10124 } 10125 }, 10126 "default": { 10127 "description": "Error.", 10128 "content": { 10129 "application/json": { 10130 "schema": { 10131 "$ref": "#/components/schemas/Error" 10132 } 10133 } 10134 } 10135 } 10136 } 10137 } 10138 }, 10139 "/api/clusters_mgmt/v1/environment": { 10140 "get": { 10141 "description": "Retrieves the details of the environment.", 10142 "responses": { 10143 "200": { 10144 "description": "Success.", 10145 "content": { 10146 "application/json": { 10147 "schema": { 10148 "$ref": "#/components/schemas/Environment" 10149 } 10150 } 10151 } 10152 }, 10153 "default": { 10154 "description": "Error.", 10155 "content": { 10156 "application/json": { 10157 "schema": { 10158 "$ref": "#/components/schemas/Error" 10159 } 10160 } 10161 } 10162 } 10163 } 10164 }, 10165 "patch": { 10166 "description": "Updates the environment.\n\nAttributes that can be updated are:\n\n- `last_upgrade_available_check`\n- `last_limited_support_check`", 10167 "requestBody": { 10168 "content": { 10169 "application/json": { 10170 "schema": { 10171 "$ref": "#/components/schemas/Environment" 10172 } 10173 } 10174 } 10175 }, 10176 "responses": { 10177 "200": { 10178 "description": "Success.", 10179 "content": { 10180 "application/json": { 10181 "schema": { 10182 "$ref": "#/components/schemas/Environment" 10183 } 10184 } 10185 } 10186 }, 10187 "default": { 10188 "description": "Error.", 10189 "content": { 10190 "application/json": { 10191 "schema": { 10192 "$ref": "#/components/schemas/Error" 10193 } 10194 } 10195 } 10196 } 10197 } 10198 } 10199 }, 10200 "/api/clusters_mgmt/v1/events": { 10201 "post": { 10202 "description": "Adds a new event to be tracked. When sending a new event request,\nit gets tracked in Prometheus, Pendo, CloudWatch, or whichever\nanalytics client is configured as part of clusters service. This\nallows for reporting on events that happen outside of a regular API\nrequest, but are found to be useful for understanding customer\nneeds and possible blockers.", 10203 "requestBody": { 10204 "content": { 10205 "application/json": { 10206 "schema": { 10207 "$ref": "#/components/schemas/Event" 10208 } 10209 } 10210 } 10211 }, 10212 "responses": { 10213 "201": { 10214 "description": "Success.", 10215 "content": { 10216 "application/json": { 10217 "schema": { 10218 "$ref": "#/components/schemas/Event" 10219 } 10220 } 10221 } 10222 }, 10223 "default": { 10224 "description": "Error.", 10225 "content": { 10226 "application/json": { 10227 "schema": { 10228 "$ref": "#/components/schemas/Error" 10229 } 10230 } 10231 } 10232 } 10233 } 10234 } 10235 }, 10236 "/api/clusters_mgmt/v1/flavours": { 10237 "get": { 10238 "parameters": [ 10239 { 10240 "name": "order", 10241 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the flavour instead of\nthe names of the columns of a table. For example, in order to sort the flavours\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 10242 "in": "query", 10243 "schema": { 10244 "type": "string" 10245 } 10246 }, 10247 { 10248 "name": "page", 10249 "description": "Index of the requested page, where one corresponds to the first page.", 10250 "in": "query", 10251 "schema": { 10252 "type": "integer", 10253 "format": "int32" 10254 } 10255 }, 10256 { 10257 "name": "search", 10258 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the flavour instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nflavours with a name starting with `my`the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the flavours\nthat the user has permission to see will be returned.", 10259 "in": "query", 10260 "schema": { 10261 "type": "string" 10262 } 10263 }, 10264 { 10265 "name": "size", 10266 "description": "Maximum number of items that will be contained in the returned page.", 10267 "in": "query", 10268 "schema": { 10269 "type": "integer", 10270 "format": "int32" 10271 } 10272 } 10273 ], 10274 "responses": { 10275 "200": { 10276 "description": "Success.", 10277 "content": { 10278 "application/json": { 10279 "schema": { 10280 "type": "object", 10281 "properties": { 10282 "items": { 10283 "description": "Retrieved list of flavours.", 10284 "type": "array", 10285 "items": { 10286 "$ref": "#/components/schemas/Flavour" 10287 } 10288 }, 10289 "page": { 10290 "description": "Index of the requested page, where one corresponds to the first page.", 10291 "type": "integer", 10292 "format": "int32" 10293 }, 10294 "size": { 10295 "description": "Maximum number of items that will be contained in the returned page.", 10296 "type": "integer", 10297 "format": "int32" 10298 }, 10299 "total": { 10300 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 10301 "type": "integer", 10302 "format": "int32" 10303 } 10304 } 10305 } 10306 } 10307 } 10308 }, 10309 "default": { 10310 "description": "Error.", 10311 "content": { 10312 "application/json": { 10313 "schema": { 10314 "$ref": "#/components/schemas/Error" 10315 } 10316 } 10317 } 10318 } 10319 } 10320 } 10321 }, 10322 "/api/clusters_mgmt/v1/flavours/{flavour_id}": { 10323 "get": { 10324 "description": "Retrieves the details of the cluster flavour.", 10325 "parameters": [ 10326 { 10327 "name": "flavour_id", 10328 "in": "path", 10329 "schema": { 10330 "type": "string" 10331 }, 10332 "required": true 10333 } 10334 ], 10335 "responses": { 10336 "200": { 10337 "description": "Success.", 10338 "content": { 10339 "application/json": { 10340 "schema": { 10341 "$ref": "#/components/schemas/Flavour" 10342 } 10343 } 10344 } 10345 }, 10346 "default": { 10347 "description": "Error.", 10348 "content": { 10349 "application/json": { 10350 "schema": { 10351 "$ref": "#/components/schemas/Error" 10352 } 10353 } 10354 } 10355 } 10356 } 10357 }, 10358 "patch": { 10359 "description": "Updates the flavour.\n\nAttributes that can be updated are:\n\n- `aws.infra_volume`\n- `aws.infra_instance_type`\n- `gcp.infra_instance_type`", 10360 "parameters": [ 10361 { 10362 "name": "flavour_id", 10363 "in": "path", 10364 "schema": { 10365 "type": "string" 10366 }, 10367 "required": true 10368 } 10369 ], 10370 "requestBody": { 10371 "content": { 10372 "application/json": { 10373 "schema": { 10374 "$ref": "#/components/schemas/Flavour" 10375 } 10376 } 10377 } 10378 }, 10379 "responses": { 10380 "200": { 10381 "description": "Success.", 10382 "content": { 10383 "application/json": { 10384 "schema": { 10385 "$ref": "#/components/schemas/Flavour" 10386 } 10387 } 10388 } 10389 }, 10390 "default": { 10391 "description": "Error.", 10392 "content": { 10393 "application/json": { 10394 "schema": { 10395 "$ref": "#/components/schemas/Error" 10396 } 10397 } 10398 } 10399 } 10400 } 10401 } 10402 }, 10403 "/api/clusters_mgmt/v1/gcp/wif_configs": { 10404 "post": { 10405 "description": "Provision a new wif_config resource and add it to the collection of wif_configs.", 10406 "requestBody": { 10407 "content": { 10408 "application/json": { 10409 "schema": { 10410 "$ref": "#/components/schemas/WifConfig" 10411 } 10412 } 10413 } 10414 }, 10415 "responses": { 10416 "201": { 10417 "description": "Success.", 10418 "content": { 10419 "application/json": { 10420 "schema": { 10421 "$ref": "#/components/schemas/WifConfig" 10422 } 10423 } 10424 } 10425 }, 10426 "default": { 10427 "description": "Error.", 10428 "content": { 10429 "application/json": { 10430 "schema": { 10431 "$ref": "#/components/schemas/Error" 10432 } 10433 } 10434 } 10435 } 10436 } 10437 }, 10438 "get": { 10439 "description": "Retrieves the list of wif_configs", 10440 "parameters": [ 10441 { 10442 "name": "order", 10443 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the cluster instead of\nthe names of the columns of a table. For example, in order to sort the clusters\ndescending by region identifier the value should be:\n\n```sql\nregion.id desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 10444 "in": "query", 10445 "schema": { 10446 "type": "string" 10447 } 10448 }, 10449 { 10450 "name": "page", 10451 "description": "Index of the requested page, where one corresponds to the first page.", 10452 "in": "query", 10453 "schema": { 10454 "type": "integer", 10455 "format": "int32" 10456 } 10457 }, 10458 { 10459 "name": "search", 10460 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the cluster instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nclusters with a name starting with `my` in the `us-east-1` region the value\nshould be:\n\n```sql\nname like 'my%' and region.id = 'us-east-1'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nwif_configs that the user has permission to see will be returned.", 10461 "in": "query", 10462 "schema": { 10463 "type": "string" 10464 } 10465 }, 10466 { 10467 "name": "size", 10468 "description": "Maximum number of items that will be contained in the returned page.", 10469 "in": "query", 10470 "schema": { 10471 "type": "integer", 10472 "format": "int32" 10473 } 10474 } 10475 ], 10476 "responses": { 10477 "200": { 10478 "description": "Success.", 10479 "content": { 10480 "application/json": { 10481 "schema": { 10482 "type": "object", 10483 "properties": { 10484 "items": { 10485 "description": "Retrieved list of wif_configs.", 10486 "type": "array", 10487 "items": { 10488 "$ref": "#/components/schemas/WifConfig" 10489 } 10490 }, 10491 "page": { 10492 "description": "Index of the requested page, where one corresponds to the first page.", 10493 "type": "integer", 10494 "format": "int32" 10495 }, 10496 "size": { 10497 "description": "Maximum number of items that will be contained in the returned page.", 10498 "type": "integer", 10499 "format": "int32" 10500 }, 10501 "total": { 10502 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 10503 "type": "integer", 10504 "format": "int32" 10505 } 10506 } 10507 } 10508 } 10509 } 10510 }, 10511 "default": { 10512 "description": "Error.", 10513 "content": { 10514 "application/json": { 10515 "schema": { 10516 "$ref": "#/components/schemas/Error" 10517 } 10518 } 10519 } 10520 } 10521 } 10522 } 10523 }, 10524 "/api/clusters_mgmt/v1/gcp/wif_configs/{wif_config_id}": { 10525 "delete": { 10526 "description": "Deletes the wif_config.", 10527 "parameters": [ 10528 { 10529 "name": "wif_config_id", 10530 "in": "path", 10531 "schema": { 10532 "type": "string" 10533 }, 10534 "required": true 10535 }, 10536 { 10537 "name": "dry_run", 10538 "description": "Dry run flag is used to check if the operation can be completed, but won't delete.", 10539 "in": "query", 10540 "schema": { 10541 "type": "boolean" 10542 } 10543 } 10544 ], 10545 "responses": { 10546 "204": { 10547 "description": "Success." 10548 }, 10549 "default": { 10550 "description": "Error.", 10551 "content": { 10552 "application/json": { 10553 "schema": { 10554 "$ref": "#/components/schemas/Error" 10555 } 10556 } 10557 } 10558 } 10559 } 10560 }, 10561 "get": { 10562 "description": "Retrieves the details of the WifConfig.", 10563 "parameters": [ 10564 { 10565 "name": "wif_config_id", 10566 "in": "path", 10567 "schema": { 10568 "type": "string" 10569 }, 10570 "required": true 10571 } 10572 ], 10573 "responses": { 10574 "200": { 10575 "description": "Success.", 10576 "content": { 10577 "application/json": { 10578 "schema": { 10579 "$ref": "#/components/schemas/WifConfig" 10580 } 10581 } 10582 } 10583 }, 10584 "default": { 10585 "description": "Error.", 10586 "content": { 10587 "application/json": { 10588 "schema": { 10589 "$ref": "#/components/schemas/Error" 10590 } 10591 } 10592 } 10593 } 10594 } 10595 }, 10596 "patch": { 10597 "description": "Updates the WifConfig.", 10598 "parameters": [ 10599 { 10600 "name": "wif_config_id", 10601 "in": "path", 10602 "schema": { 10603 "type": "string" 10604 }, 10605 "required": true 10606 } 10607 ], 10608 "requestBody": { 10609 "content": { 10610 "application/json": { 10611 "schema": { 10612 "$ref": "#/components/schemas/WifConfig" 10613 } 10614 } 10615 } 10616 }, 10617 "responses": { 10618 "200": { 10619 "description": "Success.", 10620 "content": { 10621 "application/json": { 10622 "schema": { 10623 "$ref": "#/components/schemas/WifConfig" 10624 } 10625 } 10626 } 10627 }, 10628 "default": { 10629 "description": "Error.", 10630 "content": { 10631 "application/json": { 10632 "schema": { 10633 "$ref": "#/components/schemas/Error" 10634 } 10635 } 10636 } 10637 } 10638 } 10639 } 10640 }, 10641 "/api/clusters_mgmt/v1/gcp/wif_configs/{wif_config_id}/status": { 10642 "get": { 10643 "parameters": [ 10644 { 10645 "name": "wif_config_id", 10646 "in": "path", 10647 "schema": { 10648 "type": "string" 10649 }, 10650 "required": true 10651 } 10652 ], 10653 "responses": { 10654 "200": { 10655 "description": "Success.", 10656 "content": { 10657 "application/json": { 10658 "schema": { 10659 "$ref": "#/components/schemas/WifConfigStatus" 10660 } 10661 } 10662 } 10663 }, 10664 "default": { 10665 "description": "Error.", 10666 "content": { 10667 "application/json": { 10668 "schema": { 10669 "$ref": "#/components/schemas/Error" 10670 } 10671 } 10672 } 10673 } 10674 } 10675 } 10676 }, 10677 "/api/clusters_mgmt/v1/gcp_inquiries/encryption_keys": { 10678 "post": { 10679 "description": "Retrieves the list of encryption keys.\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available regions\nof the provider.", 10680 "parameters": [ 10681 { 10682 "name": "page", 10683 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10684 "in": "query", 10685 "schema": { 10686 "type": "integer", 10687 "format": "int32" 10688 } 10689 }, 10690 { 10691 "name": "size", 10692 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 10693 "in": "query", 10694 "schema": { 10695 "type": "integer", 10696 "format": "int32" 10697 } 10698 } 10699 ], 10700 "requestBody": { 10701 "content": { 10702 "application/json": { 10703 "schema": { 10704 "$ref": "#/components/schemas/CloudProviderData" 10705 } 10706 } 10707 } 10708 }, 10709 "responses": { 10710 "200": { 10711 "description": "Success.", 10712 "content": { 10713 "application/json": { 10714 "schema": { 10715 "type": "object", 10716 "properties": { 10717 "items": { 10718 "description": "Retrieved list of encryption keys.", 10719 "type": "array", 10720 "items": { 10721 "$ref": "#/components/schemas/EncryptionKey" 10722 } 10723 }, 10724 "page": { 10725 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10726 "type": "integer", 10727 "format": "int32" 10728 }, 10729 "size": { 10730 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 10731 "type": "integer", 10732 "format": "int32" 10733 }, 10734 "total": { 10735 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available regions of the provider.", 10736 "type": "integer", 10737 "format": "int32" 10738 } 10739 } 10740 } 10741 } 10742 } 10743 }, 10744 "default": { 10745 "description": "Error.", 10746 "content": { 10747 "application/json": { 10748 "schema": { 10749 "$ref": "#/components/schemas/Error" 10750 } 10751 } 10752 } 10753 } 10754 } 10755 } 10756 }, 10757 "/api/clusters_mgmt/v1/gcp_inquiries/key_rings": { 10758 "post": { 10759 "description": "Retrieves the list of available key rings of the cloud provider.\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available regions\nof the provider.", 10760 "parameters": [ 10761 { 10762 "name": "page", 10763 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10764 "in": "query", 10765 "schema": { 10766 "type": "integer", 10767 "format": "int32" 10768 } 10769 }, 10770 { 10771 "name": "size", 10772 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nkey rings of the provider.", 10773 "in": "query", 10774 "schema": { 10775 "type": "integer", 10776 "format": "int32" 10777 } 10778 } 10779 ], 10780 "requestBody": { 10781 "content": { 10782 "application/json": { 10783 "schema": { 10784 "$ref": "#/components/schemas/CloudProviderData" 10785 } 10786 } 10787 } 10788 }, 10789 "responses": { 10790 "200": { 10791 "description": "Success.", 10792 "content": { 10793 "application/json": { 10794 "schema": { 10795 "type": "object", 10796 "properties": { 10797 "items": { 10798 "description": "Retrieved list of key rings.", 10799 "type": "array", 10800 "items": { 10801 "$ref": "#/components/schemas/KeyRing" 10802 } 10803 }, 10804 "page": { 10805 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10806 "type": "integer", 10807 "format": "int32" 10808 }, 10809 "size": { 10810 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nkey rings of the provider.", 10811 "type": "integer", 10812 "format": "int32" 10813 }, 10814 "total": { 10815 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available key rings of the provider.", 10816 "type": "integer", 10817 "format": "int32" 10818 } 10819 } 10820 } 10821 } 10822 } 10823 }, 10824 "default": { 10825 "description": "Error.", 10826 "content": { 10827 "application/json": { 10828 "schema": { 10829 "$ref": "#/components/schemas/Error" 10830 } 10831 } 10832 } 10833 } 10834 } 10835 } 10836 }, 10837 "/api/clusters_mgmt/v1/gcp_inquiries/machine_types": { 10838 "post": { 10839 "description": "Retrieves the list of machine types in the provided region.", 10840 "parameters": [ 10841 { 10842 "name": "page", 10843 "description": "Index of the requested page, where one corresponds to the first page.", 10844 "in": "query", 10845 "schema": { 10846 "type": "integer", 10847 "format": "int32" 10848 } 10849 }, 10850 { 10851 "name": "size", 10852 "description": "Maximum number of items that will be contained in the returned page.", 10853 "in": "query", 10854 "schema": { 10855 "type": "integer", 10856 "format": "int32" 10857 } 10858 } 10859 ], 10860 "requestBody": { 10861 "content": { 10862 "application/json": { 10863 "schema": { 10864 "$ref": "#/components/schemas/CloudProviderData" 10865 } 10866 } 10867 } 10868 }, 10869 "responses": { 10870 "200": { 10871 "description": "Success.", 10872 "content": { 10873 "application/json": { 10874 "schema": { 10875 "type": "object", 10876 "properties": { 10877 "items": { 10878 "description": "Retrieved list of machine types.", 10879 "type": "array", 10880 "items": { 10881 "$ref": "#/components/schemas/MachineType" 10882 } 10883 }, 10884 "page": { 10885 "description": "Index of the requested page, where one corresponds to the first page.", 10886 "type": "integer", 10887 "format": "int32" 10888 }, 10889 "size": { 10890 "description": "Maximum number of items that will be contained in the returned page.", 10891 "type": "integer", 10892 "format": "int32" 10893 }, 10894 "total": { 10895 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 10896 "type": "integer", 10897 "format": "int32" 10898 } 10899 } 10900 } 10901 } 10902 } 10903 }, 10904 "default": { 10905 "description": "Error.", 10906 "content": { 10907 "application/json": { 10908 "schema": { 10909 "$ref": "#/components/schemas/Error" 10910 } 10911 } 10912 } 10913 } 10914 } 10915 } 10916 }, 10917 "/api/clusters_mgmt/v1/gcp_inquiries/regions": { 10918 "post": { 10919 "description": "Retrieves the list of available regions of the cloud provider.\nIMPORTANT: This list doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available regions\nof the provider.", 10920 "parameters": [ 10921 { 10922 "name": "page", 10923 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10924 "in": "query", 10925 "schema": { 10926 "type": "integer", 10927 "format": "int32" 10928 } 10929 }, 10930 { 10931 "name": "size", 10932 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 10933 "in": "query", 10934 "schema": { 10935 "type": "integer", 10936 "format": "int32" 10937 } 10938 } 10939 ], 10940 "requestBody": { 10941 "content": { 10942 "application/json": { 10943 "schema": { 10944 "$ref": "#/components/schemas/CloudProviderData" 10945 } 10946 } 10947 } 10948 }, 10949 "responses": { 10950 "200": { 10951 "description": "Success.", 10952 "content": { 10953 "application/json": { 10954 "schema": { 10955 "type": "object", 10956 "properties": { 10957 "items": { 10958 "description": "Retrieved list of regions.", 10959 "type": "array", 10960 "items": { 10961 "$ref": "#/components/schemas/CloudRegion" 10962 } 10963 }, 10964 "page": { 10965 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 10966 "type": "integer", 10967 "format": "int32" 10968 }, 10969 "size": { 10970 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nregions of the provider.", 10971 "type": "integer", 10972 "format": "int32" 10973 }, 10974 "total": { 10975 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available regions of the provider.", 10976 "type": "integer", 10977 "format": "int32" 10978 } 10979 } 10980 } 10981 } 10982 } 10983 }, 10984 "default": { 10985 "description": "Error.", 10986 "content": { 10987 "application/json": { 10988 "schema": { 10989 "$ref": "#/components/schemas/Error" 10990 } 10991 } 10992 } 10993 } 10994 } 10995 } 10996 }, 10997 "/api/clusters_mgmt/v1/gcp_inquiries/vpcs": { 10998 "post": { 10999 "description": "Retrieves the list of available vpcs of the cloud provider for specific region.\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of available vpcs\nof the provider.", 11000 "parameters": [ 11001 { 11002 "name": "page", 11003 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 11004 "in": "query", 11005 "schema": { 11006 "type": "integer", 11007 "format": "int32" 11008 } 11009 }, 11010 { 11011 "name": "size", 11012 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nvpcs of the provider.", 11013 "in": "query", 11014 "schema": { 11015 "type": "integer", 11016 "format": "int32" 11017 } 11018 } 11019 ], 11020 "requestBody": { 11021 "content": { 11022 "application/json": { 11023 "schema": { 11024 "$ref": "#/components/schemas/CloudProviderData" 11025 } 11026 } 11027 } 11028 }, 11029 "responses": { 11030 "200": { 11031 "description": "Success.", 11032 "content": { 11033 "application/json": { 11034 "schema": { 11035 "type": "object", 11036 "properties": { 11037 "items": { 11038 "description": "Retrieved list of cloud VPC.", 11039 "type": "array", 11040 "items": { 11041 "$ref": "#/components/schemas/CloudVPC" 11042 } 11043 }, 11044 "page": { 11045 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 11046 "type": "integer", 11047 "format": "int32" 11048 }, 11049 "size": { 11050 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nvpcs of the provider.", 11051 "type": "integer", 11052 "format": "int32" 11053 }, 11054 "total": { 11055 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of available vpcs of the provider.", 11056 "type": "integer", 11057 "format": "int32" 11058 } 11059 } 11060 } 11061 } 11062 } 11063 }, 11064 "default": { 11065 "description": "Error.", 11066 "content": { 11067 "application/json": { 11068 "schema": { 11069 "$ref": "#/components/schemas/Error" 11070 } 11071 } 11072 } 11073 } 11074 } 11075 } 11076 }, 11077 "/api/clusters_mgmt/v1/limited_support_reason_templates": { 11078 "get": { 11079 "description": "Retrieves the list of templates.", 11080 "parameters": [ 11081 { 11082 "name": "page", 11083 "description": "Index of the requested page, where one corresponds to the first page.", 11084 "in": "query", 11085 "schema": { 11086 "type": "integer", 11087 "format": "int32" 11088 } 11089 }, 11090 { 11091 "name": "size", 11092 "description": "Number of items contained in the returned page.", 11093 "in": "query", 11094 "schema": { 11095 "type": "integer", 11096 "format": "int32" 11097 } 11098 } 11099 ], 11100 "responses": { 11101 "200": { 11102 "description": "Success.", 11103 "content": { 11104 "application/json": { 11105 "schema": { 11106 "type": "object", 11107 "properties": { 11108 "items": { 11109 "description": "Retrieved list of template.", 11110 "type": "array", 11111 "items": { 11112 "$ref": "#/components/schemas/LimitedSupportReasonTemplate" 11113 } 11114 }, 11115 "page": { 11116 "description": "Index of the requested page, where one corresponds to the first page.", 11117 "type": "integer", 11118 "format": "int32" 11119 }, 11120 "size": { 11121 "description": "Number of items contained in the returned page.", 11122 "type": "integer", 11123 "format": "int32" 11124 }, 11125 "total": { 11126 "description": "Total number of items of the collection.", 11127 "type": "integer", 11128 "format": "int32" 11129 } 11130 } 11131 } 11132 } 11133 } 11134 }, 11135 "default": { 11136 "description": "Error.", 11137 "content": { 11138 "application/json": { 11139 "schema": { 11140 "$ref": "#/components/schemas/Error" 11141 } 11142 } 11143 } 11144 } 11145 } 11146 } 11147 }, 11148 "/api/clusters_mgmt/v1/limited_support_reason_templates/{limited_support_reason_template_id}": { 11149 "get": { 11150 "description": "Retrieves the details of the template.", 11151 "parameters": [ 11152 { 11153 "name": "limited_support_reason_template_id", 11154 "in": "path", 11155 "schema": { 11156 "type": "string" 11157 }, 11158 "required": true 11159 } 11160 ], 11161 "responses": { 11162 "200": { 11163 "description": "Success.", 11164 "content": { 11165 "application/json": { 11166 "schema": { 11167 "$ref": "#/components/schemas/LimitedSupportReasonTemplate" 11168 } 11169 } 11170 } 11171 }, 11172 "default": { 11173 "description": "Error.", 11174 "content": { 11175 "application/json": { 11176 "schema": { 11177 "$ref": "#/components/schemas/Error" 11178 } 11179 } 11180 } 11181 } 11182 } 11183 } 11184 }, 11185 "/api/clusters_mgmt/v1/load_balancer_quota_values": { 11186 "get": { 11187 "description": "Retrieves the list of Load Balancer Quota Values.", 11188 "parameters": [ 11189 { 11190 "name": "page", 11191 "description": "Index of the requested page, where one corresponds to the first page.", 11192 "in": "query", 11193 "schema": { 11194 "type": "integer", 11195 "format": "int32" 11196 } 11197 }, 11198 { 11199 "name": "size", 11200 "description": "Number of items contained in the returned page.", 11201 "in": "query", 11202 "schema": { 11203 "type": "integer", 11204 "format": "int32" 11205 } 11206 } 11207 ], 11208 "responses": { 11209 "200": { 11210 "description": "Success.", 11211 "content": { 11212 "application/json": { 11213 "schema": { 11214 "type": "object", 11215 "properties": { 11216 "items": { 11217 "description": "Retrieved list of values.", 11218 "type": "array", 11219 "items": { 11220 "type": "integer", 11221 "format": "int32" 11222 } 11223 }, 11224 "page": { 11225 "description": "Index of the requested page, where one corresponds to the first page.", 11226 "type": "integer", 11227 "format": "int32" 11228 }, 11229 "size": { 11230 "description": "Number of items contained in the returned page.", 11231 "type": "integer", 11232 "format": "int32" 11233 }, 11234 "total": { 11235 "description": "Total number of items of the collection.", 11236 "type": "integer", 11237 "format": "int32" 11238 } 11239 } 11240 } 11241 } 11242 } 11243 }, 11244 "default": { 11245 "description": "Error.", 11246 "content": { 11247 "application/json": { 11248 "schema": { 11249 "$ref": "#/components/schemas/Error" 11250 } 11251 } 11252 } 11253 } 11254 } 11255 } 11256 }, 11257 "/api/clusters_mgmt/v1/machine_types": { 11258 "get": { 11259 "description": "Retrieves the list of machine types.", 11260 "parameters": [ 11261 { 11262 "name": "order", 11263 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the machine type\ninstead of the names of the columns of a table. For example, in order to sort the\nmachine types descending by name identifier the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 11264 "in": "query", 11265 "schema": { 11266 "type": "string" 11267 } 11268 }, 11269 { 11270 "name": "page", 11271 "description": "Index of the requested page, where one corresponds to the first page.", 11272 "in": "query", 11273 "schema": { 11274 "type": "integer", 11275 "format": "int32" 11276 } 11277 }, 11278 { 11279 "name": "search", 11280 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the machine type\ninstead of the names of the columns of a table. For example, in order to retrieve\nall the machine types with a name starting with `A` the value should be:\n\n```sql\nname like 'A%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the machine\ntypes that the user has permission to see will be returned.", 11281 "in": "query", 11282 "schema": { 11283 "type": "string" 11284 } 11285 }, 11286 { 11287 "name": "size", 11288 "description": "Maximum number of items that will be contained in the returned page.", 11289 "in": "query", 11290 "schema": { 11291 "type": "integer", 11292 "format": "int32" 11293 } 11294 } 11295 ], 11296 "responses": { 11297 "200": { 11298 "description": "Success.", 11299 "content": { 11300 "application/json": { 11301 "schema": { 11302 "type": "object", 11303 "properties": { 11304 "items": { 11305 "description": "Retrieved list of cloud providers.", 11306 "type": "array", 11307 "items": { 11308 "$ref": "#/components/schemas/MachineType" 11309 } 11310 }, 11311 "page": { 11312 "description": "Index of the requested page, where one corresponds to the first page.", 11313 "type": "integer", 11314 "format": "int32" 11315 }, 11316 "size": { 11317 "description": "Maximum number of items that will be contained in the returned page.", 11318 "type": "integer", 11319 "format": "int32" 11320 }, 11321 "total": { 11322 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 11323 "type": "integer", 11324 "format": "int32" 11325 } 11326 } 11327 } 11328 } 11329 } 11330 }, 11331 "default": { 11332 "description": "Error.", 11333 "content": { 11334 "application/json": { 11335 "schema": { 11336 "$ref": "#/components/schemas/Error" 11337 } 11338 } 11339 } 11340 } 11341 } 11342 } 11343 }, 11344 "/api/clusters_mgmt/v1/machine_types/{machine_type_id}": { 11345 "get": { 11346 "description": "Retrieves the details of the machine type.", 11347 "parameters": [ 11348 { 11349 "name": "machine_type_id", 11350 "in": "path", 11351 "schema": { 11352 "type": "string" 11353 }, 11354 "required": true 11355 } 11356 ], 11357 "responses": { 11358 "200": { 11359 "description": "Success.", 11360 "content": { 11361 "application/json": { 11362 "schema": { 11363 "$ref": "#/components/schemas/MachineType" 11364 } 11365 } 11366 } 11367 }, 11368 "default": { 11369 "description": "Error.", 11370 "content": { 11371 "application/json": { 11372 "schema": { 11373 "$ref": "#/components/schemas/Error" 11374 } 11375 } 11376 } 11377 } 11378 } 11379 } 11380 }, 11381 "/api/clusters_mgmt/v1/network_verifications": { 11382 "post": { 11383 "description": "Creates an entry for a network verification for each subnet supplied setting then to initial state.", 11384 "requestBody": { 11385 "content": { 11386 "application/json": { 11387 "schema": { 11388 "$ref": "#/components/schemas/NetworkVerification" 11389 } 11390 } 11391 } 11392 }, 11393 "responses": { 11394 "201": { 11395 "description": "Success.", 11396 "content": { 11397 "application/json": { 11398 "schema": { 11399 "$ref": "#/components/schemas/NetworkVerification" 11400 } 11401 } 11402 } 11403 }, 11404 "default": { 11405 "description": "Error.", 11406 "content": { 11407 "application/json": { 11408 "schema": { 11409 "$ref": "#/components/schemas/Error" 11410 } 11411 } 11412 } 11413 } 11414 } 11415 } 11416 }, 11417 "/api/clusters_mgmt/v1/network_verifications/{network_verification_id}": { 11418 "get": { 11419 "description": "Retrieves the details of a subnet network verification.", 11420 "parameters": [ 11421 { 11422 "name": "network_verification_id", 11423 "in": "path", 11424 "schema": { 11425 "type": "string" 11426 }, 11427 "required": true 11428 } 11429 ], 11430 "responses": { 11431 "200": { 11432 "description": "Success.", 11433 "content": { 11434 "application/json": { 11435 "schema": { 11436 "$ref": "#/components/schemas/SubnetNetworkVerification" 11437 } 11438 } 11439 } 11440 }, 11441 "default": { 11442 "description": "Error.", 11443 "content": { 11444 "application/json": { 11445 "schema": { 11446 "$ref": "#/components/schemas/Error" 11447 } 11448 } 11449 } 11450 } 11451 } 11452 } 11453 }, 11454 "/api/clusters_mgmt/v1/oidc_configs": { 11455 "post": { 11456 "description": "Creates a hosting under Red Hat's S3 bucket for byo oidc configuration.", 11457 "requestBody": { 11458 "content": { 11459 "application/json": { 11460 "schema": { 11461 "$ref": "#/components/schemas/OidcConfig" 11462 } 11463 } 11464 } 11465 }, 11466 "responses": { 11467 "201": { 11468 "description": "Success.", 11469 "content": { 11470 "application/json": { 11471 "schema": { 11472 "$ref": "#/components/schemas/OidcConfig" 11473 } 11474 } 11475 } 11476 }, 11477 "default": { 11478 "description": "Error.", 11479 "content": { 11480 "application/json": { 11481 "schema": { 11482 "$ref": "#/components/schemas/Error" 11483 } 11484 } 11485 } 11486 } 11487 } 11488 }, 11489 "get": { 11490 "description": "Retrieves the list of oidc configs.", 11491 "parameters": [ 11492 { 11493 "name": "page", 11494 "description": "Index of the requested page, where one corresponds to the first page.", 11495 "in": "query", 11496 "schema": { 11497 "type": "integer", 11498 "format": "int32" 11499 } 11500 }, 11501 { 11502 "name": "size", 11503 "description": "Number of items contained in the returned page.", 11504 "in": "query", 11505 "schema": { 11506 "type": "integer", 11507 "format": "int32" 11508 } 11509 } 11510 ], 11511 "responses": { 11512 "200": { 11513 "description": "Success.", 11514 "content": { 11515 "application/json": { 11516 "schema": { 11517 "type": "object", 11518 "properties": { 11519 "items": { 11520 "description": "Retrieved list of identity providers.", 11521 "type": "array", 11522 "items": { 11523 "$ref": "#/components/schemas/OidcConfig" 11524 } 11525 }, 11526 "page": { 11527 "description": "Index of the requested page, where one corresponds to the first page.", 11528 "type": "integer", 11529 "format": "int32" 11530 }, 11531 "size": { 11532 "description": "Number of items contained in the returned page.", 11533 "type": "integer", 11534 "format": "int32" 11535 }, 11536 "total": { 11537 "description": "Total number of items of the collection.", 11538 "type": "integer", 11539 "format": "int32" 11540 } 11541 } 11542 } 11543 } 11544 } 11545 }, 11546 "default": { 11547 "description": "Error.", 11548 "content": { 11549 "application/json": { 11550 "schema": { 11551 "$ref": "#/components/schemas/Error" 11552 } 11553 } 11554 } 11555 } 11556 } 11557 } 11558 }, 11559 "/api/clusters_mgmt/v1/oidc_configs/{oidc_config_id}": { 11560 "delete": { 11561 "description": "Deletes the OidcConfig.", 11562 "parameters": [ 11563 { 11564 "name": "oidc_config_id", 11565 "in": "path", 11566 "schema": { 11567 "type": "string" 11568 }, 11569 "required": true 11570 } 11571 ], 11572 "responses": { 11573 "204": { 11574 "description": "Success." 11575 }, 11576 "default": { 11577 "description": "Error.", 11578 "content": { 11579 "application/json": { 11580 "schema": { 11581 "$ref": "#/components/schemas/Error" 11582 } 11583 } 11584 } 11585 } 11586 } 11587 }, 11588 "get": { 11589 "description": "Retrieves the details of an OidcConfig.", 11590 "parameters": [ 11591 { 11592 "name": "oidc_config_id", 11593 "in": "path", 11594 "schema": { 11595 "type": "string" 11596 }, 11597 "required": true 11598 } 11599 ], 11600 "responses": { 11601 "200": { 11602 "description": "Success.", 11603 "content": { 11604 "application/json": { 11605 "schema": { 11606 "$ref": "#/components/schemas/OidcConfig" 11607 } 11608 } 11609 } 11610 }, 11611 "default": { 11612 "description": "Error.", 11613 "content": { 11614 "application/json": { 11615 "schema": { 11616 "$ref": "#/components/schemas/Error" 11617 } 11618 } 11619 } 11620 } 11621 } 11622 }, 11623 "patch": { 11624 "description": "Updates attributes of an OidcConfig.", 11625 "parameters": [ 11626 { 11627 "name": "oidc_config_id", 11628 "in": "path", 11629 "schema": { 11630 "type": "string" 11631 }, 11632 "required": true 11633 } 11634 ], 11635 "requestBody": { 11636 "content": { 11637 "application/json": { 11638 "schema": { 11639 "$ref": "#/components/schemas/OidcConfig" 11640 } 11641 } 11642 } 11643 }, 11644 "responses": { 11645 "200": { 11646 "description": "Success.", 11647 "content": { 11648 "application/json": { 11649 "schema": { 11650 "$ref": "#/components/schemas/OidcConfig" 11651 } 11652 } 11653 } 11654 }, 11655 "default": { 11656 "description": "Error.", 11657 "content": { 11658 "application/json": { 11659 "schema": { 11660 "$ref": "#/components/schemas/Error" 11661 } 11662 } 11663 } 11664 } 11665 } 11666 } 11667 }, 11668 "/api/clusters_mgmt/v1/pending_delete_clusters": { 11669 "get": { 11670 "description": "Retrieves the list of pending delete clusters.", 11671 "parameters": [ 11672 { 11673 "name": "order", 11674 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the pending delete cluster instead of\nthe names of the columns of a table. For example, in order to sort the pending delete clusters\ndescending by creation timestamp (i.e. their deletion time) the value should be:\n\n```sql\ncreation_timestamp desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 11675 "in": "query", 11676 "schema": { 11677 "type": "string" 11678 } 11679 }, 11680 { 11681 "name": "page", 11682 "description": "Index of the requested page, where one corresponds to the first page.", 11683 "in": "query", 11684 "schema": { 11685 "type": "integer", 11686 "format": "int32" 11687 } 11688 }, 11689 { 11690 "name": "search", 11691 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the pending delete cluster instead of\nthe names of the columns of a table. For example, in order to retrieve all the\npending delete clusters with creation time later than 2023-03-01T00:00:00Z the following is required:\n\n```sql\ncreation_timestamp > '2023-03-01T00:00:00Z'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\npending delete clusters that the user has permission to see will be returned.", 11692 "in": "query", 11693 "schema": { 11694 "type": "string" 11695 } 11696 }, 11697 { 11698 "name": "size", 11699 "description": "Maximum number of items that will be contained in the returned page.", 11700 "in": "query", 11701 "schema": { 11702 "type": "integer", 11703 "format": "int32" 11704 } 11705 } 11706 ], 11707 "responses": { 11708 "200": { 11709 "description": "Success.", 11710 "content": { 11711 "application/json": { 11712 "schema": { 11713 "type": "object", 11714 "properties": { 11715 "items": { 11716 "description": "Retrieved list of pending delete clusters.", 11717 "type": "array", 11718 "items": { 11719 "$ref": "#/components/schemas/PendingDeleteCluster" 11720 } 11721 }, 11722 "page": { 11723 "description": "Index of the requested page, where one corresponds to the first page.", 11724 "type": "integer", 11725 "format": "int32" 11726 }, 11727 "size": { 11728 "description": "Maximum number of items that will be contained in the returned page.", 11729 "type": "integer", 11730 "format": "int32" 11731 }, 11732 "total": { 11733 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 11734 "type": "integer", 11735 "format": "int32" 11736 } 11737 } 11738 } 11739 } 11740 } 11741 }, 11742 "default": { 11743 "description": "Error.", 11744 "content": { 11745 "application/json": { 11746 "schema": { 11747 "$ref": "#/components/schemas/Error" 11748 } 11749 } 11750 } 11751 } 11752 } 11753 } 11754 }, 11755 "/api/clusters_mgmt/v1/pending_delete_clusters/{pending_delete_cluster_id}": { 11756 "get": { 11757 "description": "Retrieves the details of the pending delete cluster.", 11758 "parameters": [ 11759 { 11760 "name": "pending_delete_cluster_id", 11761 "in": "path", 11762 "schema": { 11763 "type": "string" 11764 }, 11765 "required": true 11766 } 11767 ], 11768 "responses": { 11769 "200": { 11770 "description": "Success.", 11771 "content": { 11772 "application/json": { 11773 "schema": { 11774 "$ref": "#/components/schemas/PendingDeleteCluster" 11775 } 11776 } 11777 } 11778 }, 11779 "default": { 11780 "description": "Error.", 11781 "content": { 11782 "application/json": { 11783 "schema": { 11784 "$ref": "#/components/schemas/Error" 11785 } 11786 } 11787 } 11788 } 11789 } 11790 }, 11791 "patch": { 11792 "description": "Updates the pending delete cluster entry.", 11793 "parameters": [ 11794 { 11795 "name": "pending_delete_cluster_id", 11796 "in": "path", 11797 "schema": { 11798 "type": "string" 11799 }, 11800 "required": true 11801 } 11802 ], 11803 "requestBody": { 11804 "content": { 11805 "application/json": { 11806 "schema": { 11807 "$ref": "#/components/schemas/PendingDeleteCluster" 11808 } 11809 } 11810 } 11811 }, 11812 "responses": { 11813 "200": { 11814 "description": "Success.", 11815 "content": { 11816 "application/json": { 11817 "schema": { 11818 "$ref": "#/components/schemas/PendingDeleteCluster" 11819 } 11820 } 11821 } 11822 }, 11823 "default": { 11824 "description": "Error.", 11825 "content": { 11826 "application/json": { 11827 "schema": { 11828 "$ref": "#/components/schemas/Error" 11829 } 11830 } 11831 } 11832 } 11833 } 11834 } 11835 }, 11836 "/api/clusters_mgmt/v1/products": { 11837 "get": { 11838 "description": "Retrieves the list of products.", 11839 "parameters": [ 11840 { 11841 "name": "order", 11842 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to sort the products\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 11843 "in": "query", 11844 "schema": { 11845 "type": "string" 11846 } 11847 }, 11848 { 11849 "name": "page", 11850 "description": "Index of the requested page, where one corresponds to the first page.", 11851 "in": "query", 11852 "schema": { 11853 "type": "integer", 11854 "format": "int32" 11855 } 11856 }, 11857 { 11858 "name": "search", 11859 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nproducts with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the products\nthat the user has permission to see will be returned.", 11860 "in": "query", 11861 "schema": { 11862 "type": "string" 11863 } 11864 }, 11865 { 11866 "name": "size", 11867 "description": "Maximum number of items that will be contained in the returned page.", 11868 "in": "query", 11869 "schema": { 11870 "type": "integer", 11871 "format": "int32" 11872 } 11873 } 11874 ], 11875 "responses": { 11876 "200": { 11877 "description": "Success.", 11878 "content": { 11879 "application/json": { 11880 "schema": { 11881 "type": "object", 11882 "properties": { 11883 "items": { 11884 "description": "Retrieved list of products.", 11885 "type": "array", 11886 "items": { 11887 "$ref": "#/components/schemas/Product" 11888 } 11889 }, 11890 "page": { 11891 "description": "Index of the requested page, where one corresponds to the first page.", 11892 "type": "integer", 11893 "format": "int32" 11894 }, 11895 "size": { 11896 "description": "Maximum number of items that will be contained in the returned page.", 11897 "type": "integer", 11898 "format": "int32" 11899 }, 11900 "total": { 11901 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 11902 "type": "integer", 11903 "format": "int32" 11904 } 11905 } 11906 } 11907 } 11908 } 11909 }, 11910 "default": { 11911 "description": "Error.", 11912 "content": { 11913 "application/json": { 11914 "schema": { 11915 "$ref": "#/components/schemas/Error" 11916 } 11917 } 11918 } 11919 } 11920 } 11921 } 11922 }, 11923 "/api/clusters_mgmt/v1/products/{product_id}": { 11924 "get": { 11925 "description": "Retrieves the details of the product.", 11926 "parameters": [ 11927 { 11928 "name": "product_id", 11929 "in": "path", 11930 "schema": { 11931 "type": "string" 11932 }, 11933 "required": true 11934 } 11935 ], 11936 "responses": { 11937 "200": { 11938 "description": "Success.", 11939 "content": { 11940 "application/json": { 11941 "schema": { 11942 "$ref": "#/components/schemas/Product" 11943 } 11944 } 11945 } 11946 }, 11947 "default": { 11948 "description": "Error.", 11949 "content": { 11950 "application/json": { 11951 "schema": { 11952 "$ref": "#/components/schemas/Error" 11953 } 11954 } 11955 } 11956 } 11957 } 11958 } 11959 }, 11960 "/api/clusters_mgmt/v1/products/{product_id}/minimal_versions": { 11961 "get": { 11962 "description": "Retrieves the list of product minimal versions.", 11963 "parameters": [ 11964 { 11965 "name": "product_id", 11966 "in": "path", 11967 "schema": { 11968 "type": "string" 11969 }, 11970 "required": true 11971 }, 11972 { 11973 "name": "order", 11974 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to sort the products\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 11975 "in": "query", 11976 "schema": { 11977 "type": "string" 11978 } 11979 }, 11980 { 11981 "name": "page", 11982 "description": "Index of the requested page, where one corresponds to the first page.", 11983 "in": "query", 11984 "schema": { 11985 "type": "integer", 11986 "format": "int32" 11987 } 11988 }, 11989 { 11990 "name": "search", 11991 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nproducts with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the products\nthat the user has permission to see will be returned.", 11992 "in": "query", 11993 "schema": { 11994 "type": "string" 11995 } 11996 }, 11997 { 11998 "name": "size", 11999 "description": "Maximum number of items that will be contained in the returned page.", 12000 "in": "query", 12001 "schema": { 12002 "type": "integer", 12003 "format": "int32" 12004 } 12005 } 12006 ], 12007 "responses": { 12008 "200": { 12009 "description": "Success.", 12010 "content": { 12011 "application/json": { 12012 "schema": { 12013 "type": "object", 12014 "properties": { 12015 "items": { 12016 "description": "Retrieved list of product minimal versions.", 12017 "type": "array", 12018 "items": { 12019 "$ref": "#/components/schemas/ProductMinimalVersion" 12020 } 12021 }, 12022 "page": { 12023 "description": "Index of the requested page, where one corresponds to the first page.", 12024 "type": "integer", 12025 "format": "int32" 12026 }, 12027 "size": { 12028 "description": "Maximum number of items that will be contained in the returned page.", 12029 "type": "integer", 12030 "format": "int32" 12031 }, 12032 "total": { 12033 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 12034 "type": "integer", 12035 "format": "int32" 12036 } 12037 } 12038 } 12039 } 12040 } 12041 }, 12042 "default": { 12043 "description": "Error.", 12044 "content": { 12045 "application/json": { 12046 "schema": { 12047 "$ref": "#/components/schemas/Error" 12048 } 12049 } 12050 } 12051 } 12052 } 12053 } 12054 }, 12055 "/api/clusters_mgmt/v1/products/{product_id}/minimal_versions/{minimal_version_id}": { 12056 "get": { 12057 "description": "Retrieves the details of the product minimal version.", 12058 "parameters": [ 12059 { 12060 "name": "product_id", 12061 "in": "path", 12062 "schema": { 12063 "type": "string" 12064 }, 12065 "required": true 12066 }, 12067 { 12068 "name": "minimal_version_id", 12069 "in": "path", 12070 "schema": { 12071 "type": "string" 12072 }, 12073 "required": true 12074 } 12075 ], 12076 "responses": { 12077 "200": { 12078 "description": "Success.", 12079 "content": { 12080 "application/json": { 12081 "schema": { 12082 "$ref": "#/components/schemas/ProductMinimalVersion" 12083 } 12084 } 12085 } 12086 }, 12087 "default": { 12088 "description": "Error.", 12089 "content": { 12090 "application/json": { 12091 "schema": { 12092 "$ref": "#/components/schemas/Error" 12093 } 12094 } 12095 } 12096 } 12097 } 12098 } 12099 }, 12100 "/api/clusters_mgmt/v1/products/{product_id}/technology_previews": { 12101 "get": { 12102 "description": "Retrieves the list of product technology previews.", 12103 "parameters": [ 12104 { 12105 "name": "product_id", 12106 "in": "path", 12107 "schema": { 12108 "type": "string" 12109 }, 12110 "required": true 12111 }, 12112 { 12113 "name": "order", 12114 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to sort the products\ndescending by name the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 12115 "in": "query", 12116 "schema": { 12117 "type": "string" 12118 } 12119 }, 12120 { 12121 "name": "page", 12122 "description": "Index of the requested page, where one corresponds to the first page.", 12123 "in": "query", 12124 "schema": { 12125 "type": "integer", 12126 "format": "int32" 12127 } 12128 }, 12129 { 12130 "name": "search", 12131 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the product instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nproducts with a name starting with `my` the value should be:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the products\nthat the user has permission to see will be returned.", 12132 "in": "query", 12133 "schema": { 12134 "type": "string" 12135 } 12136 }, 12137 { 12138 "name": "size", 12139 "description": "Maximum number of items that will be contained in the returned page.", 12140 "in": "query", 12141 "schema": { 12142 "type": "integer", 12143 "format": "int32" 12144 } 12145 } 12146 ], 12147 "responses": { 12148 "200": { 12149 "description": "Success.", 12150 "content": { 12151 "application/json": { 12152 "schema": { 12153 "type": "object", 12154 "properties": { 12155 "items": { 12156 "description": "Retrieved list of product technology previews.", 12157 "type": "array", 12158 "items": { 12159 "$ref": "#/components/schemas/ProductTechnologyPreview" 12160 } 12161 }, 12162 "page": { 12163 "description": "Index of the requested page, where one corresponds to the first page.", 12164 "type": "integer", 12165 "format": "int32" 12166 }, 12167 "size": { 12168 "description": "Maximum number of items that will be contained in the returned page.", 12169 "type": "integer", 12170 "format": "int32" 12171 }, 12172 "total": { 12173 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 12174 "type": "integer", 12175 "format": "int32" 12176 } 12177 } 12178 } 12179 } 12180 } 12181 }, 12182 "default": { 12183 "description": "Error.", 12184 "content": { 12185 "application/json": { 12186 "schema": { 12187 "$ref": "#/components/schemas/Error" 12188 } 12189 } 12190 } 12191 } 12192 } 12193 } 12194 }, 12195 "/api/clusters_mgmt/v1/products/{product_id}/technology_previews/{technology_preview_id}": { 12196 "get": { 12197 "description": "Retrieves the details of the product technology preview.", 12198 "parameters": [ 12199 { 12200 "name": "product_id", 12201 "in": "path", 12202 "schema": { 12203 "type": "string" 12204 }, 12205 "required": true 12206 }, 12207 { 12208 "name": "technology_preview_id", 12209 "in": "path", 12210 "schema": { 12211 "type": "string" 12212 }, 12213 "required": true 12214 } 12215 ], 12216 "responses": { 12217 "200": { 12218 "description": "Success.", 12219 "content": { 12220 "application/json": { 12221 "schema": { 12222 "$ref": "#/components/schemas/ProductTechnologyPreview" 12223 } 12224 } 12225 } 12226 }, 12227 "default": { 12228 "description": "Error.", 12229 "content": { 12230 "application/json": { 12231 "schema": { 12232 "$ref": "#/components/schemas/Error" 12233 } 12234 } 12235 } 12236 } 12237 } 12238 } 12239 }, 12240 "/api/clusters_mgmt/v1/provision_shards": { 12241 "post": { 12242 "description": "Adds a provision shard.", 12243 "requestBody": { 12244 "content": { 12245 "application/json": { 12246 "schema": { 12247 "$ref": "#/components/schemas/ProvisionShard" 12248 } 12249 } 12250 } 12251 }, 12252 "responses": { 12253 "201": { 12254 "description": "Success.", 12255 "content": { 12256 "application/json": { 12257 "schema": { 12258 "$ref": "#/components/schemas/ProvisionShard" 12259 } 12260 } 12261 } 12262 }, 12263 "default": { 12264 "description": "Error.", 12265 "content": { 12266 "application/json": { 12267 "schema": { 12268 "$ref": "#/components/schemas/Error" 12269 } 12270 } 12271 } 12272 } 12273 } 12274 }, 12275 "get": { 12276 "parameters": [ 12277 { 12278 "name": "page", 12279 "description": "Index of the requested page, where one corresponds to the first page.", 12280 "in": "query", 12281 "schema": { 12282 "type": "integer", 12283 "format": "int32" 12284 } 12285 }, 12286 { 12287 "name": "search", 12288 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the cluster instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nclusters with a name starting with `my` in the `us-east-1` region the value\nshould be:\n\n```sql\nname like 'my%' and region.id = 'us-east-1'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nprovision shards that the user has permission to see will be returned.", 12289 "in": "query", 12290 "schema": { 12291 "type": "string" 12292 } 12293 }, 12294 { 12295 "name": "size", 12296 "description": "Maximum number of items that will be contained in the returned page.", 12297 "in": "query", 12298 "schema": { 12299 "type": "integer", 12300 "format": "int32" 12301 } 12302 } 12303 ], 12304 "responses": { 12305 "200": { 12306 "description": "Success.", 12307 "content": { 12308 "application/json": { 12309 "schema": { 12310 "type": "object", 12311 "properties": { 12312 "items": { 12313 "description": "Retrieved a list of provision shards.", 12314 "type": "array", 12315 "items": { 12316 "$ref": "#/components/schemas/ProvisionShard" 12317 } 12318 }, 12319 "page": { 12320 "description": "Index of the requested page, where one corresponds to the first page.", 12321 "type": "integer", 12322 "format": "int32" 12323 }, 12324 "size": { 12325 "description": "Maximum number of items that will be contained in the returned page.", 12326 "type": "integer", 12327 "format": "int32" 12328 }, 12329 "total": { 12330 "description": "Total number of items of the collection.", 12331 "type": "integer", 12332 "format": "int32" 12333 } 12334 } 12335 } 12336 } 12337 } 12338 }, 12339 "default": { 12340 "description": "Error.", 12341 "content": { 12342 "application/json": { 12343 "schema": { 12344 "$ref": "#/components/schemas/Error" 12345 } 12346 } 12347 } 12348 } 12349 } 12350 } 12351 }, 12352 "/api/clusters_mgmt/v1/provision_shards/{provision_shard_id}": { 12353 "delete": { 12354 "description": "Delete the provision shard.", 12355 "parameters": [ 12356 { 12357 "name": "provision_shard_id", 12358 "in": "path", 12359 "schema": { 12360 "type": "string" 12361 }, 12362 "required": true 12363 } 12364 ], 12365 "responses": { 12366 "204": { 12367 "description": "Success." 12368 }, 12369 "default": { 12370 "description": "Error.", 12371 "content": { 12372 "application/json": { 12373 "schema": { 12374 "$ref": "#/components/schemas/Error" 12375 } 12376 } 12377 } 12378 } 12379 } 12380 }, 12381 "get": { 12382 "description": "Retrieves the details of the provision shard.", 12383 "parameters": [ 12384 { 12385 "name": "provision_shard_id", 12386 "in": "path", 12387 "schema": { 12388 "type": "string" 12389 }, 12390 "required": true 12391 } 12392 ], 12393 "responses": { 12394 "200": { 12395 "description": "Success.", 12396 "content": { 12397 "application/json": { 12398 "schema": { 12399 "$ref": "#/components/schemas/ProvisionShard" 12400 } 12401 } 12402 } 12403 }, 12404 "default": { 12405 "description": "Error.", 12406 "content": { 12407 "application/json": { 12408 "schema": { 12409 "$ref": "#/components/schemas/Error" 12410 } 12411 } 12412 } 12413 } 12414 } 12415 }, 12416 "patch": { 12417 "description": "Updates the details of the provision shard.", 12418 "parameters": [ 12419 { 12420 "name": "provision_shard_id", 12421 "in": "path", 12422 "schema": { 12423 "type": "string" 12424 }, 12425 "required": true 12426 } 12427 ], 12428 "requestBody": { 12429 "content": { 12430 "application/json": { 12431 "schema": { 12432 "$ref": "#/components/schemas/ProvisionShard" 12433 } 12434 } 12435 } 12436 }, 12437 "responses": { 12438 "200": { 12439 "description": "Success.", 12440 "content": { 12441 "application/json": { 12442 "schema": { 12443 "$ref": "#/components/schemas/ProvisionShard" 12444 } 12445 } 12446 } 12447 }, 12448 "default": { 12449 "description": "Error.", 12450 "content": { 12451 "application/json": { 12452 "schema": { 12453 "$ref": "#/components/schemas/Error" 12454 } 12455 } 12456 } 12457 } 12458 } 12459 } 12460 }, 12461 "/api/clusters_mgmt/v1/registry_allowlists": { 12462 "post": { 12463 "description": "Adds a new break registry allowlist.", 12464 "requestBody": { 12465 "content": { 12466 "application/json": { 12467 "schema": { 12468 "$ref": "#/components/schemas/RegistryAllowlist" 12469 } 12470 } 12471 } 12472 }, 12473 "responses": { 12474 "201": { 12475 "description": "Success.", 12476 "content": { 12477 "application/json": { 12478 "schema": { 12479 "$ref": "#/components/schemas/RegistryAllowlist" 12480 } 12481 } 12482 } 12483 }, 12484 "default": { 12485 "description": "Error.", 12486 "content": { 12487 "application/json": { 12488 "schema": { 12489 "$ref": "#/components/schemas/Error" 12490 } 12491 } 12492 } 12493 } 12494 } 12495 }, 12496 "get": { 12497 "description": "Retrieves the list of registry allowlists.", 12498 "parameters": [ 12499 { 12500 "name": "order", 12501 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the registry allowlists\ninstead of the the names of the columns of a table. For example, in order to sort the\nallowlists descending by identifier the value should be:\n\n```sql\ncreation_timestamp desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 12502 "in": "query", 12503 "schema": { 12504 "type": "string" 12505 } 12506 }, 12507 { 12508 "name": "page", 12509 "description": "Index of the requested page, where one corresponds to the first page.", 12510 "in": "query", 12511 "schema": { 12512 "type": "integer", 12513 "format": "int32" 12514 } 12515 }, 12516 { 12517 "name": "search", 12518 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the registry allowlists\ninstead of the names of the columns of a table. For example, in order to retrieve all\nthe allowlists with a specific cloud provider and creation time the following is required:\n\n```sql\ncloud_provider.id='aws' and creation_timestamp > '2023-03-01T00:00:00Z'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nregistry allowlists that the user has permission to see will be returned.", 12519 "in": "query", 12520 "schema": { 12521 "type": "string" 12522 } 12523 }, 12524 { 12525 "name": "size", 12526 "description": "Number of items contained in the returned page.", 12527 "in": "query", 12528 "schema": { 12529 "type": "integer", 12530 "format": "int32" 12531 } 12532 } 12533 ], 12534 "responses": { 12535 "200": { 12536 "description": "Success.", 12537 "content": { 12538 "application/json": { 12539 "schema": { 12540 "type": "object", 12541 "properties": { 12542 "items": { 12543 "description": "Retrieved list of registry allowlists.", 12544 "type": "array", 12545 "items": { 12546 "$ref": "#/components/schemas/RegistryAllowlist" 12547 } 12548 }, 12549 "page": { 12550 "description": "Index of the requested page, where one corresponds to the first page.", 12551 "type": "integer", 12552 "format": "int32" 12553 }, 12554 "size": { 12555 "description": "Number of items contained in the returned page.", 12556 "type": "integer", 12557 "format": "int32" 12558 }, 12559 "total": { 12560 "description": "Total number of items of the collection.", 12561 "type": "integer", 12562 "format": "int32" 12563 } 12564 } 12565 } 12566 } 12567 } 12568 }, 12569 "default": { 12570 "description": "Error.", 12571 "content": { 12572 "application/json": { 12573 "schema": { 12574 "$ref": "#/components/schemas/Error" 12575 } 12576 } 12577 } 12578 } 12579 } 12580 } 12581 }, 12582 "/api/clusters_mgmt/v1/registry_allowlists/{registry_allowlist_id}": { 12583 "delete": { 12584 "description": "Deletes the allowlist.", 12585 "parameters": [ 12586 { 12587 "name": "registry_allowlist_id", 12588 "in": "path", 12589 "schema": { 12590 "type": "string" 12591 }, 12592 "required": true 12593 } 12594 ], 12595 "responses": { 12596 "204": { 12597 "description": "Success." 12598 }, 12599 "default": { 12600 "description": "Error.", 12601 "content": { 12602 "application/json": { 12603 "schema": { 12604 "$ref": "#/components/schemas/Error" 12605 } 12606 } 12607 } 12608 } 12609 } 12610 }, 12611 "get": { 12612 "description": "Retrieves the details of the allowlist.", 12613 "parameters": [ 12614 { 12615 "name": "registry_allowlist_id", 12616 "in": "path", 12617 "schema": { 12618 "type": "string" 12619 }, 12620 "required": true 12621 } 12622 ], 12623 "responses": { 12624 "200": { 12625 "description": "Success.", 12626 "content": { 12627 "application/json": { 12628 "schema": { 12629 "$ref": "#/components/schemas/RegistryAllowlist" 12630 } 12631 } 12632 } 12633 }, 12634 "default": { 12635 "description": "Error.", 12636 "content": { 12637 "application/json": { 12638 "schema": { 12639 "$ref": "#/components/schemas/Error" 12640 } 12641 } 12642 } 12643 } 12644 } 12645 } 12646 }, 12647 "/api/clusters_mgmt/v1/storage_quota_values": { 12648 "get": { 12649 "description": "Retrieves the list of Storage Quota Values.", 12650 "parameters": [ 12651 { 12652 "name": "page", 12653 "description": "Index of the requested page, where one corresponds to the first page.", 12654 "in": "query", 12655 "schema": { 12656 "type": "integer", 12657 "format": "int32" 12658 } 12659 }, 12660 { 12661 "name": "size", 12662 "description": "Number of items contained in the returned page.", 12663 "in": "query", 12664 "schema": { 12665 "type": "integer", 12666 "format": "int32" 12667 } 12668 } 12669 ], 12670 "responses": { 12671 "200": { 12672 "description": "Success.", 12673 "content": { 12674 "application/json": { 12675 "schema": { 12676 "type": "object", 12677 "properties": { 12678 "items": { 12679 "description": "Retrieved list of values.", 12680 "type": "array", 12681 "items": { 12682 "$ref": "#/components/schemas/StorageQuota" 12683 } 12684 }, 12685 "page": { 12686 "description": "Index of the requested page, where one corresponds to the first page.", 12687 "type": "integer", 12688 "format": "int32" 12689 }, 12690 "size": { 12691 "description": "Number of items contained in the returned page.", 12692 "type": "integer", 12693 "format": "int32" 12694 }, 12695 "total": { 12696 "description": "Total number of items of the collection.", 12697 "type": "integer", 12698 "format": "int32" 12699 } 12700 } 12701 } 12702 } 12703 } 12704 }, 12705 "default": { 12706 "description": "Error.", 12707 "content": { 12708 "application/json": { 12709 "schema": { 12710 "$ref": "#/components/schemas/Error" 12711 } 12712 } 12713 } 12714 } 12715 } 12716 } 12717 }, 12718 "/api/clusters_mgmt/v1/trusted_ip_addresses": { 12719 "get": { 12720 "description": "Retrieves the list of trusted ip addresses.", 12721 "parameters": [ 12722 { 12723 "name": "page", 12724 "description": "Index of the requested page, where one corresponds to the first page.", 12725 "in": "query", 12726 "schema": { 12727 "type": "integer", 12728 "format": "int32" 12729 } 12730 }, 12731 { 12732 "name": "size", 12733 "description": "Number of items contained in the returned page.", 12734 "in": "query", 12735 "schema": { 12736 "type": "integer", 12737 "format": "int32" 12738 } 12739 } 12740 ], 12741 "responses": { 12742 "200": { 12743 "description": "Success.", 12744 "content": { 12745 "application/json": { 12746 "schema": { 12747 "type": "object", 12748 "properties": { 12749 "items": { 12750 "description": "Retrieved list of trusted ip addresses.", 12751 "type": "array", 12752 "items": { 12753 "$ref": "#/components/schemas/TrustedIp" 12754 } 12755 }, 12756 "page": { 12757 "description": "Index of the requested page, where one corresponds to the first page.", 12758 "type": "integer", 12759 "format": "int32" 12760 }, 12761 "size": { 12762 "description": "Number of items contained in the returned page.", 12763 "type": "integer", 12764 "format": "int32" 12765 }, 12766 "total": { 12767 "description": "Total number of items of the collection.", 12768 "type": "integer", 12769 "format": "int32" 12770 } 12771 } 12772 } 12773 } 12774 } 12775 }, 12776 "default": { 12777 "description": "Error.", 12778 "content": { 12779 "application/json": { 12780 "schema": { 12781 "$ref": "#/components/schemas/Error" 12782 } 12783 } 12784 } 12785 } 12786 } 12787 } 12788 }, 12789 "/api/clusters_mgmt/v1/version_gates": { 12790 "post": { 12791 "description": "Adds a new version gate", 12792 "requestBody": { 12793 "content": { 12794 "application/json": { 12795 "schema": { 12796 "$ref": "#/components/schemas/VersionGate" 12797 } 12798 } 12799 } 12800 }, 12801 "responses": { 12802 "201": { 12803 "description": "Success.", 12804 "content": { 12805 "application/json": { 12806 "schema": { 12807 "$ref": "#/components/schemas/VersionGate" 12808 } 12809 } 12810 } 12811 }, 12812 "default": { 12813 "description": "Error.", 12814 "content": { 12815 "application/json": { 12816 "schema": { 12817 "$ref": "#/components/schemas/Error" 12818 } 12819 } 12820 } 12821 } 12822 } 12823 }, 12824 "get": { 12825 "description": "Retrieves a list of version gates.", 12826 "parameters": [ 12827 { 12828 "name": "order", 12829 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\nan SQL statement, but using the names of the attributes of the version gate instead of\nthe names of the columns of a table. For example, in order to sort the version gates\ndescending by identifier the value should be:\n\n```sql\nid desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 12830 "in": "query", 12831 "schema": { 12832 "type": "string" 12833 } 12834 }, 12835 { 12836 "name": "page", 12837 "description": "Index of the requested page, where one corresponds to the first page.", 12838 "in": "query", 12839 "schema": { 12840 "type": "integer", 12841 "format": "int32" 12842 } 12843 }, 12844 { 12845 "name": "search", 12846 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement, but using the names of the attributes of the version gate instead of\nthe names of the columns of a table.\n\nIf the parameter isn't provided, or if the value is empty, then all the version gates\nthat the user has permission to see will be returned.", 12847 "in": "query", 12848 "schema": { 12849 "type": "string" 12850 } 12851 }, 12852 { 12853 "name": "size", 12854 "description": "Maximum number of items that will be contained in the returned page.\n\nDefault value is `100`.", 12855 "in": "query", 12856 "schema": { 12857 "type": "integer", 12858 "format": "int32" 12859 } 12860 } 12861 ], 12862 "responses": { 12863 "200": { 12864 "description": "Success.", 12865 "content": { 12866 "application/json": { 12867 "schema": { 12868 "type": "object", 12869 "properties": { 12870 "items": { 12871 "description": "Retrieved list of version gates.", 12872 "type": "array", 12873 "items": { 12874 "$ref": "#/components/schemas/VersionGate" 12875 } 12876 }, 12877 "page": { 12878 "description": "Index of the requested page, where one corresponds to the first page.", 12879 "type": "integer", 12880 "format": "int32" 12881 }, 12882 "size": { 12883 "description": "Maximum number of items that will be contained in the returned page.\n\nDefault value is `100`.", 12884 "type": "integer", 12885 "format": "int32" 12886 }, 12887 "total": { 12888 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 12889 "type": "integer", 12890 "format": "int32" 12891 } 12892 } 12893 } 12894 } 12895 } 12896 }, 12897 "default": { 12898 "description": "Error.", 12899 "content": { 12900 "application/json": { 12901 "schema": { 12902 "$ref": "#/components/schemas/Error" 12903 } 12904 } 12905 } 12906 } 12907 } 12908 } 12909 }, 12910 "/api/clusters_mgmt/v1/version_gates/{version_gate_id}": { 12911 "delete": { 12912 "description": "Deletes the version gate.", 12913 "parameters": [ 12914 { 12915 "name": "version_gate_id", 12916 "in": "path", 12917 "schema": { 12918 "type": "string" 12919 }, 12920 "required": true 12921 } 12922 ], 12923 "responses": { 12924 "204": { 12925 "description": "Success." 12926 }, 12927 "default": { 12928 "description": "Error.", 12929 "content": { 12930 "application/json": { 12931 "schema": { 12932 "$ref": "#/components/schemas/Error" 12933 } 12934 } 12935 } 12936 } 12937 } 12938 }, 12939 "get": { 12940 "description": "Retrieves the details of the version gate.", 12941 "parameters": [ 12942 { 12943 "name": "version_gate_id", 12944 "in": "path", 12945 "schema": { 12946 "type": "string" 12947 }, 12948 "required": true 12949 } 12950 ], 12951 "responses": { 12952 "200": { 12953 "description": "Success.", 12954 "content": { 12955 "application/json": { 12956 "schema": { 12957 "$ref": "#/components/schemas/VersionGate" 12958 } 12959 } 12960 } 12961 }, 12962 "default": { 12963 "description": "Error.", 12964 "content": { 12965 "application/json": { 12966 "schema": { 12967 "$ref": "#/components/schemas/Error" 12968 } 12969 } 12970 } 12971 } 12972 } 12973 } 12974 }, 12975 "/api/clusters_mgmt/v1/versions": { 12976 "get": { 12977 "description": "Retrieves a list of versions.", 12978 "parameters": [ 12979 { 12980 "name": "order", 12981 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement, but using the names of the attributes of the version instead of\nthe names of the columns of a table. For example, in order to sort the versions\ndescending by identifier the value should be:\n\n```sql\nid desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 12982 "in": "query", 12983 "schema": { 12984 "type": "string" 12985 } 12986 }, 12987 { 12988 "name": "page", 12989 "description": "Index of the requested page, where one corresponds to the first page.", 12990 "in": "query", 12991 "schema": { 12992 "type": "integer", 12993 "format": "int32" 12994 } 12995 }, 12996 { 12997 "name": "search", 12998 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the version instead of\nthe names of the columns of a table. For example, in order to retrieve all the\nversions that are enabled:\n\n```sql\nenabled = 't'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the versions\nthat the user has permission to see will be returned.", 12999 "in": "query", 13000 "schema": { 13001 "type": "string" 13002 } 13003 }, 13004 { 13005 "name": "size", 13006 "description": "Maximum number of items that will be contained in the returned page.\n\nDefault value is `100`.", 13007 "in": "query", 13008 "schema": { 13009 "type": "integer", 13010 "format": "int32" 13011 } 13012 } 13013 ], 13014 "responses": { 13015 "200": { 13016 "description": "Success.", 13017 "content": { 13018 "application/json": { 13019 "schema": { 13020 "type": "object", 13021 "properties": { 13022 "items": { 13023 "description": "Retrieved list of versions.", 13024 "type": "array", 13025 "items": { 13026 "$ref": "#/components/schemas/Version" 13027 } 13028 }, 13029 "page": { 13030 "description": "Index of the requested page, where one corresponds to the first page.", 13031 "type": "integer", 13032 "format": "int32" 13033 }, 13034 "size": { 13035 "description": "Maximum number of items that will be contained in the returned page.\n\nDefault value is `100`.", 13036 "type": "integer", 13037 "format": "int32" 13038 }, 13039 "total": { 13040 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 13041 "type": "integer", 13042 "format": "int32" 13043 } 13044 } 13045 } 13046 } 13047 } 13048 }, 13049 "default": { 13050 "description": "Error.", 13051 "content": { 13052 "application/json": { 13053 "schema": { 13054 "$ref": "#/components/schemas/Error" 13055 } 13056 } 13057 } 13058 } 13059 } 13060 } 13061 }, 13062 "/api/clusters_mgmt/v1/versions/{version_id}": { 13063 "get": { 13064 "description": "Retrieves the details of the version.", 13065 "parameters": [ 13066 { 13067 "name": "version_id", 13068 "in": "path", 13069 "schema": { 13070 "type": "string" 13071 }, 13072 "required": true 13073 } 13074 ], 13075 "responses": { 13076 "200": { 13077 "description": "Success.", 13078 "content": { 13079 "application/json": { 13080 "schema": { 13081 "$ref": "#/components/schemas/Version" 13082 } 13083 } 13084 } 13085 }, 13086 "default": { 13087 "description": "Error.", 13088 "content": { 13089 "application/json": { 13090 "schema": { 13091 "$ref": "#/components/schemas/Error" 13092 } 13093 } 13094 } 13095 } 13096 } 13097 } 13098 } 13099 }, 13100 "components": { 13101 "schemas": { 13102 "Metadata": { 13103 "description": "Version metadata.", 13104 "properties": { 13105 "server_version": { 13106 "description": "Version of the server.", 13107 "type": "string" 13108 } 13109 } 13110 }, 13111 "AMIOverride": { 13112 "description": "AMIOverride specifies what Amazon Machine Image should be used for a particular product and region.", 13113 "properties": { 13114 "kind": { 13115 "description": "Indicates the type of this object. Will be 'AMIOverride' if this is a complete object or 'AMIOverrideLink' if it is just a link.", 13116 "type": "string" 13117 }, 13118 "id": { 13119 "description": "Unique identifier of the object.", 13120 "type": "string" 13121 }, 13122 "href": { 13123 "description": "Self link.", 13124 "type": "string" 13125 }, 13126 "ami": { 13127 "description": "AMI is the id of the Amazon Machine Image.", 13128 "type": "string" 13129 }, 13130 "product": { 13131 "description": "Link to the product type.", 13132 "$ref": "#/components/schemas/Product" 13133 }, 13134 "region": { 13135 "description": "Link to the cloud provider region.", 13136 "$ref": "#/components/schemas/CloudRegion" 13137 } 13138 } 13139 }, 13140 "AWS": { 13141 "description": "_Amazon Web Services_ specific settings of a cluster.", 13142 "properties": { 13143 "kms_key_arn": { 13144 "description": "Customer Managed Key to encrypt EBS Volume", 13145 "type": "string" 13146 }, 13147 "sts": { 13148 "description": "Contains the necessary attributes to support role-based authentication on AWS.", 13149 "$ref": "#/components/schemas/STS" 13150 }, 13151 "access_key_id": { 13152 "description": "AWS access key identifier.", 13153 "type": "string" 13154 }, 13155 "account_id": { 13156 "description": "AWS account identifier.", 13157 "type": "string" 13158 }, 13159 "additional_allowed_principals": { 13160 "description": "Additional allowed principal ARNs to be added to the hosted control plane's VPC Endpoint Service.", 13161 "type": "array", 13162 "items": { 13163 "type": "string" 13164 } 13165 }, 13166 "additional_compute_security_group_ids": { 13167 "description": "Additional AWS Security Groups to be added to default worker (compute) machine pool.", 13168 "type": "array", 13169 "items": { 13170 "type": "string" 13171 } 13172 }, 13173 "additional_control_plane_security_group_ids": { 13174 "description": "Additional AWS Security Groups to be added to default control plane machine pool.", 13175 "type": "array", 13176 "items": { 13177 "type": "string" 13178 } 13179 }, 13180 "additional_infra_security_group_ids": { 13181 "description": "Additional AWS Security Groups to be added to default infra machine pool.", 13182 "type": "array", 13183 "items": { 13184 "type": "string" 13185 } 13186 }, 13187 "audit_log": { 13188 "description": "Audit log forwarding configuration", 13189 "$ref": "#/components/schemas/AuditLog" 13190 }, 13191 "billing_account_id": { 13192 "description": "BillingAccountID is the account used for billing subscriptions purchased via the marketplace", 13193 "type": "string" 13194 }, 13195 "ec2_metadata_http_tokens": { 13196 "description": "Which Ec2MetadataHttpTokens to use for metadata service interaction options for EC2 instances", 13197 "$ref": "#/components/schemas/Ec2MetadataHttpTokens" 13198 }, 13199 "etcd_encryption": { 13200 "description": "Related etcd encryption configuration", 13201 "$ref": "#/components/schemas/AwsEtcdEncryption" 13202 }, 13203 "hcp_internal_communication_hosted_zone_id": { 13204 "description": "ID of local private hosted zone for hypershift internal communication.", 13205 "type": "string" 13206 }, 13207 "private_hosted_zone_id": { 13208 "description": "ID of private hosted zone.", 13209 "type": "string" 13210 }, 13211 "private_hosted_zone_role_arn": { 13212 "description": "Role ARN for private hosted zone.", 13213 "type": "string" 13214 }, 13215 "private_link": { 13216 "description": "Sets cluster to be inaccessible externally.", 13217 "type": "boolean" 13218 }, 13219 "private_link_configuration": { 13220 "description": "Manages additional configuration for Private Links.", 13221 "$ref": "#/components/schemas/PrivateLinkClusterConfiguration" 13222 }, 13223 "secret_access_key": { 13224 "description": "AWS secret access key.", 13225 "type": "string" 13226 }, 13227 "subnet_ids": { 13228 "description": "The subnet ids to be used when installing the cluster.", 13229 "type": "array", 13230 "items": { 13231 "type": "string" 13232 } 13233 }, 13234 "tags": { 13235 "description": "Optional keys and values that the installer will add as tags to all AWS resources it creates", 13236 "type": "object", 13237 "additionalProperties": { 13238 "type": "string" 13239 } 13240 }, 13241 "vpc_endpoint_role_arn": { 13242 "description": "Role ARN for VPC Endpoint Service cross account role.", 13243 "type": "string" 13244 } 13245 } 13246 }, 13247 "AWSBackupConfig": { 13248 "description": "Backup configuration for AWS clusters", 13249 "properties": { 13250 "s3_bucket": { 13251 "description": "Name of the S3 bucket used to save the backup", 13252 "type": "string" 13253 }, 13254 "account_id": { 13255 "description": "ID of the AWS Disaster Recovery (DR) account", 13256 "type": "string" 13257 }, 13258 "identity_provider_arn": { 13259 "description": "ARN of the identity provider created in the Disaster Recovery (DR) account for the Management Cluster", 13260 "type": "string" 13261 }, 13262 "management_cluster": { 13263 "description": "Name of the management cluster the backup config refers to", 13264 "type": "string" 13265 }, 13266 "role_arn": { 13267 "description": "ARN of the role used by the CS Trusted Account to gain access to the Disaster Recovery (DR) account", 13268 "type": "string" 13269 } 13270 } 13271 }, 13272 "AWSCapacityReservation": { 13273 "description": "AWS Capacity Reservation specification.", 13274 "properties": { 13275 "id": { 13276 "description": "Specify the target Capacity Reservation in which the EC2 instances will be launched.", 13277 "type": "string" 13278 }, 13279 "market_type": { 13280 "description": "marketType specifies the market type of the CapacityReservation for the EC2\ninstances. Valid values are OnDemand, CapacityBlocks.\n\"OnDemand\": EC2 instances run as standard On-Demand instances.\n\"CapacityBlocks\": scheduled pre-purchased compute capacity.", 13281 "$ref": "#/components/schemas/MarketType" 13282 } 13283 } 13284 }, 13285 "AWSFlavour": { 13286 "description": "Specification for different classes of nodes inside a flavour.", 13287 "properties": { 13288 "compute_instance_type": { 13289 "description": "AWS default instance type for the worker volume.\n\nUser can be overridden specifying in the cluster itself a type for compute node.", 13290 "type": "string" 13291 }, 13292 "infra_instance_type": { 13293 "description": "AWS default instance type for the infra volume.", 13294 "type": "string" 13295 }, 13296 "infra_volume": { 13297 "description": "Infra volume specification.", 13298 "$ref": "#/components/schemas/AWSVolume" 13299 }, 13300 "master_instance_type": { 13301 "description": "AWS default instance type for the master volume.", 13302 "type": "string" 13303 }, 13304 "master_volume": { 13305 "description": "Master volume specification.", 13306 "$ref": "#/components/schemas/AWSVolume" 13307 }, 13308 "worker_volume": { 13309 "description": "Worker volume specification.", 13310 "$ref": "#/components/schemas/AWSVolume" 13311 } 13312 } 13313 }, 13314 "AWSInfrastructureAccessRole": { 13315 "description": "A set of acces permissions for AWS resources", 13316 "properties": { 13317 "kind": { 13318 "description": "Indicates the type of this object. Will be 'AWSInfrastructureAccessRole' if this is a complete object or 'AWSInfrastructureAccessRoleLink' if it is just a link.", 13319 "type": "string" 13320 }, 13321 "id": { 13322 "description": "Unique identifier of the object.", 13323 "type": "string" 13324 }, 13325 "href": { 13326 "description": "Self link.", 13327 "type": "string" 13328 }, 13329 "description": { 13330 "description": "Description of the role.", 13331 "type": "string" 13332 }, 13333 "display_name": { 13334 "description": "Human friendly identifier of the role, for example `Read only`.", 13335 "type": "string" 13336 }, 13337 "state": { 13338 "description": "State of the role.", 13339 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleState" 13340 } 13341 } 13342 }, 13343 "AWSInfrastructureAccessRoleGrant": { 13344 "description": "Representation of an AWS infrastructure access role grant.", 13345 "properties": { 13346 "kind": { 13347 "description": "Indicates the type of this object. Will be 'AWSInfrastructureAccessRoleGrant' if this is a complete object or 'AWSInfrastructureAccessRoleGrantLink' if it is just a link.", 13348 "type": "string" 13349 }, 13350 "id": { 13351 "description": "Unique identifier of the object.", 13352 "type": "string" 13353 }, 13354 "href": { 13355 "description": "Self link.", 13356 "type": "string" 13357 }, 13358 "console_url": { 13359 "description": "URL to switch to the role in AWS console.", 13360 "type": "string" 13361 }, 13362 "role": { 13363 "description": "Link to AWS infrastructure access role.\nGrant must use a 'valid' role. ", 13364 "$ref": "#/components/schemas/AWSInfrastructureAccessRole" 13365 }, 13366 "state": { 13367 "description": "State of the grant.", 13368 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrantState" 13369 }, 13370 "state_description": { 13371 "description": "Description of the state.\nWill be empty unless state is 'Failed'.", 13372 "type": "string" 13373 }, 13374 "user_arn": { 13375 "description": "The user AWS IAM ARN we want to grant the role.", 13376 "type": "string" 13377 } 13378 } 13379 }, 13380 "AWSInfrastructureAccessRoleGrantState": { 13381 "description": "State of an AWS infrastructure access role grant.", 13382 "type": "string", 13383 "enum": [ 13384 "deleting", 13385 "failed", 13386 "pending", 13387 "ready", 13388 "removed" 13389 ] 13390 }, 13391 "AWSInfrastructureAccessRoleState": { 13392 "description": "State of an AWS infrastructure access role.", 13393 "type": "string", 13394 "enum": [ 13395 "invalid", 13396 "removed", 13397 "valid" 13398 ] 13399 }, 13400 "AWSMachinePool": { 13401 "description": "Representation of aws machine pool specific parameters.", 13402 "properties": { 13403 "kind": { 13404 "description": "Indicates the type of this object. Will be 'AWSMachinePool' if this is a complete object or 'AWSMachinePoolLink' if it is just a link.", 13405 "type": "string" 13406 }, 13407 "id": { 13408 "description": "Unique identifier of the object.", 13409 "type": "string" 13410 }, 13411 "href": { 13412 "description": "Self link.", 13413 "type": "string" 13414 }, 13415 "additional_security_group_ids": { 13416 "description": "Additional AWS Security Groups to be added machine pool. Note that machine pools can only be worker node at the time.", 13417 "type": "array", 13418 "items": { 13419 "type": "string" 13420 } 13421 }, 13422 "availability_zone_types": { 13423 "description": "Associates nodepool availability zones with zone types (e.g. wavelength, local).", 13424 "type": "object", 13425 "additionalProperties": { 13426 "type": "string" 13427 } 13428 }, 13429 "spot_market_options": { 13430 "description": "Use spot instances on this machine pool to reduce cost.", 13431 "$ref": "#/components/schemas/AWSSpotMarketOptions" 13432 }, 13433 "subnet_outposts": { 13434 "description": "Associates nodepool subnets with AWS Outposts.", 13435 "type": "object", 13436 "additionalProperties": { 13437 "type": "string" 13438 } 13439 }, 13440 "tags": { 13441 "description": "Optional keys and values that the machine pool provisioner will add as AWS tags to all AWS resources it creates.\n\nAWS tags must conform to the following standards:\n- Each resource may have a maximum of 25 tags\n- Tags beginning with \"aws:\" are reserved for system use and may not be set\n- Tag keys may be between 1 and 128 characters in length\n- Tag values may be between 0 and 256 characters in length\n- Tags may only contain letters, numbers, spaces, and the following characters: [_ . : / = + - @]", 13442 "type": "object", 13443 "additionalProperties": { 13444 "type": "string" 13445 } 13446 } 13447 } 13448 }, 13449 "AWSNodePool": { 13450 "description": "Representation of aws node pool specific parameters.", 13451 "properties": { 13452 "kind": { 13453 "description": "Indicates the type of this object. Will be 'AWSNodePool' if this is a complete object or 'AWSNodePoolLink' if it is just a link.", 13454 "type": "string" 13455 }, 13456 "id": { 13457 "description": "Unique identifier of the object.", 13458 "type": "string" 13459 }, 13460 "href": { 13461 "description": "Self link.", 13462 "type": "string" 13463 }, 13464 "additional_security_group_ids": { 13465 "description": "Additional AWS Security Groups to be added node pool.", 13466 "type": "array", 13467 "items": { 13468 "type": "string" 13469 } 13470 }, 13471 "availability_zone_types": { 13472 "description": "Associates nodepool availability zones with zone types (e.g. wavelength, local).", 13473 "type": "object", 13474 "additionalProperties": { 13475 "type": "string" 13476 } 13477 }, 13478 "capacity_reservation": { 13479 "description": "If present it defines the AWS Capacity Reservation used for this NodePool", 13480 "$ref": "#/components/schemas/AWSCapacityReservation" 13481 }, 13482 "ec2_metadata_http_tokens": { 13483 "description": "Which Ec2MetadataHttpTokens to use for metadata service interaction options for EC2 instances", 13484 "$ref": "#/components/schemas/Ec2MetadataHttpTokens" 13485 }, 13486 "instance_profile": { 13487 "description": "InstanceProfile is the AWS EC2 instance profile, which is a container for an IAM role that the EC2 instance uses.", 13488 "type": "string" 13489 }, 13490 "instance_type": { 13491 "description": "InstanceType is an ec2 instance type for node instances (e.g. m5.large).", 13492 "type": "string" 13493 }, 13494 "root_volume": { 13495 "description": "AWS Volume specification to be used to set custom worker disk size", 13496 "$ref": "#/components/schemas/AWSVolume" 13497 }, 13498 "subnet_outposts": { 13499 "description": "Associates nodepool subnets with AWS Outposts.", 13500 "type": "object", 13501 "additionalProperties": { 13502 "type": "string" 13503 } 13504 }, 13505 "tags": { 13506 "description": "Optional keys and values that the installer will add as tags to all AWS resources it creates.\n\nAWS tags must conform to the following standards:\n- Each resource may have a maximum of 25 tags\n- Tags beginning with \"aws:\" are reserved for system use and may not be set\n- Tag keys may be between 1 and 128 characters in length\n- Tag values may be between 0 and 256 characters in length\n- Tags may only contain letters, numbers, spaces, and the following characters: [_ . : / = + - @]", 13507 "type": "object", 13508 "additionalProperties": { 13509 "type": "string" 13510 } 13511 } 13512 } 13513 }, 13514 "AWSShard": { 13515 "description": "Config for AWS provision shards", 13516 "properties": { 13517 "ecr_repository_urls": { 13518 "description": "ECR repository URLs of the provision shard", 13519 "type": "array", 13520 "items": { 13521 "type": "string" 13522 } 13523 }, 13524 "backup_configs": { 13525 "description": "Backup configurations for the provision shard", 13526 "type": "array", 13527 "items": { 13528 "$ref": "#/components/schemas/AWSBackupConfig" 13529 } 13530 } 13531 } 13532 }, 13533 "AWSSpotMarketOptions": { 13534 "description": "Spot market options for AWS machine pool.", 13535 "properties": { 13536 "kind": { 13537 "description": "Indicates the type of this object. Will be 'AWSSpotMarketOptions' if this is a complete object or 'AWSSpotMarketOptionsLink' if it is just a link.", 13538 "type": "string" 13539 }, 13540 "id": { 13541 "description": "Unique identifier of the object.", 13542 "type": "string" 13543 }, 13544 "href": { 13545 "description": "Self link.", 13546 "type": "string" 13547 }, 13548 "max_price": { 13549 "description": "The max price for spot instance. Optional.\nIf not set, use the on-demand price.", 13550 "type": "number", 13551 "format": "float" 13552 } 13553 } 13554 }, 13555 "AWSVolume": { 13556 "description": "Holds settings for an AWS storage volume.", 13557 "properties": { 13558 "iops": { 13559 "description": "Volume provisioned IOPS.", 13560 "type": "integer", 13561 "format": "int32" 13562 }, 13563 "size": { 13564 "description": "Volume size in Gib.", 13565 "type": "integer", 13566 "format": "int32" 13567 } 13568 } 13569 }, 13570 "AWSSTSAccountRole": { 13571 "description": "Representation of an sts account role for a rosa cluster", 13572 "properties": { 13573 "items": { 13574 "description": "The list of STS Roles for this Account Role", 13575 "type": "array", 13576 "items": { 13577 "$ref": "#/components/schemas/AWSSTSRole" 13578 } 13579 }, 13580 "prefix": { 13581 "description": "The Prefix for this Account Role", 13582 "type": "string" 13583 } 13584 } 13585 }, 13586 "AWSSTSPolicy": { 13587 "description": "Representation of an sts policies for rosa cluster", 13588 "properties": { 13589 "arn": { 13590 "description": "The ARN of the managed policy", 13591 "type": "string" 13592 }, 13593 "id": { 13594 "description": "Policy ID", 13595 "type": "string" 13596 }, 13597 "details": { 13598 "description": "Policy Details", 13599 "type": "string" 13600 }, 13601 "type": { 13602 "description": "Type of policy operator/account role", 13603 "type": "string" 13604 } 13605 } 13606 }, 13607 "AWSSTSRole": { 13608 "description": "Representation of an sts role for a rosa cluster", 13609 "properties": { 13610 "hcpManagedPolicies": { 13611 "description": "Does this Role have HCP Managed Policies?", 13612 "type": "boolean" 13613 }, 13614 "isAdmin": { 13615 "description": "Does this role have Admin permission?", 13616 "type": "boolean" 13617 }, 13618 "managedPolicies": { 13619 "description": "Does this Role have Managed Policies?", 13620 "type": "boolean" 13621 }, 13622 "arn": { 13623 "description": "The AWS ARN for this Role", 13624 "type": "string" 13625 }, 13626 "type": { 13627 "description": "The type of this Role", 13628 "type": "string" 13629 }, 13630 "roleVersion": { 13631 "description": "The Openshift Version for this Role", 13632 "type": "string" 13633 } 13634 } 13635 }, 13636 "CCS": { 13637 "properties": { 13638 "kind": { 13639 "description": "Indicates the type of this object. Will be 'CCS' if this is a complete object or 'CCSLink' if it is just a link.", 13640 "type": "string" 13641 }, 13642 "id": { 13643 "description": "Unique identifier of the object.", 13644 "type": "string" 13645 }, 13646 "href": { 13647 "description": "Self link.", 13648 "type": "string" 13649 }, 13650 "disable_scp_checks": { 13651 "description": "Indicates if cloud permissions checks are disabled,\nwhen attempting installation of the cluster.", 13652 "type": "boolean" 13653 }, 13654 "enabled": { 13655 "description": "Indicates if Customer Cloud Subscription is enabled on the cluster.", 13656 "type": "boolean" 13657 } 13658 } 13659 }, 13660 "CPUTotalNodeRoleOSMetricNode": { 13661 "description": "Representation of information from telemetry about a the CPU capacity by node role and OS.", 13662 "properties": { 13663 "cpu_total": { 13664 "description": "The total CPU capacity of nodes with this set of roles and operating system.", 13665 "type": "number", 13666 "format": "float" 13667 }, 13668 "node_roles": { 13669 "description": "Representation of the node role for a cluster.", 13670 "type": "array", 13671 "items": { 13672 "type": "string" 13673 } 13674 }, 13675 "operating_system": { 13676 "description": "The operating system.", 13677 "type": "string" 13678 }, 13679 "time": { 13680 "type": "string", 13681 "format": "date-time" 13682 } 13683 } 13684 }, 13685 "CPUTotalsNodeRoleOSMetricNode": { 13686 "description": "Representation of information from telemetry about the CPU capacity by node\nrole and OS of a cluster.", 13687 "properties": { 13688 "cpu_totals": { 13689 "type": "array", 13690 "items": { 13691 "$ref": "#/components/schemas/CPUTotalNodeRoleOSMetricNode" 13692 } 13693 } 13694 } 13695 }, 13696 "DNS": { 13697 "description": "DNS settings of the cluster.", 13698 "properties": { 13699 "base_domain": { 13700 "description": "Base DNS domain of the cluster.\n\nDuring the installation of the cluster it is necessary to create multiple DNS records.\nThey will be created as sub-domains of this domain. For example, if the domain_prefix of the\ncluster is `mycluster` and the base domain is `example.com` then the following DNS\nrecords will be created:\n\n```\nmycluster-api.example.com\nmycluster-etcd-0.example.com\nmycluster-etcd-1.example.com\nmycluster-etcd-3.example.com\n```\n\nThe exact number, type and names of the created DNS record depends on the characteristics\nof the cluster, and may be different for different versions of _OpenShift_. Please don't\nrely on them. For example, to find what is the URL of the Kubernetes API server of the\ncluster don't assume that it will be `mycluster-api.example.com`. Instead of that use\nthis API to retrieve the description of the cluster, and get it from the `api.url`\nattribute. For example, if the identifier of the cluster is `123` send a request like\nthis:\n\n```http\nGET /api/clusters_mgmt/v1/clusters/123 HTTP/1.1\n```\n\nThat will return a response like this, including the `api.url` attribute:\n\n```json\n{\n \"kind\": \"Cluster\",\n \"id\": \"123\",\n \"href\": \"/api/clusters_mgmt/v1/clusters/123\",\n \"api\": {\n \"url\": \"https://mycluster-api.example.com:6443\"\n },\n ...\n}\n```\n\nWhen the cluster is created in Amazon Web Services it is necessary to create this base\nDNS domain in advance, using AWS Route53 (https://console.aws.amazon.com/route53).", 13701 "type": "string" 13702 } 13703 } 13704 }, 13705 "DNSDomain": { 13706 "description": "Contains the properties of a DNS domain.", 13707 "properties": { 13708 "kind": { 13709 "description": "Indicates the type of this object. Will be 'DNSDomain' if this is a complete object or 'DNSDomainLink' if it is just a link.", 13710 "type": "string" 13711 }, 13712 "id": { 13713 "description": "Unique identifier of the object.", 13714 "type": "string" 13715 }, 13716 "href": { 13717 "description": "Self link.", 13718 "type": "string" 13719 }, 13720 "cluster": { 13721 "description": "Link to the cluster that is registered with the DNS domain (optional).", 13722 "$ref": "#/components/schemas/ClusterLink" 13723 }, 13724 "cluster_arch": { 13725 "description": "Signals which cluster architecture the domain is ready for.", 13726 "$ref": "#/components/schemas/ClusterArchitecture" 13727 }, 13728 "organization": { 13729 "description": "Link to the organization that reserved the DNS domain.", 13730 "$ref": "#/components/schemas/OrganizationLink" 13731 }, 13732 "reserved_at_timestamp": { 13733 "description": "Date and time when the DNS domain was reserved.", 13734 "type": "string", 13735 "format": "date-time" 13736 }, 13737 "user_defined": { 13738 "description": "Indicates if this dns domain is user defined.", 13739 "type": "boolean" 13740 } 13741 } 13742 }, 13743 "GCP": { 13744 "description": "Google cloud platform settings of a cluster.", 13745 "properties": { 13746 "auth_uri": { 13747 "description": "GCP authentication uri", 13748 "type": "string" 13749 }, 13750 "auth_provider_x509_cert_url": { 13751 "description": "GCP Authentication provider x509 certificate url", 13752 "type": "string" 13753 }, 13754 "authentication": { 13755 "description": "GCP Authentication Method", 13756 "$ref": "#/components/schemas/GcpAuthentication" 13757 }, 13758 "client_id": { 13759 "description": "GCP client identifier", 13760 "type": "string" 13761 }, 13762 "client_x509_cert_url": { 13763 "description": "GCP client x509 certificate url", 13764 "type": "string" 13765 }, 13766 "client_email": { 13767 "description": "GCP client email", 13768 "type": "string" 13769 }, 13770 "private_key": { 13771 "description": "GCP private key", 13772 "type": "string" 13773 }, 13774 "private_key_id": { 13775 "description": "GCP private key identifier", 13776 "type": "string" 13777 }, 13778 "private_service_connect": { 13779 "description": "GCP PrivateServiceConnect configuration", 13780 "$ref": "#/components/schemas/GcpPrivateServiceConnect" 13781 }, 13782 "project_id": { 13783 "description": "GCP project identifier.", 13784 "type": "string" 13785 }, 13786 "security": { 13787 "description": "GCP Security Settings", 13788 "$ref": "#/components/schemas/GcpSecurity" 13789 }, 13790 "token_uri": { 13791 "description": "GCP token uri", 13792 "type": "string" 13793 }, 13794 "type": { 13795 "description": "GCP the type of the service the key belongs to", 13796 "type": "string" 13797 } 13798 } 13799 }, 13800 "GCPEncryptionKey": { 13801 "description": "GCP Encryption Key for CCS clusters.", 13802 "properties": { 13803 "kms_key_service_account": { 13804 "description": "Service account used to access the KMS key", 13805 "type": "string" 13806 }, 13807 "key_location": { 13808 "description": "Location of the encryption key ring", 13809 "type": "string" 13810 }, 13811 "key_name": { 13812 "description": "Name of the encryption key", 13813 "type": "string" 13814 }, 13815 "key_ring": { 13816 "description": "Name of the key ring the encryption key is located on", 13817 "type": "string" 13818 } 13819 } 13820 }, 13821 "GCPFlavour": { 13822 "description": "Specification for different classes of nodes inside a flavour.", 13823 "properties": { 13824 "compute_instance_type": { 13825 "description": "GCP default instance type for the worker volume.\n\nUser can be overridden specifying in the cluster itself a type for compute node.", 13826 "type": "string" 13827 }, 13828 "infra_instance_type": { 13829 "description": "GCP default instance type for the infra volume.", 13830 "type": "string" 13831 }, 13832 "infra_volume": { 13833 "description": "Infra volume specification.", 13834 "$ref": "#/components/schemas/GCPVolume" 13835 }, 13836 "master_instance_type": { 13837 "description": "GCP default instance type for the master volume.", 13838 "type": "string" 13839 }, 13840 "master_volume": { 13841 "description": "Master volume specification.", 13842 "$ref": "#/components/schemas/GCPVolume" 13843 }, 13844 "worker_volume": { 13845 "description": "Worker volume specification.", 13846 "$ref": "#/components/schemas/GCPVolume" 13847 } 13848 } 13849 }, 13850 "GCPImageOverride": { 13851 "description": "GcpImageOverride specifies what a GCP VM Image should be used for a particular product and billing model", 13852 "properties": { 13853 "kind": { 13854 "description": "Indicates the type of this object. Will be 'GCPImageOverride' if this is a complete object or 'GCPImageOverrideLink' if it is just a link.", 13855 "type": "string" 13856 }, 13857 "id": { 13858 "description": "Unique identifier of the object.", 13859 "type": "string" 13860 }, 13861 "href": { 13862 "description": "Self link.", 13863 "type": "string" 13864 }, 13865 "billing_model": { 13866 "description": "Link to the billing model.", 13867 "$ref": "#/components/schemas/BillingModelItem" 13868 }, 13869 "image_id": { 13870 "description": "ImageID is the id of the Google Cloud Platform image.", 13871 "type": "string" 13872 }, 13873 "product": { 13874 "description": "Link to the product type.", 13875 "$ref": "#/components/schemas/Product" 13876 }, 13877 "project_id": { 13878 "description": "ProjectID is the id of the Google Cloud Platform project that hosts the image.", 13879 "type": "string" 13880 } 13881 } 13882 }, 13883 "GCPMachinePool": { 13884 "description": "Representation of gcp machine pool specific parameters.", 13885 "properties": { 13886 "secure_boot": { 13887 "description": "Determines whether the Shielded VM's SecureBoot feature should be\nenabled for the nodes of the machine pool. If SecureBoot is not\nspecified, the value of this attribute will remain unspecified and the\nSecureBoot's value specified in the `.gcp.security.secure_boot`\nattribute of the parent Cluster will be the one applied to the nodes of\nthe machine pool.\nImmutable.", 13888 "type": "boolean" 13889 } 13890 } 13891 }, 13892 "GCPNetwork": { 13893 "description": "GCP Network configuration of a cluster.", 13894 "properties": { 13895 "vpc_name": { 13896 "description": "VPC mame used by the cluster.", 13897 "type": "string" 13898 }, 13899 "vpc_project_id": { 13900 "description": "The name of the host project where the shared VPC exists.", 13901 "type": "string" 13902 }, 13903 "compute_subnet": { 13904 "description": "Compute subnet used by the cluster.", 13905 "type": "string" 13906 }, 13907 "control_plane_subnet": { 13908 "description": "Control plane subnet used by the cluster.", 13909 "type": "string" 13910 } 13911 } 13912 }, 13913 "GCPVolume": { 13914 "description": "Holds settings for an GCP storage volume.", 13915 "properties": { 13916 "size": { 13917 "description": "Volume size in Gib.", 13918 "type": "integer", 13919 "format": "int32" 13920 } 13921 } 13922 }, 13923 "HTPasswdIdentityProvider": { 13924 "description": "Details for `htpasswd` identity providers.", 13925 "properties": { 13926 "password": { 13927 "description": "Password to be used in the _HTPasswd_ data file.", 13928 "type": "string" 13929 }, 13930 "username": { 13931 "description": "Username to be used in the _HTPasswd_ data file.", 13932 "type": "string" 13933 }, 13934 "users": { 13935 "description": "Link to the collection of _HTPasswd_ users.", 13936 "type": "array", 13937 "items": { 13938 "$ref": "#/components/schemas/HTPasswdUser" 13939 } 13940 } 13941 } 13942 }, 13943 "HTPasswdUser": { 13944 "properties": { 13945 "id": { 13946 "description": "ID for a secondary user in the _HTPasswd_ data file.", 13947 "type": "string" 13948 }, 13949 "hashed_password": { 13950 "description": "HTPasswd Hashed Password for a user in the _HTPasswd_ data file.\nThe value of this field is set as-is in the _HTPasswd_ data file for the HTPasswd IDP", 13951 "type": "string" 13952 }, 13953 "password": { 13954 "description": "Password in plain-text for a user in the _HTPasswd_ data file.\nThe value of this field is hashed before setting it in the _HTPasswd_ data file for the HTPasswd IDP", 13955 "type": "string" 13956 }, 13957 "username": { 13958 "description": "Username for a secondary user in the _HTPasswd_ data file.", 13959 "type": "string" 13960 } 13961 } 13962 }, 13963 "LDAPAttributes": { 13964 "description": "LDAP attributes used to configure the LDAP identity provider.", 13965 "properties": { 13966 "id": { 13967 "description": "List of attributes to use as the identity.", 13968 "type": "array", 13969 "items": { 13970 "type": "string" 13971 } 13972 }, 13973 "email": { 13974 "description": "List of attributes to use as the mail address.", 13975 "type": "array", 13976 "items": { 13977 "type": "string" 13978 } 13979 }, 13980 "name": { 13981 "description": "List of attributes to use as the display name.", 13982 "type": "array", 13983 "items": { 13984 "type": "string" 13985 } 13986 }, 13987 "preferred_username": { 13988 "description": "List of attributes to use as the preferred user name when provisioning a user.", 13989 "type": "array", 13990 "items": { 13991 "type": "string" 13992 } 13993 } 13994 } 13995 }, 13996 "LDAPIdentityProvider": { 13997 "description": "Details for `ldap` identity providers.", 13998 "properties": { 13999 "ca": { 14000 "description": "Certificate bundle to use to validate server certificates for the configured URL.", 14001 "type": "string" 14002 }, 14003 "url": { 14004 "description": "An https://tools.ietf.org/html/rfc2255[RFC 2255] URL which specifies the LDAP host and\nsearch parameters to use.", 14005 "type": "string" 14006 }, 14007 "attributes": { 14008 "description": "LDAP attributes used to configure the provider.", 14009 "$ref": "#/components/schemas/LDAPAttributes" 14010 }, 14011 "bind_dn": { 14012 "description": "Optional distinguished name to use to bind during the search phase.", 14013 "type": "string" 14014 }, 14015 "bind_password": { 14016 "description": "Optional password to use to bind during the search phase.", 14017 "type": "string" 14018 }, 14019 "insecure": { 14020 "description": "When `true` no TLS connection is made to the server. When `false` `ldaps://...` URLs\nconnect using TLS and `ldap://...` are upgraded to TLS.", 14021 "type": "boolean" 14022 } 14023 } 14024 }, 14025 "STS": { 14026 "description": "Contains the necessary attributes to support role-based authentication on AWS.", 14027 "properties": { 14028 "oidc_endpoint_url": { 14029 "description": "URL of the location where OIDC configuration and keys are available", 14030 "type": "string" 14031 }, 14032 "auto_mode": { 14033 "description": "Auto creation mode for cluster - OCM will create the operator roles and OIDC provider. false by default.", 14034 "type": "boolean" 14035 }, 14036 "enabled": { 14037 "description": "If STS is enabled or disabled", 14038 "type": "boolean" 14039 }, 14040 "external_id": { 14041 "description": "Optional unique identifier when assuming role in another account", 14042 "type": "string" 14043 }, 14044 "instance_iam_roles": { 14045 "description": "Instance IAM roles to use for the instance profiles of the master and worker instances", 14046 "$ref": "#/components/schemas/InstanceIAMRoles" 14047 }, 14048 "managed_policies": { 14049 "description": "If true, cluster account and operator roles have managed policies attached.", 14050 "type": "boolean" 14051 }, 14052 "oidc_config": { 14053 "description": "Registered Oidc Config, if available holds information related to the oidc config.", 14054 "$ref": "#/components/schemas/OidcConfig" 14055 }, 14056 "operator_iam_roles": { 14057 "description": "List of roles necessary to access the AWS resources of the various operators used during installation", 14058 "type": "array", 14059 "items": { 14060 "$ref": "#/components/schemas/OperatorIAMRole" 14061 } 14062 }, 14063 "operator_role_prefix": { 14064 "description": "Optional user provided prefix for operator roles.", 14065 "type": "string" 14066 }, 14067 "permission_boundary": { 14068 "description": "Optional user provided permission boundary.", 14069 "type": "string" 14070 }, 14071 "role_arn": { 14072 "description": "ARN of the AWS role to assume when installing the cluster", 14073 "type": "string" 14074 }, 14075 "support_role_arn": { 14076 "description": "ARN of the AWS role used by SREs to access the cluster AWS account in order to provide support", 14077 "type": "string" 14078 } 14079 } 14080 }, 14081 "STSCredentialRequest": { 14082 "description": "Representation of an credRequest", 14083 "properties": { 14084 "name": { 14085 "description": "Name of CredRequest", 14086 "type": "string" 14087 }, 14088 "operator": { 14089 "description": "Operator Details", 14090 "$ref": "#/components/schemas/STSOperator" 14091 } 14092 } 14093 }, 14094 "STSOperator": { 14095 "description": "Representation of an sts operator", 14096 "properties": { 14097 "max_version": { 14098 "description": "Maximum ocp version supported", 14099 "type": "string" 14100 }, 14101 "min_version": { 14102 "description": "Minimum ocp version supported", 14103 "type": "string" 14104 }, 14105 "name": { 14106 "description": "Operator Name", 14107 "type": "string" 14108 }, 14109 "namespace": { 14110 "description": "Operator Namespace", 14111 "type": "string" 14112 }, 14113 "service_accounts": { 14114 "description": "Service Accounts", 14115 "type": "array", 14116 "items": { 14117 "type": "string" 14118 } 14119 } 14120 } 14121 }, 14122 "AddOn": { 14123 "description": "Representation of an add-on that can be installed in a cluster.", 14124 "properties": { 14125 "kind": { 14126 "description": "Indicates the type of this object. Will be 'AddOn' if this is a complete object or 'AddOnLink' if it is just a link.", 14127 "type": "string" 14128 }, 14129 "id": { 14130 "description": "Unique identifier of the object.", 14131 "type": "string" 14132 }, 14133 "href": { 14134 "description": "Self link.", 14135 "type": "string" 14136 }, 14137 "common_annotations": { 14138 "description": "Common annotations to be applied to all resources created by this addon.", 14139 "type": "object", 14140 "additionalProperties": { 14141 "type": "string" 14142 } 14143 }, 14144 "common_labels": { 14145 "description": "Common labels to be applied to all resources created by this addon.", 14146 "type": "object", 14147 "additionalProperties": { 14148 "type": "string" 14149 } 14150 }, 14151 "config": { 14152 "description": "Additional configs to be used by the addon once its installed in the cluster.", 14153 "$ref": "#/components/schemas/AddOnConfig" 14154 }, 14155 "credentials_requests": { 14156 "description": "List of credentials requests to authenticate operators to access cloud resources.", 14157 "type": "array", 14158 "items": { 14159 "$ref": "#/components/schemas/CredentialRequest" 14160 } 14161 }, 14162 "description": { 14163 "description": "Description of the add-on.", 14164 "type": "string" 14165 }, 14166 "docs_link": { 14167 "description": "Link to documentation about the add-on.", 14168 "type": "string" 14169 }, 14170 "enabled": { 14171 "description": "Indicates if this add-on can be added to clusters.", 14172 "type": "boolean" 14173 }, 14174 "has_external_resources": { 14175 "description": "Indicates if this add-on has external resources associated with it", 14176 "type": "boolean" 14177 }, 14178 "hidden": { 14179 "description": "Indicates if this add-on is hidden.", 14180 "type": "boolean" 14181 }, 14182 "icon": { 14183 "description": "Base64-encoded icon representing an add-on. The icon should be in PNG format.", 14184 "type": "string" 14185 }, 14186 "install_mode": { 14187 "description": "The mode in which the addon is deployed.", 14188 "$ref": "#/components/schemas/AddOnInstallMode" 14189 }, 14190 "label": { 14191 "description": "Label used to attach to a cluster deployment when add-on is installed.", 14192 "type": "string" 14193 }, 14194 "managed_service": { 14195 "description": "Indicates if add-on is part of a managed service", 14196 "type": "boolean" 14197 }, 14198 "name": { 14199 "description": "Name of the add-on.", 14200 "type": "string" 14201 }, 14202 "namespaces": { 14203 "description": "Namespaces which are required by this addon.", 14204 "type": "array", 14205 "items": { 14206 "$ref": "#/components/schemas/AddOnNamespace" 14207 } 14208 }, 14209 "operator_name": { 14210 "description": "The name of the operator installed by this add-on.", 14211 "type": "string" 14212 }, 14213 "parameters": { 14214 "description": "List of parameters for this add-on.", 14215 "type": "array", 14216 "items": { 14217 "$ref": "#/components/schemas/AddOnParameter" 14218 } 14219 }, 14220 "requirements": { 14221 "description": "List of requirements for this add-on.", 14222 "type": "array", 14223 "items": { 14224 "$ref": "#/components/schemas/AddOnRequirement" 14225 } 14226 }, 14227 "resource_cost": { 14228 "description": "Used to determine how many units of quota an add-on consumes per resource name.", 14229 "type": "number", 14230 "format": "float" 14231 }, 14232 "resource_name": { 14233 "description": "Used to determine from where to reserve quota for this add-on.", 14234 "type": "string" 14235 }, 14236 "sub_operators": { 14237 "description": "List of sub operators for this add-on.", 14238 "type": "array", 14239 "items": { 14240 "$ref": "#/components/schemas/AddOnSubOperator" 14241 } 14242 }, 14243 "target_namespace": { 14244 "description": "The namespace in which the addon CRD exists.", 14245 "type": "string" 14246 }, 14247 "version": { 14248 "description": "Link to the current default version of this add-on.", 14249 "$ref": "#/components/schemas/AddOnVersion" 14250 } 14251 } 14252 }, 14253 "AddOnConfig": { 14254 "description": "Representation of an add-on config.\nThe attributes under it are to be used by the addon once its installed in the cluster.", 14255 "properties": { 14256 "kind": { 14257 "description": "Indicates the type of this object. Will be 'AddOnConfig' if this is a complete object or 'AddOnConfigLink' if it is just a link.", 14258 "type": "string" 14259 }, 14260 "id": { 14261 "description": "Unique identifier of the object.", 14262 "type": "string" 14263 }, 14264 "href": { 14265 "description": "Self link.", 14266 "type": "string" 14267 }, 14268 "add_on_environment_variables": { 14269 "description": "List of environment variables for the addon", 14270 "type": "array", 14271 "items": { 14272 "$ref": "#/components/schemas/AddOnEnvironmentVariable" 14273 } 14274 }, 14275 "secret_propagations": { 14276 "description": "List of secret propagations for the addon", 14277 "type": "array", 14278 "items": { 14279 "$ref": "#/components/schemas/AddOnSecretPropagation" 14280 } 14281 } 14282 } 14283 }, 14284 "AddOnEnvironmentVariable": { 14285 "description": "Representation of an add-on env object.", 14286 "properties": { 14287 "kind": { 14288 "description": "Indicates the type of this object. Will be 'AddOnEnvironmentVariable' if this is a complete object or 'AddOnEnvironmentVariableLink' if it is just a link.", 14289 "type": "string" 14290 }, 14291 "id": { 14292 "description": "Unique identifier of the object.", 14293 "type": "string" 14294 }, 14295 "href": { 14296 "description": "Self link.", 14297 "type": "string" 14298 }, 14299 "name": { 14300 "description": "Name of the env object.", 14301 "type": "string" 14302 }, 14303 "value": { 14304 "description": "Value of the env object.", 14305 "type": "string" 14306 } 14307 } 14308 }, 14309 "AddOnInstallMode": { 14310 "description": "Representation of an add-on InstallMode field.", 14311 "type": "string", 14312 "enum": [ 14313 "all_namespaces", 14314 "own_namespace" 14315 ] 14316 }, 14317 "AddOnInstallation": { 14318 "description": "Representation of an add-on installation in a cluster.", 14319 "properties": { 14320 "kind": { 14321 "description": "Indicates the type of this object. Will be 'AddOnInstallation' if this is a complete object or 'AddOnInstallationLink' if it is just a link.", 14322 "type": "string" 14323 }, 14324 "id": { 14325 "description": "Unique identifier of the object.", 14326 "type": "string" 14327 }, 14328 "href": { 14329 "description": "Self link.", 14330 "type": "string" 14331 }, 14332 "addon": { 14333 "description": "Link to add-on attached to this cluster.", 14334 "$ref": "#/components/schemas/AddOn" 14335 }, 14336 "addon_version": { 14337 "description": "Link to the installed version of this add-on.", 14338 "$ref": "#/components/schemas/AddOnVersion" 14339 }, 14340 "billing": { 14341 "description": "Billing details for add-on installation resource ", 14342 "$ref": "#/components/schemas/AddOnInstallationBilling" 14343 }, 14344 "creation_timestamp": { 14345 "description": "Date and time when the add-on was initially installed in the cluster.", 14346 "type": "string", 14347 "format": "date-time" 14348 }, 14349 "operator_version": { 14350 "description": "Version of the operator installed by the add-on.", 14351 "type": "string" 14352 }, 14353 "parameters": { 14354 "description": "List of add-on parameters for this add-on installation.", 14355 "type": "array", 14356 "items": { 14357 "$ref": "#/components/schemas/AddOnInstallationParameter" 14358 } 14359 }, 14360 "state": { 14361 "description": "Overall state of the add-on installation.", 14362 "$ref": "#/components/schemas/AddOnInstallationState" 14363 }, 14364 "state_description": { 14365 "description": "Reason for the current State.", 14366 "type": "string" 14367 }, 14368 "updated_timestamp": { 14369 "description": "Date and time when the add-on installation information was last updated.", 14370 "type": "string", 14371 "format": "date-time" 14372 } 14373 } 14374 }, 14375 "AddOnInstallationBilling": { 14376 "description": "Representation of an add-on installation billing.", 14377 "properties": { 14378 "kind": { 14379 "description": "Indicates the type of this object. Will be 'AddOnInstallationBilling' if this is a complete object or 'AddOnInstallationBillingLink' if it is just a link.", 14380 "type": "string" 14381 }, 14382 "id": { 14383 "description": "Unique identifier of the object.", 14384 "type": "string" 14385 }, 14386 "href": { 14387 "description": "Self link.", 14388 "type": "string" 14389 }, 14390 "billing_marketplace_account": { 14391 "description": "Account ID for billing market place", 14392 "type": "string" 14393 }, 14394 "billing_model": { 14395 "description": "Billing Model for addon resources", 14396 "$ref": "#/components/schemas/BillingModel" 14397 } 14398 } 14399 }, 14400 "AddOnInstallationParameter": { 14401 "description": "Representation of an add-on installation parameter.", 14402 "properties": { 14403 "kind": { 14404 "description": "Indicates the type of this object. Will be 'AddOnInstallationParameter' if this is a complete object or 'AddOnInstallationParameterLink' if it is just a link.", 14405 "type": "string" 14406 }, 14407 "id": { 14408 "description": "Unique identifier of the object.", 14409 "type": "string" 14410 }, 14411 "href": { 14412 "description": "Self link.", 14413 "type": "string" 14414 }, 14415 "value": { 14416 "description": "Value of the parameter.", 14417 "type": "string" 14418 } 14419 } 14420 }, 14421 "AddOnInstallationState": { 14422 "description": "Representation of an add-on installation State field.", 14423 "type": "string", 14424 "enum": [ 14425 "deleting", 14426 "failed", 14427 "installing", 14428 "pending", 14429 "ready" 14430 ] 14431 }, 14432 "AddOnNamespace": { 14433 "properties": { 14434 "kind": { 14435 "description": "Indicates the type of this object. Will be 'AddOnNamespace' if this is a complete object or 'AddOnNamespaceLink' if it is just a link.", 14436 "type": "string" 14437 }, 14438 "id": { 14439 "description": "Unique identifier of the object.", 14440 "type": "string" 14441 }, 14442 "href": { 14443 "description": "Self link.", 14444 "type": "string" 14445 }, 14446 "annotations": { 14447 "description": "Annotations to be applied to this namespace.", 14448 "type": "object", 14449 "additionalProperties": { 14450 "type": "string" 14451 } 14452 }, 14453 "labels": { 14454 "description": "Labels to be applied to this namespace.", 14455 "type": "object", 14456 "additionalProperties": { 14457 "type": "string" 14458 } 14459 }, 14460 "name": { 14461 "description": "Name of the namespace.", 14462 "type": "string" 14463 } 14464 } 14465 }, 14466 "AddOnParameter": { 14467 "description": "Representation of an add-on parameter.", 14468 "properties": { 14469 "kind": { 14470 "description": "Indicates the type of this object. Will be 'AddOnParameter' if this is a complete object or 'AddOnParameterLink' if it is just a link.", 14471 "type": "string" 14472 }, 14473 "id": { 14474 "description": "Unique identifier of the object.", 14475 "type": "string" 14476 }, 14477 "href": { 14478 "description": "Self link.", 14479 "type": "string" 14480 }, 14481 "addon": { 14482 "description": "Link to add-on.", 14483 "$ref": "#/components/schemas/AddOn" 14484 }, 14485 "conditions": { 14486 "description": "Conditions in which this parameter is valid for", 14487 "type": "array", 14488 "items": { 14489 "$ref": "#/components/schemas/AddOnRequirement" 14490 } 14491 }, 14492 "default_value": { 14493 "description": "Indicates the value default for the add-on parameter.", 14494 "type": "string" 14495 }, 14496 "description": { 14497 "description": "Description of the add-on parameter.", 14498 "type": "string" 14499 }, 14500 "editable": { 14501 "description": "Indicates if this parameter can be edited after creation.", 14502 "type": "boolean" 14503 }, 14504 "editable_direction": { 14505 "description": "Restricts if the parameter can be upscaled/downscaled\nExpected values are \"up\", \"down\", or \"\" (no restriction).", 14506 "type": "string" 14507 }, 14508 "enabled": { 14509 "description": "Indicates if this parameter is enabled for the add-on.", 14510 "type": "boolean" 14511 }, 14512 "name": { 14513 "description": "Name of the add-on parameter.", 14514 "type": "string" 14515 }, 14516 "options": { 14517 "description": "List of options for the add-on parameter value.", 14518 "type": "array", 14519 "items": { 14520 "$ref": "#/components/schemas/AddOnParameterOption" 14521 } 14522 }, 14523 "required": { 14524 "description": "Indicates if this parameter is required by the add-on.", 14525 "type": "boolean" 14526 }, 14527 "validation": { 14528 "description": "Validation rule for the add-on parameter.", 14529 "type": "string" 14530 }, 14531 "validation_err_msg": { 14532 "description": "Error message to return should the parameter be invalid.", 14533 "type": "string" 14534 }, 14535 "value_type": { 14536 "description": "Type of value of the add-on parameter.", 14537 "type": "string" 14538 } 14539 } 14540 }, 14541 "AddOnParameterOption": { 14542 "description": "Representation of an add-on parameter option.", 14543 "properties": { 14544 "name": { 14545 "description": "Name of the add-on parameter option.", 14546 "type": "string" 14547 }, 14548 "rank": { 14549 "description": "Rank of option to be used in cases where editable direction should be restricted.", 14550 "type": "integer", 14551 "format": "int32" 14552 }, 14553 "requirements": { 14554 "description": "List of add-on requirements for this parameter option.", 14555 "type": "array", 14556 "items": { 14557 "$ref": "#/components/schemas/AddOnRequirement" 14558 } 14559 }, 14560 "value": { 14561 "description": "Value of the add-on parameter option.", 14562 "type": "string" 14563 } 14564 } 14565 }, 14566 "AddOnRequirement": { 14567 "description": "Representation of an add-on requirement.", 14568 "properties": { 14569 "id": { 14570 "description": "ID of the add-on requirement.", 14571 "type": "string" 14572 }, 14573 "data": { 14574 "description": "Data for the add-on requirement.", 14575 "type": "object", 14576 "additionalProperties": { 14577 "type": "object" 14578 } 14579 }, 14580 "enabled": { 14581 "description": "Indicates if this requirement is enabled for the add-on.", 14582 "type": "boolean" 14583 }, 14584 "resource": { 14585 "description": "Type of resource of the add-on requirement.", 14586 "type": "string" 14587 }, 14588 "status": { 14589 "description": "Optional cluster specific status for the add-on.", 14590 "$ref": "#/components/schemas/AddOnRequirementStatus" 14591 } 14592 } 14593 }, 14594 "AddOnRequirementStatus": { 14595 "description": "Representation of an add-on requirement status.", 14596 "properties": { 14597 "error_msgs": { 14598 "description": "Error messages detailing reasons for unfulfilled requirements.", 14599 "type": "array", 14600 "items": { 14601 "type": "string" 14602 } 14603 }, 14604 "fulfilled": { 14605 "description": "Indicates if this requirement is fulfilled.", 14606 "type": "boolean" 14607 } 14608 } 14609 }, 14610 "AddOnSecretPropagation": { 14611 "description": "Representation of an addon secret propagation", 14612 "properties": { 14613 "id": { 14614 "description": "ID of the secret propagation", 14615 "type": "string" 14616 }, 14617 "destination_secret": { 14618 "description": "DestinationSecret is location of the secret to be added", 14619 "type": "string" 14620 }, 14621 "enabled": { 14622 "description": "Indicates is this secret propagation is enabled for the addon", 14623 "type": "boolean" 14624 }, 14625 "source_secret": { 14626 "description": "SourceSecret is location of the source secret", 14627 "type": "string" 14628 } 14629 } 14630 }, 14631 "AddOnSubOperator": { 14632 "description": "Representation of an add-on sub operator. A sub operator is an operator\nwho's life cycle is controlled by the add-on umbrella operator. ", 14633 "properties": { 14634 "enabled": { 14635 "description": "Indicates if the sub operator is enabled for the add-on", 14636 "type": "boolean" 14637 }, 14638 "operator_name": { 14639 "description": "Name of the add-on sub operator", 14640 "type": "string" 14641 }, 14642 "operator_namespace": { 14643 "description": "Namespace of the add-on sub operator", 14644 "type": "string" 14645 } 14646 } 14647 }, 14648 "AddOnVersion": { 14649 "description": "Representation of an add-on version.", 14650 "properties": { 14651 "kind": { 14652 "description": "Indicates the type of this object. Will be 'AddOnVersion' if this is a complete object or 'AddOnVersionLink' if it is just a link.", 14653 "type": "string" 14654 }, 14655 "id": { 14656 "description": "Unique identifier of the object.", 14657 "type": "string" 14658 }, 14659 "href": { 14660 "description": "Self link.", 14661 "type": "string" 14662 }, 14663 "additional_catalog_sources": { 14664 "description": "Additional catalog sources associated with this addon version", 14665 "type": "array", 14666 "items": { 14667 "$ref": "#/components/schemas/AdditionalCatalogSource" 14668 } 14669 }, 14670 "available_upgrades": { 14671 "description": "AvailableUpgrades is the list of versions this version can be upgraded to.", 14672 "type": "array", 14673 "items": { 14674 "type": "string" 14675 } 14676 }, 14677 "channel": { 14678 "description": "The specific addon catalog source channel of packages", 14679 "type": "string" 14680 }, 14681 "config": { 14682 "description": "Additional configs to be used by the addon once its installed in the cluster.", 14683 "$ref": "#/components/schemas/AddOnConfig" 14684 }, 14685 "enabled": { 14686 "description": "Indicates if this add-on version can be added to clusters.", 14687 "type": "boolean" 14688 }, 14689 "package_image": { 14690 "description": "The package image for this addon version", 14691 "type": "string" 14692 }, 14693 "parameters": { 14694 "description": "List of parameters for this add-on version.", 14695 "type": "array", 14696 "items": { 14697 "$ref": "#/components/schemas/AddOnParameter" 14698 } 14699 }, 14700 "pull_secret_name": { 14701 "description": "The pull secret name used for this addon version.", 14702 "type": "string" 14703 }, 14704 "requirements": { 14705 "description": "List of requirements for this add-on version.", 14706 "type": "array", 14707 "items": { 14708 "$ref": "#/components/schemas/AddOnRequirement" 14709 } 14710 }, 14711 "source_image": { 14712 "description": "The catalog source image for this add-on version.", 14713 "type": "string" 14714 }, 14715 "sub_operators": { 14716 "description": "List of sub operators for this add-on version.", 14717 "type": "array", 14718 "items": { 14719 "$ref": "#/components/schemas/AddOnSubOperator" 14720 } 14721 } 14722 } 14723 }, 14724 "AdditionalCatalogSource": { 14725 "description": "Representation of an addon catalog source object used by addon versions.", 14726 "properties": { 14727 "id": { 14728 "description": "ID of the additional catalog source", 14729 "type": "string" 14730 }, 14731 "enabled": { 14732 "description": "Indicates is this additional catalog source is enabled for the addon", 14733 "type": "boolean" 14734 }, 14735 "image": { 14736 "description": "Image of the additional catalog source.", 14737 "type": "string" 14738 }, 14739 "name": { 14740 "description": "Name of the additional catalog source.", 14741 "type": "string" 14742 } 14743 } 14744 }, 14745 "AddonUpgradePolicy": { 14746 "description": "Representation of an upgrade policy that can be set for a cluster.", 14747 "properties": { 14748 "kind": { 14749 "description": "Indicates the type of this object. Will be 'AddonUpgradePolicy' if this is a complete object or 'AddonUpgradePolicyLink' if it is just a link.", 14750 "type": "string" 14751 }, 14752 "id": { 14753 "description": "Unique identifier of the object.", 14754 "type": "string" 14755 }, 14756 "href": { 14757 "description": "Self link.", 14758 "type": "string" 14759 }, 14760 "addon_id": { 14761 "description": "Addon ID this upgrade policy is defined for", 14762 "type": "string" 14763 }, 14764 "cluster_id": { 14765 "description": "Cluster ID this upgrade policy is defined for.", 14766 "type": "string" 14767 }, 14768 "next_run": { 14769 "description": "Next time the upgrade should run.", 14770 "type": "string", 14771 "format": "date-time" 14772 }, 14773 "schedule": { 14774 "description": "Schedule cron expression that defines automatic upgrade scheduling.", 14775 "type": "string" 14776 }, 14777 "schedule_type": { 14778 "description": "Schedule type can be either \"manual\" (single execution) or \"automatic\" (re-occurring).", 14779 "type": "string" 14780 }, 14781 "upgrade_type": { 14782 "description": "Upgrade type specify the type of the upgrade. Must be \"ADDON\".", 14783 "type": "string" 14784 }, 14785 "version": { 14786 "description": "Version is the desired upgrade version.", 14787 "type": "string" 14788 } 14789 } 14790 }, 14791 "AddonUpgradePolicyState": { 14792 "description": "Representation of an addon upgrade policy state that that is set for a cluster.", 14793 "properties": { 14794 "kind": { 14795 "description": "Indicates the type of this object. Will be 'AddonUpgradePolicyState' if this is a complete object or 'AddonUpgradePolicyStateLink' if it is just a link.", 14796 "type": "string" 14797 }, 14798 "id": { 14799 "description": "Unique identifier of the object.", 14800 "type": "string" 14801 }, 14802 "href": { 14803 "description": "Self link.", 14804 "type": "string" 14805 }, 14806 "description": { 14807 "description": "Description of the state.", 14808 "type": "string" 14809 }, 14810 "value": { 14811 "description": "State value can be 'pending', 'scheduled', 'cancelled', 'started', 'delayed',\n'failed' or 'completed'.", 14812 "$ref": "#/components/schemas/UpgradePolicyStateValue" 14813 } 14814 } 14815 }, 14816 "AdminCredentials": { 14817 "description": "Temporary administrator credentials generated during the installation of the\ncluster.", 14818 "properties": { 14819 "password": { 14820 "description": "Cluster administrator password.", 14821 "type": "string" 14822 }, 14823 "user": { 14824 "description": "Cluster administrator user name.", 14825 "type": "string" 14826 } 14827 } 14828 }, 14829 "AlertInfo": { 14830 "description": "Provides information about a single alert firing on the cluster.", 14831 "properties": { 14832 "name": { 14833 "description": "The alert name. Multiple alerts with same name are possible.", 14834 "type": "string" 14835 }, 14836 "severity": { 14837 "description": "The alert severity.", 14838 "$ref": "#/components/schemas/AlertSeverity" 14839 } 14840 } 14841 }, 14842 "AlertSeverity": { 14843 "description": "Severity of a cluster alert received via telemetry.", 14844 "type": "string", 14845 "enum": [ 14846 "critical", 14847 "none", 14848 "warning" 14849 ] 14850 }, 14851 "AlertsInfo": { 14852 "description": "Provides information about the alerts firing on the cluster.", 14853 "properties": { 14854 "alerts": { 14855 "type": "array", 14856 "items": { 14857 "$ref": "#/components/schemas/AlertInfo" 14858 } 14859 } 14860 } 14861 }, 14862 "AuditLog": { 14863 "description": "Contains the necessary attributes to support audit log forwarding", 14864 "properties": { 14865 "role_arn": { 14866 "description": "ARN of the CloudWatch audit log forwarding role", 14867 "type": "string" 14868 } 14869 } 14870 }, 14871 "AutoscalerResourceLimits": { 14872 "properties": { 14873 "gpus": { 14874 "description": "Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>.\nCluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.", 14875 "type": "array", 14876 "items": { 14877 "$ref": "#/components/schemas/AutoscalerResourceLimitsGPULimit" 14878 } 14879 }, 14880 "cores": { 14881 "description": "Minimum and maximum number of cores in cluster, in the format <min>:<max>.\nCluster autoscaler will not scale the cluster beyond these numbers.", 14882 "$ref": "#/components/schemas/ResourceRange" 14883 }, 14884 "max_nodes_total": { 14885 "description": "Maximum number of nodes in all node groups.\nCluster autoscaler will not grow the cluster beyond this number.", 14886 "type": "integer", 14887 "format": "int32" 14888 }, 14889 "memory": { 14890 "description": "Minimum and maximum number of gigabytes of memory in cluster, in the format <min>:<max>.\nCluster autoscaler will not scale the cluster beyond these numbers.", 14891 "$ref": "#/components/schemas/ResourceRange" 14892 } 14893 } 14894 }, 14895 "AutoscalerResourceLimitsGPULimit": { 14896 "properties": { 14897 "range": { 14898 "$ref": "#/components/schemas/ResourceRange" 14899 }, 14900 "type": { 14901 "description": "The type of GPU to associate with the minimum and maximum limits.\nThis value is used by the Cluster Autoscaler to identify Nodes that will have GPU capacity by searching\nfor it as a label value on the Node objects. For example, Nodes that carry the label key\n`cluster-api/accelerator` with the label value being the same as the Type field will be counted towards\nthe resource limits by the Cluster Autoscaler.", 14902 "type": "string" 14903 } 14904 } 14905 }, 14906 "AutoscalerScaleDownConfig": { 14907 "properties": { 14908 "delay_after_add": { 14909 "description": "How long after scale up that scale down evaluation resumes.", 14910 "type": "string" 14911 }, 14912 "delay_after_delete": { 14913 "description": "How long after node deletion that scale down evaluation resumes, defaults to scan-interval.", 14914 "type": "string" 14915 }, 14916 "delay_after_failure": { 14917 "description": "How long after scale down failure that scale down evaluation resumes.", 14918 "type": "string" 14919 }, 14920 "enabled": { 14921 "description": "Should cluster-autoscaler scale down the cluster.", 14922 "type": "boolean" 14923 }, 14924 "unneeded_time": { 14925 "description": "How long a node should be unneeded before it is eligible for scale down.", 14926 "type": "string" 14927 }, 14928 "utilization_threshold": { 14929 "description": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", 14930 "type": "string" 14931 } 14932 } 14933 }, 14934 "AwsEtcdEncryption": { 14935 "description": "Contains the necessary attributes to support etcd encryption for AWS based clusters.", 14936 "properties": { 14937 "kms_key_arn": { 14938 "description": "ARN of the KMS to be used for the etcd encryption", 14939 "type": "string" 14940 } 14941 } 14942 }, 14943 "Azure": { 14944 "description": "Microsoft Azure settings of a cluster.", 14945 "properties": { 14946 "etcd_encryption": { 14947 "description": "Etcd encryption configuration.\nIf not specified, etcd data is encrypted with platform managed keys.\nCurrently etcd data encryption is only supported with customer managed keys.\nCreating a cluster with platform managed keys will result in a failure creating the cluster.", 14948 "$ref": "#/components/schemas/AzureEtcdEncryption" 14949 }, 14950 "managed_resource_group_name": { 14951 "description": "The desired name of the Azure Resource Group where the Azure Resources related\nto the cluster are created. It must not previously exist. The Azure Resource\nGroup is created with the given value, within the Azure Subscription\n`subscription_id` of the cluster.\n`managed_resource_group_name` cannot be equal to the value of `managed_resource_group`.\n`managed_resource_group_name` is located in the same Azure location as the\ncluster's region.\nNot to be confused with `resource_group_name`, which is the Azure Resource Group Name\nwhere the own Azure Resource associated to the cluster resides.\nRequired during creation.\nImmutable.", 14952 "type": "string" 14953 }, 14954 "network_security_group_resource_id": { 14955 "description": "The Azure Resource ID of a pre-existing Azure Network Security Group.\nThe Network Security Group specified in network_security_group_resource_id\nmust already be associated to the Azure Subnet `subnet_resource_id`.\nIt is the Azure Network Security Group associated to the cluster's subnet\nspecified in `subnet_resource_id`.\n`network_security_group_resource_id` must be located in the same Azure\nlocation as the cluster's region.\nThe Azure Subscription specified as part of\n`network_security_group_resource_id` must be located in the same Azure\nSubscription as `subscription_id`.\nThe Azure Resource Group Name specified as part of `network_security_group_resource_id`\nmust belong to the Azure Subscription `subscription_id`, and in the same\nAzure location as the cluster's region.\nThe Azure Resource Group Name specified as part of `network_security_group_resource_id`\nmust be a different Resource Group Name than the one specified in\n`managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of `network_security_group_resource_id`\ncan be the same, or a different one than the one specified in\n`resource_group_name`.\nRequired during creation.\nImmutable.", 14956 "type": "string" 14957 }, 14958 "nodes_outbound_connectivity": { 14959 "description": "NodesOutboundConnectivity defines how the network outbound\nconfiguration of the Cluster's Node Pool's Nodes is performed.\nBy default this is configured as Azure Load Balancer. This value is immutable.", 14960 "$ref": "#/components/schemas/AzureNodesOutboundConnectivity" 14961 }, 14962 "operators_authentication": { 14963 "description": "Defines how the operators of the cluster authenticate to Azure.\nRequired during creation.\nImmutable.", 14964 "$ref": "#/components/schemas/AzureOperatorsAuthentication" 14965 }, 14966 "resource_group_name": { 14967 "description": "The Azure Resource Group Name of the cluster. It must be a pre-existing\nAzure Resource Group and it must exist within the Azure Subscription\n`subscription_id` of the cluster.\n`resource_group_name` is located in the same Azure location as the\ncluster's region.\nRequired during creation.\nImmutable.", 14968 "type": "string" 14969 }, 14970 "resource_name": { 14971 "description": "The Azure Resource Name of the cluster. It must be within the\nAzure Resource Group Name `resource_group_name`.\n`resource_name` is located in the same Azure location as the cluster's region.\nRequired during creation.\nImmutable.", 14972 "type": "string" 14973 }, 14974 "subnet_resource_id": { 14975 "description": "The Azure Resource ID of a pre-existing Azure Subnet. It is an Azure\nSubnet used for the Data Plane of the cluster. `subnet_resource_id`\nmust be located in the same Azure location as the cluster's region.\nThe Azure Subscription specified as part of the `subnet_resource_id`\nmust be located in the same Azure Subscription as `subscription_id`.\nThe Azure Resource Group Name specified as part of `subnet_resource_id`\nmust belong to the Azure Subscription `subscription_id`, and in the same\nAzure location as the cluster's region.\nThe Azure Resource Group Name specified as part of `subnet_resource_id`\nmust be a different Resource Group Name than the one specified in\n`managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of the `subnet_resource_id`\ncan be the same, or a different one than the one specified in\n`resource_group_name`.\nRequired during creation.\nImmutable.", 14976 "type": "string" 14977 }, 14978 "subscription_id": { 14979 "description": "The Azure Subscription ID associated with the cluster. It must belong to\nthe Microsoft Entra Tenant ID `tenant_id`.\nRequired during creation.\nImmutable.", 14980 "type": "string" 14981 }, 14982 "tenant_id": { 14983 "description": "The Microsoft Entra Tenant ID where the cluster belongs.\nRequired during creation.\nImmutable.", 14984 "type": "string" 14985 } 14986 } 14987 }, 14988 "AzureControlPlaneManagedIdentity": { 14989 "description": "Represents the information associated to an Azure User-Assigned\nManaged Identity belonging to the Control Plane of the cluster.", 14990 "properties": { 14991 "client_id": { 14992 "description": "The Client ID associated to the Azure User-Assigned Managed Identity.\nReadonly.", 14993 "type": "string" 14994 }, 14995 "principal_id": { 14996 "description": "The Principal ID associated to the Azure User-Assigned Identity.\nReadonly.", 14997 "type": "string" 14998 }, 14999 "resource_id": { 15000 "description": "The Azure Resource ID of the Azure User-Assigned Managed\nIdentity. The managed identity represented must exist before\ncreating the cluster.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust belong to the Azure Subscription specified in `.azure.subscription_id`,\nand in the same Azure location as the cluster's region.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust be a different Resource Group Name than the one specified in\n`.azure.managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of the Resource ID\ncan be the same, or a different one than the one specified in\n`.azure.resource_group_name`.\nRequired during creation.\nImmutable.", 15001 "type": "string" 15002 } 15003 } 15004 }, 15005 "AzureDataPlaneManagedIdentity": { 15006 "description": "Represents the information associated to an Azure User-Assigned\nManaged Identity belonging to the Data Plane of the cluster.", 15007 "properties": { 15008 "resource_id": { 15009 "description": "The Azure Resource ID of the Azure User-Assigned Managed\nIdentity. The managed identity represented must exist before\ncreating the cluster.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust belong to the Azure Subscription specified in `.azure.subscription_id`,\nand in the same Azure location as the cluster's region.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust be a different Resource Group Name than the one specified in\n`.azure.managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of the Resource ID\ncan be the same, or a different one than the one specified in\n`.azure.resource_group_name`.\nRequired during creation.\nImmutable.", 15010 "type": "string" 15011 } 15012 } 15013 }, 15014 "AzureEtcdDataEncryption": { 15015 "description": "Contains the necessary attributes to support data encryption for Azure based clusters.", 15016 "properties": { 15017 "customer_managed": { 15018 "description": "Customer Managed encryption keys configuration.\nRequired when key_management_mode is \"customer_managed\".", 15019 "$ref": "#/components/schemas/AzureEtcdDataEncryptionCustomerManaged" 15020 }, 15021 "key_management_mode": { 15022 "description": "The key management strategy used for the encryption key that encrypts the etcd data.\nAccepted values are: \"customer_managed\", \"platform_managed\".\nBy default, \"platform_managed\" is used.\nCurrently only \"customer_managed\" mode is supported.", 15023 "type": "string" 15024 } 15025 } 15026 }, 15027 "AzureEtcdDataEncryptionCustomerManaged": { 15028 "description": "Contains the necessary attributes to support etcd data encryption with customer managed keys\nfor Azure based clusters.", 15029 "properties": { 15030 "encryption_type": { 15031 "description": "The encryption type used.\nAccepted values are: \"kms\".\nBy default, \"kms\" is used.", 15032 "type": "string" 15033 }, 15034 "kms": { 15035 "description": "The KMS encryption configuration.\nRequired when encryption_type is \"kms\".", 15036 "$ref": "#/components/schemas/AzureKmsEncryption" 15037 } 15038 } 15039 }, 15040 "AzureEtcdEncryption": { 15041 "description": "Contains the necessary attributes to support etcd encryption for Azure based clusters.", 15042 "properties": { 15043 "data_encryption": { 15044 "description": "etcd data encryption settings.\nIf not specified, etcd data is encrypted with platform managed keys.", 15045 "$ref": "#/components/schemas/AzureEtcdDataEncryption" 15046 } 15047 } 15048 }, 15049 "AzureKmsEncryption": { 15050 "description": "Contains the necessary attributes to support KMS encryption for Azure based clusters.", 15051 "properties": { 15052 "active_key": { 15053 "description": "The details of the active key\nRequired during creation.", 15054 "$ref": "#/components/schemas/AzureKmsKey" 15055 } 15056 } 15057 }, 15058 "AzureKmsKey": { 15059 "description": "Contains the necessary attributes to support KMS encryption key for Azure based clusters", 15060 "properties": { 15061 "key_name": { 15062 "description": "key_name is the name of the Azure Key Vault Key\nRequired during creation.", 15063 "type": "string" 15064 }, 15065 "key_vault_name": { 15066 "description": "key_vault_name is the name of the Azure Key Vault that contains the encryption key\nRequired during creation.", 15067 "type": "string" 15068 }, 15069 "key_version": { 15070 "description": "key_version is the version of the Azure Key Vault key\nRequired during creation.", 15071 "type": "string" 15072 } 15073 } 15074 }, 15075 "AzureNodePool": { 15076 "description": "Representation of azure node pool specific parameters.", 15077 "properties": { 15078 "os_disk_size_gibibytes": { 15079 "description": "The size in GiB to assign to the OS disks of the\nNodes in the Node Pool. The property\nis the number of bytes x 1024^3.\nIf not specified, OS disk size is 30 GiB.", 15080 "type": "integer", 15081 "format": "int32" 15082 }, 15083 "os_disk_storage_account_type": { 15084 "description": "The disk storage account type to use for the OS disks of the Nodes in the\nNode Pool. Valid values are:\n* Standard_LRS: HDD\n* StandardSSD_LRS: Standard SSD\n* Premium_LRS: Premium SDD\n* UltraSSD_LRS: Ultra SDD\n\nIf not specified, `Premium_LRS` is used.", 15085 "type": "string" 15086 }, 15087 "vm_size": { 15088 "description": "The Azure Virtual Machine size identifier used for the\nNodes of the Node Pool.\nAvailability of VM sizes are dependent on the Azure Location\nof the parent Cluster.\nRequired during creation.", 15089 "type": "string" 15090 }, 15091 "encryption_at_host": { 15092 "description": "EncryptionAtHost contains Encryption At Host disk encryption configuration.\nWhen enabled, it enhances Azure Disk Storage Server-Side Encryption to ensure that all temporary disks\nand disk caches are encrypted at rest and flow encrypted to the Storage clusters.\nIf not specified, Encryption at Host is not enabled.\nImmutable.", 15093 "$ref": "#/components/schemas/AzureNodePoolEncryptionAtHost" 15094 }, 15095 "ephemeral_os_disk_enabled": { 15096 "description": "Enables Ephemeral OS Disks for the Nodes in the Node Pool.\nIf not specified, no Ephemeral OS Disks are used.", 15097 "type": "boolean" 15098 }, 15099 "os_disk": { 15100 "description": "The configuration for the OS disk used by the nodes in the Node Pool.", 15101 "$ref": "#/components/schemas/AzureNodePoolOsDisk" 15102 }, 15103 "os_disk_sse_encryption_set_resource_id": { 15104 "description": "The Azure Resource ID of a pre-existing Azure Disk Encryption Set (DES).\nWhen provided, Server-Side Encryption (SSE) on the OS Disks of the Nodes of the Node Pool\nis performed using the provided Disk Encryption Set.\nIt must be located in the same Azure location as the parent Cluster. \nIt must be located in the same Azure Subscription as the parent Cluster.\nThe Azure Resource Group Name specified as part of it must be a different resource group name\nthan the one specified in the parent Cluster's `managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of it can be the same, or a different one\nthan the one specified in the parent Cluster's `resource_group_name`.\nIf not specified, Server-Side Encryption (SSE) on the OS Disks of the Nodes of the Node Pool \nis performed with platform managed keys.", 15105 "type": "string" 15106 }, 15107 "resource_name": { 15108 "description": "ResourceName is the Azure Resource Name of the NodePool.\nResourceName must be within the Azure Resource Group Name of the parent\nCluster it belongs to.\nResourceName must be located in the same Azure Location as the parent\nCluster it belongs to.\nResourceName must be located in the same Azure Subscription as the parent\nCluster it belongs to.\nResourceName must belong to the same Microsoft Entra Tenant ID as the parent\nCluster it belongs to.\nRequired during creation.\nImmutable.", 15109 "type": "string" 15110 } 15111 } 15112 }, 15113 "AzureNodePoolEncryptionAtHost": { 15114 "description": "AzureNodePoolEncryptionAtHost defines the encryption setting for Encryption At Host.\nIf not specified, Encryption at Host is not enabled.", 15115 "properties": { 15116 "state": { 15117 "description": "State indicates whether Encryption At Host is enabled.\nWhen enabled, it enhances Azure Disk Storage Server-Side Encryption to ensure that all temporary disks\nand disk caches are encrypted at rest and flow encrypted to the Storage clusters.\nAccepted values are: \"disabled\" or \"enabled\".\nIf not specified, its value is \"disabled\", which indicates Encryption At Host is disabled.\nImmutable.", 15118 "type": "string" 15119 } 15120 } 15121 }, 15122 "AzureNodePoolOsDisk": { 15123 "description": "Defines the configuration of a Node Pool's OS disk.", 15124 "properties": { 15125 "persistence": { 15126 "description": "Specifies the OS Disk persistence for the OS Disks of the Nodes in the Node Pool.\nValid values are:\n* persistent\n* ephemeral\nIf not specified, Persistent OS Disks are used.", 15127 "type": "string" 15128 }, 15129 "size_gibibytes": { 15130 "description": "The size in GiB to assign to the OS disks of the\nNodes in the Node Pool. The property\nis the number of bytes x 1024^3.\nIf not specified, OS disk size is 64 GiB.", 15131 "type": "integer", 15132 "format": "int32" 15133 }, 15134 "sse_encryption_set_resource_id": { 15135 "description": "The Azure Resource ID of a pre-existing Azure Disk Encryption Set (DES).\nWhen provided, Server-Side Encryption (SSE) on the OS Disks of the Nodes of the Node Pool\nis performed using the provided Disk Encryption Set.\nIt must be located in the same Azure location as the parent Cluster. \nIt must be located in the same Azure Subscription as the parent Cluster.\nThe Azure Resource Group Name specified as part of it must be a different resource group name\nthan the one specified in the parent Cluster's `managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of it can be the same, or a different one\nthan the one specified in the parent Cluster's `resource_group_name`.\nIf not specified, Server-Side Encryption (SSE) on the OS Disks of the Nodes of the Node Pool \nis performed with platform managed keys.", 15136 "type": "string" 15137 }, 15138 "storage_account_type": { 15139 "description": "The disk storage account type to use for the OS disks of the Nodes in the\nNode Pool. Valid values are:\n* Standard_LRS: HDD\n* StandardSSD_LRS: Standard SSD\n* Premium_LRS: Premium SDD\n* UltraSSD_LRS: Ultra SDD\n\nIf not specified, `Premium_LRS` is used.", 15140 "type": "string" 15141 } 15142 } 15143 }, 15144 "AzureNodesOutboundConnectivity": { 15145 "description": "The configuration of the node outbound connectivity", 15146 "properties": { 15147 "outbound_type": { 15148 "description": "OutboundType is the type of network outbound configuration.\nThe default and only accepted value is 'load_balancer'.\nThis value is immutable.", 15149 "type": "string" 15150 } 15151 } 15152 }, 15153 "AzureOperatorsAuthentication": { 15154 "description": "The configuration that the operators of the\ncluster have to authenticate to Azure.", 15155 "properties": { 15156 "managed_identities": { 15157 "description": "The authentication configuration to authenticate\nto Azure using Azure User-Assigned Managed Identities.\nRequired during creation.", 15158 "$ref": "#/components/schemas/AzureOperatorsAuthenticationManagedIdentities" 15159 } 15160 } 15161 }, 15162 "AzureOperatorsAuthenticationManagedIdentities": { 15163 "description": "Represents the information related to Azure User-Assigned managed identities\nneeded to perform Operators authentication based on Azure User-Assigned\nManaged Identities", 15164 "properties": { 15165 "control_plane_operators_managed_identities": { 15166 "description": "The set of Azure User-Assigned Managed Identities leveraged for the\nControl Plane operators of the cluster. The set of required managed\nidentities is dependent on the Cluster's OpenShift version.\nImmutable", 15167 "type": "object", 15168 "additionalProperties": { 15169 "$ref": "#/components/schemas/AzureControlPlaneManagedIdentity" 15170 } 15171 }, 15172 "data_plane_operators_managed_identities": { 15173 "description": "The set of Azure User-Assigned Managed Identities leveraged for the\nData Plane operators of the cluster. The set of required managed\nidentities is dependent on the Cluster's OpenShift version.\nImmutable.", 15174 "type": "object", 15175 "additionalProperties": { 15176 "$ref": "#/components/schemas/AzureDataPlaneManagedIdentity" 15177 } 15178 }, 15179 "managed_identities_data_plane_identity_url": { 15180 "description": "The Managed Identities Data Plane Identity URL associated with the\ncluster. It is the URL that will be used to communicate with the\nManaged Identities Resource Provider (MI RP).\nRequired during creation.\nImmutable.", 15181 "type": "string" 15182 }, 15183 "service_managed_identity": { 15184 "description": "The Azure User-Assigned Managed Identity used to perform service\nlevel actions. Specifically:\n- Add Federated Identity Credentials to the identities in\n `data_plane_operators_managed_identities` that belong to Data\n Plane Cluster Operators\n- Perform permissions validation for the BYOVNet related resources\n associated to the Cluster\nRequired during creation.\nImmutable.", 15185 "$ref": "#/components/schemas/AzureServiceManagedIdentity" 15186 } 15187 } 15188 }, 15189 "AzureServiceManagedIdentity": { 15190 "description": "Represents the information associated to an Azure User-Assigned\nManaged Identity whose purpose is to perform service level actions.", 15191 "properties": { 15192 "client_id": { 15193 "description": "The Client ID associated to the Azure User-Assigned Managed Identity.\nReadonly.", 15194 "type": "string" 15195 }, 15196 "principal_id": { 15197 "description": "The Principal ID associated to the Azure User-Assigned Managed Identity.\nReadonly.", 15198 "type": "string" 15199 }, 15200 "resource_id": { 15201 "description": "The Azure Resource ID of the Azure User-Assigned Managed\nIdentity. The managed identity represented must exist before\ncreating the cluster.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust belong to the Azure Subscription specified in `.azure.subscription_id`,\nand in the same Azure location as the cluster's region.\nThe Azure Resource Group Name specified as part of the Resource ID\nmust be a different Resource Group Name than the one specified in\n`.azure.managed_resource_group_name`.\nThe Azure Resource Group Name specified as part of the Resource ID\ncan be the same, or a different one than the one specified in\n`.azure.resource_group_name`.\nRequired during creation.\nImmutable.", 15202 "type": "string" 15203 } 15204 } 15205 }, 15206 "BillingModel": { 15207 "description": "Billing model for cluster resources.", 15208 "type": "string", 15209 "enum": [ 15210 "marketplace", 15211 "marketplace-aws", 15212 "marketplace-gcp", 15213 "marketplace-rhm", 15214 "marketplace-azure", 15215 "standard" 15216 ] 15217 }, 15218 "BillingModelItem": { 15219 "description": "BillingModelItem represents a billing model", 15220 "properties": { 15221 "kind": { 15222 "description": "Indicates the type of this object. Will be 'BillingModelItem' if this is a complete object or 'BillingModelItemLink' if it is just a link.", 15223 "type": "string" 15224 }, 15225 "id": { 15226 "description": "Unique identifier of the object.", 15227 "type": "string" 15228 }, 15229 "href": { 15230 "description": "Self link.", 15231 "type": "string" 15232 }, 15233 "billing_model_type": { 15234 "description": "BillingModelType is the type of the BillingModel. e.g. standard, marketplace.", 15235 "type": "string" 15236 }, 15237 "description": { 15238 "description": "Single line description of the billing model.", 15239 "type": "string" 15240 }, 15241 "display_name": { 15242 "description": "User friendly display name of the billing model.", 15243 "type": "string" 15244 }, 15245 "marketplace": { 15246 "description": "Indicates the marketplace of the billing model. e.g. gcp, aws, etc.", 15247 "type": "string" 15248 } 15249 } 15250 }, 15251 "BreakGlassCredential": { 15252 "description": "Representation of a break glass credential.", 15253 "properties": { 15254 "kind": { 15255 "description": "Indicates the type of this object. Will be 'BreakGlassCredential' if this is a complete object or 'BreakGlassCredentialLink' if it is just a link.", 15256 "type": "string" 15257 }, 15258 "id": { 15259 "description": "Unique identifier of the object.", 15260 "type": "string" 15261 }, 15262 "href": { 15263 "description": "Self link.", 15264 "type": "string" 15265 }, 15266 "expiration_timestamp": { 15267 "description": "ExpirationTimestamp is the date and time when the credential will expire.", 15268 "type": "string", 15269 "format": "date-time" 15270 }, 15271 "kubeconfig": { 15272 "description": "Kubeconfig is the generated kubeconfig for this credential. It is only stored in memory", 15273 "type": "string" 15274 }, 15275 "revocation_timestamp": { 15276 "description": "RevocationTimestamp is the date and time when the credential has been revoked.", 15277 "type": "string", 15278 "format": "date-time" 15279 }, 15280 "status": { 15281 "description": "Status is the status of this credential", 15282 "$ref": "#/components/schemas/BreakGlassCredentialStatus" 15283 }, 15284 "username": { 15285 "description": "Username is the user which will be used for this credential.", 15286 "type": "string" 15287 } 15288 } 15289 }, 15290 "BreakGlassCredentialStatus": { 15291 "description": "Status of the break glass credential.", 15292 "type": "string", 15293 "enum": [ 15294 "awaiting_revocation", 15295 "created", 15296 "expired", 15297 "failed", 15298 "issued", 15299 "revoked" 15300 ] 15301 }, 15302 "ByoOidc": { 15303 "description": "ByoOidc configuration.", 15304 "properties": { 15305 "enabled": { 15306 "description": "Boolean flag indicating if the cluster should be creating using _ByoOidc_.\n\nBy default this is `false`.\n\nTo enable it the cluster needs to be ROSA cluster and the organization of the user needs\nto have the `byo-oidc` feature toggle enabled.", 15307 "type": "boolean" 15308 } 15309 } 15310 }, 15311 "ClientComponent": { 15312 "description": "The reference of a component that will consume the client configuration.", 15313 "properties": { 15314 "name": { 15315 "description": "The name of the component.", 15316 "type": "string" 15317 }, 15318 "namespace": { 15319 "description": "The namespace of the component.", 15320 "type": "string" 15321 } 15322 } 15323 }, 15324 "CloudVPC": { 15325 "description": "Description of a cloud provider virtual private cloud.", 15326 "properties": { 15327 "aws_security_groups": { 15328 "description": "List of AWS security groups with details.", 15329 "type": "array", 15330 "items": { 15331 "$ref": "#/components/schemas/SecurityGroup" 15332 } 15333 }, 15334 "aws_subnets": { 15335 "description": "List of AWS subnetworks with details.", 15336 "type": "array", 15337 "items": { 15338 "$ref": "#/components/schemas/Subnetwork" 15339 } 15340 }, 15341 "cidr_block": { 15342 "description": "CIDR block of the virtual private cloud.", 15343 "type": "string" 15344 }, 15345 "id": { 15346 "description": "ID of virtual private cloud.", 15347 "type": "string" 15348 }, 15349 "name": { 15350 "description": "Name of virtual private cloud according to its `Name` tag on AWS.", 15351 "type": "string" 15352 }, 15353 "red_hat_managed": { 15354 "description": "If the resource is RH managed.", 15355 "type": "boolean" 15356 }, 15357 "subnets": { 15358 "description": "List of subnets used by the virtual private cloud.", 15359 "type": "array", 15360 "items": { 15361 "type": "string" 15362 } 15363 } 15364 } 15365 }, 15366 "CloudProvider": { 15367 "description": "Cloud provider.", 15368 "properties": { 15369 "kind": { 15370 "description": "Indicates the type of this object. Will be 'CloudProvider' if this is a complete object or 'CloudProviderLink' if it is just a link.", 15371 "type": "string" 15372 }, 15373 "id": { 15374 "description": "Unique identifier of the object.", 15375 "type": "string" 15376 }, 15377 "href": { 15378 "description": "Self link.", 15379 "type": "string" 15380 }, 15381 "display_name": { 15382 "description": "Name of the cloud provider for display purposes. It can contain any characters,\nincluding spaces.", 15383 "type": "string" 15384 }, 15385 "name": { 15386 "description": "Human friendly identifier of the cloud provider, for example `aws`.", 15387 "type": "string" 15388 }, 15389 "regions": { 15390 "description": "(optional) Provider's regions - only included when listing providers with `fetchRegions=true`.", 15391 "type": "array", 15392 "items": { 15393 "$ref": "#/components/schemas/CloudRegion" 15394 } 15395 } 15396 } 15397 }, 15398 "CloudProviderData": { 15399 "description": "Description of a cloud provider data used for cloud provider inquiries.", 15400 "properties": { 15401 "aws": { 15402 "description": "Amazon Web Services settings.", 15403 "$ref": "#/components/schemas/AWS" 15404 }, 15405 "gcp": { 15406 "description": "Google cloud platform settings.", 15407 "$ref": "#/components/schemas/GCP" 15408 }, 15409 "availability_zones": { 15410 "description": "Availability zone", 15411 "type": "array", 15412 "items": { 15413 "type": "string" 15414 } 15415 }, 15416 "key_location": { 15417 "description": "Key location", 15418 "type": "string" 15419 }, 15420 "key_ring_name": { 15421 "description": "Key ring name", 15422 "type": "string" 15423 }, 15424 "region": { 15425 "description": "Region", 15426 "$ref": "#/components/schemas/CloudRegion" 15427 }, 15428 "subnets": { 15429 "description": "Subnets", 15430 "type": "array", 15431 "items": { 15432 "type": "string" 15433 } 15434 }, 15435 "version": { 15436 "description": "Openshift version", 15437 "$ref": "#/components/schemas/Version" 15438 }, 15439 "vpc_ids": { 15440 "description": "VPC ids", 15441 "type": "array", 15442 "items": { 15443 "type": "string" 15444 } 15445 } 15446 } 15447 }, 15448 "CloudRegion": { 15449 "description": "Description of a region of a cloud provider.", 15450 "properties": { 15451 "kind": { 15452 "description": "Indicates the type of this object. Will be 'CloudRegion' if this is a complete object or 'CloudRegionLink' if it is just a link.", 15453 "type": "string" 15454 }, 15455 "id": { 15456 "description": "Unique identifier of the object.", 15457 "type": "string" 15458 }, 15459 "href": { 15460 "description": "Self link.", 15461 "type": "string" 15462 }, 15463 "ccs_only": { 15464 "description": "'true' if the region is supported only for CCS clusters, 'false' otherwise.", 15465 "type": "boolean" 15466 }, 15467 "kms_location_id": { 15468 "description": "(GCP only) Comma-separated list of KMS location IDs that can be used with this region.\nE.g. \"global,nam4,us\". Order is not guaranteed.", 15469 "type": "string" 15470 }, 15471 "kms_location_name": { 15472 "description": "(GCP only) Comma-separated list of display names corresponding to KMSLocationID.\nE.g. \"Global,nam4 (Iowa, South Carolina, and Oklahoma),US\". Order is not guaranteed but will match KMSLocationID.\nUnfortunately, this API doesn't allow robust splitting - Contact ocm-feedback@redhat.com if you want to rely on this.", 15473 "type": "string" 15474 }, 15475 "cloud_provider": { 15476 "description": "Link to the cloud provider that the region belongs to.", 15477 "$ref": "#/components/schemas/CloudProvider" 15478 }, 15479 "display_name": { 15480 "description": "Name of the region for display purposes, for example `N. Virginia`.", 15481 "type": "string" 15482 }, 15483 "enabled": { 15484 "description": "Whether the region is enabled for deploying a managed cluster.", 15485 "type": "boolean" 15486 }, 15487 "govcloud": { 15488 "description": "Whether the region is an AWS GovCloud region.", 15489 "type": "boolean" 15490 }, 15491 "name": { 15492 "description": "Human friendly identifier of the region, for example `us-east-1`.\n\nNOTE: Currently for all cloud providers and all regions `id` and `name` have exactly\nthe same values.", 15493 "type": "string" 15494 }, 15495 "supports_hypershift": { 15496 "description": "'true' if the region is supported for Hypershift deployments, 'false' otherwise.", 15497 "type": "boolean" 15498 }, 15499 "supports_multi_az": { 15500 "description": "Whether the region supports multiple availability zones.", 15501 "type": "boolean" 15502 } 15503 } 15504 }, 15505 "Cluster": { 15506 "description": "Definition of an _OpenShift_ cluster.\n\nThe `cloud_provider` attribute is a reference to the cloud provider. When a\ncluster is retrieved it will be a link to the cloud provider, containing only\nthe kind, id and href attributes:\n\n```json\n{\n \"cloud_provider\": {\n \"kind\": \"CloudProviderLink\",\n \"id\": \"123\",\n \"href\": \"/api/clusters_mgmt/v1/cloud_providers/123\"\n }\n}\n```\n\nWhen a cluster is created this is optional, and if used it should contain the\nidentifier of the cloud provider to use:\n\n```json\n{\n \"cloud_provider\": {\n \"id\": \"123\",\n }\n}\n```\n\nIf not included, then the cluster will be created using the default cloud\nprovider, which is currently Amazon Web Services.\n\nThe region attribute is mandatory when a cluster is created.\n\nThe `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain`\nattributes are mandatory when creation a cluster with your own Amazon Web\nServices account.", 15507 "properties": { 15508 "kind": { 15509 "description": "Indicates the type of this object. Will be 'Cluster' if this is a complete object or 'ClusterLink' if it is just a link.", 15510 "type": "string" 15511 }, 15512 "id": { 15513 "description": "Unique identifier of the object.", 15514 "type": "string" 15515 }, 15516 "href": { 15517 "description": "Self link.", 15518 "type": "string" 15519 }, 15520 "api": { 15521 "description": "Information about the API of the cluster.", 15522 "$ref": "#/components/schemas/ClusterAPI" 15523 }, 15524 "aws": { 15525 "description": "Amazon Web Services settings of the cluster.", 15526 "$ref": "#/components/schemas/AWS" 15527 }, 15528 "aws_infrastructure_access_role_grants": { 15529 "description": "List of AWS infrastructure access role grants on this cluster.", 15530 "type": "array", 15531 "items": { 15532 "$ref": "#/components/schemas/AWSInfrastructureAccessRoleGrant" 15533 } 15534 }, 15535 "ccs": { 15536 "description": "Contains configuration of a Customer Cloud Subscription cluster.", 15537 "$ref": "#/components/schemas/CCS" 15538 }, 15539 "dns": { 15540 "description": "DNS settings of the cluster.", 15541 "$ref": "#/components/schemas/DNS" 15542 }, 15543 "fips": { 15544 "description": "Create cluster that uses FIPS Validated / Modules in Process cryptographic libraries.", 15545 "type": "boolean" 15546 }, 15547 "gcp": { 15548 "description": "Google cloud platform settings of the cluster.", 15549 "$ref": "#/components/schemas/GCP" 15550 }, 15551 "gcp_encryption_key": { 15552 "description": "Key used for encryption of GCP cluster nodes.", 15553 "$ref": "#/components/schemas/GCPEncryptionKey" 15554 }, 15555 "gcp_network": { 15556 "description": "GCP Network.", 15557 "$ref": "#/components/schemas/GCPNetwork" 15558 }, 15559 "additional_trust_bundle": { 15560 "description": "Additional trust bundle.", 15561 "type": "string" 15562 }, 15563 "addons": { 15564 "description": "List of add-ons on this cluster.", 15565 "type": "array", 15566 "items": { 15567 "$ref": "#/components/schemas/AddOnInstallation" 15568 } 15569 }, 15570 "autoscaler": { 15571 "description": "Link to an optional _ClusterAutoscaler_ that is coupled with the cluster.", 15572 "$ref": "#/components/schemas/ClusterAutoscaler" 15573 }, 15574 "azure": { 15575 "description": "Microsoft Azure settings of the cluster.", 15576 "$ref": "#/components/schemas/Azure" 15577 }, 15578 "billing_model": { 15579 "description": "Billing model for cluster resources.", 15580 "$ref": "#/components/schemas/BillingModel" 15581 }, 15582 "byo_oidc": { 15583 "description": "Contains information about BYO OIDC.", 15584 "$ref": "#/components/schemas/ByoOidc" 15585 }, 15586 "cloud_provider": { 15587 "description": "Link to the cloud provider where the cluster is installed.", 15588 "$ref": "#/components/schemas/CloudProvider" 15589 }, 15590 "console": { 15591 "description": "Information about the console of the cluster.", 15592 "$ref": "#/components/schemas/ClusterConsole" 15593 }, 15594 "creation_timestamp": { 15595 "description": "Date and time when the cluster was initially created, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 15596 "type": "string", 15597 "format": "date-time" 15598 }, 15599 "delete_protection": { 15600 "description": "Delete protection", 15601 "$ref": "#/components/schemas/DeleteProtection" 15602 }, 15603 "disable_user_workload_monitoring": { 15604 "description": "Indicates whether the User workload monitoring is enabled or not\nIt is enabled by default", 15605 "type": "boolean" 15606 }, 15607 "domain_prefix": { 15608 "description": "DomainPrefix of the cluster. This prefix is optionally assigned by the user when the\ncluster is created. It will appear in the Cluster's domain when the cluster is provisioned.", 15609 "type": "string" 15610 }, 15611 "etcd_encryption": { 15612 "description": "Indicates whether that etcd is encrypted or not.\nThis is set only during cluster creation.\nFor ARO-HCP Clusters, this is a readonly attribute, always set to true.", 15613 "type": "boolean" 15614 }, 15615 "expiration_timestamp": { 15616 "description": "Date and time when the cluster will be automatically deleted, using the format defined in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt). If no timestamp is provided, the cluster\nwill never expire.\n\nThis option is unsupported.", 15617 "type": "string", 15618 "format": "date-time" 15619 }, 15620 "external_id": { 15621 "description": "External identifier of the cluster, generated by the installer.", 15622 "type": "string" 15623 }, 15624 "external_auth_config": { 15625 "description": "External authentication configuration.\n\nFor ROSA HCP, if this is not specified, external authentication configuration will be disabled by default\nFor ARO HCP, if this is not specified, external authentication configuration will be enabled by default", 15626 "$ref": "#/components/schemas/ExternalAuthConfig" 15627 }, 15628 "external_configuration": { 15629 "description": "ExternalConfiguration shows external configuration on the cluster.", 15630 "$ref": "#/components/schemas/ExternalConfiguration" 15631 }, 15632 "flavour": { 15633 "description": "Link to the _flavour_ that was used to create the cluster.", 15634 "$ref": "#/components/schemas/Flavour" 15635 }, 15636 "groups": { 15637 "description": "Link to the collection of groups of user of the cluster.", 15638 "type": "array", 15639 "items": { 15640 "$ref": "#/components/schemas/Group" 15641 } 15642 }, 15643 "health_state": { 15644 "description": "HealthState indicates the overall health state of the cluster.", 15645 "$ref": "#/components/schemas/ClusterHealthState" 15646 }, 15647 "htpasswd": { 15648 "description": "Details for `htpasswd` identity provider.", 15649 "$ref": "#/components/schemas/HTPasswdIdentityProvider" 15650 }, 15651 "hypershift": { 15652 "description": "Hypershift configuration.", 15653 "$ref": "#/components/schemas/Hypershift" 15654 }, 15655 "identity_providers": { 15656 "description": "Link to the collection of identity providers of the cluster.", 15657 "type": "array", 15658 "items": { 15659 "$ref": "#/components/schemas/IdentityProvider" 15660 } 15661 }, 15662 "image_registry": { 15663 "description": "The OpenShift Image Registry configuration\nIt provides an internal, integrated container image registry to locally manage images.\nFor non ARO-HCP clusters, it is readonly and always enabled", 15664 "$ref": "#/components/schemas/ClusterImageRegistry" 15665 }, 15666 "inflight_checks": { 15667 "description": "List of inflight checks on this cluster.", 15668 "type": "array", 15669 "items": { 15670 "$ref": "#/components/schemas/InflightCheck" 15671 } 15672 }, 15673 "infra_id": { 15674 "description": "InfraID is used for example to name the VPCs.", 15675 "type": "string" 15676 }, 15677 "ingresses": { 15678 "description": "List of ingresses on this cluster.", 15679 "type": "array", 15680 "items": { 15681 "$ref": "#/components/schemas/Ingress" 15682 } 15683 }, 15684 "kubelet_config": { 15685 "description": "Details of cluster-wide KubeletConfig", 15686 "$ref": "#/components/schemas/KubeletConfig" 15687 }, 15688 "load_balancer_quota": { 15689 "description": "Load Balancer quota to be assigned to the cluster.", 15690 "type": "integer", 15691 "format": "int32" 15692 }, 15693 "machine_pools": { 15694 "description": "List of machine pools on this cluster.", 15695 "type": "array", 15696 "items": { 15697 "$ref": "#/components/schemas/MachinePool" 15698 } 15699 }, 15700 "managed": { 15701 "description": "Flag indicating if the cluster is managed (by Red Hat) or\nself-managed by the user.", 15702 "type": "boolean" 15703 }, 15704 "managed_service": { 15705 "description": "Contains information about Managed Service", 15706 "$ref": "#/components/schemas/ManagedService" 15707 }, 15708 "multi_az": { 15709 "description": "Flag indicating if the cluster should be created with nodes in\ndifferent availability zones or all the nodes in a single one\nrandomly selected.\nFor ARO-HCP Clusters, this attribute is unused, and the control plane\nis deployed in multiple availability zones when the Azure region where\nit is deployed supports multiple availability zones.", 15710 "type": "boolean" 15711 }, 15712 "multi_arch_enabled": { 15713 "description": "Indicate whether the cluster is enabled for multi arch workers", 15714 "type": "boolean" 15715 }, 15716 "name": { 15717 "description": "Name of the cluster. This name is assigned by the user when the\ncluster is created. This is used to uniquely identify the cluster", 15718 "type": "string" 15719 }, 15720 "network": { 15721 "description": "Network settings of the cluster.", 15722 "$ref": "#/components/schemas/Network" 15723 }, 15724 "node_drain_grace_period": { 15725 "description": "Node drain grace period.", 15726 "$ref": "#/components/schemas/Value" 15727 }, 15728 "node_pools": { 15729 "description": "List of node pools on this cluster.\nNodePool is a scalable set of worker nodes attached to a hosted cluster.", 15730 "type": "array", 15731 "items": { 15732 "$ref": "#/components/schemas/NodePool" 15733 } 15734 }, 15735 "nodes": { 15736 "description": "Information about the nodes of the cluster.", 15737 "$ref": "#/components/schemas/ClusterNodes" 15738 }, 15739 "openshift_version": { 15740 "description": "Version of _OpenShift_ installed in the cluster, for example `4.0.0-0.2`.\n\nWhen retrieving a cluster this will always be reported.\n\nWhen provisioning a cluster this will be ignored, as the version to\ndeploy will be determined internally.", 15741 "type": "string" 15742 }, 15743 "product": { 15744 "description": "Link to the product type of this cluster.", 15745 "$ref": "#/components/schemas/Product" 15746 }, 15747 "properties": { 15748 "description": "User defined properties for tagging and querying.", 15749 "type": "object", 15750 "additionalProperties": { 15751 "type": "string" 15752 } 15753 }, 15754 "provision_shard": { 15755 "description": "ProvisionShard contains the properties of the provision shard, including AWS and GCP related configurations", 15756 "$ref": "#/components/schemas/ProvisionShard" 15757 }, 15758 "proxy": { 15759 "description": "Proxy.", 15760 "$ref": "#/components/schemas/Proxy" 15761 }, 15762 "region": { 15763 "description": "Link to the cloud provider region where the cluster is installed.", 15764 "$ref": "#/components/schemas/CloudRegion" 15765 }, 15766 "registry_config": { 15767 "description": "External registry configuration for the cluster", 15768 "$ref": "#/components/schemas/ClusterRegistryConfig" 15769 }, 15770 "state": { 15771 "description": "Overall state of the cluster.", 15772 "$ref": "#/components/schemas/ClusterState" 15773 }, 15774 "status": { 15775 "description": "Status of cluster", 15776 "$ref": "#/components/schemas/ClusterStatus" 15777 }, 15778 "storage_quota": { 15779 "description": "Storage quota to be assigned to the cluster.", 15780 "$ref": "#/components/schemas/Value" 15781 }, 15782 "subscription": { 15783 "description": "Link to the subscription that comes from the account management service when the cluster\nis registered.", 15784 "$ref": "#/components/schemas/Subscription" 15785 }, 15786 "version": { 15787 "description": "Link to the version of _OpenShift_ that will be used to install the cluster.", 15788 "$ref": "#/components/schemas/Version" 15789 } 15790 } 15791 }, 15792 "ClusterAPI": { 15793 "description": "Information about the API of a cluster.", 15794 "properties": { 15795 "url": { 15796 "description": "The URL of the API server of the cluster.", 15797 "type": "string" 15798 }, 15799 "listening": { 15800 "description": "The listening method of the API server.", 15801 "$ref": "#/components/schemas/ListeningMethod" 15802 } 15803 } 15804 }, 15805 "ClusterArchitecture": { 15806 "description": "Possible cluster architectures.", 15807 "type": "string", 15808 "enum": [ 15809 "classic", 15810 "hcp" 15811 ] 15812 }, 15813 "ClusterAutoscaler": { 15814 "description": "Cluster-wide autoscaling configuration.", 15815 "properties": { 15816 "kind": { 15817 "description": "Indicates the type of this object. Will be 'ClusterAutoscaler' if this is a complete object or 'ClusterAutoscalerLink' if it is just a link.", 15818 "type": "string" 15819 }, 15820 "id": { 15821 "description": "Unique identifier of the object.", 15822 "type": "string" 15823 }, 15824 "href": { 15825 "description": "Self link.", 15826 "type": "string" 15827 }, 15828 "balance_similar_node_groups": { 15829 "description": "BalanceSimilarNodeGroups enables/disables the\n`--balance-similar-node-groups` cluster-autoscaler feature.\nThis feature will automatically identify node groups with\nthe same instance type and the same set of labels and try\nto keep the respective sizes of those node groups balanced.", 15830 "type": "boolean" 15831 }, 15832 "balancing_ignored_labels": { 15833 "description": "This option specifies labels that cluster autoscaler should ignore when considering node group similarity.\nFor example, if you have nodes with \"topology.ebs.csi.aws.com/zone\" label, you can add name of this label here\nto prevent cluster autoscaler from splitting nodes into different node groups based on its value.", 15834 "type": "array", 15835 "items": { 15836 "type": "string" 15837 } 15838 }, 15839 "ignore_daemonsets_utilization": { 15840 "description": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down. false by default.", 15841 "type": "boolean" 15842 }, 15843 "log_verbosity": { 15844 "description": "Sets the autoscaler log level.\nDefault value is 1, level 4 is recommended for DEBUGGING and level 6 will enable almost everything.", 15845 "type": "integer", 15846 "format": "int32" 15847 }, 15848 "max_node_provision_time": { 15849 "description": "Maximum time CA waits for node to be provisioned.", 15850 "type": "string" 15851 }, 15852 "max_pod_grace_period": { 15853 "description": "Gives pods graceful termination time before scaling down.", 15854 "type": "integer", 15855 "format": "int32" 15856 }, 15857 "pod_priority_threshold": { 15858 "description": "To allow users to schedule \"best-effort\" pods, which shouldn't trigger\nCluster Autoscaler actions, but only run when there are spare resources available,\nMore info: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption.", 15859 "type": "integer", 15860 "format": "int32" 15861 }, 15862 "resource_limits": { 15863 "description": "Constraints of autoscaling resources.", 15864 "$ref": "#/components/schemas/AutoscalerResourceLimits" 15865 }, 15866 "scale_down": { 15867 "description": "Configuration of scale down operation.", 15868 "$ref": "#/components/schemas/AutoscalerScaleDownConfig" 15869 }, 15870 "skip_nodes_with_local_storage": { 15871 "description": "Enables/Disables `--skip-nodes-with-local-storage` CA feature flag. If true cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath. true by default at autoscaler.", 15872 "type": "boolean" 15873 } 15874 } 15875 }, 15876 "ClusterConfigurationMode": { 15877 "description": "Configuration mode of a cluster.", 15878 "type": "string", 15879 "enum": [ 15880 "full", 15881 "read_only" 15882 ] 15883 }, 15884 "ClusterConsole": { 15885 "description": "Information about the console of a cluster.", 15886 "properties": { 15887 "url": { 15888 "description": "The URL of the console of the cluster.", 15889 "type": "string" 15890 } 15891 } 15892 }, 15893 "ClusterCredentials": { 15894 "description": "Credentials of the a cluster.", 15895 "properties": { 15896 "kind": { 15897 "description": "Indicates the type of this object. Will be 'ClusterCredentials' if this is a complete object or 'ClusterCredentialsLink' if it is just a link.", 15898 "type": "string" 15899 }, 15900 "id": { 15901 "description": "Unique identifier of the object.", 15902 "type": "string" 15903 }, 15904 "href": { 15905 "description": "Self link.", 15906 "type": "string" 15907 }, 15908 "kubeconfig": { 15909 "description": "Administrator _kubeconfig_ file for the cluster.", 15910 "type": "string" 15911 } 15912 } 15913 }, 15914 "ClusterDeployment": { 15915 "description": "Representation of a clusterdeployment.", 15916 "properties": { 15917 "kind": { 15918 "description": "Indicates the type of this object. Will be 'ClusterDeployment' if this is a complete object or 'ClusterDeploymentLink' if it is just a link.", 15919 "type": "string" 15920 }, 15921 "id": { 15922 "description": "Unique identifier of the object.", 15923 "type": "string" 15924 }, 15925 "href": { 15926 "description": "Self link.", 15927 "type": "string" 15928 }, 15929 "content": { 15930 "description": "Content of the clusterdeployment.", 15931 "type": "object" 15932 } 15933 } 15934 }, 15935 "ClusterHealthState": { 15936 "description": "ClusterHealthState indicates the health of a cluster.", 15937 "type": "string", 15938 "enum": [ 15939 "healthy", 15940 "unhealthy", 15941 "unknown" 15942 ] 15943 }, 15944 "ClusterImageRegistry": { 15945 "description": "ClusterImageRegistry represents the configuration for the cluster's internal image registry.", 15946 "properties": { 15947 "state": { 15948 "description": "State indicates whether the image registry is enabled.\nUnless explicitly set, the image registry is enabled by default.\nThis setting is immutable and cannot be changed after the cluster is created.\nValid values: \"enabled\", \"disabled\".", 15949 "type": "string" 15950 } 15951 } 15952 }, 15953 "ClusterLink": { 15954 "description": "Definition of a cluster link.", 15955 "properties": { 15956 "href": { 15957 "description": "HREF for the cluster, filled in response.", 15958 "type": "string" 15959 }, 15960 "id": { 15961 "description": "The cluster's ID.", 15962 "type": "string" 15963 } 15964 } 15965 }, 15966 "ClusterMigration": { 15967 "description": "Representation of a cluster migration.", 15968 "properties": { 15969 "kind": { 15970 "description": "Indicates the type of this object. Will be 'ClusterMigration' if this is a complete object or 'ClusterMigrationLink' if it is just a link.", 15971 "type": "string" 15972 }, 15973 "id": { 15974 "description": "Unique identifier of the object.", 15975 "type": "string" 15976 }, 15977 "href": { 15978 "description": "Self link.", 15979 "type": "string" 15980 }, 15981 "cluster_id": { 15982 "description": "Internal cluster ID.", 15983 "type": "string" 15984 }, 15985 "creation_timestamp": { 15986 "description": "Date and time when the cluster migration was initially created, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 15987 "type": "string", 15988 "format": "date-time" 15989 }, 15990 "sdn_to_ovn": { 15991 "description": "Details for `SdnToOvn` cluster migrations.", 15992 "$ref": "#/components/schemas/SdnToOvnClusterMigration" 15993 }, 15994 "state": { 15995 "description": "The state of the cluster migration.", 15996 "$ref": "#/components/schemas/ClusterMigrationState" 15997 }, 15998 "type": { 15999 "description": "Type of cluster migration. The rest of the attributes will be populated according to this\nvalue. For example, if the type is `sdnToOvn` then only the `SdnToOvn` attribute will be\npopulated.", 16000 "$ref": "#/components/schemas/ClusterMigrationType" 16001 }, 16002 "updated_timestamp": { 16003 "description": "Date and time when the cluster migration was last updated, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 16004 "type": "string", 16005 "format": "date-time" 16006 } 16007 } 16008 }, 16009 "ClusterMigrationState": { 16010 "description": "Representation of a cluster migration state.", 16011 "properties": { 16012 "description": { 16013 "description": "A longer description of the current state of the cluster migration.", 16014 "type": "string" 16015 }, 16016 "value": { 16017 "description": "The current state of the cluster migration.", 16018 "$ref": "#/components/schemas/ClusterMigrationStateValue" 16019 } 16020 } 16021 }, 16022 "ClusterMigrationStateValue": { 16023 "description": "The state of the cluster migration.", 16024 "type": "string", 16025 "enum": [ 16026 "completed", 16027 "in progress", 16028 "scheduled" 16029 ] 16030 }, 16031 "ClusterMigrationType": { 16032 "description": "Type of cluster migration.", 16033 "type": "string", 16034 "enum": [ 16035 "sdnToOvn" 16036 ] 16037 }, 16038 "ClusterNodes": { 16039 "description": "Counts of different classes of nodes inside a cluster.", 16040 "properties": { 16041 "autoscale_compute": { 16042 "description": "Details for auto-scaling the compute machine pool.\nCompute and AutoscaleCompute cannot be used together.", 16043 "$ref": "#/components/schemas/MachinePoolAutoscaling" 16044 }, 16045 "availability_zones": { 16046 "description": "The availability zones upon which the nodes are created.", 16047 "type": "array", 16048 "items": { 16049 "type": "string" 16050 } 16051 }, 16052 "compute": { 16053 "description": "Number of compute nodes of the cluster.\nCompute and AutoscaleCompute cannot be used together.", 16054 "type": "integer", 16055 "format": "int32" 16056 }, 16057 "compute_labels": { 16058 "description": "The labels set on the \"default\" compute machine pool.", 16059 "type": "object", 16060 "additionalProperties": { 16061 "type": "string" 16062 } 16063 }, 16064 "compute_machine_type": { 16065 "description": "The compute machine type to use, for example `r5.xlarge`.", 16066 "$ref": "#/components/schemas/MachineType" 16067 }, 16068 "compute_root_volume": { 16069 "description": "The compute machine root volume capabilities.", 16070 "$ref": "#/components/schemas/RootVolume" 16071 }, 16072 "infra": { 16073 "description": "Number of infrastructure nodes of the cluster.", 16074 "type": "integer", 16075 "format": "int32" 16076 }, 16077 "infra_machine_type": { 16078 "description": "The infra machine type to use, for example `r5.xlarge` (Optional).", 16079 "$ref": "#/components/schemas/MachineType" 16080 }, 16081 "master": { 16082 "description": "Number of master nodes of the cluster.", 16083 "type": "integer", 16084 "format": "int32" 16085 }, 16086 "master_machine_type": { 16087 "description": "The master machine type to use, for example `r5.xlarge` (Optional).", 16088 "$ref": "#/components/schemas/MachineType" 16089 }, 16090 "security_group_filters": { 16091 "description": "List of security groups to be applied to nodes (Optional).", 16092 "type": "array", 16093 "items": { 16094 "$ref": "#/components/schemas/MachinePoolSecurityGroupFilter" 16095 } 16096 }, 16097 "total": { 16098 "description": "Total number of nodes of the cluster.", 16099 "type": "integer", 16100 "format": "int32" 16101 } 16102 } 16103 }, 16104 "ClusterOperatorInfo": { 16105 "properties": { 16106 "condition": { 16107 "description": "Operator status. Empty string if unknown.", 16108 "$ref": "#/components/schemas/ClusterOperatorState" 16109 }, 16110 "name": { 16111 "description": "Name of the operator.", 16112 "type": "string" 16113 }, 16114 "reason": { 16115 "description": "Extra detail on condition, if available. Empty string if unknown.", 16116 "type": "string" 16117 }, 16118 "time": { 16119 "description": "Time when the sample was obtained, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.", 16120 "type": "string", 16121 "format": "date-time" 16122 }, 16123 "version": { 16124 "description": "Current version of the operator. Empty string if unknown.", 16125 "type": "string" 16126 } 16127 } 16128 }, 16129 "ClusterOperatorState": { 16130 "description": "Overall state of a cluster operator.", 16131 "type": "string", 16132 "enum": [ 16133 "available", 16134 "degraded", 16135 "failing", 16136 "upgrading" 16137 ] 16138 }, 16139 "ClusterOperatorsInfo": { 16140 "description": "Provides detailed information about the operators installed on the cluster.", 16141 "properties": { 16142 "operators": { 16143 "type": "array", 16144 "items": { 16145 "$ref": "#/components/schemas/ClusterOperatorInfo" 16146 } 16147 } 16148 } 16149 }, 16150 "ClusterRegistration": { 16151 "description": "Registration of a new cluster to the service.\n\nFor example, to register a cluster that has been provisioned outside\nof this service, send a a request like this:\n\n```http\nPOST /api/clusters_mgmt/v1/register_cluster HTTP/1.1\n```\n\nWith a request body like this:\n\n```json\n{\n \"external_id\": \"d656aecf-11a6-4782-ad86-8f72638449ba\",\n \"subscription_id\": \"...\",\n \"organization_id\": \"...\"\n}\n```", 16152 "properties": { 16153 "console_url": { 16154 "description": "Optional Console URL of the cluster.", 16155 "type": "string" 16156 }, 16157 "external_id": { 16158 "description": "Identifier of the cluster generated by the installer.", 16159 "type": "string" 16160 }, 16161 "organization_id": { 16162 "description": "Organization identifier of the cluster generated by the\naccount manager.", 16163 "type": "string" 16164 }, 16165 "subscription_id": { 16166 "description": "Subscription identifier of the cluster generated by the account\nmanager.", 16167 "type": "string" 16168 } 16169 } 16170 }, 16171 "ClusterRegistryConfig": { 16172 "description": "ClusterRegistryConfig describes the configuration of registries for the cluster.\nIts format reflects the OpenShift Image Configuration, for which docs are available on\n[docs.openshift.com](https://docs.openshift.com/container-platform/4.16/openshift_images/image-configuration.html)\n```json\n{\n \"registry_config\": {\n \"registry_sources\": {\n \"blocked_registries\": [\n \"badregistry.io\",\n \"badregistry8.io\"\n ]\n }\n }\n}\n```\n", 16173 "properties": { 16174 "additional_trusted_ca": { 16175 "description": "A map containing the registry hostname as the key, and the PEM-encoded certificate as the value,\nfor each additional registry CA to trust.", 16176 "type": "object", 16177 "additionalProperties": { 16178 "type": "string" 16179 } 16180 }, 16181 "allowed_registries_for_import": { 16182 "description": "AllowedRegistriesForImport limits the container image registries that normal users may import\nimages from. Set this list to the registries that you trust to contain valid Docker\nimages and that you want applications to be able to import from. Users with\npermission to create Images or ImageStreamMappings via the API are not affected by\nthis policy - typically only administrators or system integrations will have those\npermissions.", 16183 "type": "array", 16184 "items": { 16185 "$ref": "#/components/schemas/RegistryLocation" 16186 } 16187 }, 16188 "platform_allowlist": { 16189 "description": "PlatformAllowlist contains a reference to a RegistryAllowlist which is a list of internal registries\nwhich needs to be whitelisted for the platform to work. It can be omitted at creation and \nupdating and its lifecycle can be managed separately if needed.", 16190 "$ref": "#/components/schemas/RegistryAllowlist" 16191 }, 16192 "registry_sources": { 16193 "description": "RegistrySources contains configuration that determines how the container runtime\nshould treat individual registries when accessing images for builds+pods. (e.g.\nwhether or not to allow insecure access). It does not contain configuration for the\ninternal cluster registry.", 16194 "$ref": "#/components/schemas/RegistrySources" 16195 } 16196 } 16197 }, 16198 "ClusterResources": { 16199 "description": "Cluster Resource which belongs to a cluster, example Cluster Deployment.", 16200 "properties": { 16201 "kind": { 16202 "description": "Indicates the type of this object. Will be 'ClusterResources' if this is a complete object or 'ClusterResourcesLink' if it is just a link.", 16203 "type": "string" 16204 }, 16205 "id": { 16206 "description": "Unique identifier of the object.", 16207 "type": "string" 16208 }, 16209 "href": { 16210 "description": "Self link.", 16211 "type": "string" 16212 }, 16213 "cluster_id": { 16214 "description": "Cluster ID for the fetched resources", 16215 "type": "string" 16216 }, 16217 "creation_timestamp": { 16218 "description": "Date and time when the resources were fetched.", 16219 "type": "string", 16220 "format": "date-time" 16221 }, 16222 "resources": { 16223 "description": "Returned map of cluster resources fetched.", 16224 "type": "object", 16225 "additionalProperties": { 16226 "type": "string" 16227 } 16228 } 16229 } 16230 }, 16231 "ClusterState": { 16232 "description": "Overall state of a cluster.", 16233 "type": "string", 16234 "enum": [ 16235 "error", 16236 "hibernating", 16237 "installing", 16238 "pending", 16239 "powering_down", 16240 "ready", 16241 "resuming", 16242 "uninstalling", 16243 "unknown", 16244 "updating", 16245 "validating", 16246 "waiting" 16247 ] 16248 }, 16249 "ClusterStatus": { 16250 "description": "Detailed status of a cluster.", 16251 "properties": { 16252 "kind": { 16253 "description": "Indicates the type of this object. Will be 'ClusterStatus' if this is a complete object or 'ClusterStatusLink' if it is just a link.", 16254 "type": "string" 16255 }, 16256 "id": { 16257 "description": "Unique identifier of the object.", 16258 "type": "string" 16259 }, 16260 "href": { 16261 "description": "Self link.", 16262 "type": "string" 16263 }, 16264 "dns_ready": { 16265 "description": "DNSReady from Provisioner", 16266 "type": "boolean" 16267 }, 16268 "oidc_ready": { 16269 "description": "OIDCReady from user configuration.", 16270 "type": "boolean" 16271 }, 16272 "configuration_mode": { 16273 "description": "Configuration mode", 16274 "$ref": "#/components/schemas/ClusterConfigurationMode" 16275 }, 16276 "current_compute": { 16277 "description": "Current Replicas available for a Hosted Cluster", 16278 "type": "integer", 16279 "format": "int32" 16280 }, 16281 "description": { 16282 "description": "Detailed description of the cluster status.", 16283 "type": "string" 16284 }, 16285 "limited_support_reason_count": { 16286 "description": "Limited Support Reason Count", 16287 "type": "integer", 16288 "format": "int32" 16289 }, 16290 "provision_error_code": { 16291 "description": "Provisioning Error Code", 16292 "type": "string" 16293 }, 16294 "provision_error_message": { 16295 "description": "Provisioning Error Message", 16296 "type": "string" 16297 }, 16298 "state": { 16299 "description": "The overall state of the cluster.", 16300 "$ref": "#/components/schemas/ClusterState" 16301 } 16302 } 16303 }, 16304 "ComponentRoute": { 16305 "description": "Representation of a Component Route.", 16306 "properties": { 16307 "kind": { 16308 "description": "Indicates the type of this object. Will be 'ComponentRoute' if this is a complete object or 'ComponentRouteLink' if it is just a link.", 16309 "type": "string" 16310 }, 16311 "id": { 16312 "description": "Unique identifier of the object.", 16313 "type": "string" 16314 }, 16315 "href": { 16316 "description": "Self link.", 16317 "type": "string" 16318 }, 16319 "hostname": { 16320 "description": "Hostname of the route.", 16321 "type": "string" 16322 }, 16323 "tls_secret_ref": { 16324 "description": "TLS Secret reference of the route.", 16325 "type": "string" 16326 } 16327 } 16328 }, 16329 "ComponentRouteType": { 16330 "description": "Type of Component Route.", 16331 "type": "string", 16332 "enum": [ 16333 "console", 16334 "downloads", 16335 "oauth" 16336 ] 16337 }, 16338 "ControlPlaneUpgradePolicy": { 16339 "description": "Representation of an upgrade policy that can be set for a cluster.", 16340 "properties": { 16341 "kind": { 16342 "description": "Indicates the type of this object. Will be 'ControlPlaneUpgradePolicy' if this is a complete object or 'ControlPlaneUpgradePolicyLink' if it is just a link.", 16343 "type": "string" 16344 }, 16345 "id": { 16346 "description": "Unique identifier of the object.", 16347 "type": "string" 16348 }, 16349 "href": { 16350 "description": "Self link.", 16351 "type": "string" 16352 }, 16353 "cluster_id": { 16354 "description": "Cluster ID this upgrade policy for control plane is defined for.", 16355 "type": "string" 16356 }, 16357 "creation_timestamp": { 16358 "description": "Timestamp for creation of resource.", 16359 "type": "string", 16360 "format": "date-time" 16361 }, 16362 "enable_minor_version_upgrades": { 16363 "description": "Indicates if minor version upgrades are allowed for automatic upgrades (for manual it's always allowed).", 16364 "type": "boolean" 16365 }, 16366 "last_update_timestamp": { 16367 "description": "Timestamp for last update that happened to resource.", 16368 "type": "string", 16369 "format": "date-time" 16370 }, 16371 "next_run": { 16372 "description": "Next time the upgrade should run.", 16373 "type": "string", 16374 "format": "date-time" 16375 }, 16376 "schedule": { 16377 "description": "Schedule cron expression that defines automatic upgrade scheduling.", 16378 "type": "string" 16379 }, 16380 "schedule_type": { 16381 "description": "Schedule type of the control plane upgrade.", 16382 "$ref": "#/components/schemas/ScheduleType" 16383 }, 16384 "state": { 16385 "description": "State of the upgrade policy for the hosted control plane.", 16386 "$ref": "#/components/schemas/UpgradePolicyState" 16387 }, 16388 "upgrade_type": { 16389 "description": "Upgrade type of the control plane.", 16390 "$ref": "#/components/schemas/UpgradeType" 16391 }, 16392 "version": { 16393 "description": "Version is the desired upgrade version.", 16394 "type": "string" 16395 } 16396 } 16397 }, 16398 "CredentialRequest": { 16399 "description": "Contains the necessary attributes to allow each operator to access the necessary AWS resources", 16400 "properties": { 16401 "name": { 16402 "description": "Name of the credentials secret used to access cloud resources", 16403 "type": "string" 16404 }, 16405 "namespace": { 16406 "description": "Namespace where the credentials secret lives in the cluster", 16407 "type": "string" 16408 }, 16409 "policy_permissions": { 16410 "description": "List of policy permissions needed to access cloud resources", 16411 "type": "array", 16412 "items": { 16413 "type": "string" 16414 } 16415 }, 16416 "service_account": { 16417 "description": "Service account name to use when authenticating", 16418 "type": "string" 16419 } 16420 } 16421 }, 16422 "DeleteProtection": { 16423 "description": "DeleteProtection configuration.", 16424 "properties": { 16425 "enabled": { 16426 "description": "Boolean flag indicating if the cluster should be be using _DeleteProtection_.\n\nBy default this is `false`.\n\nTo enable it a SREP needs to patch the value through OCM API", 16427 "type": "boolean" 16428 } 16429 } 16430 }, 16431 "DetectionType": { 16432 "type": "string", 16433 "enum": [ 16434 "auto", 16435 "manual" 16436 ] 16437 }, 16438 "Ec2MetadataHttpTokens": { 16439 "description": "Which Ec2MetadataHttpTokens to use for metadata service interaction options for EC2 instances", 16440 "type": "string", 16441 "enum": [ 16442 "optional", 16443 "required" 16444 ] 16445 }, 16446 "EncryptionKey": { 16447 "description": "Description of a cloud provider encryption key.", 16448 "properties": { 16449 "kind": { 16450 "description": "Indicates the type of this object. Will be 'EncryptionKey' if this is a complete object or 'EncryptionKeyLink' if it is just a link.", 16451 "type": "string" 16452 }, 16453 "id": { 16454 "description": "Unique identifier of the object.", 16455 "type": "string" 16456 }, 16457 "href": { 16458 "description": "Self link.", 16459 "type": "string" 16460 }, 16461 "name": { 16462 "description": "Name of the encryption key.", 16463 "type": "string" 16464 } 16465 } 16466 }, 16467 "Environment": { 16468 "description": "Description of an environment", 16469 "properties": { 16470 "backplane_url": { 16471 "description": "the backplane url for the environment", 16472 "type": "string" 16473 }, 16474 "last_limited_support_check": { 16475 "description": "last time that the worker checked for limited support clusters", 16476 "type": "string", 16477 "format": "date-time" 16478 }, 16479 "last_upgrade_available_check": { 16480 "description": "last time that the worker checked for available upgrades", 16481 "type": "string", 16482 "format": "date-time" 16483 }, 16484 "name": { 16485 "description": "environment name", 16486 "type": "string" 16487 } 16488 } 16489 }, 16490 "Event": { 16491 "description": "Representation of a trackable event.", 16492 "properties": { 16493 "body": { 16494 "description": "Body of the event to track the details of the tracking event as Key value pair", 16495 "type": "object", 16496 "additionalProperties": { 16497 "type": "string" 16498 } 16499 }, 16500 "key": { 16501 "description": "Key of the event to be tracked. This key should start with an\nuppercase letter followed by alphanumeric characters or\nunderscores. The entire key needs to be smaller than 64 characters.", 16502 "type": "string" 16503 } 16504 } 16505 }, 16506 "ExternalAuth": { 16507 "description": "Representation of an external authentication provider.", 16508 "properties": { 16509 "kind": { 16510 "description": "Indicates the type of this object. Will be 'ExternalAuth' if this is a complete object or 'ExternalAuthLink' if it is just a link.", 16511 "type": "string" 16512 }, 16513 "id": { 16514 "description": "Unique identifier of the object.", 16515 "type": "string" 16516 }, 16517 "href": { 16518 "description": "Self link.", 16519 "type": "string" 16520 }, 16521 "claim": { 16522 "description": "The rules on how to transform information from an ID token into a cluster identity.", 16523 "$ref": "#/components/schemas/ExternalAuthClaim" 16524 }, 16525 "clients": { 16526 "description": "The list of the platform's clients that need to request tokens from the issuer.", 16527 "type": "array", 16528 "items": { 16529 "$ref": "#/components/schemas/ExternalAuthClientConfig" 16530 } 16531 }, 16532 "issuer": { 16533 "description": "The issuer describes the attributes of the OIDC token issuer.", 16534 "$ref": "#/components/schemas/TokenIssuer" 16535 }, 16536 "status": { 16537 "description": "The status describes the current state of the external authentication provider.\nThis is read-only.", 16538 "$ref": "#/components/schemas/ExternalAuthStatus" 16539 } 16540 } 16541 }, 16542 "ExternalAuthClaim": { 16543 "description": "The claims and validation rules used in the configuration of the external authentication.", 16544 "properties": { 16545 "mappings": { 16546 "description": "Mapping describes rules on how to transform information from an ID token into a cluster identity.", 16547 "$ref": "#/components/schemas/TokenClaimMappings" 16548 }, 16549 "validation_rules": { 16550 "description": "ValidationRules are rules that are applied to validate token claims to authenticate users.", 16551 "type": "array", 16552 "items": { 16553 "$ref": "#/components/schemas/TokenClaimValidationRule" 16554 } 16555 } 16556 } 16557 }, 16558 "ExternalAuthClientConfig": { 16559 "description": "ExternalAuthClientConfig contains configuration for the platform's clients that\nneed to request tokens from the issuer.", 16560 "properties": { 16561 "id": { 16562 "description": "The identifier of the OIDC client from the OIDC provider.\nThis is required.\nMust be at least one character length.", 16563 "type": "string" 16564 }, 16565 "component": { 16566 "description": "The component that is supposed to consume this client configuration.", 16567 "$ref": "#/components/schemas/ClientComponent" 16568 }, 16569 "extra_scopes": { 16570 "description": "ExtraScopes is an optional set of scopes to request tokens with.", 16571 "type": "array", 16572 "items": { 16573 "type": "string" 16574 } 16575 }, 16576 "secret": { 16577 "description": "The secret of the OIDC client from the OIDC provider.\nThe client is considered 'public' if no secret is specified. Otherwise, it is considered\nas a 'confidential' client.\nThis can only be used for an external authentication provider belonging to a ROSA HCP cluster.", 16578 "type": "string" 16579 }, 16580 "type": { 16581 "description": "Determines the OIDC provider client type.\n\nThis is required to be defined for clients of an external authentication provider belonging to an ARO-HCP cluster.\n\nFor clients belonging to a ROSA HCP cluster, this is read-only. The value of this property will be determined by the \n'secret' property in the client configuration. \n - If the 'secret' property is set, the type of the client is 'confidential.\n - If the 'secret' property is not set, the type of the client is 'public.", 16582 "$ref": "#/components/schemas/ExternalAuthClientType" 16583 } 16584 } 16585 }, 16586 "ExternalAuthClientType": { 16587 "description": "Representation of the possible values of an external authentication client's type", 16588 "type": "string", 16589 "enum": [ 16590 "confidential", 16591 "public" 16592 ] 16593 }, 16594 "ExternalAuthConfig": { 16595 "description": "Represents an external authentication configuration", 16596 "properties": { 16597 "kind": { 16598 "description": "Indicates the type of this object. Will be 'ExternalAuthConfig' if this is a complete object or 'ExternalAuthConfigLink' if it is just a link.", 16599 "type": "string" 16600 }, 16601 "id": { 16602 "description": "Unique identifier of the object.", 16603 "type": "string" 16604 }, 16605 "href": { 16606 "description": "Self link.", 16607 "type": "string" 16608 }, 16609 "enabled": { 16610 "description": "Boolean flag indicating if the cluster should use an external authentication configuration for ROSA HCP clusters.\n\nBy default this is false.\n\nTo enable it the cluster needs to be ROSA HCP cluster and the organization of the user needs\nto have the `external-authentication` feature toggle enabled.\n\nFor ARO HCP clusters, use the \"State\" property to enable/disable this feature instead.", 16611 "type": "boolean" 16612 }, 16613 "external_auths": { 16614 "description": "A list of external authentication providers configured for the cluster.\n\nOnly one external authentication provider can be configured.", 16615 "type": "array", 16616 "items": { 16617 "$ref": "#/components/schemas/ExternalAuth" 16618 } 16619 }, 16620 "state": { 16621 "description": "Controls whether the cluster uses an external authentication configuration for ARO HCP clusters.\n\nFor ARO HCP clusters, this will be \"enabled\" by default and cannot be set to \"disabled\".\n\nFOR ROSA HCP clusters, use the \"Enabled\" boolean flag to enable/disable this feature instead.", 16622 "$ref": "#/components/schemas/ExternalAuthConfigState" 16623 } 16624 } 16625 }, 16626 "ExternalAuthConfigState": { 16627 "description": "Representation of the possible values for the state field of an external authentication configuration", 16628 "type": "string", 16629 "enum": [ 16630 "disabled", 16631 "enabled" 16632 ] 16633 }, 16634 "ExternalAuthState": { 16635 "description": "Representation of the state of an external authentication provider.", 16636 "properties": { 16637 "last_updated_timestamp": { 16638 "description": "The date and time when the external authentication provider state was last updated.", 16639 "type": "string", 16640 "format": "date-time" 16641 }, 16642 "value": { 16643 "description": "A string value representing the external authentication provider's current state.", 16644 "type": "string" 16645 } 16646 } 16647 }, 16648 "ExternalAuthStatus": { 16649 "description": "Representation of the status of an external authentication provider.", 16650 "properties": { 16651 "message": { 16652 "description": "A descriptive message providing additional context about the current \nstate of the external authentication provider.", 16653 "type": "string" 16654 }, 16655 "state": { 16656 "description": "The current state of the external authentication provider.", 16657 "$ref": "#/components/schemas/ExternalAuthState" 16658 } 16659 } 16660 }, 16661 "ExternalConfiguration": { 16662 "description": "Representation of cluster external configuration.", 16663 "properties": { 16664 "labels": { 16665 "description": "list of labels externally configured on the clusterdeployment.", 16666 "type": "array", 16667 "items": { 16668 "$ref": "#/components/schemas/Label" 16669 } 16670 }, 16671 "manifests": { 16672 "description": "list of manifest externally configured for a hosted cluster.", 16673 "type": "array", 16674 "items": { 16675 "$ref": "#/components/schemas/Manifest" 16676 } 16677 }, 16678 "syncsets": { 16679 "description": "list of syncsets externally configured on the cluster.", 16680 "type": "array", 16681 "items": { 16682 "$ref": "#/components/schemas/Syncset" 16683 } 16684 } 16685 } 16686 }, 16687 "Flavour": { 16688 "description": "Set of predefined properties of a cluster. For example, a _huge_ flavour can be a cluster\nwith 10 infra nodes and 1000 compute nodes.", 16689 "properties": { 16690 "kind": { 16691 "description": "Indicates the type of this object. Will be 'Flavour' if this is a complete object or 'FlavourLink' if it is just a link.", 16692 "type": "string" 16693 }, 16694 "id": { 16695 "description": "Unique identifier of the object.", 16696 "type": "string" 16697 }, 16698 "href": { 16699 "description": "Self link.", 16700 "type": "string" 16701 }, 16702 "aws": { 16703 "description": "Default _Amazon Web Services_ settings of the cluster.", 16704 "$ref": "#/components/schemas/AWSFlavour" 16705 }, 16706 "gcp": { 16707 "description": "Default _Google Cloud Platform_ settings of the cluster.", 16708 "$ref": "#/components/schemas/GCPFlavour" 16709 }, 16710 "name": { 16711 "description": "Human friendly identifier of the cluster, for example `4`.\n\nNOTE: Currently for all flavours the `id` and `name` attributes have exactly the\nsame values.", 16712 "type": "string" 16713 }, 16714 "network": { 16715 "description": "Default network settings of the cluster.\n\nThese can be overridden specifying in the cluster itself a different set of settings.", 16716 "$ref": "#/components/schemas/Network" 16717 }, 16718 "nodes": { 16719 "description": "Number of nodes that will be used by default when creating a cluster that uses\nthis flavour.\n\nThese can be overridden specifying in the cluster itself a different number of nodes.", 16720 "$ref": "#/components/schemas/FlavourNodes" 16721 } 16722 } 16723 }, 16724 "FlavourNodes": { 16725 "description": "Counts of different classes of nodes inside a flavour.", 16726 "properties": { 16727 "master": { 16728 "description": "Number of master nodes of the cluster.", 16729 "type": "integer", 16730 "format": "int32" 16731 } 16732 } 16733 }, 16734 "GcpAuthentication": { 16735 "description": "Google cloud platform authentication method of a cluster.", 16736 "properties": { 16737 "href": { 16738 "description": "Self link", 16739 "type": "string" 16740 }, 16741 "id": { 16742 "description": "Unique identifier of the object", 16743 "type": "string" 16744 }, 16745 "kind": { 16746 "description": "Indicates the type of this object", 16747 "type": "string" 16748 } 16749 } 16750 }, 16751 "GcpPrivateServiceConnect": { 16752 "description": "Google cloud platform private service connect configuration of a cluster.", 16753 "properties": { 16754 "service_attachment_subnet": { 16755 "description": "The name of the subnet where the PSC service attachment is created", 16756 "type": "string" 16757 } 16758 } 16759 }, 16760 "GcpSecurity": { 16761 "description": "Google cloud platform security settings of a cluster.", 16762 "properties": { 16763 "secure_boot": { 16764 "description": "Determines if Shielded VM feature \"Secure Boot\" should be set for the nodes of the cluster.", 16765 "type": "boolean" 16766 } 16767 } 16768 }, 16769 "GithubIdentityProvider": { 16770 "description": "Details for `github` identity providers.", 16771 "properties": { 16772 "ca": { 16773 "description": "Optional trusted certificate authority bundle to use when making requests tot he server.", 16774 "type": "string" 16775 }, 16776 "client_id": { 16777 "description": "Client identifier of a registered _GitHub_ OAuth application.", 16778 "type": "string" 16779 }, 16780 "client_secret": { 16781 "description": "Client secret of a registered _GitHub_ OAuth application.", 16782 "type": "string" 16783 }, 16784 "hostname": { 16785 "description": "For _GitHub Enterprise_ you must provide the host name of your instance, such as\n`example.com`. This value must match the _GitHub Enterprise_ host name value in the\n`/setup/settings` file and cannot include a port number.\n\nFor plain _GitHub_ omit this parameter.", 16786 "type": "string" 16787 }, 16788 "organizations": { 16789 "description": "Optional list of organizations. Cannot be used in combination with the Teams field.", 16790 "type": "array", 16791 "items": { 16792 "type": "string" 16793 } 16794 }, 16795 "teams": { 16796 "description": "Optional list of teams. Cannot be used in combination with the Organizations field.", 16797 "type": "array", 16798 "items": { 16799 "type": "string" 16800 } 16801 } 16802 } 16803 }, 16804 "GitlabIdentityProvider": { 16805 "description": "Details for `gitlab` identity providers.", 16806 "properties": { 16807 "ca": { 16808 "description": "Optional trusted certificate authority bundle to use when making requests tot he server.", 16809 "type": "string" 16810 }, 16811 "url": { 16812 "description": "URL of the _GitLab_ instance.", 16813 "type": "string" 16814 }, 16815 "client_id": { 16816 "description": "Client identifier of a registered _GitLab_ OAuth application.", 16817 "type": "string" 16818 }, 16819 "client_secret": { 16820 "description": "Client secret issued by _GitLab_.", 16821 "type": "string" 16822 } 16823 } 16824 }, 16825 "GoogleIdentityProvider": { 16826 "description": "Details for `google` identity providers.", 16827 "properties": { 16828 "client_id": { 16829 "description": "Client identifier of a registered _Google_ project.", 16830 "type": "string" 16831 }, 16832 "client_secret": { 16833 "description": "Client secret issued by _Google_.", 16834 "type": "string" 16835 }, 16836 "hosted_domain": { 16837 "description": "Optional hosted domain to restrict sign-in accounts to.", 16838 "type": "string" 16839 } 16840 } 16841 }, 16842 "Group": { 16843 "description": "Representation of a group of users.", 16844 "properties": { 16845 "kind": { 16846 "description": "Indicates the type of this object. Will be 'Group' if this is a complete object or 'GroupLink' if it is just a link.", 16847 "type": "string" 16848 }, 16849 "id": { 16850 "description": "Unique identifier of the object.", 16851 "type": "string" 16852 }, 16853 "href": { 16854 "description": "Self link.", 16855 "type": "string" 16856 }, 16857 "users": { 16858 "description": "List of users of the group.", 16859 "type": "array", 16860 "items": { 16861 "$ref": "#/components/schemas/User" 16862 } 16863 } 16864 } 16865 }, 16866 "GroupsClaim": { 16867 "properties": { 16868 "claim": { 16869 "description": "The claim used in the token.", 16870 "type": "string" 16871 }, 16872 "prefix": { 16873 "description": "A prefix contatenated in the claim (Optional).", 16874 "type": "string" 16875 } 16876 } 16877 }, 16878 "Hypershift": { 16879 "description": "Hypershift configuration.", 16880 "properties": { 16881 "enabled": { 16882 "description": "Boolean flag indicating if the cluster should be creating using _Hypershift_.\n\nBy default this is `false`.\n\nTo enable it the cluster needs to be ROSA cluster and the organization of the user needs\nto have the `hypershift` capability enabled.", 16883 "type": "boolean" 16884 } 16885 } 16886 }, 16887 "HypershiftConfig": { 16888 "description": "Hypershift configuration.", 16889 "properties": { 16890 "hcp_namespace": { 16891 "description": "Contains the name of the hcp namespace for this Hypershift cluster.\nEmpty for non Hypershift clusters.", 16892 "type": "string" 16893 }, 16894 "enabled": { 16895 "description": "Boolean flag indicating if the cluster should be creating using _Hypershift_.\n\nBy default this is `false`.\n\nTo enable it the cluster needs to be ROSA cluster and the organization of the user needs\nto have the `hypershift` capability enabled.", 16896 "type": "boolean" 16897 }, 16898 "management_cluster": { 16899 "description": "Contains the name of the current management cluster for this Hypershift cluster.\nEmpty for non Hypershift clusters.", 16900 "type": "string" 16901 } 16902 } 16903 }, 16904 "IdentityProvider": { 16905 "description": "Representation of an identity provider.", 16906 "properties": { 16907 "kind": { 16908 "description": "Indicates the type of this object. Will be 'IdentityProvider' if this is a complete object or 'IdentityProviderLink' if it is just a link.", 16909 "type": "string" 16910 }, 16911 "id": { 16912 "description": "Unique identifier of the object.", 16913 "type": "string" 16914 }, 16915 "href": { 16916 "description": "Self link.", 16917 "type": "string" 16918 }, 16919 "ldap": { 16920 "description": "Details for `ldap` identity providers.", 16921 "$ref": "#/components/schemas/LDAPIdentityProvider" 16922 }, 16923 "challenge": { 16924 "description": "When `true` unauthenticated token requests from non-web clients (like the CLI) are sent a\n`WWW-Authenticate` challenge header for this provider.", 16925 "type": "boolean" 16926 }, 16927 "github": { 16928 "description": "Details for `github` identity providers.", 16929 "$ref": "#/components/schemas/GithubIdentityProvider" 16930 }, 16931 "gitlab": { 16932 "description": "Details for `gitlab` identity providers.", 16933 "$ref": "#/components/schemas/GitlabIdentityProvider" 16934 }, 16935 "google": { 16936 "description": "Details for `google` identity providers.", 16937 "$ref": "#/components/schemas/GoogleIdentityProvider" 16938 }, 16939 "htpasswd": { 16940 "description": "Details for `htpasswd` identity providers.", 16941 "$ref": "#/components/schemas/HTPasswdIdentityProvider" 16942 }, 16943 "login": { 16944 "description": "When `true` unauthenticated token requests from web clients (like the web console) are\nredirected to the authorize URL to log in.", 16945 "type": "boolean" 16946 }, 16947 "mapping_method": { 16948 "description": "Controls how mappings are established between this provider's identities and user\nobjects.", 16949 "$ref": "#/components/schemas/IdentityProviderMappingMethod" 16950 }, 16951 "name": { 16952 "description": "The name of the identity provider.", 16953 "type": "string" 16954 }, 16955 "open_id": { 16956 "description": "Details for `openid` identity providers.", 16957 "$ref": "#/components/schemas/OpenIDIdentityProvider" 16958 }, 16959 "type": { 16960 "description": "Type of identity provider. The rest of the attributes will be populated according to this\nvalue. For example, if the type is `github` then only the `github` attribute will be\npopulated.", 16961 "$ref": "#/components/schemas/IdentityProviderType" 16962 } 16963 } 16964 }, 16965 "IdentityProviderMappingMethod": { 16966 "description": "Controls how mappings are established between provider identities and user objects.", 16967 "type": "string", 16968 "enum": [ 16969 "add", 16970 "claim", 16971 "generate", 16972 "lookup" 16973 ] 16974 }, 16975 "IdentityProviderType": { 16976 "description": "Type of identity provider.", 16977 "type": "string", 16978 "enum": [ 16979 "LDAPIdentityProvider", 16980 "GithubIdentityProvider", 16981 "GitlabIdentityProvider", 16982 "GoogleIdentityProvider", 16983 "HTPasswdIdentityProvider", 16984 "OpenIDIdentityProvider" 16985 ] 16986 }, 16987 "ImageOverrides": { 16988 "description": "ImageOverrides holds the lists of available images per cloud provider.", 16989 "properties": { 16990 "kind": { 16991 "description": "Indicates the type of this object. Will be 'ImageOverrides' if this is a complete object or 'ImageOverridesLink' if it is just a link.", 16992 "type": "string" 16993 }, 16994 "id": { 16995 "description": "Unique identifier of the object.", 16996 "type": "string" 16997 }, 16998 "href": { 16999 "description": "Self link.", 17000 "type": "string" 17001 }, 17002 "aws": { 17003 "type": "array", 17004 "items": { 17005 "$ref": "#/components/schemas/AMIOverride" 17006 } 17007 }, 17008 "gcp": { 17009 "type": "array", 17010 "items": { 17011 "$ref": "#/components/schemas/GCPImageOverride" 17012 } 17013 } 17014 } 17015 }, 17016 "InflightCheck": { 17017 "description": "Representation of check running before the cluster is provisioned.", 17018 "properties": { 17019 "kind": { 17020 "description": "Indicates the type of this object. Will be 'InflightCheck' if this is a complete object or 'InflightCheckLink' if it is just a link.", 17021 "type": "string" 17022 }, 17023 "id": { 17024 "description": "Unique identifier of the object.", 17025 "type": "string" 17026 }, 17027 "href": { 17028 "description": "Self link.", 17029 "type": "string" 17030 }, 17031 "details": { 17032 "description": "Details regarding the state of the inflight check.", 17033 "type": "object" 17034 }, 17035 "ended_at": { 17036 "description": "The time the check finished running.", 17037 "type": "string", 17038 "format": "date-time" 17039 }, 17040 "name": { 17041 "description": "The name of the inflight check.", 17042 "type": "string" 17043 }, 17044 "restarts": { 17045 "description": "The number of times the inflight check restarted.", 17046 "type": "integer", 17047 "format": "int32" 17048 }, 17049 "started_at": { 17050 "description": "The time the check started running.", 17051 "type": "string", 17052 "format": "date-time" 17053 }, 17054 "state": { 17055 "description": "State of the inflight check.", 17056 "$ref": "#/components/schemas/InflightCheckState" 17057 } 17058 } 17059 }, 17060 "InflightCheckState": { 17061 "description": "State of an inflight check.", 17062 "type": "string", 17063 "enum": [ 17064 "failed", 17065 "passed", 17066 "pending", 17067 "running" 17068 ] 17069 }, 17070 "Ingress": { 17071 "description": "Representation of an ingress.", 17072 "properties": { 17073 "kind": { 17074 "description": "Indicates the type of this object. Will be 'Ingress' if this is a complete object or 'IngressLink' if it is just a link.", 17075 "type": "string" 17076 }, 17077 "id": { 17078 "description": "Unique identifier of the object.", 17079 "type": "string" 17080 }, 17081 "href": { 17082 "description": "Self link.", 17083 "type": "string" 17084 }, 17085 "dns_name": { 17086 "description": "DNS Name of the ingress.", 17087 "type": "string" 17088 }, 17089 "cluster_routes_hostname": { 17090 "description": "Cluster routes hostname.", 17091 "type": "string" 17092 }, 17093 "cluster_routes_tls_secret_ref": { 17094 "description": "Cluster routes TLS Secret reference.", 17095 "type": "string" 17096 }, 17097 "component_routes": { 17098 "description": "Component Routes settings.", 17099 "type": "object", 17100 "additionalProperties": { 17101 "$ref": "#/components/schemas/ComponentRoute" 17102 } 17103 }, 17104 "default": { 17105 "description": "Indicates if this is the default ingress.", 17106 "type": "boolean" 17107 }, 17108 "excluded_namespaces": { 17109 "description": "A set of excluded namespaces for the ingress.", 17110 "type": "array", 17111 "items": { 17112 "type": "string" 17113 } 17114 }, 17115 "listening": { 17116 "description": "Listening method of the ingress", 17117 "$ref": "#/components/schemas/ListeningMethod" 17118 }, 17119 "load_balancer_type": { 17120 "description": "Load Balancer type of the ingress", 17121 "$ref": "#/components/schemas/LoadBalancerFlavor" 17122 }, 17123 "route_namespace_ownership_policy": { 17124 "description": "Namespace Ownership Policy for the ingress.", 17125 "$ref": "#/components/schemas/NamespaceOwnershipPolicy" 17126 }, 17127 "route_selectors": { 17128 "description": "A set of labels for the ingress. ", 17129 "type": "object", 17130 "additionalProperties": { 17131 "type": "string" 17132 } 17133 }, 17134 "route_wildcard_policy": { 17135 "description": "Wildcard policy for the ingress.", 17136 "$ref": "#/components/schemas/WildcardPolicy" 17137 } 17138 } 17139 }, 17140 "InstanceIAMRoles": { 17141 "description": "Contains the necessary attributes to support role-based authentication on AWS.", 17142 "properties": { 17143 "master_role_arn": { 17144 "description": "The IAM role ARN that will be attached to master instances", 17145 "type": "string" 17146 }, 17147 "worker_role_arn": { 17148 "description": "The IAM role ARN that will be attached to worker instances", 17149 "type": "string" 17150 } 17151 } 17152 }, 17153 "KeyRing": { 17154 "description": "Description of a cloud provider key ring.", 17155 "properties": { 17156 "kind": { 17157 "description": "Indicates the type of this object. Will be 'KeyRing' if this is a complete object or 'KeyRingLink' if it is just a link.", 17158 "type": "string" 17159 }, 17160 "id": { 17161 "description": "Unique identifier of the object.", 17162 "type": "string" 17163 }, 17164 "href": { 17165 "description": "Self link.", 17166 "type": "string" 17167 }, 17168 "name": { 17169 "description": "Name of the key ring.", 17170 "type": "string" 17171 } 17172 } 17173 }, 17174 "KubeletConfig": { 17175 "description": "OCM representation of KubeletConfig, exposing the fields of Kubernetes\nKubeletConfig that can be managed by users", 17176 "properties": { 17177 "kind": { 17178 "description": "Indicates the type of this object. Will be 'KubeletConfig' if this is a complete object or 'KubeletConfigLink' if it is just a link.", 17179 "type": "string" 17180 }, 17181 "id": { 17182 "description": "Unique identifier of the object.", 17183 "type": "string" 17184 }, 17185 "href": { 17186 "description": "Self link.", 17187 "type": "string" 17188 }, 17189 "name": { 17190 "description": "Allows the user to specify the name to be used to identify this KubeletConfig.\nOptional. A name will be generated if not provided.", 17191 "type": "string" 17192 }, 17193 "pod_pids_limit": { 17194 "description": "Allows the user to specify the podPidsLimit to be applied via KubeletConfig.\nUseful if workloads have greater PIDs limit requirements than the OCP default.", 17195 "type": "integer", 17196 "format": "int32" 17197 } 17198 } 17199 }, 17200 "Label": { 17201 "description": "Representation of a label in clusterdeployment.", 17202 "properties": { 17203 "kind": { 17204 "description": "Indicates the type of this object. Will be 'Label' if this is a complete object or 'LabelLink' if it is just a link.", 17205 "type": "string" 17206 }, 17207 "id": { 17208 "description": "Unique identifier of the object.", 17209 "type": "string" 17210 }, 17211 "href": { 17212 "description": "Self link.", 17213 "type": "string" 17214 }, 17215 "key": { 17216 "description": "the key of the label", 17217 "type": "string" 17218 }, 17219 "value": { 17220 "description": "the value to set in the label", 17221 "type": "string" 17222 } 17223 } 17224 }, 17225 "LimitedSupportReason": { 17226 "description": "A reason that a cluster is in limited support.", 17227 "properties": { 17228 "kind": { 17229 "description": "Indicates the type of this object. Will be 'LimitedSupportReason' if this is a complete object or 'LimitedSupportReasonLink' if it is just a link.", 17230 "type": "string" 17231 }, 17232 "id": { 17233 "description": "Unique identifier of the object.", 17234 "type": "string" 17235 }, 17236 "href": { 17237 "description": "Self link.", 17238 "type": "string" 17239 }, 17240 "creation_timestamp": { 17241 "description": "The time the reason was detected.", 17242 "type": "string", 17243 "format": "date-time" 17244 }, 17245 "details": { 17246 "description": "URL with a link to a detailed description of the reason.", 17247 "type": "string" 17248 }, 17249 "detection_type": { 17250 "description": "Indicates if the reason was detected automatically or manually.\nWhen creating a new reason this field should be empty or \"manual\".", 17251 "$ref": "#/components/schemas/DetectionType" 17252 }, 17253 "override": { 17254 "description": "Indicates if the override is enabled", 17255 "$ref": "#/components/schemas/LimitedSupportReasonOverride" 17256 }, 17257 "summary": { 17258 "description": "Summary of the reason.", 17259 "type": "string" 17260 }, 17261 "template": { 17262 "description": "Optional link to a template with summary and details.", 17263 "$ref": "#/components/schemas/LimitedSupportReasonTemplate" 17264 } 17265 } 17266 }, 17267 "LimitedSupportReasonOverride": { 17268 "description": "Representation of the limited support reason override.", 17269 "properties": { 17270 "kind": { 17271 "description": "Indicates the type of this object. Will be 'LimitedSupportReasonOverride' if this is a complete object or 'LimitedSupportReasonOverrideLink' if it is just a link.", 17272 "type": "string" 17273 }, 17274 "id": { 17275 "description": "Unique identifier of the object.", 17276 "type": "string" 17277 }, 17278 "href": { 17279 "description": "Self link.", 17280 "type": "string" 17281 }, 17282 "enabled": { 17283 "description": "Indicates if the override is enabled", 17284 "type": "boolean" 17285 } 17286 } 17287 }, 17288 "LimitedSupportReasonTemplate": { 17289 "description": "A template for cluster limited support reason.", 17290 "properties": { 17291 "kind": { 17292 "description": "Indicates the type of this object. Will be 'LimitedSupportReasonTemplate' if this is a complete object or 'LimitedSupportReasonTemplateLink' if it is just a link.", 17293 "type": "string" 17294 }, 17295 "id": { 17296 "description": "Unique identifier of the object.", 17297 "type": "string" 17298 }, 17299 "href": { 17300 "description": "Self link.", 17301 "type": "string" 17302 }, 17303 "details": { 17304 "description": "A detailed description of the reason.", 17305 "type": "string" 17306 }, 17307 "summary": { 17308 "description": "Summary of the reason.", 17309 "type": "string" 17310 } 17311 } 17312 }, 17313 "ListeningMethod": { 17314 "description": "Cluster components listening method.", 17315 "type": "string", 17316 "enum": [ 17317 "external", 17318 "internal" 17319 ] 17320 }, 17321 "LoadBalancerFlavor": { 17322 "description": "Type of load balancer for AWS cloud provider parameters.", 17323 "type": "string", 17324 "enum": [ 17325 "classic", 17326 "nlb" 17327 ] 17328 }, 17329 "Log": { 17330 "description": "Log of the cluster.", 17331 "properties": { 17332 "kind": { 17333 "description": "Indicates the type of this object. Will be 'Log' if this is a complete object or 'LogLink' if it is just a link.", 17334 "type": "string" 17335 }, 17336 "id": { 17337 "description": "Unique identifier of the object.", 17338 "type": "string" 17339 }, 17340 "href": { 17341 "description": "Self link.", 17342 "type": "string" 17343 }, 17344 "content": { 17345 "description": "Content of the log.", 17346 "type": "string" 17347 } 17348 } 17349 }, 17350 "MachinePool": { 17351 "description": "Representation of a machine pool in a cluster.", 17352 "properties": { 17353 "kind": { 17354 "description": "Indicates the type of this object. Will be 'MachinePool' if this is a complete object or 'MachinePoolLink' if it is just a link.", 17355 "type": "string" 17356 }, 17357 "id": { 17358 "description": "Unique identifier of the object.", 17359 "type": "string" 17360 }, 17361 "href": { 17362 "description": "Self link.", 17363 "type": "string" 17364 }, 17365 "aws": { 17366 "description": "AWS specific parameters (Optional).", 17367 "$ref": "#/components/schemas/AWSMachinePool" 17368 }, 17369 "gcp": { 17370 "description": "GCP specific parameters (Optional).", 17371 "$ref": "#/components/schemas/GCPMachinePool" 17372 }, 17373 "autoscaling": { 17374 "description": "Details for auto-scaling the machine pool.\nReplicas and autoscaling cannot be used together.", 17375 "$ref": "#/components/schemas/MachinePoolAutoscaling" 17376 }, 17377 "availability_zones": { 17378 "description": "The availability zones upon which the nodes are created.", 17379 "type": "array", 17380 "items": { 17381 "type": "string" 17382 } 17383 }, 17384 "instance_type": { 17385 "description": "The instance type of Nodes to create.", 17386 "type": "string" 17387 }, 17388 "labels": { 17389 "description": "The labels set on the Nodes created.", 17390 "type": "object", 17391 "additionalProperties": { 17392 "type": "string" 17393 } 17394 }, 17395 "replicas": { 17396 "description": "The number of Machines (and Nodes) to create.\nReplicas and autoscaling cannot be used together.", 17397 "type": "integer", 17398 "format": "int32" 17399 }, 17400 "root_volume": { 17401 "description": "The machine root volume capabilities.", 17402 "$ref": "#/components/schemas/RootVolume" 17403 }, 17404 "security_group_filters": { 17405 "description": "List of security groups to be applied to MachinePool (Optional)", 17406 "type": "array", 17407 "items": { 17408 "$ref": "#/components/schemas/MachinePoolSecurityGroupFilter" 17409 } 17410 }, 17411 "subnets": { 17412 "description": "The subnets upon which the nodes are created.", 17413 "type": "array", 17414 "items": { 17415 "type": "string" 17416 } 17417 }, 17418 "taints": { 17419 "description": "The taints set on the Nodes created.", 17420 "type": "array", 17421 "items": { 17422 "$ref": "#/components/schemas/Taint" 17423 } 17424 } 17425 } 17426 }, 17427 "MachinePoolAutoscaling": { 17428 "description": "Representation of a autoscaling in a machine pool.", 17429 "properties": { 17430 "kind": { 17431 "description": "Indicates the type of this object. Will be 'MachinePoolAutoscaling' if this is a complete object or 'MachinePoolAutoscalingLink' if it is just a link.", 17432 "type": "string" 17433 }, 17434 "id": { 17435 "description": "Unique identifier of the object.", 17436 "type": "string" 17437 }, 17438 "href": { 17439 "description": "Self link.", 17440 "type": "string" 17441 }, 17442 "max_replicas": { 17443 "description": "The maximum number of replicas for the machine pool.", 17444 "type": "integer", 17445 "format": "int32" 17446 }, 17447 "min_replicas": { 17448 "description": "The minimum number of replicas for the machine pool.", 17449 "type": "integer", 17450 "format": "int32" 17451 } 17452 } 17453 }, 17454 "MachinePoolSecurityGroupFilter": { 17455 "description": "Security Group Filter object, containing name of the filter tag and value of the filter tag", 17456 "properties": { 17457 "name": { 17458 "type": "string" 17459 }, 17460 "value": { 17461 "type": "string" 17462 } 17463 } 17464 }, 17465 "MachineType": { 17466 "description": "Machine type.", 17467 "properties": { 17468 "kind": { 17469 "description": "Indicates the type of this object. Will be 'MachineType' if this is a complete object or 'MachineTypeLink' if it is just a link.", 17470 "type": "string" 17471 }, 17472 "id": { 17473 "description": "Unique identifier of the object.", 17474 "type": "string" 17475 }, 17476 "href": { 17477 "description": "Self link.", 17478 "type": "string" 17479 }, 17480 "ccs_only": { 17481 "description": "'true' if the instance type is supported only for CCS clusters, 'false' otherwise.", 17482 "type": "boolean" 17483 }, 17484 "cpu": { 17485 "description": "The amount of cpu's of the machine type.", 17486 "$ref": "#/components/schemas/Value" 17487 }, 17488 "architecture": { 17489 "description": "The architecture of the machine type.", 17490 "$ref": "#/components/schemas/ProcessorType" 17491 }, 17492 "category": { 17493 "description": "The category which the machine type is suitable for.", 17494 "$ref": "#/components/schemas/MachineTypeCategory" 17495 }, 17496 "cloud_provider": { 17497 "description": "Link to the cloud provider that the machine type belongs to.", 17498 "$ref": "#/components/schemas/CloudProvider" 17499 }, 17500 "generic_name": { 17501 "description": "Generic name for quota purposes, for example `highmem-4`.\nCloud provider agnostic - many values are shared between \"similar\"\nmachine types on different providers.\nCorresponds to `resource_name` values in \"compute.node\" quota cost data.", 17502 "type": "string" 17503 }, 17504 "memory": { 17505 "description": "The amount of memory of the machine type.", 17506 "$ref": "#/components/schemas/Value" 17507 }, 17508 "name": { 17509 "description": "Human friendly identifier of the machine type, for example `r5.xlarge - Memory Optimized`.", 17510 "type": "string" 17511 }, 17512 "size": { 17513 "description": "The size of the machine type.", 17514 "$ref": "#/components/schemas/MachineTypeSize" 17515 } 17516 } 17517 }, 17518 "MachineTypeCategory": { 17519 "description": "Machine type category.", 17520 "type": "string", 17521 "enum": [ 17522 "accelerated_computing", 17523 "compute_optimized", 17524 "general_purpose", 17525 "memory_optimized" 17526 ] 17527 }, 17528 "MachineTypeSize": { 17529 "description": "Machine type size.", 17530 "type": "string", 17531 "enum": [ 17532 "large", 17533 "medium", 17534 "small" 17535 ] 17536 }, 17537 "ManagedService": { 17538 "description": "Contains the necessary attributes to support role-based authentication on AWS.", 17539 "properties": { 17540 "enabled": { 17541 "description": "Indicates whether the cluster belongs to a managed service\nThis should only be set by the \"Managed Service\" service.\nclusters with this set can only be modified by the \"Managed Service\" service.", 17542 "type": "boolean" 17543 } 17544 } 17545 }, 17546 "Manifest": { 17547 "description": "Representation of a manifestwork.", 17548 "properties": { 17549 "kind": { 17550 "description": "Indicates the type of this object. Will be 'Manifest' if this is a complete object or 'ManifestLink' if it is just a link.", 17551 "type": "string" 17552 }, 17553 "id": { 17554 "description": "Unique identifier of the object.", 17555 "type": "string" 17556 }, 17557 "href": { 17558 "description": "Self link.", 17559 "type": "string" 17560 }, 17561 "creation_timestamp": { 17562 "description": "Date and time when the manifest got created in OCM database.", 17563 "type": "string", 17564 "format": "date-time" 17565 }, 17566 "live_resource": { 17567 "description": "Transient value to represent the underlying live resource.", 17568 "type": "object" 17569 }, 17570 "spec": { 17571 "description": "Spec of Manifest Work object from open cluster management\nFor more info please check https://open-cluster-management.io/concepts/manifestwork.", 17572 "type": "object" 17573 }, 17574 "updated_timestamp": { 17575 "description": "Date and time when the manifest got updated in OCM database.", 17576 "type": "string", 17577 "format": "date-time" 17578 }, 17579 "workloads": { 17580 "description": "List of k8s objects to deploy on a hosted cluster.", 17581 "type": "array", 17582 "items": { 17583 "type": "object" 17584 } 17585 } 17586 } 17587 }, 17588 "MarketType": { 17589 "description": "Market type for AWS Capacity Reservations.", 17590 "type": "string", 17591 "enum": [ 17592 "capacity_blocks", 17593 "on_demand" 17594 ] 17595 }, 17596 "NamespaceOwnershipPolicy": { 17597 "description": "Type of Namespace Ownership Policy.", 17598 "type": "string", 17599 "enum": [ 17600 "InterNamespaceAllowed", 17601 "Strict" 17602 ] 17603 }, 17604 "Network": { 17605 "description": "Network configuration of a cluster.", 17606 "properties": { 17607 "host_prefix": { 17608 "description": "Network host prefix which is defaulted to `23` if not specified.", 17609 "type": "integer", 17610 "format": "int32" 17611 }, 17612 "machine_cidr": { 17613 "description": "IP address block from which to assign machine IP addresses, for example `10.0.0.0/16`.", 17614 "type": "string" 17615 }, 17616 "pod_cidr": { 17617 "description": "IP address block from which to assign pod IP addresses, for example `10.128.0.0/14`.", 17618 "type": "string" 17619 }, 17620 "service_cidr": { 17621 "description": "IP address block from which to assign service IP addresses, for example `172.30.0.0/16`.", 17622 "type": "string" 17623 }, 17624 "type": { 17625 "description": "The main controller responsible for rendering the core networking components.", 17626 "type": "string" 17627 } 17628 } 17629 }, 17630 "NetworkVerification": { 17631 "properties": { 17632 "cloud_provider_data": { 17633 "description": "Cloud provider data to execute the network verification.", 17634 "$ref": "#/components/schemas/CloudProviderData" 17635 }, 17636 "cluster_id": { 17637 "description": "Cluster ID needed to execute the network verification.", 17638 "type": "string" 17639 }, 17640 "items": { 17641 "description": "Details about each subnet network verification.", 17642 "type": "array", 17643 "items": { 17644 "$ref": "#/components/schemas/SubnetNetworkVerification" 17645 } 17646 }, 17647 "platform": { 17648 "description": "Platform needed to execute the network verification.", 17649 "$ref": "#/components/schemas/Platform" 17650 }, 17651 "total": { 17652 "description": "Amount of network verifier executions started.", 17653 "type": "integer", 17654 "format": "int32" 17655 } 17656 } 17657 }, 17658 "NodeInfo": { 17659 "description": "Provides information about a node from specific type in the cluster.", 17660 "properties": { 17661 "amount": { 17662 "description": "The amount of the nodes from this type.", 17663 "type": "integer", 17664 "format": "int32" 17665 }, 17666 "type": { 17667 "description": "The Node type.", 17668 "$ref": "#/components/schemas/NodeType" 17669 } 17670 } 17671 }, 17672 "NodePool": { 17673 "description": "Representation of a node pool in a cluster.", 17674 "properties": { 17675 "kind": { 17676 "description": "Indicates the type of this object. Will be 'NodePool' if this is a complete object or 'NodePoolLink' if it is just a link.", 17677 "type": "string" 17678 }, 17679 "id": { 17680 "description": "Unique identifier of the object.", 17681 "type": "string" 17682 }, 17683 "href": { 17684 "description": "Self link.", 17685 "type": "string" 17686 }, 17687 "aws_node_pool": { 17688 "description": "AWS specific parameters (Optional).", 17689 "$ref": "#/components/schemas/AWSNodePool" 17690 }, 17691 "auto_repair": { 17692 "description": "Specifies whether health checks should be enabled for machines in the NodePool.", 17693 "type": "boolean" 17694 }, 17695 "autoscaling": { 17696 "description": "Details for auto-scaling the machine pool.\nReplicas and autoscaling cannot be used together.", 17697 "$ref": "#/components/schemas/NodePoolAutoscaling" 17698 }, 17699 "availability_zone": { 17700 "description": "The availability zone upon which the node is created.", 17701 "type": "string" 17702 }, 17703 "azure_node_pool": { 17704 "description": "Azure specific parameters.", 17705 "$ref": "#/components/schemas/AzureNodePool" 17706 }, 17707 "kubelet_configs": { 17708 "description": "The names of the KubeletConfigs for this node pool.", 17709 "type": "array", 17710 "items": { 17711 "type": "string" 17712 } 17713 }, 17714 "labels": { 17715 "description": "The labels set on the Nodes created.", 17716 "type": "object", 17717 "additionalProperties": { 17718 "type": "string" 17719 } 17720 }, 17721 "management_upgrade": { 17722 "description": "Management parameters (Optional).", 17723 "$ref": "#/components/schemas/NodePoolManagementUpgrade" 17724 }, 17725 "node_drain_grace_period": { 17726 "description": "Time to wait for a NodePool to drain when it is upgraded or replaced before it is forcibly removed.", 17727 "$ref": "#/components/schemas/Value" 17728 }, 17729 "replicas": { 17730 "description": "The number of Machines (and Nodes) to create.\nReplicas and autoscaling cannot be used together.", 17731 "type": "integer", 17732 "format": "int32" 17733 }, 17734 "status": { 17735 "description": "NodePool status.", 17736 "$ref": "#/components/schemas/NodePoolStatus" 17737 }, 17738 "subnet": { 17739 "description": "The subnet upon which the nodes are created.", 17740 "type": "string" 17741 }, 17742 "taints": { 17743 "description": "The taints set on the Nodes created.", 17744 "type": "array", 17745 "items": { 17746 "$ref": "#/components/schemas/Taint" 17747 } 17748 }, 17749 "tuning_configs": { 17750 "description": "The names of the tuning configs for this node pool.", 17751 "type": "array", 17752 "items": { 17753 "type": "string" 17754 } 17755 }, 17756 "version": { 17757 "description": "Version of the node pool.", 17758 "$ref": "#/components/schemas/Version" 17759 } 17760 } 17761 }, 17762 "NodePoolAutoscaling": { 17763 "description": "Representation of a autoscaling in a node pool.", 17764 "properties": { 17765 "kind": { 17766 "description": "Indicates the type of this object. Will be 'NodePoolAutoscaling' if this is a complete object or 'NodePoolAutoscalingLink' if it is just a link.", 17767 "type": "string" 17768 }, 17769 "id": { 17770 "description": "Unique identifier of the object.", 17771 "type": "string" 17772 }, 17773 "href": { 17774 "description": "Self link.", 17775 "type": "string" 17776 }, 17777 "max_replica": { 17778 "description": "The maximum number of replicas for the node pool.", 17779 "type": "integer", 17780 "format": "int32" 17781 }, 17782 "min_replica": { 17783 "description": "The minimum number of replicas for the node pool.", 17784 "type": "integer", 17785 "format": "int32" 17786 } 17787 } 17788 }, 17789 "NodePoolManagementUpgrade": { 17790 "description": "Representation of node pool management.", 17791 "properties": { 17792 "kind": { 17793 "description": "Indicates the type of this object. Will be 'NodePoolManagementUpgrade' if this is a complete object or 'NodePoolManagementUpgradeLink' if it is just a link.", 17794 "type": "string" 17795 }, 17796 "id": { 17797 "description": "Unique identifier of the object.", 17798 "type": "string" 17799 }, 17800 "href": { 17801 "description": "Self link.", 17802 "type": "string" 17803 }, 17804 "max_surge": { 17805 "description": "Maximum number of nodes in the NodePool of a ROSA HCP cluster that can be scheduled above the desired number of nodes during the upgrade.", 17806 "type": "string" 17807 }, 17808 "max_unavailable": { 17809 "description": "Maximum number of nodes in the NodePool of a ROSA HCP cluster that can be unavailable during the upgrade.", 17810 "type": "string" 17811 }, 17812 "type": { 17813 "description": "Type of strategy for handling upgrades.", 17814 "type": "string" 17815 } 17816 } 17817 }, 17818 "NodePoolState": { 17819 "description": "Representation of the status of a node pool.", 17820 "properties": { 17821 "kind": { 17822 "description": "Indicates the type of this object. Will be 'NodePoolState' if this is a complete object or 'NodePoolStateLink' if it is just a link.", 17823 "type": "string" 17824 }, 17825 "id": { 17826 "description": "Unique identifier of the object.", 17827 "type": "string" 17828 }, 17829 "href": { 17830 "description": "Self link.", 17831 "type": "string" 17832 }, 17833 "last_updated_timestamp": { 17834 "description": "The current number of replicas for the node pool.", 17835 "type": "string", 17836 "format": "date-time" 17837 }, 17838 "value": { 17839 "description": "The current state of the node pool", 17840 "type": "string" 17841 } 17842 } 17843 }, 17844 "NodePoolStatus": { 17845 "description": "Representation of the status of a node pool.", 17846 "properties": { 17847 "kind": { 17848 "description": "Indicates the type of this object. Will be 'NodePoolStatus' if this is a complete object or 'NodePoolStatusLink' if it is just a link.", 17849 "type": "string" 17850 }, 17851 "id": { 17852 "description": "Unique identifier of the object.", 17853 "type": "string" 17854 }, 17855 "href": { 17856 "description": "Self link.", 17857 "type": "string" 17858 }, 17859 "current_replicas": { 17860 "description": "The current number of replicas for the node pool.", 17861 "type": "integer", 17862 "format": "int32" 17863 }, 17864 "message": { 17865 "description": "Adds additional information about the NodePool status when the node pool doesn't reach the desired replicas.", 17866 "type": "string" 17867 }, 17868 "state": { 17869 "description": "The current state of the node pool", 17870 "$ref": "#/components/schemas/NodePoolState" 17871 } 17872 } 17873 }, 17874 "NodePoolUpgradePolicy": { 17875 "description": "Representation of an upgrade policy that can be set for a node pool.", 17876 "properties": { 17877 "kind": { 17878 "description": "Indicates the type of this object. Will be 'NodePoolUpgradePolicy' if this is a complete object or 'NodePoolUpgradePolicyLink' if it is just a link.", 17879 "type": "string" 17880 }, 17881 "id": { 17882 "description": "Unique identifier of the object.", 17883 "type": "string" 17884 }, 17885 "href": { 17886 "description": "Self link.", 17887 "type": "string" 17888 }, 17889 "cluster_id": { 17890 "description": "Cluster ID this upgrade policy for node pool is defined for.", 17891 "type": "string" 17892 }, 17893 "creation_timestamp": { 17894 "description": "Timestamp for creation of resource.", 17895 "type": "string", 17896 "format": "date-time" 17897 }, 17898 "enable_minor_version_upgrades": { 17899 "description": "Indicates if minor version upgrades are allowed for automatic upgrades (for manual it's always allowed).", 17900 "type": "boolean" 17901 }, 17902 "last_update_timestamp": { 17903 "description": "Timestamp for last update that happened to resource.", 17904 "type": "string", 17905 "format": "date-time" 17906 }, 17907 "next_run": { 17908 "description": "Next time the upgrade should run.", 17909 "type": "string", 17910 "format": "date-time" 17911 }, 17912 "node_pool_id": { 17913 "description": "Node Pool ID this upgrade policy is defined for.", 17914 "type": "string" 17915 }, 17916 "schedule": { 17917 "description": "Schedule cron expression that defines automatic upgrade scheduling.", 17918 "type": "string" 17919 }, 17920 "schedule_type": { 17921 "description": "Schedule type of the upgrade.", 17922 "$ref": "#/components/schemas/ScheduleType" 17923 }, 17924 "state": { 17925 "description": "State of the upgrade policy for the node pool.", 17926 "$ref": "#/components/schemas/UpgradePolicyState" 17927 }, 17928 "upgrade_type": { 17929 "description": "Upgrade type of the node pool.", 17930 "$ref": "#/components/schemas/UpgradeType" 17931 }, 17932 "version": { 17933 "description": "Version is the desired upgrade version.", 17934 "type": "string" 17935 } 17936 } 17937 }, 17938 "NodeType": { 17939 "description": "Type of node received via telemetry.", 17940 "type": "string", 17941 "enum": [ 17942 "compute", 17943 "infra", 17944 "master" 17945 ] 17946 }, 17947 "NodesInfo": { 17948 "description": "Provides information about the nodes in the cluster.", 17949 "properties": { 17950 "nodes": { 17951 "type": "array", 17952 "items": { 17953 "$ref": "#/components/schemas/NodeInfo" 17954 } 17955 } 17956 } 17957 }, 17958 "OidcConfig": { 17959 "description": "Contains the necessary attributes to support oidc configuration hosting under Red Hat or registering a Customer's byo oidc config.", 17960 "properties": { 17961 "href": { 17962 "description": "HREF for the oidc config, filled in response.", 17963 "type": "string" 17964 }, 17965 "id": { 17966 "description": "ID for the oidc config, filled in response.", 17967 "type": "string" 17968 }, 17969 "creation_timestamp": { 17970 "description": "Creation timestamp, filled in response.", 17971 "type": "string", 17972 "format": "date-time" 17973 }, 17974 "installer_role_arn": { 17975 "description": "ARN of the AWS role to assume when installing the cluster as to reveal the secret, supplied in request. It is only to be used in Unmanaged Oidc Config.", 17976 "type": "string" 17977 }, 17978 "issuer_url": { 17979 "description": "Issuer URL, filled in response when Managed and supplied in Unmanaged.", 17980 "type": "string" 17981 }, 17982 "last_update_timestamp": { 17983 "description": "Last update timestamp, filled when patching a valid attribute of this oidc config.", 17984 "type": "string", 17985 "format": "date-time" 17986 }, 17987 "last_used_timestamp": { 17988 "description": "Last used timestamp, filled by the latest cluster that used this oidc config.", 17989 "type": "string", 17990 "format": "date-time" 17991 }, 17992 "managed": { 17993 "description": "Indicates whether it is Managed or Unmanaged (Customer hosted).", 17994 "type": "boolean" 17995 }, 17996 "organization_id": { 17997 "description": "Organization ID, filled in response respecting token provided.", 17998 "type": "string" 17999 }, 18000 "reusable": { 18001 "description": "Indicates whether the Oidc Config can be reused.", 18002 "type": "boolean" 18003 }, 18004 "secret_arn": { 18005 "description": "Secrets Manager ARN for the OIDC private key, supplied in request. It is only to be used in Unmanaged Oidc Config.", 18006 "type": "string" 18007 } 18008 } 18009 }, 18010 "OidcThumbprint": { 18011 "description": "Contains the necessary attributes to support oidc configuration thumbprint operations such as fetching/creation of a thumbprint", 18012 "properties": { 18013 "href": { 18014 "description": "HREF for the oidc config thumbprint, filled in response.", 18015 "type": "string" 18016 }, 18017 "cluster_id": { 18018 "description": "ClusterId is the for the cluster used, filled in response.", 18019 "type": "string" 18020 }, 18021 "kind": { 18022 "description": "Kind is the resource type, filled in response.", 18023 "type": "string" 18024 }, 18025 "oidc_config_id": { 18026 "description": "OidcConfigId is the ID for the oidc config used, filled in response.", 18027 "type": "string" 18028 }, 18029 "thumbprint": { 18030 "description": "Thumbprint is the thumbprint itself, filled in response.", 18031 "type": "string" 18032 } 18033 } 18034 }, 18035 "OidcThumbprintInput": { 18036 "description": "Contains the necessary attributes to fetch an OIDC Configuration thumbprint", 18037 "properties": { 18038 "cluster_id": { 18039 "description": "ClusterId is the for the cluster used, exclusive from OidcConfigId.", 18040 "type": "string" 18041 }, 18042 "oidc_config_id": { 18043 "description": "OidcConfigId is the ID for the oidc config used, exclusive from ClusterId.", 18044 "type": "string" 18045 } 18046 } 18047 }, 18048 "OpenIDClaims": { 18049 "description": "_OpenID_ identity provider claims.", 18050 "properties": { 18051 "email": { 18052 "description": "List of claims to use as the mail address.", 18053 "type": "array", 18054 "items": { 18055 "type": "string" 18056 } 18057 }, 18058 "groups": { 18059 "description": "List of claims to use as the group name.", 18060 "type": "array", 18061 "items": { 18062 "type": "string" 18063 } 18064 }, 18065 "name": { 18066 "description": "List of claims to use as the display name.", 18067 "type": "array", 18068 "items": { 18069 "type": "string" 18070 } 18071 }, 18072 "preferred_username": { 18073 "description": "List of claims to use as the preferred user name when provisioning a user.", 18074 "type": "array", 18075 "items": { 18076 "type": "string" 18077 } 18078 } 18079 } 18080 }, 18081 "OpenIDIdentityProvider": { 18082 "description": "Details for `openid` identity providers.", 18083 "properties": { 18084 "ca": { 18085 "description": "Certificate bunde to use to validate server certificates for the configured URL.", 18086 "type": "string" 18087 }, 18088 "claims": { 18089 "description": "Claims used to configure the provider.", 18090 "$ref": "#/components/schemas/OpenIDClaims" 18091 }, 18092 "client_id": { 18093 "description": "Identifier of a client registered with the _OpenID_ provider.", 18094 "type": "string" 18095 }, 18096 "client_secret": { 18097 "description": "Client secret.", 18098 "type": "string" 18099 }, 18100 "extra_authorize_parameters": { 18101 "description": "Optional map of extra parameters to add to the authorization token request.", 18102 "type": "object", 18103 "additionalProperties": { 18104 "type": "string" 18105 } 18106 }, 18107 "extra_scopes": { 18108 "description": "Optional list of scopes to request, in addition to the `openid` scope, during the\nauthorization token request.", 18109 "type": "array", 18110 "items": { 18111 "type": "string" 18112 } 18113 }, 18114 "issuer": { 18115 "description": "The URL that the OpenID Provider asserts as the Issuer Identifier", 18116 "type": "string" 18117 } 18118 } 18119 }, 18120 "OperatorIAMRole": { 18121 "description": "Contains the necessary attributes to allow each operator to access the necessary AWS resources", 18122 "properties": { 18123 "id": { 18124 "description": "Randomly-generated ID to identify the operator role", 18125 "type": "string" 18126 }, 18127 "name": { 18128 "description": "Name of the credentials secret used to access cloud resources", 18129 "type": "string" 18130 }, 18131 "namespace": { 18132 "description": "Namespace where the credentials secret lives in the cluster", 18133 "type": "string" 18134 }, 18135 "role_arn": { 18136 "description": "Role to assume when accessing AWS resources", 18137 "type": "string" 18138 }, 18139 "service_account": { 18140 "description": "Service account name to use when authenticating", 18141 "type": "string" 18142 } 18143 } 18144 }, 18145 "OrganizationLink": { 18146 "description": "Definition of an organization link.", 18147 "properties": { 18148 "href": { 18149 "description": "HREF for the Organization, filled in response.", 18150 "type": "string" 18151 }, 18152 "id": { 18153 "description": "The organization's ID.", 18154 "type": "string" 18155 } 18156 } 18157 }, 18158 "PendingDeleteCluster": { 18159 "description": "Represents a pending delete entry for a specific cluster.", 18160 "properties": { 18161 "kind": { 18162 "description": "Indicates the type of this object. Will be 'PendingDeleteCluster' if this is a complete object or 'PendingDeleteClusterLink' if it is just a link.", 18163 "type": "string" 18164 }, 18165 "id": { 18166 "description": "Unique identifier of the object.", 18167 "type": "string" 18168 }, 18169 "href": { 18170 "description": "Self link.", 18171 "type": "string" 18172 }, 18173 "best_effort": { 18174 "description": "Flag indicating if the cluster deletion should be best-effort mode or not.", 18175 "type": "boolean" 18176 }, 18177 "cluster": { 18178 "description": "Cluster is the details of the cluster that is pending deletion.", 18179 "$ref": "#/components/schemas/Cluster" 18180 }, 18181 "creation_timestamp": { 18182 "description": "Date and time when the cluster was initially created, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 18183 "type": "string", 18184 "format": "date-time" 18185 } 18186 } 18187 }, 18188 "Platform": { 18189 "description": "Representation of an platform type field.", 18190 "type": "string", 18191 "enum": [ 18192 "aws", 18193 "aws-classic", 18194 "aws-hosted-cp", 18195 "gcp", 18196 "hostedcluster" 18197 ] 18198 }, 18199 "PrivateLinkClusterConfiguration": { 18200 "description": "Manages the configuration for the Private Links.", 18201 "properties": { 18202 "principals": { 18203 "description": "List of additional principals for the Private Link", 18204 "type": "array", 18205 "items": { 18206 "$ref": "#/components/schemas/PrivateLinkPrincipal" 18207 } 18208 } 18209 } 18210 }, 18211 "PrivateLinkConfiguration": { 18212 "description": "Manages the configuration for the Private Links.", 18213 "properties": { 18214 "principals": { 18215 "description": "List of additional principals for the Private Link", 18216 "$ref": "#/components/schemas/PrivateLinkPrincipals" 18217 } 18218 } 18219 }, 18220 "PrivateLinkPrincipal": { 18221 "properties": { 18222 "kind": { 18223 "description": "Indicates the type of this object. Will be 'PrivateLinkPrincipal' if this is a complete object or 'PrivateLinkPrincipalLink' if it is just a link.", 18224 "type": "string" 18225 }, 18226 "id": { 18227 "description": "Unique identifier of the object.", 18228 "type": "string" 18229 }, 18230 "href": { 18231 "description": "Self link.", 18232 "type": "string" 18233 }, 18234 "principal": { 18235 "description": "ARN for a principal that is allowed for this Private Link.", 18236 "type": "string" 18237 } 18238 } 18239 }, 18240 "PrivateLinkPrincipals": { 18241 "description": "Contains a list of principals for the Private Link.", 18242 "properties": { 18243 "kind": { 18244 "description": "Indicates the type of this object. Will be 'PrivateLinkPrincipals' if this is a complete object or 'PrivateLinkPrincipalsLink' if it is just a link.", 18245 "type": "string" 18246 }, 18247 "id": { 18248 "description": "Unique identifier of the object.", 18249 "type": "string" 18250 }, 18251 "href": { 18252 "description": "Self link.", 18253 "type": "string" 18254 }, 18255 "principals": { 18256 "description": "List of additional principals for the Private Link", 18257 "type": "array", 18258 "items": { 18259 "$ref": "#/components/schemas/PrivateLinkPrincipal" 18260 } 18261 } 18262 } 18263 }, 18264 "ProcessorType": { 18265 "description": "Processor type category.", 18266 "type": "string", 18267 "enum": [ 18268 "amd64", 18269 "arm64" 18270 ] 18271 }, 18272 "Product": { 18273 "description": "Representation of an product that can be selected as a cluster type.", 18274 "properties": { 18275 "kind": { 18276 "description": "Indicates the type of this object. Will be 'Product' if this is a complete object or 'ProductLink' if it is just a link.", 18277 "type": "string" 18278 }, 18279 "id": { 18280 "description": "Unique identifier of the object.", 18281 "type": "string" 18282 }, 18283 "href": { 18284 "description": "Self link.", 18285 "type": "string" 18286 }, 18287 "name": { 18288 "description": "Name of the product.", 18289 "type": "string" 18290 } 18291 } 18292 }, 18293 "ProductMinimalVersion": { 18294 "description": "Representation of a product minimal version.", 18295 "properties": { 18296 "kind": { 18297 "description": "Indicates the type of this object. Will be 'ProductMinimalVersion' if this is a complete object or 'ProductMinimalVersionLink' if it is just a link.", 18298 "type": "string" 18299 }, 18300 "id": { 18301 "description": "Unique identifier of the object.", 18302 "type": "string" 18303 }, 18304 "href": { 18305 "description": "Self link.", 18306 "type": "string" 18307 }, 18308 "rosa_cli": { 18309 "description": "The ROSA CLI minimal version.", 18310 "type": "string" 18311 }, 18312 "start_date": { 18313 "description": "The start date for this minimal version.", 18314 "type": "string", 18315 "format": "date-time" 18316 } 18317 } 18318 }, 18319 "ProductTechnologyPreview": { 18320 "description": "Representation of a product technology preview.", 18321 "properties": { 18322 "kind": { 18323 "description": "Indicates the type of this object. Will be 'ProductTechnologyPreview' if this is a complete object or 'ProductTechnologyPreviewLink' if it is just a link.", 18324 "type": "string" 18325 }, 18326 "id": { 18327 "description": "Unique identifier of the object.", 18328 "type": "string" 18329 }, 18330 "href": { 18331 "description": "Self link.", 18332 "type": "string" 18333 }, 18334 "additional_text": { 18335 "description": "Message associated with this technology preview.", 18336 "type": "string" 18337 }, 18338 "end_date": { 18339 "description": "The end date for this technology preview.", 18340 "type": "string", 18341 "format": "date-time" 18342 }, 18343 "start_date": { 18344 "description": "The start date for this technology preview.", 18345 "type": "string", 18346 "format": "date-time" 18347 } 18348 } 18349 }, 18350 "ProvisionShard": { 18351 "description": "Contains the properties of the provision shard, including AWS and GCP related configurations", 18352 "properties": { 18353 "kind": { 18354 "description": "Indicates the type of this object. Will be 'ProvisionShard' if this is a complete object or 'ProvisionShardLink' if it is just a link.", 18355 "type": "string" 18356 }, 18357 "id": { 18358 "description": "Unique identifier of the object.", 18359 "type": "string" 18360 }, 18361 "href": { 18362 "description": "Self link.", 18363 "type": "string" 18364 }, 18365 "aws_account_operator_config": { 18366 "description": "Contains the configuration for the AWS account operator.", 18367 "$ref": "#/components/schemas/ServerConfig" 18368 }, 18369 "aws_base_domain": { 18370 "description": "Contains the AWS base domain.", 18371 "type": "string" 18372 }, 18373 "gcp_base_domain": { 18374 "description": "Contains the GCP base domain.", 18375 "type": "string" 18376 }, 18377 "gcp_project_operator": { 18378 "description": "Contains the configuration for the GCP project operator.", 18379 "$ref": "#/components/schemas/ServerConfig" 18380 }, 18381 "cloud_provider": { 18382 "description": "Contains the cloud provider name.", 18383 "$ref": "#/components/schemas/CloudProvider" 18384 }, 18385 "creation_timestamp": { 18386 "description": "Date and time when the provision shard was initially created, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 18387 "type": "string", 18388 "format": "date-time" 18389 }, 18390 "hive_config": { 18391 "description": "Contains the configuration for Hive.", 18392 "$ref": "#/components/schemas/ServerConfig" 18393 }, 18394 "hypershift_config": { 18395 "description": "Contains the configuration for Hypershift.", 18396 "$ref": "#/components/schemas/ServerConfig" 18397 }, 18398 "last_update_timestamp": { 18399 "description": "Date and time when the provision shard was last updated, using the\nformat defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt).", 18400 "type": "string", 18401 "format": "date-time" 18402 }, 18403 "management_cluster": { 18404 "description": "Contains the name of the management cluster for Hypershift clusters that are assigned to this shard.\nThis field is populated by OCM, and must not be overwritten via API.", 18405 "type": "string" 18406 }, 18407 "region": { 18408 "description": "Contains the cloud-provider region in which the provisioner spins up the cluster.", 18409 "$ref": "#/components/schemas/CloudRegion" 18410 }, 18411 "status": { 18412 "description": "Status of the provision shard. Possible values: active/maintenance/offline.", 18413 "type": "string" 18414 } 18415 } 18416 }, 18417 "ProvisionShardTopology": { 18418 "type": "string", 18419 "enum": [ 18420 "dedicated" 18421 ] 18422 }, 18423 "Proxy": { 18424 "description": "Proxy configuration of a cluster.", 18425 "properties": { 18426 "http_proxy": { 18427 "description": "HTTPProxy is the URL of the proxy for HTTP requests.", 18428 "type": "string" 18429 }, 18430 "https_proxy": { 18431 "description": "HTTPSProxy is the URL of the proxy for HTTPS requests.", 18432 "type": "string" 18433 }, 18434 "no_proxy": { 18435 "description": "NoProxy is a comma-separated list of domains and CIDRs for which \nthe proxy should not be used", 18436 "type": "string" 18437 } 18438 } 18439 }, 18440 "RegistryAllowlist": { 18441 "description": "RegistryAllowlist represents a single registry allowlist.", 18442 "properties": { 18443 "kind": { 18444 "description": "Indicates the type of this object. Will be 'RegistryAllowlist' if this is a complete object or 'RegistryAllowlistLink' if it is just a link.", 18445 "type": "string" 18446 }, 18447 "id": { 18448 "description": "Unique identifier of the object.", 18449 "type": "string" 18450 }, 18451 "href": { 18452 "description": "Self link.", 18453 "type": "string" 18454 }, 18455 "cloud_provider": { 18456 "description": "CloudProvider is the cloud provider for which this allowlist is valid.", 18457 "$ref": "#/components/schemas/CloudProvider" 18458 }, 18459 "creation_timestamp": { 18460 "description": "CreationTimestamp is the date and time when the allow list has been created.", 18461 "type": "string", 18462 "format": "date-time" 18463 }, 18464 "registries": { 18465 "description": "Registries is the list of registries contained in this Allowlist.", 18466 "type": "array", 18467 "items": { 18468 "type": "string" 18469 } 18470 } 18471 } 18472 }, 18473 "RegistryLocation": { 18474 "description": "RegistryLocation contains a location of the registry specified by the registry domain\nname. The domain name might include wildcards, like '*' or '??'.", 18475 "properties": { 18476 "domain_name": { 18477 "description": "domainName specifies a domain name for the registry\nIn case the registry use non-standard (80 or 443) port, the port should be included\nin the domain name as well.", 18478 "type": "string" 18479 }, 18480 "insecure": { 18481 "description": "insecure indicates whether the registry is secure (https) or insecure (http)\nBy default (if not specified) the registry is assumed as secure.", 18482 "type": "boolean" 18483 } 18484 } 18485 }, 18486 "RegistrySources": { 18487 "description": "RegistrySources contains configuration that determines how the container runtime should treat individual\nregistries when accessing images for builds and pods. For instance, whether or not to allow insecure access.\nIt does not contain configuration for the internal cluster registry.", 18488 "properties": { 18489 "allowed_registries": { 18490 "description": "AllowedRegistries: registries for which image pull and push actions are allowed.\nTo specify all subdomains, add the asterisk (*) wildcard character as a prefix to the domain name.\nFor example, *.example.com. You can specify an individual repository within a registry.\nFor example: reg1.io/myrepo/myapp:latest. All other registries are blocked.\nMutually exclusive with `BlockedRegistries`", 18491 "type": "array", 18492 "items": { 18493 "type": "string" 18494 } 18495 }, 18496 "blocked_registries": { 18497 "description": "BlockedRegistries: registries for which image pull and push actions are denied.\nTo specify all subdomains, add the asterisk (*) wildcard character as a prefix to the domain name.\nFor example, *.example.com. You can specify an individual repository within a registry.\nFor example: reg1.io/myrepo/myapp:latest. All other registries are allowed.\nMutually exclusive with `AllowedRegistries`", 18498 "type": "array", 18499 "items": { 18500 "type": "string" 18501 } 18502 }, 18503 "insecure_registries": { 18504 "description": "InsecureRegistries are registries which do not have a valid TLS certificate or only support HTTP connections.\nTo specify all subdomains, add the asterisk (*) wildcard character as a prefix to the domain name.\nFor example, *.example.com. You can specify an individual repository within a registry.\nFor example: reg1.io/myrepo/myapp:latest.", 18505 "type": "array", 18506 "items": { 18507 "type": "string" 18508 } 18509 } 18510 } 18511 }, 18512 "ReleaseImageDetails": { 18513 "properties": { 18514 "available_upgrades": { 18515 "description": "AvailableUpgrades is the list of versions this version can be upgraded to.", 18516 "type": "array", 18517 "items": { 18518 "type": "string" 18519 } 18520 }, 18521 "release_image": { 18522 "description": "ReleaseImage contains the URI of Openshift release image.", 18523 "type": "string" 18524 } 18525 } 18526 }, 18527 "ReleaseImages": { 18528 "properties": { 18529 "arm64": { 18530 "description": "Arm64 will contain the reference for the arm64 image which will be used for cluster deployments", 18531 "$ref": "#/components/schemas/ReleaseImageDetails" 18532 }, 18533 "multi": { 18534 "description": "Multi will contain the reference for the multi image which will be used for cluster deployments", 18535 "$ref": "#/components/schemas/ReleaseImageDetails" 18536 } 18537 } 18538 }, 18539 "ResourceRange": { 18540 "properties": { 18541 "max": { 18542 "type": "integer", 18543 "format": "int32" 18544 }, 18545 "min": { 18546 "type": "integer", 18547 "format": "int32" 18548 } 18549 } 18550 }, 18551 "RolePolicy": { 18552 "properties": { 18553 "arn": { 18554 "type": "string" 18555 }, 18556 "name": { 18557 "type": "string" 18558 }, 18559 "type": { 18560 "type": "string" 18561 } 18562 } 18563 }, 18564 "RolePolicyBinding": { 18565 "properties": { 18566 "arn": { 18567 "type": "string" 18568 }, 18569 "creation_timestamp": { 18570 "type": "string", 18571 "format": "date-time" 18572 }, 18573 "last_update_timestamp": { 18574 "type": "string", 18575 "format": "date-time" 18576 }, 18577 "name": { 18578 "type": "string" 18579 }, 18580 "policies": { 18581 "type": "array", 18582 "items": { 18583 "$ref": "#/components/schemas/RolePolicy" 18584 } 18585 }, 18586 "status": { 18587 "$ref": "#/components/schemas/RolePolicyBindingStatus" 18588 }, 18589 "type": { 18590 "type": "string" 18591 } 18592 } 18593 }, 18594 "RolePolicyBindingStatus": { 18595 "properties": { 18596 "description": { 18597 "type": "string" 18598 }, 18599 "value": { 18600 "type": "string" 18601 } 18602 } 18603 }, 18604 "RootVolume": { 18605 "description": "Root volume capabilities.", 18606 "properties": { 18607 "aws": { 18608 "description": "AWS volume specification", 18609 "$ref": "#/components/schemas/AWSVolume" 18610 }, 18611 "gcp": { 18612 "description": "GCP Volume specification", 18613 "$ref": "#/components/schemas/GCPVolume" 18614 } 18615 } 18616 }, 18617 "ScheduleType": { 18618 "description": "ScheduleType defines which type of scheduling should be used for the upgrade policy.", 18619 "type": "string", 18620 "enum": [ 18621 "automatic", 18622 "manual" 18623 ] 18624 }, 18625 "SdnToOvnClusterMigration": { 18626 "description": "Details for `SdnToOvn` cluster migrations.", 18627 "properties": { 18628 "join_ipv4": { 18629 "description": "The IP address range to use for the internalJoinSubnet parameter of OVN-Kubernetes\nupon migration.", 18630 "type": "string" 18631 }, 18632 "masquerade_ipv4": { 18633 "description": "The IP address range to us for the internalMasqueradeSubnet parameter of OVN-Kubernetes\nupon migration.", 18634 "type": "string" 18635 }, 18636 "transit_ipv4": { 18637 "description": "The IP address range to use for the internalTransSwitchSubnet parameter of OVN-Kubernetes\nupon migration.", 18638 "type": "string" 18639 } 18640 } 18641 }, 18642 "SecurityGroup": { 18643 "description": "AWS security group object", 18644 "properties": { 18645 "id": { 18646 "description": "The security group ID.", 18647 "type": "string" 18648 }, 18649 "name": { 18650 "description": "Name of the security group according to its `Name` tag on AWS.", 18651 "type": "string" 18652 }, 18653 "red_hat_managed": { 18654 "description": "If the resource is RH managed.", 18655 "type": "boolean" 18656 } 18657 } 18658 }, 18659 "ServerConfig": { 18660 "description": "Representation of a server config", 18661 "properties": { 18662 "kind": { 18663 "description": "Indicates the type of this object. Will be 'ServerConfig' if this is a complete object or 'ServerConfigLink' if it is just a link.", 18664 "type": "string" 18665 }, 18666 "id": { 18667 "description": "Unique identifier of the object.", 18668 "type": "string" 18669 }, 18670 "href": { 18671 "description": "Self link.", 18672 "type": "string" 18673 }, 18674 "aws_shard": { 18675 "description": "Config for AWS provision shards", 18676 "$ref": "#/components/schemas/AWSShard" 18677 }, 18678 "kubeconfig": { 18679 "description": "The kubeconfig of the server.", 18680 "type": "string" 18681 }, 18682 "server": { 18683 "description": "The URL of the server.", 18684 "type": "string" 18685 }, 18686 "topology": { 18687 "description": "The topology of a provision shard (Optional).", 18688 "$ref": "#/components/schemas/ProvisionShardTopology" 18689 } 18690 } 18691 }, 18692 "SocketTotalNodeRoleOSMetricNode": { 18693 "description": "Representation of information from telemetry about a the socket capacity\nby node role and OS.", 18694 "properties": { 18695 "node_roles": { 18696 "description": "Representation of the node role for a cluster.", 18697 "type": "array", 18698 "items": { 18699 "type": "string" 18700 } 18701 }, 18702 "operating_system": { 18703 "description": "The operating system.", 18704 "type": "string" 18705 }, 18706 "socket_total": { 18707 "description": "The total socket capacity of nodes with this set of roles and operating system.", 18708 "type": "number", 18709 "format": "float" 18710 }, 18711 "time": { 18712 "type": "string", 18713 "format": "date-time" 18714 } 18715 } 18716 }, 18717 "SocketTotalsNodeRoleOSMetricNode": { 18718 "description": "Representation of information from telemetry about the socket capacity by node\nrole and OS of a cluster.", 18719 "properties": { 18720 "socket_totals": { 18721 "type": "array", 18722 "items": { 18723 "$ref": "#/components/schemas/SocketTotalNodeRoleOSMetricNode" 18724 } 18725 } 18726 } 18727 }, 18728 "StorageQuota": { 18729 "description": "Representation of a storage quota ", 18730 "properties": { 18731 "unit": { 18732 "description": "Unit of storage", 18733 "type": "string" 18734 }, 18735 "value": { 18736 "description": "Numerical value", 18737 "type": "number", 18738 "format": "float" 18739 } 18740 } 18741 }, 18742 "StsSupportJumpRole": { 18743 "description": "Isolated STS support role created per organization.", 18744 "properties": { 18745 "role_arn": { 18746 "description": "ARN of the support role created in the SRE jump account.", 18747 "type": "string" 18748 } 18749 } 18750 }, 18751 "SubnetNetworkVerification": { 18752 "properties": { 18753 "kind": { 18754 "description": "Indicates the type of this object. Will be 'SubnetNetworkVerification' if this is a complete object or 'SubnetNetworkVerificationLink' if it is just a link.", 18755 "type": "string" 18756 }, 18757 "id": { 18758 "description": "Unique identifier of the object.", 18759 "type": "string" 18760 }, 18761 "href": { 18762 "description": "Self link.", 18763 "type": "string" 18764 }, 18765 "details": { 18766 "description": "Slice of failures that happened during a subnet network verification.", 18767 "type": "array", 18768 "items": { 18769 "type": "string" 18770 } 18771 }, 18772 "platform": { 18773 "description": "Platform supplied to the network verifier for this subnet.", 18774 "$ref": "#/components/schemas/Platform" 18775 }, 18776 "state": { 18777 "description": "State of the subnet network verification.", 18778 "type": "string" 18779 }, 18780 "tags": { 18781 "description": "Tags supplied to the network verifier for this subnet.", 18782 "type": "object", 18783 "additionalProperties": { 18784 "type": "string" 18785 } 18786 } 18787 } 18788 }, 18789 "Subnetwork": { 18790 "description": "AWS subnetwork object to be used while installing a cluster", 18791 "properties": { 18792 "cidr_block": { 18793 "description": "The CIDR Block of the subnet.", 18794 "type": "string" 18795 }, 18796 "availability_zone": { 18797 "description": "The availability zone to which the subnet is related.", 18798 "type": "string" 18799 }, 18800 "name": { 18801 "description": "Name of the subnet according to its `Name` tag on AWS.", 18802 "type": "string" 18803 }, 18804 "public": { 18805 "description": "Whether or not it is a public subnet.", 18806 "type": "boolean" 18807 }, 18808 "red_hat_managed": { 18809 "description": "If the resource is RH managed.", 18810 "type": "boolean" 18811 }, 18812 "subnet_id": { 18813 "description": "The subnet ID to be used while installing a cluster.", 18814 "type": "string" 18815 } 18816 } 18817 }, 18818 "Subscription": { 18819 "description": "Definition of a subscription.", 18820 "properties": { 18821 "kind": { 18822 "description": "Indicates the type of this object. Will be 'Subscription' if this is a complete object or 'SubscriptionLink' if it is just a link.", 18823 "type": "string" 18824 }, 18825 "id": { 18826 "description": "Unique identifier of the object.", 18827 "type": "string" 18828 }, 18829 "href": { 18830 "description": "Self link.", 18831 "type": "string" 18832 } 18833 } 18834 }, 18835 "Syncset": { 18836 "description": "Representation of a syncset.", 18837 "properties": { 18838 "kind": { 18839 "description": "Indicates the type of this object. Will be 'Syncset' if this is a complete object or 'SyncsetLink' if it is just a link.", 18840 "type": "string" 18841 }, 18842 "id": { 18843 "description": "Unique identifier of the object.", 18844 "type": "string" 18845 }, 18846 "href": { 18847 "description": "Self link.", 18848 "type": "string" 18849 }, 18850 "resources": { 18851 "description": "List of k8s objects to configure for the cluster.", 18852 "type": "array", 18853 "items": { 18854 "type": "object" 18855 } 18856 } 18857 } 18858 }, 18859 "Taint": { 18860 "description": "Representation of a Taint set on a MachinePool in a cluster.", 18861 "properties": { 18862 "effect": { 18863 "description": "The effect on the node for the pods matching the taint, i.e: NoSchedule, NoExecute, PreferNoSchedule.", 18864 "type": "string" 18865 }, 18866 "key": { 18867 "description": "The key for the taint", 18868 "type": "string" 18869 }, 18870 "value": { 18871 "description": "The value for the taint.", 18872 "type": "string" 18873 } 18874 } 18875 }, 18876 "TokenClaimMappings": { 18877 "description": "The claim mappings defined for users and groups.", 18878 "properties": { 18879 "groups": { 18880 "description": "Groups is a name of the claim that should be used to construct groups for the cluster identity.", 18881 "$ref": "#/components/schemas/GroupsClaim" 18882 }, 18883 "username": { 18884 "description": "Username is a name of the claim that should be used to construct usernames for the cluster identity.", 18885 "$ref": "#/components/schemas/UsernameClaim" 18886 } 18887 } 18888 }, 18889 "TokenClaimValidationRule": { 18890 "description": "The rule that is applied to validate token claims to authenticate users.", 18891 "properties": { 18892 "claim": { 18893 "description": "Claim is a name of a required claim.", 18894 "type": "string" 18895 }, 18896 "required_value": { 18897 "description": "RequiredValue is the required value for the claim.", 18898 "type": "string" 18899 } 18900 } 18901 }, 18902 "TokenIssuer": { 18903 "description": "Representation of a token issuer used in an external authentication.", 18904 "properties": { 18905 "ca": { 18906 "description": "Certificate bundle to use to validate server certificates for the configured URL.", 18907 "type": "string" 18908 }, 18909 "url": { 18910 "description": "URL is the serving URL of the token issuer.\nIt must be a valid url and use the 'https' scheme.\nThis is required.", 18911 "type": "string" 18912 }, 18913 "audiences": { 18914 "description": "Audiences is an array of audiences that the token was issued for.\nValid tokens must include at least one of these values in their\n\"aud\" claim.\nMust have at least one audience and a maximum of ten.\nAny clients defined for this external authentication must have their id included here.", 18915 "type": "array", 18916 "items": { 18917 "type": "string" 18918 } 18919 } 18920 } 18921 }, 18922 "TrustedIp": { 18923 "description": "Representation of a trusted ip address in clusterdeployment.", 18924 "properties": { 18925 "kind": { 18926 "description": "Indicates the type of this object. Will be 'TrustedIp' if this is a complete object or 'TrustedIpLink' if it is just a link.", 18927 "type": "string" 18928 }, 18929 "id": { 18930 "description": "Unique identifier of the object.", 18931 "type": "string" 18932 }, 18933 "href": { 18934 "description": "Self link.", 18935 "type": "string" 18936 }, 18937 "enabled": { 18938 "description": "The boolean set to show if the ip is enabled.", 18939 "type": "boolean" 18940 } 18941 } 18942 }, 18943 "TuningConfig": { 18944 "description": "Representation of a tuning config.", 18945 "properties": { 18946 "kind": { 18947 "description": "Indicates the type of this object. Will be 'TuningConfig' if this is a complete object or 'TuningConfigLink' if it is just a link.", 18948 "type": "string" 18949 }, 18950 "id": { 18951 "description": "Unique identifier of the object.", 18952 "type": "string" 18953 }, 18954 "href": { 18955 "description": "Self link.", 18956 "type": "string" 18957 }, 18958 "name": { 18959 "description": "Name of the tuning config.", 18960 "type": "string" 18961 }, 18962 "spec": { 18963 "description": "Spec of the tuning config.", 18964 "type": "object" 18965 } 18966 } 18967 }, 18968 "UpgradePolicy": { 18969 "description": "Representation of an upgrade policy that can be set for a cluster.", 18970 "properties": { 18971 "kind": { 18972 "description": "Indicates the type of this object. Will be 'UpgradePolicy' if this is a complete object or 'UpgradePolicyLink' if it is just a link.", 18973 "type": "string" 18974 }, 18975 "id": { 18976 "description": "Unique identifier of the object.", 18977 "type": "string" 18978 }, 18979 "href": { 18980 "description": "Self link.", 18981 "type": "string" 18982 }, 18983 "cluster_id": { 18984 "description": "Cluster ID this upgrade policy is defined for.", 18985 "type": "string" 18986 }, 18987 "enable_minor_version_upgrades": { 18988 "description": "Indicates if minor version upgrades are allowed for automatic upgrades (for manual it's always allowed).", 18989 "type": "boolean" 18990 }, 18991 "next_run": { 18992 "description": "Next time the upgrade should run.", 18993 "type": "string", 18994 "format": "date-time" 18995 }, 18996 "schedule": { 18997 "description": "Schedule cron expression that defines automatic upgrade scheduling.", 18998 "type": "string" 18999 }, 19000 "schedule_type": { 19001 "description": "Schedule type of the upgrade.", 19002 "$ref": "#/components/schemas/ScheduleType" 19003 }, 19004 "upgrade_type": { 19005 "description": "Upgrade type specify the type of the upgrade.", 19006 "$ref": "#/components/schemas/UpgradeType" 19007 }, 19008 "version": { 19009 "description": "Version is the desired upgrade version.", 19010 "type": "string" 19011 } 19012 } 19013 }, 19014 "UpgradePolicyState": { 19015 "description": "Representation of an upgrade policy state that that is set for a cluster.", 19016 "properties": { 19017 "kind": { 19018 "description": "Indicates the type of this object. Will be 'UpgradePolicyState' if this is a complete object or 'UpgradePolicyStateLink' if it is just a link.", 19019 "type": "string" 19020 }, 19021 "id": { 19022 "description": "Unique identifier of the object.", 19023 "type": "string" 19024 }, 19025 "href": { 19026 "description": "Self link.", 19027 "type": "string" 19028 }, 19029 "description": { 19030 "description": "Description of the state.", 19031 "type": "string" 19032 }, 19033 "value": { 19034 "description": "State value can be 'pending', 'scheduled', 'cancelled', 'started', 'delayed', \n'failed' or 'completed'.", 19035 "$ref": "#/components/schemas/UpgradePolicyStateValue" 19036 } 19037 } 19038 }, 19039 "UpgradePolicyStateValue": { 19040 "description": "Overall state of a cluster upgrade policy.", 19041 "type": "string", 19042 "enum": [ 19043 "cancelled", 19044 "completed", 19045 "delayed", 19046 "failed", 19047 "pending", 19048 "scheduled", 19049 "started" 19050 ] 19051 }, 19052 "UpgradeType": { 19053 "description": "UpgradeType defines which type of upgrade should be used.", 19054 "type": "string", 19055 "enum": [ 19056 "OSD", 19057 "ADDON", 19058 "ControlPlane", 19059 "NodePool" 19060 ] 19061 }, 19062 "User": { 19063 "description": "Representation of a user.", 19064 "properties": { 19065 "kind": { 19066 "description": "Indicates the type of this object. Will be 'User' if this is a complete object or 'UserLink' if it is just a link.", 19067 "type": "string" 19068 }, 19069 "id": { 19070 "description": "Unique identifier of the object.", 19071 "type": "string" 19072 }, 19073 "href": { 19074 "description": "Self link.", 19075 "type": "string" 19076 } 19077 } 19078 }, 19079 "UsernameClaim": { 19080 "description": "The username claim mapping.", 19081 "properties": { 19082 "claim": { 19083 "description": "The claim used in the token.", 19084 "type": "string" 19085 }, 19086 "prefix": { 19087 "description": "A prefix contatenated in the claim (Optional).", 19088 "type": "string" 19089 }, 19090 "prefix_policy": { 19091 "description": "PrefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to\nprevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nIf a prefix is defined, this will be set to 'Prefix' by default.", 19092 "type": "string" 19093 } 19094 } 19095 }, 19096 "Value": { 19097 "description": "Numeric value and the unit used to measure it.\n\nUnits are not mandatory, and they're not specified for some resources. For\nresources that use bytes, the accepted units are:\n\n- 1 B = 1 byte\n- 1 KB = 10^3 bytes\n- 1 MB = 10^6 bytes\n- 1 GB = 10^9 bytes\n- 1 TB = 10^12 bytes\n- 1 PB = 10^15 bytes\n\n- 1 B = 1 byte\n- 1 KiB = 2^10 bytes\n- 1 MiB = 2^20 bytes\n- 1 GiB = 2^30 bytes\n- 1 TiB = 2^40 bytes\n- 1 PiB = 2^50 bytes", 19098 "properties": { 19099 "unit": { 19100 "description": "Name of the unit used to measure the value.", 19101 "type": "string" 19102 }, 19103 "value": { 19104 "description": "Numeric value.", 19105 "type": "number", 19106 "format": "float" 19107 } 19108 } 19109 }, 19110 "Version": { 19111 "description": "Representation of an _OpenShift_ version.", 19112 "properties": { 19113 "kind": { 19114 "description": "Indicates the type of this object. Will be 'Version' if this is a complete object or 'VersionLink' if it is just a link.", 19115 "type": "string" 19116 }, 19117 "id": { 19118 "description": "Unique identifier of the object.", 19119 "type": "string" 19120 }, 19121 "href": { 19122 "description": "Self link.", 19123 "type": "string" 19124 }, 19125 "gcp_marketplace_enabled": { 19126 "description": "GCPMarketplaceEnabled indicates if this version can be used to create GCP Marketplace clusters.", 19127 "type": "boolean" 19128 }, 19129 "rosa_enabled": { 19130 "description": "ROSAEnabled indicates whether this version can be used to create ROSA clusters.", 19131 "type": "boolean" 19132 }, 19133 "available_upgrades": { 19134 "description": "AvailableUpgrades is the list of versions this version can be upgraded to.", 19135 "type": "array", 19136 "items": { 19137 "type": "string" 19138 } 19139 }, 19140 "channel_group": { 19141 "description": "ChannelGroup is the name of the group where this image belongs.\nChannelGroup is a mechanism to partition the images to different groups,\neach image belongs to only a single group.", 19142 "type": "string" 19143 }, 19144 "default": { 19145 "description": "Indicates if this should be selected as the default version when a cluster is created\nwithout specifying explicitly the version.", 19146 "type": "boolean" 19147 }, 19148 "enabled": { 19149 "description": "Indicates if this version can be used to create clusters.", 19150 "type": "boolean" 19151 }, 19152 "end_of_life_timestamp": { 19153 "description": "EndOfLifeTimestamp is the date and time when the version will get to End of Life, using the\nformat defined in https://www.ietf.org/rfc/rfc3339.txt[RC3339].", 19154 "type": "string", 19155 "format": "date-time" 19156 }, 19157 "hosted_control_plane_default": { 19158 "description": "HostedControlPlaneDefault is a flag that indicates if this should be selected as the default version when a\nHCP cluster is created without specifying explicitly the version.", 19159 "type": "boolean" 19160 }, 19161 "hosted_control_plane_enabled": { 19162 "description": "HostedControlPlaneEnabled indicates whether this version can be used to create HCP clusters.", 19163 "type": "boolean" 19164 }, 19165 "image_overrides": { 19166 "description": "ImageOverrides contains the lists of images per cloud provider.", 19167 "$ref": "#/components/schemas/ImageOverrides" 19168 }, 19169 "raw_id": { 19170 "description": "RawID is the id of the version - without channel group and prefix.", 19171 "type": "string" 19172 }, 19173 "release_image": { 19174 "description": "ReleaseImage contains the URI of Openshift release image for amd64 architecture.", 19175 "type": "string" 19176 }, 19177 "release_images": { 19178 "description": "ReleaseImages contains the URI of OpenShift release images for arm64 and multi architectures.", 19179 "$ref": "#/components/schemas/ReleaseImages" 19180 }, 19181 "wif_enabled": { 19182 "description": "WifEnabled is a flag that indicates whether this version is enabled for Workload Identity Federation.", 19183 "type": "boolean" 19184 } 19185 } 19186 }, 19187 "VersionGate": { 19188 "description": "Representation of an _OpenShift_ version gate.", 19189 "properties": { 19190 "kind": { 19191 "description": "Indicates the type of this object. Will be 'VersionGate' if this is a complete object or 'VersionGateLink' if it is just a link.", 19192 "type": "string" 19193 }, 19194 "id": { 19195 "description": "Unique identifier of the object.", 19196 "type": "string" 19197 }, 19198 "href": { 19199 "description": "Self link.", 19200 "type": "string" 19201 }, 19202 "sts_only": { 19203 "description": "STSOnly indicates if this version gate is for STS clusters only,\ndeprecated: to be replaced with ClusterCondition", 19204 "type": "boolean" 19205 }, 19206 "cluster_condition": { 19207 "description": "ClusterCondition aims at selecting the clusters targeted by this version gate,\nignored if STSOnly is true", 19208 "type": "string" 19209 }, 19210 "creation_timestamp": { 19211 "description": "CreationTimestamp is the date and time when the version gate was created,\nformat defined in https://www.ietf.org/rfc/rfc3339.txt[RC3339].", 19212 "type": "string", 19213 "format": "date-time" 19214 }, 19215 "description": { 19216 "description": "Description of the version gate.", 19217 "type": "string" 19218 }, 19219 "documentation_url": { 19220 "description": "DocumentationURL is the URL for the documentation of the version gate.", 19221 "type": "string" 19222 }, 19223 "label": { 19224 "description": "Label representing the version gate in OpenShift.", 19225 "type": "string" 19226 }, 19227 "value": { 19228 "description": "Value represents the required value of the label.", 19229 "type": "string" 19230 }, 19231 "version_raw_id_prefix": { 19232 "description": "VersionRawIDPrefix represents the versions prefix that the gate applies to.", 19233 "type": "string" 19234 }, 19235 "warning_message": { 19236 "description": "WarningMessage is a warning that will be displayed to the user before they acknowledge the gate", 19237 "type": "string" 19238 } 19239 } 19240 }, 19241 "VersionGateAgreement": { 19242 "description": "VersionGateAgreement represents a version gate that the user agreed to for a specific cluster.", 19243 "properties": { 19244 "kind": { 19245 "description": "Indicates the type of this object. Will be 'VersionGateAgreement' if this is a complete object or 'VersionGateAgreementLink' if it is just a link.", 19246 "type": "string" 19247 }, 19248 "id": { 19249 "description": "Unique identifier of the object.", 19250 "type": "string" 19251 }, 19252 "href": { 19253 "description": "Self link.", 19254 "type": "string" 19255 }, 19256 "agreed_timestamp": { 19257 "description": "The time the user agreed to the version gate", 19258 "type": "string", 19259 "format": "date-time" 19260 }, 19261 "version_gate": { 19262 "description": "link to the version gate that the user agreed to", 19263 "$ref": "#/components/schemas/VersionGate" 19264 } 19265 } 19266 }, 19267 "WifAccessMethod": { 19268 "type": "string", 19269 "enum": [ 19270 "impersonate", 19271 "vm", 19272 "wif" 19273 ] 19274 }, 19275 "WifConfig": { 19276 "description": "Definition of an wif_config resource.", 19277 "properties": { 19278 "kind": { 19279 "description": "Indicates the type of this object. Will be 'WifConfig' if this is a complete object or 'WifConfigLink' if it is just a link.", 19280 "type": "string" 19281 }, 19282 "id": { 19283 "description": "Unique identifier of the object.", 19284 "type": "string" 19285 }, 19286 "href": { 19287 "description": "Self link.", 19288 "type": "string" 19289 }, 19290 "display_name": { 19291 "description": "The name OCM clients will display for this wif_config.", 19292 "type": "string" 19293 }, 19294 "gcp": { 19295 "description": "Holds GCP related data.", 19296 "$ref": "#/components/schemas/WifGcp" 19297 }, 19298 "organization": { 19299 "description": "The OCM organization that this wif_config resource belongs to.", 19300 "$ref": "#/components/schemas/OrganizationLink" 19301 }, 19302 "wif_templates": { 19303 "description": "Wif template(s) used to configure IAM resources", 19304 "type": "array", 19305 "items": { 19306 "type": "string" 19307 } 19308 } 19309 } 19310 }, 19311 "WifConfigStatus": { 19312 "description": "Configuration status of a WifConfig.", 19313 "properties": { 19314 "configured": { 19315 "description": "Indicates the current status of the WifConfig resource configuration.\n- `false`: The WifConfig resource has a user configuration error.\n- `true`: The resources associated with the WifConfig object are properly configured and operational at the time of the check.", 19316 "type": "boolean" 19317 }, 19318 "description": { 19319 "description": "Provides additional information about the WifConfig resource status.\n- When `Configured` is `false`, this field contains details about the user configuration error.\n- When `Configured` is `true`, this field may be empty or contain optional notes about the configuration.", 19320 "type": "string" 19321 } 19322 } 19323 }, 19324 "WifCredentialRequest": { 19325 "properties": { 19326 "secret_ref": { 19327 "$ref": "#/components/schemas/WifSecretRef" 19328 }, 19329 "service_account_names": { 19330 "type": "array", 19331 "items": { 19332 "type": "string" 19333 } 19334 } 19335 } 19336 }, 19337 "WifGcp": { 19338 "properties": { 19339 "federated_project_id": { 19340 "description": "This represents the GCP project ID in which, when specified,\nthe wif workload WorkloadIdentityPool resources will be configured.", 19341 "type": "string" 19342 }, 19343 "federated_project_number": { 19344 "description": "This represents the GCP project number in which, when specified,\nthe wif workload WorkloadIdentityPool resources will be configured.", 19345 "type": "string" 19346 }, 19347 "impersonator_email": { 19348 "description": "This is the service account email that OCM will use to access other SAs. ", 19349 "type": "string" 19350 }, 19351 "project_id": { 19352 "description": "This represents the GCP project ID in which the wif resources will be configured.", 19353 "type": "string" 19354 }, 19355 "project_number": { 19356 "description": "This represents the GCP project number in which the wif resources will be configured.", 19357 "type": "string" 19358 }, 19359 "role_prefix": { 19360 "description": "Prefix for naming GCP custom roles configured.", 19361 "type": "string" 19362 }, 19363 "service_accounts": { 19364 "description": "The list of service accounts and their associated roles that will need to be\nconfigured on the user's GCP project.", 19365 "type": "array", 19366 "items": { 19367 "$ref": "#/components/schemas/WifServiceAccount" 19368 } 19369 }, 19370 "support": { 19371 "description": "Defines the access configuration for support.", 19372 "$ref": "#/components/schemas/WifSupport" 19373 }, 19374 "workload_identity_pool": { 19375 "description": "The workload identity configuration data that will be used to create the\nworkload identity pool on the user's account.", 19376 "$ref": "#/components/schemas/WifPool" 19377 } 19378 } 19379 }, 19380 "WifIdentityProvider": { 19381 "properties": { 19382 "allowed_audiences": { 19383 "type": "array", 19384 "items": { 19385 "type": "string" 19386 } 19387 }, 19388 "identity_provider_id": { 19389 "type": "string" 19390 }, 19391 "issuer_url": { 19392 "type": "string" 19393 }, 19394 "jwks": { 19395 "type": "string" 19396 } 19397 } 19398 }, 19399 "WifPool": { 19400 "properties": { 19401 "identity_provider": { 19402 "description": "Identity provider configuration data that will be created as part of the\nworkload identity pool.", 19403 "$ref": "#/components/schemas/WifIdentityProvider" 19404 }, 19405 "pool_id": { 19406 "description": "The Id of the workload identity pool.", 19407 "type": "string" 19408 }, 19409 "pool_name": { 19410 "description": "The display name of the workload identity pool.", 19411 "type": "string" 19412 } 19413 } 19414 }, 19415 "WifRole": { 19416 "properties": { 19417 "permissions": { 19418 "type": "array", 19419 "items": { 19420 "type": "string" 19421 } 19422 }, 19423 "predefined": { 19424 "type": "boolean" 19425 }, 19426 "role_id": { 19427 "type": "string" 19428 } 19429 } 19430 }, 19431 "WifSecretRef": { 19432 "properties": { 19433 "name": { 19434 "type": "string" 19435 }, 19436 "namespace": { 19437 "type": "string" 19438 } 19439 } 19440 }, 19441 "WifServiceAccount": { 19442 "properties": { 19443 "access_method": { 19444 "$ref": "#/components/schemas/WifAccessMethod" 19445 }, 19446 "credential_request": { 19447 "$ref": "#/components/schemas/WifCredentialRequest" 19448 }, 19449 "osd_role": { 19450 "type": "string" 19451 }, 19452 "roles": { 19453 "type": "array", 19454 "items": { 19455 "$ref": "#/components/schemas/WifRole" 19456 } 19457 }, 19458 "service_account_id": { 19459 "type": "string" 19460 } 19461 } 19462 }, 19463 "WifSupport": { 19464 "properties": { 19465 "principal": { 19466 "type": "string" 19467 }, 19468 "roles": { 19469 "type": "array", 19470 "items": { 19471 "$ref": "#/components/schemas/WifRole" 19472 } 19473 } 19474 } 19475 }, 19476 "WildcardPolicy": { 19477 "description": "Type of wildcard policy.", 19478 "type": "string", 19479 "enum": [ 19480 "WildcardsAllowed", 19481 "WildcardsDisallowed" 19482 ] 19483 }, 19484 "Error": { 19485 "type": "object", 19486 "properties": { 19487 "kind": { 19488 "description": "Indicates the type of this object. Will always be 'Error'", 19489 "type": "string" 19490 }, 19491 "id": { 19492 "description": "Numeric identifier of the error.", 19493 "type": "integer", 19494 "format": "int32" 19495 }, 19496 "href": { 19497 "description": "Self link.", 19498 "type": "string" 19499 }, 19500 "code": { 19501 "description": "Globally unique code of the error, composed of the unique identifier of the API and the numeric identifier of the error. For example, for if the numeric identifier of the error is `93` and the identifier of the API is `clusters_mgmt` then the code will be `CLUSTERS-MGMT-93`.", 19502 "type": "string" 19503 }, 19504 "reason": { 19505 "description": "Human readable description of the error.", 19506 "type": "string" 19507 }, 19508 "details": { 19509 "description": "Extra information about the error.", 19510 "type": "object", 19511 "additionalProperties": true 19512 } 19513 } 19514 } 19515 }, 19516 "securitySchemes": { 19517 "bearer": { 19518 "type": "http", 19519 "scheme": "bearer", 19520 "bearerFormat": "JWT" 19521 } 19522 } 19523 }, 19524 "security": [ 19525 { 19526 "bearer": [ 19527 19528 ] 19529 } 19530 ] 19531 }