-
Notifications
You must be signed in to change notification settings - Fork 13
docs: remove Vagrant documentation from magma-documentation #59
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
Open
Spirizeon
wants to merge
8
commits into
magma:main
Choose a base branch
from
Spirizeon:remove-vagrant-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
44be5f3
docs: remove Vagrant documentation and add deprecation notice
Spirizeon b8bf1db
docs: remove Vagrant documentation and add deprecation notice
Spirizeon 04847bf
fix: update link path and add migration pointer to deprecation notice
Spirizeon cd389a9
Merge branch 'main' into remove-vagrant-docs
Spirizeon 7d814d7
docs: continue removing Vagrant documentation
Spirizeon aae3d1a
docs: continue removing Vagrant documentation from additional files
Spirizeon 5039822
fix: align Vagrant removal with Docker commands and fix inconsistencies
Spirizeon 0223635
fix: address PR review feedback - remove unnecessary deprecation notices
Spirizeon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,32 @@ | ||
| --- | ||
| id: version-1.0.0-setup | ||
| title: CWAG Setup (With Vagrant) | ||
| sidebar_label: Setup (With Vagrant) | ||
| title: CWAG Setup | ||
| sidebar_label: Setup | ||
| hide_title: true | ||
| original_id: setup | ||
| --- | ||
| # CWF Access Gateway Setup (With Vagrant) | ||
| ### Prerequisites | ||
| To develop and manage a Magma VM, you must have the following applications installed locally: | ||
|
|
||
| * Virtualbox | ||
| * Vagrant | ||
| * Ansible | ||
| # Carrier Wifi Access Gateway (CWAG) Setup | ||
|
|
||
| ### Steps | ||
| > **Note**: Vagrant-based CWAG setup has been deprecated. Please use Docker-based deployment. | ||
|
|
||
| To bring up a Wifi Access Gateway (CWAG) VM using Vagrant: | ||
| ### Prerequisites | ||
|
|
||
| * Run the following command: | ||
| To develop and manage a Magma CWAG using Docker, you must have the following installed: | ||
|
|
||
| ``HOST:magma/cwf/gateway USER$ vagrant up cwag`` | ||
| - Docker and Docker Compose | ||
| - Ansible (for configuration) | ||
|
|
||
| Vagrant will bring up the VM, then Ansible will provision the VM. | ||
| ### Steps | ||
|
|
||
| To bring up a Carrier Wifi Access Gateway (CWAG) using Docker, follow the [AGW Docker deployment guide](../deployment/agw/docker.md). | ||
|
|
||
| * Once the CWAG VM is up and provisioned, run the following commands: | ||
| Quick start: | ||
|
|
||
| ``HOST:magma/cwf/gateway USER$ vagrant ssh cwag``<br></br> | ||
| ``AGW:~ USER$ cd magma/cwf/gateway/docker``<br></br> | ||
| ``AGW:~/magma/cwf/gateway/docker USER$ docker-compose build --parallel`` | ||
| ``AGW:~/magma/cwf/gateway/docker USER$ docker-compose up -d`` | ||
| ```bash | ||
| HOST [magma/cwf/gateway]$ cd cwf/gateway/deploy | ||
| HOST [magma/cwf/gateway/deploy]$ ./agw_docker_install.sh | ||
| ``` | ||
|
|
||
| After this, all the CWAG docker containers should have been brought up | ||
| successfully. | ||
| For more details, see: | ||
| - [Quick Start Guide](../basics/quick_start_guide.md) | ||
| - [AGW Docker Deployment](../deployment/agw/docker.md) |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,34 @@ | ||
| --- | ||
| id: version-1.0.0-setup | ||
| title: AGW Setup (With Vagrant) | ||
| sidebar_label: Setup (With Vagrant) | ||
| title: AGW Setup | ||
| sidebar_label: Setup | ||
| hide_title: true | ||
| original_id: setup | ||
| --- | ||
| # Access Gateway Setup (With Vagrant) | ||
| ### Prerequisites | ||
| To develop and manage a Magma VM, you must have the following applications installed locally: | ||
| # Access Gateway Setup | ||
|
|
||
| * Virtualbox | ||
| * Vagrant | ||
| * Ansible | ||
| > **Note**: Vagrant-based AGW setup has been deprecated. Please use Docker-based deployment. | ||
|
|
||
| ### Steps | ||
| ### Prerequisites | ||
|
|
||
| To bring up an Access Gateway (AGW) VM using Vagrant: | ||
| To develop and manage a Magma AGW using Docker, you must have the following installed: | ||
|
|
||
| * Run the following command: | ||
| - Docker and Docker Compose | ||
| - Ansible (for configuration) | ||
|
|
||
| ``HOST:magma/lte/gateway USER$ vagrant up magma`` | ||
| ### Steps | ||
|
|
||
| Vagrant will bring up the VM, then Ansible will provision the VM. | ||
| To bring up an Access Gateway (AGW) using Docker, follow the [AGW Docker deployment guide](../deployment/agw/docker.md). | ||
|
|
||
| Quick start: | ||
|
|
||
| * Once the Access Gateway VM is up and provisioned, run the following commands: | ||
| ```bash | ||
| HOST [magma/lte/gateway]$ cd deploy | ||
| HOST [magma/lte/gateway/deploy]$ ./agw_docker_install.sh | ||
| ``` | ||
|
|
||
| ``HOST:magma/lte/gateway USER$ vagrant ssh magma``<br></br> | ||
| ``AGW:~ USER$ cd magma/lte/gateway``<br></br> | ||
| ``AGW:~/magma/lte/gateway USER$ make run`` | ||
| Once the Access Gateway is running successfully, proceed to attaching the eNodeB. | ||
|
|
||
| Once the Access Gateway VM is running successfully, proceed to attaching the eNodeB. | ||
| For more details, see: | ||
| - [Quick Start Guide](../basics/quick_start_guide.md) | ||
| - [AGW Docker Deployment](../deployment/agw/docker.md) |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current documentation lives on
readmes, don't change anything else unless you have a reason to.