Skip to content

Commit

Permalink
chore: modify product description
Browse files Browse the repository at this point in the history
Signed-off-by: Serdar Vural <[email protected]>
  • Loading branch information
solmyrcan committed May 14, 2024
1 parent 695b7a8 commit 73d13cf
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Charmed Aether SD-Core

<<<<<<< Updated upstream
Aether SD-Core is a 5G core network, responsible for the 5G Network's control operations: Authentication, IP assignment, Policy management, Quality of Service, Slice management, and more.

Charmed Aether SD-Core automates the operations of Aether SD-Core, making it easy to deploy, upgrade and observe.
=======
Charmed Aether SD-Core automates the operations of Aether SD-Core, an open source 5G core network software. By leveraging Canonical Juju software automation and orchestration engine, Charmed Aether SD-Core can be easily deployed and managed, with observability in place.

>>>>>>> Stashed changes
32 changes: 32 additions & 0 deletions docs/.wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
addon
addons
Aether
<<<<<<< Updated upstream
=======
AKS
>>>>>>> Stashed changes
AMF
APIs
AUSF
Expand All @@ -11,6 +15,10 @@ bessd
br
Bitrate
bootloader
<<<<<<< Updated upstream
=======
Canonical
>>>>>>> Stashed changes
Charmhub
CharmHub
CIDR
Expand All @@ -22,18 +30,34 @@ coredns
Corefile
CPUs
CSR
<<<<<<< Updated upstream
=======
deployable
>>>>>>> Stashed changes
DHCP
DN
dns
dnsmasq
DNS
enp
<<<<<<< Updated upstream
=======
EKS
frictionless
>>>>>>> Stashed changes
gb
GCP
Gi
GiB
<<<<<<< Updated upstream
gnb
gNB
=======
GKE
gnb
gNB
gNBs
>>>>>>> Stashed changes
gnbsim
Gnbsim
gNodeB
Expand Down Expand Up @@ -70,6 +94,10 @@ MetalLB
mgmt
microk
MicroK
<<<<<<< Updated upstream
=======
Microk8s
>>>>>>> Stashed changes
MNC
Mongo
multipass
Expand All @@ -87,6 +115,10 @@ nms
NMS
NRF
NSSF
<<<<<<< Updated upstream
=======
observability
>>>>>>> Stashed changes
Observability
OCI
ONF
Expand Down
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# Charmed Aether SD-Core

<<<<<<< Updated upstream
Aether SD-Core is a 5G core network, responsible for the 5G Network's control operations: Authentication, IP assignment, Policy management, Quality of Service, Slice management, and more.

Charmed Aether SD-Core automates the operations of Aether SD-Core, making it easy to deploy, upgrade and observe.

Charmed Aether SD-Core exists because mobile networks are traditionally costly and difficult to operate and that open source alternatives are either too complex or unsecure. The project combines ONF's 5G expertise with Juju model driven operations.

Charmed Aether SD-Core is for private mobile networks operators and all connectivity enthusiasts. Use it in your farm, mine or oil rig, wherever you need 5G connectivity.
=======
Aether SD-Core is an open source 5G core network distributed by the Linux Foundation as part of its Aether directed fund project. SD-Core (Software-Defined Core) was previously distributed by the Open Networking Foundation (ONF).

Aether SD-Core addresses the need for a cost-effective open source 5G core network, as opposed to traditionally costly mobile networking software. It supports various functionalities, including user authentication, IP address assignment, data traffic policy management, quality of service assurance, and network slice management.

A 5G core network consists of multiple micro-services, each with its own set of configurations and service interfaces. This makes it complex to deploy and operate a 5G network. Charmed Aether SD-Core is an open source 5G core network solution, which is easy to deploy and manage. By leveraging Canonical's [Juju software orchestration framework](https://juju.is/), it brings full automation to Aether SD-Core micro services. It is also fully observable as it offers frictionless integration with [Canonical Observability Stack](https://ubuntu.com/observability), which is a combination of open source observability software components deployed and automated as a bundle.

Charmed Aether SD-Core is for private mobile networks. It offers a cost-effective and easy-to-use core networking solution for any enterprise that needs on-site 5G mobile network connectivity for their devices and personnel. It is also the ideal open source distribution for any technology enthusiast who would like to deploy and test a 5G mobile network for their own connectivity needs. Use it in your farm, mine or oil rig, wherever you need 5G connectivity.
>>>>>>> Stashed changes
## In this documentation

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@

SD-Core requires the following IP networks:
- **Management:** Network used by Juju and Kubernetes to communicate with the SD-Core components.
<<<<<<< Updated upstream
- **Core:** Network used by the UPF to communicate with the SMF.
=======
- **Core:** Network used by the UPF to communicate with data networks, such as the Internet.
>>>>>>> Stashed changes
- **Access:** Network used by the UPF to communicate with the RAN.
- **RAN:** Network used by the radio components to communicate with the core network.

Expand Down
9 changes: 8 additions & 1 deletion docs/reference/public_clouds.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Public Clouds

<<<<<<< Updated upstream
It is not possible to deploy SD-Core on AWS, Microsoft Azure or GCP using their managed Kubernetes services. None of them support the SCTP protocol on load balancers, which prevents the gNodeB from communicating with the AMF.

MicroK8s is the preferred Kubernetes distribution for SD-Core.
MicroK8s is the preferred Kubernetes distribution for SD-Core.
=======
Charmed Aether SD-Core is deployable on Kubernetes platforms. MicroK8s is the preferred Kubernetes distribution for SD-Core, and has been tested extensively.

Even though SD-Core can be deployed on managed Kubernetes services offered on public cloud platforms (Microsoft AKS, Amazon EKS,and Google GKE), these platforms do not support SCTP traffic on their load balancers, yet SCTP is essential for the traffic between AMF and gNBs. However, on AWS, it is possible to deploy a VM, install MicroK8s, and expose an SCTP load balancer, which then allows for SCTP connection to an external gNB.

>>>>>>> Stashed changes
16 changes: 16 additions & 0 deletions docs/tutorials/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Getting started

<<<<<<< Updated upstream
In this tutorial, we will deploy and run the SD-Core 5G core network using Juju and Terraform.
As part of this tutorial, we will also deploy additional components (gNB Simulator - a 5G radio
and a cellphone simulator, SD-Core Router - a software router facilitating communication between
the core and the Radio Access Network (RAN)) to simulate usage of this network. Both gNB Simulator
and SD-Core Router serve only demonstration purposes and shouldn't be part of production
deployments.
=======
In this tutorial, we will deploy and run an SD-Core 5G core network using Juju and Terraform.
As part of this tutorial, we will also deploy additional components:

- gNB Simulator: a 5G radio and a cellphone simulator,
- SD-Core Router: a software router facilitating communication between the core and the Radio
Access Network (RAN) to simulate usage of this network.

Both gNB Simulator and SD-Core Router serve only demonstration purposes and shouldn't be part
of production deployments.
>>>>>>> Stashed changes
To complete this tutorial, you will need a machine which meets the following requirements:

Expand Down Expand Up @@ -176,7 +188,11 @@ Initialize Juju Terraform provider:
terraform init
```

<<<<<<< Updated upstream
Deploy 5G network.
=======
Deploy SD-Core by applying your Terraform configuration:
>>>>>>> Stashed changes
```console
terraform apply -auto-approve
Expand Down
12 changes: 12 additions & 0 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@

In these tutorials, we will deploy and run Charmed Aether SD-Core in various configurations.

<<<<<<< Updated upstream
Charmed Aether SD-Core is a complex piece of software.

These tutorials will introduce you to key concepts, tools, processes and
operations, starting from your first installation to a cloud deployment.
Along the way they will give examples of good practice, and pointers to much
=======
These tutorials will introduce you to key concepts, tools, processes and
operations, starting from your first installation to a cloud deployment.
Along the way, they will give examples of good practice, and pointers to much
>>>>>>> Stashed changes
more detailed information.

You can expect to spend one to two hours working through the complete
Expand All @@ -16,8 +22,14 @@ tutorials steps in sequence; they take you on a learning journey through the
product.

The tutorials have been tested with a variety of users. We make every effort to
<<<<<<< Updated upstream
keep them up-to-date and ensure that they are reliable - but if you encounter any
problems, we want to help you, so please let us know.
=======
keep them up-to-date and ensure that they are reliable, but if you encounter any
problems, please get in touch, as we want to help you complete the tutorials and
have a frictionless experience with Charmed Aether SD-Core.
>>>>>>> Stashed changes
## Table of content

Expand Down

0 comments on commit 73d13cf

Please sign in to comment.