docs: add NMS setup workflow guide #37
Open
Conversation
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
lucaaamaral
requested changes
Jul 23, 2025
There was a problem hiding this comment.
This is great and I thank you for your contribution. I left a few comments for you to take a look at, please consider them.
Also, consider separating the deployment of the two components in readmes/deployment/nms_docker.md and readmes/deplyment/orc8r_docker.md, listing the orc8r as prerequisite of the nms.
readmes/nms/nms_setup_workflow.md
Outdated
Comment on lines
49
to
83
| ### Important Note on Ruby Gem Compatibility | ||
|
|
||
| You might encounter compatibility errors with Ruby gems during this step. | ||
| Here's a recommended fix: | ||
| - Navigate to the Fluentd Dockerfile path: | ||
|
|
||
| ```bash | ||
| cd magma/orc8r/cloud/docker/fluentd | ||
| ``` | ||
| - Modify the Dockerfile from: | ||
|
|
||
| ```dockerfile | ||
| FROM fluent/fluentd:v1.14.6-debian-1.0 | ||
| USER root | ||
| RUN gem install \ | ||
| elasticsearch:7.13.0 \ | ||
| fluent-plugin-elasticsearch:5.2.1 \ | ||
| fluent-plugin-multi-format-parser:1.0.0 \ | ||
| --no-document | ||
| USER fluent | ||
| ``` | ||
|
|
||
| - To this updated version: | ||
|
|
||
| ```dockerfile | ||
| FROM fluent/fluentd:v1.14.6-debian-1.0 | ||
| USER root | ||
| RUN gem install rubygems-update -v 3.2.33 --no-document && \ | ||
| update_rubygems && \ | ||
| gem install multi_json -v 1.15.0 --no-document && \ | ||
| gem install elasticsearch -v 7.13.0 --no-document && \ | ||
| gem install fluent-plugin-elasticsearch -v 5.2.1 --no-document && \ | ||
| gem install fluent-plugin-multi-format-parser -v 1.0.0 --no-document | ||
| USER fluent | ||
| ``` |
There was a problem hiding this comment.
This is not interesting to add in the documentation.
The PR magma/magma#15699 solves this issue and is waiting to be merged.
readmes/nms/nms_setup_workflow.md
Outdated
Comment on lines
92
to
94
| **Image 1: Successful Orc8r build output** | ||
|  | ||
| *Caption: Terminal output confirming the successful build of Orc8r Docker artifacts.* |
There was a problem hiding this comment.
If the output is textual, prefer using a code box like this.
You can add multiple lines inside it.
And it is easier to maintain in the future, as git is not very efficient with binary files such as images.
readmes/nms/nms_setup_workflow.md
Outdated
Comment on lines
14
to
44
| ## Step 1: Fork and Clone the Repository | ||
|
|
||
| The first step is straightforward but essential. | ||
| You should have already forked the Magma repository to your own GitHub account. For example: | ||
| ```bash | ||
| https://github.com/username/magma.git | ||
| ``` | ||
|
|
||
| Now, clone your fork locally: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/username/magma.git | ||
| cd magma | ||
| ``` | ||
|
|
||
| ## Step 2: Keep Your Fork Updated | ||
|
|
||
| To pull in the latest changes from the official Magma repo, add the main repository as an upstream remote: | ||
|
|
||
| ```bash | ||
| git remote add upstream https://github.com/magma/magma.git | ||
| ``` | ||
|
|
||
| Verify your remotes: | ||
|
|
||
| ```bash | ||
| git remote -v | ||
| ``` | ||
|
|
||
| This setup helps you sync your fork with the original repository regularly. | ||
|
|
There was a problem hiding this comment.
As this is the official documentation, do you think this is necessary?
|
Don't forget to update the |
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
Test Plan
Additional Information
Security Considerations