github.com/argoproj/argo-events@v1.9.1/api/event-source.md (about) 1 <p> 2 Packages: 3 </p> 4 <ul> 5 <li> 6 <a href="#argoproj.io%2fv1alpha1">argoproj.io/v1alpha1</a> 7 </li> 8 </ul> 9 <h2 id="argoproj.io/v1alpha1"> 10 argoproj.io/v1alpha1 11 </h2> 12 <p> 13 <p> 14 Package v1alpha1 is the v1alpha1 version of the API. 15 </p> 16 </p> 17 Resource Types: 18 <ul> 19 </ul> 20 <h3 id="argoproj.io/v1alpha1.AMQPConsumeConfig"> 21 AMQPConsumeConfig 22 </h3> 23 <p> 24 (<em>Appears on:</em> 25 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 26 </p> 27 <p> 28 <p> 29 AMQPConsumeConfig holds the configuration to immediately starts 30 delivering queued messages 31 </p> 32 </p> 33 <table> 34 <thead> 35 <tr> 36 <th> 37 Field 38 </th> 39 <th> 40 Description 41 </th> 42 </tr> 43 </thead> 44 <tbody> 45 <tr> 46 <td> 47 <code>consumerTag</code></br> <em> string </em> 48 </td> 49 <td> 50 <em>(Optional)</em> 51 <p> 52 ConsumerTag is the identity of the consumer included in every delivery 53 </p> 54 </td> 55 </tr> 56 <tr> 57 <td> 58 <code>autoAck</code></br> <em> bool </em> 59 </td> 60 <td> 61 <em>(Optional)</em> 62 <p> 63 AutoAck when true, the server will acknowledge deliveries to this 64 consumer prior to writing the delivery to the network 65 </p> 66 </td> 67 </tr> 68 <tr> 69 <td> 70 <code>exclusive</code></br> <em> bool </em> 71 </td> 72 <td> 73 <em>(Optional)</em> 74 <p> 75 Exclusive when true, the server will ensure that this is the sole 76 consumer from this queue 77 </p> 78 </td> 79 </tr> 80 <tr> 81 <td> 82 <code>noLocal</code></br> <em> bool </em> 83 </td> 84 <td> 85 <em>(Optional)</em> 86 <p> 87 NoLocal flag is not supported by RabbitMQ 88 </p> 89 </td> 90 </tr> 91 <tr> 92 <td> 93 <code>noWait</code></br> <em> bool </em> 94 </td> 95 <td> 96 <em>(Optional)</em> 97 <p> 98 NowWait when true, do not wait for the server to confirm the request and 99 immediately begin deliveries 100 </p> 101 </td> 102 </tr> 103 </tbody> 104 </table> 105 <h3 id="argoproj.io/v1alpha1.AMQPEventSource"> 106 AMQPEventSource 107 </h3> 108 <p> 109 (<em>Appears on:</em> 110 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 111 </p> 112 <p> 113 <p> 114 AMQPEventSource refers to an event-source for AMQP stream events 115 </p> 116 </p> 117 <table> 118 <thead> 119 <tr> 120 <th> 121 Field 122 </th> 123 <th> 124 Description 125 </th> 126 </tr> 127 </thead> 128 <tbody> 129 <tr> 130 <td> 131 <code>url</code></br> <em> string </em> 132 </td> 133 <td> 134 <p> 135 URL for rabbitmq service 136 </p> 137 </td> 138 </tr> 139 <tr> 140 <td> 141 <code>exchangeName</code></br> <em> string </em> 142 </td> 143 <td> 144 <p> 145 ExchangeName is the exchange name For more information, visit 146 <a href="https://www.rabbitmq.com/tutorials/amqp-concepts.html">https://www.rabbitmq.com/tutorials/amqp-concepts.html</a> 147 </p> 148 </td> 149 </tr> 150 <tr> 151 <td> 152 <code>exchangeType</code></br> <em> string </em> 153 </td> 154 <td> 155 <p> 156 ExchangeType is rabbitmq exchange type 157 </p> 158 </td> 159 </tr> 160 <tr> 161 <td> 162 <code>routingKey</code></br> <em> string </em> 163 </td> 164 <td> 165 <p> 166 Routing key for bindings 167 </p> 168 </td> 169 </tr> 170 <tr> 171 <td> 172 <code>connectionBackoff</code></br> <em> 173 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 174 </td> 175 <td> 176 <em>(Optional)</em> 177 <p> 178 Backoff holds parameters applied to connection. 179 </p> 180 </td> 181 </tr> 182 <tr> 183 <td> 184 <code>jsonBody</code></br> <em> bool </em> 185 </td> 186 <td> 187 <em>(Optional)</em> 188 <p> 189 JSONBody specifies that all event body payload coming from this source 190 will be JSON 191 </p> 192 </td> 193 </tr> 194 <tr> 195 <td> 196 <code>tls</code></br> <em> 197 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 198 </td> 199 <td> 200 <em>(Optional)</em> 201 <p> 202 TLS configuration for the amqp client. 203 </p> 204 </td> 205 </tr> 206 <tr> 207 <td> 208 <code>metadata</code></br> <em> map\[string\]string </em> 209 </td> 210 <td> 211 <em>(Optional)</em> 212 <p> 213 Metadata holds the user defined metadata which will passed along the 214 event payload. 215 </p> 216 </td> 217 </tr> 218 <tr> 219 <td> 220 <code>exchangeDeclare</code></br> <em> 221 <a href="#argoproj.io/v1alpha1.AMQPExchangeDeclareConfig"> 222 AMQPExchangeDeclareConfig </a> </em> 223 </td> 224 <td> 225 <em>(Optional)</em> 226 <p> 227 ExchangeDeclare holds the configuration for the exchange on the server 228 For more information, visit 229 <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare</a> 230 </p> 231 </td> 232 </tr> 233 <tr> 234 <td> 235 <code>queueDeclare</code></br> <em> 236 <a href="#argoproj.io/v1alpha1.AMQPQueueDeclareConfig"> 237 AMQPQueueDeclareConfig </a> </em> 238 </td> 239 <td> 240 <em>(Optional)</em> 241 <p> 242 QueueDeclare holds the configuration of a queue to hold messages and 243 deliver to consumers. Declaring creates a queue if it doesn’t already 244 exist, or ensures that an existing queue matches the same parameters For 245 more information, visit 246 <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare</a> 247 </p> 248 </td> 249 </tr> 250 <tr> 251 <td> 252 <code>queueBind</code></br> <em> 253 <a href="#argoproj.io/v1alpha1.AMQPQueueBindConfig"> AMQPQueueBindConfig 254 </a> </em> 255 </td> 256 <td> 257 <em>(Optional)</em> 258 <p> 259 QueueBind holds the configuration that binds an exchange to a queue so 260 that publishings to the exchange will be routed to the queue when the 261 publishing routing key matches the binding routing key For more 262 information, visit 263 <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind</a> 264 </p> 265 </td> 266 </tr> 267 <tr> 268 <td> 269 <code>consume</code></br> <em> 270 <a href="#argoproj.io/v1alpha1.AMQPConsumeConfig"> AMQPConsumeConfig 271 </a> </em> 272 </td> 273 <td> 274 <em>(Optional)</em> 275 <p> 276 Consume holds the configuration to immediately starts delivering queued 277 messages For more information, visit 278 <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume</a> 279 </p> 280 </td> 281 </tr> 282 <tr> 283 <td> 284 <code>auth</code></br> <em> 285 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth </em> 286 </td> 287 <td> 288 <em>(Optional)</em> 289 <p> 290 Auth hosts secret selectors for username and password 291 </p> 292 </td> 293 </tr> 294 <tr> 295 <td> 296 <code>urlSecret</code></br> <em> 297 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 298 Kubernetes core/v1.SecretKeySelector </a> </em> 299 </td> 300 <td> 301 <p> 302 URLSecret is secret reference for rabbitmq service URL 303 </p> 304 </td> 305 </tr> 306 <tr> 307 <td> 308 <code>filter</code></br> <em> 309 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 310 </a> </em> 311 </td> 312 <td> 313 <em>(Optional)</em> 314 <p> 315 Filter 316 </p> 317 </td> 318 </tr> 319 </tbody> 320 </table> 321 <h3 id="argoproj.io/v1alpha1.AMQPExchangeDeclareConfig"> 322 AMQPExchangeDeclareConfig 323 </h3> 324 <p> 325 (<em>Appears on:</em> 326 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 327 </p> 328 <p> 329 <p> 330 AMQPExchangeDeclareConfig holds the configuration for the exchange on 331 the server 332 </p> 333 </p> 334 <table> 335 <thead> 336 <tr> 337 <th> 338 Field 339 </th> 340 <th> 341 Description 342 </th> 343 </tr> 344 </thead> 345 <tbody> 346 <tr> 347 <td> 348 <code>durable</code></br> <em> bool </em> 349 </td> 350 <td> 351 <em>(Optional)</em> 352 <p> 353 Durable keeps the exchange also after the server restarts 354 </p> 355 </td> 356 </tr> 357 <tr> 358 <td> 359 <code>autoDelete</code></br> <em> bool </em> 360 </td> 361 <td> 362 <em>(Optional)</em> 363 <p> 364 AutoDelete removes the exchange when no bindings are active 365 </p> 366 </td> 367 </tr> 368 <tr> 369 <td> 370 <code>internal</code></br> <em> bool </em> 371 </td> 372 <td> 373 <em>(Optional)</em> 374 <p> 375 Internal when true does not accept publishings 376 </p> 377 </td> 378 </tr> 379 <tr> 380 <td> 381 <code>noWait</code></br> <em> bool </em> 382 </td> 383 <td> 384 <em>(Optional)</em> 385 <p> 386 NowWait when true does not wait for a confirmation from the server 387 </p> 388 </td> 389 </tr> 390 </tbody> 391 </table> 392 <h3 id="argoproj.io/v1alpha1.AMQPQueueBindConfig"> 393 AMQPQueueBindConfig 394 </h3> 395 <p> 396 (<em>Appears on:</em> 397 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 398 </p> 399 <p> 400 <p> 401 AMQPQueueBindConfig holds the configuration that binds an exchange to a 402 queue so that publishings to the exchange will be routed to the queue 403 when the publishing routing key matches the binding routing key 404 </p> 405 </p> 406 <table> 407 <thead> 408 <tr> 409 <th> 410 Field 411 </th> 412 <th> 413 Description 414 </th> 415 </tr> 416 </thead> 417 <tbody> 418 <tr> 419 <td> 420 <code>noWait</code></br> <em> bool </em> 421 </td> 422 <td> 423 <em>(Optional)</em> 424 <p> 425 NowWait false and the queue could not be bound, the channel will be 426 closed with an error 427 </p> 428 </td> 429 </tr> 430 </tbody> 431 </table> 432 <h3 id="argoproj.io/v1alpha1.AMQPQueueDeclareConfig"> 433 AMQPQueueDeclareConfig 434 </h3> 435 <p> 436 (<em>Appears on:</em> 437 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 438 </p> 439 <p> 440 <p> 441 AMQPQueueDeclareConfig holds the configuration of a queue to hold 442 messages and deliver to consumers. Declaring creates a queue if it 443 doesn’t already exist, or ensures that an existing queue matches the 444 same parameters 445 </p> 446 </p> 447 <table> 448 <thead> 449 <tr> 450 <th> 451 Field 452 </th> 453 <th> 454 Description 455 </th> 456 </tr> 457 </thead> 458 <tbody> 459 <tr> 460 <td> 461 <code>name</code></br> <em> string </em> 462 </td> 463 <td> 464 <em>(Optional)</em> 465 <p> 466 Name of the queue. If empty the server auto-generates a unique name for 467 this queue 468 </p> 469 </td> 470 </tr> 471 <tr> 472 <td> 473 <code>durable</code></br> <em> bool </em> 474 </td> 475 <td> 476 <em>(Optional)</em> 477 <p> 478 Durable keeps the queue also after the server restarts 479 </p> 480 </td> 481 </tr> 482 <tr> 483 <td> 484 <code>autoDelete</code></br> <em> bool </em> 485 </td> 486 <td> 487 <em>(Optional)</em> 488 <p> 489 AutoDelete removes the queue when no consumers are active 490 </p> 491 </td> 492 </tr> 493 <tr> 494 <td> 495 <code>exclusive</code></br> <em> bool </em> 496 </td> 497 <td> 498 <em>(Optional)</em> 499 <p> 500 Exclusive sets the queues to be accessible only by the connection that 501 declares them and will be deleted wgen the connection closes 502 </p> 503 </td> 504 </tr> 505 <tr> 506 <td> 507 <code>noWait</code></br> <em> bool </em> 508 </td> 509 <td> 510 <em>(Optional)</em> 511 <p> 512 NowWait when true, the queue assumes to be declared on the server 513 </p> 514 </td> 515 </tr> 516 <tr> 517 <td> 518 <code>arguments</code></br> <em> string </em> 519 </td> 520 <td> 521 <em>(Optional)</em> 522 <p> 523 Arguments of a queue (also known as “x-arguments”) used for optional 524 features and plugins 525 </p> 526 </td> 527 </tr> 528 </tbody> 529 </table> 530 <h3 id="argoproj.io/v1alpha1.AzureEventsHubEventSource"> 531 AzureEventsHubEventSource 532 </h3> 533 <p> 534 (<em>Appears on:</em> 535 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 536 </p> 537 <p> 538 <p> 539 AzureEventsHubEventSource describes the event source for azure events 540 hub More info at 541 <a href="https://docs.microsoft.com/en-us/azure/event-hubs/">https://docs.microsoft.com/en-us/azure/event-hubs/</a> 542 </p> 543 </p> 544 <table> 545 <thead> 546 <tr> 547 <th> 548 Field 549 </th> 550 <th> 551 Description 552 </th> 553 </tr> 554 </thead> 555 <tbody> 556 <tr> 557 <td> 558 <code>fqdn</code></br> <em> string </em> 559 </td> 560 <td> 561 <p> 562 FQDN of the EventHubs namespace you created More info at 563 <a href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string">https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string</a> 564 </p> 565 </td> 566 </tr> 567 <tr> 568 <td> 569 <code>sharedAccessKeyName</code></br> <em> 570 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 571 Kubernetes core/v1.SecretKeySelector </a> </em> 572 </td> 573 <td> 574 <p> 575 SharedAccessKeyName is the name you chose for your application’s SAS 576 keys 577 </p> 578 </td> 579 </tr> 580 <tr> 581 <td> 582 <code>sharedAccessKey</code></br> <em> 583 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 584 Kubernetes core/v1.SecretKeySelector </a> </em> 585 </td> 586 <td> 587 <p> 588 SharedAccessKey is the generated value of the key 589 </p> 590 </td> 591 </tr> 592 <tr> 593 <td> 594 <code>hubName</code></br> <em> string </em> 595 </td> 596 <td> 597 <p> 598 Event Hub path/name 599 </p> 600 </td> 601 </tr> 602 <tr> 603 <td> 604 <code>metadata</code></br> <em> map\[string\]string </em> 605 </td> 606 <td> 607 <em>(Optional)</em> 608 <p> 609 Metadata holds the user defined metadata which will passed along the 610 event payload. 611 </p> 612 </td> 613 </tr> 614 <tr> 615 <td> 616 <code>filter</code></br> <em> 617 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 618 </a> </em> 619 </td> 620 <td> 621 <em>(Optional)</em> 622 <p> 623 Filter 624 </p> 625 </td> 626 </tr> 627 </tbody> 628 </table> 629 <h3 id="argoproj.io/v1alpha1.AzureQueueStorageEventSource"> 630 AzureQueueStorageEventSource 631 </h3> 632 <p> 633 (<em>Appears on:</em> 634 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 635 </p> 636 <p> 637 <p> 638 AzureQueueStorageEventSource describes the event source for azure queue 639 storage more info at 640 <a href="https://learn.microsoft.com/en-us/azure/storage/queues/">https://learn.microsoft.com/en-us/azure/storage/queues/</a> 641 </p> 642 </p> 643 <table> 644 <thead> 645 <tr> 646 <th> 647 Field 648 </th> 649 <th> 650 Description 651 </th> 652 </tr> 653 </thead> 654 <tbody> 655 <tr> 656 <td> 657 <code>storageAccountName</code></br> <em> string </em> 658 </td> 659 <td> 660 <em>(Optional)</em> 661 <p> 662 StorageAccountName is the name of the storage account where the queue 663 is. This field is necessary to access via Azure AD (managed identity) 664 and it is ignored if ConnectionString is set. 665 </p> 666 </td> 667 </tr> 668 <tr> 669 <td> 670 <code>connectionString</code></br> <em> 671 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 672 Kubernetes core/v1.SecretKeySelector </a> </em> 673 </td> 674 <td> 675 <em>(Optional)</em> 676 <p> 677 ConnectionString is the connection string to access Azure Queue Storage. 678 If this fields is not provided it will try to access via Azure AD with 679 StorageAccountName. 680 </p> 681 </td> 682 </tr> 683 <tr> 684 <td> 685 <code>queueName</code></br> <em> string </em> 686 </td> 687 <td> 688 <p> 689 QueueName is the name of the queue 690 </p> 691 </td> 692 </tr> 693 <tr> 694 <td> 695 <code>jsonBody</code></br> <em> bool </em> 696 </td> 697 <td> 698 <em>(Optional)</em> 699 <p> 700 JSONBody specifies that all event body payload coming from this source 701 will be JSON 702 </p> 703 </td> 704 </tr> 705 <tr> 706 <td> 707 <code>dlq</code></br> <em> bool </em> 708 </td> 709 <td> 710 <em>(Optional)</em> 711 <p> 712 DLQ specifies if a dead-letter queue is configured for messages that 713 can’t be processed successfully. If set to true, messages with invalid 714 payload won’t be acknowledged to allow to forward them farther to the 715 dead-letter queue. The default value is false. 716 </p> 717 </td> 718 </tr> 719 <tr> 720 <td> 721 <code>metadata</code></br> <em> map\[string\]string </em> 722 </td> 723 <td> 724 <em>(Optional)</em> 725 <p> 726 Metadata holds the user defined metadata which will passed along the 727 event payload. 728 </p> 729 </td> 730 </tr> 731 <tr> 732 <td> 733 <code>filter</code></br> <em> 734 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 735 </a> </em> 736 </td> 737 <td> 738 <em>(Optional)</em> 739 <p> 740 Filter 741 </p> 742 </td> 743 </tr> 744 <tr> 745 <td> 746 <code>decodeMessage</code></br> <em> bool </em> 747 </td> 748 <td> 749 <em>(Optional)</em> 750 <p> 751 DecodeMessage specifies if all the messages should be base64 decoded. If 752 set to true the decoding is done before the evaluation of JSONBody 753 </p> 754 </td> 755 </tr> 756 <tr> 757 <td> 758 <code>waitTimeInSeconds</code></br> <em> int32 </em> 759 </td> 760 <td> 761 <em>(Optional)</em> 762 <p> 763 WaitTimeInSeconds is the duration (in seconds) for which the event 764 source waits between empty results from the queue. The default value is 765 3 seconds. 766 </p> 767 </td> 768 </tr> 769 </tbody> 770 </table> 771 <h3 id="argoproj.io/v1alpha1.AzureServiceBusEventSource"> 772 AzureServiceBusEventSource 773 </h3> 774 <p> 775 (<em>Appears on:</em> 776 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 777 </p> 778 <p> 779 <p> 780 AzureServiceBusEventSource describes the event source for azure service 781 bus More info at 782 <a href="https://docs.microsoft.com/en-us/azure/service-bus-messaging/">https://docs.microsoft.com/en-us/azure/service-bus-messaging/</a> 783 </p> 784 </p> 785 <table> 786 <thead> 787 <tr> 788 <th> 789 Field 790 </th> 791 <th> 792 Description 793 </th> 794 </tr> 795 </thead> 796 <tbody> 797 <tr> 798 <td> 799 <code>connectionString</code></br> <em> 800 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 801 Kubernetes core/v1.SecretKeySelector </a> </em> 802 </td> 803 <td> 804 <em>(Optional)</em> 805 <p> 806 ConnectionString is the connection string for the Azure Service Bus. If 807 this fields is not provided it will try to access via Azure AD with 808 DefaultAzureCredential and FullyQualifiedNamespace. 809 </p> 810 </td> 811 </tr> 812 <tr> 813 <td> 814 <code>queueName</code></br> <em> string </em> 815 </td> 816 <td> 817 <p> 818 QueueName is the name of the Azure Service Bus Queue 819 </p> 820 </td> 821 </tr> 822 <tr> 823 <td> 824 <code>topicName</code></br> <em> string </em> 825 </td> 826 <td> 827 <p> 828 TopicName is the name of the Azure Service Bus Topic 829 </p> 830 </td> 831 </tr> 832 <tr> 833 <td> 834 <code>subscriptionName</code></br> <em> string </em> 835 </td> 836 <td> 837 <p> 838 SubscriptionName is the name of the Azure Service Bus Topic Subscription 839 </p> 840 </td> 841 </tr> 842 <tr> 843 <td> 844 <code>tls</code></br> <em> 845 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 846 </td> 847 <td> 848 <em>(Optional)</em> 849 <p> 850 TLS configuration for the service bus client 851 </p> 852 </td> 853 </tr> 854 <tr> 855 <td> 856 <code>jsonBody</code></br> <em> bool </em> 857 </td> 858 <td> 859 <em>(Optional)</em> 860 <p> 861 JSONBody specifies that all event body payload coming from this source 862 will be JSON 863 </p> 864 </td> 865 </tr> 866 <tr> 867 <td> 868 <code>metadata</code></br> <em> map\[string\]string </em> 869 </td> 870 <td> 871 <em>(Optional)</em> 872 <p> 873 Metadata holds the user defined metadata which will passed along the 874 event payload. 875 </p> 876 </td> 877 </tr> 878 <tr> 879 <td> 880 <code>filter</code></br> <em> 881 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 882 </a> </em> 883 </td> 884 <td> 885 <em>(Optional)</em> 886 <p> 887 Filter 888 </p> 889 </td> 890 </tr> 891 <tr> 892 <td> 893 <code>fullyQualifiedNamespace</code></br> <em> string </em> 894 </td> 895 <td> 896 <em>(Optional)</em> 897 <p> 898 FullyQualifiedNamespace is the Service Bus namespace name (ex: 899 myservicebus.servicebus.windows.net). This field is necessary to access 900 via Azure AD (managed identity) and it is ignored if ConnectionString is 901 set. 902 </p> 903 </td> 904 </tr> 905 </tbody> 906 </table> 907 <h3 id="argoproj.io/v1alpha1.BitbucketAuth"> 908 BitbucketAuth 909 </h3> 910 <p> 911 (<em>Appears on:</em> 912 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>) 913 </p> 914 <p> 915 <p> 916 BitbucketAuth holds the different auth strategies for connecting to 917 Bitbucket 918 </p> 919 </p> 920 <table> 921 <thead> 922 <tr> 923 <th> 924 Field 925 </th> 926 <th> 927 Description 928 </th> 929 </tr> 930 </thead> 931 <tbody> 932 <tr> 933 <td> 934 <code>basic</code></br> <em> 935 <a href="#argoproj.io/v1alpha1.BitbucketBasicAuth"> BitbucketBasicAuth 936 </a> </em> 937 </td> 938 <td> 939 <em>(Optional)</em> 940 <p> 941 Basic is BasicAuth auth strategy. 942 </p> 943 </td> 944 </tr> 945 <tr> 946 <td> 947 <code>oauthToken</code></br> <em> 948 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 949 Kubernetes core/v1.SecretKeySelector </a> </em> 950 </td> 951 <td> 952 <em>(Optional)</em> 953 <p> 954 OAuthToken refers to the K8s secret that holds the OAuth Bearer token. 955 </p> 956 </td> 957 </tr> 958 </tbody> 959 </table> 960 <h3 id="argoproj.io/v1alpha1.BitbucketBasicAuth"> 961 BitbucketBasicAuth 962 </h3> 963 <p> 964 (<em>Appears on:</em> 965 <a href="#argoproj.io/v1alpha1.BitbucketAuth">BitbucketAuth</a>) 966 </p> 967 <p> 968 <p> 969 BasicAuth holds the information required to authenticate user via basic 970 auth mechanism 971 </p> 972 </p> 973 <table> 974 <thead> 975 <tr> 976 <th> 977 Field 978 </th> 979 <th> 980 Description 981 </th> 982 </tr> 983 </thead> 984 <tbody> 985 <tr> 986 <td> 987 <code>username</code></br> <em> 988 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 989 Kubernetes core/v1.SecretKeySelector </a> </em> 990 </td> 991 <td> 992 <p> 993 Username refers to the K8s secret that holds the username. 994 </p> 995 </td> 996 </tr> 997 <tr> 998 <td> 999 <code>password</code></br> <em> 1000 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1001 Kubernetes core/v1.SecretKeySelector </a> </em> 1002 </td> 1003 <td> 1004 <p> 1005 Password refers to the K8s secret that holds the password. 1006 </p> 1007 </td> 1008 </tr> 1009 </tbody> 1010 </table> 1011 <h3 id="argoproj.io/v1alpha1.BitbucketEventSource"> 1012 BitbucketEventSource 1013 </h3> 1014 <p> 1015 (<em>Appears on:</em> 1016 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1017 </p> 1018 <p> 1019 <p> 1020 BitbucketEventSource describes the event source for Bitbucket 1021 </p> 1022 </p> 1023 <table> 1024 <thead> 1025 <tr> 1026 <th> 1027 Field 1028 </th> 1029 <th> 1030 Description 1031 </th> 1032 </tr> 1033 </thead> 1034 <tbody> 1035 <tr> 1036 <td> 1037 <code>deleteHookOnFinish</code></br> <em> bool </em> 1038 </td> 1039 <td> 1040 <em>(Optional)</em> 1041 <p> 1042 DeleteHookOnFinish determines whether to delete the defined Bitbucket 1043 hook once the event source is stopped. 1044 </p> 1045 </td> 1046 </tr> 1047 <tr> 1048 <td> 1049 <code>metadata</code></br> <em> map\[string\]string </em> 1050 </td> 1051 <td> 1052 <em>(Optional)</em> 1053 <p> 1054 Metadata holds the user defined metadata which will be passed along the 1055 event payload. 1056 </p> 1057 </td> 1058 </tr> 1059 <tr> 1060 <td> 1061 <code>webhook</code></br> <em> 1062 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 1063 </em> 1064 </td> 1065 <td> 1066 <p> 1067 Webhook refers to the configuration required to run an http server 1068 </p> 1069 </td> 1070 </tr> 1071 <tr> 1072 <td> 1073 <code>auth</code></br> <em> 1074 <a href="#argoproj.io/v1alpha1.BitbucketAuth"> BitbucketAuth </a> </em> 1075 </td> 1076 <td> 1077 <p> 1078 Auth information required to connect to Bitbucket. 1079 </p> 1080 </td> 1081 </tr> 1082 <tr> 1083 <td> 1084 <code>events</code></br> <em> \[\]string </em> 1085 </td> 1086 <td> 1087 <p> 1088 Events this webhook is subscribed to. 1089 </p> 1090 </td> 1091 </tr> 1092 <tr> 1093 <td> 1094 <code>owner</code></br> <em> string </em> 1095 </td> 1096 <td> 1097 <em>(Optional)</em> 1098 <p> 1099 DeprecatedOwner is the owner of the repository. Deprecated: use 1100 Repositories instead. Will be unsupported in v1.9 1101 </p> 1102 </td> 1103 </tr> 1104 <tr> 1105 <td> 1106 <code>projectKey</code></br> <em> string </em> 1107 </td> 1108 <td> 1109 <em>(Optional)</em> 1110 <p> 1111 DeprecatedProjectKey is the key of the project to which the repository 1112 relates Deprecated: use Repositories instead. Will be unsupported in 1113 v1.9 1114 </p> 1115 </td> 1116 </tr> 1117 <tr> 1118 <td> 1119 <code>repositorySlug</code></br> <em> string </em> 1120 </td> 1121 <td> 1122 <em>(Optional)</em> 1123 <p> 1124 DeprecatedRepositorySlug is a URL-friendly version of a repository name, 1125 automatically generated by Bitbucket for use in the URL Deprecated: use 1126 Repositories instead. Will be unsupported in v1.9 1127 </p> 1128 </td> 1129 </tr> 1130 <tr> 1131 <td> 1132 <code>repositories</code></br> <em> 1133 <a href="#argoproj.io/v1alpha1.BitbucketRepository"> 1134 \[\]BitbucketRepository </a> </em> 1135 </td> 1136 <td> 1137 <em>(Optional)</em> 1138 <p> 1139 Repositories holds a list of repositories for which integration needs to 1140 set up 1141 </p> 1142 </td> 1143 </tr> 1144 <tr> 1145 <td> 1146 <code>filter</code></br> <em> 1147 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 1148 </a> </em> 1149 </td> 1150 <td> 1151 <em>(Optional)</em> 1152 <p> 1153 Filter 1154 </p> 1155 </td> 1156 </tr> 1157 </tbody> 1158 </table> 1159 <h3 id="argoproj.io/v1alpha1.BitbucketRepository"> 1160 BitbucketRepository 1161 </h3> 1162 <p> 1163 (<em>Appears on:</em> 1164 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>) 1165 </p> 1166 <p> 1167 </p> 1168 <table> 1169 <thead> 1170 <tr> 1171 <th> 1172 Field 1173 </th> 1174 <th> 1175 Description 1176 </th> 1177 </tr> 1178 </thead> 1179 <tbody> 1180 <tr> 1181 <td> 1182 <code>owner</code></br> <em> string </em> 1183 </td> 1184 <td> 1185 <p> 1186 Owner is the owner of the repository 1187 </p> 1188 </td> 1189 </tr> 1190 <tr> 1191 <td> 1192 <code>repositorySlug</code></br> <em> string </em> 1193 </td> 1194 <td> 1195 <p> 1196 RepositorySlug is a URL-friendly version of a repository name, 1197 automatically generated by Bitbucket for use in the URL 1198 </p> 1199 </td> 1200 </tr> 1201 </tbody> 1202 </table> 1203 <h3 id="argoproj.io/v1alpha1.BitbucketServerEventSource"> 1204 BitbucketServerEventSource 1205 </h3> 1206 <p> 1207 (<em>Appears on:</em> 1208 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1209 </p> 1210 <p> 1211 <p> 1212 BitbucketServerEventSource refers to event-source related to Bitbucket 1213 Server events 1214 </p> 1215 </p> 1216 <table> 1217 <thead> 1218 <tr> 1219 <th> 1220 Field 1221 </th> 1222 <th> 1223 Description 1224 </th> 1225 </tr> 1226 </thead> 1227 <tbody> 1228 <tr> 1229 <td> 1230 <code>webhook</code></br> <em> 1231 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 1232 </em> 1233 </td> 1234 <td> 1235 <p> 1236 Webhook holds configuration to run a http server 1237 </p> 1238 </td> 1239 </tr> 1240 <tr> 1241 <td> 1242 <code>projectKey</code></br> <em> string </em> 1243 </td> 1244 <td> 1245 <em>(Optional)</em> 1246 <p> 1247 DeprecatedProjectKey is the key of project for which integration needs 1248 to set up Deprecated: use Repositories instead. Will be unsupported in 1249 v1.8 1250 </p> 1251 </td> 1252 </tr> 1253 <tr> 1254 <td> 1255 <code>repositorySlug</code></br> <em> string </em> 1256 </td> 1257 <td> 1258 <em>(Optional)</em> 1259 <p> 1260 DeprecatedRepositorySlug is the slug of the repository for which 1261 integration needs to set up Deprecated: use Repositories instead. Will 1262 be unsupported in v1.8 1263 </p> 1264 </td> 1265 </tr> 1266 <tr> 1267 <td> 1268 <code>repositories</code></br> <em> 1269 <a href="#argoproj.io/v1alpha1.BitbucketServerRepository"> 1270 \[\]BitbucketServerRepository </a> </em> 1271 </td> 1272 <td> 1273 <em>(Optional)</em> 1274 <p> 1275 Repositories holds a list of repositories for which integration needs to 1276 set up 1277 </p> 1278 </td> 1279 </tr> 1280 <tr> 1281 <td> 1282 <code>events</code></br> <em> \[\]string </em> 1283 </td> 1284 <td> 1285 <p> 1286 Events are bitbucket event to listen to. Refer 1287 <a href="https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html">https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html</a> 1288 </p> 1289 </td> 1290 </tr> 1291 <tr> 1292 <td> 1293 <code>accessToken</code></br> <em> 1294 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1295 Kubernetes core/v1.SecretKeySelector </a> </em> 1296 </td> 1297 <td> 1298 <p> 1299 AccessToken is reference to K8s secret which holds the bitbucket api 1300 access information 1301 </p> 1302 </td> 1303 </tr> 1304 <tr> 1305 <td> 1306 <code>webhookSecret</code></br> <em> 1307 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1308 Kubernetes core/v1.SecretKeySelector </a> </em> 1309 </td> 1310 <td> 1311 <p> 1312 WebhookSecret is reference to K8s secret which holds the bitbucket 1313 webhook secret (for HMAC validation) 1314 </p> 1315 </td> 1316 </tr> 1317 <tr> 1318 <td> 1319 <code>bitbucketserverBaseURL</code></br> <em> string </em> 1320 </td> 1321 <td> 1322 <p> 1323 BitbucketServerBaseURL is the base URL for API requests to a custom 1324 endpoint 1325 </p> 1326 </td> 1327 </tr> 1328 <tr> 1329 <td> 1330 <code>deleteHookOnFinish</code></br> <em> bool </em> 1331 </td> 1332 <td> 1333 <em>(Optional)</em> 1334 <p> 1335 DeleteHookOnFinish determines whether to delete the Bitbucket Server 1336 hook for the project once the event source is stopped. 1337 </p> 1338 </td> 1339 </tr> 1340 <tr> 1341 <td> 1342 <code>metadata</code></br> <em> map\[string\]string </em> 1343 </td> 1344 <td> 1345 <em>(Optional)</em> 1346 <p> 1347 Metadata holds the user defined metadata which will passed along the 1348 event payload. 1349 </p> 1350 </td> 1351 </tr> 1352 <tr> 1353 <td> 1354 <code>filter</code></br> <em> 1355 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 1356 </a> </em> 1357 </td> 1358 <td> 1359 <em>(Optional)</em> 1360 <p> 1361 Filter 1362 </p> 1363 </td> 1364 </tr> 1365 <tr> 1366 <td> 1367 <code>tls</code></br> <em> 1368 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 1369 </td> 1370 <td> 1371 <em>(Optional)</em> 1372 <p> 1373 TLS configuration for the bitbucketserver client. 1374 </p> 1375 </td> 1376 </tr> 1377 </tbody> 1378 </table> 1379 <h3 id="argoproj.io/v1alpha1.BitbucketServerRepository"> 1380 BitbucketServerRepository 1381 </h3> 1382 <p> 1383 (<em>Appears on:</em> 1384 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>) 1385 </p> 1386 <p> 1387 </p> 1388 <table> 1389 <thead> 1390 <tr> 1391 <th> 1392 Field 1393 </th> 1394 <th> 1395 Description 1396 </th> 1397 </tr> 1398 </thead> 1399 <tbody> 1400 <tr> 1401 <td> 1402 <code>projectKey</code></br> <em> string </em> 1403 </td> 1404 <td> 1405 <p> 1406 ProjectKey is the key of project for which integration needs to set up 1407 </p> 1408 </td> 1409 </tr> 1410 <tr> 1411 <td> 1412 <code>repositorySlug</code></br> <em> string </em> 1413 </td> 1414 <td> 1415 <p> 1416 RepositorySlug is the slug of the repository for which integration needs 1417 to set up 1418 </p> 1419 </td> 1420 </tr> 1421 </tbody> 1422 </table> 1423 <h3 id="argoproj.io/v1alpha1.CalendarEventSource"> 1424 CalendarEventSource 1425 </h3> 1426 <p> 1427 (<em>Appears on:</em> 1428 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1429 </p> 1430 <p> 1431 <p> 1432 CalendarEventSource describes a time based dependency. One of the fields 1433 (schedule, interval, or recurrence) must be passed. Schedule takes 1434 precedence over interval; interval takes precedence over recurrence 1435 </p> 1436 </p> 1437 <table> 1438 <thead> 1439 <tr> 1440 <th> 1441 Field 1442 </th> 1443 <th> 1444 Description 1445 </th> 1446 </tr> 1447 </thead> 1448 <tbody> 1449 <tr> 1450 <td> 1451 <code>schedule</code></br> <em> string </em> 1452 </td> 1453 <td> 1454 <em>(Optional)</em> 1455 <p> 1456 Schedule is a cron-like expression. For reference, see: 1457 <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a> 1458 </p> 1459 </td> 1460 </tr> 1461 <tr> 1462 <td> 1463 <code>interval</code></br> <em> string </em> 1464 </td> 1465 <td> 1466 <em>(Optional)</em> 1467 <p> 1468 Interval is a string that describes an interval duration, e.g. 1s, 30m, 1469 2h… 1470 </p> 1471 </td> 1472 </tr> 1473 <tr> 1474 <td> 1475 <code>exclusionDates</code></br> <em> \[\]string </em> 1476 </td> 1477 <td> 1478 <p> 1479 ExclusionDates defines the list of DATE-TIME exceptions for recurring 1480 events. 1481 </p> 1482 </td> 1483 </tr> 1484 <tr> 1485 <td> 1486 <code>timezone</code></br> <em> string </em> 1487 </td> 1488 <td> 1489 <em>(Optional)</em> 1490 <p> 1491 Timezone in which to run the schedule 1492 </p> 1493 </td> 1494 </tr> 1495 <tr> 1496 <td> 1497 <code>metadata</code></br> <em> map\[string\]string </em> 1498 </td> 1499 <td> 1500 <em>(Optional)</em> 1501 <p> 1502 Metadata holds the user defined metadata which will passed along the 1503 event payload. 1504 </p> 1505 </td> 1506 </tr> 1507 <tr> 1508 <td> 1509 <code>persistence</code></br> <em> 1510 <a href="#argoproj.io/v1alpha1.EventPersistence"> EventPersistence </a> 1511 </em> 1512 </td> 1513 <td> 1514 <p> 1515 Persistence hold the configuration for event persistence 1516 </p> 1517 </td> 1518 </tr> 1519 <tr> 1520 <td> 1521 <code>filter</code></br> <em> 1522 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 1523 </a> </em> 1524 </td> 1525 <td> 1526 <em>(Optional)</em> 1527 <p> 1528 Filter 1529 </p> 1530 </td> 1531 </tr> 1532 </tbody> 1533 </table> 1534 <h3 id="argoproj.io/v1alpha1.CatchupConfiguration"> 1535 CatchupConfiguration 1536 </h3> 1537 <p> 1538 (<em>Appears on:</em> 1539 <a href="#argoproj.io/v1alpha1.EventPersistence">EventPersistence</a>) 1540 </p> 1541 <p> 1542 </p> 1543 <table> 1544 <thead> 1545 <tr> 1546 <th> 1547 Field 1548 </th> 1549 <th> 1550 Description 1551 </th> 1552 </tr> 1553 </thead> 1554 <tbody> 1555 <tr> 1556 <td> 1557 <code>enabled</code></br> <em> bool </em> 1558 </td> 1559 <td> 1560 <p> 1561 Enabled enables to triggered the missed schedule when eventsource 1562 restarts 1563 </p> 1564 </td> 1565 </tr> 1566 <tr> 1567 <td> 1568 <code>maxDuration</code></br> <em> string </em> 1569 </td> 1570 <td> 1571 <p> 1572 MaxDuration holds max catchup duration 1573 </p> 1574 </td> 1575 </tr> 1576 </tbody> 1577 </table> 1578 <h3 id="argoproj.io/v1alpha1.ConfigMapPersistence"> 1579 ConfigMapPersistence 1580 </h3> 1581 <p> 1582 (<em>Appears on:</em> 1583 <a href="#argoproj.io/v1alpha1.EventPersistence">EventPersistence</a>) 1584 </p> 1585 <p> 1586 </p> 1587 <table> 1588 <thead> 1589 <tr> 1590 <th> 1591 Field 1592 </th> 1593 <th> 1594 Description 1595 </th> 1596 </tr> 1597 </thead> 1598 <tbody> 1599 <tr> 1600 <td> 1601 <code>name</code></br> <em> string </em> 1602 </td> 1603 <td> 1604 <p> 1605 Name of the configmap 1606 </p> 1607 </td> 1608 </tr> 1609 <tr> 1610 <td> 1611 <code>createIfNotExist</code></br> <em> bool </em> 1612 </td> 1613 <td> 1614 <p> 1615 CreateIfNotExist will create configmap if it doesn’t exists 1616 </p> 1617 </td> 1618 </tr> 1619 </tbody> 1620 </table> 1621 <h3 id="argoproj.io/v1alpha1.EmitterEventSource"> 1622 EmitterEventSource 1623 </h3> 1624 <p> 1625 (<em>Appears on:</em> 1626 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1627 </p> 1628 <p> 1629 <p> 1630 EmitterEventSource describes the event source for emitter More info at 1631 <a href="https://emitter.io/develop/getting-started/">https://emitter.io/develop/getting-started/</a> 1632 </p> 1633 </p> 1634 <table> 1635 <thead> 1636 <tr> 1637 <th> 1638 Field 1639 </th> 1640 <th> 1641 Description 1642 </th> 1643 </tr> 1644 </thead> 1645 <tbody> 1646 <tr> 1647 <td> 1648 <code>broker</code></br> <em> string </em> 1649 </td> 1650 <td> 1651 <p> 1652 Broker URI to connect to. 1653 </p> 1654 </td> 1655 </tr> 1656 <tr> 1657 <td> 1658 <code>channelKey</code></br> <em> string </em> 1659 </td> 1660 <td> 1661 <p> 1662 ChannelKey refers to the channel key 1663 </p> 1664 </td> 1665 </tr> 1666 <tr> 1667 <td> 1668 <code>channelName</code></br> <em> string </em> 1669 </td> 1670 <td> 1671 <p> 1672 ChannelName refers to the channel name 1673 </p> 1674 </td> 1675 </tr> 1676 <tr> 1677 <td> 1678 <code>username</code></br> <em> 1679 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1680 Kubernetes core/v1.SecretKeySelector </a> </em> 1681 </td> 1682 <td> 1683 <em>(Optional)</em> 1684 <p> 1685 Username to use to connect to broker 1686 </p> 1687 </td> 1688 </tr> 1689 <tr> 1690 <td> 1691 <code>password</code></br> <em> 1692 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1693 Kubernetes core/v1.SecretKeySelector </a> </em> 1694 </td> 1695 <td> 1696 <em>(Optional)</em> 1697 <p> 1698 Password to use to connect to broker 1699 </p> 1700 </td> 1701 </tr> 1702 <tr> 1703 <td> 1704 <code>connectionBackoff</code></br> <em> 1705 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 1706 </td> 1707 <td> 1708 <em>(Optional)</em> 1709 <p> 1710 Backoff holds parameters applied to connection. 1711 </p> 1712 </td> 1713 </tr> 1714 <tr> 1715 <td> 1716 <code>jsonBody</code></br> <em> bool </em> 1717 </td> 1718 <td> 1719 <em>(Optional)</em> 1720 <p> 1721 JSONBody specifies that all event body payload coming from this source 1722 will be JSON 1723 </p> 1724 </td> 1725 </tr> 1726 <tr> 1727 <td> 1728 <code>tls</code></br> <em> 1729 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 1730 </td> 1731 <td> 1732 <em>(Optional)</em> 1733 <p> 1734 TLS configuration for the emitter client. 1735 </p> 1736 </td> 1737 </tr> 1738 <tr> 1739 <td> 1740 <code>metadata</code></br> <em> map\[string\]string </em> 1741 </td> 1742 <td> 1743 <em>(Optional)</em> 1744 <p> 1745 Metadata holds the user defined metadata which will passed along the 1746 event payload. 1747 </p> 1748 </td> 1749 </tr> 1750 <tr> 1751 <td> 1752 <code>filter</code></br> <em> 1753 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 1754 </a> </em> 1755 </td> 1756 <td> 1757 <em>(Optional)</em> 1758 <p> 1759 Filter 1760 </p> 1761 </td> 1762 </tr> 1763 </tbody> 1764 </table> 1765 <h3 id="argoproj.io/v1alpha1.EventPersistence"> 1766 EventPersistence 1767 </h3> 1768 <p> 1769 (<em>Appears on:</em> 1770 <a href="#argoproj.io/v1alpha1.CalendarEventSource">CalendarEventSource</a>) 1771 </p> 1772 <p> 1773 </p> 1774 <table> 1775 <thead> 1776 <tr> 1777 <th> 1778 Field 1779 </th> 1780 <th> 1781 Description 1782 </th> 1783 </tr> 1784 </thead> 1785 <tbody> 1786 <tr> 1787 <td> 1788 <code>catchup</code></br> <em> 1789 <a href="#argoproj.io/v1alpha1.CatchupConfiguration"> 1790 CatchupConfiguration </a> </em> 1791 </td> 1792 <td> 1793 <p> 1794 Catchup enables to triggered the missed schedule when eventsource 1795 restarts 1796 </p> 1797 </td> 1798 </tr> 1799 <tr> 1800 <td> 1801 <code>configMap</code></br> <em> 1802 <a href="#argoproj.io/v1alpha1.ConfigMapPersistence"> 1803 ConfigMapPersistence </a> </em> 1804 </td> 1805 <td> 1806 <p> 1807 ConfigMap holds configmap details for persistence 1808 </p> 1809 </td> 1810 </tr> 1811 </tbody> 1812 </table> 1813 <h3 id="argoproj.io/v1alpha1.EventSource"> 1814 EventSource 1815 </h3> 1816 <p> 1817 <p> 1818 EventSource is the definition of a eventsource resource 1819 </p> 1820 </p> 1821 <table> 1822 <thead> 1823 <tr> 1824 <th> 1825 Field 1826 </th> 1827 <th> 1828 Description 1829 </th> 1830 </tr> 1831 </thead> 1832 <tbody> 1833 <tr> 1834 <td> 1835 <code>metadata</code></br> <em> 1836 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 1837 Kubernetes meta/v1.ObjectMeta </a> </em> 1838 </td> 1839 <td> 1840 Refer to the Kubernetes API documentation for the fields of the 1841 <code>metadata</code> field. 1842 </td> 1843 </tr> 1844 <tr> 1845 <td> 1846 <code>spec</code></br> <em> 1847 <a href="#argoproj.io/v1alpha1.EventSourceSpec"> EventSourceSpec </a> 1848 </em> 1849 </td> 1850 <td> 1851 <br/> <br/> 1852 <table> 1853 <tr> 1854 <td> 1855 <code>eventBusName</code></br> <em> string </em> 1856 </td> 1857 <td> 1858 <p> 1859 EventBusName references to a EventBus name. By default the value is 1860 “default” 1861 </p> 1862 </td> 1863 </tr> 1864 <tr> 1865 <td> 1866 <code>template</code></br> <em> 1867 <a href="#argoproj.io/v1alpha1.Template"> Template </a> </em> 1868 </td> 1869 <td> 1870 <em>(Optional)</em> 1871 <p> 1872 Template is the pod specification for the event source 1873 </p> 1874 </td> 1875 </tr> 1876 <tr> 1877 <td> 1878 <code>service</code></br> <em> <a href="#argoproj.io/v1alpha1.Service"> 1879 Service </a> </em> 1880 </td> 1881 <td> 1882 <em>(Optional)</em> 1883 <p> 1884 Service is the specifications of the service to expose the event source 1885 </p> 1886 </td> 1887 </tr> 1888 <tr> 1889 <td> 1890 <code>minio</code></br> <em> 1891 map\[string\]github.com/argoproj/argo-events/pkg/apis/common.S3Artifact 1892 </em> 1893 </td> 1894 <td> 1895 <p> 1896 Minio event sources 1897 </p> 1898 </td> 1899 </tr> 1900 <tr> 1901 <td> 1902 <code>calendar</code></br> <em> 1903 <a href="#argoproj.io/v1alpha1.CalendarEventSource"> 1904 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.CalendarEventSource 1905 </a> </em> 1906 </td> 1907 <td> 1908 <p> 1909 Calendar event sources 1910 </p> 1911 </td> 1912 </tr> 1913 <tr> 1914 <td> 1915 <code>file</code></br> <em> 1916 <a href="#argoproj.io/v1alpha1.FileEventSource"> 1917 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.FileEventSource 1918 </a> </em> 1919 </td> 1920 <td> 1921 <p> 1922 File event sources 1923 </p> 1924 </td> 1925 </tr> 1926 <tr> 1927 <td> 1928 <code>resource</code></br> <em> 1929 <a href="#argoproj.io/v1alpha1.ResourceEventSource"> 1930 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.ResourceEventSource 1931 </a> </em> 1932 </td> 1933 <td> 1934 <p> 1935 Resource event sources 1936 </p> 1937 </td> 1938 </tr> 1939 <tr> 1940 <td> 1941 <code>webhook</code></br> <em> 1942 <a href="#argoproj.io/v1alpha1.WebhookEventSource"> 1943 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.WebhookEventSource 1944 </a> </em> 1945 </td> 1946 <td> 1947 <p> 1948 Webhook event sources 1949 </p> 1950 </td> 1951 </tr> 1952 <tr> 1953 <td> 1954 <code>amqp</code></br> <em> 1955 <a href="#argoproj.io/v1alpha1.AMQPEventSource"> 1956 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AMQPEventSource 1957 </a> </em> 1958 </td> 1959 <td> 1960 <p> 1961 AMQP event sources 1962 </p> 1963 </td> 1964 </tr> 1965 <tr> 1966 <td> 1967 <code>kafka</code></br> <em> 1968 <a href="#argoproj.io/v1alpha1.KafkaEventSource"> 1969 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.KafkaEventSource 1970 </a> </em> 1971 </td> 1972 <td> 1973 <p> 1974 Kafka event sources 1975 </p> 1976 </td> 1977 </tr> 1978 <tr> 1979 <td> 1980 <code>mqtt</code></br> <em> 1981 <a href="#argoproj.io/v1alpha1.MQTTEventSource"> 1982 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.MQTTEventSource 1983 </a> </em> 1984 </td> 1985 <td> 1986 <p> 1987 MQTT event sources 1988 </p> 1989 </td> 1990 </tr> 1991 <tr> 1992 <td> 1993 <code>nats</code></br> <em> 1994 <a href="#argoproj.io/v1alpha1.NATSEventsSource"> 1995 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NATSEventsSource 1996 </a> </em> 1997 </td> 1998 <td> 1999 <p> 2000 NATS event sources 2001 </p> 2002 </td> 2003 </tr> 2004 <tr> 2005 <td> 2006 <code>sns</code></br> <em> 2007 <a href="#argoproj.io/v1alpha1.SNSEventSource"> 2008 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SNSEventSource 2009 </a> </em> 2010 </td> 2011 <td> 2012 <p> 2013 SNS event sources 2014 </p> 2015 </td> 2016 </tr> 2017 <tr> 2018 <td> 2019 <code>sqs</code></br> <em> 2020 <a href="#argoproj.io/v1alpha1.SQSEventSource"> 2021 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SQSEventSource 2022 </a> </em> 2023 </td> 2024 <td> 2025 <p> 2026 SQS event sources 2027 </p> 2028 </td> 2029 </tr> 2030 <tr> 2031 <td> 2032 <code>pubSub</code></br> <em> 2033 <a href="#argoproj.io/v1alpha1.PubSubEventSource"> 2034 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PubSubEventSource 2035 </a> </em> 2036 </td> 2037 <td> 2038 <p> 2039 PubSub event sources 2040 </p> 2041 </td> 2042 </tr> 2043 <tr> 2044 <td> 2045 <code>github</code></br> <em> 2046 <a href="#argoproj.io/v1alpha1.GithubEventSource"> 2047 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GithubEventSource 2048 </a> </em> 2049 </td> 2050 <td> 2051 <p> 2052 Github event sources 2053 </p> 2054 </td> 2055 </tr> 2056 <tr> 2057 <td> 2058 <code>gitlab</code></br> <em> 2059 <a href="#argoproj.io/v1alpha1.GitlabEventSource"> 2060 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GitlabEventSource 2061 </a> </em> 2062 </td> 2063 <td> 2064 <p> 2065 Gitlab event sources 2066 </p> 2067 </td> 2068 </tr> 2069 <tr> 2070 <td> 2071 <code>hdfs</code></br> <em> 2072 <a href="#argoproj.io/v1alpha1.HDFSEventSource"> 2073 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.HDFSEventSource 2074 </a> </em> 2075 </td> 2076 <td> 2077 <p> 2078 HDFS event sources 2079 </p> 2080 </td> 2081 </tr> 2082 <tr> 2083 <td> 2084 <code>slack</code></br> <em> 2085 <a href="#argoproj.io/v1alpha1.SlackEventSource"> 2086 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SlackEventSource 2087 </a> </em> 2088 </td> 2089 <td> 2090 <p> 2091 Slack event sources 2092 </p> 2093 </td> 2094 </tr> 2095 <tr> 2096 <td> 2097 <code>storageGrid</code></br> <em> 2098 <a href="#argoproj.io/v1alpha1.StorageGridEventSource"> 2099 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StorageGridEventSource 2100 </a> </em> 2101 </td> 2102 <td> 2103 <p> 2104 StorageGrid event sources 2105 </p> 2106 </td> 2107 </tr> 2108 <tr> 2109 <td> 2110 <code>azureEventsHub</code></br> <em> 2111 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource"> 2112 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureEventsHubEventSource 2113 </a> </em> 2114 </td> 2115 <td> 2116 <p> 2117 AzureEventsHub event sources 2118 </p> 2119 </td> 2120 </tr> 2121 <tr> 2122 <td> 2123 <code>stripe</code></br> <em> 2124 <a href="#argoproj.io/v1alpha1.StripeEventSource"> 2125 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StripeEventSource 2126 </a> </em> 2127 </td> 2128 <td> 2129 <p> 2130 Stripe event sources 2131 </p> 2132 </td> 2133 </tr> 2134 <tr> 2135 <td> 2136 <code>emitter</code></br> <em> 2137 <a href="#argoproj.io/v1alpha1.EmitterEventSource"> 2138 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.EmitterEventSource 2139 </a> </em> 2140 </td> 2141 <td> 2142 <p> 2143 Emitter event source 2144 </p> 2145 </td> 2146 </tr> 2147 <tr> 2148 <td> 2149 <code>redis</code></br> <em> 2150 <a href="#argoproj.io/v1alpha1.RedisEventSource"> 2151 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisEventSource 2152 </a> </em> 2153 </td> 2154 <td> 2155 <p> 2156 Redis event source 2157 </p> 2158 </td> 2159 </tr> 2160 <tr> 2161 <td> 2162 <code>nsq</code></br> <em> 2163 <a href="#argoproj.io/v1alpha1.NSQEventSource"> 2164 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NSQEventSource 2165 </a> </em> 2166 </td> 2167 <td> 2168 <p> 2169 NSQ event source 2170 </p> 2171 </td> 2172 </tr> 2173 <tr> 2174 <td> 2175 <code>pulsar</code></br> <em> 2176 <a href="#argoproj.io/v1alpha1.PulsarEventSource"> 2177 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PulsarEventSource 2178 </a> </em> 2179 </td> 2180 <td> 2181 <p> 2182 Pulsar event source 2183 </p> 2184 </td> 2185 </tr> 2186 <tr> 2187 <td> 2188 <code>generic</code></br> <em> 2189 <a href="#argoproj.io/v1alpha1.GenericEventSource"> 2190 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GenericEventSource 2191 </a> </em> 2192 </td> 2193 <td> 2194 <p> 2195 Generic event source 2196 </p> 2197 </td> 2198 </tr> 2199 <tr> 2200 <td> 2201 <code>replicas</code></br> <em> int32 </em> 2202 </td> 2203 <td> 2204 <p> 2205 Replicas is the event source deployment replicas 2206 </p> 2207 </td> 2208 </tr> 2209 <tr> 2210 <td> 2211 <code>bitbucketserver</code></br> <em> 2212 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource"> 2213 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketServerEventSource 2214 </a> </em> 2215 </td> 2216 <td> 2217 <p> 2218 Bitbucket Server event sources 2219 </p> 2220 </td> 2221 </tr> 2222 <tr> 2223 <td> 2224 <code>bitbucket</code></br> <em> 2225 <a href="#argoproj.io/v1alpha1.BitbucketEventSource"> 2226 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketEventSource 2227 </a> </em> 2228 </td> 2229 <td> 2230 <p> 2231 Bitbucket event sources 2232 </p> 2233 </td> 2234 </tr> 2235 <tr> 2236 <td> 2237 <code>redisStream</code></br> <em> 2238 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource"> 2239 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisStreamEventSource 2240 </a> </em> 2241 </td> 2242 <td> 2243 <p> 2244 Redis stream source 2245 </p> 2246 </td> 2247 </tr> 2248 <tr> 2249 <td> 2250 <code>azureServiceBus</code></br> <em> 2251 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource"> 2252 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureServiceBusEventSource 2253 </a> </em> 2254 </td> 2255 <td> 2256 <p> 2257 Azure Service Bus event source 2258 </p> 2259 </td> 2260 </tr> 2261 <tr> 2262 <td> 2263 <code>azureQueueStorage</code></br> <em> 2264 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource"> 2265 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureQueueStorageEventSource 2266 </a> </em> 2267 </td> 2268 <td> 2269 <p> 2270 AzureQueueStorage event source 2271 </p> 2272 </td> 2273 </tr> 2274 <tr> 2275 <td> 2276 <code>sftp</code></br> <em> 2277 <a href="#argoproj.io/v1alpha1.SFTPEventSource"> 2278 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SFTPEventSource 2279 </a> </em> 2280 </td> 2281 <td> 2282 <p> 2283 SFTP event sources 2284 </p> 2285 </td> 2286 </tr> 2287 <tr> 2288 <td> 2289 <code>gerrit</code></br> <em> 2290 <a href="#argoproj.io/v1alpha1.GerritEventSource"> 2291 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GerritEventSource 2292 </a> </em> 2293 </td> 2294 <td> 2295 <p> 2296 Gerrit event source 2297 </p> 2298 </td> 2299 </tr> 2300 </table> 2301 </td> 2302 </tr> 2303 <tr> 2304 <td> 2305 <code>status</code></br> <em> 2306 <a href="#argoproj.io/v1alpha1.EventSourceStatus"> EventSourceStatus 2307 </a> </em> 2308 </td> 2309 <td> 2310 <em>(Optional)</em> 2311 </td> 2312 </tr> 2313 </tbody> 2314 </table> 2315 <h3 id="argoproj.io/v1alpha1.EventSourceFilter"> 2316 EventSourceFilter 2317 </h3> 2318 <p> 2319 (<em>Appears on:</em> 2320 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>, 2321 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource">AzureEventsHubEventSource</a>, 2322 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource">AzureQueueStorageEventSource</a>, 2323 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource">AzureServiceBusEventSource</a>, 2324 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>, 2325 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>, 2326 <a href="#argoproj.io/v1alpha1.CalendarEventSource">CalendarEventSource</a>, 2327 <a href="#argoproj.io/v1alpha1.EmitterEventSource">EmitterEventSource</a>, 2328 <a href="#argoproj.io/v1alpha1.FileEventSource">FileEventSource</a>, 2329 <a href="#argoproj.io/v1alpha1.GenericEventSource">GenericEventSource</a>, 2330 <a href="#argoproj.io/v1alpha1.GerritEventSource">GerritEventSource</a>, 2331 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>, 2332 <a href="#argoproj.io/v1alpha1.GitlabEventSource">GitlabEventSource</a>, 2333 <a href="#argoproj.io/v1alpha1.HDFSEventSource">HDFSEventSource</a>, 2334 <a href="#argoproj.io/v1alpha1.KafkaEventSource">KafkaEventSource</a>, 2335 <a href="#argoproj.io/v1alpha1.MQTTEventSource">MQTTEventSource</a>, 2336 <a href="#argoproj.io/v1alpha1.NATSEventsSource">NATSEventsSource</a>, 2337 <a href="#argoproj.io/v1alpha1.NSQEventSource">NSQEventSource</a>, 2338 <a href="#argoproj.io/v1alpha1.PubSubEventSource">PubSubEventSource</a>, 2339 <a href="#argoproj.io/v1alpha1.PulsarEventSource">PulsarEventSource</a>, 2340 <a href="#argoproj.io/v1alpha1.RedisEventSource">RedisEventSource</a>, 2341 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource">RedisStreamEventSource</a>, 2342 <a href="#argoproj.io/v1alpha1.SFTPEventSource">SFTPEventSource</a>, 2343 <a href="#argoproj.io/v1alpha1.SNSEventSource">SNSEventSource</a>, 2344 <a href="#argoproj.io/v1alpha1.SQSEventSource">SQSEventSource</a>, 2345 <a href="#argoproj.io/v1alpha1.SlackEventSource">SlackEventSource</a>, 2346 <a href="#argoproj.io/v1alpha1.WebhookEventSource">WebhookEventSource</a>) 2347 </p> 2348 <p> 2349 </p> 2350 <table> 2351 <thead> 2352 <tr> 2353 <th> 2354 Field 2355 </th> 2356 <th> 2357 Description 2358 </th> 2359 </tr> 2360 </thead> 2361 <tbody> 2362 <tr> 2363 <td> 2364 <code>expression</code></br> <em> string </em> 2365 </td> 2366 <td> 2367 </td> 2368 </tr> 2369 </tbody> 2370 </table> 2371 <h3 id="argoproj.io/v1alpha1.EventSourceSpec"> 2372 EventSourceSpec 2373 </h3> 2374 <p> 2375 (<em>Appears on:</em> 2376 <a href="#argoproj.io/v1alpha1.EventSource">EventSource</a>) 2377 </p> 2378 <p> 2379 <p> 2380 EventSourceSpec refers to specification of event-source resource 2381 </p> 2382 </p> 2383 <table> 2384 <thead> 2385 <tr> 2386 <th> 2387 Field 2388 </th> 2389 <th> 2390 Description 2391 </th> 2392 </tr> 2393 </thead> 2394 <tbody> 2395 <tr> 2396 <td> 2397 <code>eventBusName</code></br> <em> string </em> 2398 </td> 2399 <td> 2400 <p> 2401 EventBusName references to a EventBus name. By default the value is 2402 “default” 2403 </p> 2404 </td> 2405 </tr> 2406 <tr> 2407 <td> 2408 <code>template</code></br> <em> 2409 <a href="#argoproj.io/v1alpha1.Template"> Template </a> </em> 2410 </td> 2411 <td> 2412 <em>(Optional)</em> 2413 <p> 2414 Template is the pod specification for the event source 2415 </p> 2416 </td> 2417 </tr> 2418 <tr> 2419 <td> 2420 <code>service</code></br> <em> <a href="#argoproj.io/v1alpha1.Service"> 2421 Service </a> </em> 2422 </td> 2423 <td> 2424 <em>(Optional)</em> 2425 <p> 2426 Service is the specifications of the service to expose the event source 2427 </p> 2428 </td> 2429 </tr> 2430 <tr> 2431 <td> 2432 <code>minio</code></br> <em> 2433 map\[string\]github.com/argoproj/argo-events/pkg/apis/common.S3Artifact 2434 </em> 2435 </td> 2436 <td> 2437 <p> 2438 Minio event sources 2439 </p> 2440 </td> 2441 </tr> 2442 <tr> 2443 <td> 2444 <code>calendar</code></br> <em> 2445 <a href="#argoproj.io/v1alpha1.CalendarEventSource"> 2446 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.CalendarEventSource 2447 </a> </em> 2448 </td> 2449 <td> 2450 <p> 2451 Calendar event sources 2452 </p> 2453 </td> 2454 </tr> 2455 <tr> 2456 <td> 2457 <code>file</code></br> <em> 2458 <a href="#argoproj.io/v1alpha1.FileEventSource"> 2459 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.FileEventSource 2460 </a> </em> 2461 </td> 2462 <td> 2463 <p> 2464 File event sources 2465 </p> 2466 </td> 2467 </tr> 2468 <tr> 2469 <td> 2470 <code>resource</code></br> <em> 2471 <a href="#argoproj.io/v1alpha1.ResourceEventSource"> 2472 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.ResourceEventSource 2473 </a> </em> 2474 </td> 2475 <td> 2476 <p> 2477 Resource event sources 2478 </p> 2479 </td> 2480 </tr> 2481 <tr> 2482 <td> 2483 <code>webhook</code></br> <em> 2484 <a href="#argoproj.io/v1alpha1.WebhookEventSource"> 2485 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.WebhookEventSource 2486 </a> </em> 2487 </td> 2488 <td> 2489 <p> 2490 Webhook event sources 2491 </p> 2492 </td> 2493 </tr> 2494 <tr> 2495 <td> 2496 <code>amqp</code></br> <em> 2497 <a href="#argoproj.io/v1alpha1.AMQPEventSource"> 2498 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AMQPEventSource 2499 </a> </em> 2500 </td> 2501 <td> 2502 <p> 2503 AMQP event sources 2504 </p> 2505 </td> 2506 </tr> 2507 <tr> 2508 <td> 2509 <code>kafka</code></br> <em> 2510 <a href="#argoproj.io/v1alpha1.KafkaEventSource"> 2511 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.KafkaEventSource 2512 </a> </em> 2513 </td> 2514 <td> 2515 <p> 2516 Kafka event sources 2517 </p> 2518 </td> 2519 </tr> 2520 <tr> 2521 <td> 2522 <code>mqtt</code></br> <em> 2523 <a href="#argoproj.io/v1alpha1.MQTTEventSource"> 2524 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.MQTTEventSource 2525 </a> </em> 2526 </td> 2527 <td> 2528 <p> 2529 MQTT event sources 2530 </p> 2531 </td> 2532 </tr> 2533 <tr> 2534 <td> 2535 <code>nats</code></br> <em> 2536 <a href="#argoproj.io/v1alpha1.NATSEventsSource"> 2537 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NATSEventsSource 2538 </a> </em> 2539 </td> 2540 <td> 2541 <p> 2542 NATS event sources 2543 </p> 2544 </td> 2545 </tr> 2546 <tr> 2547 <td> 2548 <code>sns</code></br> <em> 2549 <a href="#argoproj.io/v1alpha1.SNSEventSource"> 2550 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SNSEventSource 2551 </a> </em> 2552 </td> 2553 <td> 2554 <p> 2555 SNS event sources 2556 </p> 2557 </td> 2558 </tr> 2559 <tr> 2560 <td> 2561 <code>sqs</code></br> <em> 2562 <a href="#argoproj.io/v1alpha1.SQSEventSource"> 2563 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SQSEventSource 2564 </a> </em> 2565 </td> 2566 <td> 2567 <p> 2568 SQS event sources 2569 </p> 2570 </td> 2571 </tr> 2572 <tr> 2573 <td> 2574 <code>pubSub</code></br> <em> 2575 <a href="#argoproj.io/v1alpha1.PubSubEventSource"> 2576 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PubSubEventSource 2577 </a> </em> 2578 </td> 2579 <td> 2580 <p> 2581 PubSub event sources 2582 </p> 2583 </td> 2584 </tr> 2585 <tr> 2586 <td> 2587 <code>github</code></br> <em> 2588 <a href="#argoproj.io/v1alpha1.GithubEventSource"> 2589 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GithubEventSource 2590 </a> </em> 2591 </td> 2592 <td> 2593 <p> 2594 Github event sources 2595 </p> 2596 </td> 2597 </tr> 2598 <tr> 2599 <td> 2600 <code>gitlab</code></br> <em> 2601 <a href="#argoproj.io/v1alpha1.GitlabEventSource"> 2602 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GitlabEventSource 2603 </a> </em> 2604 </td> 2605 <td> 2606 <p> 2607 Gitlab event sources 2608 </p> 2609 </td> 2610 </tr> 2611 <tr> 2612 <td> 2613 <code>hdfs</code></br> <em> 2614 <a href="#argoproj.io/v1alpha1.HDFSEventSource"> 2615 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.HDFSEventSource 2616 </a> </em> 2617 </td> 2618 <td> 2619 <p> 2620 HDFS event sources 2621 </p> 2622 </td> 2623 </tr> 2624 <tr> 2625 <td> 2626 <code>slack</code></br> <em> 2627 <a href="#argoproj.io/v1alpha1.SlackEventSource"> 2628 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SlackEventSource 2629 </a> </em> 2630 </td> 2631 <td> 2632 <p> 2633 Slack event sources 2634 </p> 2635 </td> 2636 </tr> 2637 <tr> 2638 <td> 2639 <code>storageGrid</code></br> <em> 2640 <a href="#argoproj.io/v1alpha1.StorageGridEventSource"> 2641 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StorageGridEventSource 2642 </a> </em> 2643 </td> 2644 <td> 2645 <p> 2646 StorageGrid event sources 2647 </p> 2648 </td> 2649 </tr> 2650 <tr> 2651 <td> 2652 <code>azureEventsHub</code></br> <em> 2653 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource"> 2654 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureEventsHubEventSource 2655 </a> </em> 2656 </td> 2657 <td> 2658 <p> 2659 AzureEventsHub event sources 2660 </p> 2661 </td> 2662 </tr> 2663 <tr> 2664 <td> 2665 <code>stripe</code></br> <em> 2666 <a href="#argoproj.io/v1alpha1.StripeEventSource"> 2667 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StripeEventSource 2668 </a> </em> 2669 </td> 2670 <td> 2671 <p> 2672 Stripe event sources 2673 </p> 2674 </td> 2675 </tr> 2676 <tr> 2677 <td> 2678 <code>emitter</code></br> <em> 2679 <a href="#argoproj.io/v1alpha1.EmitterEventSource"> 2680 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.EmitterEventSource 2681 </a> </em> 2682 </td> 2683 <td> 2684 <p> 2685 Emitter event source 2686 </p> 2687 </td> 2688 </tr> 2689 <tr> 2690 <td> 2691 <code>redis</code></br> <em> 2692 <a href="#argoproj.io/v1alpha1.RedisEventSource"> 2693 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisEventSource 2694 </a> </em> 2695 </td> 2696 <td> 2697 <p> 2698 Redis event source 2699 </p> 2700 </td> 2701 </tr> 2702 <tr> 2703 <td> 2704 <code>nsq</code></br> <em> 2705 <a href="#argoproj.io/v1alpha1.NSQEventSource"> 2706 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NSQEventSource 2707 </a> </em> 2708 </td> 2709 <td> 2710 <p> 2711 NSQ event source 2712 </p> 2713 </td> 2714 </tr> 2715 <tr> 2716 <td> 2717 <code>pulsar</code></br> <em> 2718 <a href="#argoproj.io/v1alpha1.PulsarEventSource"> 2719 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PulsarEventSource 2720 </a> </em> 2721 </td> 2722 <td> 2723 <p> 2724 Pulsar event source 2725 </p> 2726 </td> 2727 </tr> 2728 <tr> 2729 <td> 2730 <code>generic</code></br> <em> 2731 <a href="#argoproj.io/v1alpha1.GenericEventSource"> 2732 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GenericEventSource 2733 </a> </em> 2734 </td> 2735 <td> 2736 <p> 2737 Generic event source 2738 </p> 2739 </td> 2740 </tr> 2741 <tr> 2742 <td> 2743 <code>replicas</code></br> <em> int32 </em> 2744 </td> 2745 <td> 2746 <p> 2747 Replicas is the event source deployment replicas 2748 </p> 2749 </td> 2750 </tr> 2751 <tr> 2752 <td> 2753 <code>bitbucketserver</code></br> <em> 2754 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource"> 2755 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketServerEventSource 2756 </a> </em> 2757 </td> 2758 <td> 2759 <p> 2760 Bitbucket Server event sources 2761 </p> 2762 </td> 2763 </tr> 2764 <tr> 2765 <td> 2766 <code>bitbucket</code></br> <em> 2767 <a href="#argoproj.io/v1alpha1.BitbucketEventSource"> 2768 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketEventSource 2769 </a> </em> 2770 </td> 2771 <td> 2772 <p> 2773 Bitbucket event sources 2774 </p> 2775 </td> 2776 </tr> 2777 <tr> 2778 <td> 2779 <code>redisStream</code></br> <em> 2780 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource"> 2781 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisStreamEventSource 2782 </a> </em> 2783 </td> 2784 <td> 2785 <p> 2786 Redis stream source 2787 </p> 2788 </td> 2789 </tr> 2790 <tr> 2791 <td> 2792 <code>azureServiceBus</code></br> <em> 2793 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource"> 2794 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureServiceBusEventSource 2795 </a> </em> 2796 </td> 2797 <td> 2798 <p> 2799 Azure Service Bus event source 2800 </p> 2801 </td> 2802 </tr> 2803 <tr> 2804 <td> 2805 <code>azureQueueStorage</code></br> <em> 2806 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource"> 2807 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureQueueStorageEventSource 2808 </a> </em> 2809 </td> 2810 <td> 2811 <p> 2812 AzureQueueStorage event source 2813 </p> 2814 </td> 2815 </tr> 2816 <tr> 2817 <td> 2818 <code>sftp</code></br> <em> 2819 <a href="#argoproj.io/v1alpha1.SFTPEventSource"> 2820 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SFTPEventSource 2821 </a> </em> 2822 </td> 2823 <td> 2824 <p> 2825 SFTP event sources 2826 </p> 2827 </td> 2828 </tr> 2829 <tr> 2830 <td> 2831 <code>gerrit</code></br> <em> 2832 <a href="#argoproj.io/v1alpha1.GerritEventSource"> 2833 map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GerritEventSource 2834 </a> </em> 2835 </td> 2836 <td> 2837 <p> 2838 Gerrit event source 2839 </p> 2840 </td> 2841 </tr> 2842 </tbody> 2843 </table> 2844 <h3 id="argoproj.io/v1alpha1.EventSourceStatus"> 2845 EventSourceStatus 2846 </h3> 2847 <p> 2848 (<em>Appears on:</em> 2849 <a href="#argoproj.io/v1alpha1.EventSource">EventSource</a>) 2850 </p> 2851 <p> 2852 <p> 2853 EventSourceStatus holds the status of the event-source resource 2854 </p> 2855 </p> 2856 <table> 2857 <thead> 2858 <tr> 2859 <th> 2860 Field 2861 </th> 2862 <th> 2863 Description 2864 </th> 2865 </tr> 2866 </thead> 2867 <tbody> 2868 <tr> 2869 <td> 2870 <code>Status</code></br> <em> 2871 github.com/argoproj/argo-events/pkg/apis/common.Status </em> 2872 </td> 2873 <td> 2874 <p> 2875 (Members of <code>Status</code> are embedded into this type.) 2876 </p> 2877 </td> 2878 </tr> 2879 </tbody> 2880 </table> 2881 <h3 id="argoproj.io/v1alpha1.FileEventSource"> 2882 FileEventSource 2883 </h3> 2884 <p> 2885 (<em>Appears on:</em> 2886 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 2887 </p> 2888 <p> 2889 <p> 2890 FileEventSource describes an event-source for file related events. 2891 </p> 2892 </p> 2893 <table> 2894 <thead> 2895 <tr> 2896 <th> 2897 Field 2898 </th> 2899 <th> 2900 Description 2901 </th> 2902 </tr> 2903 </thead> 2904 <tbody> 2905 <tr> 2906 <td> 2907 <code>eventType</code></br> <em> string </em> 2908 </td> 2909 <td> 2910 <p> 2911 Type of file operations to watch Refer 2912 <a href="https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go">https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go</a> 2913 for more information 2914 </p> 2915 </td> 2916 </tr> 2917 <tr> 2918 <td> 2919 <code>watchPathConfig</code></br> <em> 2920 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> WatchPathConfig </a> 2921 </em> 2922 </td> 2923 <td> 2924 <p> 2925 WatchPathConfig contains configuration about the file path to watch 2926 </p> 2927 </td> 2928 </tr> 2929 <tr> 2930 <td> 2931 <code>polling</code></br> <em> bool </em> 2932 </td> 2933 <td> 2934 <p> 2935 Use polling instead of inotify 2936 </p> 2937 </td> 2938 </tr> 2939 <tr> 2940 <td> 2941 <code>metadata</code></br> <em> map\[string\]string </em> 2942 </td> 2943 <td> 2944 <em>(Optional)</em> 2945 <p> 2946 Metadata holds the user defined metadata which will passed along the 2947 event payload. 2948 </p> 2949 </td> 2950 </tr> 2951 <tr> 2952 <td> 2953 <code>filter</code></br> <em> 2954 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 2955 </a> </em> 2956 </td> 2957 <td> 2958 <em>(Optional)</em> 2959 <p> 2960 Filter 2961 </p> 2962 </td> 2963 </tr> 2964 </tbody> 2965 </table> 2966 <h3 id="argoproj.io/v1alpha1.GenericEventSource"> 2967 GenericEventSource 2968 </h3> 2969 <p> 2970 (<em>Appears on:</em> 2971 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 2972 </p> 2973 <p> 2974 <p> 2975 GenericEventSource refers to a generic event source. It can be used to 2976 implement a custom event source. 2977 </p> 2978 </p> 2979 <table> 2980 <thead> 2981 <tr> 2982 <th> 2983 Field 2984 </th> 2985 <th> 2986 Description 2987 </th> 2988 </tr> 2989 </thead> 2990 <tbody> 2991 <tr> 2992 <td> 2993 <code>url</code></br> <em> string </em> 2994 </td> 2995 <td> 2996 <p> 2997 URL of the gRPC server that implements the event source. 2998 </p> 2999 </td> 3000 </tr> 3001 <tr> 3002 <td> 3003 <code>config</code></br> <em> string </em> 3004 </td> 3005 <td> 3006 <p> 3007 Config is the event source configuration 3008 </p> 3009 </td> 3010 </tr> 3011 <tr> 3012 <td> 3013 <code>insecure</code></br> <em> bool </em> 3014 </td> 3015 <td> 3016 <p> 3017 Insecure determines the type of connection. 3018 </p> 3019 </td> 3020 </tr> 3021 <tr> 3022 <td> 3023 <code>jsonBody</code></br> <em> bool </em> 3024 </td> 3025 <td> 3026 <em>(Optional)</em> 3027 <p> 3028 JSONBody specifies that all event body payload coming from this source 3029 will be JSON 3030 </p> 3031 </td> 3032 </tr> 3033 <tr> 3034 <td> 3035 <code>metadata</code></br> <em> map\[string\]string </em> 3036 </td> 3037 <td> 3038 <em>(Optional)</em> 3039 <p> 3040 Metadata holds the user defined metadata which will passed along the 3041 event payload. 3042 </p> 3043 </td> 3044 </tr> 3045 <tr> 3046 <td> 3047 <code>authSecret</code></br> <em> 3048 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3049 Kubernetes core/v1.SecretKeySelector </a> </em> 3050 </td> 3051 <td> 3052 <em>(Optional)</em> 3053 <p> 3054 AuthSecret holds a secret selector that contains a bearer token for 3055 authentication 3056 </p> 3057 </td> 3058 </tr> 3059 <tr> 3060 <td> 3061 <code>filter</code></br> <em> 3062 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 3063 </a> </em> 3064 </td> 3065 <td> 3066 <em>(Optional)</em> 3067 <p> 3068 Filter 3069 </p> 3070 </td> 3071 </tr> 3072 </tbody> 3073 </table> 3074 <h3 id="argoproj.io/v1alpha1.GerritEventSource"> 3075 GerritEventSource 3076 </h3> 3077 <p> 3078 (<em>Appears on:</em> 3079 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3080 </p> 3081 <p> 3082 <p> 3083 GerritEventSource refers to event-source related to gerrit events 3084 </p> 3085 </p> 3086 <table> 3087 <thead> 3088 <tr> 3089 <th> 3090 Field 3091 </th> 3092 <th> 3093 Description 3094 </th> 3095 </tr> 3096 </thead> 3097 <tbody> 3098 <tr> 3099 <td> 3100 <code>webhook</code></br> <em> 3101 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 3102 </em> 3103 </td> 3104 <td> 3105 <p> 3106 Webhook holds configuration to run a http server 3107 </p> 3108 </td> 3109 </tr> 3110 <tr> 3111 <td> 3112 <code>hookName</code></br> <em> string </em> 3113 </td> 3114 <td> 3115 <p> 3116 HookName is the name of the webhook 3117 </p> 3118 </td> 3119 </tr> 3120 <tr> 3121 <td> 3122 <code>events</code></br> <em> \[\]string </em> 3123 </td> 3124 <td> 3125 <p> 3126 Events are gerrit event to listen to. Refer 3127 <a href="https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events">https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events</a> 3128 </p> 3129 </td> 3130 </tr> 3131 <tr> 3132 <td> 3133 <code>auth</code></br> <em> 3134 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth </em> 3135 </td> 3136 <td> 3137 <em>(Optional)</em> 3138 <p> 3139 Auth hosts secret selectors for username and password 3140 </p> 3141 </td> 3142 </tr> 3143 <tr> 3144 <td> 3145 <code>gerritBaseURL</code></br> <em> string </em> 3146 </td> 3147 <td> 3148 <p> 3149 GerritBaseURL is the base URL for API requests to a custom endpoint 3150 </p> 3151 </td> 3152 </tr> 3153 <tr> 3154 <td> 3155 <code>deleteHookOnFinish</code></br> <em> bool </em> 3156 </td> 3157 <td> 3158 <em>(Optional)</em> 3159 <p> 3160 DeleteHookOnFinish determines whether to delete the Gerrit hook for the 3161 project once the event source is stopped. 3162 </p> 3163 </td> 3164 </tr> 3165 <tr> 3166 <td> 3167 <code>metadata</code></br> <em> map\[string\]string </em> 3168 </td> 3169 <td> 3170 <em>(Optional)</em> 3171 <p> 3172 Metadata holds the user defined metadata which will passed along the 3173 event payload. 3174 </p> 3175 </td> 3176 </tr> 3177 <tr> 3178 <td> 3179 <code>projects</code></br> <em> \[\]string </em> 3180 </td> 3181 <td> 3182 <p> 3183 List of project namespace paths like “whynowy/test”. 3184 </p> 3185 </td> 3186 </tr> 3187 <tr> 3188 <td> 3189 <code>sslVerify</code></br> <em> bool </em> 3190 </td> 3191 <td> 3192 <em>(Optional)</em> 3193 <p> 3194 SslVerify to enable ssl verification 3195 </p> 3196 </td> 3197 </tr> 3198 <tr> 3199 <td> 3200 <code>filter</code></br> <em> 3201 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 3202 </a> </em> 3203 </td> 3204 <td> 3205 <em>(Optional)</em> 3206 <p> 3207 Filter 3208 </p> 3209 </td> 3210 </tr> 3211 </tbody> 3212 </table> 3213 <h3 id="argoproj.io/v1alpha1.GithubAppCreds"> 3214 GithubAppCreds 3215 </h3> 3216 <p> 3217 (<em>Appears on:</em> 3218 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>) 3219 </p> 3220 <p> 3221 </p> 3222 <table> 3223 <thead> 3224 <tr> 3225 <th> 3226 Field 3227 </th> 3228 <th> 3229 Description 3230 </th> 3231 </tr> 3232 </thead> 3233 <tbody> 3234 <tr> 3235 <td> 3236 <code>privateKey</code></br> <em> 3237 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3238 Kubernetes core/v1.SecretKeySelector </a> </em> 3239 </td> 3240 <td> 3241 <p> 3242 PrivateKey refers to a K8s secret containing the GitHub app private key 3243 </p> 3244 </td> 3245 </tr> 3246 <tr> 3247 <td> 3248 <code>appID</code></br> <em> int64 </em> 3249 </td> 3250 <td> 3251 <p> 3252 AppID refers to the GitHub App ID for the application you created 3253 </p> 3254 </td> 3255 </tr> 3256 <tr> 3257 <td> 3258 <code>installationID</code></br> <em> int64 </em> 3259 </td> 3260 <td> 3261 <p> 3262 InstallationID refers to the Installation ID of the GitHub app you 3263 created and installed 3264 </p> 3265 </td> 3266 </tr> 3267 </tbody> 3268 </table> 3269 <h3 id="argoproj.io/v1alpha1.GithubEventSource"> 3270 GithubEventSource 3271 </h3> 3272 <p> 3273 (<em>Appears on:</em> 3274 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3275 </p> 3276 <p> 3277 <p> 3278 GithubEventSource refers to event-source for github related events 3279 </p> 3280 </p> 3281 <table> 3282 <thead> 3283 <tr> 3284 <th> 3285 Field 3286 </th> 3287 <th> 3288 Description 3289 </th> 3290 </tr> 3291 </thead> 3292 <tbody> 3293 <tr> 3294 <td> 3295 <code>id</code></br> <em> int64 </em> 3296 </td> 3297 <td> 3298 <em>(Optional)</em> 3299 <p> 3300 Id is the webhook’s id Deprecated: This is not used at all, will be 3301 removed in v1.6 3302 </p> 3303 </td> 3304 </tr> 3305 <tr> 3306 <td> 3307 <code>webhook</code></br> <em> 3308 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 3309 </em> 3310 </td> 3311 <td> 3312 <p> 3313 Webhook refers to the configuration required to run a http server 3314 </p> 3315 </td> 3316 </tr> 3317 <tr> 3318 <td> 3319 <code>owner</code></br> <em> string </em> 3320 </td> 3321 <td> 3322 <em>(Optional)</em> 3323 <p> 3324 DeprecatedOwner refers to GitHub owner name i.e. argoproj Deprecated: 3325 use Repositories instead. Will be unsupported in v 1.6 3326 </p> 3327 </td> 3328 </tr> 3329 <tr> 3330 <td> 3331 <code>repository</code></br> <em> string </em> 3332 </td> 3333 <td> 3334 <em>(Optional)</em> 3335 <p> 3336 DeprecatedRepository refers to GitHub repo name i.e. argo-events 3337 Deprecated: use Repositories instead. Will be unsupported in v 1.6 3338 </p> 3339 </td> 3340 </tr> 3341 <tr> 3342 <td> 3343 <code>events</code></br> <em> \[\]string </em> 3344 </td> 3345 <td> 3346 <p> 3347 Events refer to Github events to which the event source will subscribe 3348 </p> 3349 </td> 3350 </tr> 3351 <tr> 3352 <td> 3353 <code>apiToken</code></br> <em> 3354 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3355 Kubernetes core/v1.SecretKeySelector </a> </em> 3356 </td> 3357 <td> 3358 <em>(Optional)</em> 3359 <p> 3360 APIToken refers to a K8s secret containing github api token 3361 </p> 3362 </td> 3363 </tr> 3364 <tr> 3365 <td> 3366 <code>webhookSecret</code></br> <em> 3367 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3368 Kubernetes core/v1.SecretKeySelector </a> </em> 3369 </td> 3370 <td> 3371 <em>(Optional)</em> 3372 <p> 3373 WebhookSecret refers to K8s secret containing GitHub webhook secret 3374 <a href="https://developer.github.com/webhooks/securing/">https://developer.github.com/webhooks/securing/</a> 3375 </p> 3376 </td> 3377 </tr> 3378 <tr> 3379 <td> 3380 <code>insecure</code></br> <em> bool </em> 3381 </td> 3382 <td> 3383 <p> 3384 Insecure tls verification 3385 </p> 3386 </td> 3387 </tr> 3388 <tr> 3389 <td> 3390 <code>active</code></br> <em> bool </em> 3391 </td> 3392 <td> 3393 <em>(Optional)</em> 3394 <p> 3395 Active refers to status of the webhook for event deliveries. 3396 <a href="https://developer.github.com/webhooks/creating/#active">https://developer.github.com/webhooks/creating/#active</a> 3397 </p> 3398 </td> 3399 </tr> 3400 <tr> 3401 <td> 3402 <code>contentType</code></br> <em> string </em> 3403 </td> 3404 <td> 3405 <p> 3406 ContentType of the event delivery 3407 </p> 3408 </td> 3409 </tr> 3410 <tr> 3411 <td> 3412 <code>githubBaseURL</code></br> <em> string </em> 3413 </td> 3414 <td> 3415 <em>(Optional)</em> 3416 <p> 3417 GitHub base URL (for GitHub Enterprise) 3418 </p> 3419 </td> 3420 </tr> 3421 <tr> 3422 <td> 3423 <code>githubUploadURL</code></br> <em> string </em> 3424 </td> 3425 <td> 3426 <em>(Optional)</em> 3427 <p> 3428 GitHub upload URL (for GitHub Enterprise) 3429 </p> 3430 </td> 3431 </tr> 3432 <tr> 3433 <td> 3434 <code>deleteHookOnFinish</code></br> <em> bool </em> 3435 </td> 3436 <td> 3437 <em>(Optional)</em> 3438 <p> 3439 DeleteHookOnFinish determines whether to delete the GitHub hook for the 3440 repository once the event source is stopped. 3441 </p> 3442 </td> 3443 </tr> 3444 <tr> 3445 <td> 3446 <code>metadata</code></br> <em> map\[string\]string </em> 3447 </td> 3448 <td> 3449 <em>(Optional)</em> 3450 <p> 3451 Metadata holds the user defined metadata which will passed along the 3452 event payload. 3453 </p> 3454 </td> 3455 </tr> 3456 <tr> 3457 <td> 3458 <code>repositories</code></br> <em> 3459 <a href="#argoproj.io/v1alpha1.OwnedRepositories"> \[\]OwnedRepositories 3460 </a> </em> 3461 </td> 3462 <td> 3463 <p> 3464 Repositories holds the information of repositories, which uses repo 3465 owner as the key, and list of repo names as the value. Not required if 3466 Organizations is set. 3467 </p> 3468 </td> 3469 </tr> 3470 <tr> 3471 <td> 3472 <code>organizations</code></br> <em> \[\]string </em> 3473 </td> 3474 <td> 3475 <p> 3476 Organizations holds the names of organizations (used for organization 3477 level webhooks). Not required if Repositories is set. 3478 </p> 3479 </td> 3480 </tr> 3481 <tr> 3482 <td> 3483 <code>githubApp</code></br> <em> 3484 <a href="#argoproj.io/v1alpha1.GithubAppCreds"> GithubAppCreds </a> 3485 </em> 3486 </td> 3487 <td> 3488 <em>(Optional)</em> 3489 <p> 3490 GitHubApp holds the GitHub app credentials 3491 </p> 3492 </td> 3493 </tr> 3494 <tr> 3495 <td> 3496 <code>filter</code></br> <em> 3497 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 3498 </a> </em> 3499 </td> 3500 <td> 3501 <em>(Optional)</em> 3502 <p> 3503 Filter 3504 </p> 3505 </td> 3506 </tr> 3507 </tbody> 3508 </table> 3509 <h3 id="argoproj.io/v1alpha1.GitlabEventSource"> 3510 GitlabEventSource 3511 </h3> 3512 <p> 3513 (<em>Appears on:</em> 3514 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3515 </p> 3516 <p> 3517 <p> 3518 GitlabEventSource refers to event-source related to Gitlab events 3519 </p> 3520 </p> 3521 <table> 3522 <thead> 3523 <tr> 3524 <th> 3525 Field 3526 </th> 3527 <th> 3528 Description 3529 </th> 3530 </tr> 3531 </thead> 3532 <tbody> 3533 <tr> 3534 <td> 3535 <code>webhook</code></br> <em> 3536 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 3537 </em> 3538 </td> 3539 <td> 3540 <p> 3541 Webhook holds configuration to run a http server 3542 </p> 3543 </td> 3544 </tr> 3545 <tr> 3546 <td> 3547 <code>projectID</code></br> <em> string </em> 3548 </td> 3549 <td> 3550 <em>(Optional)</em> 3551 <p> 3552 DeprecatedProjectID is the id of project for which integration needs to 3553 setup Deprecated: use Projects instead. Will be unsupported in v 1.7 3554 </p> 3555 </td> 3556 </tr> 3557 <tr> 3558 <td> 3559 <code>events</code></br> <em> \[\]string </em> 3560 </td> 3561 <td> 3562 <p> 3563 Events are gitlab event to listen to. Refer 3564 <a href="https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794">https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794</a>. 3565 </p> 3566 </td> 3567 </tr> 3568 <tr> 3569 <td> 3570 <code>accessToken</code></br> <em> 3571 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3572 Kubernetes core/v1.SecretKeySelector </a> </em> 3573 </td> 3574 <td> 3575 <p> 3576 AccessToken references to k8 secret which holds the gitlab api access 3577 information 3578 </p> 3579 </td> 3580 </tr> 3581 <tr> 3582 <td> 3583 <code>enableSSLVerification</code></br> <em> bool </em> 3584 </td> 3585 <td> 3586 <em>(Optional)</em> 3587 <p> 3588 EnableSSLVerification to enable ssl verification 3589 </p> 3590 </td> 3591 </tr> 3592 <tr> 3593 <td> 3594 <code>gitlabBaseURL</code></br> <em> string </em> 3595 </td> 3596 <td> 3597 <p> 3598 GitlabBaseURL is the base URL for API requests to a custom endpoint 3599 </p> 3600 </td> 3601 </tr> 3602 <tr> 3603 <td> 3604 <code>deleteHookOnFinish</code></br> <em> bool </em> 3605 </td> 3606 <td> 3607 <em>(Optional)</em> 3608 <p> 3609 DeleteHookOnFinish determines whether to delete the GitLab hook for the 3610 project once the event source is stopped. 3611 </p> 3612 </td> 3613 </tr> 3614 <tr> 3615 <td> 3616 <code>metadata</code></br> <em> map\[string\]string </em> 3617 </td> 3618 <td> 3619 <em>(Optional)</em> 3620 <p> 3621 Metadata holds the user defined metadata which will passed along the 3622 event payload. 3623 </p> 3624 </td> 3625 </tr> 3626 <tr> 3627 <td> 3628 <code>projects</code></br> <em> \[\]string </em> 3629 </td> 3630 <td> 3631 <em>(Optional)</em> 3632 <p> 3633 List of project IDs or project namespace paths like “whynowy/test”. 3634 Projects and groups cannot be empty at the same time. 3635 </p> 3636 </td> 3637 </tr> 3638 <tr> 3639 <td> 3640 <code>secretToken</code></br> <em> 3641 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3642 Kubernetes core/v1.SecretKeySelector </a> </em> 3643 </td> 3644 <td> 3645 <p> 3646 SecretToken references to k8 secret which holds the Secret Token used by 3647 webhook config 3648 </p> 3649 </td> 3650 </tr> 3651 <tr> 3652 <td> 3653 <code>filter</code></br> <em> 3654 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 3655 </a> </em> 3656 </td> 3657 <td> 3658 <em>(Optional)</em> 3659 <p> 3660 Filter 3661 </p> 3662 </td> 3663 </tr> 3664 <tr> 3665 <td> 3666 <code>groups</code></br> <em> \[\]string </em> 3667 </td> 3668 <td> 3669 <em>(Optional)</em> 3670 <p> 3671 List of group IDs or group name like “test”. Group level hook available 3672 in Premium and Ultimate Gitlab. 3673 </p> 3674 </td> 3675 </tr> 3676 </tbody> 3677 </table> 3678 <h3 id="argoproj.io/v1alpha1.HDFSEventSource"> 3679 HDFSEventSource 3680 </h3> 3681 <p> 3682 (<em>Appears on:</em> 3683 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3684 </p> 3685 <p> 3686 <p> 3687 HDFSEventSource refers to event-source for HDFS related events 3688 </p> 3689 </p> 3690 <table> 3691 <thead> 3692 <tr> 3693 <th> 3694 Field 3695 </th> 3696 <th> 3697 Description 3698 </th> 3699 </tr> 3700 </thead> 3701 <tbody> 3702 <tr> 3703 <td> 3704 <code>WatchPathConfig</code></br> <em> 3705 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> WatchPathConfig </a> 3706 </em> 3707 </td> 3708 <td> 3709 <p> 3710 (Members of <code>WatchPathConfig</code> are embedded into this type.) 3711 </p> 3712 </td> 3713 </tr> 3714 <tr> 3715 <td> 3716 <code>type</code></br> <em> string </em> 3717 </td> 3718 <td> 3719 <p> 3720 Type of file operations to watch 3721 </p> 3722 </td> 3723 </tr> 3724 <tr> 3725 <td> 3726 <code>checkInterval</code></br> <em> string </em> 3727 </td> 3728 <td> 3729 <p> 3730 CheckInterval is a string that describes an interval duration to check 3731 the directory state, e.g. 1s, 30m, 2h… (defaults to 1m) 3732 </p> 3733 </td> 3734 </tr> 3735 <tr> 3736 <td> 3737 <code>addresses</code></br> <em> \[\]string </em> 3738 </td> 3739 <td> 3740 </td> 3741 </tr> 3742 <tr> 3743 <td> 3744 <code>hdfsUser</code></br> <em> string </em> 3745 </td> 3746 <td> 3747 <p> 3748 HDFSUser is the user to access HDFS file system. It is ignored if either 3749 ccache or keytab is used. 3750 </p> 3751 </td> 3752 </tr> 3753 <tr> 3754 <td> 3755 <code>krbCCacheSecret</code></br> <em> 3756 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3757 Kubernetes core/v1.SecretKeySelector </a> </em> 3758 </td> 3759 <td> 3760 <p> 3761 KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache 3762 or keytab can be set to use Kerberos. 3763 </p> 3764 </td> 3765 </tr> 3766 <tr> 3767 <td> 3768 <code>krbKeytabSecret</code></br> <em> 3769 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3770 Kubernetes core/v1.SecretKeySelector </a> </em> 3771 </td> 3772 <td> 3773 <p> 3774 KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache 3775 or keytab can be set to use Kerberos. 3776 </p> 3777 </td> 3778 </tr> 3779 <tr> 3780 <td> 3781 <code>krbUsername</code></br> <em> string </em> 3782 </td> 3783 <td> 3784 <p> 3785 KrbUsername is the Kerberos username used with Kerberos keytab It must 3786 be set if keytab is used. 3787 </p> 3788 </td> 3789 </tr> 3790 <tr> 3791 <td> 3792 <code>krbRealm</code></br> <em> string </em> 3793 </td> 3794 <td> 3795 <p> 3796 KrbRealm is the Kerberos realm used with Kerberos keytab It must be set 3797 if keytab is used. 3798 </p> 3799 </td> 3800 </tr> 3801 <tr> 3802 <td> 3803 <code>krbConfigConfigMap</code></br> <em> 3804 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#configmapkeyselector-v1-core"> 3805 Kubernetes core/v1.ConfigMapKeySelector </a> </em> 3806 </td> 3807 <td> 3808 <p> 3809 KrbConfig is the configmap selector for Kerberos config as string It 3810 must be set if either ccache or keytab is used. 3811 </p> 3812 </td> 3813 </tr> 3814 <tr> 3815 <td> 3816 <code>krbServicePrincipalName</code></br> <em> string </em> 3817 </td> 3818 <td> 3819 <p> 3820 KrbServicePrincipalName is the principal name of Kerberos service It 3821 must be set if either ccache or keytab is used. 3822 </p> 3823 </td> 3824 </tr> 3825 <tr> 3826 <td> 3827 <code>metadata</code></br> <em> map\[string\]string </em> 3828 </td> 3829 <td> 3830 <em>(Optional)</em> 3831 <p> 3832 Metadata holds the user defined metadata which will passed along the 3833 event payload. 3834 </p> 3835 </td> 3836 </tr> 3837 <tr> 3838 <td> 3839 <code>filter</code></br> <em> 3840 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 3841 </a> </em> 3842 </td> 3843 <td> 3844 <em>(Optional)</em> 3845 <p> 3846 Filter 3847 </p> 3848 </td> 3849 </tr> 3850 </tbody> 3851 </table> 3852 <h3 id="argoproj.io/v1alpha1.KafkaConsumerGroup"> 3853 KafkaConsumerGroup 3854 </h3> 3855 <p> 3856 (<em>Appears on:</em> 3857 <a href="#argoproj.io/v1alpha1.KafkaEventSource">KafkaEventSource</a>) 3858 </p> 3859 <p> 3860 </p> 3861 <table> 3862 <thead> 3863 <tr> 3864 <th> 3865 Field 3866 </th> 3867 <th> 3868 Description 3869 </th> 3870 </tr> 3871 </thead> 3872 <tbody> 3873 <tr> 3874 <td> 3875 <code>groupName</code></br> <em> string </em> 3876 </td> 3877 <td> 3878 <p> 3879 The name for the consumer group to use 3880 </p> 3881 </td> 3882 </tr> 3883 <tr> 3884 <td> 3885 <code>oldest</code></br> <em> bool </em> 3886 </td> 3887 <td> 3888 <em>(Optional)</em> 3889 <p> 3890 When starting up a new group do we want to start from the oldest event 3891 (true) or the newest event (false), defaults to false 3892 </p> 3893 </td> 3894 </tr> 3895 <tr> 3896 <td> 3897 <code>rebalanceStrategy</code></br> <em> string </em> 3898 </td> 3899 <td> 3900 <em>(Optional)</em> 3901 <p> 3902 Rebalance strategy can be one of: sticky, roundrobin, range. Range is 3903 the default. 3904 </p> 3905 </td> 3906 </tr> 3907 </tbody> 3908 </table> 3909 <h3 id="argoproj.io/v1alpha1.KafkaEventSource"> 3910 KafkaEventSource 3911 </h3> 3912 <p> 3913 (<em>Appears on:</em> 3914 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3915 </p> 3916 <p> 3917 <p> 3918 KafkaEventSource refers to event-source for Kafka related events 3919 </p> 3920 </p> 3921 <table> 3922 <thead> 3923 <tr> 3924 <th> 3925 Field 3926 </th> 3927 <th> 3928 Description 3929 </th> 3930 </tr> 3931 </thead> 3932 <tbody> 3933 <tr> 3934 <td> 3935 <code>url</code></br> <em> string </em> 3936 </td> 3937 <td> 3938 <p> 3939 URL to kafka cluster, multiple URLs separated by comma 3940 </p> 3941 </td> 3942 </tr> 3943 <tr> 3944 <td> 3945 <code>partition</code></br> <em> string </em> 3946 </td> 3947 <td> 3948 <em>(Optional)</em> 3949 <p> 3950 Partition name 3951 </p> 3952 </td> 3953 </tr> 3954 <tr> 3955 <td> 3956 <code>topic</code></br> <em> string </em> 3957 </td> 3958 <td> 3959 <p> 3960 Topic name 3961 </p> 3962 </td> 3963 </tr> 3964 <tr> 3965 <td> 3966 <code>connectionBackoff</code></br> <em> 3967 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 3968 </td> 3969 <td> 3970 <p> 3971 Backoff holds parameters applied to connection. 3972 </p> 3973 </td> 3974 </tr> 3975 <tr> 3976 <td> 3977 <code>tls</code></br> <em> 3978 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 3979 </td> 3980 <td> 3981 <em>(Optional)</em> 3982 <p> 3983 TLS configuration for the kafka client. 3984 </p> 3985 </td> 3986 </tr> 3987 <tr> 3988 <td> 3989 <code>jsonBody</code></br> <em> bool </em> 3990 </td> 3991 <td> 3992 <em>(Optional)</em> 3993 <p> 3994 JSONBody specifies that all event body payload coming from this source 3995 will be JSON 3996 </p> 3997 </td> 3998 </tr> 3999 <tr> 4000 <td> 4001 <code>metadata</code></br> <em> map\[string\]string </em> 4002 </td> 4003 <td> 4004 <em>(Optional)</em> 4005 <p> 4006 Metadata holds the user defined metadata which will passed along the 4007 event payload. 4008 </p> 4009 </td> 4010 </tr> 4011 <tr> 4012 <td> 4013 <code>consumerGroup</code></br> <em> 4014 <a href="#argoproj.io/v1alpha1.KafkaConsumerGroup"> KafkaConsumerGroup 4015 </a> </em> 4016 </td> 4017 <td> 4018 <em>(Optional)</em> 4019 <p> 4020 Consumer group for kafka client 4021 </p> 4022 </td> 4023 </tr> 4024 <tr> 4025 <td> 4026 <code>limitEventsPerSecond</code></br> <em> int64 </em> 4027 </td> 4028 <td> 4029 <em>(Optional)</em> 4030 <p> 4031 Sets a limit on how many events get read from kafka per second. 4032 </p> 4033 </td> 4034 </tr> 4035 <tr> 4036 <td> 4037 <code>version</code></br> <em> string </em> 4038 </td> 4039 <td> 4040 <em>(Optional)</em> 4041 <p> 4042 Specify what kafka version is being connected to enables certain 4043 features in sarama, defaults to 1.0.0 4044 </p> 4045 </td> 4046 </tr> 4047 <tr> 4048 <td> 4049 <code>sasl</code></br> <em> 4050 github.com/argoproj/argo-events/pkg/apis/common.SASLConfig </em> 4051 </td> 4052 <td> 4053 <em>(Optional)</em> 4054 <p> 4055 SASL configuration for the kafka client 4056 </p> 4057 </td> 4058 </tr> 4059 <tr> 4060 <td> 4061 <code>filter</code></br> <em> 4062 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4063 </a> </em> 4064 </td> 4065 <td> 4066 <em>(Optional)</em> 4067 <p> 4068 Filter 4069 </p> 4070 </td> 4071 </tr> 4072 <tr> 4073 <td> 4074 <code>config</code></br> <em> string </em> 4075 </td> 4076 <td> 4077 <em>(Optional)</em> 4078 <p> 4079 Yaml format Sarama config for Kafka connection. It follows the struct of 4080 sarama.Config. See 4081 <a href="https://github.com/IBM/sarama/blob/main/config.go">https://github.com/IBM/sarama/blob/main/config.go</a> 4082 e.g. 4083 </p> 4084 <p> 4085 consumer: fetch: min: 1 net: MaxOpenRequests: 5 4086 </p> 4087 </td> 4088 </tr> 4089 </tbody> 4090 </table> 4091 <h3 id="argoproj.io/v1alpha1.MQTTEventSource"> 4092 MQTTEventSource 4093 </h3> 4094 <p> 4095 (<em>Appears on:</em> 4096 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4097 </p> 4098 <p> 4099 <p> 4100 MQTTEventSource refers to event-source for MQTT related events 4101 </p> 4102 </p> 4103 <table> 4104 <thead> 4105 <tr> 4106 <th> 4107 Field 4108 </th> 4109 <th> 4110 Description 4111 </th> 4112 </tr> 4113 </thead> 4114 <tbody> 4115 <tr> 4116 <td> 4117 <code>url</code></br> <em> string </em> 4118 </td> 4119 <td> 4120 <p> 4121 URL to connect to broker 4122 </p> 4123 </td> 4124 </tr> 4125 <tr> 4126 <td> 4127 <code>topic</code></br> <em> string </em> 4128 </td> 4129 <td> 4130 <p> 4131 Topic name 4132 </p> 4133 </td> 4134 </tr> 4135 <tr> 4136 <td> 4137 <code>clientId</code></br> <em> string </em> 4138 </td> 4139 <td> 4140 <p> 4141 ClientID is the id of the client 4142 </p> 4143 </td> 4144 </tr> 4145 <tr> 4146 <td> 4147 <code>connectionBackoff</code></br> <em> 4148 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 4149 </td> 4150 <td> 4151 <p> 4152 ConnectionBackoff holds backoff applied to connection. 4153 </p> 4154 </td> 4155 </tr> 4156 <tr> 4157 <td> 4158 <code>jsonBody</code></br> <em> bool </em> 4159 </td> 4160 <td> 4161 <em>(Optional)</em> 4162 <p> 4163 JSONBody specifies that all event body payload coming from this source 4164 will be JSON 4165 </p> 4166 </td> 4167 </tr> 4168 <tr> 4169 <td> 4170 <code>tls</code></br> <em> 4171 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 4172 </td> 4173 <td> 4174 <em>(Optional)</em> 4175 <p> 4176 TLS configuration for the mqtt client. 4177 </p> 4178 </td> 4179 </tr> 4180 <tr> 4181 <td> 4182 <code>metadata</code></br> <em> map\[string\]string </em> 4183 </td> 4184 <td> 4185 <em>(Optional)</em> 4186 <p> 4187 Metadata holds the user defined metadata which will passed along the 4188 event payload. 4189 </p> 4190 </td> 4191 </tr> 4192 <tr> 4193 <td> 4194 <code>filter</code></br> <em> 4195 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4196 </a> </em> 4197 </td> 4198 <td> 4199 <em>(Optional)</em> 4200 <p> 4201 Filter 4202 </p> 4203 </td> 4204 </tr> 4205 <tr> 4206 <td> 4207 <code>auth</code></br> <em> 4208 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth </em> 4209 </td> 4210 <td> 4211 <em>(Optional)</em> 4212 <p> 4213 Auth hosts secret selectors for username and password 4214 </p> 4215 </td> 4216 </tr> 4217 </tbody> 4218 </table> 4219 <h3 id="argoproj.io/v1alpha1.NATSAuth"> 4220 NATSAuth 4221 </h3> 4222 <p> 4223 (<em>Appears on:</em> 4224 <a href="#argoproj.io/v1alpha1.NATSEventsSource">NATSEventsSource</a>) 4225 </p> 4226 <p> 4227 <p> 4228 NATSAuth refers to the auth info for NATS EventSource 4229 </p> 4230 </p> 4231 <table> 4232 <thead> 4233 <tr> 4234 <th> 4235 Field 4236 </th> 4237 <th> 4238 Description 4239 </th> 4240 </tr> 4241 </thead> 4242 <tbody> 4243 <tr> 4244 <td> 4245 <code>basic</code></br> <em> 4246 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth </em> 4247 </td> 4248 <td> 4249 <em>(Optional)</em> 4250 <p> 4251 Baisc auth with username and password 4252 </p> 4253 </td> 4254 </tr> 4255 <tr> 4256 <td> 4257 <code>token</code></br> <em> 4258 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4259 Kubernetes core/v1.SecretKeySelector </a> </em> 4260 </td> 4261 <td> 4262 <em>(Optional)</em> 4263 <p> 4264 Token used to connect 4265 </p> 4266 </td> 4267 </tr> 4268 <tr> 4269 <td> 4270 <code>nkey</code></br> <em> 4271 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4272 Kubernetes core/v1.SecretKeySelector </a> </em> 4273 </td> 4274 <td> 4275 <em>(Optional)</em> 4276 <p> 4277 NKey used to connect 4278 </p> 4279 </td> 4280 </tr> 4281 <tr> 4282 <td> 4283 <code>credential</code></br> <em> 4284 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4285 Kubernetes core/v1.SecretKeySelector </a> </em> 4286 </td> 4287 <td> 4288 <em>(Optional)</em> 4289 <p> 4290 credential used to connect 4291 </p> 4292 </td> 4293 </tr> 4294 </tbody> 4295 </table> 4296 <h3 id="argoproj.io/v1alpha1.NATSEventsSource"> 4297 NATSEventsSource 4298 </h3> 4299 <p> 4300 (<em>Appears on:</em> 4301 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4302 </p> 4303 <p> 4304 <p> 4305 NATSEventsSource refers to event-source for NATS related events 4306 </p> 4307 </p> 4308 <table> 4309 <thead> 4310 <tr> 4311 <th> 4312 Field 4313 </th> 4314 <th> 4315 Description 4316 </th> 4317 </tr> 4318 </thead> 4319 <tbody> 4320 <tr> 4321 <td> 4322 <code>url</code></br> <em> string </em> 4323 </td> 4324 <td> 4325 <p> 4326 URL to connect to NATS cluster 4327 </p> 4328 </td> 4329 </tr> 4330 <tr> 4331 <td> 4332 <code>subject</code></br> <em> string </em> 4333 </td> 4334 <td> 4335 <p> 4336 Subject holds the name of the subject onto which messages are published 4337 </p> 4338 </td> 4339 </tr> 4340 <tr> 4341 <td> 4342 <code>connectionBackoff</code></br> <em> 4343 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 4344 </td> 4345 <td> 4346 <p> 4347 ConnectionBackoff holds backoff applied to connection. 4348 </p> 4349 </td> 4350 </tr> 4351 <tr> 4352 <td> 4353 <code>jsonBody</code></br> <em> bool </em> 4354 </td> 4355 <td> 4356 <em>(Optional)</em> 4357 <p> 4358 JSONBody specifies that all event body payload coming from this source 4359 will be JSON 4360 </p> 4361 </td> 4362 </tr> 4363 <tr> 4364 <td> 4365 <code>tls</code></br> <em> 4366 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 4367 </td> 4368 <td> 4369 <em>(Optional)</em> 4370 <p> 4371 TLS configuration for the nats client. 4372 </p> 4373 </td> 4374 </tr> 4375 <tr> 4376 <td> 4377 <code>metadata</code></br> <em> map\[string\]string </em> 4378 </td> 4379 <td> 4380 <em>(Optional)</em> 4381 <p> 4382 Metadata holds the user defined metadata which will passed along the 4383 event payload. 4384 </p> 4385 </td> 4386 </tr> 4387 <tr> 4388 <td> 4389 <code>auth</code></br> <em> <a href="#argoproj.io/v1alpha1.NATSAuth"> 4390 NATSAuth </a> </em> 4391 </td> 4392 <td> 4393 <em>(Optional)</em> 4394 <p> 4395 Auth information 4396 </p> 4397 </td> 4398 </tr> 4399 <tr> 4400 <td> 4401 <code>filter</code></br> <em> 4402 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4403 </a> </em> 4404 </td> 4405 <td> 4406 <em>(Optional)</em> 4407 <p> 4408 Filter 4409 </p> 4410 </td> 4411 </tr> 4412 </tbody> 4413 </table> 4414 <h3 id="argoproj.io/v1alpha1.NSQEventSource"> 4415 NSQEventSource 4416 </h3> 4417 <p> 4418 (<em>Appears on:</em> 4419 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4420 </p> 4421 <p> 4422 <p> 4423 NSQEventSource describes the event source for NSQ PubSub More info at 4424 <a href="https://godoc.org/github.com/nsqio/go-nsq">https://godoc.org/github.com/nsqio/go-nsq</a> 4425 </p> 4426 </p> 4427 <table> 4428 <thead> 4429 <tr> 4430 <th> 4431 Field 4432 </th> 4433 <th> 4434 Description 4435 </th> 4436 </tr> 4437 </thead> 4438 <tbody> 4439 <tr> 4440 <td> 4441 <code>hostAddress</code></br> <em> string </em> 4442 </td> 4443 <td> 4444 <p> 4445 HostAddress is the address of the host for NSQ lookup 4446 </p> 4447 </td> 4448 </tr> 4449 <tr> 4450 <td> 4451 <code>topic</code></br> <em> string </em> 4452 </td> 4453 <td> 4454 <p> 4455 Topic to subscribe to. 4456 </p> 4457 </td> 4458 </tr> 4459 <tr> 4460 <td> 4461 <code>channel</code></br> <em> string </em> 4462 </td> 4463 <td> 4464 <p> 4465 Channel used for subscription 4466 </p> 4467 </td> 4468 </tr> 4469 <tr> 4470 <td> 4471 <code>connectionBackoff</code></br> <em> 4472 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 4473 </td> 4474 <td> 4475 <em>(Optional)</em> 4476 <p> 4477 Backoff holds parameters applied to connection. 4478 </p> 4479 </td> 4480 </tr> 4481 <tr> 4482 <td> 4483 <code>jsonBody</code></br> <em> bool </em> 4484 </td> 4485 <td> 4486 <em>(Optional)</em> 4487 <p> 4488 JSONBody specifies that all event body payload coming from this source 4489 will be JSON 4490 </p> 4491 </td> 4492 </tr> 4493 <tr> 4494 <td> 4495 <code>tls</code></br> <em> 4496 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 4497 </td> 4498 <td> 4499 <em>(Optional)</em> 4500 <p> 4501 TLS configuration for the nsq client. 4502 </p> 4503 </td> 4504 </tr> 4505 <tr> 4506 <td> 4507 <code>metadata</code></br> <em> map\[string\]string </em> 4508 </td> 4509 <td> 4510 <em>(Optional)</em> 4511 <p> 4512 Metadata holds the user defined metadata which will passed along the 4513 event payload. 4514 </p> 4515 </td> 4516 </tr> 4517 <tr> 4518 <td> 4519 <code>filter</code></br> <em> 4520 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4521 </a> </em> 4522 </td> 4523 <td> 4524 <em>(Optional)</em> 4525 <p> 4526 Filter 4527 </p> 4528 </td> 4529 </tr> 4530 </tbody> 4531 </table> 4532 <h3 id="argoproj.io/v1alpha1.OwnedRepositories"> 4533 OwnedRepositories 4534 </h3> 4535 <p> 4536 (<em>Appears on:</em> 4537 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>) 4538 </p> 4539 <p> 4540 </p> 4541 <table> 4542 <thead> 4543 <tr> 4544 <th> 4545 Field 4546 </th> 4547 <th> 4548 Description 4549 </th> 4550 </tr> 4551 </thead> 4552 <tbody> 4553 <tr> 4554 <td> 4555 <code>owner</code></br> <em> string </em> 4556 </td> 4557 <td> 4558 <p> 4559 Organization or user name 4560 </p> 4561 </td> 4562 </tr> 4563 <tr> 4564 <td> 4565 <code>names</code></br> <em> \[\]string </em> 4566 </td> 4567 <td> 4568 <p> 4569 Repository names 4570 </p> 4571 </td> 4572 </tr> 4573 </tbody> 4574 </table> 4575 <h3 id="argoproj.io/v1alpha1.PubSubEventSource"> 4576 PubSubEventSource 4577 </h3> 4578 <p> 4579 (<em>Appears on:</em> 4580 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4581 </p> 4582 <p> 4583 <p> 4584 PubSubEventSource refers to event-source for GCP PubSub related events. 4585 </p> 4586 </p> 4587 <table> 4588 <thead> 4589 <tr> 4590 <th> 4591 Field 4592 </th> 4593 <th> 4594 Description 4595 </th> 4596 </tr> 4597 </thead> 4598 <tbody> 4599 <tr> 4600 <td> 4601 <code>projectID</code></br> <em> string </em> 4602 </td> 4603 <td> 4604 <em>(Optional)</em> 4605 <p> 4606 ProjectID is GCP project ID for the subscription. Required if you run 4607 Argo Events outside of GKE/GCE. (otherwise, the default value is its 4608 project) 4609 </p> 4610 </td> 4611 </tr> 4612 <tr> 4613 <td> 4614 <code>topicProjectID</code></br> <em> string </em> 4615 </td> 4616 <td> 4617 <em>(Optional)</em> 4618 <p> 4619 TopicProjectID is GCP project ID for the topic. By default, it is same 4620 as ProjectID. 4621 </p> 4622 </td> 4623 </tr> 4624 <tr> 4625 <td> 4626 <code>topic</code></br> <em> string </em> 4627 </td> 4628 <td> 4629 <em>(Optional)</em> 4630 <p> 4631 Topic to which the subscription should belongs. Required if you want the 4632 eventsource to create a new subscription. If you specify this field 4633 along with an existing subscription, it will be verified whether it 4634 actually belongs to the specified topic. 4635 </p> 4636 </td> 4637 </tr> 4638 <tr> 4639 <td> 4640 <code>subscriptionID</code></br> <em> string </em> 4641 </td> 4642 <td> 4643 <em>(Optional)</em> 4644 <p> 4645 SubscriptionID is ID of subscription. Required if you use existing 4646 subscription. The default value will be auto generated hash based on 4647 this eventsource setting, so the subscription might be recreated every 4648 time you update the setting, which has a possibility of event loss. 4649 </p> 4650 </td> 4651 </tr> 4652 <tr> 4653 <td> 4654 <code>credentialSecret</code></br> <em> 4655 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4656 Kubernetes core/v1.SecretKeySelector </a> </em> 4657 </td> 4658 <td> 4659 <em>(Optional)</em> 4660 <p> 4661 CredentialSecret references to the secret that contains JSON credentials 4662 to access GCP. If it is missing, it implicitly uses Workload Identity to 4663 access. 4664 <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity</a> 4665 </p> 4666 </td> 4667 </tr> 4668 <tr> 4669 <td> 4670 <code>deleteSubscriptionOnFinish</code></br> <em> bool </em> 4671 </td> 4672 <td> 4673 <em>(Optional)</em> 4674 <p> 4675 DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub 4676 subscription once the event source is stopped. 4677 </p> 4678 </td> 4679 </tr> 4680 <tr> 4681 <td> 4682 <code>jsonBody</code></br> <em> bool </em> 4683 </td> 4684 <td> 4685 <em>(Optional)</em> 4686 <p> 4687 JSONBody specifies that all event body payload coming from this source 4688 will be JSON 4689 </p> 4690 </td> 4691 </tr> 4692 <tr> 4693 <td> 4694 <code>metadata</code></br> <em> map\[string\]string </em> 4695 </td> 4696 <td> 4697 <em>(Optional)</em> 4698 <p> 4699 Metadata holds the user defined metadata which will passed along the 4700 event payload. 4701 </p> 4702 </td> 4703 </tr> 4704 <tr> 4705 <td> 4706 <code>filter</code></br> <em> 4707 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4708 </a> </em> 4709 </td> 4710 <td> 4711 <em>(Optional)</em> 4712 <p> 4713 Filter 4714 </p> 4715 </td> 4716 </tr> 4717 </tbody> 4718 </table> 4719 <h3 id="argoproj.io/v1alpha1.PulsarEventSource"> 4720 PulsarEventSource 4721 </h3> 4722 <p> 4723 (<em>Appears on:</em> 4724 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4725 </p> 4726 <p> 4727 <p> 4728 PulsarEventSource describes the event source for Apache Pulsar 4729 </p> 4730 </p> 4731 <table> 4732 <thead> 4733 <tr> 4734 <th> 4735 Field 4736 </th> 4737 <th> 4738 Description 4739 </th> 4740 </tr> 4741 </thead> 4742 <tbody> 4743 <tr> 4744 <td> 4745 <code>topics</code></br> <em> \[\]string </em> 4746 </td> 4747 <td> 4748 <p> 4749 Name of the topics to subscribe to. 4750 </p> 4751 </td> 4752 </tr> 4753 <tr> 4754 <td> 4755 <code>type</code></br> <em> string </em> 4756 </td> 4757 <td> 4758 <em>(Optional)</em> 4759 <p> 4760 Type of the subscription. Only “exclusive” and “shared” is supported. 4761 Defaults to exclusive. 4762 </p> 4763 </td> 4764 </tr> 4765 <tr> 4766 <td> 4767 <code>url</code></br> <em> string </em> 4768 </td> 4769 <td> 4770 <p> 4771 Configure the service URL for the Pulsar service. 4772 </p> 4773 </td> 4774 </tr> 4775 <tr> 4776 <td> 4777 <code>tlsTrustCertsSecret</code></br> <em> 4778 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4779 Kubernetes core/v1.SecretKeySelector </a> </em> 4780 </td> 4781 <td> 4782 <em>(Optional)</em> 4783 <p> 4784 Trusted TLS certificate secret. 4785 </p> 4786 </td> 4787 </tr> 4788 <tr> 4789 <td> 4790 <code>tlsAllowInsecureConnection</code></br> <em> bool </em> 4791 </td> 4792 <td> 4793 <em>(Optional)</em> 4794 <p> 4795 Whether the Pulsar client accept untrusted TLS certificate from broker. 4796 </p> 4797 </td> 4798 </tr> 4799 <tr> 4800 <td> 4801 <code>tlsValidateHostname</code></br> <em> bool </em> 4802 </td> 4803 <td> 4804 <em>(Optional)</em> 4805 <p> 4806 Whether the Pulsar client verify the validity of the host name from 4807 broker. 4808 </p> 4809 </td> 4810 </tr> 4811 <tr> 4812 <td> 4813 <code>tls</code></br> <em> 4814 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 4815 </td> 4816 <td> 4817 <em>(Optional)</em> 4818 <p> 4819 TLS configuration for the pulsar client. 4820 </p> 4821 </td> 4822 </tr> 4823 <tr> 4824 <td> 4825 <code>connectionBackoff</code></br> <em> 4826 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 4827 </td> 4828 <td> 4829 <em>(Optional)</em> 4830 <p> 4831 Backoff holds parameters applied to connection. 4832 </p> 4833 </td> 4834 </tr> 4835 <tr> 4836 <td> 4837 <code>jsonBody</code></br> <em> bool </em> 4838 </td> 4839 <td> 4840 <em>(Optional)</em> 4841 <p> 4842 JSONBody specifies that all event body payload coming from this source 4843 will be JSON 4844 </p> 4845 </td> 4846 </tr> 4847 <tr> 4848 <td> 4849 <code>metadata</code></br> <em> map\[string\]string </em> 4850 </td> 4851 <td> 4852 <em>(Optional)</em> 4853 <p> 4854 Metadata holds the user defined metadata which will passed along the 4855 event payload. 4856 </p> 4857 </td> 4858 </tr> 4859 <tr> 4860 <td> 4861 <code>authTokenSecret</code></br> <em> 4862 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4863 Kubernetes core/v1.SecretKeySelector </a> </em> 4864 </td> 4865 <td> 4866 <em>(Optional)</em> 4867 <p> 4868 Authentication token for the pulsar client. Either token or athenz can 4869 be set to use auth. 4870 </p> 4871 </td> 4872 </tr> 4873 <tr> 4874 <td> 4875 <code>filter</code></br> <em> 4876 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 4877 </a> </em> 4878 </td> 4879 <td> 4880 <em>(Optional)</em> 4881 <p> 4882 Filter 4883 </p> 4884 </td> 4885 </tr> 4886 <tr> 4887 <td> 4888 <code>authAthenzParams</code></br> <em> map\[string\]string </em> 4889 </td> 4890 <td> 4891 <em>(Optional)</em> 4892 <p> 4893 Authentication athenz parameters for the pulsar client. Refer 4894 <a href="https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go">https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go</a> 4895 Either token or athenz can be set to use auth. 4896 </p> 4897 </td> 4898 </tr> 4899 <tr> 4900 <td> 4901 <code>authAthenzSecret</code></br> <em> 4902 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4903 Kubernetes core/v1.SecretKeySelector </a> </em> 4904 </td> 4905 <td> 4906 <em>(Optional)</em> 4907 <p> 4908 Authentication athenz privateKey secret for the pulsar client. 4909 AuthAthenzSecret must be set if AuthAthenzParams is used. 4910 </p> 4911 </td> 4912 </tr> 4913 </tbody> 4914 </table> 4915 <h3 id="argoproj.io/v1alpha1.RedisEventSource"> 4916 RedisEventSource 4917 </h3> 4918 <p> 4919 (<em>Appears on:</em> 4920 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4921 </p> 4922 <p> 4923 <p> 4924 RedisEventSource describes an event source for the Redis PubSub. More 4925 info at 4926 <a href="https://godoc.org/github.com/go-redis/redis#example-PubSub">https://godoc.org/github.com/go-redis/redis#example-PubSub</a> 4927 </p> 4928 </p> 4929 <table> 4930 <thead> 4931 <tr> 4932 <th> 4933 Field 4934 </th> 4935 <th> 4936 Description 4937 </th> 4938 </tr> 4939 </thead> 4940 <tbody> 4941 <tr> 4942 <td> 4943 <code>hostAddress</code></br> <em> string </em> 4944 </td> 4945 <td> 4946 <p> 4947 HostAddress refers to the address of the Redis host/server 4948 </p> 4949 </td> 4950 </tr> 4951 <tr> 4952 <td> 4953 <code>password</code></br> <em> 4954 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4955 Kubernetes core/v1.SecretKeySelector </a> </em> 4956 </td> 4957 <td> 4958 <em>(Optional)</em> 4959 <p> 4960 Password required for authentication if any. 4961 </p> 4962 </td> 4963 </tr> 4964 <tr> 4965 <td> 4966 <code>namespace</code></br> <em> string </em> 4967 </td> 4968 <td> 4969 <em>(Optional)</em> 4970 <p> 4971 Namespace to use to retrieve the password from. It should only be 4972 specified if password is declared 4973 </p> 4974 </td> 4975 </tr> 4976 <tr> 4977 <td> 4978 <code>db</code></br> <em> int32 </em> 4979 </td> 4980 <td> 4981 <em>(Optional)</em> 4982 <p> 4983 DB to use. If not specified, default DB 0 will be used. 4984 </p> 4985 </td> 4986 </tr> 4987 <tr> 4988 <td> 4989 <code>channels</code></br> <em> \[\]string </em> 4990 </td> 4991 <td> 4992 </td> 4993 </tr> 4994 <tr> 4995 <td> 4996 <code>tls</code></br> <em> 4997 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 4998 </td> 4999 <td> 5000 <em>(Optional)</em> 5001 <p> 5002 TLS configuration for the redis client. 5003 </p> 5004 </td> 5005 </tr> 5006 <tr> 5007 <td> 5008 <code>metadata</code></br> <em> map\[string\]string </em> 5009 </td> 5010 <td> 5011 <em>(Optional)</em> 5012 <p> 5013 Metadata holds the user defined metadata which will passed along the 5014 event payload. 5015 </p> 5016 </td> 5017 </tr> 5018 <tr> 5019 <td> 5020 <code>filter</code></br> <em> 5021 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 5022 </a> </em> 5023 </td> 5024 <td> 5025 <em>(Optional)</em> 5026 <p> 5027 Filter 5028 </p> 5029 </td> 5030 </tr> 5031 <tr> 5032 <td> 5033 <code>jsonBody</code></br> <em> bool </em> 5034 </td> 5035 <td> 5036 <em>(Optional)</em> 5037 <p> 5038 JSONBody specifies that all event body payload coming from this source 5039 will be JSON 5040 </p> 5041 </td> 5042 </tr> 5043 <tr> 5044 <td> 5045 <code>username</code></br> <em> string </em> 5046 </td> 5047 <td> 5048 <em>(Optional)</em> 5049 <p> 5050 Username required for ACL style authentication if any. 5051 </p> 5052 </td> 5053 </tr> 5054 </tbody> 5055 </table> 5056 <h3 id="argoproj.io/v1alpha1.RedisStreamEventSource"> 5057 RedisStreamEventSource 5058 </h3> 5059 <p> 5060 (<em>Appears on:</em> 5061 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5062 </p> 5063 <p> 5064 <p> 5065 RedisStreamEventSource describes an event source for Redis streams 5066 (<a href="https://redis.io/topics/streams-intro">https://redis.io/topics/streams-intro</a>) 5067 </p> 5068 </p> 5069 <table> 5070 <thead> 5071 <tr> 5072 <th> 5073 Field 5074 </th> 5075 <th> 5076 Description 5077 </th> 5078 </tr> 5079 </thead> 5080 <tbody> 5081 <tr> 5082 <td> 5083 <code>hostAddress</code></br> <em> string </em> 5084 </td> 5085 <td> 5086 <p> 5087 HostAddress refers to the address of the Redis host/server (master 5088 instance) 5089 </p> 5090 </td> 5091 </tr> 5092 <tr> 5093 <td> 5094 <code>password</code></br> <em> 5095 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5096 Kubernetes core/v1.SecretKeySelector </a> </em> 5097 </td> 5098 <td> 5099 <em>(Optional)</em> 5100 <p> 5101 Password required for authentication if any. 5102 </p> 5103 </td> 5104 </tr> 5105 <tr> 5106 <td> 5107 <code>db</code></br> <em> int32 </em> 5108 </td> 5109 <td> 5110 <em>(Optional)</em> 5111 <p> 5112 DB to use. If not specified, default DB 0 will be used. 5113 </p> 5114 </td> 5115 </tr> 5116 <tr> 5117 <td> 5118 <code>streams</code></br> <em> \[\]string </em> 5119 </td> 5120 <td> 5121 <p> 5122 Streams to look for entries. XREADGROUP is used on all streams using a 5123 single consumer group. 5124 </p> 5125 </td> 5126 </tr> 5127 <tr> 5128 <td> 5129 <code>maxMsgCountPerRead</code></br> <em> int32 </em> 5130 </td> 5131 <td> 5132 <em>(Optional)</em> 5133 <p> 5134 MaxMsgCountPerRead holds the maximum number of messages per stream that 5135 will be read in each XREADGROUP of all streams Example: if there are 2 5136 streams and MaxMsgCountPerRead=10, then each XREADGROUP may read upto a 5137 total of 20 messages. Same as COUNT option in 5138 XREADGROUP(<a href="https://redis.io/topics/streams-intro">https://redis.io/topics/streams-intro</a>). 5139 Defaults to 10 5140 </p> 5141 </td> 5142 </tr> 5143 <tr> 5144 <td> 5145 <code>consumerGroup</code></br> <em> string </em> 5146 </td> 5147 <td> 5148 <em>(Optional)</em> 5149 <p> 5150 ConsumerGroup refers to the Redis stream consumer group that will be 5151 created on all redis streams. Messages are read through this group. 5152 Defaults to ‘argo-events-cg’ 5153 </p> 5154 </td> 5155 </tr> 5156 <tr> 5157 <td> 5158 <code>tls</code></br> <em> 5159 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 5160 </td> 5161 <td> 5162 <em>(Optional)</em> 5163 <p> 5164 TLS configuration for the redis client. 5165 </p> 5166 </td> 5167 </tr> 5168 <tr> 5169 <td> 5170 <code>metadata</code></br> <em> map\[string\]string </em> 5171 </td> 5172 <td> 5173 <em>(Optional)</em> 5174 <p> 5175 Metadata holds the user defined metadata which will passed along the 5176 event payload. 5177 </p> 5178 </td> 5179 </tr> 5180 <tr> 5181 <td> 5182 <code>filter</code></br> <em> 5183 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 5184 </a> </em> 5185 </td> 5186 <td> 5187 <em>(Optional)</em> 5188 <p> 5189 Filter 5190 </p> 5191 </td> 5192 </tr> 5193 <tr> 5194 <td> 5195 <code>username</code></br> <em> string </em> 5196 </td> 5197 <td> 5198 <em>(Optional)</em> 5199 <p> 5200 Username required for ACL style authentication if any. 5201 </p> 5202 </td> 5203 </tr> 5204 </tbody> 5205 </table> 5206 <h3 id="argoproj.io/v1alpha1.ResourceEventSource"> 5207 ResourceEventSource 5208 </h3> 5209 <p> 5210 (<em>Appears on:</em> 5211 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5212 </p> 5213 <p> 5214 <p> 5215 ResourceEventSource refers to a event-source for K8s resource related 5216 events. 5217 </p> 5218 </p> 5219 <table> 5220 <thead> 5221 <tr> 5222 <th> 5223 Field 5224 </th> 5225 <th> 5226 Description 5227 </th> 5228 </tr> 5229 </thead> 5230 <tbody> 5231 <tr> 5232 <td> 5233 <code>namespace</code></br> <em> string </em> 5234 </td> 5235 <td> 5236 <p> 5237 Namespace where resource is deployed 5238 </p> 5239 </td> 5240 </tr> 5241 <tr> 5242 <td> 5243 <code>filter</code></br> <em> 5244 <a href="#argoproj.io/v1alpha1.ResourceFilter"> ResourceFilter </a> 5245 </em> 5246 </td> 5247 <td> 5248 <em>(Optional)</em> 5249 <p> 5250 Filter is applied on the metadata of the resource If you apply filter, 5251 then the internal event informer will only monitor objects that pass the 5252 filter. 5253 </p> 5254 </td> 5255 </tr> 5256 <tr> 5257 <td> 5258 <code>GroupVersionResource</code></br> <em> 5259 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#groupversionresource-v1-meta"> 5260 Kubernetes meta/v1.GroupVersionResource </a> </em> 5261 </td> 5262 <td> 5263 <p> 5264 (Members of <code>GroupVersionResource</code> are embedded into this 5265 type.) 5266 </p> 5267 <p> 5268 Group of the resource 5269 </p> 5270 </td> 5271 </tr> 5272 <tr> 5273 <td> 5274 <code>eventTypes</code></br> <em> 5275 <a href="#argoproj.io/v1alpha1.ResourceEventType"> \[\]ResourceEventType 5276 </a> </em> 5277 </td> 5278 <td> 5279 <p> 5280 EventTypes is the list of event type to watch. Possible values are - 5281 ADD, UPDATE and DELETE. 5282 </p> 5283 </td> 5284 </tr> 5285 <tr> 5286 <td> 5287 <code>metadata</code></br> <em> map\[string\]string </em> 5288 </td> 5289 <td> 5290 <em>(Optional)</em> 5291 <p> 5292 Metadata holds the user defined metadata which will passed along the 5293 event payload. 5294 </p> 5295 </td> 5296 </tr> 5297 </tbody> 5298 </table> 5299 <h3 id="argoproj.io/v1alpha1.ResourceEventType"> 5300 ResourceEventType (<code>string</code> alias) 5301 </p> 5302 </h3> 5303 <p> 5304 (<em>Appears on:</em> 5305 <a href="#argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource</a>) 5306 </p> 5307 <p> 5308 <p> 5309 ResourceEventType is the type of event for the K8s resource mutation 5310 </p> 5311 </p> 5312 <h3 id="argoproj.io/v1alpha1.ResourceFilter"> 5313 ResourceFilter 5314 </h3> 5315 <p> 5316 (<em>Appears on:</em> 5317 <a href="#argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource</a>) 5318 </p> 5319 <p> 5320 <p> 5321 ResourceFilter contains K8s ObjectMeta information to further filter 5322 resource event objects 5323 </p> 5324 </p> 5325 <table> 5326 <thead> 5327 <tr> 5328 <th> 5329 Field 5330 </th> 5331 <th> 5332 Description 5333 </th> 5334 </tr> 5335 </thead> 5336 <tbody> 5337 <tr> 5338 <td> 5339 <code>prefix</code></br> <em> string </em> 5340 </td> 5341 <td> 5342 <em>(Optional)</em> 5343 <p> 5344 Prefix filter is applied on the resource name. 5345 </p> 5346 </td> 5347 </tr> 5348 <tr> 5349 <td> 5350 <code>labels</code></br> <em> <a href="#argoproj.io/v1alpha1.Selector"> 5351 \[\]Selector </a> </em> 5352 </td> 5353 <td> 5354 <em>(Optional)</em> 5355 <p> 5356 Labels provide listing options to K8s API to watch resource/s. Refer 5357 <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/">https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/</a> 5358 for more info. Unlike K8s field selector, multiple values are passed as 5359 comma separated values instead of list of values. Eg: value: 5360 value1,value2. Same as K8s label selector, operator “=”, “==”, “!=”, 5361 “exists”, “!”, “notin”, “in”, “gt” and “lt” are supported 5362 </p> 5363 </td> 5364 </tr> 5365 <tr> 5366 <td> 5367 <code>fields</code></br> <em> <a href="#argoproj.io/v1alpha1.Selector"> 5368 \[\]Selector </a> </em> 5369 </td> 5370 <td> 5371 <em>(Optional)</em> 5372 <p> 5373 Fields provide field filters similar to K8s field selector (see 5374 <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/">https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/</a>). 5375 Unlike K8s field selector, it supports arbitrary fileds like 5376 “spec.serviceAccountName”, and the value could be a string or a regex. 5377 Same as K8s field selector, operator “=”, “==” and “!=” are supported. 5378 </p> 5379 </td> 5380 </tr> 5381 <tr> 5382 <td> 5383 <code>createdBy</code></br> <em> 5384 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#time-v1-meta"> 5385 Kubernetes meta/v1.Time </a> </em> 5386 </td> 5387 <td> 5388 <em>(Optional)</em> 5389 <p> 5390 If resource is created before the specified time then the event is 5391 treated as valid. 5392 </p> 5393 </td> 5394 </tr> 5395 <tr> 5396 <td> 5397 <code>afterStart</code></br> <em> bool </em> 5398 </td> 5399 <td> 5400 <em>(Optional)</em> 5401 <p> 5402 If the resource is created after the start time then the event is 5403 treated as valid. 5404 </p> 5405 </td> 5406 </tr> 5407 </tbody> 5408 </table> 5409 <h3 id="argoproj.io/v1alpha1.SFTPEventSource"> 5410 SFTPEventSource 5411 </h3> 5412 <p> 5413 (<em>Appears on:</em> 5414 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5415 </p> 5416 <p> 5417 <p> 5418 SFTPEventSource describes an event-source for sftp related events. 5419 </p> 5420 </p> 5421 <table> 5422 <thead> 5423 <tr> 5424 <th> 5425 Field 5426 </th> 5427 <th> 5428 Description 5429 </th> 5430 </tr> 5431 </thead> 5432 <tbody> 5433 <tr> 5434 <td> 5435 <code>eventType</code></br> <em> string </em> 5436 </td> 5437 <td> 5438 <p> 5439 Type of file operations to watch Refer 5440 <a href="https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go">https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go</a> 5441 for more information 5442 </p> 5443 </td> 5444 </tr> 5445 <tr> 5446 <td> 5447 <code>watchPathConfig</code></br> <em> 5448 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> WatchPathConfig </a> 5449 </em> 5450 </td> 5451 <td> 5452 <p> 5453 WatchPathConfig contains configuration about the file path to watch 5454 </p> 5455 </td> 5456 </tr> 5457 <tr> 5458 <td> 5459 <code>username</code></br> <em> 5460 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5461 Kubernetes core/v1.SecretKeySelector </a> </em> 5462 </td> 5463 <td> 5464 <p> 5465 Username required for authentication if any. 5466 </p> 5467 </td> 5468 </tr> 5469 <tr> 5470 <td> 5471 <code>password</code></br> <em> 5472 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5473 Kubernetes core/v1.SecretKeySelector </a> </em> 5474 </td> 5475 <td> 5476 <p> 5477 Password required for authentication if any. 5478 </p> 5479 </td> 5480 </tr> 5481 <tr> 5482 <td> 5483 <code>sshKeySecret</code></br> <em> 5484 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5485 Kubernetes core/v1.SecretKeySelector </a> </em> 5486 </td> 5487 <td> 5488 <p> 5489 SSHKeySecret refers to the secret that contains SSH key 5490 </p> 5491 </td> 5492 </tr> 5493 <tr> 5494 <td> 5495 <code>address</code></br> <em> 5496 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5497 Kubernetes core/v1.SecretKeySelector </a> </em> 5498 </td> 5499 <td> 5500 <p> 5501 Address sftp address. 5502 </p> 5503 </td> 5504 </tr> 5505 <tr> 5506 <td> 5507 <code>metadata</code></br> <em> map\[string\]string </em> 5508 </td> 5509 <td> 5510 <em>(Optional)</em> 5511 <p> 5512 Metadata holds the user defined metadata which will passed along the 5513 event payload. 5514 </p> 5515 </td> 5516 </tr> 5517 <tr> 5518 <td> 5519 <code>filter</code></br> <em> 5520 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 5521 </a> </em> 5522 </td> 5523 <td> 5524 <em>(Optional)</em> 5525 <p> 5526 Filter 5527 </p> 5528 </td> 5529 </tr> 5530 <tr> 5531 <td> 5532 <code>pollIntervalDuration</code></br> <em> string </em> 5533 </td> 5534 <td> 5535 <em>(Optional)</em> 5536 <p> 5537 PollIntervalDuration the interval at which to poll the SFTP server 5538 defaults to 10 seconds 5539 </p> 5540 </td> 5541 </tr> 5542 </tbody> 5543 </table> 5544 <h3 id="argoproj.io/v1alpha1.SNSEventSource"> 5545 SNSEventSource 5546 </h3> 5547 <p> 5548 (<em>Appears on:</em> 5549 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5550 </p> 5551 <p> 5552 <p> 5553 SNSEventSource refers to event-source for AWS SNS related events 5554 </p> 5555 </p> 5556 <table> 5557 <thead> 5558 <tr> 5559 <th> 5560 Field 5561 </th> 5562 <th> 5563 Description 5564 </th> 5565 </tr> 5566 </thead> 5567 <tbody> 5568 <tr> 5569 <td> 5570 <code>webhook</code></br> <em> 5571 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 5572 </em> 5573 </td> 5574 <td> 5575 <p> 5576 Webhook configuration for http server 5577 </p> 5578 </td> 5579 </tr> 5580 <tr> 5581 <td> 5582 <code>topicArn</code></br> <em> string </em> 5583 </td> 5584 <td> 5585 <p> 5586 TopicArn 5587 </p> 5588 </td> 5589 </tr> 5590 <tr> 5591 <td> 5592 <code>accessKey</code></br> <em> 5593 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5594 Kubernetes core/v1.SecretKeySelector </a> </em> 5595 </td> 5596 <td> 5597 <p> 5598 AccessKey refers K8s secret containing aws access key 5599 </p> 5600 </td> 5601 </tr> 5602 <tr> 5603 <td> 5604 <code>secretKey</code></br> <em> 5605 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5606 Kubernetes core/v1.SecretKeySelector </a> </em> 5607 </td> 5608 <td> 5609 <p> 5610 SecretKey refers K8s secret containing aws secret key 5611 </p> 5612 </td> 5613 </tr> 5614 <tr> 5615 <td> 5616 <code>region</code></br> <em> string </em> 5617 </td> 5618 <td> 5619 <p> 5620 Region is AWS region 5621 </p> 5622 </td> 5623 </tr> 5624 <tr> 5625 <td> 5626 <code>roleARN</code></br> <em> string </em> 5627 </td> 5628 <td> 5629 <em>(Optional)</em> 5630 <p> 5631 RoleARN is the Amazon Resource Name (ARN) of the role to assume. 5632 </p> 5633 </td> 5634 </tr> 5635 <tr> 5636 <td> 5637 <code>metadata</code></br> <em> map\[string\]string </em> 5638 </td> 5639 <td> 5640 <em>(Optional)</em> 5641 <p> 5642 Metadata holds the user defined metadata which will passed along the 5643 event payload. 5644 </p> 5645 </td> 5646 </tr> 5647 <tr> 5648 <td> 5649 <code>validateSignature</code></br> <em> bool </em> 5650 </td> 5651 <td> 5652 <em>(Optional)</em> 5653 <p> 5654 ValidateSignature is boolean that can be set to true for SNS signature 5655 verification 5656 </p> 5657 </td> 5658 </tr> 5659 <tr> 5660 <td> 5661 <code>filter</code></br> <em> 5662 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 5663 </a> </em> 5664 </td> 5665 <td> 5666 <em>(Optional)</em> 5667 <p> 5668 Filter 5669 </p> 5670 </td> 5671 </tr> 5672 <tr> 5673 <td> 5674 <code>endpoint</code></br> <em> string </em> 5675 </td> 5676 <td> 5677 <em>(Optional)</em> 5678 <p> 5679 Endpoint configures connection to a specific SNS endpoint instead of 5680 Amazons servers 5681 </p> 5682 </td> 5683 </tr> 5684 </tbody> 5685 </table> 5686 <h3 id="argoproj.io/v1alpha1.SQSEventSource"> 5687 SQSEventSource 5688 </h3> 5689 <p> 5690 (<em>Appears on:</em> 5691 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5692 </p> 5693 <p> 5694 <p> 5695 SQSEventSource refers to event-source for AWS SQS related events 5696 </p> 5697 </p> 5698 <table> 5699 <thead> 5700 <tr> 5701 <th> 5702 Field 5703 </th> 5704 <th> 5705 Description 5706 </th> 5707 </tr> 5708 </thead> 5709 <tbody> 5710 <tr> 5711 <td> 5712 <code>accessKey</code></br> <em> 5713 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5714 Kubernetes core/v1.SecretKeySelector </a> </em> 5715 </td> 5716 <td> 5717 <p> 5718 AccessKey refers K8s secret containing aws access key 5719 </p> 5720 </td> 5721 </tr> 5722 <tr> 5723 <td> 5724 <code>secretKey</code></br> <em> 5725 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5726 Kubernetes core/v1.SecretKeySelector </a> </em> 5727 </td> 5728 <td> 5729 <p> 5730 SecretKey refers K8s secret containing aws secret key 5731 </p> 5732 </td> 5733 </tr> 5734 <tr> 5735 <td> 5736 <code>region</code></br> <em> string </em> 5737 </td> 5738 <td> 5739 <p> 5740 Region is AWS region 5741 </p> 5742 </td> 5743 </tr> 5744 <tr> 5745 <td> 5746 <code>queue</code></br> <em> string </em> 5747 </td> 5748 <td> 5749 <p> 5750 Queue is AWS SQS queue to listen to for messages 5751 </p> 5752 </td> 5753 </tr> 5754 <tr> 5755 <td> 5756 <code>waitTimeSeconds</code></br> <em> int64 </em> 5757 </td> 5758 <td> 5759 <p> 5760 WaitTimeSeconds is The duration (in seconds) for which the call waits 5761 for a message to arrive in the queue before returning. 5762 </p> 5763 </td> 5764 </tr> 5765 <tr> 5766 <td> 5767 <code>roleARN</code></br> <em> string </em> 5768 </td> 5769 <td> 5770 <em>(Optional)</em> 5771 <p> 5772 RoleARN is the Amazon Resource Name (ARN) of the role to assume. 5773 </p> 5774 </td> 5775 </tr> 5776 <tr> 5777 <td> 5778 <code>jsonBody</code></br> <em> bool </em> 5779 </td> 5780 <td> 5781 <em>(Optional)</em> 5782 <p> 5783 JSONBody specifies that all event body payload coming from this source 5784 will be JSON 5785 </p> 5786 </td> 5787 </tr> 5788 <tr> 5789 <td> 5790 <code>queueAccountId</code></br> <em> string </em> 5791 </td> 5792 <td> 5793 <em>(Optional)</em> 5794 <p> 5795 QueueAccountID is the ID of the account that created the queue to 5796 monitor 5797 </p> 5798 </td> 5799 </tr> 5800 <tr> 5801 <td> 5802 <code>metadata</code></br> <em> map\[string\]string </em> 5803 </td> 5804 <td> 5805 <em>(Optional)</em> 5806 <p> 5807 Metadata holds the user defined metadata which will passed along the 5808 event payload. 5809 </p> 5810 </td> 5811 </tr> 5812 <tr> 5813 <td> 5814 <code>dlq</code></br> <em> bool </em> 5815 </td> 5816 <td> 5817 <em>(Optional)</em> 5818 <p> 5819 DLQ specifies if a dead-letter queue is configured for messages that 5820 can’t be processed successfully. If set to true, messages with invalid 5821 payload won’t be acknowledged to allow to forward them farther to the 5822 dead-letter queue. The default value is false. 5823 </p> 5824 </td> 5825 </tr> 5826 <tr> 5827 <td> 5828 <code>filter</code></br> <em> 5829 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 5830 </a> </em> 5831 </td> 5832 <td> 5833 <em>(Optional)</em> 5834 <p> 5835 Filter 5836 </p> 5837 </td> 5838 </tr> 5839 <tr> 5840 <td> 5841 <code>endpoint</code></br> <em> string </em> 5842 </td> 5843 <td> 5844 <em>(Optional)</em> 5845 <p> 5846 Endpoint configures connection to a specific SQS endpoint instead of 5847 Amazons servers 5848 </p> 5849 </td> 5850 </tr> 5851 <tr> 5852 <td> 5853 <code>sessionToken</code></br> <em> 5854 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5855 Kubernetes core/v1.SecretKeySelector </a> </em> 5856 </td> 5857 <td> 5858 <em>(Optional)</em> 5859 <p> 5860 SessionToken refers to K8s secret containing AWS temporary 5861 credentials(STS) session token 5862 </p> 5863 </td> 5864 </tr> 5865 </tbody> 5866 </table> 5867 <h3 id="argoproj.io/v1alpha1.Selector"> 5868 Selector 5869 </h3> 5870 <p> 5871 (<em>Appears on:</em> 5872 <a href="#argoproj.io/v1alpha1.ResourceFilter">ResourceFilter</a>) 5873 </p> 5874 <p> 5875 <p> 5876 Selector represents conditional operation to select K8s objects. 5877 </p> 5878 </p> 5879 <table> 5880 <thead> 5881 <tr> 5882 <th> 5883 Field 5884 </th> 5885 <th> 5886 Description 5887 </th> 5888 </tr> 5889 </thead> 5890 <tbody> 5891 <tr> 5892 <td> 5893 <code>key</code></br> <em> string </em> 5894 </td> 5895 <td> 5896 <p> 5897 Key name 5898 </p> 5899 </td> 5900 </tr> 5901 <tr> 5902 <td> 5903 <code>operation</code></br> <em> string </em> 5904 </td> 5905 <td> 5906 <em>(Optional)</em> 5907 <p> 5908 Supported operations like ==, != etc. Defaults to ==. Refer 5909 <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a> 5910 for more info. 5911 </p> 5912 </td> 5913 </tr> 5914 <tr> 5915 <td> 5916 <code>value</code></br> <em> string </em> 5917 </td> 5918 <td> 5919 <p> 5920 Value 5921 </p> 5922 </td> 5923 </tr> 5924 </tbody> 5925 </table> 5926 <h3 id="argoproj.io/v1alpha1.Service"> 5927 Service 5928 </h3> 5929 <p> 5930 (<em>Appears on:</em> 5931 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5932 </p> 5933 <p> 5934 <p> 5935 Service holds the service information eventsource exposes 5936 </p> 5937 </p> 5938 <table> 5939 <thead> 5940 <tr> 5941 <th> 5942 Field 5943 </th> 5944 <th> 5945 Description 5946 </th> 5947 </tr> 5948 </thead> 5949 <tbody> 5950 <tr> 5951 <td> 5952 <code>ports</code></br> <em> 5953 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#serviceport-v1-core"> 5954 \[\]Kubernetes core/v1.ServicePort </a> </em> 5955 </td> 5956 <td> 5957 <p> 5958 The list of ports that are exposed by this ClusterIP service. 5959 </p> 5960 </td> 5961 </tr> 5962 <tr> 5963 <td> 5964 <code>clusterIP</code></br> <em> string </em> 5965 </td> 5966 <td> 5967 <em>(Optional)</em> 5968 <p> 5969 clusterIP is the IP address of the service and is usually assigned 5970 randomly by the master. If an address is specified manually and is not 5971 in use by others, it will be allocated to the service; otherwise, 5972 creation of the service will fail. This field can not be changed through 5973 updates. Valid values are “None”, empty string (“”), or a valid IP 5974 address. “None” can be specified for headless services when proxying is 5975 not required. More info: 5976 <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a> 5977 </p> 5978 </td> 5979 </tr> 5980 </tbody> 5981 </table> 5982 <h3 id="argoproj.io/v1alpha1.SlackEventSource"> 5983 SlackEventSource 5984 </h3> 5985 <p> 5986 (<em>Appears on:</em> 5987 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5988 </p> 5989 <p> 5990 <p> 5991 SlackEventSource refers to event-source for Slack related events 5992 </p> 5993 </p> 5994 <table> 5995 <thead> 5996 <tr> 5997 <th> 5998 Field 5999 </th> 6000 <th> 6001 Description 6002 </th> 6003 </tr> 6004 </thead> 6005 <tbody> 6006 <tr> 6007 <td> 6008 <code>signingSecret</code></br> <em> 6009 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6010 Kubernetes core/v1.SecretKeySelector </a> </em> 6011 </td> 6012 <td> 6013 <p> 6014 Slack App signing secret 6015 </p> 6016 </td> 6017 </tr> 6018 <tr> 6019 <td> 6020 <code>token</code></br> <em> 6021 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6022 Kubernetes core/v1.SecretKeySelector </a> </em> 6023 </td> 6024 <td> 6025 <p> 6026 Token for URL verification handshake 6027 </p> 6028 </td> 6029 </tr> 6030 <tr> 6031 <td> 6032 <code>webhook</code></br> <em> 6033 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 6034 </em> 6035 </td> 6036 <td> 6037 <p> 6038 Webhook holds configuration for a REST endpoint 6039 </p> 6040 </td> 6041 </tr> 6042 <tr> 6043 <td> 6044 <code>metadata</code></br> <em> map\[string\]string </em> 6045 </td> 6046 <td> 6047 <em>(Optional)</em> 6048 <p> 6049 Metadata holds the user defined metadata which will passed along the 6050 event payload. 6051 </p> 6052 </td> 6053 </tr> 6054 <tr> 6055 <td> 6056 <code>filter</code></br> <em> 6057 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 6058 </a> </em> 6059 </td> 6060 <td> 6061 <em>(Optional)</em> 6062 <p> 6063 Filter 6064 </p> 6065 </td> 6066 </tr> 6067 </tbody> 6068 </table> 6069 <h3 id="argoproj.io/v1alpha1.StorageGridEventSource"> 6070 StorageGridEventSource 6071 </h3> 6072 <p> 6073 (<em>Appears on:</em> 6074 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6075 </p> 6076 <p> 6077 <p> 6078 StorageGridEventSource refers to event-source for StorageGrid related 6079 events 6080 </p> 6081 </p> 6082 <table> 6083 <thead> 6084 <tr> 6085 <th> 6086 Field 6087 </th> 6088 <th> 6089 Description 6090 </th> 6091 </tr> 6092 </thead> 6093 <tbody> 6094 <tr> 6095 <td> 6096 <code>webhook</code></br> <em> 6097 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 6098 </em> 6099 </td> 6100 <td> 6101 <p> 6102 Webhook holds configuration for a REST endpoint 6103 </p> 6104 </td> 6105 </tr> 6106 <tr> 6107 <td> 6108 <code>events</code></br> <em> \[\]string </em> 6109 </td> 6110 <td> 6111 </td> 6112 </tr> 6113 <tr> 6114 <td> 6115 <code>filter</code></br> <em> 6116 <a href="#argoproj.io/v1alpha1.StorageGridFilter"> StorageGridFilter 6117 </a> </em> 6118 </td> 6119 <td> 6120 <p> 6121 Filter on object key which caused the notification. 6122 </p> 6123 </td> 6124 </tr> 6125 <tr> 6126 <td> 6127 <code>topicArn</code></br> <em> string </em> 6128 </td> 6129 <td> 6130 <p> 6131 TopicArn 6132 </p> 6133 </td> 6134 </tr> 6135 <tr> 6136 <td> 6137 <code>bucket</code></br> <em> string </em> 6138 </td> 6139 <td> 6140 <p> 6141 Name of the bucket to register notifications for. 6142 </p> 6143 </td> 6144 </tr> 6145 <tr> 6146 <td> 6147 <code>region</code></br> <em> string </em> 6148 </td> 6149 <td> 6150 <em>(Optional)</em> 6151 <p> 6152 S3 region. Defaults to us-east-1 6153 </p> 6154 </td> 6155 </tr> 6156 <tr> 6157 <td> 6158 <code>authToken</code></br> <em> 6159 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6160 Kubernetes core/v1.SecretKeySelector </a> </em> 6161 </td> 6162 <td> 6163 <p> 6164 Auth token for storagegrid api 6165 </p> 6166 </td> 6167 </tr> 6168 <tr> 6169 <td> 6170 <code>apiURL</code></br> <em> string </em> 6171 </td> 6172 <td> 6173 <p> 6174 APIURL is the url of the storagegrid api. 6175 </p> 6176 </td> 6177 </tr> 6178 <tr> 6179 <td> 6180 <code>metadata</code></br> <em> map\[string\]string </em> 6181 </td> 6182 <td> 6183 <em>(Optional)</em> 6184 <p> 6185 Metadata holds the user defined metadata which will passed along the 6186 event payload. 6187 </p> 6188 </td> 6189 </tr> 6190 </tbody> 6191 </table> 6192 <h3 id="argoproj.io/v1alpha1.StorageGridFilter"> 6193 StorageGridFilter 6194 </h3> 6195 <p> 6196 (<em>Appears on:</em> 6197 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">StorageGridEventSource</a>) 6198 </p> 6199 <p> 6200 <p> 6201 StorageGridFilter represents filters to apply to bucket notifications 6202 for specifying constraints on objects 6203 </p> 6204 </p> 6205 <table> 6206 <thead> 6207 <tr> 6208 <th> 6209 Field 6210 </th> 6211 <th> 6212 Description 6213 </th> 6214 </tr> 6215 </thead> 6216 <tbody> 6217 <tr> 6218 <td> 6219 <code>prefix</code></br> <em> string </em> 6220 </td> 6221 <td> 6222 </td> 6223 </tr> 6224 <tr> 6225 <td> 6226 <code>suffix</code></br> <em> string </em> 6227 </td> 6228 <td> 6229 </td> 6230 </tr> 6231 </tbody> 6232 </table> 6233 <h3 id="argoproj.io/v1alpha1.StripeEventSource"> 6234 StripeEventSource 6235 </h3> 6236 <p> 6237 (<em>Appears on:</em> 6238 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6239 </p> 6240 <p> 6241 <p> 6242 StripeEventSource describes the event source for stripe webhook 6243 notifications More info at 6244 <a href="https://stripe.com/docs/webhooks">https://stripe.com/docs/webhooks</a> 6245 </p> 6246 </p> 6247 <table> 6248 <thead> 6249 <tr> 6250 <th> 6251 Field 6252 </th> 6253 <th> 6254 Description 6255 </th> 6256 </tr> 6257 </thead> 6258 <tbody> 6259 <tr> 6260 <td> 6261 <code>webhook</code></br> <em> 6262 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 6263 </em> 6264 </td> 6265 <td> 6266 <p> 6267 Webhook holds configuration for a REST endpoint 6268 </p> 6269 </td> 6270 </tr> 6271 <tr> 6272 <td> 6273 <code>createWebhook</code></br> <em> bool </em> 6274 </td> 6275 <td> 6276 <em>(Optional)</em> 6277 <p> 6278 CreateWebhook if specified creates a new webhook programmatically. 6279 </p> 6280 </td> 6281 </tr> 6282 <tr> 6283 <td> 6284 <code>apiKey</code></br> <em> 6285 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6286 Kubernetes core/v1.SecretKeySelector </a> </em> 6287 </td> 6288 <td> 6289 <em>(Optional)</em> 6290 <p> 6291 APIKey refers to K8s secret that holds Stripe API key. Used only if 6292 CreateWebhook is enabled. 6293 </p> 6294 </td> 6295 </tr> 6296 <tr> 6297 <td> 6298 <code>eventFilter</code></br> <em> \[\]string </em> 6299 </td> 6300 <td> 6301 <em>(Optional)</em> 6302 <p> 6303 EventFilter describes the type of events to listen to. If not specified, 6304 all types of events will be processed. More info at 6305 <a href="https://stripe.com/docs/api/events/list">https://stripe.com/docs/api/events/list</a> 6306 </p> 6307 </td> 6308 </tr> 6309 <tr> 6310 <td> 6311 <code>metadata</code></br> <em> map\[string\]string </em> 6312 </td> 6313 <td> 6314 <em>(Optional)</em> 6315 <p> 6316 Metadata holds the user defined metadata which will passed along the 6317 event payload. 6318 </p> 6319 </td> 6320 </tr> 6321 </tbody> 6322 </table> 6323 <h3 id="argoproj.io/v1alpha1.Template"> 6324 Template 6325 </h3> 6326 <p> 6327 (<em>Appears on:</em> 6328 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6329 </p> 6330 <p> 6331 <p> 6332 Template holds the information of an EventSource deployment template 6333 </p> 6334 </p> 6335 <table> 6336 <thead> 6337 <tr> 6338 <th> 6339 Field 6340 </th> 6341 <th> 6342 Description 6343 </th> 6344 </tr> 6345 </thead> 6346 <tbody> 6347 <tr> 6348 <td> 6349 <code>metadata</code></br> <em> 6350 github.com/argoproj/argo-events/pkg/apis/common.Metadata </em> 6351 </td> 6352 <td> 6353 <p> 6354 Metadata sets the pods’s metadata, i.e. annotations and labels 6355 </p> 6356 </td> 6357 </tr> 6358 <tr> 6359 <td> 6360 <code>serviceAccountName</code></br> <em> string </em> 6361 </td> 6362 <td> 6363 <em>(Optional)</em> 6364 <p> 6365 ServiceAccountName is the name of the ServiceAccount to use to run event 6366 source pod. More info: 6367 <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/">https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/</a> 6368 </p> 6369 </td> 6370 </tr> 6371 <tr> 6372 <td> 6373 <code>container</code></br> <em> 6374 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core"> 6375 Kubernetes core/v1.Container </a> </em> 6376 </td> 6377 <td> 6378 <em>(Optional)</em> 6379 <p> 6380 Container is the main container image to run in the event source pod 6381 </p> 6382 </td> 6383 </tr> 6384 <tr> 6385 <td> 6386 <code>volumes</code></br> <em> 6387 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#volume-v1-core"> 6388 \[\]Kubernetes core/v1.Volume </a> </em> 6389 </td> 6390 <td> 6391 <em>(Optional)</em> 6392 <p> 6393 Volumes is a list of volumes that can be mounted by containers in an 6394 eventsource. 6395 </p> 6396 </td> 6397 </tr> 6398 <tr> 6399 <td> 6400 <code>securityContext</code></br> <em> 6401 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core"> 6402 Kubernetes core/v1.PodSecurityContext </a> </em> 6403 </td> 6404 <td> 6405 <em>(Optional)</em> 6406 <p> 6407 SecurityContext holds pod-level security attributes and common container 6408 settings. Optional: Defaults to empty. See type description for default 6409 values of each field. 6410 </p> 6411 </td> 6412 </tr> 6413 <tr> 6414 <td> 6415 <code>affinity</code></br> <em> 6416 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core"> 6417 Kubernetes core/v1.Affinity </a> </em> 6418 </td> 6419 <td> 6420 <em>(Optional)</em> 6421 <p> 6422 If specified, the pod’s scheduling constraints 6423 </p> 6424 </td> 6425 </tr> 6426 <tr> 6427 <td> 6428 <code>tolerations</code></br> <em> 6429 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core"> 6430 \[\]Kubernetes core/v1.Toleration </a> </em> 6431 </td> 6432 <td> 6433 <em>(Optional)</em> 6434 <p> 6435 If specified, the pod’s tolerations. 6436 </p> 6437 </td> 6438 </tr> 6439 <tr> 6440 <td> 6441 <code>nodeSelector</code></br> <em> map\[string\]string </em> 6442 </td> 6443 <td> 6444 <em>(Optional)</em> 6445 <p> 6446 NodeSelector is a selector which must be true for the pod to fit on a 6447 node. Selector which must match a node’s labels for the pod to be 6448 scheduled on that node. More info: 6449 <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a> 6450 </p> 6451 </td> 6452 </tr> 6453 <tr> 6454 <td> 6455 <code>imagePullSecrets</code></br> <em> 6456 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core"> 6457 \[\]Kubernetes core/v1.LocalObjectReference </a> </em> 6458 </td> 6459 <td> 6460 <em>(Optional)</em> 6461 <p> 6462 ImagePullSecrets is an optional list of references to secrets in the 6463 same namespace to use for pulling any of the images used by this 6464 PodSpec. If specified, these secrets will be passed to individual puller 6465 implementations for them to use. For example, in the case of docker, 6466 only DockerConfig type secrets are honored. More info: 6467 <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> 6468 </p> 6469 </td> 6470 </tr> 6471 <tr> 6472 <td> 6473 <code>priorityClassName</code></br> <em> string </em> 6474 </td> 6475 <td> 6476 <em>(Optional)</em> 6477 <p> 6478 If specified, indicates the EventSource pod’s priority. 6479 “system-node-critical” and “system-cluster-critical” are two special 6480 keywords which indicate the highest priorities with the former being the 6481 highest priority. Any other name must be defined by creating a 6482 PriorityClass object with that name. If not specified, the pod priority 6483 will be default or zero if there is no default. More info: 6484 <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a> 6485 </p> 6486 </td> 6487 </tr> 6488 <tr> 6489 <td> 6490 <code>priority</code></br> <em> int32 </em> 6491 </td> 6492 <td> 6493 <em>(Optional)</em> 6494 <p> 6495 The priority value. Various system components use this field to find the 6496 priority of the EventSource pod. When Priority Admission Controller is 6497 enabled, it prevents users from setting this field. The admission 6498 controller populates this field from PriorityClassName. The higher the 6499 value, the higher the priority. More info: 6500 <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a> 6501 </p> 6502 </td> 6503 </tr> 6504 </tbody> 6505 </table> 6506 <h3 id="argoproj.io/v1alpha1.WatchPathConfig"> 6507 WatchPathConfig 6508 </h3> 6509 <p> 6510 (<em>Appears on:</em> 6511 <a href="#argoproj.io/v1alpha1.FileEventSource">FileEventSource</a>, 6512 <a href="#argoproj.io/v1alpha1.HDFSEventSource">HDFSEventSource</a>, 6513 <a href="#argoproj.io/v1alpha1.SFTPEventSource">SFTPEventSource</a>) 6514 </p> 6515 <p> 6516 </p> 6517 <table> 6518 <thead> 6519 <tr> 6520 <th> 6521 Field 6522 </th> 6523 <th> 6524 Description 6525 </th> 6526 </tr> 6527 </thead> 6528 <tbody> 6529 <tr> 6530 <td> 6531 <code>directory</code></br> <em> string </em> 6532 </td> 6533 <td> 6534 <p> 6535 Directory to watch for events 6536 </p> 6537 </td> 6538 </tr> 6539 <tr> 6540 <td> 6541 <code>path</code></br> <em> string </em> 6542 </td> 6543 <td> 6544 <p> 6545 Path is relative path of object to watch with respect to the directory 6546 </p> 6547 </td> 6548 </tr> 6549 <tr> 6550 <td> 6551 <code>pathRegexp</code></br> <em> string </em> 6552 </td> 6553 <td> 6554 <p> 6555 PathRegexp is regexp of relative path of object to watch with respect to 6556 the directory 6557 </p> 6558 </td> 6559 </tr> 6560 </tbody> 6561 </table> 6562 <h3 id="argoproj.io/v1alpha1.WebhookContext"> 6563 WebhookContext 6564 </h3> 6565 <p> 6566 (<em>Appears on:</em> 6567 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>, 6568 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>, 6569 <a href="#argoproj.io/v1alpha1.GerritEventSource">GerritEventSource</a>, 6570 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>, 6571 <a href="#argoproj.io/v1alpha1.GitlabEventSource">GitlabEventSource</a>, 6572 <a href="#argoproj.io/v1alpha1.SNSEventSource">SNSEventSource</a>, 6573 <a href="#argoproj.io/v1alpha1.SlackEventSource">SlackEventSource</a>, 6574 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">StorageGridEventSource</a>, 6575 <a href="#argoproj.io/v1alpha1.StripeEventSource">StripeEventSource</a>, 6576 <a href="#argoproj.io/v1alpha1.WebhookEventSource">WebhookEventSource</a>) 6577 </p> 6578 <p> 6579 <p> 6580 WebhookContext holds a general purpose REST API context 6581 </p> 6582 </p> 6583 <table> 6584 <thead> 6585 <tr> 6586 <th> 6587 Field 6588 </th> 6589 <th> 6590 Description 6591 </th> 6592 </tr> 6593 </thead> 6594 <tbody> 6595 <tr> 6596 <td> 6597 <code>endpoint</code></br> <em> string </em> 6598 </td> 6599 <td> 6600 <p> 6601 REST API endpoint 6602 </p> 6603 </td> 6604 </tr> 6605 <tr> 6606 <td> 6607 <code>method</code></br> <em> string </em> 6608 </td> 6609 <td> 6610 <p> 6611 Method is HTTP request method that indicates the desired action to be 6612 performed for a given resource. See RFC7231 Hypertext Transfer Protocol 6613 (HTTP/1.1): Semantics and Content 6614 </p> 6615 </td> 6616 </tr> 6617 <tr> 6618 <td> 6619 <code>port</code></br> <em> string </em> 6620 </td> 6621 <td> 6622 <p> 6623 Port on which HTTP server is listening for incoming events. 6624 </p> 6625 </td> 6626 </tr> 6627 <tr> 6628 <td> 6629 <code>url</code></br> <em> string </em> 6630 </td> 6631 <td> 6632 <p> 6633 URL is the url of the server. 6634 </p> 6635 </td> 6636 </tr> 6637 <tr> 6638 <td> 6639 <code>serverCertSecret</code></br> <em> 6640 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6641 Kubernetes core/v1.SecretKeySelector </a> </em> 6642 </td> 6643 <td> 6644 <p> 6645 ServerCertPath refers the file that contains the cert. 6646 </p> 6647 </td> 6648 </tr> 6649 <tr> 6650 <td> 6651 <code>serverKeySecret</code></br> <em> 6652 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6653 Kubernetes core/v1.SecretKeySelector </a> </em> 6654 </td> 6655 <td> 6656 <p> 6657 ServerKeyPath refers the file that contains private key 6658 </p> 6659 </td> 6660 </tr> 6661 <tr> 6662 <td> 6663 <code>metadata</code></br> <em> map\[string\]string </em> 6664 </td> 6665 <td> 6666 <em>(Optional)</em> 6667 <p> 6668 Metadata holds the user defined metadata which will passed along the 6669 event payload. 6670 </p> 6671 </td> 6672 </tr> 6673 <tr> 6674 <td> 6675 <code>authSecret</code></br> <em> 6676 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6677 Kubernetes core/v1.SecretKeySelector </a> </em> 6678 </td> 6679 <td> 6680 <em>(Optional)</em> 6681 <p> 6682 AuthSecret holds a secret selector that contains a bearer token for 6683 authentication 6684 </p> 6685 </td> 6686 </tr> 6687 <tr> 6688 <td> 6689 <code>maxPayloadSize</code></br> <em> int64 </em> 6690 </td> 6691 <td> 6692 <em>(Optional)</em> 6693 <p> 6694 MaxPayloadSize is the maximum webhook payload size that the server will 6695 accept. Requests exceeding that limit will be rejected with “request too 6696 large” response. Default value: 1048576 (1MB). 6697 </p> 6698 </td> 6699 </tr> 6700 </tbody> 6701 </table> 6702 <h3 id="argoproj.io/v1alpha1.WebhookEventSource"> 6703 WebhookEventSource 6704 </h3> 6705 <p> 6706 (<em>Appears on:</em> 6707 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6708 </p> 6709 <p> 6710 <p> 6711 CalendarEventSource describes an HTTP based EventSource 6712 </p> 6713 </p> 6714 <table> 6715 <thead> 6716 <tr> 6717 <th> 6718 Field 6719 </th> 6720 <th> 6721 Description 6722 </th> 6723 </tr> 6724 </thead> 6725 <tbody> 6726 <tr> 6727 <td> 6728 <code>WebhookContext</code></br> <em> 6729 <a href="#argoproj.io/v1alpha1.WebhookContext"> WebhookContext </a> 6730 </em> 6731 </td> 6732 <td> 6733 <p> 6734 (Members of <code>WebhookContext</code> are embedded into this type.) 6735 </p> 6736 </td> 6737 </tr> 6738 <tr> 6739 <td> 6740 <code>filter</code></br> <em> 6741 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> EventSourceFilter 6742 </a> </em> 6743 </td> 6744 <td> 6745 <em>(Optional)</em> 6746 <p> 6747 Filter 6748 </p> 6749 </td> 6750 </tr> 6751 </tbody> 6752 </table> 6753 <hr/> 6754 <p> 6755 <em> Generated with <code>gen-crd-api-reference-docs</code>. </em> 6756 </p>