Merge pull request #580 from killbill/aws-docs-cleanup

Aws docs cleanup
killbill · Dec 10, 2024 · 796aab7 · 796aab7
2 parents fa19b24 + 517b94a
commit 796aab7
Show file tree

Hide file tree

Showing 17 changed files with 26 additions and 2,067 deletions.
diff --git a/userguide/tutorials/aws-container.adoc → userguide/aws/aws-container.adoc b/userguide/tutorials/aws-container.adoc → userguide/aws/aws-container.adoc
diff --git a/userguide/tutorials/aws-tools.adoc → userguide/aws/aws-tools.adoc b/userguide/tutorials/aws-tools.adoc → userguide/aws/aws-tools.adoc
@@ -10,8 +10,8 @@ Several of these tools have been integrated with the AWS implementations of Kill
 
 To proceed, you should have a working Kill Bill implementation running on
 AWS, using either the
-https://docs.killbill.io/latest/aws-singletier.html[single-tier] or
-https://docs.killbill.io/latest/aws-multitier.html[multi-tier]
+https://docs.killbill.io/latest/how-to-set-up-a-single-tier-system.html[single-tier] or
+https://docs.killbill.io/latest/how-to-set-up-a-multi-tier-system.html[multi-tier]
 installation options. The single-tier option runs Kill Bill, Kaui, the
 MariaDB database, and the nginx load balancer on a single AWS EC2
 instance. This is suitable for quick deployment and for testing and

diff --git a/userguide/tutorials/aws.adoc → userguide/aws/aws.adoc b/userguide/tutorials/aws.adoc → userguide/aws/aws.adoc
diff --git a/userguide/tutorials/errors-rollbar.adoc → userguide/aws/errors-rollbar.adoc b/userguide/tutorials/errors-rollbar.adoc → userguide/aws/errors-rollbar.adoc
diff --git a/userguide/tutorials/errors-sentry.adoc → userguide/aws/errors-sentry.adoc b/userguide/tutorials/errors-sentry.adoc → userguide/aws/errors-sentry.adoc
diff --git a/userguide/tutorials/events-to-aws-sqs.adoc → userguide/aws/events-to-aws-sqs.adoc b/userguide/tutorials/events-to-aws-sqs.adoc → userguide/aws/events-to-aws-sqs.adoc
diff --git a/userguide/aws/how-to-maintain-a-cloud-formation-system.adoc b/userguide/aws/how-to-maintain-a-cloud-formation-system.adoc
@@ -111,6 +111,27 @@ If you update any configuration file, you will need to restart the service. To d
 > sudo service killbill restart
 ----
 
+== Update Configuration
+To update the Kill Bill configuration parameters, select the CloudFormation stack and click on *Update*. The update stack consists of the following 4 steps:
+
+* Step 1 - Update stack: select *Use current template* and click Next
+
+image::https://github.com/vnandwana/killbill-docs/raw/v3/userguide/assets/aws/cf-update-config-step1.JPG[align=center]
+
+* Step 2 - Specify stack details: update any of the parameters and click Next
+
+image::https://github.com/vnandwana/killbill-docs/raw/v3/userguide/assets/aws/cf-update-config-step2.JPG[align=center]
+
+* Step 3 - Configure stack options: no changes are needed at this step
+
+image::https://github.com/vnandwana/killbill-docs/raw/v3/userguide/assets/aws/cf-update-config-step3.JPG[align=center]
+
+* Step 4 - Review: review all the changes made to the parameters, scroll down and check *I acknowledge that AWS CloudFormation might create IAM resources* and click on *Submit*.
+
+image::https://github.com/vnandwana/killbill-docs/raw/v3/userguide/assets/aws/cf-update-config-step4b.JPG[align=center]
+
+CloudFormation stack will start updating all these configurations, and upon completion, its status will change to *UPDATE_COMPLETE*.
+
 == Maintenance
 
 If your installation has been running well but shows signs of slowing down or other problems, there are several commands you can use to assess its overall health. These commands can be used when you are logged in to any instance. Some should be run on all instances from time to time.

diff --git a/userguide/aws/how-to-set-up-a-cloud-formation-system.adoc b/userguide/aws/how-to-set-up-a-cloud-formation-system.adoc
@@ -190,7 +190,7 @@ This provides access to certain detailed resources that may be needed for mainte
 
 Congratulations! Your CloudFormation installation is ready to go!
 
-For information on troubleshooting, maintaining and upgrading your installation see https://../how-to-maintain-a-cloudformation-system.adoc[How to Maintain a CloudFormation System].
+For information on troubleshooting, maintaining and upgrading your installation see https://docs.killbill.io/latest/how-to-maintain-a-cloud-formation-system[How to Maintain a CloudFormation System].
 
 
 
diff --git a/userguide/tutorials/metrics-cloudwatch.adoc → userguide/aws/metrics-cloudwatch.adoc b/userguide/tutorials/metrics-cloudwatch.adoc → userguide/aws/metrics-cloudwatch.adoc
@@ -133,6 +133,8 @@ If you have multiple instances, repeat these steps for each one. You may use the
 To test your installation, Go to the Cloudwatch console. After a short delay, you
 should see a set of available metrics. There should be well over 1,000 in your list.
 
+image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/aws/cloudwatch.png[align=center]
+
 Congratulations. Your CloudWatch integration is complete!
 
 == Using CloudWatch

diff --git a/userguide/tutorials/metrics-datadog.adoc → userguide/aws/metrics-datadog.adoc b/userguide/tutorials/metrics-datadog.adoc → userguide/aws/metrics-datadog.adoc
diff --git a/userguide/tutorials/metrics-newrelic.adoc → userguide/aws/metrics-newrelic.adoc b/userguide/tutorials/metrics-newrelic.adoc → userguide/aws/metrics-newrelic.adoc
diff --git a/userguide/tutorials/using-ses-with-aws.adoc → userguide/aws/using-ses-with-aws.adoc b/userguide/tutorials/using-ses-with-aws.adoc → userguide/aws/using-ses-with-aws.adoc
diff --git a/userguide/tutorials/aws-cf.adoc b/userguide/tutorials/aws-cf.adoc
diff --git a/userguide/tutorials/aws-multitier.adoc b/userguide/tutorials/aws-multitier.adoc
diff --git a/userguide/tutorials/aws-single-ami.adoc b/userguide/tutorials/aws-single-ami.adoc
diff --git a/userguide/tutorials/aws-singletier.adoc b/userguide/tutorials/aws-singletier.adoc
Original file line number	Diff line number	Diff line change
Expand Up		@@ -190,7 +190,7 @@ This provides access to certain detailed resources that may be needed for mainte

		Congratulations! Your CloudFormation installation is ready to go!

		For information on troubleshooting, maintaining and upgrading your installation see https://../how-to-maintain-a-cloudformation-system.adoc[How to Maintain a CloudFormation System].
		For information on troubleshooting, maintaining and upgrading your installation see https://docs.killbill.io/latest/how-to-maintain-a-cloud-formation-system[How to Maintain a CloudFormation System].