Skip to content

GitLab

Commit 51bf03b8 authored by Raphael Defosseux's avatar Raphael Defosseux
Browse files

doc(release): added separate page for pulling images. 


Signed-off-by: Raphael Defosseux's avatarRaphael Defosseux <raphael.defosseux@eurecom.fr>
parent e19bb524
Hide whitespace changes
Inline Side-by-side
Showing with 145 additions and 56 deletions
docker-compose/docker-compose-no-nrf.yaml
View file @ 51bf03b8
......@@ -22,7 +22,7 @@ services:
ipv4_address: 192.168.70.131
oai-amf:
container_name: "oai-amf"
image: rdefosseoai/oai-amf:latest
image: oai-amf:latest
environment:
- TZ=Europe/paris
- INSTANCE=0
......@@ -87,7 +87,7 @@ services:
ipv4_address: 192.168.70.132
oai-smf:
container_name: "oai-smf"
image: rdefosseoai/oai-smf:latest
image: oai-smf:latest
environment:
- TZ=Europe/Paris
- INSTANCE=0
......@@ -130,7 +130,7 @@ services:
ipv4_address: 192.168.70.133
oai-spgwu:
container_name: "oai-spgwu"
image: rdefosseoai/oai-spgwu-tiny:latest
image: oai-spgwu-tiny:latest
environment:
- TZ=Europe/Paris
- PID_DIRECTORY=/var/run
......@@ -200,4 +200,4 @@ networks:
# config:
# - subnet: 192.168.70.128/26
# driver_opts:
# com.docker.network.bridge.name: "demo-oai"
\ No newline at end of file
# com.docker.network.bridge.name: "demo-oai"
docker-compose/docker-compose.yaml
View file @ 51bf03b8
......@@ -2,7 +2,7 @@ version: '3.8'
services:
oai-nrf:
container_name: "oai-nrf"
image: rdefosseoai/oai-nrf:latest
image: oai-nrf:latest
environment:
- NRF_INTERFACE_NAME_FOR_SBI=eth0
- NRF_INTERFACE_PORT_FOR_SBI=80
......@@ -42,7 +42,7 @@ services:
ipv4_address: 192.168.70.131
oai-amf:
container_name: "oai-amf"
image: rdefosseoai/oai-amf:latest
image: oai-amf:latest
environment:
- TZ=Europe/paris
- INSTANCE=0
......@@ -107,7 +107,7 @@ services:
ipv4_address: 192.168.70.132
oai-smf:
container_name: "oai-smf"
image: rdefosseoai/oai-smf:latest
image: oai-smf:latest
environment:
- TZ=Europe/Paris
- INSTANCE=0
......@@ -150,7 +150,7 @@ services:
ipv4_address: 192.168.70.133
oai-spgwu:
container_name: "oai-spgwu"
image: rdefosseoai/oai-spgwu-tiny:latest
image: oai-spgwu-tiny:latest
environment:
- TZ=Europe/Paris
- PID_DIRECTORY=/var/run
......
docs/CONFIGURE_CONTAINERS.md
View file @ 51bf03b8
......@@ -142,7 +142,7 @@ components. To capture initial message exchange between smf<-->nrf<-->upf.
```bash
(docker-compose-host)$ sudo sysctl net.ipv4.conf.all.forwarding=1
sudo iptables -P FORWARD ACCEPT
(docker-compose-host)$ sudo iptables -P FORWARD ACCEPT
```
You are ready to check out the tutorial that [how 5g core works](./DEPLOY_SA5G_WITH_DS_TESTER.md).
docs/DEPLOY_HOME.md
View file @ 51bf03b8
......@@ -14,10 +14,14 @@
Welcome to the tutorial home page of OAI 5g Core project. Here you can find lot of tutorials and help manuals. We regularly update these documents depending on the new feature set.
**2021/07/27 Update: you have now the choice to either pull images or build your-self.**
**Table of Contents**
1. [Pre-requisites](./DEPLOY_PRE_REQUESITES.md)
2. [Building the Container Images](./BUILD_IMAGES.md)
2. Getting the images
1. [Retrieving the Container Images](./RETRIEVE_OFFICIAL_IMAGES.md)
2. [Building the Container Images](./BUILD_IMAGES.md)
3. [Configuring the Containers](./CONFIGURE_CONTAINERS.md)
4. [Tutorial: 5G Core Network Deployment and Testing with dsTest](./DEPLOY_SA5G_WITH_DS_TESTER.md)
5. [Tutorial: 5G Core Network Deployment using Helm Charts](./DEPLOY_SA5G_HC.md)
......
docs/DEPLOY_PRE_REQUESITES.md
View file @ 51bf03b8
......@@ -52,11 +52,11 @@ Go to [docker-hub](https://hub.docker.com/) and create an account.
# 3. Pull base images #
* Ubuntu version: We need 2 base images: `ubuntu:bionic` and `mysql/mysql-server:5.7`
* Ubuntu version: We need 2 base images: `ubuntu:bionic` and `mysql/mysql:5.7`
Currently we are working to support `CentOS8` and `RHEL8` distributions.
First log with your Docker Hub credentials.
First log with your Docker Hub credentials. This is required if your organization has reached pulling limit as `anonymous`.
```bash
$ docker login
......@@ -65,24 +65,13 @@ Username:
Password:
```
All the network functions are using the same base image Ubuntu 18.04. If you want to build image of each network function then pull the base image, else you can pull the network function images from [rdefosseoai docker-hub](https://hub.docker.com/r/rdefosseoai)
On a Ubuntu18.04 host:
```bash
$ docker pull ubuntu:bionic
$ docker pull mysql/mysql-server:5.7
```
```bash
$ docker pull rdefosseoai/oai-amf
$ docker pull rdefosseoai/oai-nrf
$ docker pull rdefosseoai/oai-spgwu-tiny
$ docker pull rdefosseoai/oai-smf
$ docker pull mysql:5.7
```
Finally you may logoff --> your token is stored in plain text..
```bash
......@@ -147,4 +136,7 @@ $ docker network inspect bridge
....
```
You are ready to [build the network function images](./BUILD_IMAGES.md) in case you didn't pull them in previous steps.
\ No newline at end of file
Here you have 2 choices:
* You can pull official images from Docker Hub like [this](./RETRIEVE_OFFICIAL_IMAGES.md).
* Or you are ready to [build your-self the network function images](./BUILD_IMAGES.md).
docs/DEPLOY_SA5G_WITH_DS_TESTER.md
View file @ 51bf03b8
......@@ -55,30 +55,22 @@ The requried softwares and their respected versions are listed below. To replica
| tshark | 3.4.4 (Git commit c33f6306cbb2) |
| wireshark | 3.4.4 (Git commit c33f6306cbb2) |
The new version of `wireshark` may not be available in the ubuntu repository so it is better to build it from source.
The new version of `wireshark` may not be available in the ubuntu repository so it is better to build it from source.
Most of the times the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command (if you have already done it in any other section then don't repeat). This is the most important step towards end to end connectivity.
Most of the times the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command (if you have already done it in any other section then don't repeat).
```bash
(docker-compose-host)$ sudo sysctl net.ipv4.conf.all.forwarding=1
sudo iptables -P FORWARD ACCEPT
```
**This is the most important step towards end-to-end connectivity.**
```bash
(docker-compose-host)$ sudo sysctl net.ipv4.conf.all.forwarding=1
(docker-compose-host)$ sudo iptables -P FORWARD ACCEPT
```
To know how to configure the machine with the above requirements vist [pre-requisites](./DEPLOY_PRE_REQUESITES.md) page.
## 2. Network Function Container Images ##
- This step can be skip and the images can be pulled from docker-hub, in case there is a problem in pulling the images due to docker limit then readers can build images.
- **NOTE**: Currently the [docker-compose-file](../docker-compose/docker-compose.yaml) is configured for pulling images from docker-hub. In you case you build images please change the image-tag accordingly
```bash
(docker-compose-host)$ docker pull rdefosseoai/oai-amf
(docker-compose-host)$ docker pull rdefosseoai/oai-nrf
(docker-compose-host)$ docker pull rdefosseoai/oai-spgwu-tiny
(docker-compose-host)$ docker pull rdefosseoai/oai-smf
```
- In this demo the network function branch and tags which were used are listed below, follow the [Building images](./BUILD_IMAGES.md) to build images with below tags.
- In this demo the network function branch and tags which were used are listed below, follow the [Retrieving images](./RETRIEVE_OFFICIAL_IMAGES.md) or the [Building images](./BUILD_IMAGES.md) to build images with below tags.
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
| ----------- | ----------- | -------- | ------------ | ----------------|
......@@ -87,15 +79,15 @@ To know how to configure the machine with the above requirements vist [pre-requi
| NRF | `master` | `v1.1.0` | X | X |
| SPGW-U-TINY | `master` | `v1.1.2` | X | X |
- In case readers are interested in making images using different branch then **they have to build images from scratch they can't use the docker-hub images**.
- In case readers are interested in making images using different branch then **they have to build images from scratch they can't use the docker-hub images**.
## 3. Configuring Host Machines ##
All the network functions are connected using `demo-oai-net` bridge. There are two ways to create this bridge either manually or automatically using docker-compose. The manual version will allow packet capturing while network functions are getting deployed. So the initial tested setup packets can be captured for debugging purposes or checking if network functions registered properly to nrf. The second option of automatic deployment is good when initial packet capture is not important.
All the network functions are connected using `demo-oai-net` bridge. There are two ways to create this bridge either manually or automatically using docker-compose. The manual version will allow packet capturing while network functions are getting deployed. So the initial tested setup packets can be captured for debugging purposes or checking if network functions registered properly to nrf. The second option of automatic deployment is good when initial packet capture is not important.
### 3.1 Creating bridge manually
- Make sure that the below line is commented in [docker-compose file](../docker-compose/docker-compose.yaml) and uncomment the line above this,
- Make sure that the below line is commented in [docker-compose file](../docker-compose/docker-compose.yaml) and uncomment the line above this,
```
networks:
......@@ -109,7 +101,7 @@ All the network functions are connected using `demo-oai-net` bridge. There are t
com.docker.network.bridge.name: "demo-oai"
```
- The `docker-compose-host` machine needs to be configured with `demo-oai-net` bridge before deploying core network components. To capture initial message exchange between smf<-->nrf<-->upf.
- The `docker-compose-host` machine needs to be configured with `demo-oai-net` bridge before deploying core network components. To capture initial message exchange between smf<-->nrf<-->upf.
```bash
(docker-compose-host)$ docker network create \
......@@ -121,7 +113,6 @@ All the network functions are connected using `demo-oai-net` bridge. There are t
(docker-compose-host)$ ifconfig demo-oai
demo-oai: flags=4099<UP,BROADCAST,MULTICAST> mtu 1500
inet 192.168.70.129 netmask 255.255.255.192 broadcast 192.168.70.191
ether 02:42:9c:0a:23:44 txqueuelen 0 (Ethernet)
RX packets 0 bytes 0 (0.0 B)
RX errors 0 dropped 0 overruns 0 frame 0
TX packets 0 bytes 0 (0.0 B)
......@@ -148,22 +139,22 @@ All the network functions are connected using `demo-oai-net` bridge. There are t
com.docker.network.bridge.name: "demo-oai"
```
- If the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command (important step),
- If the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command (**important step**),
```bash
(docker-compose-host)$ sudo sysctl net.ipv4.conf.all.forwarding=1
sudo iptables -P FORWARD ACCEPT
(docker-compose-host)$ sudo iptables -P FORWARD ACCEPT
```
- The `dsTest-host` needs to configured with a route to reach `docker-compose-host`. Assuming `dsTest-host` physical interface which is connected with `docker-compose-host` is NIC1 and the ip-address of this interface is IP_ADDR_NIC1 then,
```bash
(dsTest-host)$ sudo ip route add route \
192.168.70.128/26 via IP_ADDR_NIC1\
dev NIC1_NAME
(dsTest-host)$ sudo ip route add route 192.168.70.128/26 \
via IP_ADDR_NIC1\
dev NIC1_NAME
```
- To verify ping the ip-address of the `docker-compose-host` interface connected to demo-oai bridge, if possible also ping amf from the dsTest-host machine.
- To verify ping the ip-address of the `docker-compose-host` interface connected to demo-oai bridge, if possible also ping amf from the dsTest-host machine.
```bash
(dsTest-host)$ ping 192.168.70.129
......@@ -247,7 +238,7 @@ All the network functions are connected using `demo-oai-net` bridge. There are t
```bash
(docker-compose-host)$ pwd
/home/<docker-compose-host>/oai/oai-cn-fed/docker-compose
(docker-compose-host)$ ./core-network
(docker-compose-host)$ ./core-network.sh
Only use the following options
......@@ -275,7 +266,7 @@ All the network functions are connected using `demo-oai-net` bridge. There are t
- Starting the core network components,
```bash
(docker-compose-host)$ ./core-network start nrf spgwu
(docker-compose-host)$ ./core-network.sh start nrf spgwu
Starting 5gcn components in the order nrf, mysql, amf, smf, spgwu...
Creating mysql ... done
Creating oai-nrf ... done
......@@ -427,4 +418,4 @@ Using wireshark open scenario-execution.pcap use the filter ngap || http || pfcp
docker-compose -f <file-name> -p <project-name> ps -a
#To stop the containers
docker-compose -f <file-name> -p <project-name> down
```
\ No newline at end of file
```
docs/DEPLOY_SA5G_WITH_VPP_UPF.md
View file @ 51bf03b8
......@@ -12,6 +12,8 @@
</tr>
</table>
**CAUTION: the vpp-upf repository is stil not public.**
![SA dsTest Demo](./images/5gcn_vpp_upf.jpg)
**Reading time: ~ 30mins**
......
docs/RETRIEVE_OFFICIAL_IMAGES.md 0 → 100644
View file @ 51bf03b8
<table style="border-collapse: collapse; border: none;">
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface 5G Core Network Deployment : Pulling Container Images</font></b>
</td>
</tr>
</table>
This page is only valid for an `Ubuntu18` host.
If you are using any other distributions, please refer to [Build your own images](./BUILD_IMAGES.md).
If you want to the up-to-date new features, please refer to [Build your own images](./BUILD_IMAGES.md).
# Pulling the images from Docker Hub #
Currently the images are hosted under the user account `rdefosseoai`.
This may change in the future.
Once again you may need to log on [docker-hub](https://hub.docker.com/) if your organization has reached pulling limit as `anonymous`.
```bash
$ docker login
Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one.
Username:
Password:
```
Now pull images.
```bash
$ docker pull rdefosseoai/oai-amf
$ docker pull rdefosseoai/oai-nrf
$ docker pull rdefosseoai/oai-spgwu-tiny
$ docker pull rdefosseoai/oai-smf
```
And **re-tag** them for tutorials' docker-compose file to work.
```bash
$ docker image tag rdefosseoai/oai-amf:latest oai-amf:latest
$ docker tag rdefosseoai/oai-nrf:latest oai-nrf:latest
$ docker tag rdefosseoai/oai-smf:latest oai-smf:latest
$ docker tag rdefosseoai/oai-spgwu-tiny:latest oai-spgwu-tiny:latest
```
Finally you may logoff --> your token is stored in plain text..
```bash
$ docker logout
```
We will push new versions when new features are validated.
# Synchronizing the tutorials #
**CAUTION: PLEASE READ THIS SECTION VERY CAREFULLY!**
This repository only has tutorials and Continuous Integration scripts.
**At the time of writing (2021/07/22), the release tag is `v1.1.0`.**
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
| ----------- | ----------- | -------- | ------------ | ----------------|
| FED REPO | N/A | `v1.1.0` | | |
| AMF | `master` | `v1.1.0` | X | X |
| SMF | `master` | `v1.1.0` | X | X |
| NRF | `master` | `v1.1.0` | X | X |
| SPGW-U-TINY | `master` | `v1.1.2` | X | X |
```bash
# Clone directly on the latest release tag
$ git clone --branch v1.1.0 https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
$ cd oai-cn5g-fed
# If you forgot to clone directly to the latest release tag
$ git checkout -f v1.1.0
# Synchronize all git submodules
$ ./scripts/syncComponents.sh
---------------------------------------------------------
OAI-NRF component branch : master
OAI-AMF component branch : master
OAI-SMF component branch : master
OAI-SPGW-U component branch : master
---------------------------------------------------------
git submodule deinit --all --force
git submodule init
git submodule update
```
Later versions of the `master` branch may not work with the pulled images.
You are ready to [Configure the Containers](./CONFIGURE_CONTAINERS.md).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment