> For the complete documentation index, see [llms.txt](https://asus-isg-aidc.gitbook.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://asus-isg-aidc.gitbook.io/guide/latest/portal/overview/appendix.md).

# Appendix

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/01/23    |

## Service Parameter Reference Table

### Slurm Cluster

| Parameter Name     | Type   | Required | Description                       | Example            |
| ------------------ | ------ | -------- | --------------------------------- | ------------------ |
| slurmHeadnodeGroup | string | ✅        | Group ID for Headnode             | "group-001"        |
| slurmComputeGroup  | string | ✅        | Group ID for Compute nodes        | "group-002"        |
| slurmDbGroup       | string | ✅        | Group ID for Database             | "group-003"        |
| slurmDbUsername    | string | ✅        | Database username (≥6 characters) | "slurm\_user"      |
| slurmDbPassword    | string | ✅        | Database password (≥6 characters) | "secure\_password" |

### MariaDB Galera Cluster

| Parameter Name     | Type   | Required | Description            | Example            |
| ------------------ | ------ | -------- | ---------------------- | ------------------ |
| mariadbGaleraGroup | string | ✅        | Group ID for DB Nodes  | "group-001"        |
| mariadbPassword    | string | ✅        | Database root password | "secure\_password" |

### UFM Standalone

| Parameter Name | Type   | Required | Description            | Example                     |
| -------------- | ------ | -------- | ---------------------- | --------------------------- |
| node           | string | ✅        | Node ID to install UFM | "node-001"                  |
| netInterface   | string | ✅        | Network interface name | "eth0"                      |
| licensePath    | file   | ✅        | License file           | "/opt/mellanox/license.lic" |

### NMX-M

| Parameter Name | Type   | Required | Description                 | Example                   |
| -------------- | ------ | -------- | --------------------------- | ------------------------- |
| vmPassword     | string | ✅        | VM root password            | "vm\_password"            |
| roPassword     | string | ✅        | Read-only account password  | "ro\_password"            |
| rwPassword     | string | ✅        | Read-write account password | "rw\_password"            |
| index          | string | ✅        | VM name                     | "nmx-vm-0"                |
| hostName       | string | ✅        | VM name                     | "nmx-vm-0"                |
| name           | string | ✅        | VM name                     | "nmx-vm-0"                |
| ip             | string | ✅        | VM IP address               | "192.168.1.100"           |
| mask           | string | ✅        | Subnet mask                 | "255.255.255.0"           |
| gateway        | string | ✅        | Gateway address             | "192.168.1.1"             |
| dns            | string | ✅        | DNS server                  | "8.8.8.8"                 |
| role           | string | ✅        | VM role (master/worker)     | "master"                  |
| qcowBasePath   | string | ✅        | QCOW image path             | "/var/lib/libvirt/images" |
| bridge         | string | ✅        | Bridge name                 | "br0"                     |
| node           | string | ✅        | Node ID                     | "node-001"                |
| vm             | string | ✅        | Corresponding VM ID         | "vm-0"                    |

### Docker Engine

| Parameter Name | Type   | Required | Description                                                 | Example        |
| -------------- | ------ | -------- | ----------------------------------------------------------- | -------------- |
| groups         | string | ---      | Installation Group ID (either Group or Node required)       | "group-001"    |
| nodes          | string | ---      | Installation Node ID (either Group or Node required)        | "node-001"     |
| image          | string | ---      | Container image name (required if containerCount is filled) | "nginx:latest" |
| containerCount | string | ---      | Container count (required if image is filled)               | "3"            |

> ⚠️ Warning: image and containerCount must be filled together or left empty together.

### Native K8s Cluster

| Parameter Name   | Type   | Required | Description            | Example       |
| ---------------- | ------ | -------- | ---------------------- | ------------- |
| k8sControllGroup | string | ✅        | Control Plane Group ID | "group-001"   |
| k8sDataGroup     | string | ✅        | Worker Node Group ID   | "group-002"   |
| gatewayIp        | string | ✅        | Gateway IP address     | "192.168.1.1" |
| interface        | string | ✅        | Network interface name | "eth0"        |

### WEKA

| Parameter Name | Type   | Required | Description                                        | Example     |
| -------------- | ------ | -------- | -------------------------------------------------- | ----------- |
| groups         | string | ---      | WEKA node Group ID (either Group or Node required) | "group-001" |
| nodes          | string | ---      | WEKA node Node ID (either Group or Node required)  | "node-001"  |
| isoName        | string | ✅        | ISO Image Configuration                            |             |

> ⚠️ Warning: Total node count from groups and nodes must be >= 6.

### Podman Engine

| Parameter Name | Type   | Required | Description                                           | Example        |
| -------------- | ------ | -------- | ----------------------------------------------------- | -------------- |
| groups         | string | ---      | Installation Group ID (either Group or Node required) | "group-001"    |
| nodes          | string | ---      | Installation Node ID (either Group or Node required)  | "node-001"     |
| image          | string | ---      | Container image name                                  | "nginx:latest" |
| containerCount | string | ---      | Container count                                       | "3"            |

***

## Keyboard Shortcuts Reference

| Shortcut | Function      | Applicable Scope  |
| -------- | ------------- | ----------------- |
| Esc      | Close dialog  | Deployment dialog |
| Enter    | Confirm/Next  | Form input        |
| Tab      | Switch fields | Form input        |