See Handover Meetings (and sub-pages) for hands on handover meetings.

Show&Tell Sessions

CI: 2023-02-01 Magma CI Show&Tell + Q&A

VMs: 2023-02-08 Magma VMs Show&Tell + Q&A

Bazel: 2023-02-15 Magma Bazel Show&Tell + Q&A

Release: 2023-02-23 Magma Release Show&Tell + Q&A

DevOps

• Infrastructure

  • Overview

    • https://github.com/magma/magma/wiki/Technical-Infrastructure

  • GitHub

    • Code ownership and reviews

      • https://github.com/magma/magma/wiki/Contributing-Code

    • Branch protection rules

      • https://github.com/magma/magma/wiki/Contributing-Code

    • Artifacts
      
      

      • https://github.com/magma/magma/wiki/Magma-Artifactory

  • GitHub Actions

    • Secrets
      
      

      • Add something to https://github.com/magma/magma/wiki/Technical-Infrastructure under GitHub section

      • TRACKED IN ISSUE https://github.com/magma/magma/issues/15009 

    • Caching

      • Bazel caching: https://magma.github.io/magma/docs/next/bazel/agw_with_bazel#caching

      • VM caching: https://github.com/magma/magma/wiki/Creating,-Testing,-and-Publishing-Magma-VM-Base-Images

      • GitHub caches. Add to https://github.com/magma/magma/wiki/Technical-Infrastructure under GitHub section

      • GitHub artifacts (published images)

      • TRACKED IN ISSUE https://github.com/magma/magma/issues/15010

  • Artifactory (https://linuxfoundation.jfrog.io/ui)

    • https://github.com/magma/magma/wiki/Magma-Artifactory

    • Debian/Ubuntu

      • the structure

      • keeping dependencies up to date

    • Docker

    • Helm

      • Brief mentions in Build Orchestrator and Deploy on Minikube

      • May be helpful to look at the files in https://github.com/magma/magma/tree/master/orc8r/tools/helm

    • blob storage

  • CI Dashboard (https://magma-ci.web.app/)

    • https://github.com/magma/magma/wiki/Magma-CI
      
      

      • Add something explaining where the dashboard is configured, i.e. linking to https://github.com/magma/ci-dashboard? → Link added to https://github.com/magma/magma/wiki/Technical-Infrastructure#ci-dashboard-and-firebase

  • Website

    • Docusaurus generation of documentation

      • Overview: https://magma.github.io/magma/docs/docs/docs_overview 

      • Contributing: https://github.com/magma/magma/wiki/Contributing-Documentation

      • Deployment: https://github.com/magma/magma/wiki/Documentation-Infrastructure-for-Docusaurus

  • AWS

    • https://github.com/magma/magma/wiki/Technical-Infrastructure

• CI

  • GitHub Actions

    • Definitions of actions

      • https://github.com/magma/magma/wiki/Contributing-Code

      • https://github.com/magma/magma/wiki/Magma-CI

    • Integration in Slack

      • https://github.com/magma/magma/wiki/Technical-Infrastructure#slack

  • other Jobs in CI

    • DCO

      • https://github.com/magma/magma/wiki/Contributing-Code#signed-off-commits

    • dependabot
      
      

      • https://github.com/magma/magma/wiki/Technical-Infrastructure#dependabot

      • https://github.com/magma/magma/wiki/Security-Overview-for-Contributors#additional-resources.

    • codecov

      • https://github.com/magma/magma/wiki/Technical-Infrastructure#codecovio 

      • https://github.com/magma/magma/wiki/Magma-CI#external-workflows

      • https://github.com/magma/magma/wiki/Contributing-Code#overview-of-checks-applied-to-a-pull-request

• Third-party dependencies

  • https://github.com/magma/magma/wiki/Third-Party-Dependencies 

  • building

  • patching

  • publishing

• (auto-) Formatting and style-guides

  • https://github.com/magma/magma/wiki/Contributing-Code-Conventions (code conventions)

  • https://github.com/magma/magma/wiki/Contributing-Documentation#checking-changes (documentation formatting)

  • https://magma.github.io/magma/docs/next/bazel/agw_with_bazel#starlark-formatter (Bazel)

  • https://magma.github.io/magma/docs/next/cwf/dev_testing#format-and-verify-build (CWAG)

  • https://magma.github.io/magma/docs/next/lte/dev_unit_testing#format-agw (AGW)

  • https://magma.github.io/magma/docs/next/feg/dev_testing#run-tests-on-the-host (FeG)

  • https://magma.github.io/magma/docs/next/feg/docker#development (FeG)

  • https://magma.github.io/magma/docs/next/orc8r/dev_testing#pre-build-lint (Orc8r)

  • https://magma.github.io/magma/docs/next/nms/dev_testing#pre-commit-tests (NMS)

• Vagrant VMs (dev,...)

  • provisioning

    • Ansible

    • Show&Tell session: 2023-02-08 Magma VMs Show&Tell + Q&A

    • See external docs, e.g. https://developer.hashicorp.com/vagrant/docs/provisioning and https://developer.hashicorp.com/vagrant/docs/provisioning/ansible

  • publishing https://github.com/magma/magma/wiki/Creating,-Testing,-and-Publishing-Magma-VM-Base-Images

  • Using the newly published VM

    • https://github.com/magma/magma/issues/15008

• Docker build

  • orc8r https://github.com/magma/magma/wiki/Magma-Artifactory

  • agw https://github.com/magma/magma/wiki/Magma-Artifactory

  • bazel base & devcontainer https://magma.github.io/magma/docs/next/bazel/agw_with_bazel#environments

Releasing

• https://github.com/magma/magma/wiki/Releases

• Releasing process / release stabilization

  • release branch creation

  • testing

    • regression testing

    • update and installation testing

• Creation of Artifactory repositories

• Tagging

• Publishing/Promoting

  • Debian/Ubuntu

  • Docker

  • Helm

• Documentation

  • https://github.com/magma/magma/wiki/Contributing-Documentation#versioning-process

Security

• https://github.com/magma/magma/security/policy

• https://magma.github.io/magma/docs/next/contributing/contribute_codeowners#guidelines-on-force-merging-a-pr

• https://github.com/magma/magma/wiki/Security-Overview-for-Contributors

• https://github.com/magma/magma/wiki/Secure-Use-of-GitHub-Actions

• https://github.com/magma/magma/wiki/Technical-Infrastructure#dependabot

• https://github.com/magma/magma/wiki/Magma-CI#pre-merge-workflows (bullet point about GitHub secrets)

• https://github.com/magma/magma/wiki/Magma-Artifactory#read-access (point about keys being needed to download Debian artifacts)

Security-related information to do with the code

• https://magma.github.io/magma/docs/next/orc8r/architecture_security (Orc8r)

• https://magma.github.io/magma/docs/next/feg/architecture_overview#overview (FeG)

• https://magma.github.io/magma/docs/next/lte/ebpf_datapath#bpf (eBPF)

• https://magma.github.io/magma/docs/next/lte/extended_5g_sa_features#suci-extensions (SUCI extensions)

• https://magma.github.io/magma/docs/next/lte/configure_agw_ha#deploy-agw-ami (configuring the security group for AGW AMIs)

• https://magma.github.io/magma/docs/next/nms/architecture_overview#sessionmiddleware (NMS - secure cookie in SessionMiddleware)

• https://magma.github.io/magma/docs/next/orc8r/deploy_install#create-an-orchestrator-admin-user (deleting certificates for security)

• https://magma.github.io/magma/docs/next/orc8r/deploy_using_juju#deploy-charmed-magma-orchestrator (security warning in Juju deployments)

• https://magma.github.io/magma/docs/next/orc8r/dev_aws_stack#what-does-terraform-deploy-in-my-aws-account (Terraform deployment)

• https://magma.github.io/magma/docs/orc8r/dev_token_security#motivation (REST API auth)

• https://magma.github.io/magma/docs/next/orc8r/dev_security (Orc8r security debugging)

Sentry

• https://magma.github.io/magma/docs/lte/configure_sentry#sentry--magma-agw

• https://github.com/magma/magma/wiki/Error-monitoring-and-triaging-workflow

• https://github.com/magma/magma/wiki/Tools

• https://github.com/magma/magma/wiki/Technical-Infrastructure#sentry

Bazel

• https://magma.github.io/magma/docs/next/bazel/agw_with_bazel

• https://magma.github.io/magma/docs/next/lte/dev_notes#combining-xml-unit-test-reports

• https://magma.github.io/magma/docs/next/lte/dev_unit_testing

• https://magma.github.io/magma/docs/next/lte/s1ap_tests

• https://github.com/magma/magma/wiki/Bazel-vs.-Make-commands-dictionary

• https://github.com/magma/magma/wiki/Bazel-remote-caching

• https://github.com/magma/magma/wiki/Bazel-cache-analysis

• https://github.com/magma/magma/wiki/Bazel-remote-caching-disaster-recovery-plan

• https://github.com/magma/magma/wiki/Contributing-Code-with-VSCode#building-and-testing-with-bazel

• https://github.com/magma/magma/wiki/Contributing-Code-Conventions#bazel-experimental

Miscellaneous

• The repos and scripts in Shubhams GitHub account https://github.com/ShubhamTatvamasi/

Meta

• Can a hierarchy structure be added to the wiki pages? E.g. combining contributing code sections, bazel sections etc.