Skip to content
This repository was archived by the owner on Mar 11, 2026. It is now read-only.

Commit 43427f3

Browse files
authored
docs(deploy): standardize installation and uninstallation terminology in README files (#168)
* docs(deploy): standardize installation and uninstallation terminology in README files - update terminology for installation and uninstallation processes - clarify cleanup and destroy definitions - improve consistency in documentation language 📝 - Generated by Copilot * docs(deploy): standardize cleanup and destruction terminology in README - clarify cleanup steps for cluster components - update descriptions for destroying infrastructure 🗑️ - Generated by Copilot * docs(deploy): update destruction steps in README for clarity - specify order of destroying VPN and remaining infrastructure - improve instructions for resource group deletion 🔧 - Generated by Copilot * docs(deploy): remove reference to terminology glossary in deployment description 🔒 - Generated by Copilot
1 parent 311886c commit 43427f3

3 files changed

Lines changed: 35 additions & 24 deletions

File tree

deploy/001-iac/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Terraform configuration for the robotics reference architecture. Deploys Azure r
44

55
## 📋 Prerequisites
66

7-
| Tool | Version | Installation |
7+
| Tool | Version | Setup or Check |
88
|--------------|-----------------|---------------------------------|
99
| Azure CLI | Latest | `az login` |
1010
| Terraform | 1.5+ | `terraform version` |
@@ -322,7 +322,7 @@ az group delete --name <resource-group-name> --yes --no-wait
322322

323323
## 🔍 Troubleshooting
324324

325-
Issues and resolutions encountered during infrastructure deployment and teardown.
325+
Issues and resolutions encountered during infrastructure deployment and destroy.
326326

327327
### Destroy Takes a Long Time
328328

deploy/002-setup/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ kubectl describe sa osmo-service -n osmo-control-plane
330330
├── 02-deploy-azureml-extension.sh
331331
├── 03-deploy-osmo-control-plane.sh
332332
├── 04-deploy-osmo-backend.sh
333-
├── cleanup/ # Uninstall scripts
333+
├── cleanup/ # Cleanup scripts
334334
├── config/ # OSMO configuration templates
335335
├── lib/ # Shared functions
336336
├── manifests/ # Kubernetes manifests
@@ -343,12 +343,12 @@ kubectl describe sa osmo-service -n osmo-control-plane
343343
| Script | Purpose |
344344
|-------------------------------------------|------------------------------|
345345
| `optional/deploy-volcano-scheduler.sh` | Volcano (alternative to KAI) |
346-
| `optional/uninstall-volcano-scheduler.sh` | Remove Volcano scheduler |
346+
| `optional/uninstall-volcano-scheduler.sh` | Uninstall Volcano scheduler |
347347
| `optional/add-user-to-platform.sh` | Add user to OSMO platform |
348348

349349
## 🗑️ Cleanup
350350

351-
Uninstall scripts in `cleanup/` remove cluster components in reverse deployment order.
351+
Cleanup scripts in `cleanup/` uninstall cluster components in reverse deployment order.
352352

353353
### Cleanup Scripts
354354

@@ -359,9 +359,9 @@ Uninstall scripts in `cleanup/` remove cluster components in reverse deployment
359359
| `cleanup/uninstall-azureml-extension.sh` | ML extension, compute target, FICs |
360360
| `cleanup/uninstall-robotics-charts.sh` | GPU Operator, KAI Scheduler |
361361

362-
### Uninstall Order
362+
### Cleanup Order
363363

364-
Run scripts in this order to avoid dependency issues:
364+
Run uninstall scripts in this order to avoid dependency issues:
365365

366366
```bash
367367
cd cleanup
@@ -394,7 +394,7 @@ By default, uninstall scripts preserve data. Use flags for complete removal:
394394

395395
### Full Component Cleanup
396396

397-
Remove everything including data:
397+
Clean up everything including data:
398398

399399
```bash
400400
cd cleanup
@@ -406,7 +406,7 @@ cd cleanup
406406

407407
### Selective Cleanup
408408

409-
Remove only specific components:
409+
Clean up only specific components:
410410

411411
```bash
412412
# OSMO only (preserve AzureML and GPU infrastructure)

deploy/README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
Infrastructure deployment and cluster configuration for the robotics reference architecture.
44

5+
## 📖 Terminology Glossary
6+
7+
| Term | Definition |
8+
| --- | --- |
9+
| Deploy | Provision Azure infrastructure or install cluster components using Terraform or deployment scripts. |
10+
| Setup | Post-deploy configuration and access steps for the cluster and workloads. |
11+
| Install | Install local client tools or CLIs (for example, Azure VPN Client). |
12+
| Cleanup | Remove cluster components while keeping Azure infrastructure intact. |
13+
| Uninstall | Run uninstall scripts that remove deployed cluster components. |
14+
| Destroy | Delete Azure infrastructure (Terraform destroy or resource group deletion). |
15+
| Teardown | Avoid in docs; use Destroy for infrastructure removal. |
16+
517
## 📋 Deployment Order
618

719
| Step | Folder | Description | Time |
@@ -83,17 +95,15 @@ See the [root README](../README.md) for architecture details.
8395

8496
## 🗑️ Cleanup
8597

86-
Remove deployed components in reverse order. Cluster components must be removed before infrastructure.
98+
Remove deployed cluster components. Use [Destroy Infrastructure](#destroy-infrastructure) for VPN and Terraform removal.
8799

88-
| Step | Folder | Description | Time |
89-
|:----:|-----------------------------------------|-----------------------------------------------|-----------|
90-
| 1 | [002-setup/cleanup](002-setup/cleanup/) | Uninstall Helm charts, extensions, namespaces | 10-15 min |
91-
| 2 | [001-iac/vpn](001-iac/vpn/) | Destroy VPN Gateway | 10-15 min |
92-
| 3 | [001-iac](001-iac/) | Terraform destroy or resource group deletion | 20-30 min |
100+
| Folder | Description | Time |
101+
|-----------------------------------------|-----------------------------------------------|-----------|
102+
| [002-setup/cleanup](002-setup/cleanup/) | Uninstall Helm charts, extensions, namespaces | 10-15 min |
93103

94-
### Partial Cleanup (Cluster Components Only)
104+
### Cleanup Steps (Cluster Components)
95105

96-
Remove OSMO, AzureML, and GPU components while preserving Azure infrastructure:
106+
Clean up OSMO, AzureML, and GPU components while preserving Azure infrastructure:
97107

98108
```bash
99109
cd 002-setup/cleanup
@@ -107,26 +117,27 @@ cd 002-setup/cleanup
107117

108118
See [002-setup/README.md](002-setup/README.md#cleanup) for script options and data preservation.
109119

110-
### Full Teardown
120+
### Destroy Infrastructure
111121

112-
Remove all Azure resources. Choose based on how infrastructure was created.
122+
Destroy all Azure resources after cleanup. This removes VPN and Terraform-managed infrastructure.
113123

114124
**Option A: Terraform Destroy** (recommended if using Terraform state)
115125

116126
```bash
117-
# Remove cluster components first
127+
# Clean up cluster components first
118128
cd 002-setup/cleanup
119129
./uninstall-osmo-backend.sh --delete-container
120130
./uninstall-osmo-control-plane.sh --purge-postgres --purge-redis --delete-mek
121131
./uninstall-azureml-extension.sh
122132
./uninstall-robotics-charts.sh --delete-namespaces --delete-crds
123133

124-
# Destroy infrastructure
125-
cd ../../001-iac
134+
# Destroy VPN first (if deployed)
135+
cd ../../001-iac/vpn
126136
terraform destroy -var-file=terraform.tfvars
127137

128-
# Optional: destroy VPN if deployed
129-
cd vpn && terraform destroy -var-file=terraform.tfvars
138+
# Destroy remaining infrastructure
139+
cd ..
140+
terraform destroy -var-file=terraform.tfvars
130141
```
131142

132143
**Option B: Delete Resource Group** (fastest, deletes everything)

0 commit comments

Comments
 (0)