github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/developer_docs/api-reference/add-on.md (about) 1 --- 2 title: Add-On API Reference 3 description: Add-On API Reference 4 keywords: [add-on, api] 5 sidebar_position: 3 6 sidebar_label: Add-On 7 --- 8 <br /> 9 <p>Packages:</p> 10 <ul> 11 <li> 12 <a href="#extensions.kubeblocks.io%2fv1alpha1">extensions.kubeblocks.io/v1alpha1</a> 13 </li> 14 </ul> 15 <h2 id="extensions.kubeblocks.io/v1alpha1">extensions.kubeblocks.io/v1alpha1</h2> 16 <div> 17 </div> 18 Resource Types: 19 <ul><li> 20 <a href="#extensions.kubeblocks.io/v1alpha1.Addon">Addon</a> 21 </li></ul> 22 <h3 id="extensions.kubeblocks.io/v1alpha1.Addon">Addon 23 </h3> 24 <div> 25 <p>Addon is the Schema for the add-ons API.</p><br /> 26 </div> 27 <table> 28 <thead> 29 <tr> 30 <th>Field</th> 31 <th>Description</th> 32 </tr> 33 </thead> 34 <tbody> 35 <tr> 36 <td> 37 <code>apiVersion</code><br/> 38 string</td> 39 <td> 40 <code>extensions.kubeblocks.io/v1alpha1</code> 41 </td> 42 </tr> 43 <tr> 44 <td> 45 <code>kind</code><br/> 46 string 47 </td> 48 <td><code>Addon</code></td> 49 </tr> 50 <tr> 51 <td> 52 <code>metadata</code><br/> 53 <em> 54 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta"> 55 Kubernetes meta/v1.ObjectMeta 56 </a> 57 </em> 58 </td> 59 <td> 60 Refer to the Kubernetes API documentation for the fields of the 61 <code>metadata</code> field. 62 </td> 63 </tr> 64 <tr> 65 <td> 66 <code>spec</code><br/> 67 <em> 68 <a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec"> 69 AddonSpec 70 </a> 71 </em> 72 </td> 73 <td> 74 <br/> 75 <br/> 76 <table> 77 <tr> 78 <td> 79 <code>description</code><br/> 80 <em> 81 string 82 </em> 83 </td> 84 <td> 85 <em>(Optional)</em> 86 <p>Addon description.</p><br /> 87 </td> 88 </tr> 89 <tr> 90 <td> 91 <code>type</code><br/> 92 <em> 93 <a href="#extensions.kubeblocks.io/v1alpha1.AddonType"> 94 AddonType 95 </a> 96 </em> 97 </td> 98 <td> 99 <p>Add-on type. The valid value is helm.</p><br /> 100 </td> 101 </tr> 102 <tr> 103 <td> 104 <code>helm</code><br/> 105 <em> 106 <a href="#extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec"> 107 HelmTypeInstallSpec 108 </a> 109 </em> 110 </td> 111 <td> 112 <em>(Optional)</em> 113 <p>Helm installation spec. It’s processed only when type=helm.</p><br /> 114 </td> 115 </tr> 116 <tr> 117 <td> 118 <code>defaultInstallValues</code><br/> 119 <em> 120 <a href="#extensions.kubeblocks.io/v1alpha1.AddonDefaultInstallSpecItem"> 121 []AddonDefaultInstallSpecItem 122 </a> 123 </em> 124 </td> 125 <td> 126 <p>Default installation parameters.</p><br /> 127 </td> 128 </tr> 129 <tr> 130 <td> 131 <code>install</code><br/> 132 <em> 133 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpec"> 134 AddonInstallSpec 135 </a> 136 </em> 137 </td> 138 <td> 139 <em>(Optional)</em> 140 <p>Installation parameters.</p><br /> 141 </td> 142 </tr> 143 <tr> 144 <td> 145 <code>installable</code><br/> 146 <em> 147 <a href="#extensions.kubeblocks.io/v1alpha1.InstallableSpec"> 148 InstallableSpec 149 </a> 150 </em> 151 </td> 152 <td> 153 <em>(Optional)</em> 154 <p>Addon installable spec. It provides selector and auto-install settings.</p><br /> 155 </td> 156 </tr> 157 <tr> 158 <td> 159 <code>cliPlugins</code><br/> 160 <em> 161 <a href="#extensions.kubeblocks.io/v1alpha1.CliPlugin"> 162 []CliPlugin 163 </a> 164 </em> 165 </td> 166 <td> 167 <em>(Optional)</em> 168 <p>Plugin installation spec.</p><br /> 169 </td> 170 </tr> 171 </table> 172 </td> 173 </tr> 174 <tr> 175 <td> 176 <code>status</code><br/> 177 <em> 178 <a href="#extensions.kubeblocks.io/v1alpha1.AddonStatus"> 179 AddonStatus 180 </a> 181 </em> 182 </td> 183 <td> 184 </td> 185 </tr> 186 </tbody> 187 </table> 188 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonDefaultInstallSpecItem">AddonDefaultInstallSpecItem 189 </h3> 190 <p> 191 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 192 </p> 193 <div> 194 </div> 195 <table> 196 <thead> 197 <tr> 198 <th>Field</th> 199 <th>Description</th> 200 </tr> 201 </thead> 202 <tbody> 203 <tr> 204 <td> 205 <code>AddonInstallSpec</code><br/> 206 <em> 207 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpec"> 208 AddonInstallSpec 209 </a> 210 </em> 211 </td> 212 <td> 213 <p> 214 (Members of <code>AddonInstallSpec</code> are embedded into this type.) 215 </p> 216 </td> 217 </tr> 218 <tr> 219 <td> 220 <code>selectors</code><br/> 221 <em> 222 <a href="#extensions.kubeblocks.io/v1alpha1.SelectorRequirement"> 223 []SelectorRequirement 224 </a> 225 </em> 226 </td> 227 <td> 228 <em>(Optional)</em> 229 <p>Addon installs parameters selectors by default. If multiple selectors are provided,<br />all selectors must evaluate to true.</p><br /> 230 </td> 231 </tr> 232 </tbody> 233 </table> 234 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonInstallExtraItem">AddonInstallExtraItem 235 </h3> 236 <p> 237 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpec">AddonInstallSpec</a>) 238 </p> 239 <div> 240 </div> 241 <table> 242 <thead> 243 <tr> 244 <th>Field</th> 245 <th>Description</th> 246 </tr> 247 </thead> 248 <tbody> 249 <tr> 250 <td> 251 <code>AddonInstallSpecItem</code><br/> 252 <em> 253 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpecItem"> 254 AddonInstallSpecItem 255 </a> 256 </em> 257 </td> 258 <td> 259 <p> 260 (Members of <code>AddonInstallSpecItem</code> are embedded into this type.) 261 </p> 262 </td> 263 </tr> 264 <tr> 265 <td> 266 <code>name</code><br/> 267 <em> 268 string 269 </em> 270 </td> 271 <td> 272 <p>Name of the item.</p><br /> 273 </td> 274 </tr> 275 </tbody> 276 </table> 277 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonInstallSpec">AddonInstallSpec 278 </h3> 279 <p> 280 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonDefaultInstallSpecItem">AddonDefaultInstallSpecItem</a>, <a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 281 </p> 282 <div> 283 </div> 284 <table> 285 <thead> 286 <tr> 287 <th>Field</th> 288 <th>Description</th> 289 </tr> 290 </thead> 291 <tbody> 292 <tr> 293 <td> 294 <code>AddonInstallSpecItem</code><br/> 295 <em> 296 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpecItem"> 297 AddonInstallSpecItem 298 </a> 299 </em> 300 </td> 301 <td> 302 <p> 303 (Members of <code>AddonInstallSpecItem</code> are embedded into this type.) 304 </p> 305 </td> 306 </tr> 307 <tr> 308 <td> 309 <code>enabled</code><br/> 310 <em> 311 bool 312 </em> 313 </td> 314 <td> 315 <em>(Optional)</em> 316 <p>enabled can be set if there are no specific installation attributes to be set.</p><br /> 317 </td> 318 </tr> 319 <tr> 320 <td> 321 <code>extras</code><br/> 322 <em> 323 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallExtraItem"> 324 []AddonInstallExtraItem 325 </a> 326 </em> 327 </td> 328 <td> 329 <em>(Optional)</em> 330 <p>Installs spec. for extra items.</p><br /> 331 </td> 332 </tr> 333 </tbody> 334 </table> 335 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonInstallSpecItem">AddonInstallSpecItem 336 </h3> 337 <p> 338 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallExtraItem">AddonInstallExtraItem</a>, <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpec">AddonInstallSpec</a>) 339 </p> 340 <div> 341 </div> 342 <table> 343 <thead> 344 <tr> 345 <th>Field</th> 346 <th>Description</th> 347 </tr> 348 </thead> 349 <tbody> 350 <tr> 351 <td> 352 <code>replicas</code><br/> 353 <em> 354 int32 355 </em> 356 </td> 357 <td> 358 <em>(Optional)</em> 359 <p>Replicas value.</p><br /> 360 </td> 361 </tr> 362 <tr> 363 <td> 364 <code>persistentVolumeEnabled</code><br/> 365 <em> 366 bool 367 </em> 368 </td> 369 <td> 370 <em>(Optional)</em> 371 <p>Persistent Volume Enabled value.</p><br /> 372 </td> 373 </tr> 374 <tr> 375 <td> 376 <code>storageClass</code><br/> 377 <em> 378 string 379 </em> 380 </td> 381 <td> 382 <em>(Optional)</em> 383 <p>Storage class name.</p><br /> 384 </td> 385 </tr> 386 <tr> 387 <td> 388 <code>tolerations</code><br/> 389 <em> 390 string 391 </em> 392 </td> 393 <td> 394 <em>(Optional)</em> 395 <p>Tolerations JSON array string value.</p><br /> 396 </td> 397 </tr> 398 <tr> 399 <td> 400 <code>resources</code><br/> 401 <em> 402 <a href="#extensions.kubeblocks.io/v1alpha1.ResourceRequirements"> 403 ResourceRequirements 404 </a> 405 </em> 406 </td> 407 <td> 408 <em>(Optional)</em> 409 <p>Resource requirements.</p><br /> 410 </td> 411 </tr> 412 </tbody> 413 </table> 414 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonPhase">AddonPhase 415 (<code>string</code> alias)</h3> 416 <p> 417 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonStatus">AddonStatus</a>) 418 </p> 419 <div> 420 <p>AddonPhase defines addon phases.</p><br /> 421 </div> 422 <table> 423 <thead> 424 <tr> 425 <th>Value</th> 426 <th>Description</th> 427 </tr> 428 </thead> 429 <tbody><tr><td><p>"Disabled"</p></td> 430 <td></td> 431 </tr><tr><td><p>"Disabling"</p></td> 432 <td></td> 433 </tr><tr><td><p>"Enabled"</p></td> 434 <td></td> 435 </tr><tr><td><p>"Enabling"</p></td> 436 <td></td> 437 </tr><tr><td><p>"Failed"</p></td> 438 <td></td> 439 </tr></tbody> 440 </table> 441 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonSelectorKey">AddonSelectorKey 442 (<code>string</code> alias)</h3> 443 <p> 444 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.SelectorRequirement">SelectorRequirement</a>) 445 </p> 446 <div> 447 <p>AddonSelectorKey are selector requirement key types.</p><br /> 448 </div> 449 <table> 450 <thead> 451 <tr> 452 <th>Value</th> 453 <th>Description</th> 454 </tr> 455 </thead> 456 <tbody><tr><td><p>"KubeGitVersion"</p></td> 457 <td></td> 458 </tr><tr><td><p>"KubeVersion"</p></td> 459 <td></td> 460 </tr></tbody> 461 </table> 462 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec 463 </h3> 464 <p> 465 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.Addon">Addon</a>) 466 </p> 467 <div> 468 <p>AddonSpec defines the desired state of an add-on.</p><br /> 469 </div> 470 <table> 471 <thead> 472 <tr> 473 <th>Field</th> 474 <th>Description</th> 475 </tr> 476 </thead> 477 <tbody> 478 <tr> 479 <td> 480 <code>description</code><br/> 481 <em> 482 string 483 </em> 484 </td> 485 <td> 486 <em>(Optional)</em> 487 <p>Addon description.</p><br /> 488 </td> 489 </tr> 490 <tr> 491 <td> 492 <code>type</code><br/> 493 <em> 494 <a href="#extensions.kubeblocks.io/v1alpha1.AddonType"> 495 AddonType 496 </a> 497 </em> 498 </td> 499 <td> 500 <p>Add-on type. The valid value is helm.</p><br /> 501 </td> 502 </tr> 503 <tr> 504 <td> 505 <code>helm</code><br/> 506 <em> 507 <a href="#extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec"> 508 HelmTypeInstallSpec 509 </a> 510 </em> 511 </td> 512 <td> 513 <em>(Optional)</em> 514 <p>Helm installation spec. It’s processed only when type=helm.</p><br /> 515 </td> 516 </tr> 517 <tr> 518 <td> 519 <code>defaultInstallValues</code><br/> 520 <em> 521 <a href="#extensions.kubeblocks.io/v1alpha1.AddonDefaultInstallSpecItem"> 522 []AddonDefaultInstallSpecItem 523 </a> 524 </em> 525 </td> 526 <td> 527 <p>Default installation parameters.</p><br /> 528 </td> 529 </tr> 530 <tr> 531 <td> 532 <code>install</code><br/> 533 <em> 534 <a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpec"> 535 AddonInstallSpec 536 </a> 537 </em> 538 </td> 539 <td> 540 <em>(Optional)</em> 541 <p>Installation parameters.</p><br /> 542 </td> 543 </tr> 544 <tr> 545 <td> 546 <code>installable</code><br/> 547 <em> 548 <a href="#extensions.kubeblocks.io/v1alpha1.InstallableSpec"> 549 InstallableSpec 550 </a> 551 </em> 552 </td> 553 <td> 554 <em>(Optional)</em> 555 <p>Addon installable spec. It provides selector and auto-install settings.</p><br /> 556 </td> 557 </tr> 558 <tr> 559 <td> 560 <code>cliPlugins</code><br/> 561 <em> 562 <a href="#extensions.kubeblocks.io/v1alpha1.CliPlugin"> 563 []CliPlugin 564 </a> 565 </em> 566 </td> 567 <td> 568 <em>(Optional)</em> 569 <p>Plugin installation spec.</p><br /> 570 </td> 571 </tr> 572 </tbody> 573 </table> 574 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonStatus">AddonStatus 575 </h3> 576 <p> 577 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.Addon">Addon</a>) 578 </p> 579 <div> 580 <p>AddonStatus defines the observed state of an add-on.</p><br /> 581 </div> 582 <table> 583 <thead> 584 <tr> 585 <th>Field</th> 586 <th>Description</th> 587 </tr> 588 </thead> 589 <tbody> 590 <tr> 591 <td> 592 <code>phase</code><br/> 593 <em> 594 <a href="#extensions.kubeblocks.io/v1alpha1.AddonPhase"> 595 AddonPhase 596 </a> 597 </em> 598 </td> 599 <td> 600 <p>Add-on installation phases. Valid values are Disabled, Enabled, Failed, Enabling, Disabling.</p><br /> 601 </td> 602 </tr> 603 <tr> 604 <td> 605 <code>conditions</code><br/> 606 <em> 607 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta"> 608 []Kubernetes meta/v1.Condition 609 </a> 610 </em> 611 </td> 612 <td> 613 <em>(Optional)</em> 614 <p>Describes the current state of add-on API installation conditions.</p><br /> 615 </td> 616 </tr> 617 <tr> 618 <td> 619 <code>observedGeneration</code><br/> 620 <em> 621 int64 622 </em> 623 </td> 624 <td> 625 <em>(Optional)</em> 626 <p>observedGeneration is the most recent generation observed for this<br />add-on. It corresponds to the add-on’s generation, which is<br />updated on mutation by the API Server.</p><br /> 627 </td> 628 </tr> 629 </tbody> 630 </table> 631 <h3 id="extensions.kubeblocks.io/v1alpha1.AddonType">AddonType 632 (<code>string</code> alias)</h3> 633 <p> 634 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 635 </p> 636 <div> 637 <p>AddonType defines the addon types.</p><br /> 638 </div> 639 <table> 640 <thead> 641 <tr> 642 <th>Value</th> 643 <th>Description</th> 644 </tr> 645 </thead> 646 <tbody><tr><td><p>"Helm"</p></td> 647 <td></td> 648 </tr></tbody> 649 </table> 650 <h3 id="extensions.kubeblocks.io/v1alpha1.CliPlugin">CliPlugin 651 </h3> 652 <p> 653 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 654 </p> 655 <div> 656 </div> 657 <table> 658 <thead> 659 <tr> 660 <th>Field</th> 661 <th>Description</th> 662 </tr> 663 </thead> 664 <tbody> 665 <tr> 666 <td> 667 <code>name</code><br/> 668 <em> 669 string 670 </em> 671 </td> 672 <td> 673 <p>Name of the plugin.</p><br /> 674 </td> 675 </tr> 676 <tr> 677 <td> 678 <code>indexRepository</code><br/> 679 <em> 680 string 681 </em> 682 </td> 683 <td> 684 <p>The index repository of the plugin.</p><br /> 685 </td> 686 </tr> 687 <tr> 688 <td> 689 <code>description</code><br/> 690 <em> 691 string 692 </em> 693 </td> 694 <td> 695 <em>(Optional)</em> 696 <p>The description of the plugin.</p><br /> 697 </td> 698 </tr> 699 </tbody> 700 </table> 701 <h3 id="extensions.kubeblocks.io/v1alpha1.DataObjectKeySelector">DataObjectKeySelector 702 </h3> 703 <p> 704 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmInstallValues">HelmInstallValues</a>) 705 </p> 706 <div> 707 </div> 708 <table> 709 <thead> 710 <tr> 711 <th>Field</th> 712 <th>Description</th> 713 </tr> 714 </thead> 715 <tbody> 716 <tr> 717 <td> 718 <code>name</code><br/> 719 <em> 720 string 721 </em> 722 </td> 723 <td> 724 <p>Object name of the referent.</p><br /> 725 </td> 726 </tr> 727 <tr> 728 <td> 729 <code>key</code><br/> 730 <em> 731 string 732 </em> 733 </td> 734 <td> 735 <p>The key to select.</p><br /> 736 </td> 737 </tr> 738 </tbody> 739 </table> 740 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmInstallOptions">HelmInstallOptions 741 (<code>map[string]string</code> alias)</h3> 742 <p> 743 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec">HelmTypeInstallSpec</a>) 744 </p> 745 <div> 746 </div> 747 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmInstallValues">HelmInstallValues 748 </h3> 749 <p> 750 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec">HelmTypeInstallSpec</a>) 751 </p> 752 <div> 753 </div> 754 <table> 755 <thead> 756 <tr> 757 <th>Field</th> 758 <th>Description</th> 759 </tr> 760 </thead> 761 <tbody> 762 <tr> 763 <td> 764 <code>urls</code><br/> 765 <em> 766 []string 767 </em> 768 </td> 769 <td> 770 <em>(Optional)</em> 771 </td> 772 </tr> 773 <tr> 774 <td> 775 <code>configMapRefs</code><br/> 776 <em> 777 <a href="#extensions.kubeblocks.io/v1alpha1.DataObjectKeySelector"> 778 []DataObjectKeySelector 779 </a> 780 </em> 781 </td> 782 <td> 783 <em>(Optional)</em> 784 <p>Selects a key of a ConfigMap item list. The value of ConfigMap can be<br />a JSON or YAML string content. Use a key name with “.json” or “.yaml” or “.yml”<br />extension name to specify a content type.</p><br /> 785 </td> 786 </tr> 787 <tr> 788 <td> 789 <code>secretRefs</code><br/> 790 <em> 791 <a href="#extensions.kubeblocks.io/v1alpha1.DataObjectKeySelector"> 792 []DataObjectKeySelector 793 </a> 794 </em> 795 </td> 796 <td> 797 <em>(Optional)</em> 798 <p>Selects a key of a Secrets item list. The value of Secrets can be<br />a JSON or YAML string content. Use a key name with “.json” or “.yaml” or “.yml”<br />extension name to specify a content type.</p><br /> 799 </td> 800 </tr> 801 <tr> 802 <td> 803 <code>setValues</code><br/> 804 <em> 805 []string 806 </em> 807 </td> 808 <td> 809 <em>(Optional)</em> 810 <p>Helm install set values. It can specify multiple or separate values with commas(key1=val1,key2=val2).</p><br /> 811 </td> 812 </tr> 813 <tr> 814 <td> 815 <code>setJSONValues</code><br/> 816 <em> 817 []string 818 </em> 819 </td> 820 <td> 821 <em>(Optional)</em> 822 <p>Helm install set JSON values. It can specify multiple or separate values with commas(key1=jsonval1,key2=jsonval2).</p><br /> 823 </td> 824 </tr> 825 </tbody> 826 </table> 827 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmJSONValueMapType">HelmJSONValueMapType 828 </h3> 829 <p> 830 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem">HelmValuesMappingItem</a>) 831 </p> 832 <div> 833 </div> 834 <table> 835 <thead> 836 <tr> 837 <th>Field</th> 838 <th>Description</th> 839 </tr> 840 </thead> 841 <tbody> 842 <tr> 843 <td> 844 <code>tolerations</code><br/> 845 <em> 846 string 847 </em> 848 </td> 849 <td> 850 <em>(Optional)</em> 851 <p>tolerations sets the toleration mapping key.</p><br /> 852 </td> 853 </tr> 854 </tbody> 855 </table> 856 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec">HelmTypeInstallSpec 857 </h3> 858 <p> 859 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 860 </p> 861 <div> 862 <p>HelmTypeInstallSpec defines the Helm installation spec.</p><br /> 863 </div> 864 <table> 865 <thead> 866 <tr> 867 <th>Field</th> 868 <th>Description</th> 869 </tr> 870 </thead> 871 <tbody> 872 <tr> 873 <td> 874 <code>chartLocationURL</code><br/> 875 <em> 876 string 877 </em> 878 </td> 879 <td> 880 <p>A Helm Chart location URL.</p><br /> 881 </td> 882 </tr> 883 <tr> 884 <td> 885 <code>installOptions</code><br/> 886 <em> 887 <a href="#extensions.kubeblocks.io/v1alpha1.HelmInstallOptions"> 888 HelmInstallOptions 889 </a> 890 </em> 891 </td> 892 <td> 893 <em>(Optional)</em> 894 <p>installOptions defines Helm release installation options.</p><br /> 895 </td> 896 </tr> 897 <tr> 898 <td> 899 <code>installValues</code><br/> 900 <em> 901 <a href="#extensions.kubeblocks.io/v1alpha1.HelmInstallValues"> 902 HelmInstallValues 903 </a> 904 </em> 905 </td> 906 <td> 907 <em>(Optional)</em> 908 <p>HelmInstallValues defines Helm release installation set values.</p><br /> 909 </td> 910 </tr> 911 <tr> 912 <td> 913 <code>valuesMapping</code><br/> 914 <em> 915 <a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMapping"> 916 HelmValuesMapping 917 </a> 918 </em> 919 </td> 920 <td> 921 <em>(Optional)</em> 922 <p>valuesMapping defines add-on normalized resources parameters mapped to Helm values’ keys.</p><br /> 923 </td> 924 </tr> 925 <tr> 926 <td> 927 <code>chartsImage</code><br/> 928 <em> 929 string 930 </em> 931 </td> 932 <td> 933 <em>(Optional)</em> 934 <p>chartsImage defines the image of Helm charts.</p><br /> 935 </td> 936 </tr> 937 <tr> 938 <td> 939 <code>chartsPathInImage</code><br/> 940 <em> 941 string 942 </em> 943 </td> 944 <td> 945 <em>(Optional)</em> 946 <p>chartsPathInImage defines the path of Helm charts in the image. It’s used to copy<br />Helm charts from the image to the shared volume.</p><br /> 947 </td> 948 </tr> 949 </tbody> 950 </table> 951 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmValueMapType">HelmValueMapType 952 </h3> 953 <p> 954 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem">HelmValuesMappingItem</a>) 955 </p> 956 <div> 957 </div> 958 <table> 959 <thead> 960 <tr> 961 <th>Field</th> 962 <th>Description</th> 963 </tr> 964 </thead> 965 <tbody> 966 <tr> 967 <td> 968 <code>replicaCount</code><br/> 969 <em> 970 string 971 </em> 972 </td> 973 <td> 974 <em>(Optional)</em> 975 <p>replicaCount sets the replicaCount value mapping key.</p><br /> 976 </td> 977 </tr> 978 <tr> 979 <td> 980 <code>persistentVolumeEnabled</code><br/> 981 <em> 982 string 983 </em> 984 </td> 985 <td> 986 <em>(Optional)</em> 987 <p>persistentVolumeEnabled sets the persistent volume enabled mapping key.</p><br /> 988 </td> 989 </tr> 990 <tr> 991 <td> 992 <code>storageClass</code><br/> 993 <em> 994 string 995 </em> 996 </td> 997 <td> 998 <em>(Optional)</em> 999 <p>storageClass sets the storageClass mapping key.</p><br /> 1000 </td> 1001 </tr> 1002 </tbody> 1003 </table> 1004 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmValuesMapping">HelmValuesMapping 1005 </h3> 1006 <p> 1007 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmTypeInstallSpec">HelmTypeInstallSpec</a>) 1008 </p> 1009 <div> 1010 </div> 1011 <table> 1012 <thead> 1013 <tr> 1014 <th>Field</th> 1015 <th>Description</th> 1016 </tr> 1017 </thead> 1018 <tbody> 1019 <tr> 1020 <td> 1021 <code>HelmValuesMappingItem</code><br/> 1022 <em> 1023 <a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem"> 1024 HelmValuesMappingItem 1025 </a> 1026 </em> 1027 </td> 1028 <td> 1029 <p> 1030 (Members of <code>HelmValuesMappingItem</code> are embedded into this type.) 1031 </p> 1032 </td> 1033 </tr> 1034 <tr> 1035 <td> 1036 <code>extras</code><br/> 1037 <em> 1038 <a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingExtraItem"> 1039 []HelmValuesMappingExtraItem 1040 </a> 1041 </em> 1042 </td> 1043 <td> 1044 <em>(Optional)</em> 1045 <p>Helm value mapping items for extra items.</p><br /> 1046 </td> 1047 </tr> 1048 </tbody> 1049 </table> 1050 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmValuesMappingExtraItem">HelmValuesMappingExtraItem 1051 </h3> 1052 <p> 1053 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMapping">HelmValuesMapping</a>) 1054 </p> 1055 <div> 1056 </div> 1057 <table> 1058 <thead> 1059 <tr> 1060 <th>Field</th> 1061 <th>Description</th> 1062 </tr> 1063 </thead> 1064 <tbody> 1065 <tr> 1066 <td> 1067 <code>HelmValuesMappingItem</code><br/> 1068 <em> 1069 <a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem"> 1070 HelmValuesMappingItem 1071 </a> 1072 </em> 1073 </td> 1074 <td> 1075 <p> 1076 (Members of <code>HelmValuesMappingItem</code> are embedded into this type.) 1077 </p> 1078 </td> 1079 </tr> 1080 <tr> 1081 <td> 1082 <code>name</code><br/> 1083 <em> 1084 string 1085 </em> 1086 </td> 1087 <td> 1088 <p>Name of the item.</p><br /> 1089 </td> 1090 </tr> 1091 </tbody> 1092 </table> 1093 <h3 id="extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem">HelmValuesMappingItem 1094 </h3> 1095 <p> 1096 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMapping">HelmValuesMapping</a>, <a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingExtraItem">HelmValuesMappingExtraItem</a>) 1097 </p> 1098 <div> 1099 </div> 1100 <table> 1101 <thead> 1102 <tr> 1103 <th>Field</th> 1104 <th>Description</th> 1105 </tr> 1106 </thead> 1107 <tbody> 1108 <tr> 1109 <td> 1110 <code>valueMap</code><br/> 1111 <em> 1112 <a href="#extensions.kubeblocks.io/v1alpha1.HelmValueMapType"> 1113 HelmValueMapType 1114 </a> 1115 </em> 1116 </td> 1117 <td> 1118 <em>(Optional)</em> 1119 <p>valueMap define the “key” mapping values. Valid keys are replicaCount,<br />persistentVolumeEnabled, and storageClass. Enum values explained:<br /><code>"replicaCount"</code> sets the replicaCount value mapping key.<br /><code>"persistentVolumeEnabled"</code> sets the persistent volume enabled mapping key.<br /><code>"storageClass"</code> sets the storageClass mapping key.</p><br /> 1120 </td> 1121 </tr> 1122 <tr> 1123 <td> 1124 <code>jsonMap</code><br/> 1125 <em> 1126 <a href="#extensions.kubeblocks.io/v1alpha1.HelmJSONValueMapType"> 1127 HelmJSONValueMapType 1128 </a> 1129 </em> 1130 </td> 1131 <td> 1132 <em>(Optional)</em> 1133 <p>jsonMap defines the “key” mapping values. The valid key is tolerations.<br />Enum values explained:<br /><code>"tolerations"</code> sets the toleration mapping key.</p><br /> 1134 </td> 1135 </tr> 1136 <tr> 1137 <td> 1138 <code>resources</code><br/> 1139 <em> 1140 <a href="#extensions.kubeblocks.io/v1alpha1.ResourceMappingItem"> 1141 ResourceMappingItem 1142 </a> 1143 </em> 1144 </td> 1145 <td> 1146 <em>(Optional)</em> 1147 <p>resources sets resources related mapping keys.</p><br /> 1148 </td> 1149 </tr> 1150 </tbody> 1151 </table> 1152 <h3 id="extensions.kubeblocks.io/v1alpha1.InstallableSpec">InstallableSpec 1153 </h3> 1154 <p> 1155 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>) 1156 </p> 1157 <div> 1158 </div> 1159 <table> 1160 <thead> 1161 <tr> 1162 <th>Field</th> 1163 <th>Description</th> 1164 </tr> 1165 </thead> 1166 <tbody> 1167 <tr> 1168 <td> 1169 <code>selectors</code><br/> 1170 <em> 1171 <a href="#extensions.kubeblocks.io/v1alpha1.SelectorRequirement"> 1172 []SelectorRequirement 1173 </a> 1174 </em> 1175 </td> 1176 <td> 1177 <em>(Optional)</em> 1178 <p>Add-on installable selectors. If multiple selectors are provided,<br />all selectors must evaluate to true.</p><br /> 1179 </td> 1180 </tr> 1181 <tr> 1182 <td> 1183 <code>autoInstall</code><br/> 1184 <em> 1185 bool 1186 </em> 1187 </td> 1188 <td> 1189 <p>autoInstall defines an add-on should be installed automatically.</p><br /> 1190 </td> 1191 </tr> 1192 </tbody> 1193 </table> 1194 <h3 id="extensions.kubeblocks.io/v1alpha1.LineSelectorOperator">LineSelectorOperator 1195 (<code>string</code> alias)</h3> 1196 <p> 1197 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.SelectorRequirement">SelectorRequirement</a>) 1198 </p> 1199 <div> 1200 <p>LineSelectorOperator defines line selector operators.</p><br /> 1201 </div> 1202 <table> 1203 <thead> 1204 <tr> 1205 <th>Value</th> 1206 <th>Description</th> 1207 </tr> 1208 </thead> 1209 <tbody><tr><td><p>"Contains"</p></td> 1210 <td></td> 1211 </tr><tr><td><p>"DoesNotContain"</p></td> 1212 <td></td> 1213 </tr><tr><td><p>"DoesNotMatchRegex"</p></td> 1214 <td></td> 1215 </tr><tr><td><p>"MatchRegex"</p></td> 1216 <td></td> 1217 </tr></tbody> 1218 </table> 1219 <h3 id="extensions.kubeblocks.io/v1alpha1.ResourceMappingItem">ResourceMappingItem 1220 </h3> 1221 <p> 1222 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.HelmValuesMappingItem">HelmValuesMappingItem</a>) 1223 </p> 1224 <div> 1225 </div> 1226 <table> 1227 <thead> 1228 <tr> 1229 <th>Field</th> 1230 <th>Description</th> 1231 </tr> 1232 </thead> 1233 <tbody> 1234 <tr> 1235 <td> 1236 <code>storage</code><br/> 1237 <em> 1238 string 1239 </em> 1240 </td> 1241 <td> 1242 <em>(Optional)</em> 1243 <p>storage sets the storage size value mapping key.</p><br /> 1244 </td> 1245 </tr> 1246 <tr> 1247 <td> 1248 <code>cpu</code><br/> 1249 <em> 1250 <a href="#extensions.kubeblocks.io/v1alpha1.ResourceReqLimItem"> 1251 ResourceReqLimItem 1252 </a> 1253 </em> 1254 </td> 1255 <td> 1256 <em>(Optional)</em> 1257 <p>cpu sets CPU requests and limits mapping keys.</p><br /> 1258 </td> 1259 </tr> 1260 <tr> 1261 <td> 1262 <code>memory</code><br/> 1263 <em> 1264 <a href="#extensions.kubeblocks.io/v1alpha1.ResourceReqLimItem"> 1265 ResourceReqLimItem 1266 </a> 1267 </em> 1268 </td> 1269 <td> 1270 <em>(Optional)</em> 1271 <p>memory sets Memory requests and limits mapping keys.</p><br /> 1272 </td> 1273 </tr> 1274 </tbody> 1275 </table> 1276 <h3 id="extensions.kubeblocks.io/v1alpha1.ResourceReqLimItem">ResourceReqLimItem 1277 </h3> 1278 <p> 1279 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.ResourceMappingItem">ResourceMappingItem</a>) 1280 </p> 1281 <div> 1282 </div> 1283 <table> 1284 <thead> 1285 <tr> 1286 <th>Field</th> 1287 <th>Description</th> 1288 </tr> 1289 </thead> 1290 <tbody> 1291 <tr> 1292 <td> 1293 <code>requests</code><br/> 1294 <em> 1295 string 1296 </em> 1297 </td> 1298 <td> 1299 <em>(Optional)</em> 1300 <p>Requests value mapping key.</p><br /> 1301 </td> 1302 </tr> 1303 <tr> 1304 <td> 1305 <code>limits</code><br/> 1306 <em> 1307 string 1308 </em> 1309 </td> 1310 <td> 1311 <em>(Optional)</em> 1312 <p>Limits value mapping key.</p><br /> 1313 </td> 1314 </tr> 1315 </tbody> 1316 </table> 1317 <h3 id="extensions.kubeblocks.io/v1alpha1.ResourceRequirements">ResourceRequirements 1318 </h3> 1319 <p> 1320 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonInstallSpecItem">AddonInstallSpecItem</a>) 1321 </p> 1322 <div> 1323 </div> 1324 <table> 1325 <thead> 1326 <tr> 1327 <th>Field</th> 1328 <th>Description</th> 1329 </tr> 1330 </thead> 1331 <tbody> 1332 <tr> 1333 <td> 1334 <code>limits</code><br/> 1335 <em> 1336 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcelist-v1-core"> 1337 Kubernetes core/v1.ResourceList 1338 </a> 1339 </em> 1340 </td> 1341 <td> 1342 <em>(Optional)</em> 1343 <p>Limits describes the maximum amount of compute resources allowed.<br />More info: <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/</a>.</p><br /> 1344 </td> 1345 </tr> 1346 <tr> 1347 <td> 1348 <code>requests</code><br/> 1349 <em> 1350 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcelist-v1-core"> 1351 Kubernetes core/v1.ResourceList 1352 </a> 1353 </em> 1354 </td> 1355 <td> 1356 <em>(Optional)</em> 1357 <p>Requests describes the minimum amount of compute resources required.<br />If Requests is omitted for a container, it defaults to Limits if that is explicitly specified;<br />otherwise, it defaults to an implementation-defined value.<br />More info: <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/</a>.</p><br /> 1358 </td> 1359 </tr> 1360 </tbody> 1361 </table> 1362 <h3 id="extensions.kubeblocks.io/v1alpha1.SelectorRequirement">SelectorRequirement 1363 </h3> 1364 <p> 1365 (<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonDefaultInstallSpecItem">AddonDefaultInstallSpecItem</a>, <a href="#extensions.kubeblocks.io/v1alpha1.InstallableSpec">InstallableSpec</a>) 1366 </p> 1367 <div> 1368 </div> 1369 <table> 1370 <thead> 1371 <tr> 1372 <th>Field</th> 1373 <th>Description</th> 1374 </tr> 1375 </thead> 1376 <tbody> 1377 <tr> 1378 <td> 1379 <code>key</code><br/> 1380 <em> 1381 <a href="#extensions.kubeblocks.io/v1alpha1.AddonSelectorKey"> 1382 AddonSelectorKey 1383 </a> 1384 </em> 1385 </td> 1386 <td> 1387 <p>The selector key. Valid values are KubeVersion, KubeGitVersion.<br />“KubeVersion” the semver expression of Kubernetes versions, i.e., v1.24.<br />“KubeGitVersion” may contain distro. info., i.e., v1.24.4+eks.</p><br /> 1388 </td> 1389 </tr> 1390 <tr> 1391 <td> 1392 <code>operator</code><br/> 1393 <em> 1394 <a href="#extensions.kubeblocks.io/v1alpha1.LineSelectorOperator"> 1395 LineSelectorOperator 1396 </a> 1397 </em> 1398 </td> 1399 <td> 1400 <p>Represents a key’s relationship to a set of values.<br />Valid operators are Contains, NotIn, DoesNotContain, MatchRegex, and DoesNoteMatchRegex.</p><br /><br /><p>Possible enum values:<br /><code>"Contains"</code> line contains a string.<br /><code>"DoesNotContain"</code> line does not contain a string.<br /><code>"MatchRegex"</code> line contains a match to the regular expression.<br /><code>"DoesNotMatchRegex"</code> line does not contain a match to the regular expression.</p><br /> 1401 </td> 1402 </tr> 1403 <tr> 1404 <td> 1405 <code>values</code><br/> 1406 <em> 1407 []string 1408 </em> 1409 </td> 1410 <td> 1411 <em>(Optional)</em> 1412 <p>An array of string values. It serves as an “OR” expression to the operator.</p><br /> 1413 </td> 1414 </tr> 1415 </tbody> 1416 </table> 1417 <hr/> 1418 <p><em> 1419 Generated with <code>gen-crd-api-reference-docs</code> 1420 </em></p>