Skip to content

Commit a354b10

Browse files
committed
updated readme files
1 parent 2cfa9e8 commit a354b10

File tree

2 files changed

+58
-9
lines changed

2 files changed

+58
-9
lines changed

examples/AWS-EC2/README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Deploy application in AWS Beanstalk
1+
# Chronos AWS EC2 Example
2+
3+
Deploy AWS EC2 for testing [Chronos](https://github.com/open-source-labs/Chronos), an open-source developer tool that monitors health data from servers, microservices, Kubernetes clusters, and now, AWS services.
4+
5+
## Deploy application in AWS Beanstalk
6+
7+
This sample AWS EC2 example allows developers to explore the functionality of Chronos with cloud-based applications.
28

39
## Setup
410

@@ -59,14 +65,14 @@ git archive -v -o myMM.zip --format=zip HEAD
5965

6066
## Part 2 - AWS Beanstalk, IAM, EC2, RDS, ECR
6167

62-
1. Create user wiht `AdministratorAccess` policy and log in.
68+
1. Create user wiht `AdministratorAccess` policy and log in. Create Access Key and Secret Access Key, you would need these for launching Chronos for cloud-based application. (instruction at the end).
6369

6470
2. Start Elastic Beanstalk with following settings:
6571
- Platform: Docker running on 64bit Amazon Linux 2
6672

67-
3. Upload zipped file (from previous step 9)
73+
3. Upload zipped file (from previous step 9), it will take a while to beanstalk to set things up.
6874

69-
4. Go to EC2 under the Services menu and select 'Key Pairs'.
75+
4. Go to EC2 , mark the instance ID for later use (instruction at the end) under the Services menu and select 'Key Pairs'.
7076

7177
5. Create a new key pair and give it a meaningful name like 'mm-ec2-key' and select "pem" as the file format.
7278

@@ -111,3 +117,21 @@ git archive -v -o myMM.zip --format=zip HEAD
111117

112118
10. Open the Dashboard for application environment and follow the URL at the top to see the application running in the cloud.
113119

120+
## Monitoring EC2 instance on Chronos
121+
122+
1. Start Chronos desktop application.
123+
124+
2. Select `cloud-based`
125+
126+
3. Use Access Key, Secret Access Key, region, and EC2 instance ID to start monitoring EC2 instance.
127+
128+
## Contributing
129+
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
130+
131+
## People
132+
[Snow X. Bai](https://github.com/xueapp)
133+
[Taylor Zhang](https://github.com/taylrzhang)
134+
[Tim Lee](https://github.com/timlee12)
135+
[Roberto Meloni ](https://github.com/RobertoRueMeloni)
136+
137+

examples/AWS-ECS/README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
## ECS Test Case
1+
# Chronos AWS ECS Example
2+
3+
Deploy AWS ECS for testing [Chronos](https://github.com/open-source-labs/Chronos), an open-source developer tool that monitors health data from servers, microservices, Kubernetes clusters, and now, AWS services.
4+
5+
## Purpose and Design
6+
7+
This sample AWS ECS example allows developers to explore the functionality of Chronos with cloud-based applications.
28

39
ECS clustter is deployed with following process:
410
- build Docker Image
@@ -18,7 +24,7 @@ ECS clustter is deployed with following process:
1824

1925
- If the @chronosmicro/tracker dependency is listed as a local npm package (i.e. `"@chronosmicro/tracker": "file:./chronos_npm_package"`), the Docker build will require that the the Chronos code is in this folder. Copy the _chronos_npm_package_ folder in manually.
2026

21-
### Deploy application in ECS
27+
## Deploy application in ECS
2228

2329
Step 1: build Docker Image
2430
```
@@ -42,14 +48,33 @@ Step 4: Set up AWS account, grant access to floowing AWS IAM permissions listed
4248

4349
If you push docker image in ECR you might need additional permission as well.
4450

45-
Step 5: Generate access key in IAM -> Users -> yourusername -> secureity credentials -> Access Keys. _Make sure you save your secret access key as it is only accessible once when generated._
51+
Step 5: Generate access key in IAM -> Users -> yourusername -> secureity credentials -> Access Keys. _Make sure you save your secret access key as it is only accessible once when generated._ (These are used for launching Chronos (instruction at the end)
4652

4753
Step 6: Create and use AWS context, follow instruction [here](https://docs.docker.com/cloud/ecs-integration/#requirements).
4854

4955
Step 7: Deploy test application in ECS
5056
```
5157
docker compose up
5258
```
53-
### some notes about the ecs-test
59+
60+
61+
## Monitoring ECS instance on Chronos
62+
63+
1. Start Chronos desktop application.
64+
65+
2. Select `cloud-based`
66+
67+
3. Use Access Key, Secret Access Key, and region to start monitoring ECS instance.
68+
69+
### Some notes about the ECS-test
70+
71+
The way deployment set up is using Fargate, you will not be able to see graphs in ECS cluster->metrics. Instead, check inside services or Cloudwatch.
72+
73+
## Contributing
74+
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
5475

55-
The way deployment set up is using Fargate, you will not be able to see graph in cluster->metrics. Instead, check inside services or cloudwatch. The ultimate visulization is in Chronos!!!
76+
## People
77+
[Snow X. Bai](https://github.com/xueapp)
78+
[Taylor Zhang](https://github.com/taylrzhang)
79+
[Tim Lee](https://github.com/timlee12)
80+
[Roberto Meloni ](https://github.com/RobertoRueMeloni)

0 commit comments

Comments
 (0)