github.com/argoproj/argo-events@v1.9.1/api/event-bus.html (about) 1 <p>Packages:</p> 2 <ul> 3 <li> 4 <a href="#argoproj.io%2fv1alpha1">argoproj.io/v1alpha1</a> 5 </li> 6 </ul> 7 <h2 id="argoproj.io/v1alpha1">argoproj.io/v1alpha1</h2> 8 <p> 9 <p>Package v1alpha1 is the v1alpha1 version of the API.</p> 10 </p> 11 Resource Types: 12 <ul></ul> 13 <h3 id="argoproj.io/v1alpha1.AuthStrategy">AuthStrategy 14 (<code>string</code> alias)</p></h3> 15 <p> 16 (<em>Appears on:</em> 17 <a href="#argoproj.io/v1alpha1.NATSConfig">NATSConfig</a>, 18 <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>) 19 </p> 20 <p> 21 <p>AuthStrategy is the auth strategy of native nats installaion</p> 22 </p> 23 <h3 id="argoproj.io/v1alpha1.BusConfig">BusConfig 24 </h3> 25 <p> 26 (<em>Appears on:</em> 27 <a href="#argoproj.io/v1alpha1.EventBusStatus">EventBusStatus</a>) 28 </p> 29 <p> 30 <p>BusConfig has the finalized configuration for EventBus</p> 31 </p> 32 <table> 33 <thead> 34 <tr> 35 <th>Field</th> 36 <th>Description</th> 37 </tr> 38 </thead> 39 <tbody> 40 <tr> 41 <td> 42 <code>nats</code></br> 43 <em> 44 <a href="#argoproj.io/v1alpha1.NATSConfig"> 45 NATSConfig 46 </a> 47 </em> 48 </td> 49 <td> 50 <em>(Optional)</em> 51 </td> 52 </tr> 53 <tr> 54 <td> 55 <code>jetstream</code></br> 56 <em> 57 <a href="#argoproj.io/v1alpha1.JetStreamConfig"> 58 JetStreamConfig 59 </a> 60 </em> 61 </td> 62 <td> 63 <em>(Optional)</em> 64 </td> 65 </tr> 66 <tr> 67 <td> 68 <code>kafka</code></br> 69 <em> 70 <a href="#argoproj.io/v1alpha1.KafkaBus"> 71 KafkaBus 72 </a> 73 </em> 74 </td> 75 <td> 76 <em>(Optional)</em> 77 </td> 78 </tr> 79 </tbody> 80 </table> 81 <h3 id="argoproj.io/v1alpha1.ContainerTemplate">ContainerTemplate 82 </h3> 83 <p> 84 (<em>Appears on:</em> 85 <a href="#argoproj.io/v1alpha1.JetStreamBus">JetStreamBus</a>, 86 <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>) 87 </p> 88 <p> 89 <p>ContainerTemplate defines customized spec for a container</p> 90 </p> 91 <table> 92 <thead> 93 <tr> 94 <th>Field</th> 95 <th>Description</th> 96 </tr> 97 </thead> 98 <tbody> 99 <tr> 100 <td> 101 <code>resources</code></br> 102 <em> 103 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#resourcerequirements-v1-core"> 104 Kubernetes core/v1.ResourceRequirements 105 </a> 106 </em> 107 </td> 108 <td> 109 </td> 110 </tr> 111 <tr> 112 <td> 113 <code>imagePullPolicy</code></br> 114 <em> 115 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pullpolicy-v1-core"> 116 Kubernetes core/v1.PullPolicy 117 </a> 118 </em> 119 </td> 120 <td> 121 </td> 122 </tr> 123 <tr> 124 <td> 125 <code>securityContext</code></br> 126 <em> 127 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#securitycontext-v1-core"> 128 Kubernetes core/v1.SecurityContext 129 </a> 130 </em> 131 </td> 132 <td> 133 </td> 134 </tr> 135 </tbody> 136 </table> 137 <h3 id="argoproj.io/v1alpha1.EventBus">EventBus 138 </h3> 139 <p> 140 <p>EventBus is the definition of a eventbus resource</p> 141 </p> 142 <table> 143 <thead> 144 <tr> 145 <th>Field</th> 146 <th>Description</th> 147 </tr> 148 </thead> 149 <tbody> 150 <tr> 151 <td> 152 <code>metadata</code></br> 153 <em> 154 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 155 Kubernetes meta/v1.ObjectMeta 156 </a> 157 </em> 158 </td> 159 <td> 160 Refer to the Kubernetes API documentation for the fields of the 161 <code>metadata</code> field. 162 </td> 163 </tr> 164 <tr> 165 <td> 166 <code>spec</code></br> 167 <em> 168 <a href="#argoproj.io/v1alpha1.EventBusSpec"> 169 EventBusSpec 170 </a> 171 </em> 172 </td> 173 <td> 174 <br/> 175 <br/> 176 <table> 177 <tr> 178 <td> 179 <code>nats</code></br> 180 <em> 181 <a href="#argoproj.io/v1alpha1.NATSBus"> 182 NATSBus 183 </a> 184 </em> 185 </td> 186 <td> 187 <em>(Optional)</em> 188 <p>NATS eventbus</p> 189 </td> 190 </tr> 191 <tr> 192 <td> 193 <code>jetstream</code></br> 194 <em> 195 <a href="#argoproj.io/v1alpha1.JetStreamBus"> 196 JetStreamBus 197 </a> 198 </em> 199 </td> 200 <td> 201 <em>(Optional)</em> 202 </td> 203 </tr> 204 <tr> 205 <td> 206 <code>kafka</code></br> 207 <em> 208 <a href="#argoproj.io/v1alpha1.KafkaBus"> 209 KafkaBus 210 </a> 211 </em> 212 </td> 213 <td> 214 <em>(Optional)</em> 215 <p>Kafka eventbus</p> 216 </td> 217 </tr> 218 <tr> 219 <td> 220 <code>jetstreamExotic</code></br> 221 <em> 222 <a href="#argoproj.io/v1alpha1.JetStreamConfig"> 223 JetStreamConfig 224 </a> 225 </em> 226 </td> 227 <td> 228 <em>(Optional)</em> 229 <p>Exotic JetStream</p> 230 </td> 231 </tr> 232 </table> 233 </td> 234 </tr> 235 <tr> 236 <td> 237 <code>status</code></br> 238 <em> 239 <a href="#argoproj.io/v1alpha1.EventBusStatus"> 240 EventBusStatus 241 </a> 242 </em> 243 </td> 244 <td> 245 <em>(Optional)</em> 246 </td> 247 </tr> 248 </tbody> 249 </table> 250 <h3 id="argoproj.io/v1alpha1.EventBusSpec">EventBusSpec 251 </h3> 252 <p> 253 (<em>Appears on:</em> 254 <a href="#argoproj.io/v1alpha1.EventBus">EventBus</a>) 255 </p> 256 <p> 257 <p>EventBusSpec refers to specification of eventbus resource</p> 258 </p> 259 <table> 260 <thead> 261 <tr> 262 <th>Field</th> 263 <th>Description</th> 264 </tr> 265 </thead> 266 <tbody> 267 <tr> 268 <td> 269 <code>nats</code></br> 270 <em> 271 <a href="#argoproj.io/v1alpha1.NATSBus"> 272 NATSBus 273 </a> 274 </em> 275 </td> 276 <td> 277 <em>(Optional)</em> 278 <p>NATS eventbus</p> 279 </td> 280 </tr> 281 <tr> 282 <td> 283 <code>jetstream</code></br> 284 <em> 285 <a href="#argoproj.io/v1alpha1.JetStreamBus"> 286 JetStreamBus 287 </a> 288 </em> 289 </td> 290 <td> 291 <em>(Optional)</em> 292 </td> 293 </tr> 294 <tr> 295 <td> 296 <code>kafka</code></br> 297 <em> 298 <a href="#argoproj.io/v1alpha1.KafkaBus"> 299 KafkaBus 300 </a> 301 </em> 302 </td> 303 <td> 304 <em>(Optional)</em> 305 <p>Kafka eventbus</p> 306 </td> 307 </tr> 308 <tr> 309 <td> 310 <code>jetstreamExotic</code></br> 311 <em> 312 <a href="#argoproj.io/v1alpha1.JetStreamConfig"> 313 JetStreamConfig 314 </a> 315 </em> 316 </td> 317 <td> 318 <em>(Optional)</em> 319 <p>Exotic JetStream</p> 320 </td> 321 </tr> 322 </tbody> 323 </table> 324 <h3 id="argoproj.io/v1alpha1.EventBusStatus">EventBusStatus 325 </h3> 326 <p> 327 (<em>Appears on:</em> 328 <a href="#argoproj.io/v1alpha1.EventBus">EventBus</a>) 329 </p> 330 <p> 331 <p>EventBusStatus holds the status of the eventbus resource</p> 332 </p> 333 <table> 334 <thead> 335 <tr> 336 <th>Field</th> 337 <th>Description</th> 338 </tr> 339 </thead> 340 <tbody> 341 <tr> 342 <td> 343 <code>Status</code></br> 344 <em> 345 github.com/argoproj/argo-events/pkg/apis/common.Status 346 </em> 347 </td> 348 <td> 349 <p> 350 (Members of <code>Status</code> are embedded into this type.) 351 </p> 352 </td> 353 </tr> 354 <tr> 355 <td> 356 <code>config</code></br> 357 <em> 358 <a href="#argoproj.io/v1alpha1.BusConfig"> 359 BusConfig 360 </a> 361 </em> 362 </td> 363 <td> 364 <p>Config holds the fininalized configuration of EventBus</p> 365 </td> 366 </tr> 367 </tbody> 368 </table> 369 <h3 id="argoproj.io/v1alpha1.JetStreamBus">JetStreamBus 370 </h3> 371 <p> 372 (<em>Appears on:</em> 373 <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>) 374 </p> 375 <p> 376 <p>JetStreamBus holds the JetStream EventBus information</p> 377 </p> 378 <table> 379 <thead> 380 <tr> 381 <th>Field</th> 382 <th>Description</th> 383 </tr> 384 </thead> 385 <tbody> 386 <tr> 387 <td> 388 <code>version</code></br> 389 <em> 390 string 391 </em> 392 </td> 393 <td> 394 <p>JetStream version, such as “2.7.3”</p> 395 </td> 396 </tr> 397 <tr> 398 <td> 399 <code>replicas</code></br> 400 <em> 401 int32 402 </em> 403 </td> 404 <td> 405 <p>JetStream StatefulSet size</p> 406 </td> 407 </tr> 408 <tr> 409 <td> 410 <code>containerTemplate</code></br> 411 <em> 412 <a href="#argoproj.io/v1alpha1.ContainerTemplate"> 413 ContainerTemplate 414 </a> 415 </em> 416 </td> 417 <td> 418 <em>(Optional)</em> 419 <p>ContainerTemplate contains customized spec for Nats JetStream container</p> 420 </td> 421 </tr> 422 <tr> 423 <td> 424 <code>reloaderContainerTemplate</code></br> 425 <em> 426 <a href="#argoproj.io/v1alpha1.ContainerTemplate"> 427 ContainerTemplate 428 </a> 429 </em> 430 </td> 431 <td> 432 <em>(Optional)</em> 433 <p>ReloaderContainerTemplate contains customized spec for config reloader container</p> 434 </td> 435 </tr> 436 <tr> 437 <td> 438 <code>metricsContainerTemplate</code></br> 439 <em> 440 <a href="#argoproj.io/v1alpha1.ContainerTemplate"> 441 ContainerTemplate 442 </a> 443 </em> 444 </td> 445 <td> 446 <em>(Optional)</em> 447 <p>MetricsContainerTemplate contains customized spec for metrics container</p> 448 </td> 449 </tr> 450 <tr> 451 <td> 452 <code>persistence</code></br> 453 <em> 454 <a href="#argoproj.io/v1alpha1.PersistenceStrategy"> 455 PersistenceStrategy 456 </a> 457 </em> 458 </td> 459 <td> 460 <em>(Optional)</em> 461 </td> 462 </tr> 463 <tr> 464 <td> 465 <code>metadata</code></br> 466 <em> 467 github.com/argoproj/argo-events/pkg/apis/common.Metadata 468 </em> 469 </td> 470 <td> 471 <p>Metadata sets the pods’s metadata, i.e. annotations and labels</p> 472 </td> 473 </tr> 474 <tr> 475 <td> 476 <code>nodeSelector</code></br> 477 <em> 478 map[string]string 479 </em> 480 </td> 481 <td> 482 <em>(Optional)</em> 483 <p>NodeSelector is a selector which must be true for the pod to fit on a node. 484 Selector which must match a node’s labels for the pod to be scheduled on that node. 485 More info: <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a></p> 486 </td> 487 </tr> 488 <tr> 489 <td> 490 <code>tolerations</code></br> 491 <em> 492 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core"> 493 []Kubernetes core/v1.Toleration 494 </a> 495 </em> 496 </td> 497 <td> 498 <em>(Optional)</em> 499 <p>If specified, the pod’s tolerations.</p> 500 </td> 501 </tr> 502 <tr> 503 <td> 504 <code>securityContext</code></br> 505 <em> 506 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core"> 507 Kubernetes core/v1.PodSecurityContext 508 </a> 509 </em> 510 </td> 511 <td> 512 <em>(Optional)</em> 513 <p>SecurityContext holds pod-level security attributes and common container settings. 514 Optional: Defaults to empty. See type description for default values of each field.</p> 515 </td> 516 </tr> 517 <tr> 518 <td> 519 <code>imagePullSecrets</code></br> 520 <em> 521 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core"> 522 []Kubernetes core/v1.LocalObjectReference 523 </a> 524 </em> 525 </td> 526 <td> 527 <em>(Optional)</em> 528 <p>ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. 529 If specified, these secrets will be passed to individual puller implementations for them to use. For example, 530 in the case of docker, only DockerConfig type secrets are honored. 531 More info: <a href="https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod">https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod</a></p> 532 </td> 533 </tr> 534 <tr> 535 <td> 536 <code>priorityClassName</code></br> 537 <em> 538 string 539 </em> 540 </td> 541 <td> 542 <em>(Optional)</em> 543 <p>If specified, indicates the Redis pod’s priority. “system-node-critical” 544 and “system-cluster-critical” are two special keywords which indicate the 545 highest priorities with the former being the highest priority. Any other 546 name must be defined by creating a PriorityClass object with that name. 547 If not specified, the pod priority will be default or zero if there is no 548 default. 549 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 550 </td> 551 </tr> 552 <tr> 553 <td> 554 <code>priority</code></br> 555 <em> 556 int32 557 </em> 558 </td> 559 <td> 560 <em>(Optional)</em> 561 <p>The priority value. Various system components use this field to find the 562 priority of the Redis pod. When Priority Admission Controller is enabled, 563 it prevents users from setting this field. The admission controller populates 564 this field from PriorityClassName. 565 The higher the value, the higher the priority. 566 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 567 </td> 568 </tr> 569 <tr> 570 <td> 571 <code>affinity</code></br> 572 <em> 573 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core"> 574 Kubernetes core/v1.Affinity 575 </a> 576 </em> 577 </td> 578 <td> 579 <em>(Optional)</em> 580 <p>The pod’s scheduling constraints 581 More info: <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/">https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/</a></p> 582 </td> 583 </tr> 584 <tr> 585 <td> 586 <code>serviceAccountName</code></br> 587 <em> 588 string 589 </em> 590 </td> 591 <td> 592 <em>(Optional)</em> 593 <p>ServiceAccountName to apply to the StatefulSet</p> 594 </td> 595 </tr> 596 <tr> 597 <td> 598 <code>settings</code></br> 599 <em> 600 string 601 </em> 602 </td> 603 <td> 604 <em>(Optional)</em> 605 <p>JetStream configuration, if not specified, global settings in controller-config will be used. 606 See <a href="https://docs.nats.io/running-a-nats-service/configuration#jetstream">https://docs.nats.io/running-a-nats-service/configuration#jetstream</a>. 607 Only configure “max_memory_store” or “max_file_store”, do not set “store_dir” as it has been hardcoded.</p> 608 </td> 609 </tr> 610 <tr> 611 <td> 612 <code>startArgs</code></br> 613 <em> 614 []string 615 </em> 616 </td> 617 <td> 618 <em>(Optional)</em> 619 <p>Optional arguments to start nats-server. For example, “-D” to enable debugging output, “-DV” to enable debugging and tracing. 620 Check <a href="https://docs.nats.io/">https://docs.nats.io/</a> for all the available arguments.</p> 621 </td> 622 </tr> 623 <tr> 624 <td> 625 <code>streamConfig</code></br> 626 <em> 627 string 628 </em> 629 </td> 630 <td> 631 <em>(Optional)</em> 632 <p>Optional configuration for the streams to be created in this JetStream service, if specified, it will be merged with the default configuration in controller-config. 633 It accepts a YAML format configuration, available fields include, “maxBytes”, “maxMsgs”, “maxAge” (e.g. 72h), “replicas” (1, 3, 5), “duplicates” (e.g. 5m).</p> 634 </td> 635 </tr> 636 <tr> 637 <td> 638 <code>maxPayload</code></br> 639 <em> 640 string 641 </em> 642 </td> 643 <td> 644 <em>(Optional)</em> 645 <p>Maximum number of bytes in a message payload, 0 means unlimited. Defaults to 1MB</p> 646 </td> 647 </tr> 648 </tbody> 649 </table> 650 <h3 id="argoproj.io/v1alpha1.JetStreamConfig">JetStreamConfig 651 </h3> 652 <p> 653 (<em>Appears on:</em> 654 <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>, 655 <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>) 656 </p> 657 <p> 658 </p> 659 <table> 660 <thead> 661 <tr> 662 <th>Field</th> 663 <th>Description</th> 664 </tr> 665 </thead> 666 <tbody> 667 <tr> 668 <td> 669 <code>url</code></br> 670 <em> 671 string 672 </em> 673 </td> 674 <td> 675 <p>JetStream (Nats) URL</p> 676 </td> 677 </tr> 678 <tr> 679 <td> 680 <code>accessSecret</code></br> 681 <em> 682 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 683 Kubernetes core/v1.SecretKeySelector 684 </a> 685 </em> 686 </td> 687 <td> 688 <em>(Optional)</em> 689 <p>Secret for auth</p> 690 </td> 691 </tr> 692 <tr> 693 <td> 694 <code>streamConfig</code></br> 695 <em> 696 string 697 </em> 698 </td> 699 <td> 700 <em>(Optional)</em> 701 </td> 702 </tr> 703 </tbody> 704 </table> 705 <h3 id="argoproj.io/v1alpha1.KafkaBus">KafkaBus 706 </h3> 707 <p> 708 (<em>Appears on:</em> 709 <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>, 710 <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>) 711 </p> 712 <p> 713 <p>KafkaBus holds the KafkaBus EventBus information</p> 714 </p> 715 <table> 716 <thead> 717 <tr> 718 <th>Field</th> 719 <th>Description</th> 720 </tr> 721 </thead> 722 <tbody> 723 <tr> 724 <td> 725 <code>url</code></br> 726 <em> 727 string 728 </em> 729 </td> 730 <td> 731 <p>URL to kafka cluster, multiple URLs separated by comma</p> 732 </td> 733 </tr> 734 <tr> 735 <td> 736 <code>topic</code></br> 737 <em> 738 string 739 </em> 740 </td> 741 <td> 742 <em>(Optional)</em> 743 <p>Topic name, defaults to {namespace_name}-{eventbus_name}</p> 744 </td> 745 </tr> 746 <tr> 747 <td> 748 <code>version</code></br> 749 <em> 750 string 751 </em> 752 </td> 753 <td> 754 <em>(Optional)</em> 755 <p>Kafka version, sarama defaults to the oldest supported stable version</p> 756 </td> 757 </tr> 758 <tr> 759 <td> 760 <code>tls</code></br> 761 <em> 762 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 763 </em> 764 </td> 765 <td> 766 <em>(Optional)</em> 767 <p>TLS configuration for the kafka client.</p> 768 </td> 769 </tr> 770 <tr> 771 <td> 772 <code>sasl</code></br> 773 <em> 774 github.com/argoproj/argo-events/pkg/apis/common.SASLConfig 775 </em> 776 </td> 777 <td> 778 <em>(Optional)</em> 779 <p>SASL configuration for the kafka client</p> 780 </td> 781 </tr> 782 <tr> 783 <td> 784 <code>consumerGroup</code></br> 785 <em> 786 <a href="#argoproj.io/v1alpha1.KafkaConsumerGroup"> 787 KafkaConsumerGroup 788 </a> 789 </em> 790 </td> 791 <td> 792 <em>(Optional)</em> 793 <p>Consumer group for kafka client</p> 794 </td> 795 </tr> 796 </tbody> 797 </table> 798 <h3 id="argoproj.io/v1alpha1.KafkaConsumerGroup">KafkaConsumerGroup 799 </h3> 800 <p> 801 (<em>Appears on:</em> 802 <a href="#argoproj.io/v1alpha1.KafkaBus">KafkaBus</a>) 803 </p> 804 <p> 805 </p> 806 <table> 807 <thead> 808 <tr> 809 <th>Field</th> 810 <th>Description</th> 811 </tr> 812 </thead> 813 <tbody> 814 <tr> 815 <td> 816 <code>groupName</code></br> 817 <em> 818 string 819 </em> 820 </td> 821 <td> 822 <em>(Optional)</em> 823 <p>Consumer group name, defaults to {namespace_name}-{sensor_name}</p> 824 </td> 825 </tr> 826 <tr> 827 <td> 828 <code>rebalanceStrategy</code></br> 829 <em> 830 string 831 </em> 832 </td> 833 <td> 834 <em>(Optional)</em> 835 <p>Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default.</p> 836 </td> 837 </tr> 838 <tr> 839 <td> 840 <code>startOldest</code></br> 841 <em> 842 bool 843 </em> 844 </td> 845 <td> 846 <em>(Optional)</em> 847 <p>When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false</p> 848 </td> 849 </tr> 850 </tbody> 851 </table> 852 <h3 id="argoproj.io/v1alpha1.NATSBus">NATSBus 853 </h3> 854 <p> 855 (<em>Appears on:</em> 856 <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>) 857 </p> 858 <p> 859 <p>NATSBus holds the NATS eventbus information</p> 860 </p> 861 <table> 862 <thead> 863 <tr> 864 <th>Field</th> 865 <th>Description</th> 866 </tr> 867 </thead> 868 <tbody> 869 <tr> 870 <td> 871 <code>native</code></br> 872 <em> 873 <a href="#argoproj.io/v1alpha1.NativeStrategy"> 874 NativeStrategy 875 </a> 876 </em> 877 </td> 878 <td> 879 <p>Native means to bring up a native NATS service</p> 880 </td> 881 </tr> 882 <tr> 883 <td> 884 <code>exotic</code></br> 885 <em> 886 <a href="#argoproj.io/v1alpha1.NATSConfig"> 887 NATSConfig 888 </a> 889 </em> 890 </td> 891 <td> 892 <p>Exotic holds an exotic NATS config</p> 893 </td> 894 </tr> 895 </tbody> 896 </table> 897 <h3 id="argoproj.io/v1alpha1.NATSConfig">NATSConfig 898 </h3> 899 <p> 900 (<em>Appears on:</em> 901 <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>, 902 <a href="#argoproj.io/v1alpha1.NATSBus">NATSBus</a>) 903 </p> 904 <p> 905 <p>NATSConfig holds the config of NATS</p> 906 </p> 907 <table> 908 <thead> 909 <tr> 910 <th>Field</th> 911 <th>Description</th> 912 </tr> 913 </thead> 914 <tbody> 915 <tr> 916 <td> 917 <code>url</code></br> 918 <em> 919 string 920 </em> 921 </td> 922 <td> 923 <p>NATS streaming url</p> 924 </td> 925 </tr> 926 <tr> 927 <td> 928 <code>clusterID</code></br> 929 <em> 930 string 931 </em> 932 </td> 933 <td> 934 <p>Cluster ID for nats streaming</p> 935 </td> 936 </tr> 937 <tr> 938 <td> 939 <code>auth</code></br> 940 <em> 941 <a href="#argoproj.io/v1alpha1.AuthStrategy"> 942 AuthStrategy 943 </a> 944 </em> 945 </td> 946 <td> 947 <em>(Optional)</em> 948 <p>Auth strategy, default to AuthStrategyNone</p> 949 </td> 950 </tr> 951 <tr> 952 <td> 953 <code>accessSecret</code></br> 954 <em> 955 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 956 Kubernetes core/v1.SecretKeySelector 957 </a> 958 </em> 959 </td> 960 <td> 961 <em>(Optional)</em> 962 <p>Secret for auth</p> 963 </td> 964 </tr> 965 </tbody> 966 </table> 967 <h3 id="argoproj.io/v1alpha1.NativeStrategy">NativeStrategy 968 </h3> 969 <p> 970 (<em>Appears on:</em> 971 <a href="#argoproj.io/v1alpha1.NATSBus">NATSBus</a>) 972 </p> 973 <p> 974 <p>NativeStrategy indicates to install a native NATS service</p> 975 </p> 976 <table> 977 <thead> 978 <tr> 979 <th>Field</th> 980 <th>Description</th> 981 </tr> 982 </thead> 983 <tbody> 984 <tr> 985 <td> 986 <code>replicas</code></br> 987 <em> 988 int32 989 </em> 990 </td> 991 <td> 992 <p>Size is the NATS StatefulSet size</p> 993 </td> 994 </tr> 995 <tr> 996 <td> 997 <code>auth</code></br> 998 <em> 999 <a href="#argoproj.io/v1alpha1.AuthStrategy"> 1000 AuthStrategy 1001 </a> 1002 </em> 1003 </td> 1004 <td> 1005 </td> 1006 </tr> 1007 <tr> 1008 <td> 1009 <code>persistence</code></br> 1010 <em> 1011 <a href="#argoproj.io/v1alpha1.PersistenceStrategy"> 1012 PersistenceStrategy 1013 </a> 1014 </em> 1015 </td> 1016 <td> 1017 <em>(Optional)</em> 1018 </td> 1019 </tr> 1020 <tr> 1021 <td> 1022 <code>containerTemplate</code></br> 1023 <em> 1024 <a href="#argoproj.io/v1alpha1.ContainerTemplate"> 1025 ContainerTemplate 1026 </a> 1027 </em> 1028 </td> 1029 <td> 1030 <em>(Optional)</em> 1031 <p>ContainerTemplate contains customized spec for NATS container</p> 1032 </td> 1033 </tr> 1034 <tr> 1035 <td> 1036 <code>metricsContainerTemplate</code></br> 1037 <em> 1038 <a href="#argoproj.io/v1alpha1.ContainerTemplate"> 1039 ContainerTemplate 1040 </a> 1041 </em> 1042 </td> 1043 <td> 1044 <em>(Optional)</em> 1045 <p>MetricsContainerTemplate contains customized spec for metrics container</p> 1046 </td> 1047 </tr> 1048 <tr> 1049 <td> 1050 <code>nodeSelector</code></br> 1051 <em> 1052 map[string]string 1053 </em> 1054 </td> 1055 <td> 1056 <em>(Optional)</em> 1057 <p>NodeSelector is a selector which must be true for the pod to fit on a node. 1058 Selector which must match a node’s labels for the pod to be scheduled on that node. 1059 More info: <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a></p> 1060 </td> 1061 </tr> 1062 <tr> 1063 <td> 1064 <code>tolerations</code></br> 1065 <em> 1066 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core"> 1067 []Kubernetes core/v1.Toleration 1068 </a> 1069 </em> 1070 </td> 1071 <td> 1072 <em>(Optional)</em> 1073 <p>If specified, the pod’s tolerations.</p> 1074 </td> 1075 </tr> 1076 <tr> 1077 <td> 1078 <code>metadata</code></br> 1079 <em> 1080 github.com/argoproj/argo-events/pkg/apis/common.Metadata 1081 </em> 1082 </td> 1083 <td> 1084 <p>Metadata sets the pods’s metadata, i.e. annotations and labels</p> 1085 </td> 1086 </tr> 1087 <tr> 1088 <td> 1089 <code>securityContext</code></br> 1090 <em> 1091 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core"> 1092 Kubernetes core/v1.PodSecurityContext 1093 </a> 1094 </em> 1095 </td> 1096 <td> 1097 <em>(Optional)</em> 1098 <p>SecurityContext holds pod-level security attributes and common container settings. 1099 Optional: Defaults to empty. See type description for default values of each field.</p> 1100 </td> 1101 </tr> 1102 <tr> 1103 <td> 1104 <code>maxAge</code></br> 1105 <em> 1106 string 1107 </em> 1108 </td> 1109 <td> 1110 <em>(Optional)</em> 1111 <p>Max Age of existing messages, i.e. “72h”, “4h35m”</p> 1112 </td> 1113 </tr> 1114 <tr> 1115 <td> 1116 <code>imagePullSecrets</code></br> 1117 <em> 1118 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core"> 1119 []Kubernetes core/v1.LocalObjectReference 1120 </a> 1121 </em> 1122 </td> 1123 <td> 1124 <em>(Optional)</em> 1125 <p>ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. 1126 If specified, these secrets will be passed to individual puller implementations for them to use. For example, 1127 in the case of docker, only DockerConfig type secrets are honored. 1128 More info: <a href="https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod">https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod</a></p> 1129 </td> 1130 </tr> 1131 <tr> 1132 <td> 1133 <code>serviceAccountName</code></br> 1134 <em> 1135 string 1136 </em> 1137 </td> 1138 <td> 1139 <em>(Optional)</em> 1140 <p>ServiceAccountName to apply to NATS StatefulSet</p> 1141 </td> 1142 </tr> 1143 <tr> 1144 <td> 1145 <code>priorityClassName</code></br> 1146 <em> 1147 string 1148 </em> 1149 </td> 1150 <td> 1151 <em>(Optional)</em> 1152 <p>If specified, indicates the EventSource pod’s priority. “system-node-critical” 1153 and “system-cluster-critical” are two special keywords which indicate the 1154 highest priorities with the former being the highest priority. Any other 1155 name must be defined by creating a PriorityClass object with that name. 1156 If not specified, the pod priority will be default or zero if there is no 1157 default. 1158 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 1159 </td> 1160 </tr> 1161 <tr> 1162 <td> 1163 <code>priority</code></br> 1164 <em> 1165 int32 1166 </em> 1167 </td> 1168 <td> 1169 <em>(Optional)</em> 1170 <p>The priority value. Various system components use this field to find the 1171 priority of the EventSource pod. When Priority Admission Controller is enabled, 1172 it prevents users from setting this field. The admission controller populates 1173 this field from PriorityClassName. 1174 The higher the value, the higher the priority. 1175 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 1176 </td> 1177 </tr> 1178 <tr> 1179 <td> 1180 <code>affinity</code></br> 1181 <em> 1182 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core"> 1183 Kubernetes core/v1.Affinity 1184 </a> 1185 </em> 1186 </td> 1187 <td> 1188 <em>(Optional)</em> 1189 <p>The pod’s scheduling constraints 1190 More info: <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/">https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/</a></p> 1191 </td> 1192 </tr> 1193 <tr> 1194 <td> 1195 <code>maxMsgs</code></br> 1196 <em> 1197 uint64 1198 </em> 1199 </td> 1200 <td> 1201 <p>Maximum number of messages per channel, 0 means unlimited. Defaults to 1000000</p> 1202 </td> 1203 </tr> 1204 <tr> 1205 <td> 1206 <code>maxBytes</code></br> 1207 <em> 1208 string 1209 </em> 1210 </td> 1211 <td> 1212 <p>Total size of messages per channel, 0 means unlimited. Defaults to 1GB</p> 1213 </td> 1214 </tr> 1215 <tr> 1216 <td> 1217 <code>maxSubs</code></br> 1218 <em> 1219 uint64 1220 </em> 1221 </td> 1222 <td> 1223 <p>Maximum number of subscriptions per channel, 0 means unlimited. Defaults to 1000</p> 1224 </td> 1225 </tr> 1226 <tr> 1227 <td> 1228 <code>maxPayload</code></br> 1229 <em> 1230 string 1231 </em> 1232 </td> 1233 <td> 1234 <p>Maximum number of bytes in a message payload, 0 means unlimited. Defaults to 1MB</p> 1235 </td> 1236 </tr> 1237 <tr> 1238 <td> 1239 <code>raftHeartbeatTimeout</code></br> 1240 <em> 1241 string 1242 </em> 1243 </td> 1244 <td> 1245 <p>Specifies the time in follower state without a leader before attempting an election, i.e. “72h”, “4h35m”. Defaults to 2s</p> 1246 </td> 1247 </tr> 1248 <tr> 1249 <td> 1250 <code>raftElectionTimeout</code></br> 1251 <em> 1252 string 1253 </em> 1254 </td> 1255 <td> 1256 <p>Specifies the time in candidate state without a leader before attempting an election, i.e. “72h”, “4h35m”. Defaults to 2s</p> 1257 </td> 1258 </tr> 1259 <tr> 1260 <td> 1261 <code>raftLeaseTimeout</code></br> 1262 <em> 1263 string 1264 </em> 1265 </td> 1266 <td> 1267 <p>Specifies how long a leader waits without being able to contact a quorum of nodes before stepping down as leader, i.e. “72h”, “4h35m”. Defaults to 1s</p> 1268 </td> 1269 </tr> 1270 <tr> 1271 <td> 1272 <code>raftCommitTimeout</code></br> 1273 <em> 1274 string 1275 </em> 1276 </td> 1277 <td> 1278 <p>Specifies the time without an Apply() operation before sending an heartbeat to ensure timely commit, i.e. “72h”, “4h35m”. Defaults to 100ms</p> 1279 </td> 1280 </tr> 1281 </tbody> 1282 </table> 1283 <h3 id="argoproj.io/v1alpha1.PersistenceStrategy">PersistenceStrategy 1284 </h3> 1285 <p> 1286 (<em>Appears on:</em> 1287 <a href="#argoproj.io/v1alpha1.JetStreamBus">JetStreamBus</a>, 1288 <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>) 1289 </p> 1290 <p> 1291 <p>PersistenceStrategy defines the strategy of persistence</p> 1292 </p> 1293 <table> 1294 <thead> 1295 <tr> 1296 <th>Field</th> 1297 <th>Description</th> 1298 </tr> 1299 </thead> 1300 <tbody> 1301 <tr> 1302 <td> 1303 <code>storageClassName</code></br> 1304 <em> 1305 string 1306 </em> 1307 </td> 1308 <td> 1309 <em>(Optional)</em> 1310 <p>Name of the StorageClass required by the claim. 1311 More info: <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1">https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1</a></p> 1312 </td> 1313 </tr> 1314 <tr> 1315 <td> 1316 <code>accessMode</code></br> 1317 <em> 1318 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#persistentvolumeaccessmode-v1-core"> 1319 Kubernetes core/v1.PersistentVolumeAccessMode 1320 </a> 1321 </em> 1322 </td> 1323 <td> 1324 <em>(Optional)</em> 1325 <p>Available access modes such as ReadWriteOnce, ReadWriteMany 1326 <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes">https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes</a></p> 1327 </td> 1328 </tr> 1329 <tr> 1330 <td> 1331 <code>volumeSize</code></br> 1332 <em> 1333 k8s.io/apimachinery/pkg/api/resource.Quantity 1334 </em> 1335 </td> 1336 <td> 1337 <p>Volume size, e.g. 10Gi</p> 1338 </td> 1339 </tr> 1340 </tbody> 1341 </table> 1342 <hr/> 1343 <p><em> 1344 Generated with <code>gen-crd-api-reference-docs</code>. 1345 </em></p>