Magma Documentation

1.8.0

Magma Website
|
Docs
|
Code
|
Contributing
|
Wiki

›Contribute

Getting Started

Introduction
Prerequisites
Quick Start Guide

Tutorials

Operate your own private mobile network with Charmed Magma

Overview
1. Getting Started
2. Deploying Magma Orchestrator
3. Deploying Magma Access Gateway
4. Integrating Magma Access Gateway with Magma Orchestrator
5. Deploying the radio simulator
6. Simulating user traffic
7. Destroying the environment

Usage

How-To

UE Usage Metering
AGW Non-NAT Mode
5G NSA Support
Call Tracing
Events Monitoring
(Experimental) Configure IPv6 AGW
Header Enrichment
Inbound Roaming
L3 transport for AGW
Network Probe
Packaging

NMS

Overview
Dashboard
Equipment
Network
Subscriber
Traffic
Metrics
Alerts
Federation
Admin
Tips and Tricks

Architecture

Access Gateway

Overview

Orchestrator

Overview
Modularity
Security

NMS

Overview

FeG

Overview

Domain Proxy

Overview

Deploy

General

AWS Cloudstrapper Install

Access Gateway

Install AGW
Install Docker AGW
Configure AGW
Configure eNodeB
Configure an APN
Deploy AGW using Juju
Build and install a magma package in AGW

Orchestrator

Introduction
Install Orchestrator
Deploy Orchestrator using Juju
Terraform Options
FAQs

NMS

Set Up NMS

Federation Gateway

Introduction
Build FeG
Install FeG

Domain Proxy

Build and deployment

Carrier WiFi

Introduction
Building Carrier Wifi Gateway
Installing Carrier Wifi Gateway

Configure

Access Gateway

Configure AGW for HA
Sentry Integration

Orchestrator

Thanos

Federation Gateway

Configure FeG

NMS

Multitenancy (Organizations)

Upgrade

General

Introduction

Access Gateway

Migrate AGWs to Ubuntu
Upgrade to v1.6
Upgrade to v1.5
Upgrade to v1.4
Upgrade to v1.3
Upgrade to v1.2
Upgrade to v1.1

Orchestrator

Introduction
Upgrade to v1.6
Upgrade to v1.5
Upgrade to v1.4
Upgrade to v1.3
Upgrade to v1.2
Upgrade to v1.1

Debug

General

Perform Access Gateway health check
Access Gateway Unable to Check-in to Orchestrator
User is unable to attach to Magma
Update rootCA and controller SSL certificates
Generate and update admin_operator certificates
Analyze Service crashes in AGW
Debugging AGW datapath issues

Access Gateway

Show Tech
Datapath Probe CLI
User Control Plane trace CLI

Federated Gateway

FeG CLI

Carrier WiFi

Health Checker

Orchestrator

View Logs

NMS

Alerts

Domain Proxy

Debugging and logs

Contribute

Contribute

Developer Onboarding
Development Workflow
Develop Magma With VSCode
Contributing Conventions
Magma Codeowners
Continuous Integration Checks

Maintain

Codeowners Workflow
TSC Processes

Technical Reference

General

PCAP Collection
Useful Links
Life of a Magma Metric
Documentation Overview

Access Gateway

Services/Sub-Components
Developer Notes
Magma Datapath
Pipelined
Magma eBPF Datapath
Magma IPFIX Support
Pipelined testing framework
Test AGW
Add eNB TR-069 Support
S1AP Integration Tests
Event Reporting
Restricting Network Access
TEID Allocation
Integrated 5G SA
Extended 5G SA Features
SUCI Extensions
Redirection
Building the Callflow

Orchestrator

REST API
Build Orchestrator
Test Orchestrator
Deploy on Minikube
Security
State Indexers
Subscriber Digests
REST API Auth
Module Dependencies
Gateway Registration
AWS Stack

NMS

Spacing Guidelines
Test NMS
Themes
Components

Federation Gateway

Test Federation Gateway
FeG Docker Setup
S1AP Federated Integration Tests

Carrier WiFi

Test CWAG

Design Documents

General

Configurable VPN from Orchestrator API
Call Tracing for Troubleshooting
Magma Proposals
Tech Debt Week Processes
APN Refactoring Proposal

Access Gateway

QoS Policy Configuration
Service Restriction Feature
Header enrichment
MME APN Correction
AGW Ubuntu upgrade
Export Control Path Network Metrics
Enodebd CBRS Support
L3 transport for AGW

Orchestrator

Scaled Prometheus Pipeline
Subscriber Scaling
VictoriaMetrics as Magma's TSDB

NMS

NMS MariaDB Migration
NMS Regression Testing

FAQ

Frequently Asked Questions

Continuous Integration Checks

With respect to the ongoing documentation restructuring this page was moved to the Github Wiki.

← Previous Codeowners Workflow →

Copyright © 2024 The Magma Authors