Yet another automated deployment

index.html

@@ -216,5 +216,5 @@ <h2 id="whats-here">What's here?</h2>
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-11-24 07:54:17.627497+00:00
+Build Date UTC : 2024-11-24 08:28:51.586964+00:00
 -->

tutorials/epc-setup/index.html

@@ -183,9 +183,28 @@ <h1 id="step-1-install-open5gs-notes-and-pointers">Step 1: Install Open5GS (Note
 <p>Install Open5GS following the <a href="https://open5gs.org/open5gs/docs/guide/01-quickstart/">Open5GS Quickstart documentation</a> based on your operating system and desired implementation (e.g. "bare metal" directly on the operating system vs. <a href="https://github.com/wildeyedskies/docker-open5gs-basic-config">Docker</a>).
 There are even <a href="https://open5gs.org/open5gs/docs/tutorial/02-VoLTE-setup/">VoLTE</a> and <a href="https://open5gs.org/open5gs/docs/tutorial/03-VoLTE-dockerized/">Dockerized VoLTE</a> implementations of Open5GS.
 A similar step-by-step tutorial to this one can be found <a href="https://medium.com/networkers-fiit-stu/setting-up-open5gs-a-step-by-step-guide-or-how-we-set-up-our-lab-environment-5da1c8db0439">here</a>.</p>
-<p>In SCN we have run Open5GS successfully using Ubuntu 20.04 and 22.04, on bare metal or in Virtual Machines, installed via the <code>apt</code> package manager.
-To do this, first install MongoDB as described in the Quickstart guide. Then follow instructions under the "Ubuntu" section to install Open5GS via apt.</p>
+<p>In SCN we have run Open5GS successfully using Ubuntu 20.04 and 22.04, on bare metal or in Virtual Machines, installed via the <code>apt</code> package manager (see Step "2. Install Open5GS with a Package Manager" of the <a href="https://open5gs.org/open5gs/docs/guide/01-quickstart/">Quickstart</a>).
+First install MongoDB as described in the Quickstart. Then follow instructions under the "Ubuntu" section to install Open5GS via apt.</p>
 <p>Note: If installing over a <code>ssh</code> connection, we recommend using <code>tmux</code> or another program in case you get disconnected from the session in the process. </p>
+<h2 id="configure-mme-and-sgwu">Configure MME and SGWU</h2>
+<p>Note that for our LTE setup, the MME and SGWU are the only components whose config files you will really need to change from the defaults.</p>
+<h3 id="mme">MME</h3>
+<p>Edit the <code>/etc/open5gs/mme.yaml</code> file (as root or using <code>sudo</code>) as follows:
+- Under <code>mme:</code> -&gt; <code>s1ap:</code> -&gt; <code>server:</code> -&gt; <code>address:</code>, set the IP address you will assign to the network interface (likely an ethernet port) on your EPC computer which will be connecting to the eNB. In this tutorial (to match with the Network Configuration section that follows), we will use <code>192.168.150.1</code>.
+- Under both <code>mme:</code> -&gt; <code>gummei:</code> and <code>mme:</code> -&gt; <code>tai:</code>, you will need to change the <code>plmn_id</code> (<code>mcc</code> and <code>mnc</code> values) to match the PLMN you are using for your network.
+- Note that for the purposes of eNB config later, the Tracking Area Code (or TAC) listed under <code>tai:</code> -&gt; <code>tac:</code> will need to match the TAC number configured on the eNB (using the default of 1 is fine). </p>
+<p><strong>Quick explanation:</strong> "PLMN" refers to the <a href="https://en.wikipedia.org/wiki/Public_land_mobile_network">Public Land Mobile Network</a>, in which every network has to have a unique carrier ID defined by the 3-digit "mobile country code (MCC)" and a 2 or 3-digit "mobile network code (MNC)". Alternately, for iPhone compatibility in the US, SCN uses the CBRS "private LTE" PLMN assigned by Apple as described in <a href="https://support.apple.com/guide/deployment/support-for-private-5g-and-lte-networks-depac6747317/web">this doc</a>.</p>
+<ul>
+<li>Optional: Edit <code>network_name:</code> (full and short) and <code>mme_name:</code> as desired. One of these names will show up on smartphones' lock screens as the "carrier" when the phone is attached to the network.</li>
+</ul>
+<h3 id="sgwu">SGWU</h3>
+<p>Edit the <code>/etc/open5gs/sgwu.yaml</code> file (as root or using <code>sudo</code>) as follows:
+- Under <code>sgwu:</code> -&gt; <code>gtpu:</code> -&gt; <code>server:</code> -&gt; <code>address:</code>, set the IP address you will assign to the network interface on your EPC computer which will be connecting to the eNB (this should be the same as the IP address of the MME set above, if the MME and SGWU are running on the same machine). In this tutorial we will use <code>192.168.150.1</code>.</p>
+<p>As mentioned in the Quickstart, after changing the config files, you will need to restart the corresponding Open5GS daemons:</p>
+<pre><code class="language-bash">sudo systemctl restart open5gs-mmed
+sudo systemctl restart open5gs-sgwud
+</code></pre>
+<p>However, the MME will likely not start correctly until networking is configured, as described below.</p>
 <h1 id="step-2-configure-networking">Step 2: Configure Networking</h1>
 <p>Remember to follow all the network configuration steps in the <a href="https://open5gs.org/open5gs/docs/guide/01-quickstart/">Open5GS Quickstart documentation</a>. For SCN's Ubuntu machines, this means:</p>
 <ul>
@@ -309,9 +328,9 @@ <h1 id="step-3-start-and-monitor-open5gs-software-services">Step 3: Start and mo
 <p>The following command will start only the systemd services required for LTE. However, you do not need to stop or disable the other components of the 5G core for it to run 4G LTE network hardware correctly- the full Open5GS 5G core is backwards compatible with LTE hardware if you configure the LTE components correctly.</p>
 <pre><code class="language-bash">sudo systemctl start open5gs-hssd.service open5gs-mmed.service open5gs-sgwud.service open5gs-sgwcd.service open5gs-pcrfd.service open5gs-upfd.service open5gs-smfd.service
 </code></pre>
-<h3 id="start-the-webui">Start the WebUI</h3>
+<h3 id="install-and-start-the-webui">Install and Start the WebUI</h3>
 <p>The WebUI is another systemd service and runs by default on your local computer at port 9999. 
-It requires some more dependencies to install, such as <code>nodejs</code> (see Step 3. of the <a href="https://open5gs.org/open5gs/docs/guide/01-quickstart/">Quickstart</a> guide). You can reach it by navigating to <code>http://localhost:9999</code> in your web browser.</p>
+It requires some more dependencies to install, such as <code>nodejs</code> (see Step "3. Install the WebUI of Open5GS" in the <a href="https://open5gs.org/open5gs/docs/guide/01-quickstart/">Quickstart</a>). You can reach it by navigating to <code>http://localhost:9999</code> in your web browser.</p>
 <p>If not already started, start it with the following command:</p>
 <pre><code class="language-bash">sudo systemctl start open5gs-webui.service
 </code></pre>