Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Updated Sources to Template #141

Merged
merged 9 commits into from
Apr 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions docs/sources/awscodecommit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ as a new commit or the creation of a pull request, happens in this repository.

## Prerequisite(s)

* CodeCommit Repository and Branch
* Amazon Resource Name (ARN)
* API Credentials
- CodeCommit Repository and Branch
- Amazon Resource Name (ARN)
- API Credentials

### CodeCommit Repository and Branch

Expand Down Expand Up @@ -90,10 +90,10 @@ Open the Bridge creation screen and add a source of type `AWS CodeCommit`.

In the Source creation form, give a name to the event source and add the following information:

* [**AWS ARN**][arn]: ARN of the CodeCommit repository, as described in the previous sections.
* [**Branch name**][cc-branches]: Name of the Git branch the source should be watching for commits.
* **Event types**: List of event types the event source should subscribe to.
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**AWS ARN**][arn]: ARN of the CodeCommit repository, as described in the previous sections.
- [**Branch name**][cc-branches]: Name of the Git branch the source should be watching for commits.
- **Event types**: List of event types the event source should subscribe to.
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS CodeCommit API, as described in the previous sections.

![AWS CodeCommit source form](../images/awscodecommit-source/create-bridge-2.png)
Expand All @@ -112,8 +112,8 @@ CodeCommit repository.

The AWS CodeCommit event source emits events of the following types:

* `com.amazon.codecommit.push`
* `com.amazon.codecommit.pull_request`
- `com.amazon.codecommit.push`
- `com.amazon.codecommit.pull_request`

[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscodecommit.html#awscodecommit-resources-for-iam-policies
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
Expand Down
12 changes: 6 additions & 6 deletions docs/sources/awscognitouserpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ creation of a new user, happens in the user identity pool.

## Prerequisite(s)

* AWS Cognito User Pool
* Amazon Resource Name (ARN)
* API Credentials
- AWS Cognito User Pool
- Amazon Resource Name (ARN)
- API Credentials

### AWS Cognito User Pool

Expand Down Expand Up @@ -81,9 +81,9 @@ Open the Bridge creation screen and add a source of type `AWS Cognito User Pool`

In the Source creation form, give a name to the event source and add the following information:

* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS SQS API, as described in the previous sections.
* [**AWS ARN**][arn]: ARN of the User Pool, as described in the previous sections.
- [**AWS ARN**][arn]: ARN of the User Pool, as described in the previous sections.

![Source form](../images/awscognitouserpool-source/source-cognito-userpool-form.png)

Expand All @@ -101,7 +101,7 @@ Cognito User Pool.

The AWS Cognito UserPool event source emits events of the following type:

* `com.amazon.cognito-idp.sync_trigger`
- `com.amazon.cognito-idp.sync_trigger`

[cup-docs]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html
[cup-getting-started]: https://docs.aws.amazon.com/cognito/latest/developerguide/getting-started-with-cognito-user-pools.html
Expand Down
16 changes: 8 additions & 8 deletions docs/sources/awsdynamodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sequence of item-level modifications from a [DynamoDB Stream][ddb-streams].

## Prerequisite(s)

* DynamoDB Table and Stream
* Amazon Resource Name (ARN)
* API Credentials
- DynamoDB Table and Stream
- Amazon Resource Name (ARN)
- API Credentials

### DynamoDB Table and Stream

Expand Down Expand Up @@ -89,8 +89,8 @@ Open the Bridge creation screen and add a source of type `AWS DynamoDB`.

In the Source creation form, give a name to the event source and add the following information:

* [**AWS ARN**][arn]: ARN of the DynamoDB Table, as described in the previous sections.
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**AWS ARN**][arn]: ARN of the DynamoDB Table, as described in the previous sections.
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS DynamoDB API, as described in the previous sections.

![AWS DynamoDB source form](../images/awsdynamodb-source/create-bridge-2.png)
Expand All @@ -109,9 +109,9 @@ DynamoDB Stream.

The AWS DynamoDB event source emits events of the following types:

* `com.amazon.dynamodb.insert`
* `com.amazon.dynamodb.modify`
* `com.amazon.dynamodb.remove`
- `com.amazon.dynamodb.insert`
- `com.amazon.dynamodb.modify`
- `com.amazon.dynamodb.remove`

[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html#amazondynamodb-resources-for-iam-policies
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
Expand Down
12 changes: 6 additions & 6 deletions docs/sources/awskinesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ after wrapping them in a [CloudEvent][ce] envelope.

## Prerequisite(s)

* Kinesis Data Stream
* Amazon Resource Name (ARN)
* API Credentials
- Kinesis Data Stream
- Amazon Resource Name (ARN)
- API Credentials

### Kinesis Data Stream

Expand Down Expand Up @@ -82,8 +82,8 @@ Open the Bridge creation screen and add a source of type `AWS Kinesis`.

In the Source creation form, give a name to the event source and add the following information:

* [**AWS ARN**][arn]: ARN of the Kinesis Data Stream, as described in the previous sections.
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**AWS ARN**][arn]: ARN of the Kinesis Data Stream, as described in the previous sections.
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS Kinesis API, as described in the previous sections.

![AWS Kinesis source form](../images/awskinesis-source/create-bridge-2.png)
Expand All @@ -102,7 +102,7 @@ Kinesis Data Stream.

The AWS Kinesis event source emits events of the following types:

* `com.amazon.kinesis.stream_record`
- `com.amazon.kinesis.stream_record`

[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonkinesis.html#amazonkinesis-resources-for-iam-policies
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
Expand Down
28 changes: 14 additions & 14 deletions docs/sources/awss3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ an [Amazon SQS queue][sqs-docs] in order to be consumable by the event source.

## Prerequisite(s)

* S3 Bucket
* Amazon Resource Name (ARN)
* API Credentials
* SQS Queue _(optional)_
- S3 Bucket
- Amazon Resource Name (ARN)
- API Credentials
- SQS Queue _(optional)_

### S3 Bucket

Expand Down Expand Up @@ -121,13 +121,13 @@ Open the Bridge creation screen and add a source of type `AWS S3`.

In the Source creation form, give a name to the event source and add the following information:

* [**Source secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a
- [**Source secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a
Secret Access Key to communicate with the AWS API, as described in the previous sections.
* [**Bucket ARN**][arn]: ARN of the S3 bucket. This ARN needs to include the AWS region and account ID, as described in the
- [**Bucket ARN**][arn]: ARN of the S3 bucket. This ARN needs to include the AWS region and account ID, as described in the
previous sections.
* [**Queue ARN**][arn]: _(optional)_ ARN of the SQS queue which acts as event destination, in case you prefer to manage
- [**Queue ARN**][arn]: _(optional)_ ARN of the SQS queue which acts as event destination, in case you prefer to manage
this queue yourself as described in the previous sections.
* [**Event types**][s3-events]: List of event types to subscribe to.
- [**Event types**][s3-events]: List of event types to subscribe to.

![AWS S3 source form](../images/awss3-source/create-bridge-2.png)

Expand All @@ -150,12 +150,12 @@ contains a new Event Notification targeting the SQS queue.

The TriggerMesh event source for Amazon S3 emits events of the following types:

* `com.amazon.s3.objectcreated`
* `com.amazon.s3.objectremoved`
* `com.amazon.s3.objectrestore`
* `com.amazon.s3.reducedredundancylostobject`
* `com.amazon.s3.replication`
* `com.amazon.s3.testevent`
- `com.amazon.s3.objectcreated`
- `com.amazon.s3.objectremoved`
- `com.amazon.s3.objectrestore`
- `com.amazon.s3.reducedredundancylostobject`
- `com.amazon.s3.replication`
- `com.amazon.s3.testevent`

[arn]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html#amazons3-resources-for-iam-policies
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
Expand Down
14 changes: 7 additions & 7 deletions docs/sources/awssns.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sink.

## Prerequisite(s)

* SNS Topic (standard)
* Amazon Resource Name (ARN)
* API Credentials
- SNS Topic (standard)
- Amazon Resource Name (ARN)
- API Credentials

### SNS Topic (standard)

Expand Down Expand Up @@ -91,10 +91,10 @@ Open the Bridge creation screen and add a source of type `AWS SNS`.

In the Source creation form, give a name to the event source and add the following information:

* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS SNS API, as described in the previous sections.
* [**AWS ARN**][arn]: ARN of the SNS topic, as described in the previous sections.
* [**DeliveryPolicy**][sns-delivery-policy]: Delivery policy to define how Amazon SNS retries the delivery of messages
- [**AWS ARN**][arn]: ARN of the SNS topic, as described in the previous sections.
- [**DeliveryPolicy**][sns-delivery-policy]: Delivery policy to define how Amazon SNS retries the delivery of messages
to HTTP/S endpoints.

![AWS SNS source form](../images/awssns-source/bridge-form-sns-source-form.png)
Expand All @@ -113,7 +113,7 @@ topic.

The AWS SNS event source emits events of the following type:

* `com.amazon.sns.notification`
- `com.amazon.sns.notification`

[sns-docs]: https://docs.aws.amazon.com/sns/latest/dg/welcome.html
[sns-getting-started]: https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html
Expand Down
12 changes: 6 additions & 6 deletions docs/sources/awssqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The event source captures messages sent to a [AWS SQS queue][sqs-docs] and sends

## Prerequisite(s)

* SQS Queue
* Amazon Resource Name (ARN)
* API Credentials
- SQS Queue
- Amazon Resource Name (ARN)
- API Credentials

### SQS Queue

Expand Down Expand Up @@ -83,9 +83,9 @@ Open the Bridge creation screen and add a source of type `AWS SQS`.

In the Source creation form, give a name to the event source and add the following information:

* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
- [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
Access Key to communicate with the AWS SQS API, as described in the previous sections.
* [**AWS ARN**][arn]: ARN of the SQS queue, as described in the previous sections.
- [**AWS ARN**][arn]: ARN of the SQS queue, as described in the previous sections.

![AWS SQS source form](../images/awssqs-source/bridge-form-sqs-source-form.png)

Expand All @@ -103,7 +103,7 @@ SQS queue.

The AWS SQS event source emits events of the following type:

* `com.amazon.sqs.message`
- `com.amazon.sqs.message`

[sqs-docs]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html
[sqs-getting-started]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-getting-started.html
Expand Down
34 changes: 17 additions & 17 deletions docs/sources/azureactivitylogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ selected set of log categories to a dedicated Event Hub, then subscribing to the

## Prerequisite(s)

* Service Principal
* Event Hubs Namespace
* Event Hubs Instance _(optional)_
* Shared Access Policy / Shared Access Signature (SAS)
- Service Principal
- Event Hubs Namespace
- Event Hubs Instance _(optional)_
- Shared Access Policy / Shared Access Signature (SAS)

### Service Principal

Expand All @@ -20,10 +20,10 @@ authority over the Azure Subscription to monitor. You can create a Service Princ
The section called _Assign a role to the application_ describes how to assign permissions to the Service Principal. Make
sure you select a role which has at least the following permissions:

* `Microsoft.Insights/DiagnosticSettings/Read`
* `Microsoft.Insights/DiagnosticSettings/Delete`
* `Microsoft.Insights/DiagnosticSettings/Write`
* `Microsoft.EventHub/namespaces/authorizationRules/listkeys/action`
- `Microsoft.Insights/DiagnosticSettings/Read`
- `Microsoft.Insights/DiagnosticSettings/Delete`
- `Microsoft.Insights/DiagnosticSettings/Write`
- `Microsoft.EventHub/namespaces/authorizationRules/listkeys/action`

Additionally, assign the role `Azure Event Hubs Data Receiver` to the Service Principal to allow it to receive events
from Event Hubs.
Expand Down Expand Up @@ -62,8 +62,8 @@ The corresponding role JSON is given as a reference which you can replicate to c

After the Service Principal is created and assigned suitable roles, take note of the following information:

* **Tenant ID** and **Client ID** (see _Get tenant and app ID values for signing in_)
* **Client secret** (see _Create a new application secret_)
- **Tenant ID** and **Client ID** (see _Get tenant and app ID values for signing in_)
- **Client secret** (see _Create a new application secret_)

### Event Hubs Namespace

Expand Down Expand Up @@ -137,13 +137,13 @@ In the Source creation form, give a name to the event source and add the followi
The ID of the Azure subscription which Activity Logs are to be subscribed to is inferred from the **Event Hub ID**
parameter below. Therefore, the form does not require providing a subscription ID explicitly.

* [Secret][sp-create]: Service Principal authentication credentials, as described in the previous sections.
* [Event Hub ID][eventhubs-create]: Resource ID of either
* an Event Hubs _namespace_ (Event Hub managed by Azure, defaults to `insights-activity-logs`)
* an Event Hubs _instance_ (Event Hub managed by the user)
* [SAS Policy][sas-policy]: _(optional)_ Name of a SAS policy with Manage permissions on the Event Hubs namespace
- [Secret][sp-create]: Service Principal authentication credentials, as described in the previous sections.
- [Event Hub ID][eventhubs-create]: Resource ID of either
- an Event Hubs _namespace_ (Event Hub managed by Azure, defaults to `insights-activity-logs`)
- an Event Hubs _instance_ (Event Hub managed by the user)
- [SAS Policy][sas-policy]: _(optional)_ Name of a SAS policy with Manage permissions on the Event Hubs namespace
referenced in the **Event Hub ID** field. Uses Azure's default "RootManageSharedAccessKey" policy if not provided.
* [Log categories][log-categories]: _(optional)_ Categories of Activity Logs to collect. All available categories are
- [Log categories][log-categories]: _(optional)_ Categories of Activity Logs to collect. All available categories are
selected when the list of categories is left empty.

![Azure Activity Logs source form](../images/azureactivitylogs-source/create-bridge-2.png)
Expand All @@ -168,7 +168,7 @@ within the Azure Subscription.

The Azure Activity Logs event source emits events of the following type:

* `com.microsoft.azure.monitor.activity-log`
- `com.microsoft.azure.monitor.activity-log`

[activity-logs]: https://docs.microsoft.com/en-us/azure/azure-monitor/platform/activity-log
[diag-settings]: https://docs.microsoft.com/en-us/azure/azure-monitor/platform/diagnostic-settings
Expand Down
Loading