From 9ba10415eb70bc7359665e469b010cc7257167e0 Mon Sep 17 00:00:00 2001
From: Mark Beierl <mark.beierl@canonical.com>
Date: Thu, 6 Jun 2024 10:41:53 -0400
Subject: [PATCH] feat: Adding UPF Machine charm howto

---
 docs/how-to/deploy_sdcore_upf_machine.md | 40 ++++++++++++++++++++++++
 docs/how-to/index.md                     |  1 +
 2 files changed, 41 insertions(+)
 create mode 100644 docs/how-to/deploy_sdcore_upf_machine.md

diff --git a/docs/how-to/deploy_sdcore_upf_machine.md b/docs/how-to/deploy_sdcore_upf_machine.md
new file mode 100644
index 0000000..c7a8cb2
--- /dev/null
+++ b/docs/how-to/deploy_sdcore_upf_machine.md
@@ -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
diff --git a/docs/how-to/index.md b/docs/how-to/index.md
index 667f17d..41e76c8 100644
--- a/docs/how-to/index.md
+++ b/docs/how-to/index.md
@@ -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