Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: modify product description #11

Closed
wants to merge 12 commits into from
Closed
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Charmed Aether SD-Core

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, 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.

Charmed Aether SD-Core automates the operations of Aether SD-Core, making it easy to deploy, upgrade and observe.
9 changes: 9 additions & 0 deletions docs/.wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
addon
addons
Aether
AKS
AMF
APIs
AUSF
Expand All @@ -11,6 +12,7 @@ bessd
br
Bitrate
bootloader
Canonical
Charmhub
CharmHub
CIDR
Expand All @@ -22,18 +24,23 @@ coredns
Corefile
CPUs
CSR
deployable
DHCP
DN
dns
dnsmasq
DNS
enp
EKS
frictionless
gb
GCP
Gi
GiB
GKE
gnb
gNB
gNBs
gnbsim
Gnbsim
gNodeB
Expand Down Expand Up @@ -70,6 +77,7 @@ MetalLB
mgmt
microk
MicroK
Microk8s
MNC
Mongo
multipass
Expand All @@ -87,6 +95,7 @@ nms
NMS
NRF
NSSF
observability
Observability
OCI
ONF
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Charmed Aether SD-Core

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.
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).

Charmed Aether SD-Core automates the operations of Aether SD-Core, making it easy to deploy, upgrade and observe.
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.

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.
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 operators and all connectivity enthusiasts. Use it in your farm, mine or oil rig, wherever you need 5G connectivity.
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.

## In this documentation

Expand Down
5 changes: 3 additions & 2 deletions docs/reference/public_clouds.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Public Clouds

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.
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.

MicroK8s is the preferred Kubernetes distribution for SD-Core.
17 changes: 10 additions & 7 deletions docs/tutorials/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Getting started

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.

To complete this tutorial, you will need a machine which meets the following requirements:

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

Deploy 5G network.
Deploy SD-Core by applying your Terraform configuration:

```console
terraform apply -auto-approve
Expand Down
9 changes: 4 additions & 5 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

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

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
Along the way, they will give examples of good practice, and pointers to much
more detailed information.

You can expect to spend one to two hours working through the complete
Expand All @@ -16,8 +14,9 @@ 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
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.

## Table of content

Expand Down
Loading