docs(orc8r): Added docs for simple gateway registration #12263

christinewang5 · 2022-03-24T06:44:52Z

Added docs for simple gateway registration

github-actions · 2022-03-24T06:45:08Z

Thanks for opening a PR! 💯

A couple initial guidelines

All commits must be signed off. This is enforced by DCO check.
All PR titles must follow the semantic commits format. This is enforced by Semantic PR.

Howto

Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
Checks. All required CI checks must pass before merge.
Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

Contributing Conventions for norms around contributed code

If this is your first Magma PR, also consider reading

Developer Onboarding for onboarding as a new Magma developer
Development Workflow for guidance on your first pull request
CI Checks for points of contact for failing or flaky CI checks
GitHub-to-Slack mappings for Magma maintainers for guidance on how to contact maintainers on Slack

docs/docusaurus/i18n/en.json

hcgatewood

Lgtm! Couple comments, msg when ready to merge

docs/readmes/orc8r/dev_gateway_registration.md

Neudrino

Thanks for great additions! 🚀

If we could make "misspell" happy, that would be nice. 😄

Neudrino · 2022-03-25T11:11:32Z

docs/readmes/orc8r/dev_gateway_registration.md

+## Overview
+
+The overview of gateway registration is as follows:
+![gateway_registration_overview](assets/orc8r/gateway_registration_overview.png)


The graphics uploaded above seems incomplete. I.e. the lines touching the bottom of the graphics indicate to me, that there is more to come in the process. Could we add a "termination" there indicating that the registration process is finished?

Yeah I was using https://sequencediagram.org/ to create the diagram, it seems to format all its sequence diagrams like so

What do you think about using the bottomparticipants keyword in that tool to somehow work around that issue?

If you created the graphics from some text (similar to mermaid), than you would probably also want to add a hidden section with the respective code to the docs.
In Github this would probably be a , maybe Docusaurus has something similar?

If hidden parts are not possible, you might want to use a details block.

Hi @christinewang5 ,
according to this slack message DocuSaurus does support mermaid diagrams. (Also see the examples for Github and Docusaurus).

Could you at least post the code, used to generate the graphics here in the thread, for a later cleanup, please.

docs/readmes/orc8r/dev_gateway_registration.md

Neudrino · 2022-03-25T11:31:19Z

docs/readmes/orc8r/dev_gateway_registration.md

+   It can optionally set the root CA file with the `--ca-file CA_FILE` flag or disable writing to the control proxy file with the `--no-control-proxy` flag.
+
+   ```shell
+   sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py [-h] [--ca-file CA_FILE] [--cloud-port CLOUD_PORT] [--no-control-proxy] DOMAIN_NAME REGISTRATION_TOKEN 


Is there any reason to use sudo here? I do not see any immediate necessity. 😇

added a sentence to explain why we need sudo permission :)

Neudrino · 2022-03-25T11:31:52Z

docs/readmes/orc8r/dev_gateway_registration.md

+   ```shell
+   sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py [-h] [--ca-file CA_FILE] [--cloud-port CLOUD_PORT] [--no-control-proxy] DOMAIN_NAME REGISTRATION_TOKEN 
+   ```


Could we give context, to where this script is executed? And who does execute it?
From the scripts itself it seems as if this is development-VM specific. However, that it is not necessarily correct for a (bare-metal) production deployment.

Yup, good point, added the shell prompt in front MAGMA-VM [/home/vagrant]$ to indicate

Signed-off-by: Christine Wang <christinewang@fb.com>

github-actions · 2022-03-25T15:32:21Z

Oops! Looks like you failed the Markdown lint check.

Howto

Neudrino · 2022-03-25T16:34:53Z

docs/readmes/orc8r/dev_gateway_registration.md

+   For example, in a testing environment with the `rootCA.pem` and `control_proxy.yml` configured, the operator could run
+
+   ```shell
+   MAGMA-VM [/home/vagrant]$ sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py magma.test reg_t5S4zjhD0tXRTmkYKQoN91FmWnQSK2  --cloud-port 7444 --no-control-proxy 


Suggested change

MAGMA-VM [/home/vagrant]$ sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py magma.test reg_t5S4zjhD0tXRTmkYKQoN91FmWnQSK2 --cloud-port 7444 --no-control-proxy

MAGMA-VM [/home/vagrant]$ sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py magma.test reg_t5S4zjhD0tXRTmkYKQoN91FmWnQSK2 --cloud-port 7444 --no-control-proxy

github-actions · 2022-03-29T22:48:33Z

Unit Test Results

157 files 157 suites 2h 4m 6s ⏱️
307 tests 304 ✔️ 3 💤 0 ❌

Results for commit cadb1d4.

♻️ This comment has been updated with latest results.

christinewang5 requested review from hcgatewood and a team March 24, 2022 06:44

pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines. label Mar 24, 2022

github-actions bot added the component: docs Documentation-related issue label Mar 24, 2022

github-actions bot reviewed Mar 24, 2022

View reviewed changes

docs/docusaurus/i18n/en.json Outdated Show resolved Hide resolved

docs/docusaurus/i18n/en.json Outdated Show resolved Hide resolved

christinewang5 force-pushed the simple-gw-reg-docs branch from d4a30b6 to 0cd3290 Compare March 24, 2022 13:03

hcgatewood approved these changes Mar 24, 2022

View reviewed changes

docs/readmes/orc8r/dev_gateway_registration.md Outdated Show resolved Hide resolved

docs/readmes/orc8r/dev_gateway_registration.md Show resolved Hide resolved

docs/readmes/orc8r/dev_gateway_registration.md Outdated Show resolved Hide resolved

Neudrino reviewed Mar 25, 2022

View reviewed changes

christinewang5 force-pushed the simple-gw-reg-docs branch 2 times, most recently from 793a437 to 4af7af0 Compare March 25, 2022 15:26

docs(orc8r): Added docs for simple gateway registration

ec3911c

Signed-off-by: Christine Wang <christinewang@fb.com>

christinewang5 force-pushed the simple-gw-reg-docs branch from 4af7af0 to ec3911c Compare March 25, 2022 15:29

pull-request-size bot added size/L Denotes a Pull Request that changes 100-499 lines. and removed size/M Denotes a PR that changes 30-99 lines. labels Mar 25, 2022

Neudrino reviewed Mar 25, 2022

View reviewed changes

hcgatewood merged commit cadb1d4 into magma:master Mar 29, 2022

ardzoht pushed a commit that referenced this pull request Mar 30, 2022

docs(orc8r): Added docs for simple gateway registration (#12263)

1e064fa

emakeev pushed a commit to emakeev/magma that referenced this pull request Aug 5, 2022

docs(orc8r): Added docs for simple gateway registration (magma#12263)

a285854

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(orc8r): Added docs for simple gateway registration #12263

docs(orc8r): Added docs for simple gateway registration #12263

christinewang5 commented Mar 24, 2022

github-actions bot commented Mar 24, 2022

hcgatewood left a comment

Neudrino left a comment

Neudrino Mar 25, 2022

christinewang5 Mar 25, 2022

Neudrino Mar 25, 2022

Neudrino Mar 25, 2022

Neudrino Mar 25, 2022

Neudrino Apr 6, 2022

Neudrino Mar 25, 2022

christinewang5 Mar 25, 2022

Neudrino Mar 25, 2022

christinewang5 Mar 25, 2022

github-actions bot commented Mar 25, 2022

Neudrino Mar 25, 2022

github-actions bot commented Mar 29, 2022 •

edited

	MAGMA-VM [/home/vagrant]$ sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py magma.test reg_t5S4zjhD0tXRTmkYKQoN91FmWnQSK2 --cloud-port 7444 --no-control-proxy
	MAGMA-VM [/home/vagrant]$ sudo /home/vagrant/build/python/bin/python3 ~/magma/orc8r/gateway/python/scripts/register.py magma.test reg_t5S4zjhD0tXRTmkYKQoN91FmWnQSK2 --cloud-port 7444 --no-control-proxy

docs(orc8r): Added docs for simple gateway registration #12263

docs(orc8r): Added docs for simple gateway registration #12263

Conversation

christinewang5 commented Mar 24, 2022

github-actions bot commented Mar 24, 2022

Howto

More info

hcgatewood left a comment

Choose a reason for hiding this comment

Neudrino left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 25, 2022

Howto

Choose a reason for hiding this comment

github-actions bot commented Mar 29, 2022 • edited

Unit Test Results

github-actions bot commented Mar 29, 2022 •

edited