diff --git a/ci-scripts/Jenkinsfile-GitLab-Docker-Check b/ci-scripts/Jenkinsfile-GitLab-Docker-Check
new file mode 100644
index 0000000000000000000000000000000000000000..9900ea9eda8b000a33d4ca2a9cc100a4d52fd79a
--- /dev/null
+++ b/ci-scripts/Jenkinsfile-GitLab-Docker-Check
@@ -0,0 +1,198 @@
+#!/bin/groovy
+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ * contact@openairinterface.org
+ */
+
+//-------------------------------------------------------------------------------
+// Abstraction function to send social media messages:
+// like on Slack or Mattermost
+def sendSocialMediaMessage(pipeChannel, pipeColor, pipeMessage) {
+ if (params.pipelineUsesSlack != null) {
+ if (params.pipelineUsesSlack) {
+ slackSend channel: pipeChannel, color: pipeColor, message: pipeMessage
+ }
+ }
+}
+
+// Location of the CN executor node
+def cn_ci_host = params.Host_CN_CI_Server
+
+// for lock
+def cn_ci_resource = params.DockerContainers
+
+// Location of the 2nd CN executor
+def new_host_flag = false
+def new_host = ""
+def new_host_user = ""
+
+//-------------------------------------------------------------------------------
+// Pipeline start
+pipeline {
+ agent {
+ label cn_ci_host
+ }
+ options {
+ disableConcurrentBuilds()
+ timestamps()
+ ansiColor('xterm')
+ lock(cn_ci_resource)
+ }
+ stages {
+ stage ('Verify Parameters') {
+ steps {
+ script {
+ echo '\u2705 \u001B[32mVerify Parameters\u001B[0m'
+
+ JOB_TIMESTAMP = sh returnStdout: true, script: 'date --utc --rfc-3339=seconds | sed -e "s#+00:00##"'
+ JOB_TIMESTAMP = JOB_TIMESTAMP.trim()
+
+ if (params.Host_CN_CI_2nd_Server_Flag != null) {
+ new_host_flag = params.Host_CN_CI_2nd_Server_Flag
+ if (new_host_flag) {
+ new_host = params.Host_CN_CI_2nd_Server
+ new_host_user = params.Host_CN_CI_2nd_Server_Login
+ echo "1st Node is ${NODE_NAME}"
+ echo "2nd Node is ${new_host}"
+ } else {
+ echo "Node is ${NODE_NAME}"
+ }
+ } else {
+ echo "Node is ${NODE_NAME}"
+ }
+
+ sh "git clean -x -d -f > /dev/null 2>&1"
+ sh "mkdir -p archives/cn5g"
+ sh "mkdir -p archives/cn5gwithnoNRF"
+ }
+ }
+ }
+ stage ('Deploy Whole 5G Core Network with NRF') {
+ steps {
+ script {
+ echo '\u2705 \u001B[32mDeploy CN5G using Docker-Compose with NRF\u001B[0m'
+ dir('docker-compose') {
+ sh 'docker-compose -f docker-compose.yaml up -d > ../archives/cn5g/compose_5gcn_up.log 2>&1'
+ sh 'sleep 100'
+ // Do a check on number of healthy containers
+ // 5 == mysql + nrf + amf + smf + upf(spgwu-tiny)
+ ret = sh returnStdout: true, script: 'docker-compose ps -a | grep -v unhealthy | grep -c healthy || true'
+ ret = ret.trim()
+ if (ret != '5') {
+ error "Deployment went wrong!"
+ }
+ }
+ }
+ }
+ post {
+ always {
+ script {
+ sh 'docker logs oai-nrf > archives/cn5g/oai_nrf.log'
+ sh 'docker logs oai-amf > archives/cn5g/oai_amf.log'
+ sh 'docker logs oai-smf > archives/cn5g/oai_smf.log'
+ sh 'docker logs oai-spgwu > archives/cn5g/oai_spgwu.log'
+ }
+ }
+ success {
+ script {
+ sh 'echo "DEPLOYMENT: OK"'
+ }
+ }
+ unsuccessful {
+ script {
+ sh 'echo "DEPLOYMENT: KO"'
+ }
+ }
+ }
+ }
+ stage ('Undeploy 5G-CN with NRF') {
+ steps {
+ script {
+ echo '\u2705 \u001B[32mUn-Deploy CN5G with NRF\u001B[0m'
+ dir('docker-compose') {
+ sh 'docker-compose down > ../archives/cn5g/compose_normal_down.log 2>&1'
+ }
+ }
+ }
+ }
+
+ stage ('Deploy Whole 5G Core Network with no NRF') {
+ steps {
+ script {
+ echo '\u2705 \u001B[32mDeploy CN5G using Docker-Compose with no NRF\u001B[0m'
+ dir('docker-compose') {
+ sh 'docker-compose -f docker-compose-no-nrf.yaml up -d > ../archives/cn5gwithnoNRF/compose_5gcn_up.log 2>&1'
+ sh 'sleep 100'
+ // Do a check on number of healthy containers
+ // 4 == mysql + amf + smf + upf(spgwu-tiny)
+ ret = sh returnStdout: true, script: 'docker-compose ps -a | grep -v unhealthy | grep -c healthy || true'
+ ret = ret.trim()
+ if (ret != '4') {
+ error "Deployment went wrong with no NRF!"
+ }
+ }
+ }
+ }
+ post {
+ always {
+ script {
+ sh 'docker logs oai-amf > archives/cn5gwithnoNRF/oai_amf.log'
+ sh 'docker logs oai-smf > archives/cn5gwithnoNRF/oai_smf.log'
+ sh 'docker logs oai-spgwu > archives/cn5gwithnoNRF/oai_spgwu.log'
+ }
+ }
+ success {
+ script {
+ sh 'echo "DEPLOYMENT: OK with no NRF"'
+ }
+ }
+ unsuccessful {
+ script {
+ sh 'echo "DEPLOYMENT: KO with no NRF"'
+ }
+ }
+ }
+ }
+ stage ('Undeploy 5G-CN with no NRF') {
+ steps {
+ script {
+ echo '\u2705 \u001B[32mUn-Deploy CN5G with no NRF\u001B[0m'
+ dir('docker-compose') {
+ sh 'docker-compose down > ../archives/cn5gwithnoNRF/compose_normal_down.log 2>&1'
+ }
+ }
+ }
+ }
+ }
+ post {
+ always {
+ script {
+ // Remove any leftover containers/networks
+ dir('docker-compose') {
+ sh 'docker-compose down'
+ }
+ // Zipping all archived log files
+ sh "zip -r -qq cn5g_deploy_docker_logs.zip archives"
+ if (fileExists('cn5g_deploy_docker_logs.zip')) {
+ archiveArtifacts artifacts: 'cn5g_deploy_docker_logs.zip'
+ }
+ }
+ }
+ }
+}
diff --git a/docker-compose/docker-compose-no-nrf.yaml b/docker-compose/docker-compose-no-nrf.yaml
index 785b6890b16072138106c9a017e211f691ed84da..88b2d98d2d1bfdacee69e45b262454cd68274924 100644
--- a/docker-compose/docker-compose-no-nrf.yaml
+++ b/docker-compose/docker-compose-no-nrf.yaml
@@ -23,6 +23,12 @@ services:
oai-amf:
container_name: "oai-amf"
image: oai-amf:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/amf.pcap 2>&1 > /dev/null &
+ /openair-amf/bin/oai_amf -c /openair-amf/etc/amf.conf -o | tee /tmp/amf.log 2>&1
+ "
+ cap_add:
+ - NET_ADMIN
environment:
- TZ=Europe/paris
- INSTANCE=0
@@ -88,6 +94,12 @@ services:
oai-smf:
container_name: "oai-smf"
image: oai-smf:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/smf.pcap 2>&1 > /dev/null &
+ /openair-smf/bin/oai_smf -c /openair-smf/etc/smf.conf -o | tee /tmp/smf.log 2>&1
+ "
+ cap_add:
+ - NET_ADMIN
environment:
- TZ=Europe/Paris
- INSTANCE=0
@@ -131,6 +143,10 @@ services:
oai-spgwu:
container_name: "oai-spgwu"
image: oai-spgwu-tiny:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/spgwu.pcap 2>&1 > /dev/null &
+ /openair-spgwu-tiny/bin/oai_spgwu -c /openair-spgwu-tiny/etc/spgw_u.conf -o | tee /tmp/spgwu.log 2>&1
+ "
environment:
- TZ=Europe/Paris
- PID_DIRECTORY=/var/run
@@ -194,12 +210,11 @@ networks:
public_net:
external:
name: demo-oai-public-net
-# Incase the user wants docker-compose to create a bridge rather than creating the bridge manually then uncomment the below lines
-# public_net:
-# driver: bridge
-# name: demo-oai-public-net
-# ipam:
-# config:
-# - subnet: 192.168.70.128/26
-# driver_opts:
-# com.docker.network.bridge.name: "demo-oai"
+ public_net:
+ driver: bridge
+ name: demo-oai-public-net
+ ipam:
+ config:
+ - subnet: 192.168.70.128/26
+ driver_opts:
+ com.docker.network.bridge.name: "demo-oai"
diff --git a/docker-compose/docker-compose.yaml b/docker-compose/docker-compose.yaml
index cfb88e460da44f4a15343c09a53e3ee88d4ff895..8d85bee475612bceec310965e7e28953f57e58d2 100644
--- a/docker-compose/docker-compose.yaml
+++ b/docker-compose/docker-compose.yaml
@@ -3,6 +3,12 @@ services:
oai-nrf:
container_name: "oai-nrf"
image: oai-nrf:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/nrf.pcap 2>&1 > /dev/null &
+ /openair-nrf/bin/oai_nrf -c /openair-nrf/etc/nrf.conf -o | tee /tmp/nrf.log 2>&1
+ "
+ cap_add:
+ - NET_ADMIN
environment:
- NRF_INTERFACE_NAME_FOR_SBI=eth0
- NRF_INTERFACE_PORT_FOR_SBI=80
@@ -43,6 +49,12 @@ services:
oai-amf:
container_name: "oai-amf"
image: oai-amf:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/amf.pcap 2>&1 > /dev/null &
+ /openair-amf/bin/oai_amf -c /openair-amf/etc/amf.conf -o | tee /tmp/amf.log 2>&1
+ "
+ cap_add:
+ - NET_ADMIN
environment:
- TZ=Europe/paris
- INSTANCE=0
@@ -108,6 +120,12 @@ services:
oai-smf:
container_name: "oai-smf"
image: oai-smf:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/smf.pcap 2>&1 > /dev/null &
+ /openair-smf/bin/oai_smf -c /openair-smf/etc/smf.conf -o | tee /tmp/smf.log 2>&1
+ "
+ cap_add:
+ - NET_ADMIN
environment:
- TZ=Europe/Paris
- INSTANCE=0
@@ -151,6 +169,10 @@ services:
oai-spgwu:
container_name: "oai-spgwu"
image: oai-spgwu-tiny:develop
+ command: >
+ bash -c "nohup tshark -i eth0 -w /tmp/spgwu.pcap 2>&1 > /dev/null &
+ /openair-spgwu-tiny/bin/oai_spgwu -c /openair-spgwu-tiny/etc/spgw_u.conf -o | tee /tmp/spgwu.log 2>&1
+ "
environment:
- TZ=Europe/Paris
- PID_DIRECTORY=/var/run
@@ -214,12 +236,11 @@ networks:
public_net:
external:
name: demo-oai-public-net
-# Incase the user wants docker-compose to create a bridge rather than creating the bridge manually then uncomment the below lines
-# public_net:
-# driver: bridge
-# name: demo-oai-public-net
-# ipam:
-# config:
-# - subnet: 192.168.70.128/26
-# driver_opts:
-# com.docker.network.bridge.name: "demo-oai"
+ public_net:
+ driver: bridge
+ name: demo-oai-public-net
+ ipam:
+ config:
+ - subnet: 192.168.70.128/26
+ driver_opts:
+ com.docker.network.bridge.name: "demo-oai"
diff --git a/docs/CONFIGURE_CONTAINERS.md b/docs/CONFIGURE_CONTAINERS.md
index acbccaa7fcaeb2933a074d0af00950c1eaa1cddc..e9ea54bbbb5e4a249ba0ca91c3826018984d3f57 100644
--- a/docs/CONFIGURE_CONTAINERS.md
+++ b/docs/CONFIGURE_CONTAINERS.md
@@ -99,43 +99,6 @@
# 3. Networking #
-- The [docker-compose.yaml](../docker-compose/docker-compose.yaml) can create the network automatically, currently in the file automatic network creation is disabled. It can be enabled by uncommenting the lines.
-
- ```bash
- networks:
- public_net:
- driver: bridge
- name: demo-oai-public-net
- ipam:
- config:
- - subnet: 192.168.70.128/26
- driver_opts:
- com.docker.network.bridge.name: "demo-oai"
- ```
-
-- In user wants to create manual network then below is the command
-
-components. To capture initial message exchange between smf<-->nrf<-->upf.
-
- ```bash
- (docker-compose-host)$ docker network create \
- --driver=bridge \
- --subnet=192.168.70.128/26 \
- -o "com.docker.network.bridge.name"="demo-oai" \
- demo-oai-public-net
- 455631b3749ccd6f10a366cd1c49d5a66cf976d176884252d5d88a1e54049bc5
- (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)
- TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0
- (docker-compose-host)$ docker network ls
- NETWORK ID NAME DRIVER SCOPE
- d2d34e05bb2d bridge bridge local
- 455631b3749c demo-oai-public-net bridge local
- ```
+- The [docker-compose.yaml](../docker-compose/docker-compose.yaml) will create the network automatically.
You are ready to check out the tutorial that [how 5g core works](./DEPLOY_SA5G_WITH_DS_TESTER.md).
diff --git a/docs/DEPLOY_SA5G_WITH_DS_TESTER.md b/docs/DEPLOY_SA5G_WITH_DS_TESTER.md
index f688c93fd0f88db31e9cb5b51ff7fb7c867ad6e8..dbd7d31c51aa48ce9553488ce33476b07dd8d192 100644
--- a/docs/DEPLOY_SA5G_WITH_DS_TESTER.md
+++ b/docs/DEPLOY_SA5G_WITH_DS_TESTER.md
@@ -62,42 +62,11 @@ To know how to configure the machine with the above requirements vist [pre-requi
## 3. Configuring Host Machines ##
-- The `docker-compose-host` machine needs to be configured with `demo-oai-public-net` bridge before deploying core network components. To capture initial message exchange between smf<-->nrf<-->upf.
+- The `docker-compose-host` machine will be configured with `demo-oai-public-net` bridge automatically using [docker-compose.yaml](../docker-compose/docker-compose.yaml) at the time of deploying core network components. And also for each component it will start capturing `pcap` messages and stores it on the `/tmp/` location of that container. Use the below command as shown as an example.
```bash
- (docker-compose-host)$ docker network create \
- --driver=bridge \
- --subnet=192.168.70.128/26 \
- -o "com.docker.network.bridge.name"="demo-oai" \
- demo-oai-public-net
- 455631b3749ccd6f10a366cd1c49d5a66cf976d176884252d5d88a1e54049bc5
- (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)
- TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0
- (docker-compose-host)$ docker network ls
- NETWORK ID NAME DRIVER SCOPE
- d2d34e05bb2d bridge bridge local
- 455631b3749c demo-oai-public-net bridge local
+ (docker-compose-host)$ docker cp container_name:/tmp/amf.pcap amf.pcap
```
-- Optional, Though the bridge can be automatically created using docker-compose file if there is no need to capture initial packets. Uncomment the last lines of the [docker-compose.yaml](../docker-compose/docker-compose.yaml) or docker-compose-no-nrf.yaml. Else replace with below section
-
- ```
- networks:
- public_net:
- driver: bridge
- name: demo-oai-public-net
- ipam:
- config:
- - subnet: 192.168.70.128/26
- driver_opts:
- com.docker.network.bridge.name: "demo-oai"
- ```
-
- Optional, if the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command,