Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for WSL #777

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/content/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,42 @@ The distributables for each language can be used directly as follows:

The following subsections outline what you need to install and use the AWS PDK.


### Windows Linux Subsystem (WSL)

If you work on a Windows OS, it's possible to run PDK through the Windows Linux Subsystem (WSL).

The WSL comes in two versions where version 1 is [more performant](https://learn.microsoft.com/en-us/windows/wsl/compare-versions) regarding files access protocol between the Windows OS and the Linux subsystem.

As PDK is downloading a lot of packages and write a lot of small files, this setting has a significant impact.

By default, WSL will install a Ubuntu Linux flavor in version 2.

```ps
wsl --install
wsl --set-version Ubuntu 1
```

Then connect in the subsystem by doing:
```ps
wsl
```


Ubuntu comes without some packages that you have to install:
```bash
sudo apt install build-essential graphviz
```

Where **build-essential** brings the **make** utils and **graphviz** is used for PNG/SVG schema generation.

Finally, and this is related to the Ubuntu **urllib3** package, we have to install a complementary version as **awscli** is not supporting yet the version 2 of this lib:

```python
pip install 'urllib3<2'
```


### Node runtime

All AWS PDK developers, even those working in Python or Java, need Node.js 16 or later. All supported languages use the same backend, which runs on Node.js. We recommend a version in active long-term support. Your organization may have a different recommendation.
Expand Down
Loading