docs: cut 1.7.0 new documentation #12276

uri200 · 2022-03-24T18:59:04Z

Signed-off-by: Oriol Batalla obatalla@fb.com

Summary

Update Magma doc site to include 1.7.0,

Will be merged once 1.7 is official

Test Plan

Additional Information

This change is backwards-breaking

github-actions · 2022-03-24T18:59:49Z

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

github-actions · 2022-03-24T19:01:31Z

Oops! Looks like you failed the Markdown lint check.

Howto

♻️ Updated: ❌ The check is still failing the Markdown lint check after the last commit.

github-actions · 2022-03-24T19:03:44Z

docs/docusaurus/versioned_docs/version-1.7.0/proposals/p011_intra_agw_mobility.md

+
+## Introduction
+
+Currently, mobility in Magma is limited to RAN a single AGW where RAN elements support the X2 interface. This isn't always feasible; S1 mobility is the "fallback" method for mobility in LTE networks when X2 isn't avaialble. The scope of this proposal is enhancing intra-AGW mobility (that is, mobility that does not cross an AGW boundary) using S1 handover. Although *inter-AGW* mobility is not within scope of this proposal, the signalling mechanisms necessary for S1 handover will be useful for future mobility proposals.


[misspell] _{reported by reviewdog 🐶}
"avaialble" is a misspelling of "available"

github-actions · 2022-03-24T19:03:44Z

docs/docusaurus/versioned_docs/version-1.7.0/proposals/p011_intra_agw_mobility.md

+
+## Introduction
+
+Currently, mobility in Magma is limited to RAN a single AGW where RAN elements support the X2 interface. This isn't always feasible; S1 mobility is the "fallback" method for mobility in LTE networks when X2 isn't avaialble. The scope of this proposal is enhancing intra-AGW mobility (that is, mobility that does not cross an AGW boundary) using S1 handover. Although *inter-AGW* mobility is not within scope of this proposal, the signalling mechanisms necessary for S1 handover will be useful for future mobility proposals.


[misspell] _{reported by reviewdog 🐶}
"signalling" is a misspelling of "signaling"

github-actions · 2022-03-24T19:03:44Z

docs/docusaurus/versioned_docs/version-1.7.0/proposals/p011_intra_agw_mobility.md

+
+The traditional S1 mobility call flow is our guide. A good overview of this particular flow is available [here](https://www.eventhelix.com/lte/handover/s1/).
+
+### S1AP Signalling


[misspell] _{reported by reviewdog 🐶}
"Signalling" is a misspelling of "Signaling"

github-actions · 2022-03-24T19:03:44Z

...aurus/versioned_docs/version-1.7.0/proposals/p008_mandatory_integration_tests_for_each_PR.md

+
+- Ensure that for each commit of each PR all unit test jobs are executed by CircleCI
+- Ensure that each PR was reviewed and accepted by component maintainer
+- Ensure that each PR which succesfully passed unit testing and maintainer review gets "ready-to-merge" label assigned.


[misspell] _{reported by reviewdog 🐶}
"succesfully" is a misspelling of "successfully"

github-actions · 2022-03-24T19:03:44Z

...aurus/versioned_docs/version-1.7.0/proposals/p008_mandatory_integration_tests_for_each_PR.md

+
+### Existing test env is a VirtualBox VMs managed by Vagrant on top of KVM VMs which are running on baremetall node is very slow
+
+As we found as a result of performance tests current setup gives us low performace because of Virtualbox running in KVM. Best option we can suggest so far is start using libvirt based vagrant boxes which 2-3 times faster then Virtualbox.


[misspell] _{reported by reviewdog 🐶}
"performace" is a misspelling of "performance"

github-actions · 2022-03-24T19:03:48Z

docs/docusaurus/versioned_docs/version-1.7.0/lte/architecture_overview.md

+┏Access Control & ┓         ┏━━━━Session━━━━┓ │  ┏━━━━Device━━━━━┓ │┏━━━Optional━━━━┓
+┃   Management    ┃         ┃   & Policy    ┃ │  ┃  Management   ┃ │┃   Services    ┃
+┃   ┌───────────┐ ┃         ┃  Management   ┃ │  ┃ ┌───────────┐ ┃ │┃ ┌────────────┐┃
+┃   │    MME    │ ┃         ┃ ┌───────────┐ ┃ └──╋─│  magmad   │ ┃ │┃ │  monitord  │┃


[misspell] _{reported by reviewdog 🐶}
"monitord" is a misspelling of "monitored"

github-actions · 2022-03-24T19:03:48Z

docs/docusaurus/versioned_docs/version-1.7.0/lte/architecture_overview.md

+
+Dynamic services are optional AGW services that must be enabled by updating the AGW's *magmad* configuration.
+
+### Monitord


[misspell] _{reported by reviewdog 🐶}
"Monitord" is a misspelling of "Monitored"

github-actions · 2022-03-24T19:03:48Z

docs/docusaurus/versioned_docs/version-1.7.0/lte/architecture_overview.md

+
+### Monitord
+
+*monitord* service. Monitors the CPEs connected to the AGW. Sends ICMP pings to the CPEs connected to the gateway and reports liveness metrics.


[misspell] _{reported by reviewdog 🐶}
"monitord" is a misspelling of "monitored"

github-actions · 2022-03-24T19:03:48Z

docs/docusaurus/versioned_docs/version-1.7.0/lte/redirectd.md

+already do this for the check quota service in CWF we take a lock when assigning
+an internal IP to prevent collisions. By assigning an internal IP in the same
+subnet as the Redirection server(which listens on OVS internal port) we get to
+use the deafult ip route that will send the redirect server responses back to


[misspell] _{reported by reviewdog 🐶}
"deafult" is a misspelling of "default"

github-actions · 2022-03-24T19:03:48Z

docs/docusaurus/versioned_docs/version-1.7.0/lte/eventd.md

+First, on the gateway, events are aggregated by the `eventd` service.
+To fire events, the gRPC interface on `eventd` must be called.
+The `eventd` service is responsible for sending these events to Fluent Bit,
+labelled as `td-agent-bit` on the diagram above.


[misspell] _{reported by reviewdog 🐶}
"labelled" is a misspelling of "labeled"

Neudrino

LGTM. However, I did not review every single file, as this is a migration (or version release).

We should probably make sure it was rebased with newest changes added between creation an merging the PR. 😉

electronjoe

% @Neudrino good advice

uri200 · 2022-03-28T21:54:17Z

Hey @Neudrino rebase will be done right before we release to make sure we collect everything

Signed-off-by: Oriol Batalla <obatalla@fb.com>

uri200 requested review from a team and electronjoe March 24, 2022 18:59

pull-request-size bot added the size/L Denotes a Pull Request that changes 100-499 lines. label Mar 24, 2022

uri200 requested a review from themarwhal March 24, 2022 18:59

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

uri200 force-pushed the docs_v1.7 branch from a47f2e6 to d758d90 Compare March 24, 2022 19:02

pull-request-size bot added size/XXL Denotes a Pull Request that changes 1000+ lines. and removed size/L Denotes a Pull Request that changes 100-499 lines. labels Mar 24, 2022

github-actions bot reviewed Mar 24, 2022

View reviewed changes

Neudrino reviewed Mar 25, 2022

View reviewed changes

electronjoe approved these changes Mar 28, 2022

View reviewed changes

docs: cut 1.7.0 new documentation

305a32a

Signed-off-by: Oriol Batalla <obatalla@fb.com>

uri200 force-pushed the docs_v1.7 branch from d758d90 to 305a32a Compare March 28, 2022 22:08

uri200 merged commit 85d52a6 into magma:master Mar 29, 2022

uri200 deleted the docs_v1.7 branch March 29, 2022 22:05

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

docs: cut 1.7.0 new documentation (magma#12276)

55062f7

voisey mentioned this pull request Sep 30, 2022

v1.8 docs need to be cut #14051

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: cut 1.7.0 new documentation #12276

docs: cut 1.7.0 new documentation #12276

uri200 commented Mar 24, 2022 •

edited

github-actions bot commented Mar 24, 2022

github-actions bot commented Mar 24, 2022 •

edited

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

github-actions bot Mar 24, 2022

Neudrino left a comment

electronjoe left a comment

uri200 commented Mar 28, 2022


		## Introduction

		Currently, mobility in Magma is limited to RAN a single AGW where RAN elements support the X2 interface. This isn't always feasible; S1 mobility is the "fallback" method for mobility in LTE networks when X2 isn't avaialble. The scope of this proposal is enhancing intra-AGW mobility (that is, mobility that does not cross an AGW boundary) using S1 handover. Although inter-AGW mobility is not within scope of this proposal, the signalling mechanisms necessary for S1 handover will be useful for future mobility proposals.


		The traditional S1 mobility call flow is our guide. A good overview of this particular flow is available [here](https://www.eventhelix.com/lte/handover/s1/).

		### S1AP Signalling


		### Existing test env is a VirtualBox VMs managed by Vagrant on top of KVM VMs which are running on baremetall node is very slow

		As we found as a result of performance tests current setup gives us low performace because of Virtualbox running in KVM. Best option we can suggest so far is start using libvirt based vagrant boxes which 2-3 times faster then Virtualbox.


		Dynamic services are optional AGW services that must be enabled by updating the AGW's magmad configuration.

		### Monitord


		### Monitord

		monitord service. Monitors the CPEs connected to the AGW. Sends ICMP pings to the CPEs connected to the gateway and reports liveness metrics.

docs: cut 1.7.0 new documentation #12276

docs: cut 1.7.0 new documentation #12276

Conversation

uri200 commented Mar 24, 2022 • edited

Summary

Test Plan

Additional Information

github-actions bot commented Mar 24, 2022

Howto

More info

github-actions bot commented Mar 24, 2022 • edited

Howto

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

github-actions bot Mar 24, 2022

Choose a reason for hiding this comment

Neudrino left a comment

Choose a reason for hiding this comment

electronjoe left a comment

Choose a reason for hiding this comment

uri200 commented Mar 28, 2022

uri200 commented Mar 24, 2022 •

edited

github-actions bot commented Mar 24, 2022 •

edited