From 5216d29b2f0a503266636a3e83a3f3f7a41c1ab2 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 00:37:39 -0500 Subject: [PATCH 01/11] Add First steps to finish the setup --- content/en/developer-guide/first_steps.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 content/en/developer-guide/first_steps.md diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md new file mode 100644 index 0000000000..167ebdc144 --- /dev/null +++ b/content/en/developer-guide/first_steps.md @@ -0,0 +1,22 @@ +### Running Localstack + +Once you have cloned the localstack repository, and setup the environment, with dependencies installed, +You should be able to create the python virtualenv with + + ```bash + virtualenv -p 3.8 venv + source venv/bin/activate + + ``` + it will create the virtualenv with the python version 3.8, and load it. + + Then, to install all the libraries into the containers, run + ```bash + make install + ``` + + Finally, you should able to run + ```bash + make start + ``` + You will see localstack running, and the url to http://localhost:4566/ shows `{"status": "running"}` From be36581b657cb2e2cff73cfb22cb0469a8274bc2 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 00:39:46 -0500 Subject: [PATCH 02/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 167ebdc144..6cc7337724 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -12,7 +12,7 @@ You should be able to create the python virtualenv with Then, to install all the libraries into the containers, run ```bash - make install + make install-dev ``` Finally, you should able to run From c892a3dd1c67e1e532c7c6d3f45819aaa4726612 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 01:09:08 -0500 Subject: [PATCH 03/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 6cc7337724..01b7e91544 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -20,3 +20,9 @@ You should be able to create the python virtualenv with make start ``` You will see localstack running, and the url to http://localhost:4566/ shows `{"status": "running"}` + + If you are looking for running directly the Python repo + + ```bash + localhost/bin$ python3 localstack start --host + ``` From d0fb1583ee0ce2de438c3d4def55b6f28a06f00e Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 01:11:36 -0500 Subject: [PATCH 04/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 01b7e91544..76c4cc2d51 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -26,3 +26,9 @@ You should be able to create the python virtualenv with ```bash localhost/bin$ python3 localstack start --host ``` + +### Debugging Local changes + +``` + python3 -m pdb localstack start --host +``` From 708db1f80514b165d624d698ff71b30681081411 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 01:20:40 -0500 Subject: [PATCH 05/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 76c4cc2d51..d0926310df 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -31,4 +31,6 @@ You should be able to create the python virtualenv with ``` python3 -m pdb localstack start --host + python3 -m pdb bin/localstack start --host + ``` From 1d5a28816381ebfb40752da6f3a2ae9e58d65424 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 01:50:13 -0500 Subject: [PATCH 06/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index d0926310df..7ae94dfeaf 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -34,3 +34,10 @@ You should be able to create the python virtualenv with python3 -m pdb bin/localstack start --host ``` + +### Initializa Services + +``` + SERVICES=s3 DEBUG=1 make start + +``` From 0321bd8085fde180f6c025a32167e762af549f5f Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 01:58:19 -0500 Subject: [PATCH 07/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 7ae94dfeaf..0b8baff938 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -35,7 +35,15 @@ You should be able to create the python virtualenv with ``` -### Initializa Services +Also, considerate the debugging flags at + +https://docs.localstack.cloud/localstack/configuration/#debugging + +``` + DEVELOP=1 SERVICES=s3,ec2, DEBUG=1 make start +``` + +### Initialize Services ``` SERVICES=s3 DEBUG=1 make start From c0245fe41de31197ce44aebce9fa082a7f375b81 Mon Sep 17 00:00:00 2001 From: Pipo Date: Tue, 12 Apr 2022 02:12:30 -0500 Subject: [PATCH 08/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index 0b8baff938..ae82f474fe 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -10,9 +10,9 @@ You should be able to create the python virtualenv with ``` it will create the virtualenv with the python version 3.8, and load it. - Then, to install all the libraries into the containers, run + Then, to install all the deps and third-party libraries into the venv, run ```bash - make install-dev + make install ``` Finally, you should able to run From 8a4eb52638cefd7872f2191a8b5b08cf42264d42 Mon Sep 17 00:00:00 2001 From: Pipo Date: Sun, 17 Apr 2022 20:03:22 -0500 Subject: [PATCH 09/11] Update first_steps.md --- content/en/developer-guide/first_steps.md | 72 ++++++++++++----------- 1 file changed, 37 insertions(+), 35 deletions(-) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index ae82f474fe..cf2744567a 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -1,51 +1,53 @@ ### Running Localstack -Once you have cloned the localstack repository, and setup the environment, with dependencies installed, -You should be able to create the python virtualenv with +Once you have cloned the LocalStack repository, and setup the environment, with the OS System dependencies installed, +you should be able to create the Python virtualenv. - ```bash - virtualenv -p 3.8 venv - source venv/bin/activate +We recommend create the virtualenv inside `.venv`, +which is automatically created whith the Make utility available in the root of the repository. - ``` - it will create the virtualenv with the python version 3.8, and load it. - - Then, to install all the deps and third-party libraries into the venv, run - ```bash - make install - ``` - - Finally, you should able to run - ```bash - make start - ``` - You will see localstack running, and the url to http://localhost:4566/ shows `{"status": "running"}` +Create the virtualenv with + +{{< command >}} +make venv +{{< / command >}} + + The command above will create the Python virtualenv with the dependencies. + Then, to build and install all the Python dependencies and third-party libraries into the venv, excecute - If you are looking for running directly the Python repo - - ```bash - localhost/bin$ python3 localstack start --host - ``` +{{< command >}} +make install +{{< / command >}} -### Debugging Local changes +Finally, you should able to run Localstack with +{{< command >}} +make start +{{< / command >}} -``` - python3 -m pdb localstack start --host - python3 -m pdb bin/localstack start --host +You will see LocalStack running, and the url to http://localhost:4566/ shows `{"status": "running"}` -``` +If you are looking for running LocalStack directly with Python, execute + +{{< command >}} +localhost/bin$ python3 localstack start --host +{{< / command >}} -Also, considerate the debugging flags at +### Debugging Local changes +{{< / command >}} +python3 -m pdb localstack start --host +python3 -m pdb bin/localstack start --host +{{< / command >}} + +Also, consider the debugging flags at https://docs.localstack.cloud/localstack/configuration/#debugging -``` +{{< command >}} DEVELOP=1 SERVICES=s3,ec2, DEBUG=1 make start -``` +{{< / command >}} ### Initialize Services -``` - SERVICES=s3 DEBUG=1 make start - -``` +{{< command >}} +SERVICES=s3 DEBUG=1 make start +{{< / command >}} From fd03e9a79bd52f0f7a4944d324e4fbc23c5244a8 Mon Sep 17 00:00:00 2001 From: Felipe de Jesus Ruiz Garcia Date: Wed, 27 Apr 2022 14:20:07 -0500 Subject: [PATCH 10/11] Fix wrong label for command Signed-off-by: Felipe de Jesus Ruiz Garcia --- content/en/developer-guide/first_steps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first_steps.md index cf2744567a..28686b8613 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first_steps.md @@ -34,7 +34,7 @@ localhost/bin$ python3 localstack start --host ### Debugging Local changes -{{< / command >}} +{{< command >}} python3 -m pdb localstack start --host python3 -m pdb bin/localstack start --host {{< / command >}} From 452fa1c95987b58bb8d7a50797ceb8f94450b94d Mon Sep 17 00:00:00 2001 From: Felipe de Jesus Ruiz Garcia Date: Wed, 27 Apr 2022 20:38:37 -0500 Subject: [PATCH 11/11] Add first steps in Developer guide Signed-off-by: Felipe de Jesus Ruiz Garcia --- .../{first_steps.md => first-steps.md} | 13 +++++++++++++ 1 file changed, 13 insertions(+) rename content/en/developer-guide/{first_steps.md => first-steps.md} (80%) diff --git a/content/en/developer-guide/first_steps.md b/content/en/developer-guide/first-steps.md similarity index 80% rename from content/en/developer-guide/first_steps.md rename to content/en/developer-guide/first-steps.md index 28686b8613..28a471f5a8 100644 --- a/content/en/developer-guide/first_steps.md +++ b/content/en/developer-guide/first-steps.md @@ -1,3 +1,14 @@ +--- +title: "First steps" +weight: 5 +description: Run Localstack and test your changes. + +--- + +{{% alert %}} +**Note:** We have recently added a couple of refactorings and enhancements in the core framework and application architecture, hence this page is no longer fully up to date. We're planning to publish an updated version soon. +{{% /alert %}} + ### Running Localstack Once you have cloned the LocalStack repository, and setup the environment, with the OS System dependencies installed, @@ -6,8 +17,10 @@ you should be able to create the Python virtualenv. We recommend create the virtualenv inside `.venv`, which is automatically created whith the Make utility available in the root of the repository. + Create the virtualenv with + {{< command >}} make venv {{< / command >}}