Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
Updated instructions and successfully tested the code.
  • Loading branch information
ak-org authored Nov 1, 2024
1 parent 60bb711 commit 5d6add2
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions neuron-problem-detector/ecs-npd-cdk/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Overview

# Welcome to your CDK Python project!
This project contains CDK code to provision :

This is a blank project for CDK development with Python.
* An ECS Cluster and one Inf2.xlarge EC2 instance joining the cluster.
* An ECS Task Definition for Neruon Problem Detector and Recovery
* An ECS Service that run the containers as Daemon in all instances
* Related IAM roles and log groups

The `cdk.json` file tells the CDK Toolkit how to execute your app.

This project is set up like a standard Python project. The initialization
process also creates a virtualenv within this project, stored under the `.venv`
Expand All @@ -12,9 +15,15 @@ directory. To create the virtualenv it assumes that there is a `python3`
package. If for any reason the automatic creation of the virtualenv fails,
you can create the virtualenv manually.

The `cdk.json` file tells the CDK Toolkit how to execute your app.

## Pre-requisites
You will need `python3` and `cdk` utility installed on your machine.
To install `cdk` follow the instructions [here](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html)
Before you start, ensure that you have installed the latest version of the following tools on your machine:

1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
2. [aws cdk](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html)
3. [Session Manager Plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)


## Environment Setup
To manually create a virtualenv on MacOS and Linux:
Expand Down Expand Up @@ -60,7 +69,7 @@ Deploy the stack in your AWS environment
cdk deploy [--profile <profile name>]
```


## Optional
To add additional dependencies, for example other CDK libraries, just add
them to your `setup.py` file and rerun the `pip install -r requirements.txt`
command.
Expand All @@ -73,4 +82,4 @@ command.
* `cdk diff` compare deployed stack with current state
* `cdk docs` open CDK documentation

Enjoy!

0 comments on commit 5d6add2

Please sign in to comment.