Skip to content

Commit 0bf3024

Browse files
author
Harika
committed
update iso readme
Signed-off-by: Harika <codewith3@gmail.com>
1 parent 91bdb67 commit 0bf3024

2 files changed

Lines changed: 33 additions & 42 deletions

File tree

third_party/Dell/ubuntu-22.04/iac/README.md

Lines changed: 27 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,23 @@ The solution cleanly separates:
1414

1515
**Script:** [custom-iso.sh](./iso/custom-iso.sh)
1616

17-
Before mounting the Ubuntu ISO to iDRAC, you may optionally generate a custom Ubuntu 22.04.5 ISO designed for fully unattended installation.
17+
> Note: If you already have a prebuilt ISO hosted and accessible via HTTP/HTTPS, you may skip this step and proceed to Step 1: Mount Ubuntu ISO.
1818
19-
This enables a zero-touch, fully automated OS installation, eliminating manual input during setup and ensuring consistent, repeatable provisioning.
19+
Before mounting the Ubuntu ISO to iDRAC, generate a custom Ubuntu 22.04.5 ISO designed for zero-touch, fully automated OS installation, eliminating manual input during setup and ensuring consistent, repeatable provisioning.
2020

21-
**Host Your Custom ISO (Recommended for Automation)**
22-
23-
After generating the ISO:
24-
25-
1. Upload it to a web-accessible location (e.g., Firebase Hosting, internal web server, object storage, or any HTTP/HTTPS file server).
21+
For detailed instructions on building a custom ISO, refer to: [ISO Creation Guide](./iso/README.md)
2622

27-
2. Ensure the ISO is reachable via a public or internally accessible HTTP/HTTPS URL.
23+
### Host Your Custom ISO (Recommended for Automation)
2824

29-
3. Save this URL — it will be required in the next step when mounting the ISO using iDRAC Redfish Virtual Media.
25+
After generating the ISO:
26+
- Upload it to a web-accessible location (e.g., internal or external web server, object storage, or any HTTP/HTTPS file server).
27+
- Ensure the ISO is reachable via a public or internally accessible HTTP/HTTPS URL.
28+
- Save this URL, it will be required in the next step when mounting the ISO using iDRAC Redfish Virtual Media.
3029

3130
Example:
3231
```bash
3332
https://your-domain.com/ubuntu-22.04.5-custom.iso
3433
```
35-
36-
If you already have a prebuilt ISO hosted and accessible via HTTP/HTTPS, you may skip this step and proceed to Step 1: Mount Ubuntu ISO.
37-
38-
For detailed instructions on building a custom ISO, refer to: [ISO Creation Guide](./iso/README.md)
39-
4034
---
4135

4236
## 1. Mount Ubuntu ISO (iDRAC Redfish)
@@ -48,7 +42,7 @@ This script mounts or unmounts the **Ubuntu 22.04.5 live server ISO** using the
4842
- Mount ISO
4943
- Idempotent (skips if already mounted)
5044

51-
**Required Environment Variables**
45+
### Required Environment Variables
5246
```bash
5347
export IDRAC_IP=100.67.x.x
5448
export IDRAC_USER=root
@@ -67,37 +61,37 @@ You may also use any internally hosted ISO that is reachable by iDRAC.
6761

6862
> Note: If ISO_URL is not provided, the script will automatically use the default Ubuntu 22.04 Live Server ISO. it will Launch the standard installer and Prompt for manual user input during OS installation.
6963
70-
**Mount ISO**
64+
### Mount ISO
7165
```bash
7266
chmod +x mount-iso.sh
7367
./mount-iso.sh
7468
```
7569
---
7670

77-
## 2.Boot Ubuntu Installer (Terraform + Redfish)
71+
## 2. Boot Ubuntu Installer (Terraform + Redfish)
7872

7973
**Script:** [iac/main.tf](./main.tf)
8074

8175
Terraform uses the **Dell Redfish provider** to configure a **one-time boot from Virtual Media (CD)** and **force a reboot**.
8276

83-
**Terraform Installation (Client Machine)**
77+
### Terraform Installation (Client Machine)
8478

8579
Terraform is executed from a client machine (such as your laptop or a jump host), not from the target server or iDRAC.
8680

87-
Install Terraform on the machine where you will run the Terraform commands.
81+
Install Terraform on the machine where you will run the Terraform , if terraform is not already installed.
8882

89-
**Download Terraform:**
83+
- **Download Terraform:**
9084
https://developer.hashicorp.com/terraform/install
9185

9286
Choose the package for your operating system and follow the installation instructions.
9387

94-
**Verify Installation**
88+
- **Verify Installation**
9589
```bash
9690
terraform version
9791
```
9892
Terraform should return a version without errors. If Terraform is not found, ensure the installation directory is added to your system PATH.
9993

100-
**Terraform Variables**
94+
### Terraform Variables
10195

10296
The following variables must be explicitly provided in 'terraform.tfvars' for the Ubuntu installer boot workflow to function correctly.
10397

@@ -114,7 +108,7 @@ ubuntu_username = "user"
114108
ubuntu_password = "password"
115109
```
116110

117-
**Apply Terraform**
111+
### Apply Terraform
118112
```bash
119113
terraform init
120114
terraform apply
@@ -133,12 +127,12 @@ Once OS is installed, Download the deploy-enterprise-inference.sh script to your
133127

134128
This script performs **all post-OS configuration** and deploys the **Enterprise Inference stack** on a **single node**.
135129

136-
**Change permission to your file**
130+
### Change permission to your file
137131

138132
```bash
139133
chmod +x deploy-enterprise-inference.sh
140134
```
141-
**Required Parameters to run the script**
135+
### Run the script
142136

143137
```bash
144138
sudo ./deploy-enterprise-inference.sh \
@@ -149,7 +143,7 @@ sudo ./deploy-enterprise-inference.sh \
149143
-a cluster-url \
150144
-m "1" \
151145
```
152-
### Options & Defaults
146+
**Options & Defaults**
153147

154148
| Option | Required | Default | Description |
155149
|--------|----------|----------|-------------|
@@ -192,10 +186,7 @@ sudo ./deploy-enterprise-inference.sh -u user uninstall
192186

193187
**State is tracked in:**
194188

195-
Deployment progress is tracked using a local state file:
196-
```bash
197-
/tmp/ei-deploy.state
198-
```
189+
Deployment progress is tracked using a local state file: `/tmp/ei-deploy.state`
199190

200191
**What the Deployment Script Does**
201192

@@ -215,7 +206,7 @@ Deployment progress is tracked using a local state file:
215206

216207
After a successful deployment, verify the system at three levels: OS, Enterprise Inference services, and model inference.
217208

218-
**1. OS & System Validation**
209+
### 1. OS & System Validation
219210
Verify the node is healthy and running the expected kernel.
220211
```bash
221212
hostname
@@ -233,7 +224,7 @@ df -h
233224
free -h
234225
```
235226

236-
**2. Enterprise Inference Services**
227+
### 2. Enterprise Inference Services
237228
Verify all inference services are running.
238229
```bash
239230
kubectl get pods -A
@@ -247,7 +238,7 @@ Check systemd services manually if needed:
247238
systemctl list-units --type=service | grep -i inference
248239
```
249240

250-
**3. Gaudi3 Verification (Only if -g gaudi3)**
241+
### 3. Gaudi3 Verification (Only if -g gaudi3)
251242
Confirm Gaudi devices and firmware are detected.
252243
```bash
253244
hl-smi
@@ -261,7 +252,7 @@ Verify kernel modules:
261252
lsmod | grep habanalabs
262253
```
263254

264-
**4. API & Networking Validation**
255+
### 4. API & Networking Validation
265256
Verify hostname resolution:
266257
```bash
267258
cat /etc/hosts | grep api.example.com
@@ -279,7 +270,7 @@ Expected:
279270
- key.pem
280271

281272

282-
**5. API Health Check**
273+
### 5. API Health Check
283274
Validate the inference gateway is reachable.
284275
```bash
285276
curl -k https://api.example.com/health
@@ -289,7 +280,7 @@ Expected:
289280

290281
---
291282

292-
**6. Test Model Inference**
283+
### 6. Test Model Inference
293284

294285
if EI is deployed with apisix, follow [Testing EI model with apisix](../EI/single-node/user-guide-apisix.md#5-test-the-inference) for generating token and testing the inference
295286

third_party/Dell/ubuntu-22.04/iac/iso/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ brew install xorriso rsync
3737

3838
## Usage
3939

40-
Set `--hostname`, `--username`, and `--password-hash` variables, these are need to run script. All other values have defaults.
40+
The script requires `--hostname`, `--username`, and `--password-hash`. All other values have defaults.
4141

4242
Basic example using a local ISO:
4343

4444
```bash
4545
./custom-iso.sh \
46-
--hostname=<hostname> \
47-
--username=<user> \
48-
--password-hash=<password in SHA-516 hah format> \
46+
--hostname=ubuntu-server-001 \
47+
--username=user \
48+
--iso=./ubuntu-22.04.5-live-server-amd64.iso
4949
```
5050

5151
Full example with all options:
@@ -82,7 +82,7 @@ Notes:
8282
|---|---|---|---|
8383
| `--hostname` | Yes | (none) | Hostname for the installed system. |
8484
| `--username` | Yes | (none) | Primary user name. |
85-
| `--password-hash` | Yes | (none) | password should be in SHA-512 hash format. |
85+
| `--password-hash` | Yes | (none) | SHA-512 password hash for the user. |
8686
| `--ssh-key` | No | `""` | SSH public key (optional). |
8787
| `--timezone` | No | `America/Chicago` | System timezone. |
8888
| `--locale` | No | `en_US.UTF-8` | Locale. |
@@ -107,4 +107,4 @@ If testing in UTM and you see a `Shell>` prompt:
107107
- On Apple Silicon, you must use **Emulate → x86_64** for this amd64 ISO.
108108
- In the UEFI shell, type `exit`, then select the CD/DVD boot entry.
109109

110-
If the installer logs repeatedly mention networking updates, verify UTM’s network mode is set to **Shared** or **Bridged**.
110+
If the installer logs repeatedly mention networking updates, verify UTM’s network mode is set to **Shared** or **Bridged**.

0 commit comments

Comments
 (0)