Skip to content

update oai and free5gc exercises #307

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.

Sign up for GitHub

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

Open
Noisyboy-9 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update oai and free5gc exercises #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 19 additions & 11 deletions content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ regional-md-0-m6cr5-wtzlx regional 1 1 1 5m36s v1

## Step 3: Deploy two Edge clusters

Next, you can deploy two Edge clusters by applying the PackageVariantSet that can be found in the *tests* directory:
Next, you can deploy two Edge clusters by applying the PackageVariantSet from the catalog's Free5GC test-resource package:

{{% alert title="Note" color="primary" %}}

Expand All @@ -283,8 +283,17 @@ This should match the `NEPHIO_BRANCH` used during the [sandbox installation](/do

{{% /alert %}}

Fetch the resources once; the remaining commands in this guide use this local copy.

```bash
envsubst < test-infra/e2e/tests/free5gc/002-edge-clusters.yaml | kubectl apply -f -
FREE5GC_RESDIR="$(mktemp -d -t free5gc-e2e-resources)"
kpt pkg get --for-deployment \
"https://github.com/nephio-project/catalog.git/test-infra-resources/free5gc@${BRANCH}" \
"${FREE5GC_RESDIR}"
```

```bash
envsubst < "${FREE5GC_RESDIR}/002-edge-clusters.yaml" | kubectl apply -f -
```


Expand Down Expand Up @@ -388,10 +397,10 @@ can interact with external systems to fully configure packages. But it needs to

First, you will apply a package to define the high-level networks for attaching our workloads. The Nephio package
specialization pipeline will determine the exact VLAN tags and IP addresses for those attachments based on the specific
clusters. There is a predefined PackageVariant in the tests directory for this:
clusters. There is a predefined PackageVariant in the catalog test-resource package for this:

```bash
envsubst < test-infra/e2e/tests/free5gc/002-network.yaml | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/002-network.yaml" | kubectl apply -f -
```


Expand All @@ -405,7 +414,7 @@ packagevariant.config.porch.kpt.dev/network created
Then you will create appropriate Secret to make sure that Nephio can authenticate to the external backend.

```bash
kubectl apply -f test-infra/e2e/tests/free5gc/002-secret.yaml
kubectl apply -f "${FREE5GC_RESDIR}/002-secret.yaml"
```


Expand Down Expand Up @@ -539,7 +548,7 @@ added to the Management cluster when you had deployed the *nephio-workload-clust
PackageVariantSet).

```bash
envsubst < test-infra/e2e/tests/free5gc/004-free5gc-operator.yaml | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/004-free5gc-operator.yaml" | kubectl apply -f -
```


Expand Down Expand Up @@ -603,9 +612,9 @@ yet-another-package - a "topology" package - and deploy them all as a unit. Or y
create them. But for now, let's do each manually.

```bash
envsubst < test-infra/e2e/tests/free5gc/005-edge-free5gc-upf.yaml | kubectl apply -f -
envsubst < test-infra/e2e/tests/free5gc/006-regional-free5gc-amf.yaml | kubectl apply -f -
envsubst < test-infra/e2e/tests/free5gc/006-regional-free5gc-smf.yaml | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/005-edge-free5gc-upf.yaml" | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/006-regional-free5gc-amf.yaml" | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/006-regional-free5gc-smf.yaml" | kubectl apply -f -
```

Free5gc requires that the SMF and AMF NFs be explicitly configured with information about each UPF. Therefore, the AMF
Expand Down Expand Up @@ -795,7 +804,7 @@ Step 4.
Once the subscriber is registered, you can deploy UERANSIM:

```bash
envsubst < test-infra/e2e/tests/free5gc/007-edge01-ueransim.yaml | kubectl apply -f -
envsubst < "${FREE5GC_RESDIR}/007-edge01-ueransim.yaml" | kubectl apply -f -
```

You can check to see if the simulated UE is up and running by checking the UERANSIM deployment. First, you can use the
Expand Down Expand Up @@ -1070,4 +1079,3 @@ not reflect the new information. This is because the Nephio free5gc operator is
configuration.

{{% /alert %}}

28 changes: 18 additions & 10 deletions content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,17 @@ This should match the `NEPHIO_BRANCH` used during the [sandbox installation](/do

{{% /alert %}}

Fetch the resources once; the remaining commands in this guide use this local copy.

```bash
envsubst < test-infra/e2e/tests/oai/001-infra.yaml | kubectl apply -f -
OAI_RESDIR="$(mktemp -d -t oai-e2e-resources)"
kpt pkg get --for-deployment \
"https://github.com/nephio-project/catalog.git/test-infra-resources/oai@${BRANCH}" \
"${OAI_RESDIR}"
```

```bash
envsubst < "${OAI_RESDIR}/001-infra.yaml" | kubectl apply -f -
```


Expand Down Expand Up @@ -242,10 +250,10 @@ worker nodes.
Finally, you want to configure the resource backend to be aware of these clusters. The resource backend is an IP address and VLAN index management system. It is included for demonstration purposes to show how Nephio package specialization can interact with external systems to fully configure packages. But it needs to be configured to match our topology.

First, you will apply a package to define the high-level networks for attaching our workloads. The Nephio package specialization pipeline will determine the exact VLAN tags and IP addresses for those attachments based on the specific
clusters. There is a predefined *PackageVariant* in the tests directory for this:
clusters. There is a predefined *PackageVariant* in the catalog test-resource package for this:

```bash
envsubst < test-infra/e2e/tests/oai/001-network.yaml | kubectl apply -f -
envsubst < "${OAI_RESDIR}/001-network.yaml" | kubectl apply -f -
```


Expand All @@ -259,7 +267,7 @@ packagevariant.config.porch.kpt.dev/network created
Then you will create appropriate `Secret` to make sure that Nephio can authenticate to the external backend.

```bash
kubectl apply -f test-infra/e2e/tests/oai/001-secret.yaml
kubectl apply -f "${OAI_RESDIR}/001-secret.yaml"
```


Expand Down Expand Up @@ -356,8 +364,8 @@ packagerevision.porch.kpt.dev/mgmt-staging-f1b8e75b6c87549d67037f784abc0083ac601
Now you will need to deploy the MySQL database required by OAI UDR network function, OAI Core and RAN operators across the Workload clusters. To do this, you use *PackageVariant* and *PackageVariantSet*. Later uses an objectSelector to select the WorkloadCluster resources previously added to the Management cluster when you had deployed the *nephio-workload-cluster* packages (manually as well as via *PackageVariantSet*).

```bash
envsubst < test-infra/e2e/tests/oai/002-database.yaml | kubectl apply -f -
envsubst < test-infra/e2e/tests/oai/002-operators.yaml | kubectl apply -f -
envsubst < "${OAI_RESDIR}/002-database.yaml" | kubectl apply -f -
envsubst < "${OAI_RESDIR}/002-operators.yaml" | kubectl apply -f -
```


Expand Down Expand Up @@ -503,7 +511,7 @@ You can start by deploying the core network functions which the operator will in
yet-another-package - a "topology" package - and deploy them all as a unit. Or you can use a topology controller to create them. But for now, let's do each manually.

```bash
envsubst < test-infra/e2e/tests/oai/003-core-network.yaml | kubectl apply -f -
envsubst < "${OAI_RESDIR}/003-core-network.yaml" | kubectl apply -f -
```

The output is similar to:
Expand Down Expand Up @@ -603,8 +611,8 @@ In the logs you should see **Received SX HEARTBEAT REQUEST** statement. If that
If the core network functions are running and configured properly then you can start by deploying RAN network function *PackageVariants*.

```bash
envsubst < test-infra/e2e/tests/oai/004a-ran-network.yaml | kubectl apply -f -
envsubst < test-infra/e2e/tests/oai/004b-ran-network.yaml | kubectl apply -f -
envsubst < "${OAI_RESDIR}/004a-ran-network.yaml" | kubectl apply -f -
envsubst < "${OAI_RESDIR}/004b-ran-network.yaml" | kubectl apply -f -
```

The output is similar to:
Expand Down Expand Up @@ -705,7 +713,7 @@ The output is similar to:
If all three links are configured then you can proceed with deploying the UE *PackageVariants*

```bash
envsubst < test-infra/e2e/tests/oai/005-ue.yaml | kubectl apply -f -
envsubst < "${OAI_RESDIR}/005-ue.yaml" | kubectl apply -f -
```

The output is similar to:
Expand Down