README
¶
TriggerMesh Sources for Amazon Web Services (SAWS) allows you to quickly and easily consume events from your AWS services and send them to workloads running in your cluster.
Installation
Kubernetes
Using Helm:
$ helm repo add triggermesh https://storage.googleapis.com/triggermesh-charts
$ helm install triggermesh/aws-event-sources
Refer to the aws-event-sources chart documentation for all available configuration options.
OpenShift
Login to the OpenShift Container Platform console and install the AWS Sources Operator from the OperatorHub. Refer to the aws-event-sources-operator documentation for the complete guide in getting up and running on the OpenShift Container Platform.
Getting Started
The following table lists the AWS services currently supported by TriggerMesh Sources for AWS and their support level.
| AWS Service | Documentation | Support Level |
|---|---|---|
| CodeCommit | README | alpha |
| Cognito Identity Pool | README | alpha |
| Cognito User Pool | README | alpha |
| DynamoDB | README | alpha |
| Kinesis | README | alpha |
| Simple Notifications Service (SNS) | README | alpha |
| Simple Queue Service (SQS) | README | alpha |
For detailed usage instructions about a particular source, please refer to the linked README.md files.
TriggerMesh Cloud
These container sources can be used as is from this repository or you can use our feature rich TriggerMesh Cloud offering where you can use our easy to use interface to configure them and also have access to other event source that are not publicly available.
Roadmap
- Add a more generic SNS source using an operator architecture
- Add a CloudWatch source using an operator architecture
- Performance improvements
Support
The sources listed in this repository are fully open source and can be used in any Knative cluster. They consist of event consumers for various AWS services. Most of them are packaged as Container Sources and make use of CloudEvents.
We would love your feedback and ideas. Reach out to us by filing an issue and help us extend and improve these sources with your contributions.
Commercial Support
TriggerMesh Inc supports these sources commercially, email info@triggermesh.com for details.
Code of Conduct
This repository is not a part of CNCF but we abide by its code of conduct.
Contributing
Refer to DEVELOPMENT.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
awscodecommit
module
|
|
|
cmd
|
|
|
hack
|
|
|
kinesisproducer
Module
|
|
|
pkg
|
|
|
adapter/awssnssource/handler
Package handler contains the logic for handling SNS notifications over HTTP.
|
Package handler contains the logic for handling SNS notifications over HTTP. |
|
adapter/awssnssource/status
Package status contains types and helpers to manipulate the status of source objects.
|
Package status contains types and helpers to manipulate the status of source objects. |
|
adapter/common
Package common contains various helpers for adapters.
|
Package common contains various helpers for adapters. |
|
adapter/common/controller
Package controller contains helpers shared between controllers embedded in source adapters.
|
Package controller contains helpers shared between controllers embedded in source adapters. |
|
adapter/common/env
Package env allows propagating runtime configurations via the environment.
|
Package env allows propagating runtime configurations via the environment. |
|
adapter/common/health
Package health contains helpers to enable HTTP health checking.
|
Package health contains helpers to enable HTTP health checking. |
|
adapter/testing
Package testing contains test helpers for adapters.
|
Package testing contains test helpers for adapters. |
|
apis/sources/v1alpha1
Package v1alpha1 contains API Schema definitions for the sources/v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the sources/v1alpha1 API group. |
|
aws/iam
Package iam contains helpers to interact with IAM objects.
|
Package iam contains helpers to interact with IAM objects. |
|
aws/s3
Package sqs contains helpers for AWS S3.
|
Package sqs contains helpers for AWS S3. |
|
aws/sqs
Package sqs contains helpers for AWS SQS.
|
Package sqs contains helpers for AWS SQS. |
|
client/generated/clientset/internalclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/generated/clientset/internalclientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/generated/clientset/internalclientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/generated/clientset/internalclientset/typed/sources/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/generated/clientset/internalclientset/typed/sources/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
reconciler/common
Package common contains reconciliation helpers shared between source reconcilers.
|
Package common contains reconciliation helpers shared between source reconcilers. |
|
reconciler/common/event
Package event contains functions for generating Kubernetes API events.
|
Package event contains functions for generating Kubernetes API events. |
|
reconciler/common/resource
Package resource contains helpers to generate Kubernetes API objects.
|
Package resource contains helpers to generate Kubernetes API objects. |
|
reconciler/common/skip
Package skip allows a Context to carry the intention to skip parts of the code execution.
|
Package skip allows a Context to carry the intention to skip parts of the code execution. |
|
reconciler/testing
Package testing contains test helpers for reconcilers.
|
Package testing contains test helpers for reconcilers. |
|
status
Package status contains helpers to observe the status of Kubernetes objects.
|
Package status contains helpers to observe the status of Kubernetes objects. |
|
testing/event
Package event contains test helpers for Kubernetes API events.
|
Package event contains test helpers for Kubernetes API events. |
|
testing/structs
Package structs provides helpers to test Go structs.
|
Package structs provides helpers to test Go structs. |