Skip to content

Commit

Permalink
Merge pull request #565 from reshmabidikar/aws-doc-corrections
Browse files Browse the repository at this point in the history
Minor corrections to docs
  • Loading branch information
pierre authored Aug 9, 2024
2 parents 97574f2 + 97bd4b3 commit 68246e5
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 24 deletions.
19 changes: 18 additions & 1 deletion userguide/aws/how-to-maintain-a-multi-tier-system.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,24 @@ include::{sourcedir}/aws/includes/logs.adoc[]

=== Status Reports

include::{sourcedir}/aws/includes/status-reports.adoc[]
When you launch the EC2 instance, all required services should be enabled and running, including:

* An instance of Kill Bill server listening on `127.0.0.1:8080` (and receiving external traffic through nginx on port `8443`)
* An instance of Kaui listening on `127.0.0.1:3000` (and receiving external traffic through nginx on port `443`)
* A local `mysql` server running on port `3306`

The status of KB/mysql services can be checked by the following commands:

* Kill Bill service: `sudo service killbill status`
* Mysql service: `sudo service mysql status`

For each report there should be a line near the top with the following form:

`Active: active (running) since Sat 2020-10-24 20:13:43 UTC; 1 day 1h ago`

You can `start` or `stop` the services using similar commands, such as `sudo service killbill stop` to stop Kill Bill. If any service is not active, try starting it using the appropriate command.

If all services are running, the next step is to collect several reports.

=== System Health Check

Expand Down
21 changes: 20 additions & 1 deletion userguide/aws/how-to-maintain-a-single-tier-system.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,26 @@ If a new installation does not seem to work correctly, the first step is to revi

=== Status Reports

include::{sourcedir}/aws/includes/status-reports.adoc[]
When you launch the EC2 instance, all required services should be enabled and running, including:

* An instance of `nginx` receiving traffic on port `443` and `8443`
* An instance of Kill Bill server listening on `127.0.0.1:8080` (and receiving external traffic through nginx on port `8443`)
* An instance of Kaui listening on `127.0.0.1:3000` (and receiving external traffic through nginx on port `443`)
* A local `mysql` server running on port `3306`

The status of nginx/KB/mysql services can be checked by the following commands:

* Kill Bill service: `sudo service killbill status`
* Nginx service: `sudo service nginx status`
* Mysql service: `sudo service mysql status`

For each report there should be a line near the top with the following form:

`Active: active (running) since Sat 2020-10-24 20:13:43 UTC; 1 day 1h ago`

You can `start` or `stop` the services using similar commands, such as `sudo service killbill stop` to stop Kill Bill. If any service is not active, try starting it using the appropriate command.

If all services are running, the next step is to collect several reports.

=== Log Files

Expand Down
4 changes: 2 additions & 2 deletions userguide/aws/includes/logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Sometimes these logs will clearly show anomalies that will pinpoint the problem.

The logging configuration, including settings for log rotation and log levels, is defined in the `logback.xml file`. Separate `logback.xml` files are used for KB and Kaui, located at the following paths:

KB logback file: `/var/lib/tomcat/webapps/ROOT/WEB-INF/classes/logback.xml`
Kaui logback file: `/var/lib/tomcat/webapps2/ROOT/WEB-INF/classes/logback.xml`
* KB logback file: `/var/lib/tomcat/webapps/ROOT/WEB-INF/classes/logback.xml`
* Kaui logback file: `/var/lib/tomcat/webapps2/ROOT/WEB-INF/classes/logback.xml`

These files can be modified to customize the logging settings for KB and Kaui. By default, the log level is configured as `INFO`.

20 changes: 0 additions & 20 deletions userguide/aws/includes/status-reports.adoc

This file was deleted.

0 comments on commit 68246e5

Please sign in to comment.