Merge pull request #2 from rlunar/docs/readme

Docs/readme

Author: rlunar

.gitignore

@@ -1,2 +1,161 @@
 frontend/public/aws-exports.json
 server/aws-exports.json
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -3,54 +3,60 @@
 > **Disclaimer:** The sample code; software libraries; command line tools; proofs of concept; templates; or other related technology (including any of the foregoing that are provided by our personnel) is provided to you as AWS Content under the AWS Customer Agreement, or the relevant written agreement between you and AWS (whichever applies). You are responsible for testing, securing, and optimizing the AWS Content, such as sample code, as appropriate for production grade use based on your specific quality control practices and standards. Deploying AWS Content may incur AWS charges for creating or using AWS chargeable resources, such as running Amazon EC2 instances, using Amazon CloudWatch or Amazon Cognito.
 
 
+
 ## What is DBTop Monitoring ?
 
 DBTop Monitoring is evolution of [RDSTop Monitoring Solution](https://github.com/aws-samples/rds-top-monitoring) initiative.
 
-DBTop Monitoring is lightweight application to perform realtime monitoring for AWS Database Resources. 
+DBTop Monitoring is lightweight application to perform real-time monitoring for AWS Database Resources. 
 Based on same simplicity concept of Unix top utility, provide quick and fast view of database performance, just all in one screen.
 
-
 <img width="1089" alt="image" src="./images/image01.png">
 
 
-## How looks like DBTop Monitoring ?
+
+## How does DBTop Monitoring look like?
 
 <img width="1089" alt="image" src="./images/image02.png">
 
 <img width="1089" alt="image" src="./images/image03.png">
 
 <img width="1089" alt="image" src="./images/image04.png">
 
+
+### [Visit the YouTube channel for videos](https://www.youtube.com/@DBTopMonitoringSolution)
+
+
+
 ## How it works?
 
 <img width="1089" alt="image" src="./images/image05.png">
 
 
 
-
 ## Database engine support
 
 DBTop Monitoring Solution currently supports following database engines:
 
-- AWS RDS for MySQL
-- AWS RDS for PostgreSQL
-- AWS RDS for MariaDB
-- AWS RDS for Oracle
-- AWS RDS for SQLServer
-- Amazon Aurora Instance (MySQL-Compatible Edition)
-- Amazon Aurora Instance (PostgreSQL-Compatible Edition)
-- Amazon ElastiCache for Redis
-- Amazon MemoryDB for Redis
-- Amazon Aurora Clusters (MySQL-Compatible Edition)
-- Amazon Aurora Clusters (PostgreSQL-Compatible Edition)
-- Amazon DocumentDB Clusters
+- [Amazon Relational Database Service (RDS)](https://aws.amazon.com/rds/)
+    - [Amazon RDS for MySQL](https://aws.amazon.com/rds/mysql/)
+    - [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/)
+    - [Amazon RDS for MariaDB](https://aws.amazon.com/rds/mariadb/)
+    - [Amazon RDS for Oracle](https://aws.amazon.com/rds/oracle/)
+    - [Amazon RDS for SQLServer](https://aws.amazon.com/rds/sqlserver/)
+- [Amazon Aurora Instance (MySQL-Compatible Edition)](https://aws.amazon.com/rds/aurora/)
+    - [Amazon Aurora Instance (MySQL-Compatible Edition)](https://aws.amazon.com/rds/aurora/)
+    - [Amazon Aurora Instance (PostgreSQL-Compatible Edition)](https://aws.amazon.com/rds/aurora/)
+    - [Amazon Aurora Clusters (MySQL-Compatible Edition)](https://aws.amazon.com/rds/aurora/)
+    - [Amazon Aurora Clusters (PostgreSQL-Compatible Edition)](https://aws.amazon.com/rds/aurora/)
+- [Amazon In-Memory Databases](https://aws.amazon.com/elasticache/)
+    - [Amazon ElastiCache for Redis](https://aws.amazon.com/elasticache/redis/)
+    - [Amazon MemoryDB for Redis](https://aws.amazon.com/memorydb/)
+- [Amazon DocumentDB (with MongoDB compatibility)](https://aws.amazon.com/documentdb/)
 
 Additional expanded support coming later to :
 
-- Amazon OpenSearch
-
-
+- [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/)
 
 
 
@@ -61,11 +67,13 @@ Additional expanded support coming later to :
 - **Backend.** NodeJS API Component to gather performance information from database engines, AWS CloudWatch and Enhanced Monitoring.
 
 
+
 ## Architecture
 
 <img width="1023" alt="image" src="./images/image06.png">
 
 
+
 ## Use cases
 
 - **Monitor instance performance.**
@@ -81,18 +89,25 @@ Additional expanded support coming later to :
 
 ## Solution Requirements
 
-#### Amazon RDS Enhanced Monitoring
+#### [Amazon RDS](https://aws.amazon.com/rds/) Enhanced Monitoring
 
-Amazon RDS provides metrics in real time for the operating system (OS) that your DB instance runs on. DBTop Monitoring solution integrate metrics from Enhanced Monitoring and it has to be enabled. 
-Follow procedure below to turn on Enhanced Monitoring.
+[Amazon RDS](https://aws.amazon.com/rds/) provides metrics in real time for the operating system (OS) that your DB instance runs on. DBTop Monitoring solution integrate metrics from Enhanced Monitoring and it has to be enabled. Follow procedure below to turn on Enhanced Monitoring.
 
-https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.Enabling.html
+[Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.Enabling.html)
 
 
 #### VPC Network Access to AWS Database Instances
 
 DBTop Monitoring Solution needs to access privately AWS Database resources, grant inboud access for security groups used by database resources.
 
+_First, you need to take a note of the Cloudformation resources created by the stack_
+
+<img width="1023" alt="Cloudformation Security Group Id" src="./images/image07.png">
+
+
+_Second, you need to edit the Security Group that allows access to your Database resources, in this case to ElastiCache_
+
+<img width="1023" alt="Edit Security Group Id to Allow Redis" src="./images/image08.png">
 
 
 ## Resource Usage and Cost
@@ -111,29 +126,30 @@ DBTop Monitoring Solution will use following resources:
 
 ## Solution Deployment
 
-
-
 > **Time to deploy:** Approximately 10 minutes.
 
 
 ### Create database monitoring users
 
 Database credentials are needed to connect to the database engine and gather real-time metrics, use following statements to create the monitoring users.
 
-#### MySQL
-```
+
+#### [Amazon RDS for MySQL](https://aws.amazon.com/rds/mysql/)
+```sql
 CREATE USER 'monitor'@'%' IDENTIFIED BY '<PASSWORD>';
 GRANT PROCESS ON *.* TO 'monitor'@'%' ;
 ```
 
-#### PostgreSQL
-```
+
+#### [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/)
+```sql
 CREATE USER monitor WITH PASSWORD '<PASSWORD>';
 GRANT pg_read_all_stats TO monitor;
 ```
 
-#### MS SQLServer
-```
+
+#### [Amazon RDS for SQLServer](https://aws.amazon.com/rds/sqlserver/)
+```sql
 USE [master]
 GO
 CREATE LOGIN [monitor] WITH PASSWORD=N'<PASSWORD>', DEFAULT_DATABASE=[master], CHECK_EXPIRATION=ON, CHECK_POLICY=ON
@@ -146,14 +162,15 @@ GRANT VIEW SERVER STATE TO [monitor]
 GO
 ```
 
-#### Oracle
-```
+
+#### [Amazon RDS for Oracle](https://aws.amazon.com/rds/oracle/)
+```sql
 CREATE USER monitor IDENTIFIED BY '<PASSWORD>';
 GRANT CREATE SESSION,SELECT ANY DICTIONARY TO monitor;
 ```
 
 
-#### Amazon DocumentDB
+#### [Amazon DocumentDB (with MongoDB compatibility)](https://aws.amazon.com/documentdb/)
 ```
 db.createUser(
 {
@@ -169,16 +186,16 @@ db.createUser(
 Follow the step-by-step instructions to configure and deploy the DBTop Monitoring Solution into your account.
 
 1. Make sure you have sign in AWS Console already.
-2. Download AWS Cloudformation Template (DBMonitoringSolution.template) located into conf folder.
+2. Download AWS Cloudformation Template ([DBMonitoringSolution.template](https://raw.githubusercontent.com/aws-samples/db-top-monitoring/main/conf/DBTopMonitoringSolution.template)) located into conf folder.
 3. [**Open AWS CloudFormation Console**](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=DBTopMonitoringSolution)
-4. Create an stack using Cloudformation template (DBMonitoringSolution.template) already downloaded on step 2.
+4. Create an stack using Cloudformation template ([DBMonitoringSolution.template](/conf/DBMonitoringSolution.template)) already downloaded on step 2.
 5. Input **Stack name** parameter. 
 6. Acknowledge **Application Updates - Disclaimer** parameter.
 7. Input **Username** parameter, this username will be used to access the application. An email will be sent with temporary password from AWS Cognito Service. 
 8. Input **AWS Linux AMI** parameter, this parameter specify AWS AMI to build App EC2 Server. Keep default value.
 9. Select **Instance Type** parameter, indicate what instance size is needed.
 10. Select **VPC Name** parameter, indicate VPC to be used to deploy application server.
-11. Select **Subnet Name** parameter, indicate subnet to be used to deploy application server, this subnet needs to have outbound internet access to reach AWS APIs. Also application server needs to be able to reach AWS Database Resources, add appropiate inboud rules on AWS RDS security groups to allow network connections.
+11. Select **Subnet Name** parameter, indicate subnet to be used to deploy application server, this subnet needs to have outbound internet access to reach AWS APIs. Also application server needs to be able to reach AWS Database Resources, add appropiate inboud rules on Amazon RDS security groups to allow network connections.
 12. Select **Public IP Address** parameter, the deployment will assign private IP Address by default to access the application, you can assign Public IP Address to access the application in case you need it, Select (true) to assign Public IP Address.
 13. Input **CIDR** parameter, specify CIDR inbound access rule, this will grant network access for the application.
 14. Click **Next**, Click **Next**, select **acknowledge that AWS CloudFormation might create IAM resources with custom names**. and Click **Submit**.
@@ -191,8 +208,14 @@ CA-signed certificate that not only encrypts, but also publicly authenticates yo
 
 
 
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
 
 
+## License
 
+This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE.txt) file.