README
¶
TriggerMesh Sources for Amazon Web Services (SAWS) allow you to quickly and easily consume events from your AWS services and send them to workloads running in your cluster.
Other Knative Sources maintained by TriggerMesh are available in the following repositories:
- Knative Sources
- GitLab Source (Knative sandbox project)
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 documentation of the AWS Event Sources Operator 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 |
|---|---|---|
| CloudWatch | alpha | |
| CloudWatch Logs | alpha | |
| CodeCommit | README | alpha |
| Cognito Identity Pool | README | alpha |
| Cognito User Pool | README | alpha |
| DynamoDB | README | alpha |
| Kinesis | README | alpha |
| Simple Cloud Storage (S3) | alpha | |
| Simple Notifications Service (SNS) | README | alpha |
| Simple Queue Service (SQS) | README | alpha |
For detailed usage instructions about a particular source, please refer to its linked README.md file, or to the
TriggerMesh documentation.
Contributions and support
We would love to hear your feedback on these sources. Please don't hesitate to submit bug reports and suggestions by filing issues, or contribute by submitting pull-requests.
Refer to DEVELOPMENT.md in order to get started.
TriggerMesh Cloud Early Access
TriggerMesh Sources for Amazon Web Services can be used as is from this repo. You can also use them along with other components from our Cloud at https://cloud.triggermesh.io, which has a web UI to configure and run them.
Commercial Support
TriggerMesh Inc. supports those sources commercially. Email us at info@triggermesh.com to get more details.
Code of Conduct
Although this project is not part of the CNCF, we abide by its code of conduct.
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. |