Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Borjis131 committed Jul 6, 2023
1 parent 488f559 commit e6982ac
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ The `configs/basic/` configuration uses Open5GS 5G Network Functions without SCP

The `configs/basic/upf.yaml` UPF config file is using the _advertise_ option with the `DOCKER_HOST_IP` environment variable present in the `.env` file (it is used through the `docker-host.external-ip` hosts entry). This configures the 5G Core to expect connections from external networks (not the docker network), through the host machine.

For Docker compose deployments without external connections, such as `internal` or `network-slicing` the `DOCKER_HOST_IP` environment variable is ignored.

The files for the `basic` deployment `compose-files/basic/` contains the docker-compose.yaml files to work with Compose V2 using the Compose specification.

The `docker-compose.yaml` uses configs, the source config file present in `configs/basic/<nf>.yaml` and is mounted into the container path `/open5gs/config/<nf>.yaml`. This way you can try different configuration files without the need of rebuilding the Docker image.
Expand Down
2 changes: 1 addition & 1 deletion docs/deployments/network-slicing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `network-slicing` deployment is prepared to work with internal gNBs (and UEs

This example is based on [s5uishida snssai upf sample](https://github.com/s5uishida/open5gs_5gc_ueransim_snssai_upf_sample_config).

The `network-slicing` deployment works with [UERANSIM](https://github.com/aligungr/UERANSIM) using the gNB and UE images from [docker-ueransim](https://github.com/Borjis131/docker-ueransim) and does not build the images from this repository, instead it downloads the images present in the `ghcr.io/borjis131` registry, those images are created from this repository.
The `network-slicing` deployment works with [UERANSIM](https://github.com/aligungr/UERANSIM) using the gNB and UE images from [docker-ueransim](https://github.com/Borjis131/docker-ueransim) and does not build the Docker images from this repository, instead it downloads the images present in the `ghcr.io/borjis131` registry, those images are the ones built from this repository.

This deployment connects two UERANSIM UEs (UE1 and UE2) to a UERANSIM gNB. The UEs are configured to select two different network slices, both present on the Open5GS 5G Core configuration files.

Expand Down

0 comments on commit e6982ac

Please sign in to comment.