AWS SES -- email notification #550

vnandwana · 2024-04-23T12:59:30Z

Updated email notification plugin, adding info about using AWS SES.

sbrossie

Is there anyway we can make it easier for the users - not have to install packages, ... ?

userguide/tutorials/metrics-cloudwatch.adoc

sbrossie · 2024-04-24T00:34:08Z

userguide/tutorials/email-notification-plugin.adoc


 The tenant/account configuration can be done by executing the required API endpoints via *cURL* as explained below:

 [[tenant-config]]
-. *Configure the tenant* using the following cURL command (Replace `<events>` with a comma-separated list of the events for which the emails need to be sent. For example, to configure the tenant to send emails for *INVOICE_CREATION* and *INVOICE_PAYMENT_SUCCESS*, specify `org.killbill.billing.plugin.email-notifications.defaultEvents=INVOICE_CREATION,INVOICE_PAYMENT_SUCCESS`):
+*Configure the tenant* using the following cURL command (Replace `<events>` with a comma-separated list of the events for which the emails need to be sent. For example, to configure the tenant to send emails for *INVOICE_CREATION* and *INVOICE_PAYMENT_SUCCESS*, specify `org.killbill.billing.plugin.email-notifications.defaultEvents=INVOICE_CREATION,INVOICE_PAYMENT_SUCCESS`):


Is this on purpose (no more space) ?

This is how it was earlier. I just removed the dot (.) from the beginning of the line so that it doesn't add a number section.

I think tenant/account configuration (Steps 1 and 2 in the plugin configuration section) would be required when AWS SES is used as well.

If you agree, we can maybe add a section below SMTP Server Notes called AWS SES Specific Configuration that only includes the additional configuration for AWS SES and make it clear that this is only the additional configuration.

The tenant configuration mentioned in the SMTP section is not required for AWS SES. I have made some changes to the doc, hopefully, these comments are addressed. Kindly check when you get a chance. Thank you.

sbrossie · 2024-04-24T00:34:24Z

userguide/tutorials/email-notification-plugin.adoc

+
+
+=== Configure Events
+*Configure the account* using the following `cURL` command (Replace `{accountId}` with the id of the account for which emails need to be sent and `<events>` with a comma-separated list of the events for which the emails need to be sent. For example, to configure the account to send emails for *INVOICE_CREATION* and *INVOICE_PAYMENT_SUCCESS*, specify `"INVOICE_CREATION", "INVOICE_PAYMENT_SUCCESS"`):


Same here: Is this on purpose (no more space) ?

here as well, I just removed the dot (.) from the beginning of the line so that it doesn't add a number section.

Is there a specific reason to get rid of the numbering?

sbrossie

Left a few comments to address.

…on step.

vnandwana · 2024-04-25T02:43:01Z

Is there anyway we can make it easier for the users - not have to install packages, ... ?

Could you please elaborate on your thoughts? A user needs to install this plugin (just like any other plugins), are you referring to simplifying the AWS SES configuration process -- https://github.com/killbill/killbill-docs/pull/550/files#diff-371363a9cb5621593e52291217cd15e1d82ba9479fb62d0bfcc3e4ce6072fb78R69

vnandwana · 2024-05-26T14:22:10Z

Is there anyway we can make it easier for the users - not have to install packages, ... ?

Could you please elaborate on your thoughts? A user needs to install this plugin (just like any other plugins), are you referring to simplifying the AWS SES configuration process -- https://github.com/killbill/killbill-docs/pull/550/files#diff-371363a9cb5621593e52291217cd15e1d82ba9479fb62d0bfcc3e4ce6072fb78R69

This PR had X-Ray daemon installation as well, if you're referring to simplifying this, its already been done.

vnandwana · 2024-05-26T15:12:12Z

@reshmabidikar @sbrossie I have addressed the review comments, kindly check at your convenience. I have verified these changes in preview mode using the AsciiDoc plugin for IntelliJ IDEA.

Please let me know if any further changes are required. Thank you.

sbrossie · 2024-05-30T00:50:34Z

@vnandwana I fixed the merge conflict. @reshmabidikar Can you double check your comments have been addressed - and if so, move ahead with merging this PR?

reshmabidikar

Looks good Vijay. I reviewed the doc from your fork to see how it reads and have left a few minor comments to address.

reshmabidikar · 2024-05-30T04:50:43Z

userguide/tutorials/email-notification-plugin.adoc


 == Prerequisites

 * Ensure that you have Kill Bill, Kaui, and the database set up as explained in the https://docs.killbill.io/latest/getting_started.html[__Getting Started Guide__].

 * Ensure that you have https://curl.haxx.se/[_cURL_] installed. If you are on Windows, we recommend that you use https://git-scm.com/download/win[_Git Bash_] to run the `cURL` commands.

+* If you plan to use AWS SES, obtain your AWS SES credentials (access key and secret key) and ensure that the IAM user has the ses:SendEmail permission.


Suggested change

* If you plan to use AWS SES, obtain your AWS SES credentials (access key and secret key) and ensure that the IAM user has the ses:SendEmail permission.

* If you plan to use AWS SES, obtain your AWS SES credentials (access key and secret key) and ensure that the IAM user has the `ses:SendEmail permission`.

reshmabidikar · 2024-05-30T04:55:55Z

userguide/tutorials/email-notification-plugin.adoc


-.. If a tenant is configured with some events, but the account is not configured, then emails will be sent based on what is configured at the tenant level.
+[[smtp_server_notes]]
+== SMTP Server Notes


This should be H3 so that the doc reads better:

Suggested change

== SMTP Server Notes

=== SMTP Server Notes

reshmabidikar · 2024-05-30T05:02:28Z

userguide/tutorials/email-notification-plugin.adoc

+*Note:* Ensure that the credentials used have the necessary permissions, specifically `ses:SendEmail`, on the resource arn:aws:ses:<region>:<account>:identity/<sender's email>.
+
+=== SMTP Configuration
+A tenant needs to be configured with the SMTP properties required for sending emails. Additionally, the tenant can also be configured with the events for which emails should be sent. In addition to the per-tenant configuration, the plugin also allows a more granular account-level configuration for the set of emails to be sent for the particular account. Thus, either the tenant or the account needs to be configured with the events for which the email needs to be sent.

 The tenant/account configuration can be done by executing the required API endpoints via *cURL* as explained below:


Suggested change

The tenant/account configuration can be done by executing the required API endpoints via *cURL* as explained below:

The tenant configuration can be done by executing the required API endpoints via *cURL* as explained below:

reshmabidikar · 2024-05-30T05:03:16Z

userguide/tutorials/email-notification-plugin.adoc

+*Note:* Ensure that the credentials used have the necessary permissions, specifically `ses:SendEmail`, on the resource arn:aws:ses:<region>:<account>:identity/<sender's email>.
+
+=== SMTP Configuration
+A tenant needs to be configured with the SMTP properties required for sending emails. Additionally, the tenant can also be configured with the events for which emails should be sent. In addition to the per-tenant configuration, the plugin also allows a more granular account-level configuration for the set of emails to be sent for the particular account. Thus, either the tenant or the account needs to be configured with the events for which the email needs to be sent.


Move the text In addition to the per-tenant configuration, the plugin also allows a more granular account-level configuration for the set of emails to be sent for the particular account. Thus, either the tenant or the account needs to be configured with the events for which the email needs to be sent. to the Configure Events section below.

Didn't move this as the statement is good for SMTP configuration.

I agree, but from what I read, the account configuration is now moved to the Configure Events section, hence I suggested moving the above text to the Configure Events. If you disagree, feel free to leave it as it is and merge the PR.

Lets keep this in SMTP as the following is not applicable for SES:
"per-tenant configuration" or "either the tenant or the account needs to be configured".

I'm not authorized to merge code to any of the public repositories.

@reshmabidikar If no further changes are required, kindly merge this branch. I don't have permission to merge code to this branch. Thank you.

reshmabidikar · 2024-05-30T05:06:18Z

userguide/tutorials/email-notification-plugin.adoc

+org.killbill.mail.from=<Default sender's email>
+org.killbill.aws.region=<AWS region, default region is us-east-1>
+
+AWS SES requires authentication for sending emails. System-wide environment variables can be configured for all users by appending them to the /etc/environment file. Open the `/etc/environment` file in a text editor with root privileges, set the following variables:


Suggested change

AWS SES requires authentication for sending emails. System-wide environment variables can be configured for all users by appending them to the /etc/environment file. Open the `/etc/environment` file in a text editor with root privileges, set the following variables:

AWS SES requires authentication for sending emails. System-wide environment variables can be configured for all users by appending them to the `/etc/environment` file. Open the `/etc/environment` file in a text editor with root privileges, set the following variables:

vnandwana · 2024-06-03T06:56:22Z

@reshmabidikar @sbrossie Thank you for your review comments. I have addressed all these comments. Could you take a one final look?

reshmabidikar

Apart from #550 (comment), everything looks good. If you think the change in my comment is not required, feel free to merge and we can revisit once PR is merged.

* Updated email notification plugin, adding info about using AWS SES.

ffc939b

sbrossie reviewed Apr 24, 2024

View reviewed changes

userguide/tutorials/metrics-cloudwatch.adoc Outdated Show resolved Hide resolved

sbrossie mentioned this pull request Apr 24, 2024

AWS SES killbill/killbill-email-notifications-plugin#60

Open

sbrossie reviewed Apr 24, 2024

View reviewed changes

* XRay daemon now comes preinstalled with AMI. Removed the installati…

cf65c5f

…on step.

vnandwana mentioned this pull request Apr 25, 2024

Added steps to install xray daemon on standalone EC2. #540

Closed

Addressed review comments.

d83cc75

Merge branch 'v3' into ses-email-notification

dc3dfe0

reshmabidikar reviewed May 30, 2024

View reviewed changes

vnandwana added 2 commits June 3, 2024 12:05

Addressed review comments.

3e5f3a3

Addressed review comments.

b78a292

reshmabidikar approved these changes Jun 3, 2024

View reviewed changes

reshmabidikar merged commit ad8a290 into killbill:v3 Jun 23, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AWS SES -- email notification #550

AWS SES -- email notification #550

vnandwana commented Apr 23, 2024

sbrossie left a comment

sbrossie Apr 24, 2024

vnandwana Apr 25, 2024

reshmabidikar Apr 25, 2024

vnandwana May 26, 2024

sbrossie Apr 24, 2024

vnandwana Apr 25, 2024

reshmabidikar Apr 25, 2024

sbrossie left a comment

vnandwana commented Apr 25, 2024

vnandwana commented May 26, 2024

vnandwana commented May 26, 2024

sbrossie commented May 30, 2024

reshmabidikar left a comment

reshmabidikar May 30, 2024

reshmabidikar May 30, 2024

reshmabidikar May 30, 2024

reshmabidikar May 30, 2024

vnandwana Jun 3, 2024

reshmabidikar Jun 3, 2024

vnandwana Jun 12, 2024

vnandwana Jun 23, 2024

reshmabidikar May 30, 2024

vnandwana commented Jun 3, 2024

reshmabidikar left a comment •

edited

Loading



		=== Configure Events
		Configure the account using the following `cURL` command (Replace `{accountId}` with the id of the account for which emails need to be sent and `<events>` with a comma-separated list of the events for which the emails need to be sent. For example, to configure the account to send emails for INVOICE_CREATION and INVOICE_PAYMENT_SUCCESS, specify `"INVOICE_CREATION", "INVOICE_PAYMENT_SUCCESS"`):

	* If you plan to use AWS SES, obtain your AWS SES credentials (access key and secret key) and ensure that the IAM user has the ses:SendEmail permission.
	* If you plan to use AWS SES, obtain your AWS SES credentials (access key and secret key) and ensure that the IAM user has the `ses:SendEmail permission`.

	The tenant/account configuration can be done by executing the required API endpoints via cURL as explained below:
	The tenant configuration can be done by executing the required API endpoints via cURL as explained below:

	AWS SES requires authentication for sending emails. System-wide environment variables can be configured for all users by appending them to the /etc/environment file. Open the `/etc/environment` file in a text editor with root privileges, set the following variables:
	AWS SES requires authentication for sending emails. System-wide environment variables can be configured for all users by appending them to the `/etc/environment` file. Open the `/etc/environment` file in a text editor with root privileges, set the following variables:

AWS SES -- email notification #550

AWS SES -- email notification #550

Conversation

vnandwana commented Apr 23, 2024

sbrossie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbrossie left a comment

Choose a reason for hiding this comment

vnandwana commented Apr 25, 2024

vnandwana commented May 26, 2024

vnandwana commented May 26, 2024

sbrossie commented May 30, 2024

reshmabidikar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vnandwana commented Jun 3, 2024

reshmabidikar left a comment • edited Loading

Choose a reason for hiding this comment

reshmabidikar left a comment •

edited

Loading