docs: Document magma_deb VM #13840
Merged
docs: Document magma_deb VM #13840
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening a PR! 💯
Howto
More infoPlease take a moment to read through the Magma project's
If this is your first Magma PR, also consider reading
|
5 tasks
Neudrino
approved these changes
Sep 5, 2022
docs/readmes/lte/s1ap_tests.md
Outdated
| method by which magma is usually deployed. For everyday development, the `make` installation is | ||
| recommended, while the debian installation is useful for testing packages before release. | ||
|
|
||
| > **Warning**: These two VMs use the same network configuration, so only one of them should be |
There was a problem hiding this comment.
should seems a bit too nonrestrictive here? Should this not be must not?
There was a problem hiding this comment.
I changed "should" to "must" and reworded it slightly. Is it better now?
docs/readmes/lte/s1ap_tests.md
Outdated
| Spin up and provision the gateway VM, then make and start its services: | ||
|
|
||
| 1. From `magma/lte/gateway` on the host machine: `vagrant up magma && vagrant ssh magma` | ||
| 1. Now in the gateway VM: `cd $MAGMA_ROOT/lte/gateway && make run` | ||
|
|
||
| #### Debian installation | ||
|
|
||
| Spin up the *magma_deb* VM. The services should start automatically: |
There was a problem hiding this comment.
We might want to remove the should here? That would sound more confident.
voisey
force-pushed
the
magma-deb-docs
branch
2 times, most recently
from
f894a46
to
5602ccd
Compare
ajahl
approved these changes
Sep 5, 2022
nstng
reviewed
Sep 5, 2022
| Spin up and provision the gateway VM, then make and start its services: | ||
|
|
||
| 1. From `magma/lte/gateway` on the host machine: `vagrant up magma && vagrant ssh magma` | ||
| 1. Now in the gateway VM: `cd $MAGMA_ROOT/lte/gateway && make run` | ||
|
|
||
| #### Debian installation | ||
|
|
||
| Spin up the *magma_deb* VM. The services start automatically: |
There was a problem hiding this comment.
~"During provisioning the latest magma gateway debian build from the magma artifactory is installed. This is, the deployed gateway might not match your local repository state."
There was a problem hiding this comment.
Nice suggestion, thanks! I've added this as a warning.
nstng
approved these changes
Sep 5, 2022
Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
voisey
force-pushed
the
magma-deb-docs
branch
from
5602ccd
to
d08439c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Document how to run the integration tests versus the magma_deb VM.
Test Plan
cd $MAGMA_ROOT/docs && make precommitpasses locally.