github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/3-create-a-jackal-package/4-jackal-schema.md (about) 1 # Jackal Package Schema 2 3 | | | 4 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 5 | **Type** | `object` | 6 | **Additional properties** | [](# "Additional Properties not allowed.") | 7 | **Defined in** | #/definitions/JackalPackage | 8 9 <details> 10 <summary> 11 <strong> <a name="kind"></a>kind *</strong> 12 </summary> 13 14 <blockquote> 15 16  17 18 **Description:** The kind of Jackal package 19 20 | | | 21 | ----------- | --------------------- | 22 | **Type** | `enum (of string)` | 23 | **Default** | `"JackalPackageConfig"` | 24 25 :::note 26 Must be one of: 27 * "JackalInitConfig" 28 * "JackalPackageConfig" 29 ::: 30 31 </blockquote> 32 </details> 33 34 <details open> 35 <summary> 36 <strong> <a name="metadata"></a>metadata</strong> 37 </summary> 38 39 <blockquote> 40 41 ## metadata 42 43 **Description:** Package metadata 44 45 | | | 46 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 47 | **Type** | `object` | 48 | **Additional properties** | [](# "Additional Properties not allowed.") | 49 | **Defined in** | #/definitions/JackalMetadata | 50 51 <details> 52 <summary> 53 <strong> <a name="metadata_name"></a>name *</strong> 54 </summary> 55 56 <blockquote> 57 58  59 60 **Description:** Name to identify this Jackal package 61 62 | | | 63 | -------- | -------- | 64 | **Type** | `string` | 65 66 | Restrictions | | 67 | --------------------------------- | ----------------------------------------------------------------------------------------------------- | 68 | **Must match regular expression** | ```^[a-z0-9\-]*[a-z0-9]$``` [Test](https://regex101.com/?regex=%5E%5Ba-z0-9%5C-%5D%2A%5Ba-z0-9%5D%24) | 69 70 </blockquote> 71 </details> 72 73 <details> 74 <summary> 75 <strong> <a name="metadata_description"></a>description</strong> 76 </summary> 77 78 <blockquote> 79 80 **Description:** Additional information about this package 81 82 | | | 83 | -------- | -------- | 84 | **Type** | `string` | 85 86 </blockquote> 87 </details> 88 89 <details> 90 <summary> 91 <strong> <a name="metadata_version"></a>version</strong> 92 </summary> 93 94 <blockquote> 95 96 **Description:** Generic string set by a package author to track the package version (Note: JackalInitConfigs will always be versioned to the CLIVersion they were created with) 97 98 | | | 99 | -------- | -------- | 100 | **Type** | `string` | 101 102 </blockquote> 103 </details> 104 105 <details> 106 <summary> 107 <strong> <a name="metadata_url"></a>url</strong> 108 </summary> 109 110 <blockquote> 111 112 **Description:** Link to package information when online 113 114 | | | 115 | -------- | -------- | 116 | **Type** | `string` | 117 118 </blockquote> 119 </details> 120 121 <details> 122 <summary> 123 <strong> <a name="metadata_image"></a>image</strong> 124 </summary> 125 126 <blockquote> 127 128 **Description:** An image URL to embed in this package (Reserved for future use in Jackal UI) 129 130 | | | 131 | -------- | -------- | 132 | **Type** | `string` | 133 134 </blockquote> 135 </details> 136 137 <details> 138 <summary> 139 <strong> <a name="metadata_uncompressed"></a>uncompressed</strong> 140 </summary> 141 142 <blockquote> 143 144 **Description:** Disable compression of this package 145 146 | | | 147 | -------- | --------- | 148 | **Type** | `boolean` | 149 150 </blockquote> 151 </details> 152 153 <details> 154 <summary> 155 <strong> <a name="metadata_architecture"></a>architecture</strong> 156 </summary> 157 158 <blockquote> 159 160 **Description:** The target cluster architecture for this package 161 162 | | | 163 | -------- | -------- | 164 | **Type** | `string` | 165 166 **Examples:** 167 168 <code> 169 "arm64", "amd64"</code> 170 171 </blockquote> 172 </details> 173 174 <details> 175 <summary> 176 <strong> <a name="metadata_yolo"></a>yolo</strong> 177 </summary> 178 179 <blockquote> 180 181 **Description:** Yaml OnLy Online (YOLO): True enables deploying a Jackal package without first running jackal init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries. 182 183 | | | 184 | -------- | --------- | 185 | **Type** | `boolean` | 186 187 </blockquote> 188 </details> 189 190 <details> 191 <summary> 192 <strong> <a name="metadata_authors"></a>authors</strong> 193 </summary> 194 195 <blockquote> 196 197 **Description:** Comma-separated list of package authors (including contact info) 198 199 | | | 200 | -------- | -------- | 201 | **Type** | `string` | 202 203 **Example:** 204 205 <code> 206 "Doug <hello@defenseunicorns.com>, Pepr <hello@defenseunicorns.com>"</code> 207 208 </blockquote> 209 </details> 210 211 <details> 212 <summary> 213 <strong> <a name="metadata_documentation"></a>documentation</strong> 214 </summary> 215 216 <blockquote> 217 218 **Description:** Link to package documentation when online 219 220 | | | 221 | -------- | -------- | 222 | **Type** | `string` | 223 224 </blockquote> 225 </details> 226 227 <details> 228 <summary> 229 <strong> <a name="metadata_source"></a>source</strong> 230 </summary> 231 232 <blockquote> 233 234 **Description:** Link to package source code when online 235 236 | | | 237 | -------- | -------- | 238 | **Type** | `string` | 239 240 </blockquote> 241 </details> 242 243 <details> 244 <summary> 245 <strong> <a name="metadata_vendor"></a>vendor</strong> 246 </summary> 247 248 <blockquote> 249 250 **Description:** Name of the distributing entity, organization or individual. 251 252 | | | 253 | -------- | -------- | 254 | **Type** | `string` | 255 256 </blockquote> 257 </details> 258 259 <details> 260 <summary> 261 <strong> <a name="metadata_aggregateChecksum"></a>aggregateChecksum</strong> 262 </summary> 263 264 <blockquote> 265 266 **Description:** Checksum of a checksums.txt file that contains checksums all the layers within the package. 267 268 | | | 269 | -------- | -------- | 270 | **Type** | `string` | 271 272 </blockquote> 273 </details> 274 275 </blockquote> 276 </details> 277 278 <details open> 279 <summary> 280 <strong> <a name="build"></a>build</strong> 281 </summary> 282 283 <blockquote> 284 285 ## build 286 287 **Description:** Jackal-generated package build data 288 289 | | | 290 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 291 | **Type** | `object` | 292 | **Additional properties** | [](# "Additional Properties not allowed.") | 293 | **Defined in** | #/definitions/JackalBuildData | 294 295 <details> 296 <summary> 297 <strong> <a name="build_terminal"></a>terminal *</strong> 298 </summary> 299 300 <blockquote> 301 302  303 304 **Description:** The machine name that created this package 305 306 | | | 307 | -------- | -------- | 308 | **Type** | `string` | 309 310 </blockquote> 311 </details> 312 313 <details> 314 <summary> 315 <strong> <a name="build_user"></a>user *</strong> 316 </summary> 317 318 <blockquote> 319 320  321 322 **Description:** The username who created this package 323 324 | | | 325 | -------- | -------- | 326 | **Type** | `string` | 327 328 </blockquote> 329 </details> 330 331 <details> 332 <summary> 333 <strong> <a name="build_architecture"></a>architecture *</strong> 334 </summary> 335 336 <blockquote> 337 338  339 340 **Description:** The architecture this package was created on 341 342 | | | 343 | -------- | -------- | 344 | **Type** | `string` | 345 346 </blockquote> 347 </details> 348 349 <details> 350 <summary> 351 <strong> <a name="build_timestamp"></a>timestamp *</strong> 352 </summary> 353 354 <blockquote> 355 356  357 358 **Description:** The timestamp when this package was created 359 360 | | | 361 | -------- | -------- | 362 | **Type** | `string` | 363 364 </blockquote> 365 </details> 366 367 <details> 368 <summary> 369 <strong> <a name="build_version"></a>version *</strong> 370 </summary> 371 372 <blockquote> 373 374  375 376 **Description:** The version of Jackal used to build this package 377 378 | | | 379 | -------- | -------- | 380 | **Type** | `string` | 381 382 </blockquote> 383 </details> 384 385 <details> 386 <summary> 387 <strong> <a name="build_migrations"></a>migrations</strong> 388 </summary> 389 390 <blockquote> 391 392 **Description:** Any migrations that have been run on this package 393 394 | | | 395 | -------- | ----------------- | 396 | **Type** | `array of string` | 397 398  399  400  401  402 403 ### <a name="autogenerated_heading_4"></a>migrations items 404 405 | | | 406 | -------- | -------- | 407 | **Type** | `string` | 408 409 </blockquote> 410 </details> 411 412 <details open> 413 <summary> 414 <strong> <a name="build_registryOverrides"></a>registryOverrides</strong> 415 </summary> 416 417 <blockquote> 418 419 ## build > registryOverrides 420 421 **Description:** Any registry domains that were overridden on package create when pulling images 422 423 | | | 424 | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | 425 | **Type** | `object` | 426 | **Additional properties** | [](# "Additional Properties of any type are allowed.") | 427 428 </blockquote> 429 </details> 430 431 <details> 432 <summary> 433 <strong> <a name="build_differential"></a>differential</strong> 434 </summary> 435 436 <blockquote> 437 438 **Description:** Whether this package was created with differential components 439 440 | | | 441 | -------- | --------- | 442 | **Type** | `boolean` | 443 444 </blockquote> 445 </details> 446 447 <details> 448 <summary> 449 <strong> <a name="build_differentialPackageVersion"></a>differentialPackageVersion</strong> 450 </summary> 451 452 <blockquote> 453 454 **Description:** Version of a previously built package used as the basis for creating this differential package 455 456 | | | 457 | -------- | -------- | 458 | **Type** | `string` | 459 460 </blockquote> 461 </details> 462 463 <details> 464 <summary> 465 <strong> <a name="build_differentialMissing"></a>differentialMissing</strong> 466 </summary> 467 468 <blockquote> 469 470 **Description:** List of components that were not included in this package due to differential packaging 471 472 | | | 473 | -------- | ----------------- | 474 | **Type** | `array of string` | 475 476  477  478  479  480 481 ### <a name="autogenerated_heading_5"></a>differentialMissing items 482 483 | | | 484 | -------- | -------- | 485 | **Type** | `string` | 486 487 </blockquote> 488 </details> 489 490 <details> 491 <summary> 492 <strong> <a name="build_lastNonBreakingVersion"></a>lastNonBreakingVersion</strong> 493 </summary> 494 495 <blockquote> 496 497 **Description:** The minimum version of Jackal that does not have breaking package structure changes 498 499 | | | 500 | -------- | -------- | 501 | **Type** | `string` | 502 503 </blockquote> 504 </details> 505 506 <details> 507 <summary> 508 <strong> <a name="build_flavor"></a>flavor</strong> 509 </summary> 510 511 <blockquote> 512 513 **Description:** The flavor of Jackal used to build this package 514 515 | | | 516 | -------- | -------- | 517 | **Type** | `string` | 518 519 </blockquote> 520 </details> 521 522 </blockquote> 523 </details> 524 525 <details open> 526 <summary> 527 <strong> <a name="components"></a>components *</strong> 528 </summary> 529 530 <blockquote> 531 532 ## components 533  534 535 **Description:** List of components to deploy in this package 536 537 | | | 538 | -------- | ------- | 539 | **Type** | `array` | 540 541  542  543  544  545 546 ### <a name="autogenerated_heading_6"></a>JackalComponent 547 548 | | | 549 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 550 | **Type** | `object` | 551 | **Additional properties** | [](# "Additional Properties not allowed.") | 552 | **Defined in** | #/definitions/JackalComponent | 553 554 <details> 555 <summary> 556 <strong> <a name="components_items_name"></a>name *</strong> 557 </summary> 558 559 <blockquote> 560 561  562 563 **Description:** The name of the component 564 565 | | | 566 | -------- | -------- | 567 | **Type** | `string` | 568 569 | Restrictions | | 570 | --------------------------------- | ----------------------------------------------------------------------------------------------------- | 571 | **Must match regular expression** | ```^[a-z0-9\-]*[a-z0-9]$``` [Test](https://regex101.com/?regex=%5E%5Ba-z0-9%5C-%5D%2A%5Ba-z0-9%5D%24) | 572 573 </blockquote> 574 </details> 575 576 <details> 577 <summary> 578 <strong> <a name="components_items_description"></a>description</strong> 579 </summary> 580 581 <blockquote> 582 583 **Description:** Message to include during package deploy describing the purpose of this component 584 585 | | | 586 | -------- | -------- | 587 | **Type** | `string` | 588 589 </blockquote> 590 </details> 591 592 <details> 593 <summary> 594 <strong> <a name="components_items_default"></a>default</strong> 595 </summary> 596 597 <blockquote> 598 599 **Description:** Determines the default Y/N state for installing this component on package deploy 600 601 | | | 602 | -------- | --------- | 603 | **Type** | `boolean` | 604 605 </blockquote> 606 </details> 607 608 <details> 609 <summary> 610 <strong> <a name="components_items_required"></a>required</strong> 611 </summary> 612 613 <blockquote> 614 615 **Description:** Do not prompt user to install this component 616 617 | | | 618 | -------- | --------- | 619 | **Type** | `boolean` | 620 621 </blockquote> 622 </details> 623 624 <details open> 625 <summary> 626 <strong> <a name="components_items_only"></a>only</strong> 627 </summary> 628 629 <blockquote> 630 631 ## components > only 632 633 **Description:** Filter when this component is included in package creation or deployment 634 635 | | | 636 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 637 | **Type** | `object` | 638 | **Additional properties** | [](# "Additional Properties not allowed.") | 639 | **Defined in** | #/definitions/JackalComponentOnlyTarget | 640 641 <details> 642 <summary> 643 <strong> <a name="components_items_only_localOS"></a>localOS</strong> 644 </summary> 645 646 <blockquote> 647 648 **Description:** Only deploy component to specified OS 649 650 | | | 651 | -------- | ------------------ | 652 | **Type** | `enum (of string)` | 653 654 :::note 655 Must be one of: 656 * "linux" 657 * "darwin" 658 * "windows" 659 ::: 660 661 </blockquote> 662 </details> 663 664 <details open> 665 <summary> 666 <strong> <a name="components_items_only_cluster"></a>cluster</strong> 667 </summary> 668 669 <blockquote> 670 671 ## components > only > cluster 672 673 **Description:** Only deploy component to specified clusters 674 675 | | | 676 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 677 | **Type** | `object` | 678 | **Additional properties** | [](# "Additional Properties not allowed.") | 679 | **Defined in** | #/definitions/JackalComponentOnlyCluster | 680 681 <details> 682 <summary> 683 <strong> <a name="components_items_only_cluster_architecture"></a>architecture</strong> 684 </summary> 685 686 <blockquote> 687 688 **Description:** Only create and deploy to clusters of the given architecture 689 690 | | | 691 | -------- | ------------------ | 692 | **Type** | `enum (of string)` | 693 694 :::note 695 Must be one of: 696 * "amd64" 697 * "arm64" 698 ::: 699 700 </blockquote> 701 </details> 702 703 <details> 704 <summary> 705 <strong> <a name="components_items_only_cluster_distros"></a>distros</strong> 706 </summary> 707 708 <blockquote> 709 710 **Description:** A list of kubernetes distros this package works with (Reserved for future use) 711 712 | | | 713 | -------- | ----------------- | 714 | **Type** | `array of string` | 715 716  717  718  719  720 721 ### <a name="autogenerated_heading_7"></a>distros items 722 723 | | | 724 | -------- | -------- | 725 | **Type** | `string` | 726 727 </blockquote> 728 </details> 729 730 </blockquote> 731 </details> 732 733 <details> 734 <summary> 735 <strong> <a name="components_items_only_flavor"></a>flavor</strong> 736 </summary> 737 738 <blockquote> 739 740 **Description:** Only include this component when a matching '--flavor' is specified on 'jackal package create' 741 742 | | | 743 | -------- | -------- | 744 | **Type** | `string` | 745 746 </blockquote> 747 </details> 748 749 </blockquote> 750 </details> 751 752 <details open> 753 <summary> 754 <strong> <a name="components_items_import"></a>import</strong> 755 </summary> 756 757 <blockquote> 758 759 ## components > import 760 761 **Description:** Import a component from another Jackal package 762 763 | | | 764 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 765 | **Type** | `object` | 766 | **Additional properties** | [](# "Additional Properties not allowed.") | 767 | **Defined in** | #/definitions/JackalComponentImport | 768 769 <details> 770 <summary> 771 <strong> <a name="components_items_import_name"></a>name</strong> 772 </summary> 773 774 <blockquote> 775 776 **Description:** The name of the component to import from the referenced jackal.yaml 777 778 | | | 779 | -------- | -------- | 780 | **Type** | `string` | 781 782 </blockquote> 783 </details> 784 785 <details> 786 <summary> 787 <strong> <a name="components_items_import_path"></a>path</strong> 788 </summary> 789 790 <blockquote> 791 792 **Description:** The relative path to a directory containing a jackal.yaml to import from 793 794 | | | 795 | -------- | -------- | 796 | **Type** | `string` | 797 798 </blockquote> 799 </details> 800 801 <details> 802 <summary> 803 <strong> <a name="components_items_import_url"></a>url</strong> 804 </summary> 805 806 <blockquote> 807 808 **Description:** [beta] The URL to a Jackal package to import via OCI 809 810 | | | 811 | -------- | -------- | 812 | **Type** | `string` | 813 814 | Restrictions | | 815 | --------------------------------- | --------------------------------------------------------------------------- | 816 | **Must match regular expression** | ```^oci://.*$``` [Test](https://regex101.com/?regex=%5Eoci%3A%2F%2F.%2A%24) | 817 818 </blockquote> 819 </details> 820 821 </blockquote> 822 </details> 823 824 <details open> 825 <summary> 826 <strong> <a name="components_items_manifests"></a>manifests</strong> 827 </summary> 828 829 <blockquote> 830 831 ## components > manifests 832 833 **Description:** Kubernetes manifests to be included in a generated Helm chart on package deploy 834 835 | | | 836 | -------- | ------- | 837 | **Type** | `array` | 838 839  840  841  842  843 844 ### <a name="autogenerated_heading_8"></a>JackalManifest 845 846 | | | 847 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 848 | **Type** | `object` | 849 | **Additional properties** | [](# "Additional Properties not allowed.") | 850 | **Defined in** | #/definitions/JackalManifest | 851 852 <details> 853 <summary> 854 <strong> <a name="components_items_manifests_items_name"></a>name *</strong> 855 </summary> 856 857 <blockquote> 858 859  860 861 **Description:** A name to give this collection of manifests; this will become the name of the dynamically-created helm chart 862 863 | | | 864 | -------- | -------- | 865 | **Type** | `string` | 866 867 </blockquote> 868 </details> 869 870 <details> 871 <summary> 872 <strong> <a name="components_items_manifests_items_namespace"></a>namespace</strong> 873 </summary> 874 875 <blockquote> 876 877 **Description:** The namespace to deploy the manifests to 878 879 | | | 880 | -------- | -------- | 881 | **Type** | `string` | 882 883 </blockquote> 884 </details> 885 886 <details> 887 <summary> 888 <strong> <a name="components_items_manifests_items_files"></a>files</strong> 889 </summary> 890 891 <blockquote> 892 893 **Description:** List of local K8s YAML files or remote URLs to deploy (in order) 894 895 | | | 896 | -------- | ----------------- | 897 | **Type** | `array of string` | 898 899  900  901  902  903 904 ### <a name="autogenerated_heading_9"></a>files items 905 906 | | | 907 | -------- | -------- | 908 | **Type** | `string` | 909 910 </blockquote> 911 </details> 912 913 <details> 914 <summary> 915 <strong> <a name="components_items_manifests_items_kustomizeAllowAnyDirectory"></a>kustomizeAllowAnyDirectory</strong> 916 </summary> 917 918 <blockquote> 919 920 **Description:** Allow traversing directory above the current directory if needed for kustomization 921 922 | | | 923 | -------- | --------- | 924 | **Type** | `boolean` | 925 926 </blockquote> 927 </details> 928 929 <details> 930 <summary> 931 <strong> <a name="components_items_manifests_items_kustomizations"></a>kustomizations</strong> 932 </summary> 933 934 <blockquote> 935 936 **Description:** List of local kustomization paths or remote URLs to include in the package 937 938 | | | 939 | -------- | ----------------- | 940 | **Type** | `array of string` | 941 942  943  944  945  946 947 ### <a name="autogenerated_heading_10"></a>kustomizations items 948 949 | | | 950 | -------- | -------- | 951 | **Type** | `string` | 952 953 </blockquote> 954 </details> 955 956 <details> 957 <summary> 958 <strong> <a name="components_items_manifests_items_noWait"></a>noWait</strong> 959 </summary> 960 961 <blockquote> 962 963 **Description:** Whether to not wait for manifest resources to be ready before continuing 964 965 | | | 966 | -------- | --------- | 967 | **Type** | `boolean` | 968 969 </blockquote> 970 </details> 971 972 </blockquote> 973 </details> 974 975 <details open> 976 <summary> 977 <strong> <a name="components_items_charts"></a>charts</strong> 978 </summary> 979 980 <blockquote> 981 982 ## components > charts 983 984 **Description:** Helm charts to install during package deploy 985 986 | | | 987 | -------- | ------- | 988 | **Type** | `array` | 989 990  991  992  993  994 995 ### <a name="autogenerated_heading_11"></a>JackalChart 996 997 | | | 998 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 999 | **Type** | `object` | 1000 | **Additional properties** | [](# "Additional Properties not allowed.") | 1001 | **Defined in** | #/definitions/JackalChart | 1002 1003 <details> 1004 <summary> 1005 <strong> <a name="components_items_charts_items_name"></a>name *</strong> 1006 </summary> 1007 1008 <blockquote> 1009 1010  1011 1012 **Description:** The name of the chart within Jackal; note that this must be unique and does not need to be the same as the name in the chart repo 1013 1014 | | | 1015 | -------- | -------- | 1016 | **Type** | `string` | 1017 1018 </blockquote> 1019 </details> 1020 1021 <details> 1022 <summary> 1023 <strong> <a name="components_items_charts_items_version"></a>version</strong> 1024 </summary> 1025 1026 <blockquote> 1027 1028 **Description:** The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos') 1029 1030 | | | 1031 | -------- | -------- | 1032 | **Type** | `string` | 1033 1034 </blockquote> 1035 </details> 1036 1037 <details> 1038 <summary> 1039 <strong> <a name="components_items_charts_items_url"></a>url</strong> 1040 </summary> 1041 1042 <blockquote> 1043 1044 **Description:** The URL of the OCI registry, chart repository, or git repo where the helm chart is stored 1045 1046 | | | 1047 | -------- | -------- | 1048 | **Type** | `string` | 1049 1050 **Examples:** 1051 1052 <code> 1053 "OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo", "helm chart repo: https://stefanprodan.github.io/podinfo", "git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"</code> 1054 1055 </blockquote> 1056 </details> 1057 1058 <details> 1059 <summary> 1060 <strong> <a name="components_items_charts_items_repoName"></a>repoName</strong> 1061 </summary> 1062 1063 <blockquote> 1064 1065 **Description:** The name of a chart within a Helm repository (defaults to the Jackal name of the chart) 1066 1067 | | | 1068 | -------- | -------- | 1069 | **Type** | `string` | 1070 1071 </blockquote> 1072 </details> 1073 1074 <details> 1075 <summary> 1076 <strong> <a name="components_items_charts_items_gitPath"></a>gitPath</strong> 1077 </summary> 1078 1079 <blockquote> 1080 1081 **Description:** (git repo only) The sub directory to the chart within a git repo 1082 1083 | | | 1084 | -------- | -------- | 1085 | **Type** | `string` | 1086 1087 **Example:** 1088 1089 <code> 1090 "charts/your-chart"</code> 1091 1092 </blockquote> 1093 </details> 1094 1095 <details> 1096 <summary> 1097 <strong> <a name="components_items_charts_items_localPath"></a>localPath</strong> 1098 </summary> 1099 1100 <blockquote> 1101 1102 **Description:** The path to a local chart's folder or .tgz archive 1103 1104 | | | 1105 | -------- | -------- | 1106 | **Type** | `string` | 1107 1108 </blockquote> 1109 </details> 1110 1111 <details> 1112 <summary> 1113 <strong> <a name="components_items_charts_items_namespace"></a>namespace *</strong> 1114 </summary> 1115 1116 <blockquote> 1117 1118  1119 1120 **Description:** The namespace to deploy the chart to 1121 1122 | | | 1123 | -------- | -------- | 1124 | **Type** | `string` | 1125 1126 </blockquote> 1127 </details> 1128 1129 <details> 1130 <summary> 1131 <strong> <a name="components_items_charts_items_releaseName"></a>releaseName</strong> 1132 </summary> 1133 1134 <blockquote> 1135 1136 **Description:** The name of the Helm release to create (defaults to the Jackal name of the chart) 1137 1138 | | | 1139 | -------- | -------- | 1140 | **Type** | `string` | 1141 1142 </blockquote> 1143 </details> 1144 1145 <details> 1146 <summary> 1147 <strong> <a name="components_items_charts_items_noWait"></a>noWait</strong> 1148 </summary> 1149 1150 <blockquote> 1151 1152 **Description:** Whether to not wait for chart resources to be ready before continuing 1153 1154 | | | 1155 | -------- | --------- | 1156 | **Type** | `boolean` | 1157 1158 </blockquote> 1159 </details> 1160 1161 <details> 1162 <summary> 1163 <strong> <a name="components_items_charts_items_valuesFiles"></a>valuesFiles</strong> 1164 </summary> 1165 1166 <blockquote> 1167 1168 **Description:** List of local values file paths or remote URLs to include in the package; these will be merged together when deployed 1169 1170 | | | 1171 | -------- | ----------------- | 1172 | **Type** | `array of string` | 1173 1174  1175  1176  1177  1178 1179 ### <a name="autogenerated_heading_12"></a>valuesFiles items 1180 1181 | | | 1182 | -------- | -------- | 1183 | **Type** | `string` | 1184 1185 </blockquote> 1186 </details> 1187 1188 </blockquote> 1189 </details> 1190 1191 <details open> 1192 <summary> 1193 <strong> <a name="components_items_dataInjections"></a>dataInjections</strong> 1194 </summary> 1195 1196 <blockquote> 1197 1198 ## components > dataInjections 1199 1200 **Description:** Datasets to inject into a container in the target cluster 1201 1202 | | | 1203 | -------- | ------- | 1204 | **Type** | `array` | 1205 1206  1207  1208  1209  1210 1211 ### <a name="autogenerated_heading_13"></a>JackalDataInjection 1212 1213 | | | 1214 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1215 | **Type** | `object` | 1216 | **Additional properties** | [](# "Additional Properties not allowed.") | 1217 | **Defined in** | #/definitions/JackalDataInjection | 1218 1219 <details> 1220 <summary> 1221 <strong> <a name="components_items_dataInjections_items_source"></a>source *</strong> 1222 </summary> 1223 1224 <blockquote> 1225 1226  1227 1228 **Description:** Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container 1229 1230 | | | 1231 | -------- | -------- | 1232 | **Type** | `string` | 1233 1234 </blockquote> 1235 </details> 1236 1237 <details open> 1238 <summary> 1239 <strong> <a name="components_items_dataInjections_items_target"></a>target *</strong> 1240 </summary> 1241 1242 <blockquote> 1243 1244 ## components > dataInjections > target 1245  1246 1247 **Description:** The target pod + container to inject the data into 1248 1249 | | | 1250 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1251 | **Type** | `object` | 1252 | **Additional properties** | [](# "Additional Properties not allowed.") | 1253 | **Defined in** | #/definitions/JackalContainerTarget | 1254 1255 <details> 1256 <summary> 1257 <strong> <a name="components_items_dataInjections_items_target_namespace"></a>namespace *</strong> 1258 </summary> 1259 1260 <blockquote> 1261 1262  1263 1264 **Description:** The namespace to target for data injection 1265 1266 | | | 1267 | -------- | -------- | 1268 | **Type** | `string` | 1269 1270 </blockquote> 1271 </details> 1272 1273 <details> 1274 <summary> 1275 <strong> <a name="components_items_dataInjections_items_target_selector"></a>selector *</strong> 1276 </summary> 1277 1278 <blockquote> 1279 1280  1281 1282 **Description:** The K8s selector to target for data injection 1283 1284 | | | 1285 | -------- | -------- | 1286 | **Type** | `string` | 1287 1288 **Example:** 1289 1290 <code> 1291 "app=data-injection"</code> 1292 1293 </blockquote> 1294 </details> 1295 1296 <details> 1297 <summary> 1298 <strong> <a name="components_items_dataInjections_items_target_container"></a>container *</strong> 1299 </summary> 1300 1301 <blockquote> 1302 1303  1304 1305 **Description:** The container name to target for data injection 1306 1307 | | | 1308 | -------- | -------- | 1309 | **Type** | `string` | 1310 1311 </blockquote> 1312 </details> 1313 1314 <details> 1315 <summary> 1316 <strong> <a name="components_items_dataInjections_items_target_path"></a>path *</strong> 1317 </summary> 1318 1319 <blockquote> 1320 1321  1322 1323 **Description:** The path within the container to copy the data into 1324 1325 | | | 1326 | -------- | -------- | 1327 | **Type** | `string` | 1328 1329 </blockquote> 1330 </details> 1331 1332 </blockquote> 1333 </details> 1334 1335 <details> 1336 <summary> 1337 <strong> <a name="components_items_dataInjections_items_compress"></a>compress</strong> 1338 </summary> 1339 1340 <blockquote> 1341 1342 **Description:** Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image. 1343 1344 | | | 1345 | -------- | --------- | 1346 | **Type** | `boolean` | 1347 1348 </blockquote> 1349 </details> 1350 1351 </blockquote> 1352 </details> 1353 1354 <details open> 1355 <summary> 1356 <strong> <a name="components_items_files"></a>files</strong> 1357 </summary> 1358 1359 <blockquote> 1360 1361 ## components > files 1362 1363 **Description:** Files or folders to place on disk during package deployment 1364 1365 | | | 1366 | -------- | ------- | 1367 | **Type** | `array` | 1368 1369  1370  1371  1372  1373 1374 ### <a name="autogenerated_heading_14"></a>JackalFile 1375 1376 | | | 1377 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1378 | **Type** | `object` | 1379 | **Additional properties** | [](# "Additional Properties not allowed.") | 1380 | **Defined in** | #/definitions/JackalFile | 1381 1382 <details> 1383 <summary> 1384 <strong> <a name="components_items_files_items_source"></a>source *</strong> 1385 </summary> 1386 1387 <blockquote> 1388 1389  1390 1391 **Description:** Local folder or file path or remote URL to pull into the package 1392 1393 | | | 1394 | -------- | -------- | 1395 | **Type** | `string` | 1396 1397 </blockquote> 1398 </details> 1399 1400 <details> 1401 <summary> 1402 <strong> <a name="components_items_files_items_shasum"></a>shasum</strong> 1403 </summary> 1404 1405 <blockquote> 1406 1407 **Description:** (files only) Optional SHA256 checksum of the file 1408 1409 | | | 1410 | -------- | -------- | 1411 | **Type** | `string` | 1412 1413 </blockquote> 1414 </details> 1415 1416 <details> 1417 <summary> 1418 <strong> <a name="components_items_files_items_target"></a>target *</strong> 1419 </summary> 1420 1421 <blockquote> 1422 1423  1424 1425 **Description:** The absolute or relative path where the file or folder should be copied to during package deploy 1426 1427 | | | 1428 | -------- | -------- | 1429 | **Type** | `string` | 1430 1431 </blockquote> 1432 </details> 1433 1434 <details> 1435 <summary> 1436 <strong> <a name="components_items_files_items_executable"></a>executable</strong> 1437 </summary> 1438 1439 <blockquote> 1440 1441 **Description:** (files only) Determines if the file should be made executable during package deploy 1442 1443 | | | 1444 | -------- | --------- | 1445 | **Type** | `boolean` | 1446 1447 </blockquote> 1448 </details> 1449 1450 <details> 1451 <summary> 1452 <strong> <a name="components_items_files_items_symlinks"></a>symlinks</strong> 1453 </summary> 1454 1455 <blockquote> 1456 1457 **Description:** List of symlinks to create during package deploy 1458 1459 | | | 1460 | -------- | ----------------- | 1461 | **Type** | `array of string` | 1462 1463  1464  1465  1466  1467 1468 ### <a name="autogenerated_heading_15"></a>symlinks items 1469 1470 | | | 1471 | -------- | -------- | 1472 | **Type** | `string` | 1473 1474 </blockquote> 1475 </details> 1476 1477 <details> 1478 <summary> 1479 <strong> <a name="components_items_files_items_extractPath"></a>extractPath</strong> 1480 </summary> 1481 1482 <blockquote> 1483 1484 **Description:** Local folder or file to be extracted from a 'source' archive 1485 1486 | | | 1487 | -------- | -------- | 1488 | **Type** | `string` | 1489 1490 </blockquote> 1491 </details> 1492 1493 </blockquote> 1494 </details> 1495 1496 <details> 1497 <summary> 1498 <strong> <a name="components_items_images"></a>images</strong> 1499 </summary> 1500 1501 <blockquote> 1502 1503 **Description:** List of OCI images to include in the package 1504 1505 | | | 1506 | -------- | ----------------- | 1507 | **Type** | `array of string` | 1508 1509  1510  1511  1512  1513 1514 ### <a name="autogenerated_heading_16"></a>images items 1515 1516 | | | 1517 | -------- | -------- | 1518 | **Type** | `string` | 1519 1520 </blockquote> 1521 </details> 1522 1523 <details> 1524 <summary> 1525 <strong> <a name="components_items_repos"></a>repos</strong> 1526 </summary> 1527 1528 <blockquote> 1529 1530 **Description:** List of git repos to include in the package 1531 1532 | | | 1533 | -------- | ----------------- | 1534 | **Type** | `array of string` | 1535 1536  1537  1538  1539  1540 1541 ### <a name="autogenerated_heading_17"></a>repos items 1542 1543 | | | 1544 | -------- | -------- | 1545 | **Type** | `string` | 1546 1547 </blockquote> 1548 </details> 1549 1550 <details open> 1551 <summary> 1552 <strong> <a name="components_items_extensions"></a>extensions</strong> 1553 </summary> 1554 1555 <blockquote> 1556 1557 ## components > extensions 1558 1559 **Description:** Extend component functionality with additional features 1560 1561 | | | 1562 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1563 | **Type** | `object` | 1564 | **Additional properties** | [](# "Additional Properties not allowed.") | 1565 | **Defined in** | #/definitions/JackalComponentExtensions | 1566 1567 <details open> 1568 <summary> 1569 <strong> <a name="components_items_extensions_bigbang"></a>bigbang</strong> 1570 </summary> 1571 1572 <blockquote> 1573 1574 ## components > extensions > bigbang 1575 1576 **Description:** Configurations for installing Big Bang and Flux in the cluster 1577 1578 | | | 1579 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1580 | **Type** | `object` | 1581 | **Additional properties** | [](# "Additional Properties not allowed.") | 1582 | **Defined in** | #/definitions/BigBang | 1583 1584 <details> 1585 <summary> 1586 <strong> <a name="components_items_extensions_bigbang_version"></a>version *</strong> 1587 </summary> 1588 1589 <blockquote> 1590 1591  1592 1593 **Description:** The version of Big Bang to use 1594 1595 | | | 1596 | -------- | -------- | 1597 | **Type** | `string` | 1598 1599 </blockquote> 1600 </details> 1601 1602 <details> 1603 <summary> 1604 <strong> <a name="components_items_extensions_bigbang_repo"></a>repo</strong> 1605 </summary> 1606 1607 <blockquote> 1608 1609 **Description:** Override repo to pull Big Bang from instead of Repo One 1610 1611 | | | 1612 | -------- | -------- | 1613 | **Type** | `string` | 1614 1615 </blockquote> 1616 </details> 1617 1618 <details> 1619 <summary> 1620 <strong> <a name="components_items_extensions_bigbang_valuesFiles"></a>valuesFiles</strong> 1621 </summary> 1622 1623 <blockquote> 1624 1625 **Description:** The list of values files to pass to Big Bang; these will be merged together 1626 1627 | | | 1628 | -------- | ----------------- | 1629 | **Type** | `array of string` | 1630 1631  1632  1633  1634  1635 1636 ### <a name="autogenerated_heading_18"></a>valuesFiles items 1637 1638 | | | 1639 | -------- | -------- | 1640 | **Type** | `string` | 1641 1642 </blockquote> 1643 </details> 1644 1645 <details> 1646 <summary> 1647 <strong> <a name="components_items_extensions_bigbang_skipFlux"></a>skipFlux</strong> 1648 </summary> 1649 1650 <blockquote> 1651 1652 **Description:** Whether to skip deploying flux; Defaults to false 1653 1654 | | | 1655 | -------- | --------- | 1656 | **Type** | `boolean` | 1657 1658 </blockquote> 1659 </details> 1660 1661 <details> 1662 <summary> 1663 <strong> <a name="components_items_extensions_bigbang_fluxPatchFiles"></a>fluxPatchFiles</strong> 1664 </summary> 1665 1666 <blockquote> 1667 1668 **Description:** Optional paths to Flux kustomize strategic merge patch files 1669 1670 | | | 1671 | -------- | ----------------- | 1672 | **Type** | `array of string` | 1673 1674  1675  1676  1677  1678 1679 ### <a name="autogenerated_heading_19"></a>fluxPatchFiles items 1680 1681 | | | 1682 | -------- | -------- | 1683 | **Type** | `string` | 1684 1685 </blockquote> 1686 </details> 1687 1688 </blockquote> 1689 </details> 1690 1691 </blockquote> 1692 </details> 1693 1694 <details open> 1695 <summary> 1696 <strong> <a name="components_items_actions"></a>actions</strong> 1697 </summary> 1698 1699 <blockquote> 1700 1701 ## components > actions 1702 1703 **Description:** Custom commands to run at various stages of a package lifecycle 1704 1705 | | | 1706 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1707 | **Type** | `object` | 1708 | **Additional properties** | [](# "Additional Properties not allowed.") | 1709 | **Defined in** | #/definitions/JackalComponentActions | 1710 1711 <details open> 1712 <summary> 1713 <strong> <a name="components_items_actions_onCreate"></a>onCreate</strong> 1714 </summary> 1715 1716 <blockquote> 1717 1718 ## components > actions > onCreate 1719 1720 **Description:** Actions to run during package creation 1721 1722 | | | 1723 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1724 | **Type** | `object` | 1725 | **Additional properties** | [](# "Additional Properties not allowed.") | 1726 | **Defined in** | #/definitions/JackalComponentActionSet | 1727 1728 <details open> 1729 <summary> 1730 <strong> <a name="components_items_actions_onCreate_defaults"></a>defaults</strong> 1731 </summary> 1732 1733 <blockquote> 1734 1735 ## components > actions > onCreate > defaults 1736 1737 **Description:** Default configuration for all actions in this set 1738 1739 | | | 1740 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1741 | **Type** | `object` | 1742 | **Additional properties** | [](# "Additional Properties not allowed.") | 1743 | **Defined in** | #/definitions/JackalComponentActionDefaults | 1744 1745 <details> 1746 <summary> 1747 <strong> <a name="components_items_actions_onCreate_defaults_mute"></a>mute</strong> 1748 </summary> 1749 1750 <blockquote> 1751 1752 **Description:** Hide the output of commands during execution (default false) 1753 1754 | | | 1755 | -------- | --------- | 1756 | **Type** | `boolean` | 1757 1758 </blockquote> 1759 </details> 1760 1761 <details> 1762 <summary> 1763 <strong> <a name="components_items_actions_onCreate_defaults_maxTotalSeconds"></a>maxTotalSeconds</strong> 1764 </summary> 1765 1766 <blockquote> 1767 1768 **Description:** Default timeout in seconds for commands (default to 0 1769 1770 | | | 1771 | -------- | --------- | 1772 | **Type** | `integer` | 1773 1774 </blockquote> 1775 </details> 1776 1777 <details> 1778 <summary> 1779 <strong> <a name="components_items_actions_onCreate_defaults_maxRetries"></a>maxRetries</strong> 1780 </summary> 1781 1782 <blockquote> 1783 1784 **Description:** Retry commands given number of times if they fail (default 0) 1785 1786 | | | 1787 | -------- | --------- | 1788 | **Type** | `integer` | 1789 1790 </blockquote> 1791 </details> 1792 1793 <details> 1794 <summary> 1795 <strong> <a name="components_items_actions_onCreate_defaults_dir"></a>dir</strong> 1796 </summary> 1797 1798 <blockquote> 1799 1800 **Description:** Working directory for commands (default CWD) 1801 1802 | | | 1803 | -------- | -------- | 1804 | **Type** | `string` | 1805 1806 </blockquote> 1807 </details> 1808 1809 <details> 1810 <summary> 1811 <strong> <a name="components_items_actions_onCreate_defaults_env"></a>env</strong> 1812 </summary> 1813 1814 <blockquote> 1815 1816 **Description:** Additional environment variables for commands 1817 1818 | | | 1819 | -------- | ----------------- | 1820 | **Type** | `array of string` | 1821 1822  1823  1824  1825  1826 1827 ### <a name="autogenerated_heading_20"></a>env items 1828 1829 | | | 1830 | -------- | -------- | 1831 | **Type** | `string` | 1832 1833 </blockquote> 1834 </details> 1835 1836 <details open> 1837 <summary> 1838 <strong> <a name="components_items_actions_onCreate_defaults_shell"></a>shell</strong> 1839 </summary> 1840 1841 <blockquote> 1842 1843 ## components > actions > onCreate > defaults > shell 1844 1845 **Description:** (cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems 1846 1847 | | | 1848 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1849 | **Type** | `object` | 1850 | **Additional properties** | [](# "Additional Properties not allowed.") | 1851 | **Defined in** | #/definitions/Shell | 1852 1853 <details> 1854 <summary> 1855 <strong> <a name="components_items_actions_onCreate_defaults_shell_windows"></a>windows</strong> 1856 </summary> 1857 1858 <blockquote> 1859 1860 **Description:** (default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item) 1861 1862 | | | 1863 | -------- | -------- | 1864 | **Type** | `string` | 1865 1866 **Examples:** 1867 1868 <code> 1869 "powershell", "cmd", "pwsh", "sh", "bash", "gsh"</code> 1870 1871 </blockquote> 1872 </details> 1873 1874 <details> 1875 <summary> 1876 <strong> <a name="components_items_actions_onCreate_defaults_shell_linux"></a>linux</strong> 1877 </summary> 1878 1879 <blockquote> 1880 1881 **Description:** (default 'sh') Indicates a preference for the shell to use on Linux systems 1882 1883 | | | 1884 | -------- | -------- | 1885 | **Type** | `string` | 1886 1887 **Examples:** 1888 1889 <code> 1890 "sh", "bash", "fish", "zsh", "pwsh"</code> 1891 1892 </blockquote> 1893 </details> 1894 1895 <details> 1896 <summary> 1897 <strong> <a name="components_items_actions_onCreate_defaults_shell_darwin"></a>darwin</strong> 1898 </summary> 1899 1900 <blockquote> 1901 1902 **Description:** (default 'sh') Indicates a preference for the shell to use on macOS systems 1903 1904 | | | 1905 | -------- | -------- | 1906 | **Type** | `string` | 1907 1908 **Examples:** 1909 1910 <code> 1911 "sh", "bash", "fish", "zsh", "pwsh"</code> 1912 1913 </blockquote> 1914 </details> 1915 1916 </blockquote> 1917 </details> 1918 1919 </blockquote> 1920 </details> 1921 1922 <details open> 1923 <summary> 1924 <strong> <a name="components_items_actions_onCreate_before"></a>before</strong> 1925 </summary> 1926 1927 <blockquote> 1928 1929 ## components > actions > onCreate > before 1930 1931 **Description:** Actions to run at the start of an operation 1932 1933 | | | 1934 | -------- | ------- | 1935 | **Type** | `array` | 1936 1937  1938  1939  1940  1941 1942 ### <a name="autogenerated_heading_21"></a>JackalComponentAction 1943 1944 | | | 1945 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 1946 | **Type** | `object` | 1947 | **Additional properties** | [](# "Additional Properties not allowed.") | 1948 | **Defined in** | #/definitions/JackalComponentAction | 1949 1950 <details> 1951 <summary> 1952 <strong> <a name="components_items_actions_onCreate_before_items_mute"></a>mute</strong> 1953 </summary> 1954 1955 <blockquote> 1956 1957 **Description:** Hide the output of the command during package deployment (default false) 1958 1959 | | | 1960 | -------- | --------- | 1961 | **Type** | `boolean` | 1962 1963 </blockquote> 1964 </details> 1965 1966 <details> 1967 <summary> 1968 <strong> <a name="components_items_actions_onCreate_before_items_maxTotalSeconds"></a>maxTotalSeconds</strong> 1969 </summary> 1970 1971 <blockquote> 1972 1973 **Description:** Timeout in seconds for the command (default to 0 1974 1975 | | | 1976 | -------- | --------- | 1977 | **Type** | `integer` | 1978 1979 </blockquote> 1980 </details> 1981 1982 <details> 1983 <summary> 1984 <strong> <a name="components_items_actions_onCreate_before_items_maxRetries"></a>maxRetries</strong> 1985 </summary> 1986 1987 <blockquote> 1988 1989 **Description:** Retry the command if it fails up to given number of times (default 0) 1990 1991 | | | 1992 | -------- | --------- | 1993 | **Type** | `integer` | 1994 1995 </blockquote> 1996 </details> 1997 1998 <details> 1999 <summary> 2000 <strong> <a name="components_items_actions_onCreate_before_items_dir"></a>dir</strong> 2001 </summary> 2002 2003 <blockquote> 2004 2005 **Description:** The working directory to run the command in (default is CWD) 2006 2007 | | | 2008 | -------- | -------- | 2009 | **Type** | `string` | 2010 2011 </blockquote> 2012 </details> 2013 2014 <details> 2015 <summary> 2016 <strong> <a name="components_items_actions_onCreate_before_items_env"></a>env</strong> 2017 </summary> 2018 2019 <blockquote> 2020 2021 **Description:** Additional environment variables to set for the command 2022 2023 | | | 2024 | -------- | ----------------- | 2025 | **Type** | `array of string` | 2026 2027  2028  2029  2030  2031 2032 ### <a name="autogenerated_heading_22"></a>env items 2033 2034 | | | 2035 | -------- | -------- | 2036 | **Type** | `string` | 2037 2038 </blockquote> 2039 </details> 2040 2041 <details> 2042 <summary> 2043 <strong> <a name="components_items_actions_onCreate_before_items_cmd"></a>cmd</strong> 2044 </summary> 2045 2046 <blockquote> 2047 2048 **Description:** The command to run. Must specify either cmd or wait for the action to do anything. 2049 2050 | | | 2051 | -------- | -------- | 2052 | **Type** | `string` | 2053 2054 </blockquote> 2055 </details> 2056 2057 <details open> 2058 <summary> 2059 <strong> <a name="components_items_actions_onCreate_before_items_shell"></a>shell</strong> 2060 </summary> 2061 2062 <blockquote> 2063 2064 ## components > actions > onCreate > before > shell 2065 2066 **Description:** (cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems 2067 2068 | | | 2069 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2070 | **Type** | `object` | 2071 | **Additional properties** | [](# "Additional Properties not allowed.") | 2072 | **Same definition as** | [shell](#components_items_actions_onCreate_defaults_shell) | 2073 2074 </blockquote> 2075 </details> 2076 2077 <details open> 2078 <summary> 2079 <strong> <a name="components_items_actions_onCreate_before_items_setVariables"></a>setVariables</strong> 2080 </summary> 2081 2082 <blockquote> 2083 2084 ## components > actions > onCreate > before > setVariables 2085 2086 **Description:** (onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package. 2087 2088 | | | 2089 | -------- | ------- | 2090 | **Type** | `array` | 2091 2092  2093  2094  2095  2096 2097 ### <a name="autogenerated_heading_23"></a>JackalComponentActionSetVariable 2098 2099 | | | 2100 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2101 | **Type** | `object` | 2102 | **Additional properties** | [](# "Additional Properties not allowed.") | 2103 | **Defined in** | #/definitions/JackalComponentActionSetVariable | 2104 2105 <details> 2106 <summary> 2107 <strong> <a name="components_items_actions_onCreate_before_items_setVariables_items_name"></a>name *</strong> 2108 </summary> 2109 2110 <blockquote> 2111 2112  2113 2114 **Description:** The name to be used for the variable 2115 2116 | | | 2117 | -------- | -------- | 2118 | **Type** | `string` | 2119 2120 | Restrictions | | 2121 | --------------------------------- | ----------------------------------------------------------------------------- | 2122 | **Must match regular expression** | ```^[A-Z0-9_]+$``` [Test](https://regex101.com/?regex=%5E%5BA-Z0-9_%5D%2B%24) | 2123 2124 </blockquote> 2125 </details> 2126 2127 <details> 2128 <summary> 2129 <strong> <a name="components_items_actions_onCreate_before_items_setVariables_items_type"></a>type</strong> 2130 </summary> 2131 2132 <blockquote> 2133 2134 **Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB) 2135 2136 | | | 2137 | -------- | ------------------ | 2138 | **Type** | `enum (of string)` | 2139 2140 :::note 2141 Must be one of: 2142 * "raw" 2143 * "file" 2144 ::: 2145 2146 </blockquote> 2147 </details> 2148 2149 <details> 2150 <summary> 2151 <strong> <a name="components_items_actions_onCreate_before_items_setVariables_items_pattern"></a>pattern</strong> 2152 </summary> 2153 2154 <blockquote> 2155 2156 **Description:** An optional regex pattern that a variable value must match before a package deployment can continue. 2157 2158 | | | 2159 | -------- | -------- | 2160 | **Type** | `string` | 2161 2162 </blockquote> 2163 </details> 2164 2165 <details> 2166 <summary> 2167 <strong> <a name="components_items_actions_onCreate_before_items_setVariables_items_sensitive"></a>sensitive</strong> 2168 </summary> 2169 2170 <blockquote> 2171 2172 **Description:** Whether to mark this variable as sensitive to not print it in the Jackal log 2173 2174 | | | 2175 | -------- | --------- | 2176 | **Type** | `boolean` | 2177 2178 </blockquote> 2179 </details> 2180 2181 <details> 2182 <summary> 2183 <strong> <a name="components_items_actions_onCreate_before_items_setVariables_items_autoIndent"></a>autoIndent</strong> 2184 </summary> 2185 2186 <blockquote> 2187 2188 **Description:** Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###JACKAL_VAR_. 2189 2190 | | | 2191 | -------- | --------- | 2192 | **Type** | `boolean` | 2193 2194 </blockquote> 2195 </details> 2196 2197 </blockquote> 2198 </details> 2199 2200 <details> 2201 <summary> 2202 <strong> <a name="components_items_actions_onCreate_before_items_description"></a>description</strong> 2203 </summary> 2204 2205 <blockquote> 2206 2207 **Description:** Description of the action to be displayed during package execution instead of the command 2208 2209 | | | 2210 | -------- | -------- | 2211 | **Type** | `string` | 2212 2213 </blockquote> 2214 </details> 2215 2216 <details open> 2217 <summary> 2218 <strong> <a name="components_items_actions_onCreate_before_items_wait"></a>wait</strong> 2219 </summary> 2220 2221 <blockquote> 2222 2223 ## components > actions > onCreate > before > wait 2224 2225 **Description:** Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'jackal tools wait-for' command for more info. 2226 2227 | | | 2228 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2229 | **Type** | `object` | 2230 | **Additional properties** | [](# "Additional Properties not allowed.") | 2231 | **Defined in** | #/definitions/JackalComponentActionWait | 2232 2233 <details open> 2234 <summary> 2235 <strong> <a name="components_items_actions_onCreate_before_items_wait_cluster"></a>cluster</strong> 2236 </summary> 2237 2238 <blockquote> 2239 2240 ## components > actions > onCreate > before > wait > cluster 2241 2242 **Description:** Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified. 2243 2244 | | | 2245 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2246 | **Type** | `object` | 2247 | **Additional properties** | [](# "Additional Properties not allowed.") | 2248 | **Defined in** | #/definitions/JackalComponentActionWaitCluster | 2249 2250 <details> 2251 <summary> 2252 <strong> <a name="components_items_actions_onCreate_before_items_wait_cluster_kind"></a>kind *</strong> 2253 </summary> 2254 2255 <blockquote> 2256 2257  2258 2259 **Description:** The kind of resource to wait for 2260 2261 | | | 2262 | -------- | -------- | 2263 | **Type** | `string` | 2264 2265 **Examples:** 2266 2267 <code> 2268 "Pod", "Deployment)"</code> 2269 2270 </blockquote> 2271 </details> 2272 2273 <details> 2274 <summary> 2275 <strong> <a name="components_items_actions_onCreate_before_items_wait_cluster_name"></a>name *</strong> 2276 </summary> 2277 2278 <blockquote> 2279 2280  2281 2282 **Description:** The name of the resource or selector to wait for 2283 2284 | | | 2285 | -------- | -------- | 2286 | **Type** | `string` | 2287 2288 **Examples:** 2289 2290 <code> 2291 "podinfo", "app=podinfo"</code> 2292 2293 </blockquote> 2294 </details> 2295 2296 <details> 2297 <summary> 2298 <strong> <a name="components_items_actions_onCreate_before_items_wait_cluster_namespace"></a>namespace</strong> 2299 </summary> 2300 2301 <blockquote> 2302 2303 **Description:** The namespace of the resource to wait for 2304 2305 | | | 2306 | -------- | -------- | 2307 | **Type** | `string` | 2308 2309 </blockquote> 2310 </details> 2311 2312 <details> 2313 <summary> 2314 <strong> <a name="components_items_actions_onCreate_before_items_wait_cluster_condition"></a>condition</strong> 2315 </summary> 2316 2317 <blockquote> 2318 2319 **Description:** The condition or jsonpath state to wait for; defaults to exist 2320 2321 | | | 2322 | -------- | -------- | 2323 | **Type** | `string` | 2324 2325 **Examples:** 2326 2327 <code> 2328 "Ready", "Available"</code> 2329 2330 </blockquote> 2331 </details> 2332 2333 </blockquote> 2334 </details> 2335 2336 <details open> 2337 <summary> 2338 <strong> <a name="components_items_actions_onCreate_before_items_wait_network"></a>network</strong> 2339 </summary> 2340 2341 <blockquote> 2342 2343 ## components > actions > onCreate > before > wait > network 2344 2345 **Description:** Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified. 2346 2347 | | | 2348 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2349 | **Type** | `object` | 2350 | **Additional properties** | [](# "Additional Properties not allowed.") | 2351 | **Defined in** | #/definitions/JackalComponentActionWaitNetwork | 2352 2353 <details> 2354 <summary> 2355 <strong> <a name="components_items_actions_onCreate_before_items_wait_network_protocol"></a>protocol *</strong> 2356 </summary> 2357 2358 <blockquote> 2359 2360  2361 2362 **Description:** The protocol to wait for 2363 2364 | | | 2365 | -------- | ------------------ | 2366 | **Type** | `enum (of string)` | 2367 2368 :::note 2369 Must be one of: 2370 * "tcp" 2371 * "http" 2372 * "https" 2373 ::: 2374 2375 </blockquote> 2376 </details> 2377 2378 <details> 2379 <summary> 2380 <strong> <a name="components_items_actions_onCreate_before_items_wait_network_address"></a>address *</strong> 2381 </summary> 2382 2383 <blockquote> 2384 2385  2386 2387 **Description:** The address to wait for 2388 2389 | | | 2390 | -------- | -------- | 2391 | **Type** | `string` | 2392 2393 **Examples:** 2394 2395 <code> 2396 "localhost:8080", "1.1.1.1"</code> 2397 2398 </blockquote> 2399 </details> 2400 2401 <details> 2402 <summary> 2403 <strong> <a name="components_items_actions_onCreate_before_items_wait_network_code"></a>code</strong> 2404 </summary> 2405 2406 <blockquote> 2407 2408 **Description:** The HTTP status code to wait for if using http or https 2409 2410 | | | 2411 | -------- | --------- | 2412 | **Type** | `integer` | 2413 2414 **Examples:** 2415 2416 <code> 2417 200, 404</code> 2418 2419 </blockquote> 2420 </details> 2421 2422 </blockquote> 2423 </details> 2424 2425 </blockquote> 2426 </details> 2427 2428 </blockquote> 2429 </details> 2430 2431 <details open> 2432 <summary> 2433 <strong> <a name="components_items_actions_onCreate_after"></a>after</strong> 2434 </summary> 2435 2436 <blockquote> 2437 2438 ## components > actions > onCreate > after 2439 2440 **Description:** Actions to run at the end of an operation 2441 2442 | | | 2443 | -------- | ------- | 2444 | **Type** | `array` | 2445 2446  2447  2448  2449  2450 2451 ### <a name="autogenerated_heading_24"></a>JackalComponentAction 2452 2453 | | | 2454 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2455 | **Type** | `object` | 2456 | **Additional properties** | [](# "Additional Properties not allowed.") | 2457 | **Same definition as** | [components_items_actions_onCreate_before_items](#components_items_actions_onCreate_before_items) | 2458 2459 </blockquote> 2460 </details> 2461 2462 <details open> 2463 <summary> 2464 <strong> <a name="components_items_actions_onCreate_onSuccess"></a>onSuccess</strong> 2465 </summary> 2466 2467 <blockquote> 2468 2469 ## components > actions > onCreate > onSuccess 2470 2471 **Description:** Actions to run if all operations succeed 2472 2473 | | | 2474 | -------- | ------- | 2475 | **Type** | `array` | 2476 2477  2478  2479  2480  2481 2482 ### <a name="autogenerated_heading_25"></a>JackalComponentAction 2483 2484 | | | 2485 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2486 | **Type** | `object` | 2487 | **Additional properties** | [](# "Additional Properties not allowed.") | 2488 | **Same definition as** | [components_items_actions_onCreate_before_items](#components_items_actions_onCreate_before_items) | 2489 2490 </blockquote> 2491 </details> 2492 2493 <details open> 2494 <summary> 2495 <strong> <a name="components_items_actions_onCreate_onFailure"></a>onFailure</strong> 2496 </summary> 2497 2498 <blockquote> 2499 2500 ## components > actions > onCreate > onFailure 2501 2502 **Description:** Actions to run if all operations fail 2503 2504 | | | 2505 | -------- | ------- | 2506 | **Type** | `array` | 2507 2508  2509  2510  2511  2512 2513 ### <a name="autogenerated_heading_26"></a>JackalComponentAction 2514 2515 | | | 2516 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2517 | **Type** | `object` | 2518 | **Additional properties** | [](# "Additional Properties not allowed.") | 2519 | **Same definition as** | [components_items_actions_onCreate_before_items](#components_items_actions_onCreate_before_items) | 2520 2521 </blockquote> 2522 </details> 2523 2524 </blockquote> 2525 </details> 2526 2527 <details open> 2528 <summary> 2529 <strong> <a name="components_items_actions_onDeploy"></a>onDeploy</strong> 2530 </summary> 2531 2532 <blockquote> 2533 2534 ## components > actions > onDeploy 2535 2536 **Description:** Actions to run during package deployment 2537 2538 | | | 2539 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2540 | **Type** | `object` | 2541 | **Additional properties** | [](# "Additional Properties not allowed.") | 2542 | **Same definition as** | [onCreate](#components_items_actions_onCreate) | 2543 2544 </blockquote> 2545 </details> 2546 2547 <details open> 2548 <summary> 2549 <strong> <a name="components_items_actions_onRemove"></a>onRemove</strong> 2550 </summary> 2551 2552 <blockquote> 2553 2554 ## components > actions > onRemove 2555 2556 **Description:** Actions to run during package removal 2557 2558 | | | 2559 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2560 | **Type** | `object` | 2561 | **Additional properties** | [](# "Additional Properties not allowed.") | 2562 | **Same definition as** | [onCreate](#components_items_actions_onCreate) | 2563 2564 </blockquote> 2565 </details> 2566 2567 </blockquote> 2568 </details> 2569 2570 </blockquote> 2571 </details> 2572 2573 <details open> 2574 <summary> 2575 <strong> <a name="constants"></a>constants</strong> 2576 </summary> 2577 2578 <blockquote> 2579 2580 ## constants 2581 2582 **Description:** Constant template values applied on deploy for K8s resources 2583 2584 | | | 2585 | -------- | ------- | 2586 | **Type** | `array` | 2587 2588  2589  2590  2591  2592 2593 ### <a name="autogenerated_heading_27"></a>JackalPackageConstant 2594 2595 | | | 2596 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2597 | **Type** | `object` | 2598 | **Additional properties** | [](# "Additional Properties not allowed.") | 2599 | **Defined in** | #/definitions/JackalPackageConstant | 2600 2601 <details> 2602 <summary> 2603 <strong> <a name="constants_items_name"></a>name *</strong> 2604 </summary> 2605 2606 <blockquote> 2607 2608  2609 2610 **Description:** The name to be used for the constant 2611 2612 | | | 2613 | -------- | -------- | 2614 | **Type** | `string` | 2615 2616 | Restrictions | | 2617 | --------------------------------- | ----------------------------------------------------------------------------- | 2618 | **Must match regular expression** | ```^[A-Z0-9_]+$``` [Test](https://regex101.com/?regex=%5E%5BA-Z0-9_%5D%2B%24) | 2619 2620 </blockquote> 2621 </details> 2622 2623 <details> 2624 <summary> 2625 <strong> <a name="constants_items_value"></a>value *</strong> 2626 </summary> 2627 2628 <blockquote> 2629 2630  2631 2632 **Description:** The value to set for the constant during deploy 2633 2634 | | | 2635 | -------- | -------- | 2636 | **Type** | `string` | 2637 2638 </blockquote> 2639 </details> 2640 2641 <details> 2642 <summary> 2643 <strong> <a name="constants_items_description"></a>description</strong> 2644 </summary> 2645 2646 <blockquote> 2647 2648 **Description:** A description of the constant to explain its purpose on package create or deploy confirmation prompts 2649 2650 | | | 2651 | -------- | -------- | 2652 | **Type** | `string` | 2653 2654 </blockquote> 2655 </details> 2656 2657 <details> 2658 <summary> 2659 <strong> <a name="constants_items_autoIndent"></a>autoIndent</strong> 2660 </summary> 2661 2662 <blockquote> 2663 2664 **Description:** Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###JACKAL_CONST_. 2665 2666 | | | 2667 | -------- | --------- | 2668 | **Type** | `boolean` | 2669 2670 </blockquote> 2671 </details> 2672 2673 <details> 2674 <summary> 2675 <strong> <a name="constants_items_pattern"></a>pattern</strong> 2676 </summary> 2677 2678 <blockquote> 2679 2680 **Description:** An optional regex pattern that a constant value must match before a package can be created. 2681 2682 | | | 2683 | -------- | -------- | 2684 | **Type** | `string` | 2685 2686 </blockquote> 2687 </details> 2688 2689 </blockquote> 2690 </details> 2691 2692 <details open> 2693 <summary> 2694 <strong> <a name="variables"></a>variables</strong> 2695 </summary> 2696 2697 <blockquote> 2698 2699 ## variables 2700 2701 **Description:** Variable template values applied on deploy for K8s resources 2702 2703 | | | 2704 | -------- | ------- | 2705 | **Type** | `array` | 2706 2707  2708  2709  2710  2711 2712 ### <a name="autogenerated_heading_28"></a>JackalPackageVariable 2713 2714 | | | 2715 | ------------------------- | -------------------------------------------------------------------------------------------------------- | 2716 | **Type** | `object` | 2717 | **Additional properties** | [](# "Additional Properties not allowed.") | 2718 | **Defined in** | #/definitions/JackalPackageVariable | 2719 2720 <details> 2721 <summary> 2722 <strong> <a name="variables_items_name"></a>name *</strong> 2723 </summary> 2724 2725 <blockquote> 2726 2727  2728 2729 **Description:** The name to be used for the variable 2730 2731 | | | 2732 | -------- | -------- | 2733 | **Type** | `string` | 2734 2735 | Restrictions | | 2736 | --------------------------------- | ----------------------------------------------------------------------------- | 2737 | **Must match regular expression** | ```^[A-Z0-9_]+$``` [Test](https://regex101.com/?regex=%5E%5BA-Z0-9_%5D%2B%24) | 2738 2739 </blockquote> 2740 </details> 2741 2742 <details> 2743 <summary> 2744 <strong> <a name="variables_items_description"></a>description</strong> 2745 </summary> 2746 2747 <blockquote> 2748 2749 **Description:** A description of the variable to be used when prompting the user a value 2750 2751 | | | 2752 | -------- | -------- | 2753 | **Type** | `string` | 2754 2755 </blockquote> 2756 </details> 2757 2758 <details> 2759 <summary> 2760 <strong> <a name="variables_items_default"></a>default</strong> 2761 </summary> 2762 2763 <blockquote> 2764 2765 **Description:** The default value to use for the variable 2766 2767 | | | 2768 | -------- | -------- | 2769 | **Type** | `string` | 2770 2771 </blockquote> 2772 </details> 2773 2774 <details> 2775 <summary> 2776 <strong> <a name="variables_items_prompt"></a>prompt</strong> 2777 </summary> 2778 2779 <blockquote> 2780 2781 **Description:** Whether to prompt the user for input for this variable 2782 2783 | | | 2784 | -------- | --------- | 2785 | **Type** | `boolean` | 2786 2787 </blockquote> 2788 </details> 2789 2790 <details> 2791 <summary> 2792 <strong> <a name="variables_items_sensitive"></a>sensitive</strong> 2793 </summary> 2794 2795 <blockquote> 2796 2797 **Description:** Whether to mark this variable as sensitive to not print it in the Jackal log 2798 2799 | | | 2800 | -------- | --------- | 2801 | **Type** | `boolean` | 2802 2803 </blockquote> 2804 </details> 2805 2806 <details> 2807 <summary> 2808 <strong> <a name="variables_items_autoIndent"></a>autoIndent</strong> 2809 </summary> 2810 2811 <blockquote> 2812 2813 **Description:** Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###JACKAL_VAR_. 2814 2815 | | | 2816 | -------- | --------- | 2817 | **Type** | `boolean` | 2818 2819 </blockquote> 2820 </details> 2821 2822 <details> 2823 <summary> 2824 <strong> <a name="variables_items_pattern"></a>pattern</strong> 2825 </summary> 2826 2827 <blockquote> 2828 2829 **Description:** An optional regex pattern that a variable value must match before a package can be deployed. 2830 2831 | | | 2832 | -------- | -------- | 2833 | **Type** | `string` | 2834 2835 </blockquote> 2836 </details> 2837 2838 <details> 2839 <summary> 2840 <strong> <a name="variables_items_type"></a>type</strong> 2841 </summary> 2842 2843 <blockquote> 2844 2845 **Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB) 2846 2847 | | | 2848 | -------- | ------------------ | 2849 | **Type** | `enum (of string)` | 2850 2851 :::note 2852 Must be one of: 2853 * "raw" 2854 * "file" 2855 ::: 2856 2857 </blockquote> 2858 </details> 2859 2860 </blockquote> 2861 </details> 2862 2863 ---------------------------------------------------------------------------------------------------------------------------- 2864 Generated from [jackal.schema.json](https://github.com/Racer159/jackal/blob/main/jackal.schema.json)