github.com/argoproj-labs/argocd-operator@v0.10.0/docs/reference/api.html.md (about) 1 # API Documentation 2 <p>Packages:</p> 3 <ul> 4 <li> 5 <a href="#argoproj.io%2fv1alpha1">argoproj.io/v1alpha1</a> 6 </li> 7 </ul> 8 <h2 id="argoproj.io/v1alpha1">argoproj.io/v1alpha1</h2> 9 <p> 10 <p>Package v1alpha1 contains API Schema definitions for the argoproj v1alpha1 API group</p> 11 </p> 12 Resource Types: 13 <ul></ul> 14 <h3 id="argoproj.io/v1alpha1.ArgoCD">ArgoCD</h3> 15 <p> 16 <p>ArgoCD is the Schema for the argocds API</p> 17 </p> 18 <table> 19 <thead> 20 <tr> 21 <th>Field</th> 22 <th>Description</th> 23 </tr> 24 </thead> 25 <tbody> 26 <tr> 27 <td> 28 <code>metadata</code></br> 29 <em> 30 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#objectmeta-v1-meta"> 31 Kubernetes meta/v1.ObjectMeta 32 </a> 33 </em> 34 </td> 35 <td> 36 Refer to the Kubernetes API documentation for the fields of the 37 <code>metadata</code> field. 38 </td> 39 </tr> 40 <tr> 41 <td> 42 <code>spec</code></br> 43 <em> 44 <a href="#argoproj.io/v1alpha1.ArgoCDSpec"> 45 ArgoCDSpec 46 </a> 47 </em> 48 </td> 49 <td> 50 <br/> 51 <br/> 52 <table> 53 <tr> 54 <td> 55 <code>applicationInstanceLabelKey</code></br> 56 <em> 57 string 58 </em> 59 </td> 60 <td> 61 <p>ApplicationInstanceLabelKey is the key name where Argo CD injects the app name as a tracking label.</p> 62 </td> 63 </tr> 64 <tr> 65 <td> 66 <code>configManagementPlugins</code></br> 67 <em> 68 string 69 </em> 70 </td> 71 <td> 72 <p>ConfigManagementPlugins is used to specify additional config management plugins.</p> 73 </td> 74 </tr> 75 <tr> 76 <td> 77 <code>controller</code></br> 78 <em> 79 <a href="#argoproj.io/v1alpha1.ArgoCDApplicationControllerSpec"> 80 ArgoCDApplicationControllerSpec 81 </a> 82 </em> 83 </td> 84 <td> 85 <p>Controller defines the Application Controller options for ArgoCD.</p> 86 </td> 87 </tr> 88 <tr> 89 <td> 90 <code>gaTrackingID</code></br> 91 <em> 92 string 93 </em> 94 </td> 95 <td> 96 <p>GATrackingID is the google analytics tracking ID to use.</p> 97 </td> 98 </tr> 99 <tr> 100 <td> 101 <code>gaAnonymizeUsers</code></br> 102 <em> 103 bool 104 </em> 105 </td> 106 <td> 107 <p>GAAnonymizeUsers toggles user IDs being hashed before sending to google analytics.</p> 108 </td> 109 </tr> 110 <tr> 111 <td> 112 <code>ha</code></br> 113 <em> 114 <a href="#argoproj.io/v1alpha1.ArgoCDHASpec"> 115 ArgoCDHASpec 116 </a> 117 </em> 118 </td> 119 <td> 120 <p>HA options for High Availability support for the Redis component.</p> 121 </td> 122 </tr> 123 <tr> 124 <td> 125 <code>helpChatURL</code></br> 126 <em> 127 string 128 </em> 129 </td> 130 <td> 131 <p>HelpChatURL is the URL for getting chat help, this will typically be your Slack channel for support.</p> 132 </td> 133 </tr> 134 <tr> 135 <td> 136 <code>helpChatText</code></br> 137 <em> 138 string 139 </em> 140 </td> 141 <td> 142 <p>HelpChatText is the text for getting chat help, defaults to “Chat now!”</p> 143 </td> 144 </tr> 145 <tr> 146 <td> 147 <code>image</code></br> 148 <em> 149 string 150 </em> 151 </td> 152 <td> 153 <p>Image is the ArgoCD container image for all ArgoCD components.</p> 154 </td> 155 </tr> 156 <tr> 157 <td> 158 <code>import</code></br> 159 <em> 160 <a href="#argoproj.io/v1alpha1.ArgoCDImportSpec"> 161 ArgoCDImportSpec 162 </a> 163 </em> 164 </td> 165 <td> 166 <p>Import is the import/restore options for ArgoCD.</p> 167 </td> 168 </tr> 169 <tr> 170 <td> 171 <code>initialRepositories</code></br> 172 <em> 173 string 174 </em> 175 </td> 176 <td> 177 <p>InitialRepositories to configure Argo CD with upon creation of the cluster.</p> 178 </td> 179 </tr> 180 <tr> 181 <td> 182 <code>initialSSHKnownHosts</code></br> 183 <em> 184 string 185 </em> 186 </td> 187 <td> 188 <p>InitialSSHKnownHosts defines the SSH known hosts data upon creation of the cluster for connecting Git repositories via SSH.</p> 189 </td> 190 </tr> 191 <tr> 192 <td> 193 <code>kustomizeBuildOptions</code></br> 194 <em> 195 string 196 </em> 197 </td> 198 <td> 199 <p>KustomizeBuildOptions is used to specify build options/parameters to use with <code>kustomize build</code>.</p> 200 </td> 201 </tr> 202 <tr> 203 <td> 204 <code>notifications</code></br> 205 <em> 206 <a href="#argoproj.io/v1alpha1.ArgoCDNotificationsSpec"> 207 ArgoCDNotificationsSpec 208 </a> 209 </em> 210 </td> 211 <td> 212 <p>Notifications controls the desired state of Argo CD Notifications controller.</p> 213 </td> 214 </tr> 215 <tr> 216 <td> 217 <code>oidcConfig</code></br> 218 <em> 219 string 220 </em> 221 </td> 222 <td> 223 <p>OIDCConfig is the OIDC configuration as an alternative to dex.</p> 224 </td> 225 </tr> 226 <tr> 227 <td> 228 <code>prometheus</code></br> 229 <em> 230 <a href="#argoproj.io/v1alpha1.ArgoCDPrometheusSpec"> 231 ArgoCDPrometheusSpec 232 </a> 233 </em> 234 </td> 235 <td> 236 <p>Prometheus defines the Prometheus server options for ArgoCD.</p> 237 </td> 238 </tr> 239 <tr> 240 <td> 241 <code>rbac</code></br> 242 <em> 243 <a href="#argoproj.io/v1alpha1.ArgoCDRBACSpec"> 244 ArgoCDRBACSpec 245 </a> 246 </em> 247 </td> 248 <td> 249 <p>RBAC defines the RBAC configuration for Argo CD.</p> 250 </td> 251 </tr> 252 <tr> 253 <td> 254 <code>redis</code></br> 255 <em> 256 <a href="#argoproj.io/v1alpha1.ArgoCDRedisSpec"> 257 ArgoCDRedisSpec 258 </a> 259 </em> 260 </td> 261 <td> 262 <p>Redis defines the Redis server options for ArgoCD.</p> 263 </td> 264 </tr> 265 <tr> 266 <td> 267 <code>repo</code></br> 268 <em> 269 <a href="#argoproj.io/v1alpha1.ArgoCDRepoSpec"> 270 ArgoCDRepoSpec 271 </a> 272 </em> 273 </td> 274 <td> 275 <p>Repo defines the repo server options for Argo CD.</p> 276 </td> 277 </tr> 278 <tr> 279 <td> 280 <code>repositoryCredentials</code></br> 281 <em> 282 string 283 </em> 284 </td> 285 <td> 286 <p>RepositoryCredentials are the Git pull credentials to configure Argo CD with upon creation of the cluster.</p> 287 </td> 288 </tr> 289 <tr> 290 <td> 291 <code>resourceCustomizations</code></br> 292 <em> 293 string 294 </em> 295 </td> 296 <td> 297 <p>ResourceCustomizations customizes resource behavior. Keys are in the form: group/Kind.</p> 298 </td> 299 </tr> 300 <tr> 301 <td> 302 <code>resourceExclusions</code></br> 303 <em> 304 string 305 </em> 306 </td> 307 <td> 308 <p>ResourceExclusions is used to completely ignore entire classes of resource group/kinds.</p> 309 </td> 310 </tr> 311 <tr> 312 <td> 313 <code>server</code></br> 314 <em> 315 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec"> 316 ArgoCDServerSpec 317 </a> 318 </em> 319 </td> 320 <td> 321 <p>Server defines the options for the ArgoCD Server component.</p> 322 </td> 323 </tr> 324 <tr> 325 <td> 326 <code>sso</code></br> 327 <em> 328 <a href="#argoproj.io/v1alpha1.ArgoCDSSOSpec"> 329 ArgoCDSSOSpec 330 </a> 331 </em> 332 </td> 333 <td> 334 <p>SSO defines the Single Sign-on configuration for Argo CD.</p> 335 </td> 336 </tr> 337 <tr> 338 <td> 339 <code>statusBadgeEnabled</code></br> 340 <em> 341 bool 342 </em> 343 </td> 344 <td> 345 <p>StatusBadgeEnabled toggles application status badge feature.</p> 346 </td> 347 </tr> 348 <tr> 349 <td> 350 <code>tls</code></br> 351 <em> 352 <a href="#argoproj.io/v1alpha1.ArgoCDTLSSpec"> 353 ArgoCDTLSSpec 354 </a> 355 </em> 356 </td> 357 <td> 358 <p>TLS defines the TLS options for ArgoCD.</p> 359 </td> 360 </tr> 361 <tr> 362 <td> 363 <code>usersAnonymousEnabled</code></br> 364 <em> 365 bool 366 </em> 367 </td> 368 <td> 369 <p>UsersAnonymousEnabled toggles anonymous user access. 370 The anonymous users get default role permissions specified argocd-rbac-cm. 371 </p> 372 </td> 373 </tr> 374 <tr> 375 <td> 376 <code>version</code></br> 377 <em> 378 string 379 </em> 380 </td> 381 <td> 382 <p>Version is the tag to use with the ArgoCD container image for all ArgoCD components.</p> 383 </td> 384 </tr> 385 </table> 386 </td> 387 </tr> 388 <tr> 389 <td> 390 <code>status</code></br> 391 <em> 392 <a href="#argoproj.io/v1alpha1.ArgoCDStatus"> 393 ArgoCDStatus 394 </a> 395 </em> 396 </td> 397 <td></td> 398 </tr> 399 </tbody> 400 </table> 401 <h3 id="argoproj.io/v1alpha1.ArgoCDApplicationControllerProcessorsSpec">ArgoCDApplicationControllerProcessorsSpec</h3> 402 <p> 403 (<em>Appears on:</em> 404 <a href="#argoproj.io/v1alpha1.ArgoCDApplicationControllerSpec">ArgoCDApplicationControllerSpec</a>) 405 </p> 406 <p> 407 <p>ArgoCDApplicationControllerProcessorsSpec defines the options for the ArgoCD Application Controller processors.</p> 408 </p> 409 <table> 410 <thead> 411 <tr> 412 <th>Field</th> 413 <th>Description</th> 414 </tr> 415 </thead> 416 <tbody> 417 <tr> 418 <td> 419 <code>operation</code></br> 420 <em> 421 int32 422 </em> 423 </td> 424 <td> 425 <p>Operation is the number of application operation processors.</p> 426 </td> 427 </tr> 428 <tr> 429 <td> 430 <code>status</code></br> 431 <em> 432 int32 433 </em> 434 </td> 435 <td> 436 <p>Status is the number of application status processors.</p> 437 </td> 438 </tr> 439 </tbody> 440 </table> 441 <h3 id="argoproj.io/v1alpha1.ArgoCDApplicationControllerSpec">ArgoCDApplicationControllerSpec</h3> 442 <p> 443 (<em>Appears on:</em> 444 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 445 </p> 446 <p> 447 <p>ArgoCDApplicationControllerSpec defines the options for the ArgoCD Application Controller component.</p> 448 </p> 449 <table> 450 <thead> 451 <tr> 452 <th>Field</th> 453 <th>Description</th> 454 </tr> 455 </thead> 456 <tbody> 457 <tr> 458 <td> 459 <code>processors</code></br> 460 <em> 461 <a href="#argoproj.io/v1alpha1.ArgoCDApplicationControllerProcessorsSpec"> 462 ArgoCDApplicationControllerProcessorsSpec 463 </a> 464 </em> 465 </td> 466 <td> 467 <p>Processors contains the options for the Application Controller processors.</p> 468 </td> 469 </tr> 470 <tr> 471 <td> 472 <code>resources</code></br> 473 <em> 474 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 475 Kubernetes core/v1.ResourceRequirements 476 </a> 477 </em> 478 </td> 479 <td> 480 <p>Resources defines the Compute Resources required by the container for the Application Controller.</p> 481 </td> 482 </tr> 483 </tbody> 484 </table> 485 <h3 id="argoproj.io/v1alpha1.ArgoCDCASpec">ArgoCDCASpec</h3> 486 <p> 487 (<em>Appears on:</em> 488 <a href="#argoproj.io/v1alpha1.ArgoCDTLSSpec">ArgoCDTLSSpec</a>) 489 </p> 490 <p> 491 <p>ArgoCDCASpec defines the CA options for ArgCD.</p> 492 </p> 493 <table> 494 <thead> 495 <tr> 496 <th>Field</th> 497 <th>Description</th> 498 </tr> 499 </thead> 500 <tbody> 501 <tr> 502 <td> 503 <code>configMapName</code></br> 504 <em> 505 string 506 </em> 507 </td> 508 <td> 509 <p>ConfigMapName is the name of the ConfigMap containing the CA Certificate.</p> 510 </td> 511 </tr> 512 <tr> 513 <td> 514 <code>secretName</code></br> 515 <em> 516 string 517 </em> 518 </td> 519 <td> 520 <p>SecretName is the name of the Secret containing the CA Certificate and Key.</p> 521 </td> 522 </tr> 523 </tbody> 524 </table> 525 <h3 id="argoproj.io/v1alpha1.ArgoCDCertificateSpec">ArgoCDCertificateSpec</h3> 526 <p> 527 <p>ArgoCDCertificateSpec defines the options for the ArgoCD certificates.</p> 528 </p> 529 <table> 530 <thead> 531 <tr> 532 <th>Field</th> 533 <th>Description</th> 534 </tr> 535 </thead> 536 <tbody> 537 <tr> 538 <td> 539 <code>secretName</code></br> 540 <em> 541 string 542 </em> 543 </td> 544 <td> 545 <p>SecretName is the name of the Secret containing the Certificate and Key.</p> 546 </td> 547 </tr> 548 </tbody> 549 </table> 550 <h3 id="argoproj.io/v1alpha1.ArgoCDDexOAuthSpec">ArgoCDDexOAuthSpec</h3> 551 <p> 552 <p>ArgoCDDexOAuthSpec defines the desired state for the Dex OAuth configuration.</p> 553 </p> 554 <table> 555 <thead> 556 <tr> 557 <th>Field</th> 558 <th>Description</th> 559 </tr> 560 </thead> 561 <tbody> 562 <tr> 563 <td> 564 <code>enabled</code></br> 565 <em> 566 bool 567 </em> 568 </td> 569 <td> 570 <p>Enabled will toggle OAuth support for the Dex server.</p> 571 </td> 572 </tr> 573 </tbody> 574 </table> 575 <h3 id="argoproj.io/v1alpha1.ArgoCDDexSpec">ArgoCDDexSpec</h3> 576 <p> 577 (<em>Appears on:</em> 578 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 579 </p> 580 <p> 581 <p>ArgoCDDexSpec defines the desired state for the Dex server component.</p> 582 </p> 583 <table> 584 <thead> 585 <tr> 586 <th>Field</th> 587 <th>Description</th> 588 </tr> 589 </thead> 590 <tbody> 591 <tr> 592 <td> 593 <code>config</code></br> 594 <em> 595 string 596 </em> 597 </td> 598 <td> 599 <p>Config is the dex connector configuration.</p> 600 </td> 601 </tr> 602 <tr> 603 <td> 604 <code>image</code></br> 605 <em> 606 string 607 </em> 608 </td> 609 <td> 610 <p>Image is the Dex container image.</p> 611 </td> 612 </tr> 613 <tr> 614 <td> 615 <code>openShiftOAuth</code></br> 616 <em> 617 bool 618 </em> 619 </td> 620 <td> 621 <p>OpenShiftOAuth enables OpenShift OAuth authentication for the Dex server.</p> 622 </td> 623 </tr> 624 <tr> 625 <td> 626 <code>resources</code></br> 627 <em> 628 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 629 Kubernetes core/v1.ResourceRequirements 630 </a> 631 </em> 632 </td> 633 <td> 634 <p>Resources defines the Compute Resources required by the container for Dex.</p> 635 </td> 636 </tr> 637 <tr> 638 <td> 639 <code>version</code></br> 640 <em> 641 string 642 </em> 643 </td> 644 <td> 645 <p>Version is the Dex container image tag.</p> 646 </td> 647 </tr> 648 </tbody> 649 </table> 650 <h3 id="argoproj.io/v1alpha1.ArgoCDExport">ArgoCDExport</h3> 651 <p> 652 <p>ArgoCDExport is the Schema for the argocdexports API</p> 653 </p> 654 <table> 655 <thead> 656 <tr> 657 <th>Field</th> 658 <th>Description</th> 659 </tr> 660 </thead> 661 <tbody> 662 <tr> 663 <td> 664 <code>metadata</code></br> 665 <em> 666 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta"> 667 Kubernetes meta/v1.ObjectMeta 668 </a> 669 </em> 670 </td> 671 <td> 672 Refer to the Kubernetes API documentation for the fields of the 673 <code>metadata</code> field. 674 </td> 675 </tr> 676 <tr> 677 <td> 678 <code>spec</code></br> 679 <em> 680 <a href="#argoproj.io/v1alpha1.ArgoCDExportSpec"> 681 ArgoCDExportSpec 682 </a> 683 </em> 684 </td> 685 <td> 686 <br/> 687 <br/> 688 <table> 689 <tr> 690 <td> 691 <code>argocd</code></br> 692 <em> 693 string 694 </em> 695 </td> 696 <td> 697 <p>Argocd is the name of the ArgoCD instance to export.</p> 698 </td> 699 </tr> 700 <tr> 701 <td> 702 <code>image</code></br> 703 <em> 704 string 705 </em> 706 </td> 707 <td> 708 <p>Image is the container image to use for the export Job.</p> 709 </td> 710 </tr> 711 <tr> 712 <td> 713 <code>schedule</code></br> 714 <em> 715 string 716 </em> 717 </td> 718 <td> 719 <p>Schedule in Cron format, see <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p> 720 </td> 721 </tr> 722 <tr> 723 <td> 724 <code>storage</code></br> 725 <em> 726 <a href="#argoproj.io/v1alpha1.ArgoCDExportStorageSpec"> 727 ArgoCDExportStorageSpec 728 </a> 729 </em> 730 </td> 731 <td> 732 <p>Storage defines the storage configuration options.</p> 733 </td> 734 </tr> 735 <tr> 736 <td> 737 <code>version</code></br> 738 <em> 739 string 740 </em> 741 </td> 742 <td> 743 <p>Version is the tag/digest to use for the export Job container image.</p> 744 </td> 745 </tr> 746 </table> 747 </td> 748 </tr> 749 <tr> 750 <td> 751 <code>status</code></br> 752 <em> 753 <a href="#argoproj.io/v1alpha1.ArgoCDExportStatus"> 754 ArgoCDExportStatus 755 </a> 756 </em> 757 </td> 758 <td></td> 759 </tr> 760 </tbody> 761 </table> 762 <h3 id="argoproj.io/v1alpha1.ArgoCDExportSpec">ArgoCDExportSpec</h3> 763 <p> 764 (<em>Appears on:</em> 765 <a href="#argoproj.io/v1alpha1.ArgoCDExport">ArgoCDExport</a>) 766 </p> 767 <p> 768 <p>ArgoCDExportSpec defines the desired state of ArgoCDExport</p> 769 </p> 770 <table> 771 <thead> 772 <tr> 773 <th>Field</th> 774 <th>Description</th> 775 </tr> 776 </thead> 777 <tbody> 778 <tr> 779 <td> 780 <code>argocd</code></br> 781 <em> 782 string 783 </em> 784 </td> 785 <td> 786 <p>Argocd is the name of the ArgoCD instance to export.</p> 787 </td> 788 </tr> 789 <tr> 790 <td> 791 <code>image</code></br> 792 <em> 793 string 794 </em> 795 </td> 796 <td> 797 <p>Image is the container image to use for the export Job.</p> 798 </td> 799 </tr> 800 <tr> 801 <td> 802 <code>schedule</code></br> 803 <em> 804 string 805 </em> 806 </td> 807 <td> 808 <p>Schedule in Cron format, see <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p> 809 </td> 810 </tr> 811 <tr> 812 <td> 813 <code>storage</code></br> 814 <em> 815 <a href="#argoproj.io/v1alpha1.ArgoCDExportStorageSpec"> 816 ArgoCDExportStorageSpec 817 </a> 818 </em> 819 </td> 820 <td> 821 <p>Storage defines the storage configuration options.</p> 822 </td> 823 </tr> 824 <tr> 825 <td> 826 <code>version</code></br> 827 <em> 828 string 829 </em> 830 </td> 831 <td> 832 <p>Version is the tag/digest to use for the export Job container image.</p> 833 </td> 834 </tr> 835 </tbody> 836 </table> 837 <h3 id="argoproj.io/v1alpha1.ArgoCDExportStatus">ArgoCDExportStatus</h3> 838 <p> 839 (<em>Appears on:</em> 840 <a href="#argoproj.io/v1alpha1.ArgoCDExport">ArgoCDExport</a>) 841 </p> 842 <p> 843 <p>ArgoCDExportStatus defines the observed state of ArgoCDExport</p> 844 </p> 845 <table> 846 <thead> 847 <tr> 848 <th>Field</th> 849 <th>Description</th> 850 </tr> 851 </thead> 852 <tbody> 853 <tr> 854 <td> 855 <code>phase</code></br> 856 <em> 857 string 858 </em> 859 </td> 860 <td> 861 <p>Phase is a simple, high-level summary of where the ArgoCDExport is in its lifecycle. 862 There are five possible phase values: 863 Pending: The ArgoCDExport has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 864 Running: All of the containers for the ArgoCDExport are still running, or in the process of starting or restarting. 865 Succeeded: All containers for the ArgoCDExport have terminated in success, and will not be restarted. 866 Failed: At least one container has terminated in failure, either exited with non-zero status or was terminated by the system. 867 Unknown: For some reason the state of the ArgoCDExport could not be obtained. 868 </p> 869 </td> 870 </tr> 871 </tbody> 872 </table> 873 <h3 id="argoproj.io/v1alpha1.ArgoCDExportStorageSpec">ArgoCDExportStorageSpec</h3> 874 <p> 875 (<em>Appears on:</em> 876 <a href="#argoproj.io/v1alpha1.ArgoCDExportSpec">ArgoCDExportSpec</a>) 877 </p> 878 <p> 879 <p>ArgoCDExportStorageSpec defines the desired state for ArgoCDExport storage options.</p> 880 </p> 881 <table> 882 <thead> 883 <tr> 884 <th>Field</th> 885 <th>Description</th> 886 </tr> 887 </thead> 888 <tbody> 889 <tr> 890 <td> 891 <code>backend</code></br> 892 <em> 893 string 894 </em> 895 </td> 896 <td> 897 <p>Backend defines the storage backend to use, must be “local” (the default), “aws”, “azure” or “gcp”.</p> 898 </td> 899 </tr> 900 <tr> 901 <td> 902 <code>pvc</code></br> 903 <em> 904 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#persistentvolumeclaimspec-v1-core"> 905 Kubernetes core/v1.PersistentVolumeClaimSpec 906 </a> 907 </em> 908 </td> 909 <td> 910 <p>PVC is the desired characteristics for a PersistentVolumeClaim.</p> 911 </td> 912 </tr> 913 <tr> 914 <td> 915 <code>secretName</code></br> 916 <em> 917 string 918 </em> 919 </td> 920 <td> 921 <p>SecretName is the name of a Secret with encryption key, credentials, etc.</p> 922 </td> 923 </tr> 924 </tbody> 925 </table> 926 <table> 927 <thead> 928 <tr> 929 <th>Field</th> 930 <th>Description</th> 931 </tr> 932 </thead> 933 <tbody> 934 <tr> 935 <td> 936 <code>enabled</code></br> 937 <em> 938 bool 939 </em> 940 </td> 941 </tr> 942 <tr> 943 <td> 944 <code>host</code></br> 945 <em> 946 string 947 </em> 948 </td> 949 <td> 950 <p>Host is the hostname to use for Ingress/Route resources.</p> 951 </td> 952 </tr> 953 <tr> 954 <td> 955 <code>image</code></br> 956 <em> 957 string 958 </em> 959 </td> 960 </tr> 961 <tr> 962 <td> 963 <code>ingress</code></br> 964 <em> 965 <a href="#argoproj.io/v1alpha1.ArgoCDIngressSpec"> 966 ArgoCDIngressSpec 967 </a> 968 </em> 969 </td> 970 </tr> 971 <tr> 972 <td> 973 <code>resources</code></br> 974 <em> 975 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 976 Kubernetes core/v1.ResourceRequirements 977 </a> 978 </em> 979 </td> 980 </tr> 981 <tr> 982 <td> 983 <code>route</code></br> 984 <em> 985 <a href="#argoproj.io/v1alpha1.ArgoCDRouteSpec"> 986 ArgoCDRouteSpec 987 </a> 988 </em> 989 </td> 990 </tr> 991 <tr> 992 <td> 993 <code>size</code></br> 994 <em> 995 int32 996 </em> 997 </td> 998 </tr> 999 <tr> 1000 <td> 1001 <code>version</code></br> 1002 <em> 1003 string 1004 </em> 1005 </td> 1006 </tr> 1007 </tbody> 1008 </table> 1009 <h3 id="argoproj.io/v1alpha1.ArgoCDHASpec">ArgoCDHASpec</h3> 1010 <p> 1011 (<em>Appears on:</em> 1012 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1013 </p> 1014 <p> 1015 <p>ArgoCDHASpec defines the desired state for High Availability support for Argo CD.</p> 1016 </p> 1017 <table> 1018 <thead> 1019 <tr> 1020 <th>Field</th> 1021 <th>Description</th> 1022 </tr> 1023 </thead> 1024 <tbody> 1025 <tr> 1026 <td> 1027 <code>enabled</code></br> 1028 <em> 1029 bool 1030 </em> 1031 </td> 1032 <td> 1033 <p>Enabled will toggle HA support globally for Argo CD.</p> 1034 </td> 1035 </tr> 1036 <tr> 1037 <td> 1038 <code>redisProxyImage</code></br> 1039 <em> 1040 string 1041 </em> 1042 </td> 1043 <td> 1044 <p>The Redis HAProxy container image. This overrides the "ARGOCD_REDIS_HA_PROXY_IMAGE" environment variable.</p> 1045 </td> 1046 </tr> 1047 <tr> 1048 <td> 1049 <code>redisProxyVersion</code></br> 1050 <em> 1051 string 1052 </em> 1053 </td> 1054 <td> 1055 <p>The tag to use for the Redis HAProxy container image.</p> 1056 </td> 1057 </tr> 1058 <tr> 1059 <td> 1060 <code>resources</code></br> 1061 <em> 1062 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 1063 Kubernetes core/v1.ResourceRequirements 1064 </a> 1065 </em> 1066 </td> 1067 <td> 1068 <p>Resources defines the Compute Resources required by the container for Redis HA.</p> 1069 </td> 1070 </tr> 1071 </tbody> 1072 </table> 1073 <h3 id="argoproj.io/v1alpha1.ArgoCDImportSpec">ArgoCDImportSpec</h3> 1074 <p> 1075 (<em>Appears on:</em> 1076 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1077 </p> 1078 <p> 1079 <p>ArgoCDImportSpec defines the desired state for the ArgoCD import/restore process.</p> 1080 </p> 1081 <table> 1082 <thead> 1083 <tr> 1084 <th>Field</th> 1085 <th>Description</th> 1086 </tr> 1087 </thead> 1088 <tbody> 1089 <tr> 1090 <td> 1091 <code>name</code></br> 1092 <em> 1093 string 1094 </em> 1095 </td> 1096 <td> 1097 <p>Name of an ArgoCDExport from which to import data.</p> 1098 </td> 1099 </tr> 1100 <tr> 1101 <td> 1102 <code>namespace</code></br> 1103 <em> 1104 string 1105 </em> 1106 </td> 1107 <td> 1108 <p>Namespace for the ArgoCDExport, defaults to the same namespace as the ArgoCD.</p> 1109 </td> 1110 </tr> 1111 </tbody> 1112 </table> 1113 <h3 id="argoproj.io/v1alpha1.ArgoCDIngressSpec">ArgoCDIngressSpec</h3> 1114 <p> 1115 (<em>Appears on:</em> 1116 <a href="#argoproj.io/v1alpha1.ArgoCDPrometheusSpec">ArgoCDPrometheusSpec</a>, 1117 <a href="#argoproj.io/v1alpha1.ArgoCDServerGRPCSpec">ArgoCDServerGRPCSpec</a>, 1118 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</a>) 1119 </p> 1120 <p> 1121 <p>ArgoCDIngressSpec defines the desired state for the Ingress resources.</p> 1122 </p> 1123 <table> 1124 <thead> 1125 <tr> 1126 <th>Field</th> 1127 <th>Description</th> 1128 </tr> 1129 </thead> 1130 <tbody> 1131 <tr> 1132 <td> 1133 <code>annotations</code></br> 1134 <em> 1135 map[string]string 1136 </em> 1137 </td> 1138 <td> 1139 <p>Annotations is the map of annotations to apply to the Ingress.</p> 1140 </td> 1141 </tr> 1142 <tr> 1143 <td> 1144 <code>enabled</code></br> 1145 <em> 1146 bool 1147 </em> 1148 </td> 1149 <td> 1150 <p>Enabled will toggle the creation of the Ingress.</p> 1151 </td> 1152 </tr> 1153 <tr> 1154 <td> 1155 <code>path</code></br> 1156 <em> 1157 string 1158 </em> 1159 </td> 1160 <td> 1161 <p>Path used for the Ingress resource.</p> 1162 </td> 1163 </tr> 1164 <tr> 1165 <td> 1166 <code>tls</code></br> 1167 <em> 1168 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#ingresstls-v1-networking-k8s-io"> 1169 []Kubernetes networking.k8s.io/v1.IngressTLS 1170 </a> 1171 </em> 1172 </td> 1173 <td> 1174 <em>(Optional)</em> 1175 <p>TLS configuration. Currently the Ingress only supports a single TLS 1176 port, 443. If multiple members of this list specify different hosts, they 1177 will be multiplexed on the same port according to the hostname specified 1178 through the SNI TLS extension, if the ingress controller fulfilling the 1179 ingress supports SNI. 1180 </p> 1181 </td> 1182 </tr> 1183 </tbody> 1184 </table> 1185 <h3 id="argoproj.io/v1alpha1.ArgoCDNotificationsSpec">ArgoCDNotificationsSpec</h3> 1186 <p> 1187 (<em>Appears on:</em> 1188 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1189 </p> 1190 <p> 1191 <p>ArgoCDNotificationsSpec defines the desired state for the Notifications controller component.</p> 1192 </p> 1193 <table> 1194 <thead> 1195 <tr> 1196 <th>Field</th> 1197 <th>Description</th> 1198 </tr> 1199 </thead> 1200 <tbody> 1201 <tr> 1202 <td> 1203 <code>enabled</code></br> 1204 <em> 1205 bool 1206 </em> 1207 </td> 1208 <td> 1209 <p>Enabled is the toggle that determines whether notifications controller should be started or not. </p> 1210 </td> 1211 </tr> 1212 <tr> 1213 <td> 1214 <code>image</code></br> 1215 <em> 1216 string 1217 </em> 1218 </td> 1219 <td> 1220 <p>Image is the Argo CD container image.</p> 1221 </td> 1222 </tr> 1223 <tr> 1224 <td> 1225 <code>replicas</code></br> 1226 <em> 1227 int32 1228 </em> 1229 </td> 1230 <td> 1231 <p>Replicas determins the number of replicas for notifications controller.</p> 1232 </td> 1233 </tr> 1234 <tr> 1235 <td> 1236 <code>resources</code></br> 1237 <em> 1238 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 1239 Kubernetes core/v1.ResourceRequirements 1240 </a> 1241 </em> 1242 </td> 1243 <td> 1244 <p>Resources defines the Compute Resources required by the container for Notifications controller.</p> 1245 </td> 1246 </tr> 1247 <tr> 1248 <td> 1249 <code>version</code></br> 1250 <em> 1251 string 1252 </em> 1253 </td> 1254 <td> 1255 <p>Version is the Argo CD container image tag.</p> 1256 </td> 1257 </tr> 1258 </tbody> 1259 </table> 1260 <h3 id="argoproj.io/v1alpha1.ArgoCDPrometheusSpec">ArgoCDPrometheusSpec</h3><h3 id="argoproj.io/v1alpha1.ArgoCDPrometheusSpec">ArgoCDPrometheusSpec 1261 </h3> 1262 <h3 id="argoproj.io/v1alpha1.ArgoCDKeycloakSpec">ArgoCDKeycloakSpec</h3> 1263 <p> 1264 (<em>Appears on:</em> 1265 <a href="#argoproj.io/v1alpha1.ArgoCDSSOSpec">ArgoCDSSOSpec</a>) 1266 </p> 1267 <p> 1268 <p>ArgoCDKeycloakSpec Keycloak contains the configuration for Argo CD keycloak authentication (previously found under cr.spec.sso)</p> 1269 </p> 1270 <table> 1271 <thead> 1272 <tr> 1273 <th>Field</th> 1274 <th>Description</th> 1275 </tr> 1276 </thead> 1277 <tbody> 1278 <tr> 1279 <td> 1280 <code>image</code></br> 1281 <em> 1282 string 1283 </em> 1284 </td> 1285 <td> 1286 <p>Image is the Keycloak container image.</p> 1287 </td> 1288 </tr> 1289 <tr> 1290 <td> 1291 <code>resources</code></br> 1292 <em> 1293 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#resourcerequirements-v1-core"> 1294 Kubernetes core/v1.ResourceRequirements 1295 </em> 1296 </td> 1297 <td> 1298 <p> Resources defines the Compute Resources required by the container for Keycloak.</p> 1299 </td> 1300 </tr> 1301 <tr> 1302 <td> 1303 <code>version</code></br> 1304 <em> 1305 string 1306 </em> 1307 </td> 1308 <td> 1309 <p>Version is the Keycloak container image tag.</p> 1310 </td> 1311 </tr> 1312 <tr> 1313 <td> 1314 <code>verifyTLS</code></br> 1315 <em> 1316 bool 1317 </em> 1318 </td> 1319 <td> 1320 <p>VerifyTLS set to false disables strict TLS validation.</p> 1321 </td> 1322 </tr> 1323 </tbody> 1324 </table> 1325 <h3 id="argoproj.io/v1alpha1.ArgoCDPrometheusSpec">ArgoCDPrometheusSpec</h3> 1326 <p> 1327 (<em>Appears on:</em> 1328 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1329 </p> 1330 <p> 1331 <p>ArgoCDPrometheusSpec defines the desired state for the Prometheus component.</p> 1332 </p> 1333 <table> 1334 <thead> 1335 <tr> 1336 <th>Field</th> 1337 <th>Description</th> 1338 </tr> 1339 </thead> 1340 <tbody> 1341 <tr> 1342 <td> 1343 <code>enabled</code></br> 1344 <em> 1345 bool 1346 </em> 1347 </td> 1348 <td> 1349 <p>Enabled will toggle Prometheus support globally for ArgoCD.</p> 1350 </td> 1351 </tr> 1352 <tr> 1353 <td> 1354 <code>host</code></br> 1355 <em> 1356 string 1357 </em> 1358 </td> 1359 <td> 1360 <p>Host is the hostname to use for Ingress/Route resources.</p> 1361 </td> 1362 </tr> 1363 <tr> 1364 <td> 1365 <code>ingress</code></br> 1366 <em> 1367 <a href="#argoproj.io/v1alpha1.ArgoCDIngressSpec"> 1368 ArgoCDIngressSpec 1369 </a> 1370 </em> 1371 </td> 1372 <td> 1373 <p>Ingress defines the desired state for an Ingress for the Prometheus component.</p> 1374 </td> 1375 </tr> 1376 <tr> 1377 <td> 1378 <code>route</code></br> 1379 <em> 1380 <a href="#argoproj.io/v1alpha1.ArgoCDRouteSpec"> 1381 ArgoCDRouteSpec 1382 </a> 1383 </em> 1384 </td> 1385 <td> 1386 <p>Route defines the desired state for an OpenShift Route for the Prometheus component.</p> 1387 </td> 1388 </tr> 1389 <tr> 1390 <td> 1391 <code>size</code></br> 1392 <em> 1393 int32 1394 </em> 1395 </td> 1396 <td> 1397 <p>Size is the replica count for the Prometheus StatefulSet.</p> 1398 </td> 1399 </tr> 1400 </tbody> 1401 </table> 1402 <h3 id="argoproj.io/v1alpha1.ArgoCDRBACSpec">ArgoCDRBACSpec</h3> 1403 <p> 1404 (<em>Appears on:</em> 1405 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1406 </p> 1407 <p> 1408 <p>ArgoCDRBACSpec defines the desired state for the Argo CD RBAC configuration.</p> 1409 </p> 1410 <table> 1411 <thead> 1412 <tr> 1413 <th>Field</th> 1414 <th>Description</th> 1415 </tr> 1416 </thead> 1417 <tbody> 1418 <tr> 1419 <td> 1420 <code>defaultPolicy</code></br> 1421 <em> 1422 string 1423 </em> 1424 </td> 1425 <td> 1426 <p>DefaultPolicy is the name of the default role which Argo CD will falls back to, when 1427 authorizing API requests (optional). If omitted or empty, users may be still be able to login, 1428 but will see no apps, projects, etc… 1429 </p> 1430 </td> 1431 </tr> 1432 <tr> 1433 <td> 1434 <code>policy</code></br> 1435 <em> 1436 string 1437 </em> 1438 </td> 1439 <td> 1440 <p>Policy is CSV containing user-defined RBAC policies and role definitions. 1441 Policy rules are in the form: 1442 p, subject, resource, action, object, effect 1443 Role definitions and bindings are in the form: 1444 g, subject, inherited-subject 1445 See <a href="https://github.com/argoproj/argo-cd/blob/master/docs/operator-manual/rbac.md">https://github.com/argoproj/argo-cd/blob/master/docs/operator-manual/rbac.md</a> for additional information. 1446 </p> 1447 </td> 1448 </tr> 1449 <tr> 1450 <td> 1451 <code>scopes</code></br> 1452 <em> 1453 string 1454 </em> 1455 </td> 1456 <td> 1457 <p>Scopes controls which OIDC scopes to examine during rbac enforcement (in addition to <code>sub</code> scope). 1458 If omitted, defaults to: ‘[groups]’. 1459 </p> 1460 </td> 1461 </tr> 1462 </tbody> 1463 </table> 1464 <h3 id="argoproj.io/v1alpha1.ArgoCDRedisSpec">ArgoCDRedisSpec</h3> 1465 <p> 1466 (<em>Appears on:</em> 1467 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1468 </p> 1469 <p> 1470 <p>ArgoCDRedisSpec defines the desired state for the Redis server component.</p> 1471 </p> 1472 <table> 1473 <thead> 1474 <tr> 1475 <th>Field</th> 1476 <th>Description</th> 1477 </tr> 1478 </thead> 1479 <tbody> 1480 <tr> 1481 <td> 1482 <code>image</code></br> 1483 <em> 1484 string 1485 </em> 1486 </td> 1487 <td> 1488 <p>Image is the Redis container image.</p> 1489 </td> 1490 </tr> 1491 <tr> 1492 <td> 1493 <code>resources</code></br> 1494 <em> 1495 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 1496 Kubernetes core/v1.ResourceRequirements 1497 </a> 1498 </em> 1499 </td> 1500 <td> 1501 <p>Resources defines the Compute Resources required by the container for Redis.</p> 1502 </td> 1503 </tr> 1504 <tr> 1505 <td> 1506 <code>version</code></br> 1507 <em> 1508 string 1509 </em> 1510 </td> 1511 <td> 1512 <p>Version is the Redis container image tag.</p> 1513 </td> 1514 </tr> 1515 </tbody> 1516 </table> 1517 <h3 id="argoproj.io/v1alpha1.ArgoCDRepoSpec">ArgoCDRepoSpec</h3> 1518 <p> 1519 (<em>Appears on:</em> 1520 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1521 </p> 1522 <p> 1523 <p>ArgoCDRepoSpec defines the desired state for the Argo CD repo server component.</p> 1524 </p> 1525 <table> 1526 <thead> 1527 <tr> 1528 <th>Field</th> 1529 <th>Description</th> 1530 </tr> 1531 </thead> 1532 <tbody> 1533 <tr> 1534 <td> 1535 <code>mountsatoken</code></br> 1536 <em> 1537 bool 1538 </em> 1539 </td> 1540 <td> 1541 <p>MountSAToken describes whether you would like to have the Repo server mount the service account token</p> 1542 </td> 1543 </tr> 1544 <tr> 1545 <td> 1546 <code>resources</code></br> 1547 <em> 1548 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 1549 Kubernetes core/v1.ResourceRequirements 1550 </a> 1551 </em> 1552 </td> 1553 <td> 1554 <p>Resources defines the Compute Resources required by the container for Redis.</p> 1555 </td> 1556 </tr> 1557 <tr> 1558 <td> 1559 <code>serviceaccount</code></br> 1560 <em> 1561 string 1562 </em> 1563 </td> 1564 <td> 1565 <p>ServiceAccount defines the ServiceAccount user that you would like the Repo server to use</p> 1566 </td> 1567 </tr> 1568 </tbody> 1569 </table> 1570 <h3 id="argoproj.io/v1alpha1.ArgoCDRouteSpec">ArgoCDRouteSpec</h3> 1571 <p> 1572 (<em>Appears on:</em> 1573 <a href="#argoproj.io/v1alpha1.ArgoCDPrometheusSpec">ArgoCDPrometheusSpec</a>, 1574 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</a>) 1575 </p> 1576 <p> 1577 <p>ArgoCDRouteSpec defines the desired state for an OpenShift Route.</p> 1578 </p> 1579 <table> 1580 <thead> 1581 <tr> 1582 <th>Field</th> 1583 <th>Description</th> 1584 </tr> 1585 </thead> 1586 <tbody> 1587 <tr> 1588 <td> 1589 <code>annotations</code></br> 1590 <em> 1591 map[string]string 1592 </em> 1593 </td> 1594 <td> 1595 <p>Annotations is the map of annotations to use for the Route resource.</p> 1596 </td> 1597 </tr> 1598 <tr> 1599 <td> 1600 <code>enabled</code></br> 1601 <em> 1602 bool 1603 </em> 1604 </td> 1605 <td> 1606 <p>Enabled will toggle the creation of the OpenShift Route.</p> 1607 </td> 1608 </tr> 1609 <tr> 1610 <td> 1611 <code>path</code></br> 1612 <em> 1613 string 1614 </em> 1615 </td> 1616 <td> 1617 <p>Path the router watches for, to route traffic for to the service.</p> 1618 </td> 1619 </tr> 1620 <tr> 1621 <td> 1622 <code>tls</code></br> 1623 <em> 1624 github.com/openshift/api/route/v1.TLSConfig 1625 </em> 1626 </td> 1627 <td> 1628 <p>TLS provides the ability to configure certificates and termination for the Route.</p> 1629 </td> 1630 </tr> 1631 <tr> 1632 <td> 1633 <code>wildcardPolicy</code></br> 1634 <em> 1635 github.com/openshift/api/route/v1.WildcardPolicyType 1636 </em> 1637 </td> 1638 <td> 1639 <p>WildcardPolicy if any for the route. Currently only ‘Subdomain’ or ‘None’ is allowed.</p> 1640 </td> 1641 </tr> 1642 </tbody> 1643 </table> 1644 <h3 id="argoproj.io/v1alpha1.ArgoCDServerAutoscaleSpec">ArgoCDServerAutoscaleSpec</h3> 1645 <p> 1646 (<em>Appears on:</em> 1647 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</a>) 1648 </p> 1649 <p> 1650 <p>ArgoCDServerAutoscaleSpec defines the desired state for autoscaling the Argo CD Server component.</p> 1651 </p> 1652 <table> 1653 <thead> 1654 <tr> 1655 <th>Field</th> 1656 <th>Description</th> 1657 </tr> 1658 </thead> 1659 <tbody> 1660 <tr> 1661 <td> 1662 <code>enabled</code></br> 1663 <em> 1664 bool 1665 </em> 1666 </td> 1667 <td> 1668 <p>Enabled will toggle autoscaling support for the Argo CD Server component.</p> 1669 </td> 1670 </tr> 1671 <tr> 1672 <td> 1673 <code>hpa</code></br> 1674 <em> 1675 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#horizontalpodautoscalerspec-v1-autoscaling"> 1676 Kubernetes autoscaling/v1.HorizontalPodAutoscalerSpec 1677 </a> 1678 </em> 1679 </td> 1680 <td> 1681 <p>HPA defines the HorizontalPodAutoscaler options for the Argo CD Server component.</p> 1682 </td> 1683 </tr> 1684 </tbody> 1685 </table> 1686 <h3 id="argoproj.io/v1alpha1.ArgoCDServerGRPCSpec">ArgoCDServerGRPCSpec</h3> 1687 <p> 1688 (<em>Appears on:</em> 1689 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</a>) 1690 </p> 1691 <p> 1692 <p>ArgoCDServerGRPCSpec defines the desired state for the Argo CD Server GRPC options.</p> 1693 </p> 1694 <table> 1695 <thead> 1696 <tr> 1697 <th>Field</th> 1698 <th>Description</th> 1699 </tr> 1700 </thead> 1701 <tbody> 1702 <tr> 1703 <td> 1704 <code>host</code></br> 1705 <em> 1706 string 1707 </em> 1708 </td> 1709 <td> 1710 <p>Host is the hostname to use for Ingress/Route resources.</p> 1711 </td> 1712 </tr> 1713 <tr> 1714 <td> 1715 <code>ingress</code></br> 1716 <em> 1717 <a href="#argoproj.io/v1alpha1.ArgoCDIngressSpec"> 1718 ArgoCDIngressSpec 1719 </a> 1720 </em> 1721 </td> 1722 <td> 1723 <p>Ingress defines the desired state for the Argo CD Server GRPC Ingress.</p> 1724 </td> 1725 </tr> 1726 </tbody> 1727 </table> 1728 <h3 id="argoproj.io/v1alpha1.ArgoCDServerServiceSpec">ArgoCDServerServiceSpec</h3> 1729 <p> 1730 (<em>Appears on:</em> 1731 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</a>) 1732 </p> 1733 <p> 1734 <p>ArgoCDServerServiceSpec defines the Service options for Argo CD Server component.</p> 1735 </p> 1736 <table> 1737 <thead> 1738 <tr> 1739 <th>Field</th> 1740 <th>Description</th> 1741 </tr> 1742 </thead> 1743 <tbody> 1744 <tr> 1745 <td> 1746 <code>type</code></br> 1747 <em> 1748 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#servicetype-v1-core"> 1749 Kubernetes core/v1.ServiceType 1750 </a> 1751 </em> 1752 </td> 1753 <td> 1754 <p>Type is the ServiceType to use for the Service resource.</p> 1755 </td> 1756 </tr> 1757 </tbody> 1758 </table> 1759 <h3 id="argoproj.io/v1alpha1.ArgoCDServerSpec">ArgoCDServerSpec</h3> 1760 <p> 1761 (<em>Appears on:</em> 1762 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 1763 </p> 1764 <p> 1765 <p>ArgoCDServerSpec defines the options for the ArgoCD Server component.</p> 1766 </p> 1767 <table> 1768 <thead> 1769 <tr> 1770 <th>Field</th> 1771 <th>Description</th> 1772 </tr> 1773 </thead> 1774 <tbody> 1775 <tr> 1776 <td> 1777 <code>autoscale</code></br> 1778 <em> 1779 <a href="#argoproj.io/v1alpha1.ArgoCDServerAutoscaleSpec"> 1780 ArgoCDServerAutoscaleSpec 1781 </a> 1782 </em> 1783 </td> 1784 <td> 1785 <p>Autoscale defines the autoscale options for the Argo CD Server component.</p> 1786 </td> 1787 </tr> 1788 <tr> 1789 <td> 1790 <code>grpc</code></br> 1791 <em> 1792 <a href="#argoproj.io/v1alpha1.ArgoCDServerGRPCSpec"> 1793 ArgoCDServerGRPCSpec 1794 </a> 1795 </em> 1796 </td> 1797 <td> 1798 <p>GRPC defines the state for the Argo CD Server GRPC options.</p> 1799 </td> 1800 </tr> 1801 <tr> 1802 <td> 1803 <code>host</code></br> 1804 <em> 1805 string 1806 </em> 1807 </td> 1808 <td> 1809 <p>Host is the hostname to use for Ingress/Route resources.</p> 1810 </td> 1811 </tr> 1812 <tr> 1813 <td> 1814 <code>ingress</code></br> 1815 <em> 1816 <a href="#argoproj.io/v1alpha1.ArgoCDIngressSpec"> 1817 ArgoCDIngressSpec 1818 </a> 1819 </em> 1820 </td> 1821 <td> 1822 <p>Ingress defines the desired state for an Ingress for the Argo CD Server component.</p> 1823 </td> 1824 </tr> 1825 <tr> 1826 <td> 1827 <code>insecure</code></br> 1828 <em> 1829 bool 1830 </em> 1831 </td> 1832 <td> 1833 <p>Insecure toggles the insecure flag.</p> 1834 </td> 1835 </tr> 1836 <tr> 1837 <td> 1838 <code>resources</code></br> 1839 <em> 1840 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#resourcerequirements-v1-core"> 1841 Kubernetes core/v1.ResourceRequirements 1842 </a> 1843 </em> 1844 </td> 1845 <td> 1846 <p>Resources defines the Compute Resources required by the container for the Argo CD server component.</p> 1847 </td> 1848 </tr> 1849 <tr> 1850 <td> 1851 <code>route</code></br> 1852 <em> 1853 <a href="#argoproj.io/v1alpha1.ArgoCDRouteSpec"> 1854 ArgoCDRouteSpec 1855 </a> 1856 </em> 1857 </td> 1858 <td> 1859 <p>Route defines the desired state for an OpenShift Route for the Argo CD Server component.</p> 1860 </td> 1861 </tr> 1862 <tr> 1863 <td> 1864 <code>service</code></br> 1865 <em> 1866 <a href="#argoproj.io/v1alpha1.ArgoCDServerServiceSpec"> 1867 ArgoCDServerServiceSpec 1868 </a> 1869 </em> 1870 </td> 1871 <td> 1872 <p>Service defines the options for the Service backing the ArgoCD Server component.</p> 1873 </td> 1874 </tr> 1875 </tbody> 1876 </table> 1877 <h3 id="argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</h3> 1878 <p> 1879 (<em>Appears on:</em> 1880 <a href="#argoproj.io/v1alpha1.ArgoCD">ArgoCD</a>) 1881 </p> 1882 <p> 1883 <p>ArgoCDSpec defines the desired state of ArgoCD</p> 1884 </p> 1885 <table> 1886 <thead> 1887 <tr> 1888 <th>Field</th> 1889 <th>Description</th> 1890 </tr> 1891 </thead> 1892 <tbody> 1893 <tr> 1894 <td> 1895 <code>applicationInstanceLabelKey</code></br> 1896 <em> 1897 string 1898 </em> 1899 </td> 1900 <td> 1901 <p>ApplicationInstanceLabelKey is the key name where Argo CD injects the app name as a tracking label.</p> 1902 </td> 1903 </tr> 1904 <tr> 1905 <td> 1906 <code>configManagementPlugins</code></br> 1907 <em> 1908 string 1909 </em> 1910 </td> 1911 <td> 1912 <p>ConfigManagementPlugins is used to specify additional config management plugins.</p> 1913 </td> 1914 </tr> 1915 <tr> 1916 <td> 1917 <code>controller</code></br> 1918 <em> 1919 <a href="#argoproj.io/v1alpha1.ArgoCDApplicationControllerSpec"> 1920 ArgoCDApplicationControllerSpec 1921 </a> 1922 </em> 1923 </td> 1924 <td> 1925 <p>Controller defines the Application Controller options for ArgoCD.</p> 1926 </td> 1927 </tr> 1928 <tr> 1929 <td> 1930 <code>gaTrackingID</code></br> 1931 <em> 1932 string 1933 </em> 1934 </td> 1935 <td> 1936 <p>GATrackingID is the google analytics tracking ID to use.</p> 1937 </td> 1938 </tr> 1939 <tr> 1940 <td> 1941 <code>gaAnonymizeUsers</code></br> 1942 <em> 1943 bool 1944 </em> 1945 </td> 1946 <td> 1947 <p>GAAnonymizeUsers toggles user IDs being hashed before sending to google analytics.</p> 1948 </td> 1949 </tr> 1950 <tr> 1951 <td> 1952 <code>ha</code></br> 1953 <em> 1954 <a href="#argoproj.io/v1alpha1.ArgoCDHASpec"> 1955 ArgoCDHASpec 1956 </a> 1957 </em> 1958 </td> 1959 <td> 1960 <p>HA options for High Availability support for the Redis component.</p> 1961 </td> 1962 </tr> 1963 <tr> 1964 <td> 1965 <code>helpChatURL</code></br> 1966 <em> 1967 string 1968 </em> 1969 </td> 1970 <td> 1971 <p>HelpChatURL is the URL for getting chat help, this will typically be your Slack channel for support.</p> 1972 </td> 1973 </tr> 1974 <tr> 1975 <td> 1976 <code>helpChatText</code></br> 1977 <em> 1978 string 1979 </em> 1980 </td> 1981 <td> 1982 <p>HelpChatText is the text for getting chat help, defaults to “Chat now!”</p> 1983 </td> 1984 </tr> 1985 <tr> 1986 <td> 1987 <code>image</code></br> 1988 <em> 1989 string 1990 </em> 1991 </td> 1992 <td> 1993 <p>Image is the ArgoCD container image for all ArgoCD components.</p> 1994 </td> 1995 </tr> 1996 <tr> 1997 <td> 1998 <code>import</code></br> 1999 <em> 2000 <a href="#argoproj.io/v1alpha1.ArgoCDImportSpec"> 2001 ArgoCDImportSpec 2002 </a> 2003 </em> 2004 </td> 2005 <td> 2006 <p>Import is the import/restore options for ArgoCD.</p> 2007 </td> 2008 </tr> 2009 <tr> 2010 <td> 2011 <code>initialRepositories</code></br> 2012 <em> 2013 string 2014 </em> 2015 </td> 2016 <td> 2017 <p>InitialRepositories to configure Argo CD with upon creation of the cluster.</p> 2018 </td> 2019 </tr> 2020 <tr> 2021 <td> 2022 <code>initialSSHKnownHosts</code></br> 2023 <em> 2024 string 2025 </em> 2026 </td> 2027 <td> 2028 <p>InitialSSHKnownHosts defines the SSH known hosts data upon creation of the cluster for connecting Git repositories via SSH.</p> 2029 </td> 2030 </tr> 2031 <tr> 2032 <td> 2033 <code>kustomizeBuildOptions</code></br> 2034 <em> 2035 string 2036 </em> 2037 </td> 2038 <td> 2039 <p>KustomizeBuildOptions is used to specify build options/parameters to use with <code>kustomize build</code>.</p> 2040 </td> 2041 </tr> 2042 <tr> 2043 <td> 2044 <code>oidcConfig</code></br> 2045 <em> 2046 string 2047 </em> 2048 </td> 2049 <td> 2050 <p>OIDCConfig is the OIDC configuration as an alternative to dex.</p> 2051 </td> 2052 </tr> 2053 <tr> 2054 <td> 2055 <code>prometheus</code></br> 2056 <em> 2057 <a href="#argoproj.io/v1alpha1.ArgoCDPrometheusSpec"> 2058 ArgoCDPrometheusSpec 2059 </a> 2060 </em> 2061 </td> 2062 <td> 2063 <p>Prometheus defines the Prometheus server options for ArgoCD.</p> 2064 </td> 2065 </tr> 2066 <tr> 2067 <td> 2068 <code>rbac</code></br> 2069 <em> 2070 <a href="#argoproj.io/v1alpha1.ArgoCDRBACSpec"> 2071 ArgoCDRBACSpec 2072 </a> 2073 </em> 2074 </td> 2075 <td> 2076 <p>RBAC defines the RBAC configuration for Argo CD.</p> 2077 </td> 2078 </tr> 2079 <tr> 2080 <td> 2081 <code>redis</code></br> 2082 <em> 2083 <a href="#argoproj.io/v1alpha1.ArgoCDRedisSpec"> 2084 ArgoCDRedisSpec 2085 </a> 2086 </em> 2087 </td> 2088 <td> 2089 <p>Redis defines the Redis server options for ArgoCD.</p> 2090 </td> 2091 </tr> 2092 <tr> 2093 <td> 2094 <code>repo</code></br> 2095 <em> 2096 <a href="#argoproj.io/v1alpha1.ArgoCDRepoSpec"> 2097 ArgoCDRepoSpec 2098 </a> 2099 </em> 2100 </td> 2101 <td> 2102 <p>Repo defines the repo server options for Argo CD.</p> 2103 </td> 2104 </tr> 2105 <tr> 2106 <td> 2107 <code>repositoryCredentials</code></br> 2108 <em> 2109 string 2110 </em> 2111 </td> 2112 <td> 2113 <p>RepositoryCredentials are the Git pull credentials to configure Argo CD with upon creation of the cluster.</p> 2114 </td> 2115 </tr> 2116 <tr> 2117 <td> 2118 <code>resourceCustomizations</code></br> 2119 <em> 2120 string 2121 </em> 2122 </td> 2123 <td> 2124 <p>ResourceCustomizations customizes resource behavior. Keys are in the form: group/Kind.</p> 2125 </td> 2126 </tr> 2127 <tr> 2128 <td> 2129 <code>resourceExclusions</code></br> 2130 <em> 2131 string 2132 </em> 2133 </td> 2134 <td> 2135 <p>ResourceExclusions is used to completely ignore entire classes of resource group/kinds.</p> 2136 </td> 2137 </tr> 2138 <tr> 2139 <td> 2140 <code>server</code></br> 2141 <em> 2142 <a href="#argoproj.io/v1alpha1.ArgoCDServerSpec"> 2143 ArgoCDServerSpec 2144 </a> 2145 </em> 2146 </td> 2147 <td> 2148 <p>Server defines the options for the ArgoCD Server component.</p> 2149 </td> 2150 </tr> 2151 <tr> 2152 <td> 2153 <code>sso</code></br> 2154 <em> 2155 <a href="#argoproj.io/v1alpha1.ArgoCDSSOSpec"> 2156 ArgoCDSSOSpec 2157 </a> 2158 </em> 2159 </td> 2160 <td> 2161 <p>SSO defines the Single Sign-on configuration for Argo CD.</p> 2162 </td> 2163 </tr> 2164 <tr> 2165 <td> 2166 <code>statusBadgeEnabled</code></br> 2167 <em> 2168 bool 2169 </em> 2170 </td> 2171 <td> 2172 <p>StatusBadgeEnabled toggles application status badge feature.</p> 2173 </td> 2174 </tr> 2175 <tr> 2176 <td> 2177 <code>tls</code></br> 2178 <em> 2179 <a href="#argoproj.io/v1alpha1.ArgoCDTLSSpec"> 2180 ArgoCDTLSSpec 2181 </a> 2182 </em> 2183 </td> 2184 <td> 2185 <p>TLS defines the TLS options for ArgoCD.</p> 2186 </td> 2187 </tr> 2188 <tr> 2189 <td> 2190 <code>usersAnonymousEnabled</code></br> 2191 <em> 2192 bool 2193 </em> 2194 </td> 2195 <td> 2196 <p>UsersAnonymousEnabled toggles anonymous user access. 2197 The anonymous users get default role permissions specified argocd-rbac-cm. 2198 </p> 2199 </td> 2200 </tr> 2201 <tr> 2202 <td> 2203 <code>version</code></br> 2204 <em> 2205 string 2206 </em> 2207 </td> 2208 <td> 2209 <p>Version is the tag to use with the ArgoCD container image for all ArgoCD components.</p> 2210 </td> 2211 </tr> 2212 </tbody> 2213 </table> 2214 <h3 id="argoproj.io/v1alpha1.ArgoCDSSOSpec">ArgoCDSSOSpec</h3> 2215 <p> 2216 (<em>Appears on:</em> 2217 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 2218 </p> 2219 <p> 2220 <p>ArgoCDSSOSpec defines the Single Sign-on configuration for Argo CD.</p> 2221 </p> 2222 <table> 2223 <thead> 2224 <tr> 2225 <th>Field</th> 2226 <th>Description</th> 2227 </tr> 2228 </thead> 2229 <tbody> 2230 <tr> 2231 <td> 2232 <code>dex</code></br> 2233 <em> 2234 <a href="#argoproj.io/v1alpha1.ArgoCDDexSpec"> 2235 ArgoCDDexSpec 2236 </em> 2237 </td> 2238 <td> 2239 <p>Dex contains the configuration for Argo CD dex authentication (previously found under cr.spec.dex)</p> 2240 </td> 2241 </tr> 2242 <tr> 2243 <td> 2244 <code>keycloak</code></br> 2245 <em> 2246 <a href="#argoproj.io/v1alpha1.ArgoCDKeycloakSpec"> 2247 ArgoCDKeycloakSpec 2248 </em> 2249 </td> 2250 <td> 2251 <p>Keycloak contains the configuration for Argo CD keycloak authentication (previously found under cr.spec.sso)</p> 2252 </td> 2253 </tr> 2254 <tr> 2255 <td> 2256 <code>provider</code></br> 2257 <em> 2258 SSOProviderType 2259 </em> 2260 </td> 2261 <td> 2262 <p>Provider installs and configures the given SSO Provider with Argo CD. 2263 </td> 2264 </tr> 2265 </tbody> 2266 </table> 2267 <h3 id="argoproj.io/v1alpha1.ArgoCDStatus">ArgoCDStatus</h3> 2268 <p> 2269 (<em>Appears on:</em> 2270 <a href="#argoproj.io/v1alpha1.ArgoCD">ArgoCD</a>) 2271 </p> 2272 <p> 2273 <p>ArgoCDStatus defines the observed state of ArgoCD</p> 2274 </p> 2275 <table> 2276 <thead> 2277 <tr> 2278 <th>Field</th> 2279 <th>Description</th> 2280 </tr> 2281 </thead> 2282 <tbody> 2283 <tr> 2284 <td> 2285 <code>applicationController</code></br> 2286 <em> 2287 string 2288 </em> 2289 </td> 2290 <td> 2291 <p>ApplicationController is a simple, high-level summary of where the Argo CD application controller component is in its lifecycle. 2292 There are five possible ApplicationController values: 2293 Pending: The Argo CD application controller component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2294 Running: All of the required Pods for the Argo CD application controller component are in a Ready state. 2295 Failed: At least one of the Argo CD application controller component Pods had a failure. 2296 Unknown: For some reason the state of the Argo CD application controller component could not be obtained. 2297 </p> 2298 </td> 2299 </tr> 2300 <tr> 2301 <td> 2302 <code>notifications</code></br> 2303 <em> 2304 string 2305 </em> 2306 </td> 2307 <td> 2308 <p>Notifications is a simple, high-level summary of where the Argo CD Notifications controller component is in its lifecycle. 2309 There are four possible notifications values: 2310 Pending: The Argo CD Notifications controller component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2311 Running: All of the required Pods for the Argo CD Notifications controller component are in a Ready state. 2312 Failed: At least one of the Argo CD Notifications controller component Pods had a failure. 2313 Unknown: For some reason the state of the Argo CD Notifications controller component could not be obtained. 2314 </p> 2315 </td> 2316 </tr> 2317 <tr> 2318 <td> 2319 <code>phase</code></br> 2320 <em> 2321 string 2322 </em> 2323 </td> 2324 <td> 2325 <p>Phase is a simple, high-level summary of where the ArgoCD is in its lifecycle. 2326 There are five possible phase values: 2327 Pending: The ArgoCD has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2328 Available: All of the resources for the ArgoCD are ready. 2329 Failed: At least one resource has experienced a failure. 2330 Unknown: For some reason the state of the ArgoCD phase could not be obtained. 2331 </p> 2332 </td> 2333 </tr> 2334 <tr> 2335 <td> 2336 <code>redis</code></br> 2337 <em> 2338 string 2339 </em> 2340 </td> 2341 <td> 2342 <p>Redis is a simple, high-level summary of where the Argo CD Redis component is in its lifecycle. 2343 There are five possible redis values: 2344 Pending: The Argo CD Redis component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2345 Running: All of the required Pods for the Argo CD Redis component are in a Ready state. 2346 Failed: At least one of the Argo CD Redis component Pods had a failure. 2347 Unknown: For some reason the state of the Argo CD Redis component could not be obtained. 2348 </p> 2349 </td> 2350 </tr> 2351 <tr> 2352 <td> 2353 <code>repo</code></br> 2354 <em> 2355 string 2356 </em> 2357 </td> 2358 <td> 2359 <p>Repo is a simple, high-level summary of where the Argo CD Repo component is in its lifecycle. 2360 There are five possible repo values: 2361 Pending: The Argo CD Repo component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2362 Running: All of the required Pods for the Argo CD Repo component are in a Ready state. 2363 Failed: At least one of the Argo CD Repo component Pods had a failure. 2364 Unknown: For some reason the state of the Argo CD Repo component could not be obtained. 2365 </p> 2366 </td> 2367 </tr> 2368 <tr> 2369 <td> 2370 <code>server</code></br> 2371 <em> 2372 string 2373 </em> 2374 </td> 2375 <td> 2376 <p>Server is a simple, high-level summary of where the Argo CD server component is in its lifecycle. 2377 There are five possible server values: 2378 Pending: The Argo CD server component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2379 Running: All of the required Pods for the Argo CD server component are in a Ready state. 2380 Failed: At least one of the Argo CD server component Pods had a failure. 2381 Unknown: For some reason the state of the Argo CD server component could not be obtained. 2382 </p> 2383 </td> 2384 </tr> 2385 <tr> 2386 <td> 2387 <code>sso</code></br> 2388 <em> 2389 string 2390 </em> 2391 </td> 2392 <td> 2393 <p>SSO is a simple, high-level summary of where the Argo CD SSO(Dex/Keycloak) component is in its lifecycle. 2394 There are four possible server values: 2395 Pending: The Argo CD SSO component has been accepted by the Kubernetes system, but one or more of the required resources have not been created. 2396 Running: All of the required Pods for the Argo CD SSO component are in a Ready state. 2397 Failed: At least one of the Argo CD SSO component Pods had a failure. 2398 Unknown: The state of the Argo CD SSO component could not be obtained. 2399 </p> 2400 </td> 2401 </tr> 2402 <tr> 2403 <td> 2404 <code>host</code></br> 2405 <em> 2406 string 2407 </em> 2408 </td> 2409 <td> 2410 <p>Host is the url for the hostname to use for Ingress/Route resources</p> 2411 </td> 2412 </tr> 2413 </tbody> 2414 </table> 2415 <h3 id="argoproj.io/v1alpha1.ArgoCDTLSSpec">ArgoCDTLSSpec</h3> 2416 <p> 2417 (<em>Appears on:</em> 2418 <a href="#argoproj.io/v1alpha1.ArgoCDSpec">ArgoCDSpec</a>) 2419 </p> 2420 <p> 2421 <p>ArgoCDTLSSpec defines the TLS options for ArgCD.</p> 2422 </p> 2423 <table> 2424 <thead> 2425 <tr> 2426 <th>Field</th> 2427 <th>Description</th> 2428 </tr> 2429 </thead> 2430 <tbody> 2431 <tr> 2432 <td> 2433 <code>ca</code></br> 2434 <em> 2435 <a href="#argoproj.io/v1alpha1.ArgoCDCASpec"> 2436 ArgoCDCASpec 2437 </a> 2438 </em> 2439 </td> 2440 <td> 2441 <p>CA defines the CA options.</p> 2442 </td> 2443 </tr> 2444 <tr> 2445 <td> 2446 <code>initialCerts</code></br> 2447 <em> 2448 map[string]string 2449 </em> 2450 </td> 2451 <td> 2452 <p>InitialCerts defines custom TLS certificates upon creation of the cluster for connecting Git repositories via HTTPS.</p> 2453 </td> 2454 </tr> 2455 </tbody> 2456 </table> 2457 <hr/> 2458 <p><em> 2459 Generated with <code>gen-crd-api-reference-docs</code> 2460 on git commit <code>c13da2a</code>. 2461 </em> 2462 </p> 2463 <h2 id="argoproj.io/v1alpha1">argoproj.io/v1alpha1</h2> 2464 <p>