Skip to content

docs: add AWS SQS source to README #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2019
Merged

docs: add AWS SQS source to README #708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions eventing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,21 @@ The GcpPubSubSource fires a new event each time a message is published on a
[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core)
A reference to the object that should receive events.

### AwsSqsSource

The AwsSqsSource fires a new event each time an event is published on an
[AWS SQS topic](https://aws.amazon.com/sqs/).

**Spec fields**:

- `queueURL`: URL of the SQS queue to pull events from.
- `awsCredsSecret`: credential to use to poll the AWS SQS queue.
- `sink`:
[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core)
A reference to the object that should receive events.
- `serviceAccountName`: `string` The name of the ServiceAccount used to
access the `awsCredsSecret`.
Copy link
Contributor

@vaikas vaikas Jan 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to clarify that the Receive Adapter runs as this account. So, the effect is that we access the secret as this Service Account, but it's because the Receive Adapter runs as this Service Account.

Maybe add something like this (not verbatim, but shrug)

// serviceAccountName is the name of the ServiceAccount that will be used to
// run the Receive Adapter Deployment.

Copy link
Member

@evankanderson evankanderson Jan 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to parallel line 184 for the GcpPubSubSource.


### ContainerSource

The ContainerSource will instantiate a container image which can generate events
Expand Down