Skip to content
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.

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

Added documentation for configuring Killbill to send events to AWS SQS. #559

Merged
merged 3 commits into from
Jul 22, 2024

Conversation

vnandwana
Copy link
Contributor

No description provided.

Copy link
Contributor

@reshmabidikar reshmabidikar left a comment

Choose a reason for hiding this comment

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

Looks good, I've left some minor comments.


* Access to AWS Management Console.
* IAM permissions to create and manage SQS and IAM roles.
* SSH access to the EC2 instance running Killbill.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* SSH access to the EC2 instance running Killbill.
* SSH access to the EC2 instance running Kill Bill.


1. Navigate to the EC2 Dashboard in the AWS Management Console.

2. Select the EC2 instance where Killbill is running.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
2. Select the EC2 instance where Killbill is running.
2. Select the EC2 instance where Kill Bill is running.


=== Step 4: Configure Killbill to Use SQS

1. SSH into the EC2 instance running Killbill.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. SSH into the EC2 instance running Killbill.
1. SSH to the EC2 instance running Kill Bill.


=== Step 6: Test the Configuration

1. To test the setup, install any plugin, add a user, or make any tenant configuration changes in Killbill. These actions should generate events that will be sent to the SQS queue.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. To test the setup, install any plugin, add a user, or make any tenant configuration changes in Killbill. These actions should generate events that will be sent to the SQS queue.
1. To test the setup, install any plugin, add a user, or make tenant configuration changes in Kill Bill. These actions should generate events that will be sent to the SQS queue.


== Conclusion

By following these steps, you should be able to configure Killbill to send events to an AWS SQS queue, enabling better event-driven integrations and workflows.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
By following these steps, you should be able to configure Killbill to send events to an AWS SQS queue, enabling better event-driven integrations and workflows.
By following these steps, you can configure Kill Bill to send events to an AWS SQS queue, enabling better event-driven integrations and workflows.


== Overview

This document outlines the steps to configure the Killbill application to send events to an Amazon Simple Queue Service (SQS) queue.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a link to https://docs.killbill.io/latest/kill_bill_events to explain what a Kill Bill event is?

-Dcom.killbill.aws.sqs.maxRetries=5
----

=== Step 5: Restart the Killbill EC2 Instance
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
=== Step 5: Restart the Killbill EC2 Instance
=== Step 5: Restart the Kill Bill EC2 Instance

@vnandwana
Copy link
Contributor Author

Looks good, I've left some minor comments.

Thank you, Reshma for these comments. I have addressed them, please check when you get a chance.

@reshmabidikar reshmabidikar merged commit 87fa8d1 into killbill:v3 Jul 22, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants