DOC: clarification on how to retrieve code

Signed-off-by: Raphael Defosseux <[email protected]>
OPENAIRINTERFACE · Jun 10, 2021 · 17d3dc6 · 17d3dc6
1 parent 43a1d80
commit 17d3dc6
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 8 deletions.
diff --git a/docs/BUILD_IMAGES.md b/docs/BUILD_IMAGES.md
@@ -14,11 +14,7 @@
 
 # 1.  Retrieve the proper code version #
 
-At the time of writing (2020 / 10 / 27), if you want to use the OpenAir-CN for a Dual Connectivity use case, you need to use proper branches:
-
-**UPDATE: 2021/02/08 --> this tutorial is still valid for the following tags**
-
-**For later tags, please refer to the MAGMA-based tutorial.**
+**CAUTION: 2021/02/08 --> the following tags were used.**
 
 **cNF Name** | **Branch Name** | **Tags**   | **Commit at time of writing**              | Ubuntu18 | CentOS7 | CentOS8
 ------------ | --------------- | ---------- | ------------------------------------------ | -------- | ------- | -------
@@ -32,7 +28,19 @@ SPGW-U-TINY  | `develop`       | `2021.w10` | `acd293e616f879f4dacead152c59384d1
 ```bash
 $ git clone https://github.com/OPENAIRINTERFACE/openair-epc-fed.git
 $ cd openair-epc-fed
-$ git checkout 2021.w18
+
+# You can specify a tag on the parent GIT repository such as `2021.w22`
+$ git checkout 2021.w22
+# Or you can sync to the latest version
+$ git checkout master
+
+# Then you need to resync the sub-modules (ie HSS, SPGW-CUPS, MME).
+# You can specify:
+#   ---  a valid tag (such as seen)
+#   ---  a newer tag
+#   ---  a branch to get the latest (`develop` being the latest stable)
+#        Usually the better option is to specify `develop`
+
 $ ./scripts/syncComponentsLegacy.sh --hss-branch 2021.w10 --mme-branch 2020.w47 \
                               --spgwc-branch 2021.w10 --spgwu-tiny-branch 2021.w10
 ---------------------------------------------------------
@@ -41,9 +49,20 @@ OAI-MME    component branch : 2020.w47
 OAI-SPGW-C component branch : 2021.w10
 OAI-SPGW-U component branch : 2021.w10
 ---------------------------------------------------------
+
+# Or to not specify anything
+$ ./scripts/syncComponentsLegacy.sh
+---------------------------------------------------------
+OAI-HSS    component branch : develop
+OAI-MME    component branch : develop
+OAI-SPGW-C component branch : develop
+OAI-SPGW-U component branch : develop
+---------------------------------------------------------
 ....
 ```
 
+In general, the `docker-compose` files (even in the tutorials) are up-to-date w/ `develop` latest commits in each sub-module.
+
 **CAUTION: At the time of writing (2020 / 10 / 26), only HSS and MME have a full CentOS-7 support.**
 
 It means that if you are on a CentOS 7 host, you will need to build a CentOS8 image of SPGW-C / SPGW-U-TINY.

diff --git a/docs/BUILD_IMAGES_MAGMA_MME.md b/docs/BUILD_IMAGES_MAGMA_MME.md
@@ -37,16 +37,39 @@ SPGW-U-TINY  | `develop`       | `2021.w10` | `acd293e616f879f4dacead152c59384d1
 ```bash
 $ git clone https://github.com/OPENAIRINTERFACE/openair-epc-fed.git
 $ cd openair-epc-fed
-$ git checkout 2021.w18
+
+# You can specify a tag on the parent GIT repository such as `2021.w22`
+$ git checkout 2021.w22
+# Or you can sync to the latest version
+$ git checkout master
+
+# Then you need to resync the sub-modules (ie HSS, SPGW-CUPS).
+# You can specify:
+#   ---  a valid tag (such as seen)
+#   ---  a newer tag
+#   ---  a branch to get the latest (`develop` being the latest stable)
+#        Usually the better option is to specify `develop`
+
 $ ./scripts/syncComponents.sh --hss-branch 2021.w10 --spgwc-branch 2021.w10 --spgwu-tiny-branch 2021.w10
 ---------------------------------------------------------
 OAI-HSS    component branch : 2021.w10
 OAI-SPGW-C component branch : 2021.w10
 OAI-SPGW-U component branch : 2021.w10
 ---------------------------------------------------------
 ....
+
+# Or to not specify anything
+$ ./scripts/syncComponentsLegacy.sh
+---------------------------------------------------------
+OAI-HSS    component branch : develop
+OAI-SPGW-C component branch : develop
+OAI-SPGW-U component branch : develop
+---------------------------------------------------------
+....
 ```
 
+In general, the `docker-compose` files (even in the tutorials) are up-to-date w/ `develop` latest commits in each sub-module.
+
 # 2. Generic Parameters #
 
 Here in our network configuration, we need to pass the "GIT PROXY" configuration.

diff --git a/docs/DEPLOY_PRE_REQUESITES.md b/docs/DEPLOY_PRE_REQUESITES.md
@@ -12,7 +12,7 @@
   </tr>
 </table>
 
-# 1. Install the proper version of Docker #
+# 1. Install the proper version of `docker` #
 
 At time of writing (2020 / 04 / 16):
 
@@ -47,6 +47,16 @@ $ sudo systemctl start docker
 $ docker info
 ```
 
+Please refer to the official [docker engine installation guide page](https://docs.docker.com/engine/install/).
+
+You will get more details than here.
+
+## 1.1. Install a recent version of `docker-compose` ##
+
+Official [installation guide](https://docs.docker.com/compose/install/).
+
+We recommend a version newer than `1.27`.
+
 # 2. Create an account on Docker Hub #
 
 Go to [https://hub.docker.com/](https://hub.docker.com/) website and create an account.

diff --git a/docs/DEPLOY_PRE_REQUESITES_MAGMA.md b/docs/DEPLOY_PRE_REQUESITES_MAGMA.md
@@ -33,6 +33,16 @@ $ sudo usermod -a -G docker myusername
 
 **CAUTION: At time of writing (2021 / 02 / 01), we only support Ubuntu18.04 deployment.**
 
+Please refer to the official [docker engine installation guide page](https://docs.docker.com/engine/install/).
+
+You will get more details than here.
+
+## 1.1. Install a recent version of `docker-compose` ##
+
+Official [installation guide](https://docs.docker.com/compose/install/).
+
+We recommend a version newer than `1.27`.
+
 # 2. Create an account on Docker Hub #
 
 Go to [https://hub.docker.com/](https://hub.docker.com/) website and create an account.