Packages:
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:(Appears on: AMQPEventSource)
AMQPConsumeConfig holds the configuration to immediately starts delivering queued messages
Field | Description |
---|---|
consumerTag
string
|
(Optional)
ConsumerTag is the identity of the consumer included in every delivery |
autoAck
bool
|
(Optional)
AutoAck when true, the server will acknowledge deliveries to this consumer prior to writing the delivery to the network |
exclusive
bool
|
(Optional)
Exclusive when true, the server will ensure that this is the sole consumer from this queue |
noLocal
bool
|
(Optional)
NoLocal flag is not supported by RabbitMQ |
noWait
bool
|
(Optional)
NowWait when true, do not wait for the server to confirm the request and immediately begin deliveries |
(Appears on: EventSourceSpec)
AMQPEventSource refers to an event-source for AMQP stream events
Field | Description |
---|---|
url
string
|
URL for rabbitmq service |
exchangeName
string
|
ExchangeName is the exchange name For more information, visit https://www.rabbitmq.com/tutorials/amqp-concepts.html |
exchangeType
string
|
ExchangeType is rabbitmq exchange type |
routingKey
string
|
Routing key for bindings |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
(Optional)
Backoff holds parameters applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the amqp client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
exchangeDeclare
AMQPExchangeDeclareConfig
|
(Optional)
ExchangeDeclare holds the configuration for the exchange on the server For more information, visit https://godoc.org/github.com/streadway/amqp#Channel.ExchangeDeclare |
queueDeclare
AMQPQueueDeclareConfig
|
(Optional)
QueueDeclare holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches the same parameters For more information, visit https://godoc.org/github.com/streadway/amqp#Channel.QueueDeclare |
queueBind
AMQPQueueBindConfig
|
(Optional)
QueueBind holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key For more information, visit https://godoc.org/github.com/streadway/amqp#Channel.QueueBind |
consume
AMQPConsumeConfig
|
(Optional)
Consume holds the configuration to immediately starts delivering queued messages For more information, visit https://godoc.org/github.com/streadway/amqp#Channel.Consume |
(Appears on: AMQPEventSource)
AMQPExchangeDeclareConfig holds the configuration for the exchange on the server
Field | Description |
---|---|
durable
bool
|
(Optional)
Durable keeps the exchange also after the server restarts |
autoDelete
bool
|
(Optional)
AutoDelete removes the exchange when no bindings are active |
internal
bool
|
(Optional)
Internal when true does not accept publishings |
noWait
bool
|
(Optional)
NowWait when true does not wait for a confirmation from the server |
(Appears on: AMQPEventSource)
AMQPQueueBindConfig holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key
Field | Description |
---|---|
noWait
bool
|
(Optional)
NowWait false and the queue could not be bound, the channel will be closed with an error |
(Appears on: AMQPEventSource)
AMQPQueueDeclareConfig holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches the same parameters
Field | Description |
---|---|
name
string
|
(Optional)
Name of the queue. If empty the server auto-generates a unique name for this queue |
durable
bool
|
(Optional)
Durable keeps the queue also after the server restarts |
autoDelete
bool
|
(Optional)
AutoDelete removes the queue when no consumers are active |
exclusive
bool
|
(Optional)
Exclusive sets the queues to be accessible only by the connection that declares them and will be deleted wgen the connection closes |
noWait
bool
|
(Optional)
NowWait when true, the queue assumes to be declared on the server |
(Appears on: EventSourceSpec)
AzureEventsHubEventSource describes the event source for azure events hub More info at https://docs.microsoft.com/en-us/azure/event-hubs/
Field | Description |
---|---|
fqdn
string
|
FQDN of the EventHubs namespace you created More info at https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string |
sharedAccessKeyName
Kubernetes core/v1.SecretKeySelector
|
SharedAccessKeyName is the name you chose for your application’s SAS keys |
sharedAccessKey
Kubernetes core/v1.SecretKeySelector
|
SharedAccessKey is the generated value of the key |
hubName
string
|
Event Hub path/name |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
CalendarEventSource describes a time based dependency. One of the fields (schedule, interval, or recurrence) must be passed. Schedule takes precedence over interval; interval takes precedence over recurrence
Field | Description |
---|---|
schedule
string
|
Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron |
interval
string
|
Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h… |
exclusionDates
[]string
|
|
timezone
string
|
(Optional)
Timezone in which to run the schedule |
userPayload
encoding/json.RawMessage
|
(Optional)
UserPayload will be sent to sensor as extra data once the event is triggered Deprecated: will be removed in v1.5. Please use Metadata instead. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
persistence
EventPersistence
|
Persistence hold the configuration for event persistence |
(Appears on: EventPersistence)
Field | Description |
---|---|
enabled
bool
|
Enabled enables to triggered the missed schedule when eventsource restarts |
maxDuration
string
|
MaxDuration holds max catchup duration |
(Appears on: EventPersistence)
Field | Description |
---|---|
name
string
|
Name of the configmap |
createIfNotExist
bool
|
CreateIfNotExist will create configmap if it doesn’t exists |
(Appears on: EventSourceSpec)
EmitterEventSource describes the event source for emitter More info at https://emitter.io/develop/getting-started/
Field | Description |
---|---|
broker
string
|
Broker URI to connect to. |
channelKey
string
|
ChannelKey refers to the channel key |
channelName
string
|
ChannelName refers to the channel name |
username
Kubernetes core/v1.SecretKeySelector
|
(Optional)
Username to use to connect to broker |
password
Kubernetes core/v1.SecretKeySelector
|
(Optional)
Password to use to connect to broker |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
(Optional)
Backoff holds parameters applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the emitter client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: CalendarEventSource)
Field | Description |
---|---|
catchup
CatchupConfiguration
|
Catchup enables to triggered the missed schedule when eventsource restarts |
configMap
ConfigMapPersistence
|
ConfigMap holds configmap details for persistence |
EventSource is the definition of a eventsource resource
(Appears on: EventSource)
EventSourceSpec refers to specification of event-source resource
Field | Description |
---|---|
eventBusName
string
|
EventBusName references to a EventBus name. By default the value is “default” |
template
Template
|
(Optional)
Template is the pod specification for the event source |
service
Service
|
(Optional)
Service is the specifications of the service to expose the event source |
replica
int32
|
Replica is the event source deployment replicas |
minio
map[string]github.com/argoproj/argo-events/pkg/apis/common.S3Artifact
|
Minio event sources |
calendar
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.CalendarEventSource
|
Calendar event sources |
file
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.FileEventSource
|
File event sources |
resource
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.ResourceEventSource
|
Resource event sources |
webhook
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.WebhookContext
|
Webhook event sources |
amqp
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AMQPEventSource
|
AMQP event sources |
kafka
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.KafkaEventSource
|
Kafka event sources |
mqtt
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.MQTTEventSource
|
MQTT event sources |
nats
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NATSEventsSource
|
NATS event sources |
sns
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SNSEventSource
|
SNS event sources |
sqs
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SQSEventSource
|
SQS event sources |
pubSub
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PubSubEventSource
|
PubSub event sources |
github
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GithubEventSource
|
Github event sources |
gitlab
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GitlabEventSource
|
Gitlab event sources |
hdfs
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.HDFSEventSource
|
HDFS event sources |
slack
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SlackEventSource
|
Slack event sources |
storageGrid
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StorageGridEventSource
|
StorageGrid event sources |
azureEventsHub
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureEventsHubEventSource
|
AzureEventsHub event sources |
stripe
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StripeEventSource
|
Stripe event sources |
emitter
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.EmitterEventSource
|
Emitter event source |
redis
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisEventSource
|
Redis event source |
nsq
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NSQEventSource
|
NSQ event source |
pulsar
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PulsarEventSource
|
Pulsar event source |
generic
map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GenericEventSource
|
Generic event source |
(Appears on: EventSource)
EventSourceStatus holds the status of the event-source resource
Field | Description |
---|---|
Status
github.com/argoproj/argo-events/pkg/apis/common.Status
|
(Members of |
(Appears on: EventSourceSpec)
FileEventSource describes an event-source for file related events.
Field | Description |
---|---|
eventType
string
|
Type of file operations to watch Refer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information |
watchPathConfig
WatchPathConfig
|
WatchPathConfig contains configuration about the file path to watch |
polling
bool
|
Use polling instead of inotify |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
GenericEventSource refers to a generic event source. It can be used to implement a custom event source.
Field | Description |
---|---|
url
string
|
URL of the gRPC server that implements the event source. |
config
string
|
Config is the event source configuration |
insecure
bool
|
Insecure determines the type of connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
authSecret
Kubernetes core/v1.SecretKeySelector
|
(Optional)
AuthSecret holds a secret selector that contains a bearer token for authentication |
(Appears on: EventSourceSpec)
GithubEventSource refers to event-source for github related events
Field | Description |
---|---|
id
int64
|
Id is the webhook’s id |
webhook
WebhookContext
|
Webhook refers to the configuration required to run a http server |
owner
string
|
Owner refers to GitHub owner name i.e. argoproj |
repository
string
|
Repository refers to GitHub repo name i.e. argo-events |
events
[]string
|
|
apiToken
Kubernetes core/v1.SecretKeySelector
|
(Optional)
APIToken refers to a K8s secret containing github api token |
webhookSecret
Kubernetes core/v1.SecretKeySelector
|
(Optional)
WebhookSecret refers to K8s secret containing GitHub webhook secret https://developer.github.com/webhooks/securing/ |
insecure
bool
|
Insecure tls verification |
active
bool
|
(Optional)
Active refers to status of the webhook for event deliveries. https://developer.github.com/webhooks/creating/#active |
contentType
string
|
ContentType of the event delivery |
githubBaseURL
string
|
(Optional)
GitHub base URL (for GitHub Enterprise) |
githubUploadURL
string
|
(Optional)
GitHub upload URL (for GitHub Enterprise) |
deleteHookOnFinish
bool
|
(Optional)
DeleteHookOnFinish determines whether to delete the GitHub hook for the repository once the event source is stopped. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
GitlabEventSource refers to event-source related to Gitlab events
Field | Description |
---|---|
webhook
WebhookContext
|
Webhook holds configuration to run a http server |
projectID
string
|
ProjectID is the id of project for which integration needs to setup |
events
[]string
|
Events are gitlab event to listen to. Refer https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794. |
accessToken
Kubernetes core/v1.SecretKeySelector
|
AccessToken is reference to k8 secret which holds the gitlab api access information |
enableSSLVerification
bool
|
(Optional)
EnableSSLVerification to enable ssl verification |
gitlabBaseURL
string
|
GitlabBaseURL is the base URL for API requests to a custom endpoint |
deleteHookOnFinish
bool
|
(Optional)
DeleteHookOnFinish determines whether to delete the GitLab hook for the project once the event source is stopped. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
HDFSEventSource refers to event-source for HDFS related events
Field | Description |
---|---|
WatchPathConfig
WatchPathConfig
|
(Members of |
type
string
|
Type of file operations to watch |
checkInterval
string
|
CheckInterval is a string that describes an interval duration to check the directory state, e.g. 1s, 30m, 2h… (defaults to 1m) |
addresses
[]string
|
|
hdfsUser
string
|
HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used. |
krbCCacheSecret
Kubernetes core/v1.SecretKeySelector
|
KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos. |
krbKeytabSecret
Kubernetes core/v1.SecretKeySelector
|
KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos. |
krbUsername
string
|
KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used. |
krbRealm
string
|
KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used. |
krbConfigConfigMap
Kubernetes core/v1.ConfigMapKeySelector
|
KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used. |
krbServicePrincipalName
string
|
KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: KafkaEventSource)
Field | Description |
---|---|
groupName
string
|
The name for the consumer group to use |
oldest
bool
|
(Optional)
When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false |
rebalanceStrategy
string
|
(Optional)
Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default. |
(Appears on: EventSourceSpec)
KafkaEventSource refers to event-source for Kafka related events
Field | Description |
---|---|
url
string
|
URL to kafka cluster, multiple URLs separated by comma |
partition
string
|
Partition name |
topic
string
|
Topic name |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
Backoff holds parameters applied to connection. |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the kafka client. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
consumerGroup
KafkaConsumerGroup
|
(Optional)
Consumer group for kafka client |
limitEventsPerSecond
int64
|
(Optional)
Sets a limit on how many events get read from kafka per second. |
version
string
|
(Optional)
Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0 |
(Appears on: EventSourceSpec)
MQTTEventSource refers to event-source for MQTT related events
Field | Description |
---|---|
url
string
|
URL to connect to broker |
topic
string
|
Topic name |
clientId
string
|
ClientID is the id of the client |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
ConnectionBackoff holds backoff applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the mqtt client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: NATSEventsSource)
NATSAuth refers to the auth info for NATS EventSource
Field | Description |
---|---|
basic
github.com/argoproj/argo-events/pkg/apis/common.BasicAuth
|
(Optional)
Baisc auth with username and password |
token
Kubernetes core/v1.SecretKeySelector
|
(Optional)
Token used to connect |
nkey
Kubernetes core/v1.SecretKeySelector
|
(Optional)
NKey used to connect |
credential
Kubernetes core/v1.SecretKeySelector
|
(Optional)
credential used to connect |
(Appears on: EventSourceSpec)
NATSEventsSource refers to event-source for NATS related events
Field | Description |
---|---|
url
string
|
URL to connect to NATS cluster |
subject
string
|
Subject holds the name of the subject onto which messages are published |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
ConnectionBackoff holds backoff applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the nats client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
auth
NATSAuth
|
(Optional)
Auth information |
(Appears on: EventSourceSpec)
NSQEventSource describes the event source for NSQ PubSub More info at https://godoc.org/github.com/nsqio/go-nsq
Field | Description |
---|---|
hostAddress
string
|
HostAddress is the address of the host for NSQ lookup |
topic
string
|
Topic to subscribe to. |
channel
string
|
Channel used for subscription |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
(Optional)
Backoff holds parameters applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the nsq client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
PubSubEventSource refers to event-source for GCP PubSub related events.
Field | Description |
---|---|
projectID
string
|
(Optional)
ProjectID is GCP project ID for the subscription. Required if you run Argo Events outside of GKE/GCE. (otherwise, the default value is its project) |
topicProjectID
string
|
(Optional)
TopicProjectID is GCP project ID for the topic. By default, it is same as ProjectID. |
topic
string
|
(Optional)
Topic to which the subscription should belongs. Required if you want the eventsource to create a new subscription. If you specify this field along with an existing subscription, it will be verified whether it actually belongs to the specified topic. |
subscriptionID
string
|
(Optional)
SubscriptionID is ID of subscription. Required if you use existing subscription. The default value will be auto generated hash based on this eventsource setting, so the subscription might be recreated every time you update the setting, which has a possibility of event loss. |
credentialSecret
Kubernetes core/v1.SecretKeySelector
|
(Optional)
CredentialSecret references to the secret that contains JSON credentials to access GCP. If it is missing, it implicitly uses Workload Identity to access. https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity |
deleteSubscriptionOnFinish
bool
|
(Optional)
DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub subscription once the event source is stopped. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
credentialsFile
string
|
CredentialsFile is the file that contains credentials to authenticate for GCP Deprecated: will be removed in v1.5, use CredentialSecret instead |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
PulsarEventSource describes the event source for Apache Pulsar
Field | Description |
---|---|
topics
[]string
|
Name of the topics to subscribe to. |
type
string
|
(Optional)
Type of the subscription. Only “exclusive” and “shared” is supported. Defaults to exclusive. |
url
string
|
Configure the service URL for the Pulsar service. |
tlsTrustCertsSecret
Kubernetes core/v1.SecretKeySelector
|
(Optional)
Trusted TLS certificate secret. |
tlsAllowInsecureConnection
bool
|
(Optional)
Whether the Pulsar client accept untrusted TLS certificate from broker. |
tlsValidateHostname
bool
|
(Optional)
Whether the Pulsar client verify the validity of the host name from broker. |
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the pulsar client. |
connectionBackoff
github.com/argoproj/argo-events/pkg/apis/common.Backoff
|
(Optional)
Backoff holds parameters applied to connection. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
RedisEventSource describes an event source for the Redis PubSub. More info at https://godoc.org/github.com/go-redis/redis#example-PubSub
Field | Description |
---|---|
hostAddress
string
|
HostAddress refers to the address of the Redis host/server |
password
Kubernetes core/v1.SecretKeySelector
|
(Optional)
Password required for authentication if any. |
namespace
string
|
(Optional)
Namespace to use to retrieve the password from. It should only be specified if password is declared |
db
int32
|
(Optional)
DB to use. If not specified, default DB 0 will be used. |
channels
[]string
|
|
tls
github.com/argoproj/argo-events/pkg/apis/common.TLSConfig
|
(Optional)
TLS configuration for the redis client. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
ResourceEventSource refers to a event-source for K8s resource related events.
Field | Description |
---|---|
namespace
string
|
Namespace where resource is deployed |
filter
ResourceFilter
|
(Optional)
Filter is applied on the metadata of the resource If you apply filter, then the internal event informer will only monitor objects that pass the filter. |
GroupVersionResource
Kubernetes meta/v1.GroupVersionResource
|
(Members of Group of the resource |
eventTypes
[]ResourceEventType
|
EventTypes is the list of event type to watch. Possible values are - ADD, UPDATE and DELETE. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
string
alias)(Appears on: ResourceEventSource)
ResourceEventType is the type of event for the K8s resource mutation
(Appears on: ResourceEventSource)
ResourceFilter contains K8 ObjectMeta information to further filter resource event objects
Field | Description |
---|---|
prefix
string
|
(Optional)
Prefix filter is applied on the resource name. |
labels
[]Selector
|
(Optional)
Labels provide listing options to K8s API to watch resource/s. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/ for more info. |
fields
[]Selector
|
(Optional)
Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like “spec.serviceAccountName”, and the value could be a string or a regex. Same as K8s field selector, operator “=”, “==” and “!=” are supported. |
createdBy
Kubernetes meta/v1.Time
|
(Optional)
If resource is created before the specified time then the event is treated as valid. |
afterStart
bool
|
(Optional)
If the resource is created after the start time then the event is treated as valid. |
(Appears on: EventSourceSpec)
SNSEventSource refers to event-source for AWS SNS related events
Field | Description |
---|---|
webhook
WebhookContext
|
Webhook configuration for http server |
topicArn
string
|
TopicArn |
accessKey
Kubernetes core/v1.SecretKeySelector
|
AccessKey refers K8 secret containing aws access key |
secretKey
Kubernetes core/v1.SecretKeySelector
|
SecretKey refers K8 secret containing aws secret key |
region
string
|
Region is AWS region |
roleARN
string
|
(Optional)
RoleARN is the Amazon Resource Name (ARN) of the role to assume. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
validateSignature
bool
|
(Optional)
ValidateSignature is boolean that can be set to true for SNS signature verification |
(Appears on: EventSourceSpec)
SQSEventSource refers to event-source for AWS SQS related events
Field | Description |
---|---|
accessKey
Kubernetes core/v1.SecretKeySelector
|
AccessKey refers K8 secret containing aws access key |
secretKey
Kubernetes core/v1.SecretKeySelector
|
SecretKey refers K8 secret containing aws secret key |
region
string
|
Region is AWS region |
queue
string
|
Queue is AWS SQS queue to listen to for messages |
waitTimeSeconds
int64
|
WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. |
roleARN
string
|
(Optional)
RoleARN is the Amazon Resource Name (ARN) of the role to assume. |
jsonBody
bool
|
(Optional)
JSONBody specifies that all event body payload coming from this source will be JSON |
queueAccountId
string
|
(Optional)
QueueAccountID is the ID of the account that created the queue to monitor |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: ResourceFilter)
Selector represents conditional operation to select K8s objects.
Field | Description |
---|---|
key
string
|
Key name |
operation
string
|
(Optional)
Supported operations like ==, !=, <=, >= etc. Defaults to ==. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors for more info. |
value
string
|
Value |
(Appears on: EventSourceSpec)
Service holds the service information eventsource exposes
Field | Description |
---|---|
ports
[]Kubernetes core/v1.ServicePort
|
The list of ports that are exposed by this ClusterIP service. |
clusterIP
string
|
(Optional)
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are “None”, empty string (“”), or a valid IP address. “None” can be specified for headless services when proxying is not required. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
(Appears on: EventSourceSpec)
SlackEventSource refers to event-source for Slack related events
Field | Description |
---|---|
signingSecret
Kubernetes core/v1.SecretKeySelector
|
Slack App signing secret |
token
Kubernetes core/v1.SecretKeySelector
|
Token for URL verification handshake |
webhook
WebhookContext
|
Webhook holds configuration for a REST endpoint |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
StorageGridEventSource refers to event-source for StorageGrid related events
Field | Description |
---|---|
webhook
WebhookContext
|
Webhook holds configuration for a REST endpoint |
events
[]string
|
|
filter
StorageGridFilter
|
Filter on object key which caused the notification. |
topicArn
string
|
TopicArn |
bucket
string
|
Name of the bucket to register notifications for. |
region
string
|
(Optional)
S3 region. Defaults to us-east-1 |
authToken
Kubernetes core/v1.SecretKeySelector
|
Auth token for storagegrid api |
apiURL
string
|
APIURL is the url of the storagegrid api. |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: StorageGridEventSource)
StorageGridFilter represents filters to apply to bucket notifications for specifying constraints on objects
Field | Description |
---|---|
prefix
string
|
|
suffix
string
|
(Appears on: EventSourceSpec)
StripeEventSource describes the event source for stripe webhook notifications More info at https://stripe.com/docs/webhooks
Field | Description |
---|---|
webhook
WebhookContext
|
Webhook holds configuration for a REST endpoint |
createWebhook
bool
|
(Optional)
CreateWebhook if specified creates a new webhook programmatically. |
apiKey
Kubernetes core/v1.SecretKeySelector
|
(Optional)
APIKey refers to K8s secret that holds Stripe API key. Used only if CreateWebhook is enabled. |
eventFilter
[]string
|
(Optional)
EventFilter describes the type of events to listen to. If not specified, all types of events will be processed. More info at https://stripe.com/docs/api/events/list |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
(Appears on: EventSourceSpec)
Template holds the information of an EventSource deployment template
Field | Description |
---|---|
metadata
github.com/argoproj/argo-events/pkg/apis/common.Metadata
|
Metadata sets the pods’s metadata, i.e. annotations and labels |
serviceAccountName
string
|
(Optional)
ServiceAccountName is the name of the ServiceAccount to use to run event source pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
container
Kubernetes core/v1.Container
|
(Optional)
Container is the main container image to run in the event source pod |
volumes
[]Kubernetes core/v1.Volume
|
(Optional)
Volumes is a list of volumes that can be mounted by containers in an eventsource. |
securityContext
Kubernetes core/v1.PodSecurityContext
|
(Optional)
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
affinity
Kubernetes core/v1.Affinity
|
(Optional)
If specified, the pod’s scheduling constraints |
tolerations
[]Kubernetes core/v1.Toleration
|
(Optional)
If specified, the pod’s tolerations. |
nodeSelector
map[string]string
|
(Optional)
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference
|
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
priorityClassName
string
|
(Optional)
If specified, indicates the EventSource pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ |
priority
int32
|
(Optional)
The priority value. Various system components use this field to find the priority of the EventSource pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ |
(Appears on: FileEventSource, HDFSEventSource)
Field | Description |
---|---|
directory
string
|
Directory to watch for events |
path
string
|
Path is relative path of object to watch with respect to the directory |
pathRegexp
string
|
PathRegexp is regexp of relative path of object to watch with respect to the directory |
(Appears on: EventSourceSpec, GithubEventSource, GitlabEventSource, SNSEventSource, SlackEventSource, StorageGridEventSource, StripeEventSource)
WebhookContext holds a general purpose REST API context
Field | Description |
---|---|
endpoint
string
|
REST API endpoint |
method
string
|
Method is HTTP request method that indicates the desired action to be performed for a given resource. See RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content |
port
string
|
Port on which HTTP server is listening for incoming events. |
url
string
|
URL is the url of the server. |
serverCertSecret
Kubernetes core/v1.SecretKeySelector
|
ServerCertPath refers the file that contains the cert. |
serverKeySecret
Kubernetes core/v1.SecretKeySelector
|
ServerKeyPath refers the file that contains private key |
metadata
map[string]string
|
(Optional)
Metadata holds the user defined metadata which will passed along the event payload. |
authSecret
Kubernetes core/v1.SecretKeySelector
|
(Optional)
AuthSecret holds a secret selector that contains a bearer token for authentication |
serverCertPath
string
|
DeprecatedServerCertPath refers the file that contains the cert. |
serverKeyPath
string
|
DeprecatedServerKeyPath refers the file that contains private key |
Generated with gen-crd-api-reference-docs
.