paulmataruso/5g-images
1
0
Fork 0
mirror of https://github.com/Gradiant/5g-images.git synced 2025-11-01 20:43:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix and update docs

Browse Source
This commit is contained in:
Carlos Giraldo
2021-08-05 17:15:02 +02:00
parent 42d03acdd1
commit c3b51cb7e6
32 changed files with 893 additions and 941 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/open5gs-and-oai-usrp/README.md
View File

@@ -1,16 +1,16 @@
# open5gs and openairinterface enodeb
# open5gs and openairinterface
5G end to end communication demo with open5gs and openairinterface enodeb.
4G/5G end to end communication demo with open5gs and openairinterface.
# Deployment EPC and register subscribers
# Deployment Core Network and register subscribers
deploy the EPC core (open5gs) with:
deploy the 4G/5G core (open5gs) with:
```
docker-compose -f epc.yaml up -d
docker-compose -f core.yaml up -d
```
Register subscriber in epc with `/register_subscriber.sh`.
Register subscribers in core with `/register_subscriber.sh`.
# Download uhd_images
@@ -18,7 +18,7 @@ Register subscriber in epc with `/register_subscriber.sh`.
python3 ../../uhd_image_downloader.py -i ../../uhd_images
# Deployment RAN (enodeB)
# Deployment 4G RAN (enodeB)
Deploy with
@@ -26,8 +26,23 @@ Deploy with
docker-compose -f oai-enb.yaml up -d
```
# Test 4G RAN
To test 4G ue connectivity use a commercial smartphone, insert the SIM card previously registered in the core and connect to the "internet" apn.
Check the mme log. Sometimes there is an `ERROR: Invalid Action[0] (../src/mme/s1ap-handler.c:1464)` and the oai enodeb exits. Re-run enodeb `docker-compose -f oai-enb.yaml up -d` until success.
Then ue should be connected to 4G network:
<img src="ue_connected.jpg" alt="ue_connected.jpg" width="320"/>
# Clean Up
Undeploy with:
```
docker-compose -f oai-enb.yaml down
```
docker-compose -f core.yaml down -v
```

6
docs/open5gs-and-oai-usrp/config/enb/enb.env
View File

@@ -3,11 +3,11 @@ USE_FDD_MONO=true
DL_FREQUENCY_IN_MHZ=2685
ENB_NAME=Gradiant
ENB_S1C_IF_NAME=eth0
#ENB_S1C_IP_ADDRESS@
#ENB_S1C_IP_ADDRESS
ENB_S1U_IF_NAME=eth0
#ENB_S1U_IP_ADDRESS@
#ENB_S1U_IP_ADDRESS
ENB_X2_IF_NAME=eth0
#ENB_X2_IP_ADDRESS@
#ENB_X2_IP_ADDRESS
FLEXRAN_ENABLED=false
FLEXRAN_INTERFACE_NAME=eth0
FLEXRAN_IPV4_ADDRESS=0.0.0.0

37
docs/open5gs-and-oai-usrp/config/open5gs/mme.yaml
View File

@@ -1,37 +0,0 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
mme:
freeDiameter: mme.conf
s1ap:
gtpc:
gummei:
plmn_id:
mcc: "901"
mnc: "70"
mme_gid: 2
mme_code: 1
tai:
plmn_id:
mcc: "901"
mnc: "70"
tac: "0001"
security:
integrity_order : [ EIA2, EIA1, EIA0 ]
ciphering_order : [ EEA0, EEA1, EEA2 ]
network_name:
full: Open5GS
mme_name: open5gs-mme0
sgwc:
gtpc:
- name: sgwc
smf:
gtpc:
- name: smf
parameter:
max:
pool:
sctp:

111
docs/open5gs-and-oai-usrp/core.yaml Normal file
View File

@@ -0,0 +1,111 @@
version: '3'
services:
mongo:
image: mongo
environment:
MONGO_INITDB_DATABASE: open5gs
amf:
image: openverso/open5gs:2.3.2
command:
- open5gs-amfd
restart : on-failure
ausf:
image: openverso/open5gs:2.3.2
command:
- open5gs-ausfd
restart : on-failure
bsf:
image: openverso/open5gs:2.3.2
command:
- open5gs-bsfd
restart : on-failure
hss:
image: openverso/open5gs:2.3.2
command: open5gs-hssd
environment:
DB_URI: mongodb://mongo/open5gs
restart: on-failure
nrf:
image: openverso/open5gs:2.3.2
command: open5gs-nrfd
restart : on-failure
nssf:
image: openverso/open5gs:2.3.2
command: open5gs-nssfd
restart : on-failure
pcf:
image: openverso/open5gs:2.3.2
command:
- open5gs-pcfd
environment:
DB_URI: mongodb://mongo/open5gs
restart : on-failure
pcrf:
image: openverso/open5gs:2.3.2
command: ["open5gs-pcrfd"]
environment:
DB_URI: mongodb://mongo/open5gs
restart: on-failure
mme:
image: openverso/open5gs:2.3.2
command: open5gs-mmed
restart: on-failure
sgwc:
image: openverso/open5gs:2.3.2
command: open5gs-sgwcd
restart : on-failure
sgwu:
image: openverso/open5gs:2.3.2
command: open5gs-sgwud
restart : on-failure
smf:
image: openverso/open5gs:2.3.2
command: open5gs-smfd
restart : on-failure
udm:
image: openverso/open5gs:2.3.2
restart: on-failure
command:
- open5gs-udmd
udr:
image: openverso/open5gs:2.3.2
restart: on-failure
environment:
DB_URI: mongodb://mongo/open5gs
command:
- open5gs-udrd
upf:
image: openverso/open5gs:2.3.2
command:
- open5gs-upfd
cap_add:
- all
privileged: true
restart: on-failure
ports:
- 2152:2152
webui:
image: openverso/open5gs-webui:2.3.2
restart: on-failure
environment:
DB_URI: mongodb://mongo/open5gs
ports:
- 3000:3000
# portainer:
# image: portainer/portainer-ce
# ports:
# - 9000:9000
# volumes:
# - /var/run/docker.sock:/var/run/docker.sock

59
docs/open5gs-and-oai-usrp/epc.yaml
View File

@@ -1,59 +0,0 @@
version: '3'
services:
mongo:
image: mongo
environment:
MONGO_INITDB_DATABASE: open5gs
webui:
image: openverso/open5gs-webui:2.2.3
restart: on-failure
environment:
DB_URI: mongodb://mongo/open5gs
ports:
- 3000:3000
nrf:
image: openverso/open5gs:2.2.3
command: open5gs-nrfd
restart : on-failure
smf:
image: openverso/open5gs:2.2.3
command: open5gs-smfd
restart : on-failure
mme:
image: openverso/open5gs:2.2.3
command: open5gs-mmed
restart: on-failure
ports:
- 36412:36412
volumes:
- ./open5gs-config/mme.yaml:/opt/open5gs/etc/open5gs/mme.yaml
sgwc:
image: openverso/open5gs:2.2.3
command: open5gs-sgwcd
restart : on-failure
sgwu:
image: openverso/open5gs:2.2.3
command: open5gs-sgwud
restart : on-failure
upf:
image: openverso/open5gs:2.2.3
command: ["open5gs-upfd"]
cap_add:
- all
privileged: true
restart: on-failure
ports:
- 2152:2152
pcrf:
image: openverso/open5gs:2.2.3
command: ["open5gs-pcrfd"]
environment:
DB_URI: mongodb://mongo/open5gs
restart: on-failure
hss:
image: openverso/open5gs:2.2.3
command: open5gs-hssd
environment:
DB_URI: mongodb://mongo/open5gs
restart: on-failure

4
docs/open5gs-and-oai-usrp/oai-enb.yaml
View File

@@ -1,11 +1,11 @@
version: '3'
services:
enodeb:
image: official-oai-enb:2021.w31
image: openverso/oai-enb:2021.w31
privileged: true
volumes:
- /dev/bus/usb:/dev/bus/usb
env_file:
- enb.env
- config/enb/enb.env
cap_add:
- all

BIN
docs/open5gs-and-oai-usrp/ue_connected.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 194 KiB

639
docs/open5gs-and-oai-usrp/uhd_image_downloader.py
View File

@@ -1,639 +0,0 @@
#!/usr/local/bin/python3
#
# Copyright 2018 Ettus Research, a National Instruments Company
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
"""
Download image files required for USRPs
"""
from __future__ import print_function
import argparse
import hashlib
import json
import math
import os
import re
import shutil
import sys
import tempfile
import zipfile
import platform
# For all the non-core-library imports, we will be extra paranoid and be very
# nice with error messages so that everyone understands what's up.
try:
from urllib.parse import urljoin # Python 3
except ImportError:
from urlparse import urljoin # Python 2
try:
from builtins import input
except ImportError:
input = raw_input
try:
from six import iteritems
except ImportError:
sys.stdout.write(
"[ERROR] Missing module 'six'! Please install it, e.g., by "
"running 'pip install six' or any other tool that can install "
"Python modules.\n")
if platform.system() == 'Windows':
input('Hit Enter to continue.')
exit(0)
try:
import requests
except ImportError:
sys.stdout.write(
"[ERROR] Missing module 'requests'! Please install it, e.g., by "
"running 'pip install requests' or any other tool that can install "
"Python modules.\n")
if platform.system() == 'Windows':
input('Hit Enter to continue.')
exit(0)
_DEFAULT_TARGET_REGEX = "(fpga|fw|windrv)_default"
_BASE_DIR_STRUCTURE_PARTS = ["share", "uhd", "images"]
_DEFAULT_INSTALL_PATH = os.path.join("/usr", *_BASE_DIR_STRUCTURE_PARTS)
_DEFAULT_BASE_URL = "http://files.ettus.com/binaries/cache/"
_INVENTORY_FILENAME = "inventory.json"
_CONTACT = "support@ettus.com"
_DEFAULT_BUFFER_SIZE = 8192
_DEFAULT_DOWNLOAD_LIMIT = 100 * 1024 * 1024 # Bytes
_ARCHIVE_DEFAULT_TYPE = "zip"
_UHD_VERSION = "3.15.0.0-2build5"
# Note: _MANIFEST_CONTENTS are placed at the bottom of this file for aesthetic reasons
_LOG_LEVELS = {"TRACE": 1,
"DEBUG": 2,
"INFO": 3,
"WARN": 4,
"ERROR": 5}
_LOG_LEVEL = _LOG_LEVELS["INFO"]
_YES = False
_PROXIES = {}
def log(level, message):
"""Logging function"""
message_log_level = _LOG_LEVELS.get(level, 0)
if message_log_level >= _LOG_LEVEL:
sys.stderr.write(
"[{level}] {message}\n".format(level=level, message=message))
def parse_args():
"""
Setup argument parser and parse. Also does some sanity checks and sets some
global variables we want to use.
"""
parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('-t', '--types', action='append',
help="RegEx to select image sets from the manifest file.")
parser.add_argument('-i', '--install-location',
default=None,
help="Set custom install location for images")
parser.add_argument('-m', '--manifest-location', type=str, default="",
help="Set custom location for the manifest file")
parser.add_argument('-I', '--inventory-location', type=str, default="",
help="Set custom location for the inventory file")
parser.add_argument('-l', '--list-targets', action="store_true", default=False,
help="Print targets in the manifest file to stdout, and exit.\n"
"To get relative paths only, specify an empty base URL (-b '').")
parser.add_argument('--url-only', action="store_true", default=False,
help="With -l, only print the URLs, nothing else.")
parser.add_argument("--buffer-size", type=int, default=_DEFAULT_BUFFER_SIZE,
help="Set download buffer size")
parser.add_argument("--download-limit", type=int, default=_DEFAULT_DOWNLOAD_LIMIT,
help="Set threshold for download limits. Any download "
"larger than this will require approval, either "
"interactively, or by providing --yes.")
parser.add_argument("--http-proxy", type=str,
help="Specify HTTP proxy in the format "
"http://user:pass@1.2.3.4:port\n"
"If this this option is not given, the environment "
"variable HTTP_PROXY can also be used to specify a proxy.")
parser.add_argument("-b", "--base-url", type=str, default=_DEFAULT_BASE_URL,
help="Set base URL for images download location")
parser.add_argument("-k", "--keep", action="store_true", default=False,
help="Keep the downloaded images archives in the image directory")
parser.add_argument("-T", "--test", action="store_true", default=False,
help="Verify the downloaded archives before extracting them")
parser.add_argument("-y", "--yes", action="store_true", default=False,
help="Answer all questions with 'yes' (for scripting purposes).")
parser.add_argument("-n", "--dry-run", action="store_true", default=False,
help="Print selected target without actually downloading them.")
parser.add_argument("--refetch", action="store_true", default=False,
help="Ignore the inventory file and download all images.")
parser.add_argument('-V', '--version', action='version', version=_UHD_VERSION)
parser.add_argument('-q', '--quiet', action='count', default=0,
help="Decrease verbosity level")
parser.add_argument('-v', '--verbose', action='count', default=0,
help="Increase verbosity level")
# Some sanitation that's easier to handle outside of the argparse framework:
args = parser.parse_args()
if not args.base_url.endswith('/') and args.base_url != "":
args.base_url += '/'
if args.yes:
global _YES
_YES = True
if args.http_proxy:
global _PROXIES
_PROXIES['http'] = args.http_proxy
# Set the verbosity
global _LOG_LEVEL
log("TRACE", "Default log level: {}".format(_LOG_LEVEL))
_LOG_LEVEL = _LOG_LEVEL - args.verbose + args.quiet
return args
def get_images_dir(args):
"""
Figure out where to store the images.
"""
if args.install_location:
return args.install_location
if os.environ.get("UHD_IMAGES_DIR"):
log("DEBUG",
"UHD_IMAGES_DIR environment variable is set, using to set "
"install location.")
return os.environ.get("UHD_IMAGES_DIR")
return _DEFAULT_INSTALL_PATH
def ask_permission(question, default_no=True):
"""
Ask the question, and have the user type y or n on the keyboard. If the
global variable _YES is true, this always returns True without asking the
question. Otherwise, return True if the answer is 'yes', 'y', or something
similar.
"""
if _YES:
log("DEBUG", "Assuming the answer is 'yes' for this question: " +
question)
return True
postfix = "[y/N]" if default_no else "[Y/n]"
answer = input(question + " " + postfix)
if answer and answer[0].lower() == 'y':
return True
return False
class TemporaryDirectory:
"""Class to create a temporary directory"""
def __enter__(self):
try:
self.name = tempfile.mkdtemp()
return self.name
except Exception as ex:
log("ERROR", "Failed to create a temporary directory (%s)" % ex)
raise ex
# Can return 'True' to suppress incoming exception
def __exit__(self, exc_type, exc_value, traceback):
try:
shutil.rmtree(self.name)
log("TRACE", "Temp directory deleted.")
except Exception as ex:
log("ERROR", "Could not delete temporary directory: %s (%s)" % (self.name, ex))
return exc_type is None
def get_manifest_raw(args):
"""
Return the raw content of the manifest (i.e. the text file). It
needs to be parsed to be of any practical use.
"""
# If we're given a path to a manifest file, use it
if os.path.exists(args.manifest_location):
manifest_fn = args.manifest_location
log("INFO", "Using manifest file at location: {}".format(manifest_fn))
with open(manifest_fn, 'r') as manifest_file:
manifest_raw = manifest_file.read()
# Otherwise, use the CMake Magic manifest
else:
manifest_raw = _MANIFEST_CONTENTS
log("TRACE", "Raw manifest contents: {}".format(manifest_raw))
return manifest_raw
def parse_manifest(manifest_contents):
"""Parse the manifest file, returns a dictionary of potential targets"""
manifest = {}
for line in manifest_contents.split('\n'):
line_unpacked = line.split()
try:
# Check that the line isn't empty or a comment
if not line_unpacked or line.strip().startswith('#'):
continue
target, repo_hash, url, sha256_hash = line_unpacked
manifest[target] = {"repo_hash": repo_hash,
"url": url,
"sha256_hash": sha256_hash,
}
except ValueError:
log("WARN", "Warning: Invalid line in manifest file:\n"
" {}".format(line))
continue
return manifest
def parse_inventory(inventory_fn):
"""Parse the inventory file, returns a dictionary of installed files"""
try:
if not os.path.exists(inventory_fn):
log("INFO", "No inventory file found at {}. Creating an empty one.".format(inventory_fn))
return {}
with open(inventory_fn, 'r') as inventory_file:
# TODO: verify the contents??
return json.load(inventory_file)
except Exception as ex:
log("WARN", "Error parsing the inventory file. Assuming an empty inventory: {}".format(ex))
return {}
def write_inventory(inventory, inventory_fn):
"""Writes the inventory to file"""
try:
with open(inventory_fn, 'w') as inventory_file:
json.dump(inventory, inventory_file)
return True
except Exception as ex:
log("ERROR", "Error writing the inventory file. Contents may be incomplete or corrupted.\n"
"Error message: {}".format(ex))
return False
def lookup_urls(regex_l, manifest, inventory, refetch=False):
"""Takes a list of RegExs to match within the manifest, returns a list of tuples with
(hash, URL) that match the targets and are not in the inventory"""
selected_targets = []
# Store whether or not we've found a target in the manifest that matches the requested type
found_one = False
for target in manifest.keys():
# Iterate through the possible targets in the manifest.
# If any of them match any of the RegExs supplied, add the URL to the
# return list
if all(map((lambda regex: re.findall(regex, target)), regex_l)):
found_one = True
log("TRACE", "Selected target: {}".format(target))
target_info = manifest.get(target)
target_url = target_info.get("url")
target_hash = target_info.get("repo_hash")
target_sha256 = target_info.get("sha256_hash")
filename = os.path.basename(target_url)
# Check if the same filename and hash appear in the inventory
if not refetch and inventory.get(target, {}).get("repo_hash", "") == target_hash:
# We already have this file, we don't need to download it again
log("INFO", "Target {} is up to date.".format(target))
else:
# We don't have that exact file, add it to the list
selected_targets.append({"target": target,
"repo_hash": target_hash,
"filename": filename,
"url": target_url,
"sha256_hash": target_sha256})
if not found_one:
log("INFO", "No targets matching '{}'".format(regex_l))
return selected_targets
def print_target_list(manifest, args):
"""
Print a list of targets.
"""
char_offset = max(len(x) for x in manifest.keys())
if not args.url_only:
# Print a couple helpful lines,
# then print each (Target, URL) pair in the manifest
log("INFO", "Potential targets in manifest file:\n"
"{} : {}".format(
"# TARGET".ljust(char_offset),
"URL" if args.base_url else "RELATIVE_URL"))
for key, value in sorted(manifest.items()):
print("{target} : {base}{relpath}".format(
target=key.ljust(char_offset),
base=args.base_url,
relpath=value["url"]))
else:
for manifest_item in iteritems(manifest):
print(args.base_url+manifest_item[1]["url"])
def download(
images_url,
filename,
buffer_size=_DEFAULT_BUFFER_SIZE,
print_progress=False,
download_limit=None
):
""" Run the download, show progress """
download_limit = download_limit or _DEFAULT_DOWNLOAD_LIMIT
log("TRACE", "Downloading {} to {}".format(images_url, filename))
try:
resp = requests.get(images_url, stream=True, proxies=_PROXIES,
headers={'User-Agent': 'UHD Images Downloader'})
except TypeError:
# requests library versions pre-4c3b9df6091b65d8c72763222bd5fdefb7231149
# (Dec.'12) workaround
resp = requests.get(images_url, prefetch=False, proxies=_PROXIES,
headers={'User-Agent': 'UHD Images Downloader'})
if resp.status_code != 200:
raise RuntimeError("URL does not exist: {}".format(images_url))
filesize = float(resp.headers['content-length'])
if filesize > download_limit:
if not ask_permission(
"The file size for this target ({:.1f} MiB) exceeds the "
"download limit ({:.1f} MiB). Continue downloading?".format(
filesize/1024**2, download_limit/1024**2)):
return 0, 0, ""
filesize_dl = 0
base_filename = os.path.basename(filename)
if print_progress and not sys.stdout.isatty():
print_progress = False
log("INFO", "Downloading {}, total size: {} kB".format(
base_filename, filesize/1000))
with open(filename, "wb") as temp_file:
sha256_sum = hashlib.sha256()
for buff in resp.iter_content(chunk_size=buffer_size):
if buff:
temp_file.write(buff)
filesize_dl += len(buff)
sha256_sum.update(buff)
if print_progress:
status = r"%05d kB / %05d kB (%03d%%) %s" % (
int(math.ceil(filesize_dl / 1000.)), int(math.ceil(filesize / 1000.)),
int(math.ceil(filesize_dl * 100.) / filesize),
base_filename)
if os.name == "nt":
status += chr(8) * (len(status) + 1)
else:
sys.stdout.write("\x1b[2K\r") # Clear previous line
sys.stdout.write(status)
sys.stdout.flush()
if print_progress:
print('')
return filesize, filesize_dl, sha256_sum.hexdigest()
def delete_from_inv(target_info, inventory, images_dir):
"""
Uses the inventory to delete the contents of the archive file specified by in `target_info`
"""
target = inventory.get(target_info.get("target"), {})
target_name = target.get("target")
log("TRACE", "Removing contents of {} from inventory ({})".format(
target, target.get("contents", [])))
dirs_to_delete = []
# Delete all of the files
for image_fn in target.get("contents", []):
image_path = os.path.join(images_dir, image_fn)
if os.path.isfile(image_path):
os.remove(image_path)
log("TRACE", "Deleted {} from inventory".format(image_path))
elif os.path.isdir(image_path):
dirs_to_delete.append(image_fn)
else: # File doesn't exist
log("WARN", "File {} in inventory does not exist".format(image_path))
# Then delete all of the (empty) directories
for dir_path in dirs_to_delete:
try:
if os.path.isdir(dir_path):
os.removedirs(dir_path)
except os.error as ex:
log("ERROR", "Failed to delete dir: {}".format(ex))
inventory.pop(target_name, None)
return True
def extract(archive_path, images_dir, test_zip=False):
"""
Extract the contents of `archive_path` into `images_dir`
Returns a list of files that were extracted.
If test_zip is set, it will verify the zip file before extracting.
"""
log("TRACE", "Attempting to extracted files from {}".format(archive_path))
with zipfile.ZipFile(archive_path) as images_zip:
# Check that the Zip file is valid, in which case `testzip()` returns
# None. If it's bad, that function will return a list of bad files
try:
if test_zip and images_zip.testzip():
log("ERROR", "Could not extract the following invalid Zip file:"
" {}".format(archive_path))
return []
except OSError:
log("ERROR", "Could not extract the following invalid Zip file:"
" {}".format(archive_path))
return []
images_zip.extractall(images_dir)
archive_namelist = images_zip.namelist()
log("TRACE", "Extracted files: {}".format(archive_namelist))
return archive_namelist
def update_target(target_info, temp_dir, images_dir, inventory, args):
"""
Handle the updating of a single target.
"""
target_name = target_info.get("target")
target_sha256 = target_info.get("sha256_hash")
filename = target_info.get("filename")
temp_path = os.path.join(temp_dir, filename)
# Add a trailing slash to make sure that urljoin handles things properly
full_url = urljoin(args.base_url+'/', target_info.get("url"))
_, downloaded_size, downloaded_sha256 = download(
images_url=full_url,
filename=temp_path,
buffer_size=args.buffer_size,
print_progress=(_LOG_LEVEL <= _LOG_LEVELS.get("INFO", 3))
)
if downloaded_size == 0:
log("INFO", "Skipping target: {}".format(target_name))
return
log("TRACE", "{} successfully downloaded ({} Bytes)"
.format(temp_path, downloaded_size))
# If the SHA256 in the manifest has the value '0', this is a special case
# and we just skip the verification step
if target_sha256 == '0':
log("DEBUG", "Skipping SHA256 check for {}.".format(full_url))
# If the check fails, print an error and don't unzip the file
elif downloaded_sha256 != target_sha256:
log("ERROR", "Downloaded SHA256 does not match manifest for {}!"
.format(full_url))
return
# Note: this skips the --keep option, so we'll never keep image packages
# that fail the SHA256 checksum
## Now copy the contents to the final destination (the images directory)
delete_from_inv(target_info, inventory, images_dir)
if os.path.splitext(temp_path)[1].lower() == '.zip':
archive_namelist = extract(
temp_path,
images_dir,
args.test)
if args.keep:
# If the user wants to keep the downloaded archive,
# save it to the images directory and add it to the inventory
shutil.copy(temp_path, images_dir)
archive_namelist.append(filename)
else:
archive_namelist = []
shutil.copy(temp_path, images_dir)
## Update inventory
inventory[target_name] = {"repo_hash": target_info.get("repo_hash"),
"contents": archive_namelist,
"filename": filename}
def main():
"""
Main function; does whatever the user requested (download or list files).
Returns True on successful execution.
"""
args = parse_args()
images_dir = get_images_dir(args)
log("INFO", "Images destination: {}".format(os.path.abspath(images_dir)))
try:
manifest = parse_manifest(get_manifest_raw(args))
if args.list_targets:
print_target_list(
manifest,
args
)
return True
log("TRACE", "Manifest:\n{}".format(
"\n".join("{}".format(item) for item in manifest.items())
))
# Read the inventory into a dictionary we can perform lookups on
if os.path.isfile(args.inventory_location):
inventory_fn = args.inventory_location
else:
inventory_fn = os.path.join(images_dir, _INVENTORY_FILENAME)
inventory = parse_inventory(inventory_fn=inventory_fn)
log("TRACE", "Inventory: {}\n{}".format(
os.path.abspath(inventory_fn),
"\n".join("{}".format(item) for item in inventory.items())
))
# Determine the URLs to download based on the input regular expressions
if not args.types:
types_regex_l = [_DEFAULT_TARGET_REGEX]
else:
types_regex_l = args.types
log("TRACE", "RegExs for target selection: {}".format(types_regex_l))
targets_info = lookup_urls(types_regex_l, manifest, inventory, args.refetch)
# Exit early if we don't have anything to download
if targets_info:
target_urls = [info.get("url") for info in targets_info]
log("DEBUG", "URLs to download:\n{}".format(
"\n".join("{}".format(item) for item in target_urls)
))
else:
return True
## Now download all the images archives into a temp directory
if args.dry_run:
for target_info in targets_info:
log("INFO", "[Dry Run] Fetch target: {}".format(
target_info.get("filename")))
return True
with TemporaryDirectory() as temp_dir:
for target_info in targets_info:
update_target(
target_info,
temp_dir,
images_dir,
inventory,
args
)
## Update inventory with all the new content
write_inventory(inventory, inventory_fn)
except Exception as ex:
log("ERROR", "Downloader raised an unhandled exception: {ex}\n"
"You can run this again with the '--verbose' flag to see more information\n"
"If the problem persists, please email the output to: {contact}"
.format(contact=_CONTACT, ex=ex))
# Again, we wait on Windows systems because if this is executed in a
# window, and immediately fails, the user doesn't have a way to see the
# error message, and if they're not very savvy, they won't know how to
# execute this in a shell.
if not _YES and platform.system() == 'Windows':
input('Hit Enter to continue.')
return False
log("INFO", "Images download complete.")
return True
# Placing this near the end of the file so we don't clutter the top
_MANIFEST_CONTENTS = """# UHD Image Manifest File
# Target hash url SHA256
# X300-Series
x3xx_x310_fpga_default fpga-fde2a94eb x3xx/fpga-fde2a94eb/x3xx_x310_fpga_default-gfde2a94e.zip ac5bcf4b85773508bdc3b5e882bfa14025a7867b4c1858f5751439919ee6d270
x3xx_x300_fpga_default fpga-fde2a94eb x3xx/fpga-fde2a94eb/x3xx_x300_fpga_default-gfde2a94e.zip 2bdfb7851f6b9aebadfe3aa227d93532bd005fcae4b4d88ae74522f903bd4081
# Example daughterboard targets (none currently exist)
#x3xx_twinrx_cpld_default example_target
#dboard_ubx_cpld_default example_target
# E-Series
e3xx_e310_sg1_fpga_default fpga-fde2a94eb e3xx/fpga-fde2a94eb/e3xx_e310_sg1_fpga_default-gfde2a94e.zip ac5f6db65780e944c565977e0bd5085c76d0bcdf246579f13d5da69211590980
e3xx_e310_sg3_fpga_default fpga-fde2a94eb e3xx/fpga-fde2a94eb/e3xx_e310_sg3_fpga_default-gfde2a94e.zip 84ddae28d98d02cdeb88b560dc6c1f7280f8d9adcc719bec9774deb7ed6dbb3c
e3xx_e320_fpga_default fpga-fde2a94eb e3xx/fpga-fde2a94eb/e3xx_e320_fpga_default-gfde2a94e.zip 95064badda9b93281b01e642faff9577d054883869896899e28293a243d8862c
# E310 Filesystems
e3xx_e310_sdk_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e310_sdk_default-v3.15.0.0.zip 0
e3xx_e310_sg1_mender_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e310_sg1_mender_default-v3.15.0.0.zip 0
e3xx_e310_sg1_sdimg_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e310_sg1_sdimg_default-v3.15.0.0.zip 0
e3xx_e310_sg3_mender_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e310_sg3_mender_default-v3.15.0.0.zip 0
e3xx_e310_sg3_sdimg_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e310_sg3_sdimg_default-v3.15.0.0.zip 0
# E320 Filesystems, etc
e3xx_e320_sdk_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e320_sdk_default-v3.15.0.0.zip 0
e3xx_e320_mender_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e320_mender_default-v3.15.0.0.zip 0
e3xx_e320_sdimg_default meta-ettus-v3.15.0.0 e3xx/meta-ettus-v3.15.0.0/e3xx_e320_sdimg_default-v3.15.0.0.zip 0
# N300-Series
n3xx_n310_fpga_default fpga-fde2a94eb n3xx/fpga-fde2a94eb/n3xx_n310_fpga_default-gfde2a94e.zip 4a45e2d4ec41d34fc550402928248a15488ba7b58d835ef2d4f503556173764a
n3xx_n300_fpga_default fpga-fde2a94eb n3xx/fpga-fde2a94eb/n3xx_n300_fpga_default-gfde2a94e.zip 7f1b512756ae225f8caaf20fd22d2e1537ea211b2fd6c4c9ed1330065fb56645
n3xx_n320_fpga_default fpga-fde2a94eb n3xx/fpga-fde2a94eb/n3xx_n320_fpga_default-gfde2a94e.zip 4fae9de2ede7ff446da8afb61808868c08ba32f8e3092b802c5d4d7643c7175f
n3xx_n310_cpld_default fpga-6bea23d n3xx/fpga-6bea23d/n3xx_n310_cpld_default-g6bea23d.zip ef128dcd265ee8615b673021d4ee84c39357012ffe8b28c8ad7f893f9dcb94cb
n3xx_n320_cpld_default fpga-4bc2c6f n3xx/fpga-4bc2c6f/n3xx_n320_cpld_default-g4bc2c6f.zip 6680a9363efc5fa8b5a68beb3dff44f2e314b94e716e3a1751aba0fed1f384da
# N3XX Mykonos firmware
#n3xx_n310_fw_default fpga-6bea23d n3xx/fpga-6bea23d/n3xx_n310_fw_default-g6bea23d.zip 0
# N300-Series Filesystems, etc
n3xx_common_sdk_default meta-ettus-v3.15.0.0 n3xx/meta-ettus-v3.15.0.0/n3xx_common_sdk_default-v3.15.0.0.zip 0
n3xx_common_mender_default meta-ettus-v3.15.0.0 n3xx/meta-ettus-v3.15.0.0/n3xx_common_mender_default-v3.15.0.0.zip 0
n3xx_common_sdimg_default meta-ettus-v3.15.0.0 n3xx/meta-ettus-v3.15.0.0/n3xx_common_sdimg_default-v3.15.0.0.zip 0
# B200-Series
b2xx_b200_fpga_default fpga-fde2a94eb b2xx/fpga-fde2a94eb/b2xx_b200_fpga_default-gfde2a94e.zip 44885476f1bce75657e4dd78ba03830e662a59b6bb612a90e9f8041306deb68e
b2xx_b200mini_fpga_default fpga-fde2a94eb b2xx/fpga-fde2a94eb/b2xx_b200mini_fpga_default-gfde2a94e.zip 4318249e394be686e99c58effa162209aa496a039c68ef816f0b2f9247485c12
b2xx_b210_fpga_default fpga-fde2a94eb b2xx/fpga-fde2a94eb/b2xx_b210_fpga_default-gfde2a94e.zip 936864ec5e9627f786c3cd3687c761a24a0ff68a99e224fcc2b24cb4d4197dd2
b2xx_b205mini_fpga_default fpga-fde2a94eb b2xx/fpga-fde2a94eb/b2xx_b205mini_fpga_default-gfde2a94e.zip cd3dad8c70925c0c79e728716c0ebb36f2145e1cf929409fa77c953637effd70
b2xx_common_fw_default uhd-2bdad498 b2xx/uhd-2bdad498/b2xx_common_fw_default-g2bdad498.zip a6a867466448f2f75d9d5d290c57ceb8e1d3219391c9f275824fbeb3e7931732
# USRP2 Devices
usrp2_usrp2_fw_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_usrp2_fw_default-g6bea23d.zip d523a18318cb6a7637be40484bf03a6f54766410fee2c1a1f72e8971ea9a9cb6
usrp2_usrp2_fpga_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_usrp2_fpga_default-g6bea23d.zip 505c70aedc8cdfbbfe654bcdbe1ce604c376e733a44cdd1351571f61a7f1cb49
usrp2_n200_fpga_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_n200_fpga_default-g6bea23d.zip 833a0098d66c0c502b9c3975d651a79e125133c507f9f4b2c472f9eb96fdaef8
usrp2_n200_fw_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_n200_fw_default-g6bea23d.zip 3eee2a6195caafe814912167fccf2dfc369f706446f8ecee36e97d2c0830116f
usrp2_n210_fpga_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_n210_fpga_default-g6bea23d.zip 5ce68ac539ee6eeb7d04fb3127c1fabcaff442a8edfaaa2f3746590f9df909bd
usrp2_n210_fw_default fpga-6bea23d usrp2/fpga-6bea23d/usrp2_n210_fw_default-g6bea23d.zip 3646fcd3fc974d18c621cb10dfe97c4dad6d282036dc63b7379995dfad95fb98
n230_n230_fpga_default fpga-fde2a94eb n230/fpga-fde2a94eb/n230_n230_fpga_default-gfde2a94e.zip 5436932bc8a459c6e350885b67f907f7c864edd71c0089f6692636428b3c20a9
# USRP1 Devices
usrp1_usrp1_fpga_default fpga-6bea23d usrp1/fpga-6bea23d/usrp1_usrp1_fpga_default-g6bea23d.zip 03bf72868c900dd0853bf48e2ede91058d579829b0e70c021e51b0e282d1d5be
usrp1_b100_fpga_default fpga-6bea23d usrp1/fpga-6bea23d/usrp1_b100_fpga_default-g6bea23d.zip 7f2306f21e17aa3fae3f966d08c6297d6cf42041974f846ca89f0d633ece8769
usrp1_b100_fw_default fpga-6bea23d usrp1/fpga-6bea23d/usrp1_b100_fw_default-g6bea23d.zip 867f17fac085535dbcb01c226ce87acf49806de6ed0ae9b214d7c8da86e2a71d
# Octoclock
octoclock_octoclock_fw_default uhd-14000041 octoclock/uhd-14000041/octoclock_octoclock_fw_default-g14000041.zip 8da7f1af8cecb7f6259a237a18c39058ba69a11567fa373cffc9704031a1d053
# Legacy USB Windows drivers
usb_common_windrv_default uhd-14000041 usb/uhd-14000041/usb_common_windrv_default-g14000041.zip 835e94b2bdf2312fd3881a1b78e2ec236c1f42b7a5bd3927f85f73cf5e3a5231
"""
if __name__ == "__main__":
sys.exit(not main())

76
docs/open5gs-and-ueransim/README.md
View File

@@ -10,57 +10,45 @@ deploy the ngc core (open5gs) with:
docker-compose -f ngc.yaml up -d
```
Register subscribers in ngc with `/register_subscribers.sh`.
Register subscribers in ngc with `/register_subscriber.sh`.
# RAN option1: 1 gnodeb and 1 ue
# Deploy gnodeb
Deploy 1 gnodeb and 1 ue:
gnb1.yaml is configured to deploy 1 gnodeb (gnb1) and 3 ues:
```
docker-compose -f 1gnb-1ue.yaml up -d
docker-compose -f gnb1.yaml up -d
```
You can use gnb2.yaml to deploy a second gnodeb (gnb2) with 3 additional ues:
```
docker-compose -f gnb2.yaml up -d
```
# Test
To test ue connectivity through RAN, enter the gnb1-ues container:
```
docker-compose -f gnb1.yaml exec ues /bin/bash
traceroute -i uesimtun0 google.es
ping -I uesimtun0 google.es
```
ues container will have multiple interfaces (one for each ue).
You can try each tunnel providing the flag '-i' in traceroute and '-I' in ping.
If you have deployed a second genodeb (gnb2) just change the gnb1.yaml to gnb2.yaml.
# Clean Up
Undeploy with:
```
docker-compose -f 1gnb-1ue.yaml down
```
# RAN option2: 1 gnodeb and 4 ues
Deploy 1 gnodeb and 4 ues:
```
docker-compose -f 1gnb-4ue.yaml up -d
```
Undeploy with:
```
docker-compose -f 1gnb-4ue.yaml down
```
# RAN option3: 2 gnodeb and 4 ues
Deploy 2 gnodeb and 4 ues:
```
docker-compose -f 2gnb-4ue.yaml up -d
```
Undeploy with:
```
docker-compose -f 2gnb-4ue.yaml down
```
# Undeploy NGC
Run:
```
docker-compose -f ngc.yaml down
```
docker-compose -f gnb1.yaml down
docker-compose -f gnb2.yaml down
docker-compose -f epc.yaml down -v
```

11
docs/open5gs-and-ueransim/gnb.yaml
View File

@@ -1,11 +0,0 @@
version: '3'
services:
gnb1:
image: openverso/ueransim:3.3.2
container_name: gnb1
command:
- gnb
environment:
AMF_HOSTNAME: amf
GNB_HOSTNAME: gnb1

31
docs/open5gs-and-ueransim/gnb1.yaml Normal file
View File

@@ -0,0 +1,31 @@
version: '3'
services:
gnb1:
image: openverso/ueransim:3.2.2
container_name: gnb1
command:
- gnb
environment:
AMF_HOSTNAME: amf
GNB_HOSTNAME: gnb1
MCC: '901'
MNC: '70'
SST: '1'
SD: '0xffffff'
ue:
image: openverso/ueransim:3.2.2
command: ['ue','-n','3']
cap_add:
- all
privileged: true
environment:
GNB_HOSTNAME: gnb1
APN: internet
MSISDN: '0000000001'
MCC: '901'
MNC: '70'
KEY: '465B5CE8B199B49FAA5F0A2EE238A6BC'
OP_TYPE: OPC
OP: 'E8ED289DEBA952E4283B54E88E6183CA'
SST: '1'
SD: '0xffffff'

32
docs/open5gs-and-ueransim/gnb2.yaml Normal file
View File

@@ -0,0 +1,32 @@
version: '3'
services:
gnb2:
image: openverso/ueransim:3.2.2
container_name: gnb2
command:
- gnb
environment:
AMF_HOSTNAME: amf
GNB_HOSTNAME: gnb2
MCC: '901'
MNC: '70'
SST: '1'
SD: '0xffffff'
ue:
image: openverso/ueransim:3.2.2
command: ['ue','-n','3']
cap_add:
- all
privileged: true
environment:
GNB_HOSTNAME: gnb1
APN: internet
MSISDN: '0000000011'
MCC: '901'
MNC: '70'
KEY: '465B5CE8B199B49FAA5F0A2EE238A6BC'
OP_TYPE: OPC
OP: 'E8ED289DEBA952E4283B54E88E6183CA'
SST: '1'
SD: '0xffffff'

55
docs/open5gs-and-ueransim/ngc.yaml
View File

@@ -5,56 +5,69 @@ services:
environment:
MONGO_INITDB_DATABASE: open5gs
amf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command:
- open5gs-amfd
restart : on-failure
ausf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command:
- open5gs-ausfd
restart : on-failure
bsf:
image: openverso/open5gs:2.3.2
command:
- open5gs-bsfd
restart : on-failure
nrf:
image: openverso/open5gs:2.2.3
command: open5gs-nrfd
image: openverso/open5gs:2.3.2
command: open5gs-nrfd
restart : on-failure
ports:
- 7777:7777
nssf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command: open5gs-nssfd
restart : on-failure
pcf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command:
- open5gs-pcfd
environment:
DB_URI: mongodb://mongo/open5gs
restart : on-failure
pcrf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command: ["open5gs-pcrfd"]
environment:
DB_URI: mongodb://mongo/open5gs
restart: on-failure
smf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command: open5gs-smfd
restart : on-failure
udm:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
restart: on-failure
command:
- open5gs-udmd
udr:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
restart: on-failure
environment:
DB_URI: mongodb://mongo/open5gs
command:
- open5gs-udrd
upf:
image: openverso/open5gs:2.2.3
image: openverso/open5gs:2.3.2
command:
- open5gs-upfd
cap_add:
@@ -63,16 +76,18 @@ services:
restart: on-failure
ports:
- 2152:2152
webui:
image: openverso/open5gs-webui:2.2.3
image: openverso/open5gs-webui:2.3.2
restart: on-failure
environment:
DB_URI: mongodb://mongo/open5gs
ports:
- 3000:3000
portainer:
image: portainer/portainer-ce
ports:
- 9000:9000
volumes:
- /var/run/docker.sock:/var/run/docker.sock
# portainer:
# image: portainer/portainer-ce
# ports:
# - 9000:9000
# volumes:
# - /var/run/docker.sock:/var/run/docker.sock

437
docs/open5gs-and-ueransim/open5gs-dbctl Executable file
View File

@@ -0,0 +1,437 @@
#!/bin/bash
version=0.9.1
display_help() {
echo "open5gs-dbctl: Open5GS Database Configuration Tool ($version)"
echo "COMMANDS:" >&2
echo " add {imsi key opc}: adds a user to the database with default values"
echo " add {imsi ip key opc}: adds a user to the database with default values and a IPv4 address for the UE"
echo " addT1 {imsi key opc}: adds a user to the database with 3 differents apns"
echo " addT1 {imsi ip key opc}: adds a user to the database with 3 differents apns and the same IPv4 address for the each apn"
echo " remove {imsi}: removes a user from the database"
echo " reset: WIPES OUT the database and restores it to an empty default"
echo " static_ip {imsi ip4}: adds a static IP assignment to an already-existing user"
echo " static_ip6 {imsi ip6}: adds a static IPv6 assignment to an already-existing user"
echo " type {imsi type}: changes the PDN-Type of the first PDN: 0 = IPv4, 1 = IPv6, 2 = IPv4v6, 3 = v4 OR v6"
echo " help: displays this message and exits"
echo " default values are as follows: APN \"internet\", dl_bw/ul_bw 1 Gbps, PGW address is 127.0.0.3, IPv4 only"
}
if [ "$#" -lt 1 ]; then
display_help
exit 1
fi
if [ "$1" = "help" ]; then
display_help
exit 1
fi
if [ "$1" = "add" ]; then
if [ "$#" -eq 4 ]; then
IMSI=$2
KI=$3
OPC=$4
mongo --eval "db.subscribers.update( { \"imsi\" : \"$IMSI\" },
{ \$setOnInsert:
{
\"imsi\" : \"$IMSI\",
\"subscribed_rau_tau_timer\" : NumberInt(12),
\"network_access_mode\" : NumberInt(2),
\"subscriber_status\" : NumberInt(0),
\"access_restriction_data\" : NumberInt(32),
\"slice\" :
[{
\"sst\" : NumberInt(1),
\"default_indicator\" : true,
\"_id\" : new ObjectId(),
\"session\" :
[{
\"name\" : \"internet\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
}],
}],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3),},
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"security\" :
{
\"k\" : \"$KI\",
\"amf\" : \"8000\",
\"op\" : null,
\"opc\" : \"$OPC\"
},
\"__v\" : 0
},
},
upsert=true);" open5gs
exit 0
fi
if [ "$#" -eq 5 ]; then
IMSI=$2
IP=$3
KI=$4
OPC=$5
mongo --eval "db.subscribers.update( { \"imsi\" : \"$IMSI\" },
{ \$setOnInsert:
{
\"imsi\" : \"$IMSI\",
\"subscribed_rau_tau_timer\" : NumberInt(12),
\"network_access_mode\" : NumberInt(2),
\"subscriber_status\" : NumberInt(0),
\"access_restriction_data\" : NumberInt(32),
\"slice\" :
[{
\"sst\" : NumberInt(1),
\"default_indicator\" : true,
\"_id\" : new ObjectId(),
\"session\" :
[{
\"name\" : \"internet\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ue\" :
{
\"addr\" : \"$IP\",
},
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
}],
}],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3),},
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"security\" :
{
\"k\" : \"$KI\",
\"amf\" : \"8000\",
\"op\" : null,
\"opc\" : \"$OPC\"
},
\"__v\" : 0
},
},
upsert=true);" open5gs
exit 0
fi
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl add imsi key opc\""
exit 1
fi
if [ "$1" = "addT1" ]; then
if [ "$#" -eq 4 ]; then
IMSI=$2
KI=$3
OPC=$4
mongo --eval "db.subscribers.update( { \"imsi\" : \"$IMSI\" },
{ \$setOnInsert:
{
\"imsi\" : \"$IMSI\",
\"subscribed_rau_tau_timer\" : NumberInt(12),
\"network_access_mode\" : NumberInt(2),
\"subscriber_status\" : NumberInt(0),
\"access_restriction_data\" : NumberInt(32),
\"slice\" :
[{
\"sst\" : NumberInt(1),
\"default_indicator\" : true,
\"_id\" : new ObjectId(),
\"session\" :
[{
\"name\" : \"internet\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
},{
\"name\" : \"internet1\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
},{
\"name\" : \"internet2\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
}],
}],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3),},
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"security\" :
{
\"k\" : \"$KI\",
\"amf\" : \"8000\",
\"op\" : null,
\"opc\" : \"$OPC\"
},
\"__v\" : 0
},
},
upsert=true);" open5gs
exit 0
fi
if [ "$#" -eq 5 ]; then
IMSI=$2
IP=$3
KI=$4
OPC=$5
mongo --eval "db.subscribers.update( { \"imsi\" : \"$IMSI\" },
{ \$setOnInsert:
{
\"imsi\" : \"$IMSI\",
\"subscribed_rau_tau_timer\" : NumberInt(12),
\"network_access_mode\" : NumberInt(2),
\"subscriber_status\" : NumberInt(0),
\"access_restriction_data\" : NumberInt(32),
\"slice\" :
[{
\"sst\" : NumberInt(1),
\"default_indicator\" : true,
\"_id\" : new ObjectId(),
\"session\" :
[{
\"name\" : \"internet\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ue\" :
{
\"addr\" : \"$IP\",
},
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
},{
\"name\" : \"internet1\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ue\" :
{
\"addr\" : \"$IP\",
},
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
},{
\"name\" : \"internet2\",
\"type\" : NumberInt(3),
\"_id\" : new ObjectId(),
\"pcc_rule\" : [],
\"ue\" :
{
\"addr\" : \"$IP\",
},
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"qos\" :
{
\"index\" : NumberInt(9),
\"arp\" :
{
\"priority_level\" : NumberInt(8),
\"pre_emption_capability\" : NumberInt(1),
\"pre_emption_vulnerability\" : NumberInt(1),
},
},
}],
}],
\"ambr\" :
{
\"uplink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3),},
\"downlink\" : { \"value\": NumberInt(1), \"unit\" : NumberInt(3) },
},
\"security\" :
{
\"k\" : \"$KI\",
\"amf\" : \"8000\",
\"op\" : null,
\"opc\" : \"$OPC\"
},
\"__v\" : 0
},
},
upsert=true);" open5gs
exit 0
fi
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl add imsi key opc\""
exit 1
fi
if [ "$1" = "remove" ]; then
if [ "$#" -ne 2 ]; then
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl remove imsi\""
exit 1
fi
IMSI=$2
mongo --eval "db.subscribers.remove({\"imsi\": \"$IMSI\"});" open5gs
exit 0
fi
if [ "$1" = "reset" ]; then
if [ "$#" -ne 1 ]; then
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl reset\""
exit 1
fi
mongo --eval "db.subscribers.remove({});" open5gs
exit 0
fi
if [ "$1" = "static_ip" ]; then
if [ "$#" -ne 3 ]; then
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl static_ip imsi ip\""
exit 1
fi
IMSI=$2
IP=$3
mongo --eval "db.subscribers.update({\"imsi\": \"$IMSI\"},{\$set: { \"slice.0.session.0.ue.addr\": \"$IP\" }});" open5gs
exit 0
fi
if [ "$1" = "static_ip6" ]; then
if [ "$#" -ne 3 ]; then
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl static_ip6 imsi ip\""
exit 1
fi
IMSI=$2
IP=$3
mongo --eval "db.subscribers.update({\"imsi\": \"$IMSI\"},{\$set: { \"slice.0.session.0.ue.addr6\": \"$IP\" }});" open5gs
exit 0
fi
if [ "$1" = "type" ]; then
if [ "$#" -ne 3 ]; then
echo "open5gs-dbctl: incorrect number of args, format is \"open5gs-dbctl type imsi type\""
exit 1
fi
IMSI=$2
TYPE=$3
mongo --eval "db.subscribers.update({\"imsi\": \"$IMSI\"},{\$set: { \"slice.0.session.0.type\": NumberInt($TYPE) }});" open5gs
exit 0
fi
display_help

28
docs/open5gs-and-ueransim/register_subscriber.sh Executable file
View File

@@ -0,0 +1,28 @@
#!/bin/bash
MONGO_CONTAINER=open5gs-and-ueransim_mongo_1
: 'open5gs-dbctl: Open5GS Database Configuration Tool (0.9.1)
COMMANDS:
add {imsi key opc}: adds a user to the database with default values
add {imsi ip key opc}: adds a user to the database with default values and a IPv4 address for the UE
addT1 {imsi key opc}: adds a user to the database with 3 differents apns
addT1 {imsi ip key opc}: adds a user to the database with 3 differents apns and the same IPv4 address for the each apn
remove {imsi}: removes a user from the database
reset: WIPES OUT the database and restores it to an empty default
static_ip {imsi ip4}: adds a static IP assignment to an already-existing user
static_ip6 {imsi ip6}: adds a static IPv6 assignment to an already-existing user
type {imsi type}: changes the PDN-Type of the first PDN: 0 = IPv4, 1 = IPv6, 2 = IPv4v6, 3 = v4 OR v6
help: displays this message and exits
default values are as follows: APN "internet", dl_bw/ul_bw 1 Gbps, PGW address is 127.0.0.3, IPv4 only
'
docker cp open5gs-dbctl $MONGO_CONTAINER:/
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000001 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000002 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000003 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000011 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000012 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA
docker exec -ti $MONGO_CONTAINER /open5gs-dbctl add 901700000000013 465B5CE8B199B49FAA5F0A2EE238A6BC E8ED289DEBA952E4283B54E88E6183CA

13
docs/open5gs-and-ueransim/register_subscribers.sh
View File

@@ -1,13 +0,0 @@
#!/bin/bash
CONTAINER_NAME=open5gs-and-ueransim_mongo_1
IMSI_LIST="001010000000001 001010000000002 001010000000003 001010000000004 001010000000011 001010000000012 001010000000013 001010000000014"
KI=465B5CE8B199B49FAA5F0A2EE238A6BC
OPC=E8ED289DEBA952E4283B54E88E6183CA
for IMSI in $IMSI_LIST; do
docker exec $CONTAINER_NAME mongo --eval "db.subscribers.update({\"imsi\" : \"$IMSI\"}, { \$setOnInsert: {\"imsi\" : \"$IMSI\",\"subscribed_rau_tau_timer\": NumberInt(12),\"network_access_mode\": NumberInt(2),\"subscriber_status\": NumberInt(0),\"access_restriction_data\": NumberInt(32),\"slice\":[{\"sst\": NumberInt(1),\"default_indicator\":true,\"session\":[{\"name\":\"internet\",\"type\":NumberInt(3),\"pcc_rule\":[],\"ambr\":{\"uplink\":{\"value\":NumberInt(1),\"unit\":NumberInt(3)},\"downlink\":{\"value\":NumberInt(1),\"unit\":NumberInt(3)}},\"qos\":{\"index\":NumberInt(9),\"arp\":{\"priority_level\":NumberInt(8),\"pre_emption_capability\":NumberInt(1),\"pre_emption_vulnerability\":NumberInt(1)}}}]}],\"ambr\":{\"uplink\":{\"value\":NumberInt(1),\"unit\":NumberInt(3)},\"downlink\":{\"value\":NumberInt(1),\"unit\":NumberInt(3)}},\"security\":{\"k\":\"$KI\",\"amf\":\"8000\",\"op\":null,\"opc\":\"$OPC\"}}}, upsert=true);" open5gs
done

51
docs/open5gs-and-ueransim/ues.yaml
View File

@@ -1,51 +0,0 @@
version: '3'
services:
gnb1:
image: openverso/ueransim:3.2.2
container_name: gnb1
command:
- gnb
environment:
AMF_HOSTNAME: amf
GNB_HOSTNAME: gnb1
gnb2:
image: openverso/ueransim:3.2.2
container_name: gnb2
command:
- gnb
environment:
AMF_HOSTNAME: amf
GNB_HOSTNAME: gnb2
ues_gnb1:
image: openverso/ueransim:3.2.2
command:
- ue
- -n
- "2"
cap_add:
- all
privileged: true
environment:
GNB_HOSTNAME: gnb1
APN: internet
MSISDN: '0000000001'
KEY: '465B5CE8B199B49FAA5F0A2EE238A6BC'
OP_TYPE: OPC
OP: 'E8ED289DEBA952E4283B54E88E6183CA'
ues_gnb2:
image: openverso/ueransim:3.2.2
command:
- ue
- -n
- "2"
cap_add:
- all
privileged: true
environment:
GNB_HOSTNAME: gnb2
APN: internet
MSISDN: '0000000011'
KEY: '465B5CE8B199B49FAA5F0A2EE238A6BC'
OP_TYPE: OPC
OP: 'E8ED289DEBA952E4283B54E88E6183CA'

5
oai/Makefile
View File

@@ -5,11 +5,10 @@ IMAGE=openverso/oai
TAG=2021.w31
gnb:
docker build -t ${IMAGE}-gnb:${TAG} . --build-arg version=${TAG} -f Dockerfile.gNB.ubuntu18 --push
docker build -t ${IMAGE}-gnb:${TAG} . --build-arg version=${TAG} -f Dockerfile.gNB.ubuntu18
enb:
docker build -t ${IMAGE}-enb:${TAG} . --build-arg version=${TAG} -f Dockerfile.eNB.ubuntu18 --push
docker build -t ${IMAGE}-enb:${TAG} . --build-arg version=${TAG} -f Dockerfile.eNB.ubuntu18
build:
docker build -t ${IMAGE}:${TAG} .

3
oai/enb_entrypoint.sh
View File

@@ -1,6 +1,6 @@
#!/bin/bash
set -euo pipefail
set -eo pipefail
PREFIX=/opt/oai-enb
@@ -60,6 +60,7 @@ for c in ${CONFIG_FILES}; do
EXPRESSIONS=""
for v in ${VARS}; do
NEW_VAR=`echo $v | sed -e "s#@##g"`
echo $NEW_VAR
if [[ "${!NEW_VAR}x" == "x" ]]; then
echo "Error: Environment variable '${NEW_VAR}' is not set." \
"Config file '$(basename $c)' requires all of $VARS."

2
oai/gnb_entrypoint.sh
View File

@@ -1,6 +1,6 @@
#!/bin/bash
set -euo pipefail
set -eo pipefail
IFACES=${IFACES:-"ENB_S1C ENB_S1U ENB_X2"}
HOSTNAMES=${HOSTNAMES:-"MME_S1C "}

12
open5gs/Makefile
View File

@@ -2,8 +2,14 @@
REGISTRY=docker.io
IMAGE=openverso/open5gs
TAG=2.3.0
TAG=2.3.2
PLATFORMS=linux/amd64,linux/arm64
build:
docker build -t ${IMAGE}:${TAG} --build-arg version=${TAG} . --platform linux/amd64,linux/arm64 --push
docker build -t ${IMAGE}-webui:${TAG} --build-arg version=${TAG} . -f Dockerfile.webui --platform linux/amd64,linux/arm64 --push
docker build -t ${IMAGE}:${TAG} --build-arg version=${TAG} .
docker build -t ${IMAGE}-webui:${TAG} --build-arg version=${TAG} . -f Dockerfile.webui
buildx:
docker buildx build -t ${IMAGE}:${TAG} --build-arg version=${TAG} . --platform ${PLATFORMS} --push
docker buildx build -t ${IMAGE}-webui:${TAG} --build-arg version=${TAG} . -f Dockerfile.webui --platform ${PLATFORMS} --push

61
open5gs/configs/open5gs/amf.yaml
View File

@@ -1,37 +1,38 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
amf:
sbi:
port: 7777
ngap:
guami:
- plmn_id:
mcc: 901
mnc: 70
amf_id:
region: 2
set: 1
tai:
- plmn_id:
mcc: 901
mnc: 70
tac: 1
plmn_support:
- plmn_id:
mcc: 901
mnc: 70
s_nssai:
- sst: 1
security:
integrity_order : [ NIA2, NIA1, NIA0 ]
ciphering_order : [ NEA0, NEA1, NEA2 ]
network_name:
full: Openverso
amf_name: open5gs-amf0
sbi:
- dev: eth0
advertise: amf
ngap:
guami:
- plmn_id:
mcc: 901
mnc: 70
amf_id:
region: 2
set: 1
tai:
- plmn_id:
mcc: 901
mnc: 70
tac: 1
plmn_support:
- plmn_id:
mcc: 901
mnc: 70
s_nssai:
- sst: 1
# sd: 1
security:
integrity_order : [ NIA2, NIA1, NIA0 ]
ciphering_order : [ NEA0, NEA1, NEA2 ]
network_name:
full: Openverso
amf_name: amf
nrf:
sbi:
- name: nrf
port: 7777
sbi:
- name: nrf
parameter:
max:

5
open5gs/configs/open5gs/ausf.yaml
View File

@@ -1,11 +1,12 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
ausf:
sbi:
port: 7777
- dev: eth0
advertise: ausf
nrf:
sbi:
- name: nrf
port: 7777
parameter:
max:
pool:

4
open5gs/configs/open5gs/bsf.yaml
View File

@@ -1,10 +1,10 @@
bsf:
sbi:
port: 7777
- dev: eth0
advertise: bsf
nrf:
sbi:
- name: nrf
port: 7777
parameter:
max:
pool:

23
open5gs/configs/open5gs/gnb.yaml Normal file
View File

@@ -0,0 +1,23 @@
mcc: ${MCC} # Mobile Country Code value
mnc: ${MNC} # Mobile Network Code value (2 or 3 digits)
nci: '0x0000000100' # NR Cell Identity (36-bit)
idLength: 32 # NR gNB ID length in bits [22...32]
tac: ${TAC} # Tracking Area Code
linkIp: ${GNB_ADDR} # gNB's local IP address for Radio Link Simulation (Usually same with local IP)
ngapIp: ${GNB_ADDR} # gNB's local IP address for N2 Interface (Usually same with local IP)
gtpIp: ${GNB_ADDR} # gNB's local IP address for N3 Interface (Usually same with local IP)
# List of AMF address information
amfConfigs:
- address: ${AMF_ADDR}
port: 38412
# List of supported S-NSSAIs by this gNB
slices:
- sst: ${SST}
#sd: ${SD}
# Indicates whether or not SCTP stream number errors should be ignored.
ignoreStreamIds: true

3
open5gs/configs/open5gs/nrf.yaml
View File

@@ -1,7 +1,8 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
nrf:
sbi:
port: 7777
- dev: eth0
advertise: nrf
parameter:
max:
pool:

7
open5gs/configs/open5gs/nssf.yaml
View File

@@ -1,17 +1,16 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
nssf:
sbi:
port: 7777
sbi:
- dev: eth0
advertise: nssf
nsi:
- name: nrf
port: 7777
s_nssai:
sst: 1
nrf:
sbi:
- name: nrf
port: 7777
parameter:
max:

4
open5gs/configs/open5gs/pcf.yaml
View File

@@ -1,11 +1,11 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
pcf:
sbi:
port: 7777
- dev: eth0
advertise: pcf
nrf:
sbi:
- name: nrf
port: 7777
parameter:
max:
pool:

4
open5gs/configs/open5gs/smf.yaml
View File

@@ -1,7 +1,8 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
smf:
sbi:
port: 7777
- dev: eth0
advertise: smf
gtpc:
gtpu:
pfcp:
@@ -20,7 +21,6 @@ smf:
nrf:
sbi:
- name: nrf
port: 7777
upf:
pfcp:
- name: upf

4
open5gs/configs/open5gs/udm.yaml
View File

@@ -2,11 +2,11 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
udm:
sbi:
port: 7777
- dev: eth0
advertise: udm
nrf:
sbi:
- name: nrf
port: 7777
parameter:
pool:
time:

3
open5gs/configs/open5gs/udr.yaml
View File

@@ -1,10 +1,11 @@
### For reference, see `/opt/open5gs/etc/orig/open5gs/`
udr:
sbi:
- dev: eth0
advertise: udr
nrf:
sbi:
- name: nrf
port: 7777
parameter:
max:
pool:

73
open5gs/configs/open5gs/ue.yaml Normal file
View File

@@ -0,0 +1,73 @@
# IMSI number of the UE. IMSI = [MCC|MNC|MSISDN] (In total 15 or 16 digits)
supi: 'imsi-${MCC}${MNC}${MSISDN}'
# Mobile Country Code value
mcc: ${MCC}
# Mobile Network Code value (2 or 3 digits)
mnc: ${MNC}
# Permanent subscription key
key: '${KEY}'
# Operator code (OP or OPC) of the UE
op: '${OP}'
# This value specifies the OP type and it can be either 'OP' or 'OPC'
opType: '${OP_TYPE}'
# Authentication Management Field (AMF) value
amf: '8000'
# IMEI number of the device. It is used if no SUPI is provided
imei: '356938035643803'
# IMEISV number of the device. It is used if no SUPI and IMEI is provided
imeiSv: '4370816125816151'
# List of gNB IP addresses for Radio Link Simulation
gnbSearchList:
- ${GNB_ADDR}
# UAC Access Identities Configuration
uacAic:
mps: false
mcs: false
# UAC Access Control Class
uacAcc:
normalClass: 0
class11: false
class12: false
class13: false
class14: false
class15: false
# Initial PDU sessions to be established
sessions:
- type: 'IPv4'
apn: ${APN}
slice:
sst: ${SST}
sd: ${SD}
emergency: false
# Configured NSSAI for this UE by HPLMN
configured-nssai:
- sst: ${SST}
#sd: ${SD}
# Default Configured NSSAI for this UE
default-nssai:
- sst: ${SST}
#sd: ${SD}
# Supported encryption algorithms by this UE
integrity:
IA1: true
IA2: true
IA3: true
# Supported integrity algorithms by this UE
ciphering:
EA1: true
EA2: true
EA3: true
# Integrity protection maximum data rate for user plane
integrityMaxRate:
uplink: 'full'
downlink: 'full'