Skip to content

Commit

Permalink
feat: Adding UPF Machine charm howto
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Beierl committed Jun 6, 2024
1 parent 715ece3 commit 9ba1041
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/how-to/deploy_sdcore_upf_machine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Deploy SD-Core User Plane Machine

This guide covers how to deploy the User Plane Function (UPF) as a machine charm.

## Requirements

- A host with a CPU supporting AVX2 and RDRAND instructions (Intel Haswell, AMD Excavator or equivalent)
- [Juju][Juju] controller bootstrapped to a LXD cluster
- A Juju machine manually representing the host added to the controller
- [Terraform][Terraform] installed
- Git

## Deploy

Get Charmed Aether SD-Core Terraform UPF Machine module by cloning the [Charmed Aether SD-Core UPF module][Charmed Aether SD-Core UPF modules] Git repository. Inside the `terraform` directory, create a `terraform.tfvars` file to set the name of Juju model and machine number for the deployment:

```console
git clone https://github.com/canonical/sdcore-upf-operator.git
cd terraform

cat << EOF > terraform.tfvars
machine_number = 0
model_name = "user-plane"
EOF
```

Initialize Juju Terraform provider:

```console
terraform init
```

Deploy the machine charm to the machine number specified in the `terraform.tfvars` file.

```console
terraform apply -var-file="terraform.tfvars" -auto-approve
```

[Terraform]: https://www.terraform.io/
[Juju]: https://juju.is
1 change: 1 addition & 0 deletions docs/how-to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ These how-to guides cover key operations and processes in Charmed Aether SD-Core
deploy_sdcore_standalone
deploy_sdcore_cups
deploy_sdcore_gnbsim
deploy_sdcore_upf_machine
deploy_sdcore_user_plane_in_dpdk_mode
integrate_sdcore_with_external_gnb
integrate_sdcore_with_observability
Expand Down

0 comments on commit 9ba1041

Please sign in to comment.