Skip to content

Commit 8de5f25

Browse files
committed
Added setup instructions for Linux-ubuntu
1 parent ef6f013 commit 8de5f25

File tree

1 file changed

+73
-3
lines changed

1 file changed

+73
-3
lines changed

README.md

Lines changed: 73 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,75 @@ Please refer to the AWS CDK Observability Accelertor [documentation site](https:
2626
## Usage
2727
Before proceeding, make sure [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) is installed on your machine.
2828

29-
To use the eks-blueprints and patterns module, you must have [Node.js](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed. You will also use `make` to simplify build and other common actions.
29+
To use the eks-blueprints and patterns module, you must have [Node.js](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed. You will also use `make` and `brew` to simplify build and other common actions.
30+
31+
### Ubuntu Setup
32+
Follow the below steps to setup and leverage cdk-aws-observability-accelerator in your Ubuntu Linux machine.
33+
34+
1. **Update the package list**
35+
36+
Update the package list to ensure you're installing the latest versions.
37+
38+
```bash
39+
sudo apt update
40+
```
41+
42+
2. **Install make**
43+
44+
```bash
45+
sudo apt install make
46+
```
47+
48+
3. **Install Node.js and npm**
49+
50+
Install Node.js and npm using the NodeSource binary distributions.
51+
```bash
52+
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - &&\
53+
sudo apt-get install -y nodejs
54+
```
55+
56+
Note: The Node.js package from NodeSource includes npm
57+
58+
4. **Verify Node.js and npm Installation**
59+
60+
Check the installed version of Node.js:
61+
62+
```bash
63+
node -v
64+
```
65+
66+
The output should be `v20.x.x`.
67+
68+
Check the installed version of npm:
69+
70+
```bash
71+
npm -v
72+
```
73+
74+
The output should be a version greater than `9.7.x`.
75+
76+
If your npm version is not `9.7.x` or above, update npm with the following command:
77+
78+
```bash
79+
sudo npm install -g npm@latest
80+
```
81+
82+
Verify the installed version by running `npm -v`.
83+
84+
5. Install brew on ubuntu by following instructions as detailed in [docs.brew.sh](https://docs.brew.sh/Homebrew-on-Linux)
85+
```bash
86+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
87+
```
88+
Add Homebrew to your PATH
89+
```
90+
test -d ~/.linuxbrew && eval "$(~/.linuxbrew/bin/brew shellenv)"
91+
test -d /home/linuxbrew/.linuxbrew && eval "$(/home/linuxbrew/.linux brew/bin/brew shellenv)"
92+
test -r ~/.bash_profile && echo "eval \"\$($(brew --prefix)/bin/brew shellenv)\"" >> ~/.bash_profile
93+
echo "eval \"\$($(brew --prefix)/bin/brew shellenv)\"" >> ~/.profile
94+
95+
```
96+
97+
Post completing the above, continue from Step: [Repo setup](#repo-setup)
3098
3199
### Mac Setup:
32100
@@ -66,15 +134,17 @@ $ npm -v
66134

67135
Updating npm: `sudo n stable` where stable can also be a specific version above 8.4. May require `sudo`.
68136

69-
4. Clone the `cdk-aws-observability-accelerator` repository
137+
138+
### Repo setup
139+
1. Clone the `cdk-aws-observability-accelerator` repository
70140

71141
```
72142
git clone https://github.com/aws-observability/cdk-aws-observability-accelerator.git
73143
```
74144

75145
PS: If you are contributing to this repo, please make sure to fork the repo, add your changes and create a PR against it.
76146

77-
5. Once you have cloned the repo, you can open it using your favourite IDE and run the below commands to install the dependencies and build the existing patterns.
147+
2. Once you have cloned the repo, you can open it using your favourite IDE and run the below commands to install the dependencies and build the existing patterns.
78148

79149
- Install project dependencies.
80150

0 commit comments

Comments
 (0)