blob: 30c8485a8f427d5b971bc028c9ec52c181c6812c [file] [log] [blame]
Charles Chanfcfe8902022-02-02 17:06:27 -08001.. SPDX-FileCopyrightText: 2021 Open Networking Foundation <info@opennetworking.org>
2.. SPDX-License-Identifier: Apache-2.0
3
Charles Chancaebcf32021-09-20 22:17:52 -07004Development Guide
5=================
Charles Chaneeb2dc52021-10-07 12:29:41 -07006
7Background Knowledge
8--------------------
9
10NG-SDN Tutorial
11^^^^^^^^^^^^^^^
12We highly recommend people to go through the **NG-SDN Tutorial** as preparation for the SD-Fabric development work.
13You will learn all the required background knowledge and get opportunities
14to run hands-on experiments as part of the tutorial.
15The tutorial is free and publicly available at: https://github.com/opennetworkinglab/ngsdn-tutorial
16
17Reading Materials
18^^^^^^^^^^^^^^^^^
19- `SD-Fabric Techinar 2021 <https://opennetworking.org/events/sd-fabric-techinar/>`_
20
21 Introduction to the SD-Fabric project.
22
23- `Software-Defined Networks: A Systems Approach <https://sdn.systemsapproach.org>`_
24
25 Book about SDN in the context of P4, Stratum ONOS, whitebox switches, etc.
26 Even if you are already familiar with most of the concepts,
27 it should give you full-stack view of how we use programmable data planes at ONF.
28
29- `5G Mobile Networks: A Systems Approach <https://5g.systemsapproach.org>`_
30
31 Same as the SDN book but related to 5G architecture, a very good starting point to
32 get aligned with other ONF engineers around architecture and terminology for mobile networks.
33 Optional if your work will not be strictly related to Aether.
34
35- `Aether overview <https://youtu.be/ZzwFQCSmOJg>`_
36
37 There are many videos available on YouTube, this one should be the most recent.
38 Optional if your work will not be strictly related to Aether.
39
40- UP4 architecture
41
42 UP4 is the codename for our P4-based UPF project. Optional if your work will not be strictly related to Aether.
43
44 - `Blog post (Sep 2021) <https://opennetworking.org/news-and-events/blog/using-p4-and-programmable-switches-to-implement-a-4g-5g-upf-in-aether/>`_
45 - `Paper (Sep 2021) <https://www.cs.princeton.edu/~macdavid/media/up4-sosr21.pdf>`_
46 - `Slide deck <https://docs.google.com/presentation/d/1IlxsGKXPtqfFFAqORZV-N5OuCvoLloXQuKjvaL5Xf7M>`_
47
48- `Trellis architecture <https://docs.trellisfabric.org/1.12/architecture.html>`_
49
50 This document is based on an outdated, OF-DPA based data plane. But the control plane design logic remains the same.
51
52.. note::
53 We are working on development guides for ``fabric-tna`` pipeline and SD-Fabric control applications (``SegmentRouting``, ``UPF``, ``INT``).
54 More contents will be available shortly.