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: Updating docs to reflect 1.4/beta #7

Merged
merged 2 commits into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

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 is 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, making it easy to deploy, upgrade and observe.
4 changes: 3 additions & 1 deletion docs/how-to/deploy_sdcore_cups.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Inside the `modules/sdcore-control-plane-k8s` directory, create a `control-plane

```console
git clone https://github.com/canonical/terraform-juju-sdcore-k8s.git
git checkout v1.4
cd terraform-juju-sdcore-k8s/modules/sdcore-control-plane-k8s
cat << EOF > control-plane.tfvars
model_name = "control-plane"
Expand Down Expand Up @@ -139,6 +140,7 @@ Inside the `modules/sdcore-user-plane-k8s` directory, create a `user-plane.tfvar

```console
git clone https://github.com/canonical/terraform-juju-sdcore-k8s.git
git checkout v1.4
cd terraform-juju-sdcore-k8s/modules/sdcore-user-plane-k8s
cat << EOF > user-plane.tfvars
model_name = "user-plane"
Expand Down Expand Up @@ -241,4 +243,4 @@ terraform apply -auto-approve

``````

[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s
[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4
2 changes: 1 addition & 1 deletion docs/how-to/deploy_sdcore_gnbsim.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ juju add-model gnbsim gnbsim-cloud
Deploy the `sdcore-gnbsim-k8s` operator charm.

```console
juju deploy sdcore-gnbsim-k8s gnbsim --trust --channel=1.4/edge \
juju deploy sdcore-gnbsim-k8s gnbsim --trust --channel=1.4/beta \
--config gnb-interface=ran \
--config gnb-ip-address=10.204.0.10/24 \
--config icmp-packet-destination=8.8.8.8 \
Expand Down
3 changes: 2 additions & 1 deletion docs/how-to/deploy_sdcore_standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Inside the `modules/sdcore-k8s` directory, create a `terraform.tfvars` file to s

```console
git clone https://github.com/canonical/terraform-juju-sdcore-k8s.git
git checkout v1.4
cd terraform-juju-sdcore-k8s/modules/sdcore-k8s
cat << EOF > terraform.tfvars
model_name = "<YOUR_JUJU_MODEL_NAME>"
Expand Down Expand Up @@ -62,4 +63,4 @@ To be effective, every configuration change needs to be applied using the follow
terraform apply -var-file="terraform.tfvars" -auto-approve
```

[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s
[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4
2 changes: 1 addition & 1 deletion docs/how-to/integrate_sdcore_with_observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ Click on "Dashboards" -> "Browse" and select "5G Network Overview".
:align: center
```

[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s
[Charmed Aether SD-Core Terraform modules]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/deployment_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ Terraform module to deploy the 5G user plane in edge sites.

`````

[sdcore-k8s-terraform]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/main/modules/sdcore-k8s
[sdcore-control-plane-k8s]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/main/modules/sdcore-control-plane-k8s
[sdcore-user-plane-k8s]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/main/modules/sdcore-user-plane-k8s
[sdcore-k8s-terraform]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4/modules/sdcore-k8s
[sdcore-control-plane-k8s]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4/modules/sdcore-control-plane-k8s
[sdcore-user-plane-k8s]: https://github.com/canonical/terraform-juju-sdcore-k8s/tree/v1.4/modules/sdcore-user-plane-k8s
2 changes: 1 addition & 1 deletion docs/reference/public_clouds.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

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.
54 changes: 28 additions & 26 deletions docs/tutorials/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,15 @@ resource "juju_model" "sdcore" {
}

module "sdcore-router" {
source = "git::https://github.com/canonical/sdcore-router-k8s-operator//terraform"
source = "git::https://github.com/canonical/sdcore-router-k8s-operator//terraform?ref=v1.4"
channel = "1.4/beta"

model_name = juju_model.sdcore.name
depends_on = [juju_model.sdcore]
}

module "sdcore" {
source = "git::https://github.com/canonical/terraform-juju-sdcore-k8s//modules/sdcore-k8s"
source = "git::https://github.com/canonical/terraform-juju-sdcore-k8s//modules/sdcore-k8s?ref=v1.4"

model_name = juju_model.sdcore.name
create_model = false
Expand All @@ -127,7 +128,8 @@ module "sdcore" {
}

module "gnbsim" {
source = "git::https://github.com/canonical/sdcore-gnbsim-k8s-operator//terraform"
source = "git::https://github.com/canonical/sdcore-gnbsim-k8s-operator//terraform?ref=v1.4"
channel = "1.4/beta"

model_name = juju_model.sdcore.name
depends_on = [module.sdcore-router]
Expand Down Expand Up @@ -164,7 +166,7 @@ EOF
```

```{note}
You can get a ready example by cloning [this Git repository](https://github.com/canonical/charmed-aether-sd-core).
You can get a ready example by cloning [this Git repository](https://github.com/canonical/charmed-aether-sd-core) and switching to the `v1.4` branch.
All necessary files are in the `examples/terraform/getting_started` directory.
```

Expand Down Expand Up @@ -196,27 +198,27 @@ for `grafana-agent` to remain in waiting state. Example:

```console
ubuntu@host:~$ juju status
Model Controller Cloud/Region Version SLA Timestamp
sdcore microk8s-localhost microk8s/localhost 3.4.0 unsupported 13:40:12+01:00

App Version Status Scale Charm Channel Rev Address Exposed Message
amf active 1 sdcore-amf-k8s 1.4/edge 57 10.152.183.208 no
ausf active 1 sdcore-ausf-k8s 1.4/edge 40 10.152.183.237 no
gnbsim active 1 sdcore-gnbsim-k8s 1.4/edge 43 10.152.183.167 no
grafana-agent 0.32.1 waiting 1 grafana-agent-k8s latest/stable 44 10.152.183.245 no installing agent
mongodb active 1 mongodb-k8s 6/beta 36 10.152.183.156 no Primary
nms active 1 sdcore-nms-k8s 0.2/edge 26 10.152.183.121 no
nrf active 1 sdcore-nrf-k8s 1.4/edge 62 10.152.183.123 no
nssf active 1 sdcore-nssf-k8s 1.4/edge 37 10.152.183.165 no
pcf active 1 sdcore-pcf-k8s 1.4/edge 32 10.152.183.205 no
router active 1 sdcore-router-k8s 1.4/edge 33 10.152.183.49 no
self-signed-certificates active 1 self-signed-certificates 1.4/edge 33 10.152.183.153 no
smf active 1 sdcore-smf-k8s 1.4/edge 37 10.152.183.147 no
traefik 2.10.4 active 1 traefik-k8s latest/stable 148 10.0.0.4 no
udm active 1 sdcore-udm-k8s 1.4/edge 35 10.152.183.168 no
udr active 1 sdcore-udr-k8s 1.4/edge 31 10.152.183.96 no
upf active 1 sdcore-upf-k8s 1.4/edge 64 10.152.183.126 no
webui active 1 sdcore-webui-k8s 1.4/edge 23 10.152.183.128 no
Model Controller Cloud/Region Version SLA Timestamp
sdcore microk8s-localhost microk8s/localhost 3.4.2 unsupported 10:15:12+02:00

App Version Status Scale Charm Channel Rev Address Exposed Message
amf active 1 sdcore-amf-k8s 1.4/beta 160 10.152.183.64 no
ausf active 1 sdcore-ausf-k8s 1.4/beta 139 10.152.183.140 no
gnbsim active 1 sdcore-gnbsim-k8s 1.4/beta 108 10.152.183.197 no
grafana-agent 0.35.2 waiting 1 grafana-agent-k8s latest/stable 64 10.152.183.105 no installing agent
mongodb active 1 mongodb-k8s 6/beta 38 10.152.183.55 no Primary
nms active 1 sdcore-nms-k8s 1.4/beta 127 10.152.183.220 no
nrf active 1 sdcore-nrf-k8s 1.4/beta 142 10.152.183.226 no
nssf active 1 sdcore-nssf-k8s 1.4/beta 116 10.152.183.222 no
pcf active 1 sdcore-pcf-k8s 1.4/beta 120 10.152.183.94 no
router active 1 sdcore-router-k8s 1.4/beta 109 10.152.183.203 no
self-signed-certificates active 1 self-signed-certificates latest/stable 72 10.152.183.210 no
smf active 1 sdcore-smf-k8s 1.4/beta 134 10.152.183.125 no
traefik v2.11.0 active 1 traefik-k8s latest/stable 176 10.0.0.3 no
udm active 1 sdcore-udm-k8s 1.4/beta 104 10.152.183.111 no
udr active 1 sdcore-udr-k8s 1.4/beta 114 10.152.183.162 no
upf active 1 sdcore-upf-k8s 1.4/beta 161 10.152.183.254 no
webui active 1 sdcore-webui-k8s 1.4/beta 86 10.152.183.53 no

Unit Workload Agent Address Ports Message
amf/0* active idle 10.1.182.23
Expand Down Expand Up @@ -277,7 +279,7 @@ Retrieve the NMS address:
juju run traefik/0 show-proxied-endpoints
```

The output should be `http://sdcore-nms.10.0.0.4.nip.io/`. Navigate to this address in your
The output should be `https://sdcore-nms.10.0.0.4.nip.io/`. Navigate to this address in your
browser.


Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Charmed Aether SD-Core - it will save you many more hours later on. Follow the
tutorials steps in sequence; they take you on a learning journey through the
product.

The tutorials has been tested with a variety of users. We make every effort to
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.

Expand Down
Loading