Skip to content

Commit e1e16be

Browse files
efiacorlapentad
authored andcommitted
Fix invalid usecase cmds
Signed-off-by: Fiachra Corcoran <[email protected]>
1 parent 6b6652d commit e1e16be

File tree

3 files changed

+50
-15
lines changed

3 files changed

+50
-15
lines changed

content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 2
77

88
## Introduction
99

10-
Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md)
10+
Be sure you have followed the [installation guide](/docs/guides/install-guides/)
1111
before trying these exercises.
1212

1313
These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with:
@@ -270,8 +270,21 @@ regional-md-0-m6cr5-wtzlx regional 1 1 1 5m36s v1
270270

271271
Next, you can deploy two Edge clusters by applying the PackageVariantSet that can be found in the *tests* directory:
272272

273+
{{% alert title="Note" color="primary" %}}
274+
275+
Some of the KRM used in this guide forms part of the Nephio CI e2e test suites, which uses environment
276+
variable substitution. This requires the `BRANCH` environment variable to be set before applying the KRM to the cluster.
277+
278+
```bash
279+
export BRANCH=main
280+
```
281+
In the example above, we set the `BRANCH` to `main`.
282+
This should match the `NEPHIO_BRANCH` used during the [sandbox installation](/docs/guides/install-guides/).
283+
284+
{{% /alert %}}
285+
273286
```bash
274-
kubectl apply -f test-infra/e2e/tests/free5gc/002-edge-clusters.yaml
287+
envsubst < test-infra/e2e/tests/free5gc/002-edge-clusters.yaml | kubectl apply -f -
275288
```
276289

277290

@@ -378,7 +391,7 @@ specialization pipeline will determine the exact VLAN tags and IP addresses for
378391
clusters. There is a predefined PackageVariant in the tests directory for this:
379392

380393
```bash
381-
kubectl apply -f test-infra/e2e/tests/free5gc/002-network.yaml
394+
envsubst < test-infra/e2e/tests/free5gc/002-network.yaml | kubectl apply -f -
382395
```
383396

384397

@@ -526,7 +539,7 @@ added to the Management cluster when you had deployed the *nephio-workload-clust
526539
PackageVariantSet).
527540

528541
```bash
529-
kubectl apply -f test-infra/e2e/tests/free5gc/004-free5gc-operator.yaml
542+
envsubst < test-infra/e2e/tests/free5gc/004-free5gc-operator.yaml | kubectl apply -f -
530543
```
531544

532545

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

592605
```bash
593-
kubectl apply -f test-infra/e2e/tests/free5gc/005-edge-free5gc-upf.yaml
594-
kubectl apply -f test-infra/e2e/tests/free5gc/006-regional-free5gc-amf.yaml
595-
kubectl apply -f test-infra/e2e/tests/free5gc/006-regional-free5gc-smf.yaml
606+
envsubst < test-infra/e2e/tests/free5gc/005-edge-free5gc-upf.yaml | kubectl apply -f -
607+
envsubst < test-infra/e2e/tests/free5gc/006-regional-free5gc-amf.yaml | kubectl apply -f -
608+
envsubst < test-infra/e2e/tests/free5gc/006-regional-free5gc-smf.yaml | kubectl apply -f -
596609
```
597610

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

784797
```bash
785-
kubectl apply -f test-infra/e2e/tests/free5gc/007-edge01-ueransim.yaml
798+
envsubst < test-infra/e2e/tests/free5gc/007-edge01-ueransim.yaml | kubectl apply -f -
786799
```
787800

788801
You can check to see if the simulated UE is up and running by checking the UERANSIM deployment. First, you can use the

content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,21 @@ oai-core-packages git Package false True https://github
7979

8080
Since those are Ready, you can deploy packages from these repositories. You can use our pre-defined *PackageVariantSets* for creating workload clusters
8181

82+
{{% alert title="Note" color="primary" %}}
83+
84+
Some of the KRM used in this guide forms part of the Nephio CI e2e test suites, which uses environment
85+
variable substitution. This requires the `BRANCH` environment variable to be set before applying the KRM to the cluster.
86+
87+
```bash
88+
export BRANCH=main
89+
```
90+
In the example above, we set the `BRANCH` to `main`.
91+
This should match the `NEPHIO_BRANCH` used during the [sandbox installation](/docs/guides/install-guides/).
92+
93+
{{% /alert %}}
94+
8295
```bash
83-
kubectl apply -f test-infra/e2e/tests/oai/001-infra.yaml
96+
envsubst < test-infra/e2e/tests/oai/001-infra.yaml | kubectl apply -f -
8497
```
8598

8699

@@ -231,7 +244,7 @@ First, you will apply a package to define the high-level networks for attaching
231244
clusters. There is a predefined *PackageVariant* in the tests directory for this:
232245

233246
```bash
234-
kubectl apply -f test-infra/e2e/tests/oai/001-network.yaml
247+
envsubst < test-infra/e2e/tests/oai/001-network.yaml | kubectl apply -f -
235248
```
236249

237250

@@ -342,8 +355,8 @@ packagerevision.porch.kpt.dev/mgmt-staging-f1b8e75b6c87549d67037f784abc0083ac601
342355
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*).
343356

344357
```bash
345-
kubectl apply -f test-infra/e2e/tests/oai/002-database.yaml
346-
kubectl apply -f test-infra/e2e/tests/oai/002-operators.yaml
358+
envsubst < test-infra/e2e/tests/oai/002-database.yaml | kubectl apply -f -
359+
envsubst < test-infra/e2e/tests/oai/002-operators.yaml | kubectl apply -f -
347360
```
348361

349362

@@ -489,7 +502,7 @@ You can start by deploying the core network functions which the operator will in
489502
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.
490503

491504
```bash
492-
kubectl create -f test-infra/e2e/tests/oai/003-core-network.yaml
505+
envsubst < test-infra/e2e/tests/oai/003-core-network.yaml | kubectl apply -f -
493506
```
494507

495508
The output is similar to:
@@ -589,7 +602,8 @@ In the logs you should see **Received SX HEARTBEAT REQUEST** statement. If that
589602
If the core network functions are running and configured properly then you can start by deploying RAN network function *PackageVariants*.
590603

591604
```bash
592-
kubectl create -f test-infra/e2e/tests/oai/004-ran-network.yaml
605+
envsubst < test-infra/e2e/tests/oai/004a-ran-network.yaml | kubectl apply -f -
606+
envsubst < test-infra/e2e/tests/oai/004b-ran-network.yaml | kubectl apply -f -
593607
```
594608

595609
The output is similar to:
@@ -690,7 +704,7 @@ The output is similar to:
690704
If all three links are configured then you can proceed with deploying the UE *PackageVariants*
691705

692706
```bash
693-
kubectl create -f test-infra/e2e/tests/oai/005-ue.yaml
707+
envsubst < test-infra/e2e/tests/oai/005-ue.yaml | kubectl apply -f -
694708
```
695709

696710
The output is similar to:

go.sum

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2+
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
3+
github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4=
4+
github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM=
5+
github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI=
6+
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
7+
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
8+
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

0 commit comments

Comments
 (0)