docs: remove Vagrant documentation from magma-documentation#59
Open
Spirizeon wants to merge 8 commits into
Open
docs: remove Vagrant documentation from magma-documentation#59Spirizeon wants to merge 8 commits into
Spirizeon wants to merge 8 commits into
Conversation
- Removed Vagrant and VirtualBox from prerequisites (macOS and Ubuntu) - Replaced Vagrant-based AGW setup with Docker-based deployment - Added deprecation notice in introduction.md directing users to Docker - Updated quick_start_guide.md to use agw_docker_install.sh - Part of Issue magma#45: Remove Vagrant Documentation from Magma Documentation Repository See: magma/magma#15754
- Removed Vagrant and VirtualBox from prerequisites (macOS and Ubuntu) - Replaced Vagrant-based AGW setup with Docker-based deployment - Added deprecation notice in introduction.md directing users to Docker - Updated quick_start_guide.md to use agw_docker_install.sh - Part of Issue magma#45: Remove Vagrant Documentation from Magma Documentation Repository See: magma/magma#15754
- Fixed relative link from ./deployment/agw/docker.md to ../deployment/agw/docker.md - Added migration guide reference to deprecation notice pointing to issue #15754
- Updated docusaurus/docs/lte/setup.md to use Docker instead of Vagrant - Updated readmes/lte/readme_agw.md to use docker exec instead of vagrant ssh - Updated readmes/lte/build_install_magma_pkg_in_agw.md to use Docker - Updated readmes/lte/dev_unit_testing.md to use Docker containers Part of Issue magma#45: Remove Vagrant Documentation
- Updated docusaurus/docs/cwf/setup.md to use Docker instead of Vagrant - Added deprecation notice to docusaurus/docs/lte/s1ap_tests.md - Added deprecation notice to readmes/feg/s1ap_federated_tests.md - Updated architecture section to remove Vagrant mentions Part of Issue magma#45: Remove Vagrant Documentation
- docusaurus/docs/lte/setup.md: Fixed cd path (cd deploy instead of cd lte/gateway/deploy) - readmes/lte/build_install_magma_pkg_in_agw.md: Removed duplicate bazel command, changed VM to container - readmes/lte/dev_unit_testing.md: Changed VM to CONTAINER in test/format sections - readmes/orc8r/dev_gateway_registration.md: Updated paths for Docker instead of Vagrant - docusaurus/docs/lte/README_AGW.md: Updated CLI example for Docker - readmes/bazel/agw_with_bazel.md: Added deprecation notes for Vagrant VMs Part of Issue magma#45: Remove Vagrant Documentation
lucaaamaral
requested changes
May 4, 2026
Collaborator
lucaaamaral
left a comment
lucaaamaral
left a comment
There was a problem hiding this comment.
Thank you for the time and effort invested in this, I appreciate. I have some nits.
Don't change documentation outside readmes unless you have a strong reason to.
| vagrant machine under `lte/gateway`. | ||
| > **Note**: Vagrant-based development has been deprecated. Please use the | ||
| > Docker-based AGW deployment. See the [AGW Docker deployment guide](../deployment/agw/docker.md) | ||
| > for the latest instructions. |
Collaborator
There was a problem hiding this comment.
No need to mention this here. The previous version is still correct. A VM is used for deploying, this is the easiest "quick start" possible.
You can rephrase to make the intent clearer.
Collaborator
There was a problem hiding this comment.
Current documentation lives on readmes, don't change anything else unless you have a reason to.
| Go ahead and open up 2 fresh terminal tabs. | ||
|
|
||
| ### Terminal Tab 1: Provision the AGW VM | ||
| ### Terminal Tab 1: Provision the AGW (Docker) |
Collaborator
There was a problem hiding this comment.
We still use VMs to provision AGW, this is the best "quick start" way possible to go.
| any production hardware on hand to test an end-to-end setup. | ||
| We'll be setting up the LTE AGW VM in this tab. | ||
| The development environment can use Docker to run the Access Gateway. See the | ||
| [AGW Docker deployment](../deployment/agw/docker.md) for detailed instructions. |
Collaborator
There was a problem hiding this comment.
I would very much approciate if you reviewed if the file existed before submitting the PR. Or create one with targeted content if it does not exist. This is on roadmap, only not implemented yet.
Comment on lines
-179
to
-184
| At this point, you will have built all the code in the LTE access gateway and | ||
| the Orchestrator cloud. All the services on the LTE access gateway and | ||
| orchestrator cloud are running, but your gateway VM isn't yet set up to | ||
| communicate with your local cloud. | ||
|
|
||
| We have a fabric command set up to do this: |
Collaborator
There was a problem hiding this comment.
Think from the point of view of the reader, add a little bit of context or reference a file for this context. "Why do we need to register the AGW to the orchestrator" was something the previous text attempted to answer.
Comment on lines
+113
to
+116
| - Vagrant VMs (Deprecated) | ||
| - **magma-dev** | ||
| - The magma-dev virtual machine is intended for local development and for extended testing in CI. It can be used to run the Magma AGW services, as well as e.g. the [Python sudo tests](#python-sudo-tests). | ||
| - > **Note**: Vagrant-based development has been deprecated. Use Docker-based AGW instead. |
Collaborator
There was a problem hiding this comment.
You can straight up remove it.
| - > **Note**: Vagrant-based development has been deprecated. Use Docker-based AGW instead. | ||
| - **magma-test** | ||
| - The magma-test virtual machine is used in CI to run the [LTE integration tests](#lte-integration-tests). | ||
| - > **Note**: Vagrant-based testing has been deprecated. |
Comment on lines
+9
to
+10
| > **Note**: Vagrant-based testing has been deprecated. Docker-based deployment is now recommended. | ||
|
|
Collaborator
There was a problem hiding this comment.
No need - the documentation is updated already.
|
|
||
| To SSH into the magma-dev VM, run | ||
| > **Note**: Vagrant-based testing has been deprecated. Please use Docker containers. | ||
|
|
| The registration token expires every 30 minutes and automatically refreshes every time the operator fetches this unregistered gateway. | ||
| 2. The operator runs the `register.py` script at the gateway with the registration token and its Orc8r's domain name. | ||
|
|
||
| > **Note**: Vagrant-based AGW has been deprecated. Please use Docker-based AGW deployment. |
- Reverted changes to docusaurus/docs/ (keep only readmes/ changes) - Removed redundant deprecation notices from agw_with_bazel.md, s1ap_federated_tests.md, dev_unit_testing.md, dev_gateway_registration.md - Updated VM references in quick_start_guide.md (VMs still valid for quick start) - Fixed broken link to use existing ../lte/deploy_install_docker.md Part of Issue magma#45
Author
|
@lucaaamaral Thank you for the review! I have tried to resolve the requested changes. |
Collaborator
|
Revert changes on |
Collaborator
|
Check my comments, there are still unnadressed points. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Remove Vagrant-related documentation from the magma-documentation repository as part of the approved TSC plan to deprecate and remove Vagrant deployment in Magma (see magma/magma#15754).
This addresses Issue #45.
Changes
Prerequisites (readmes/basics/prerequisites.md)
Introduction (readmes/basics/introduction.md)
Quick Start Guide (readmes/basics/quick_start_guide.md)
Docusaurus Docs (docusaurus/docs/)
Testing
Searched repository for remaining Vagrant references:
Related Issues