OpenNebula

https://docs.opennebula.io/7.0/
Admin
OpenNebula is a powerful, easy-to-use open source platform for enterprise, private, hybrid, or edge...
Tokens:356,924
Snippets:4,093
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full Build and Install Workflow

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/compile

A complete example of downloading, compiling with specific features, and installing OpenNebula as the oneadmin user.

```bash
oneadmin@frontend:~/ $> wget <opennebula tar gz>
oneadmin@frontend:~/ $> tar xzf <opennebula tar gz>
oneadmin@frontend:~/ $> cd opennebula-x.y.z
oneadmin@frontend:~/opennebula-x.y.z/ $> scons -j2 mysql=yes syslog=yes fireedge=yes grpcproto=yes
[ lots of compiling information ]
scons: done building targets.
oneadmin@frontend:~/opennebula-x.y.z $> sudo ./install.sh -u oneadmin -g oneadmin
```

--------------------------------

### Installation report output

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/opennebula_sandbox_deployment/deploy_opennebula_onprem_with_minione

Example of the output displayed after a successful installation, containing login credentials.

```text
### Report
OpenNebula 7.0 was installed
Sunstone is running on:
  http://192.168.1.130/
Use following to login:
  user: oneadmin
  password: ZMCoOWUsBg
```

--------------------------------

### Sample installation playbook output

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Example log output showing the progress and final recap of the Ansible deployment.

```text
(one-deploy) front-end:~/my-one$ ansible-playbook -v opennebula.deploy.main
Using /home/basedeployer/my-one/ansible.cfg as config file
running playbook inside collection opennebula.deploy
[WARNING]: Could not match supplied host pattern, ignoring: bastion

PLAY [bastion] *******************************************************************************************
skipping: no hosts matched
[WARNING]: Could not match supplied host pattern, ignoring: grafana
[WARNING]: Could not match supplied host pattern, ignoring: mons
[WARNING]: Could not match supplied host pattern, ignoring: mgrs
[WARNING]: Could not match supplied host pattern, ignoring: osds

PLAY [frontend,node,grafana,mons,mgrs,osds] **************************************************************

TASK [opennebula.deploy.helper/python3 : Bootstrap python3 intepreter] ***********************************
skipping: [f1] => changed=false
  attempts: 1
  msg: /usr/bin/python3 exists, matching creates option
skipping: [n2] => changed=false
  attempts: 1
  msg: /usr/bin/python3 exists, matching creates option
skipping: [n1] => changed=false
  attempts: 1
  msg: /usr/bin/python3 exists, matching creates option

...

TASK [opennebula.deploy.prometheus/server : Enable / Start / Restart Alertmanager service (NOW)] *********
skipping: [f1] => changed=false
  false_condition: features.prometheus | bool is true
  skip_reason: Conditional result was False

PLAY [grafana] *******************************************************************************************
skipping: no hosts matched

PLAY RECAP ***********************************************************************************************
f1                         : ok=84   changed=33   unreachable=0    failed=0    skipped=75   rescued=0    ignored=0
n1                         : ok=37   changed=12   unreachable=0    failed=0    skipped=57   rescued=0    ignored=0
n2                         : ok=37   changed=12   unreachable=0    failed=0    skipped=48   rescued=0    ignored=0
```

--------------------------------

### Setup GPG Key for Debian/Ubuntu

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/opennebula_repository_configuration

Downloads and installs the repository signing key. Create the keyring directory if it does not exist.

```bash
# mkdir -p /etc/apt/keyrings
```

```bash
# wget -q -O- https://downloads.opennebula.io/repo/repo2.key | gpg --dearmor --yes --output /etc/apt/keyrings/opennebula.gpg
```

--------------------------------

### Initialize Connection for Examples

Source: https://docs.opennebula.io/7.0/product/integration_references/system_interfaces/python

Standard initialization for subsequent example operations.

```python
import pyone
one = pyone.OneServer("http://one:2633/RPC2", session="oneadmin:onepass" )
```

--------------------------------

### Build and Start FireEdge Server

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/sunstone_dev

Commands to install dependencies, list scripts, build modules, and start the development server.

```bash
$ npm i         # Install dependencies from package.json
$ npm run       # List the available scripts
$ npm run build # Build all the modules.
$ npm run start # Start the server, by default accessible on http://localhost:2616/fireedge
```

--------------------------------

### Install project requirements

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_shared_ds

Run the make command to install necessary components.

```bash
make requirements
```

--------------------------------

### Full Scheduler Configuration Example

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/scheduler/configuration

A comprehensive example of scheduler settings as found in /etc/one/oned.conf.

```text

SCHED_MAD = [
      EXECUTABLE = "one_sched",
      ARGUMENTS  = "-t 15 -p rank -o one_drs"
]

SCHED_MAX_WND_TIME   = 10
SCHED_MAX_WND_LENGTH = 7

SCHED_RETRY_TIME = 60

MAX_ACTIONS_PER_HOST    = 1
MAX_ACTIONS_PER_CLUSTER = 30

ACTION_TIMEOUT = 300

LIVE_RESCHEDS     = 0
COLD_MIGRATE_MODE = 0

DRS_INTERVAL = -1
```

--------------------------------

### Initialize Installation Directory

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Create and navigate to the directory intended for the OpenNebula installation configuration.

```bash
mkdir my-one
cd my-one
```

--------------------------------

### Install OpenNebula

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/compile

Execute the installation script to deploy OpenNebula. System-wide installations require superuser privileges.

```bash
./install.sh <install_options>
```

```bash
$ sudo ./install.sh <install_options>
```

--------------------------------

### Execute OpenNebula deployment playbook

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Run this command within the my-one directory to start the installation process.

```bash
ansible-playbook -v opennebula.deploy.main
```

--------------------------------

### Install Python packages

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Install pip and pipx on the system.

```bash
sudo apt install python3-pip pipx
```

--------------------------------

### Install requirements

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Install necessary components for the installation.

```bash
make requirements
```

```bash
front-end:~/one-deploy$ make requirements
hatch env create default
hatch env run -e default -- ansible-galaxy collection install --requirements-file /home/frontend/one-deploy/requirements.yml
```

--------------------------------

### Install and Enable OVS with DPDK

Source: https://docs.opennebula.io/7.0/product/cluster_configuration/networking_system/openvswitch

Install the DPDK-enabled Open vSwitch package and configure the service to use it.

```bash
# apt install openvswitch-switch-dpdk

# update-alternatives --set ovs-vswitchd /usr/lib/openvswitch-switch-dpdk/ovs-vswitchd-dpdk

# ovs-vsctl set Open_vSwitch . other_config:dpdk-init=true
```

--------------------------------

### Install Project Requirements

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/deployment/cd_on-premises

Install necessary build tools and project-specific requirements.

```bash
apt install make
make requirements
```

--------------------------------

### Run miniONE installation

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/opennebula_sandbox_deployment/deploy_opennebula_onprem_with_minione

Executes the installation script. Use the --password option to set a custom password.

```bash
./minione
```

```bash
./minione --password <password>
```

--------------------------------

### Enable and start exporters

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/prometheus/install

Use systemctl to enable and start the OpenNebula and node exporters.

```bash
# systemctl enable --now opennebula-exporter.service opennebula-node-exporter.service
```

--------------------------------

### Install Terraform Binary

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/front_end_installation

Download and install the Terraform binary to the system path for provisioning resources.

```bash
curl 'https://releases.hashicorp.com/terraform/0.14.7/terraform_0.14.7_linux_amd64.zip' | zcat >/usr/bin/terraform
```

```bash
chmod 0755 /usr/bin/terraform
```

--------------------------------

### Enable and start exporters

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/prometheus/install

Use systemd to enable and start the libvirt and node exporter services.

```bash
# systemctl enable --now opennebula-libvirt-exporter.service opennebula-node-exporter.service
```

--------------------------------

### Install and Configure rbd-mirror Daemon

Source: https://docs.opennebula.io/7.0/solutions/deployment_blueprints/disaster_recovery/dr_config_and_deployment

Installs the mirroring daemon and prepares the systemd service unit file.

```bash
apt install rbd-mirror
```

```bash
systemctl enable ceph-rbd-mirror.target
```

```bash
cp /usr/lib/systemd/system/ceph-rbd-mirror@.service /etc/systemd/system/ceph-rbd-mirror@.service
```

--------------------------------

### Example configuration diff commands

Source: https://docs.opennebula.io/7.0/software/upgrade_process/configuration_management_ee/diff_formats

Examples of line-based diff commands for modifying configuration files.

```bash
# onecfg diff --format line
/etc/one/cli/oneimage.yaml ins :ID/:adjust false
/etc/one/cli/oneimage.yaml set :USER/:size 15
/etc/one/cli/oneimage.yaml set :GROUP/:size 15
/etc/one/cli/oneimage.yaml ins :NAME/:expand false
/etc/one/oned.conf set DEFAULT_DEVICE_PREFIX "\"sd\""
/etc/one/oned.conf ins HM_MAD/ARGUMENTS "\"-p 2101 -l 2102 -b 127.0.0.1\""
/etc/one/oned.conf ins VM_RESTRICTED_ATTR "\"NIC/FILTER\""
```

--------------------------------

### Enable and start Prometheus service

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/prometheus/install

Use systemctl to enable and start the Prometheus service on the front-end.

```bash
# systemctl enable --now opennebula-prometheus.service
```

--------------------------------

### OpenNebula Daemon Configuration Example

Source: https://docs.opennebula.io/7.0/product/operation_references/opennebula_services_configuration/oned

Example configuration block for the OpenNebula Daemon, including logging, monitoring intervals, and database backend settings.

```text
#*******************************************************************************
# Daemon configuration attributes
#*******************************************************************************

LOG = [
  SYSTEM      = "file",
  DEBUG_LEVEL = 3,
  USE_VMS_LOCATION = "NO"
]

#MANAGER_TIMER = 15

MONITORING_INTERVAL_DATASTORE = 300
MONITORING_INTERVAL_MARKET    = 600

#DS_MONITOR_VM_DISK = 10

SCRIPTS_REMOTE_DIR=/var/tmp/one

PORT = 2633

LISTEN_ADDRESS = "0.0.0.0"

DB = [ BACKEND = "sqlite" ]

# Sample configuration for MySQL
# DB = [ BACKEND = "mysql",
#        SERVER  = "localhost",
#        PORT    = 0,
#        USER    = "oneadmin",
#        PASSWD  = "oneadmin",
#        DB_NAME = "opennebula",
#        CONNECTIONS = 50 ]

VNC_PORTS = [
    START    = 5900,
    RESERVED = "32768:65536"
    # RESERVED = "6800, 6801, 9869"
]

#VM_SUBMIT_ON_HOLD = "NO"
#API_LIST_ORDER    = "DESC"
```

--------------------------------

### Install Helm and Kubectl

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/containerized_ai_execution/ai_ready_k8s

Commands to install Helm 3 and the kubectl binary on the OpenNebula Front-end instance.

```bash
curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
```

```bash
curl -fsSL "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" | \
     install -o root -g root -m 0755 -D /dev/fd/0 /usr/local/bin/kubectl
```

--------------------------------

### Install Front-end Components on Debian/Ubuntu

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/front_end_installation

Update package lists and install core OpenNebula Front-end packages using apt-get.

```bash
apt-get update
```

```bash
apt-get -y install opennebula opennebula-fireedge opennebula-gate opennebula-flow
```

--------------------------------

### Configure SCHED_RANK Examples

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

Examples of rank expressions used to prioritize hosts based on CPU availability and temperature.

```text
# First those resources with a higher Free CPU
  SCHED_RANK = "FREE_CPU"

# Consider also the CPU temperature
  SCHED_RANK = "FREE_CPU * 100 - TEMPERATURE"
```

--------------------------------

### Create VM Template for Installation

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/guest_operating_systems/creating_images

Defines a VM template with the necessary disks, network, and boot configuration for the installation process.

```bash
$ onetemplate create --name centos7-cli --cpu 1 --memory 1G --disk centos7,centos7-install --nic network --boot disk0,disk1 --vnc --raw "INPUT=[TYPE=tablet,BUS=usb]"
```

--------------------------------

### Switch to root user

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/opennebula_sandbox_deployment/deploy_opennebula_onprem_with_minione

Command to elevate privileges to the root user before starting the installation.

```bash
sudo -i
```

--------------------------------

### Basic Placement Configuration

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

Example configuration for setting host and datastore requirements and ranking.

```text
SCHED_REQUIREMENTS    = "CPUSPEED > 1000"
SCHED_RANK            = "FREE_CPU"
SCHED_DS_REQUIREMENTS = "NAME=GoldenCephDS"
SCHED_DS_RANK         = FREE_MB
```

--------------------------------

### VM Contextualization SSH Key Attribute

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/multitenancy/manage_users

Example attribute for automatically installing a user's public SSH key into a Virtual Machine.

```text
ssh_key = "$USER[SSH_KEY]"
```

--------------------------------

### Configure Slurm Worker Start Script

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/direct_ai_execution/nvidia_slurm

This script installs NVIDIA drivers, Python dependencies, downloads a model from Hugging Face, and creates a fine-tuning Python script.

```bash
set -e
AI_DIR=/opt/ai_model

# Create dir for model, venv, and demo script
mkdir -p "$AI_DIR"

# System packages: NVIDIA driver + Python build deps and venv
apt update && apt install -y nvidia-driver-570 python3-pip python3-venv python3-dev build-essential
pip3 install --break-system-packages huggingface_hub
python3 -c "from huggingface_hub import snapshot_download; snapshot_download(repo_id='Qwen/Qwen2.5-1.5B-Instruct', local_dir='$AI_DIR')"
python3 -m venv "$AI_DIR/venv"
"$AI_DIR/venv/bin/pip" install --upgrade pip
"$AI_DIR/venv/bin/pip" install "numpy<2.4.0"
"$AI_DIR/venv/bin/pip" install unsloth datasets trl transformers

# Write Unsloth demo fine-tuning script
cat > "$AI_DIR/demo_finetune.py" << 'PYEOF'
#!/usr/bin/env python3
import os
from datasets import Dataset
from unsloth import FastLanguageModel
from trl import SFTTrainer
from transformers import TrainingArguments

MODEL_PATH = "/opt/ai_model"
OUTPUT_DIR = os.path.join(MODEL_PATH, "output")

alpaca = [
    {"instruction": "What is 2+2?", "input": "", "output": "4."},
    {"instruction": "Say hello in one word.", "input": "", "output": "Hello."},
    {"instruction": "Complete: The sky is", "input": "", "output": " blue."},
]

def fmt(e):
    return {"text": "### Instruction:\n{instruction}\n\n### Input:\n{input}\n\n### Response:\n{output}".format(**e)}

dataset = Dataset.from_list(alpaca)
dataset = dataset.map(fmt, remove_columns=dataset.column_names)

model, tokenizer = FastLanguageModel.from_pretrained(MODEL_PATH, max_seq_length=2048, dtype=None, load_in_4bit=True, local_files_only=True)
model = FastLanguageModel.get_peft_model(model, r=8, target_modules=["q_proj", "k_proj", "v_proj", "o_proj", "gate_proj", "up_proj", "down_proj"], lora_alpha=16, lora_dropout=0, bias="none", use_gradient_checkpointing="unsloth")

trainer = SFTTrainer(model=model, tokenizer=tokenizer, train_dataset=dataset, dataset_text_field="text", max_seq_length=2048, dataset_num_proc=1, packing=False, args=TrainingArguments(per_device_train_batch_size=2, gradient_accumulation_steps=2, max_steps=10, learning_rate=2e-4, bf16=True, output_dir=OUTPUT_DIR, report_to="none"))
os.makedirs(OUTPUT_DIR, exist_ok=True)
trainer.train()
model.save_pretrained_merged(OUTPUT_DIR, tokenizer, save_method="merged_16bit")
tokenizer.save_pretrained(OUTPUT_DIR)
print("Saved to", OUTPUT_DIR)
PYEOF

chmod +x "$AI_DIR/demo_finetune.py"
```

--------------------------------

### Instantiate CAPI appliance with interactive prompts

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/try_kubernetes_on_opennebula/managing_k8s_with_rancher

Example of the CLI output when instantiating the template, showing the required user input parameters.

```bash
oneadmin@frontend:~$ onetemplate instantiate 'Service Capi' --nic vnet
There are some parameters that require user input. Use the string <<EDITOR>> to launch an editor (e.g. for multi-line inputs)
  * (ONEAPP_CAPI_CAPONE_VERSION) Capone Version
  * (ONEAPP_CAPI_CERT_MANAGER_VERSION) Cert Manager Chart Version
  * (ONEAPP_CAPI_K3S_VERSION) K3s Version
  * (ONEAPP_CAPI_RANCHER_HOSTNAME) Rancher Hostname
  * (ONEAPP_CAPI_RANCHER_PASSWORD) Rancher Password
  * (ONEAPP_CAPI_RANCHER_VERSION) Rancher Chart Version
  * (ONEAPP_CAPI_TURTLES_VERSION) Turtles Chart Version
VM ID: 
2
```

--------------------------------

### Configure VM Boot with Datastore Kernel

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

Example of a VM configuration booting using kernel and initrd images registered in a File Datastore.

```text
OS = [ KERNEL_DS  = "$FILE[IMAGE=\"kernel 3.6\"]",
       INITRD_DS  = "$FILE[IMAGE=\"initrd 3.6\"]",
       ROOT       = sda1,
       KERNEL_CMD = "ro console=tty1"]
```

--------------------------------

### Create a Backup Job via Command Line

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/virtual_machine_backups/backup_jobs

Example of a full backup job configuration file and the command to create it.

```bash
$ cat my_backupjob.txt

 NAME = "My backup job"

 BACKUP_VMS   = "13,15,3"
 DATASTORE_ID = 101

 FS_FREEZE = "NONE"
 KEEP_LAST = "4"
 MODE      = "INCREMENT"

 PRIORITY  = 7
 EXECUTION = "SEQUENTIAL"

 SCHED_ACTION = [
     REPEAT="0",
     DAYS="1,5",
     END_TYPE="0",
     TIME="1695478500"
 ]

 SCHED_ACTION = [
     REPEAT="3",
     DAYS="1",
     END_TYPE="0",
     TIME="1695478500"
 ]

 $ onebackupjob create b1.txt
 ID: 1
```

--------------------------------

### GET /fireedge/api/sunstone/config

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/sunstone_dev

Get the Sunstone config.

```APIDOC
## GET /fireedge/api/sunstone/config

### Description
Get the Sunstone config.

### Method
GET

### Endpoint
/fireedge/api/sunstone/config
```

--------------------------------

### Example User Environment Configuration

Source: https://docs.opennebula.io/7.0/product/operation_references/command_line_interface/cli_configuration

Shows a typical configuration in .bashrc and the contents of the authentication file.

```bash
$ tail ~/.bashrc

ONE_XMLRPC=http://localhost:2633/RPC2

export ONE_XMLRPC

$ cat ~/.one/one_auth
regularuser:password
```

--------------------------------

### GET /fireedge/api/sunstone/views

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/sunstone_dev

Get the Sunstone view.

```APIDOC
## GET /fireedge/api/sunstone/views

### Description
Get the Sunstone view.

### Method
GET

### Endpoint
/fireedge/api/sunstone/views
```

--------------------------------

### Setup Module Files

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/sunstone_dev

Copy existing module assets and webpack configuration to the new custom module directory.

```bash
# Copying the Users directory
cp -r src/modules/containers/Users src/modules/customContainers

# Copying containers webpack config for reference
cp src/modules/containers/webpack.config.prod.containers.js src/modules/customContainers/webpack.config.prod.customContainers.js

# We'll also create a index.js file which will expose our new component
touch src/modules/customContainers/index.js
```

--------------------------------

### Create System Datastore Configuration

Source: https://docs.opennebula.io/7.0/product/cluster_configuration/san_storage/lvm_drivers

Example configuration file for a system datastore and the command to register it in OpenNebula.

```bash
> cat ds_system.conf
NAME   = lvm_system
TM_MAD = fs_lvm_ssh
TYPE   = SYSTEM_DS
DISK_TYPE = BLOCK

> onedatastore create ds_system.conf
ID: 100
```

--------------------------------

### Install System Dependencies

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/deployment/cd_on-premises

Install pipx to manage Python environment tools.

```bash
apt update
apt install pipx
```

--------------------------------

### Create Virtual Machines with onevm

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/virtual_machines/vm_instances

Examples of creating new virtual machines using template files or direct command-line arguments.

```bash
onevm create vm_description.tmpl
```

```bash
onevm create --name "arch vm" --memory 128 --cpu 1 --disk arch \ --network private_lan
```

```bash
onevm create --name "test vm" --memory 128 --cpu 1 --disk arch,data
```

--------------------------------

### Install Prerequisites for Debian/Ubuntu

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/opennebula_repository_configuration

Ensures necessary tools for repository management are installed.

```bash
# apt-get update
# apt-get -y install gnupg wget apt-transport-https
```

--------------------------------

### Example Deployment Status Output

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/containerized_ai_execution/nvidia_dynamo

Sample output showing a pod stuck in ImagePullBackOff state.

```text
NAME                                                                 READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/dynamo-platform-dynamo-operator-controller-manager   1/1     1            1           42m

NAME                                                                  READY   STATUS             RESTARTS   AGE
pod/dynamo-platform-dynamo-operator-controller-manager-75847c7qj2kx   2/2     ImagePullBackOff   0          19m
pod/dynamo-platform-etcd-0                                            1/1     Running            0          42m
pod/dynamo-platform-nats-0                                            2/2     Running            0          42m
...
```

--------------------------------

### Install New Firmware Files

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/guest_operating_systems/windows_best_practice

Copy the extracted firmware files into the system directory.

```bash
cd /path/to/download/RPM/extracted/usr/share/
cp -r edk2 qemu OVMF /usr/share/.
```

--------------------------------

### Install Hatch

Source: https://docs.opennebula.io/7.0/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds

Install the Hatch project manager and update the shell path.

```bash
pipx install hatch
pipx ensurepath
source ~/.bashrc
```

--------------------------------

### Install driverctl Utility

Source: https://docs.opennebula.io/7.0/product/cluster_configuration/hosts_and_clusters/nvidia_gpu_passthrough

Install the driverctl package to manage driver overrides.

```bash
# apt install driverctl
```

--------------------------------

### Install Ansible and Hatch

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/deployment/cd_on-premises

Install the required versions of Ansible and Hatch for the deployment environment.

```bash
pipx install 'ansible-core<2.16'
pipx install hatch==1.16.5
pipx ensurepath
source ~/.bashrc
```

--------------------------------

### Install Prometheus packages on Hosts

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/prometheus/install

Commands to install the Prometheus-KVM package on OpenNebula Hosts.

```bash
# yum -y install opennebula-prometheus-kvm
```

```bash
# apt -y install opennebula-prometheus-kvm
```

--------------------------------

### Example Virtual Machine List Output

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/containerized_ai_execution/ai_ready_k8s

Expected output showing the vRouter, control plane, and worker node instances.

```text
ID USER     GROUP    NAME                                  STAT  CPU     MEM HOST
448 oneadmin oneadmin k8s-gpu-test-md-0-m5tzv-drg4k         runn   16     32G vgpu2
447 oneadmin oneadmin k8s-gpu-test-md-0-m5tzv-btvn4         runn   16     32G vgpu2
446 oneadmin oneadmin k8s-gpu-test-qb8dl                    runn   16     32G vgpu2
445 oneadmin oneadmin vr-k8s-gpu-test-cp-0                  runn    2    512M vgpu2
```

--------------------------------

### Define autostart hook templates

Source: https://docs.opennebula.io/7.0/product/integration_references/system_interfaces/hook_driver

Definition files for Host and VM autostart hooks.

```text
NAME = autostart-host
TYPE = state
COMMAND = autostart/host
ARGUMENTS = $TEMPLATE
ARGUMENTS_STDIN = yes
RESOURCE = HOST
STATE = MONITORED
```

```text
NAME = autostart-vm
TYPE = state
COMMAND = autostart/vm
ARGUMENTS = $TEMPLATE
ARGUMENTS_STDIN = yes
RESOURCE = VM
STATE = POWEROFF
LCM_STATE = LCM_INIT
ON = CUSTOM
```

--------------------------------

### XML Deployment File Example

Source: https://docs.opennebula.io/7.0/product/integration_references/infrastructure_drivers_development/devel-vmm

Represents the VM template structure in XML format, including CPU, memory, and disk configuration details.

```xml
<TEMPLATE>
  <CPU><![CDATA[1.0]]></CPU>
  <DISK>
    <DISK_ID><![CDATA[0]]></DISK_ID>
    <SOURCE><![CDATA[/home/user/vm.img]]></SOURCE>
    <TARGET><![CDATA[sda]]></TARGET>
  </DISK>
  <MEMORY><![CDATA[512]]></MEMORY>
  <NAME><![CDATA[test]]></NAME>
  <VMID><![CDATA[0]]></VMID>
</TEMPLATE>
```

--------------------------------

### Configure VM Features

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

Example configuration for enabling various VM features and setting virtio queue counts.

```text
FEATURES = [
    PAE = "yes",
    ACPI = "yes",
    APIC = "no",
    GUEST_AGENT = "yes",
    VIRTIO_SCSI_QUEUES = "auto"
    VIRTIO_BLK_QUEUES = "auto"
]
```

--------------------------------

### Create Installation Disk

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/guest_operating_systems/creating_images

Creates a persistent DATABLOCK image to serve as the target for the OS installation.

```bash
$ oneimage create --name centos7 --description "Base CentOS 7 Installation" --type DATABLOCK --persistent --prefix vd --driver qcow2 --size 10240 --datastore default
```

--------------------------------

### Instantiate a Virtual Machine with User Inputs

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/virtual_machines/vm_instances

Handles templates that require interactive user input for specific parameters during instantiation.

```bash
$ onetemplate instantiate vm-example --name my_vm
There are some parameters that require user input.
  * (BLOG_TITLE) Blog Title: <my_title>
  * (DB_PASSWORD) Database Password:
VM ID: 0
```

--------------------------------

### Start OpenNebula services

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/front_end_installation

Initiates the core OpenNebula services immediately. Adjust the service list based on your specific configuration.

```bash
systemctl start opennebula opennebula-fireedge opennebula-gate opennebula-flow
```

--------------------------------

### Install Prometheus packages on Front-end

Source: https://docs.opennebula.io/7.0/product/cloud_system_administration/prometheus/install

Commands to install Prometheus and KVM-related exporters on the OpenNebula Front-end.

```bash
# yum -y install opennebula-prometheus opennebula-prometheus-kvm
```

```bash
# apt -y install opennebula-prometheus opennebula-prometheus-kvm
```

--------------------------------

### Install cpu-checker on Debian

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/opennebula_sandbox_deployment/deploy_opennebula_onprem_with_minione

Install the package required to run the kvm-ok command on Debian-based systems.

```bash
sudo apt install cpu-checker
```

--------------------------------

### Create MIG-backed vGPU partitions

Source: https://docs.opennebula.io/7.0/product/cluster_configuration/hosts_and_clusters/vgpu

Use the nvidia-smi command to create GPU and compute instances for partitioning.

```bash
$ nvidia-smi mig -cgi 14,14,19 -C
Successfully created GPU instance ID 3 on GPU 0 using profile MIG 1g.12gb (ID 9)
Successfully created compute instance ID 0 on GPU 0 GPU instance ID 3 using
 profile MIG 1g.12gb (ID 19)
Successfully created GPU instance ID 2 on GPU 0 using profile MIG 2g.24gb (ID 9)
Successfully created compute instance ID 0 on GPU 0 GPU instance ID 2 using
 profile MIG 2g.24gb (ID 14)
Successfully created GPU instance ID 1 on GPU 0 using profile MIG 2g.24gb (ID 9)
Successfully created compute instance ID 0 on GPU 0 GPU instance ID 1 using
 profile MIG 2g.24gb (ID 14)
```

--------------------------------

### Create VM at Site B

Source: https://docs.opennebula.io/7.0/solutions/deployment_blueprints/disaster_recovery/failover

Instantiate a new VM on the Site B front-end using a template file.

```bash
onevm create <VM template file>
```

--------------------------------

### Virtual Network Template Configuration Example

Source: https://docs.opennebula.io/7.0/product/integration_references/system_interfaces/api

Example of a vntemplate string using attribute=value syntax.

```text
VN_MAD=bridge
VLAN_ID=4
```

--------------------------------

### Create Database

Source: https://docs.opennebula.io/7.0/getting_started/try_opennebula/try_kubernetes_on_opennebula/running_kubernetes_clusters

Initialize the application database by calling the create-db endpoint.

```bash
curl 172.16.100.2/create-db
```

```bash
oneadmin@ip-172-31-47-282:~$ curl 172.16.100.2/create-db
{"message":"Table 'data' created successfully"}
```

--------------------------------

### Configure VM Boot with Host Kernel

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

Example of a VM configuration booting from a specific device using a kernel and initrd located on the host.

```text
OS = [ KERNEL     = /vmlinuz,
       INITRD     = /initrd.img,
       ROOT       = sda1,
       KERNEL_CMD = "ro console=tty1"]
```

--------------------------------

### Service Log Entry Example

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/multi-vm_workflows/appflow_use_cli

Example of a log entry object within the Service body.

```json
{"timestamp": 1728498179, "severity": "I", "message": "New state: RUNNING"}
```

--------------------------------

### Example XML Template

Source: https://docs.opennebula.io/7.0/product/operation_references/configuration_references/template

A complete example of a VM template defined using the XML syntax.

```xml
<TEMPLATE>
  <NAME>test_vm</NAME>
  <CPU>2</CPU>
  <MEMORY>1024</MEMORY>
  <DISK>
    <IMAGE_ID>2</IMAGE_ID>
  </DISK>
  <DISK>
    <IMAGE>Data</IMAGE>
    <IMAGE_UNAME>oneadmin</IMAGE_UNAME>
  </DISK>
</TEMPLATE>
```

--------------------------------

### Start and Monitor Mirroring Service

Source: https://docs.opennebula.io/7.0/solutions/deployment_blueprints/disaster_recovery/dr_config_and_deployment

Starts the mirroring service instance and checks its operational status.

```bash
systemctl enable --now ceph-rbd-mirror@rbd-mirror.$(hostname).service
```

```bash
systemctl status ceph-rbd-mirror@rbd-mirror.ubuntu2204-kvm-ceph-squid-6-10-cqyoo-0.service
```

```text
root@site-b $ systemctl status ceph-rbd-mirror@rbd-mirror.ubuntu2204-kvm-ceph-squid-6-10-cqyoo-0.service
● ceph-rbd-mirror@rbd-mirror.ubuntu2204-kvm-ceph-squid-6-10-cqyoo-0.service - Ceph rbd mirror daemon
 	Loaded: loaded (/etc/systemd/system/ceph-rbd-mirror@.service; enabled; vendor preset: enabled)
 	Active: active (running) since Mon 2025-06-09 12:04:50 UTC; 6 days ago
   Main PID: 17234 (rbd-mirror)
  	Tasks: 51
 	Memory: 55.5M
    	CPU: 21min 42.097s
 	CGroup: /system.slice/system-ceph\x2drbd\x2dmirror.slice/ceph-rbd-mirror@rbd-mirror.ubuntu2204-kvm-ceph-squid-6-10-cqyoo-0.service
         	└─17234 /usr/bin/rbd-mirror -f --cluster ceph --id rbd-mirror.ubuntu2204-kvm-ceph-squid-6-10-cqyoo-0 --setuser root --setgroup root
```

--------------------------------

### Example VM Template Configuration

Source: https://docs.opennebula.io/7.0/product/virtual_machines_operation/virtual_machines/vm_templates

A sample VM template definition containing CPU, VCPU, memory, disk, and network settings.

```text
CPU     = "1"
VCPU    = "1"
MEMORY  = "512"
DISK=[
  IMAGE = "BaseOS" ]
NIC=[
  NETWORK_ID = "0" ]
```

--------------------------------

### Example Monitoring Output Format

Source: https://docs.opennebula.io/7.0/product/integration_references/infrastructure_drivers_development/devel-vmm

A sample output string demonstrating the required KEY=VALUE format, including vector attributes for disk and snapshot sizes.

```text
STATE=a USEDMEMORY=554632 DISK_SIZE=[ ID=0, SIZE=24 ] DISK_SIZE=[ ID=1, SIZE=242 ] SNAPSHOT_SIZE=[ ID=0, DISK_ID=0, SIZE=24 ]
```

--------------------------------

### Example fireedge-server.conf configuration snippet

Source: https://docs.opennebula.io/7.0/software/upgrade_process/configuration_management_ee/diff_formats

A sample configuration file snippet for fireedge-server.

```text
# OpenNebula: use it if you have oned and fireedge on different servers
:one_xmlrpc: http://localhost:2633/RPC2     # path 4
```

--------------------------------

### Configure Front-end Image Datastore Storage

Source: https://docs.opennebula.io/7.0/product/cluster_configuration/san_storage/lvm_drivers

Setup commands for different storage backends for the Image Datastore directory on the front-end.

```bash
# mkdir -p /var/lib/one/datastores/100/
# chown oneadmin:oneadmin /var/lib/one/datastores/100/
```

```bash
# echo "nfs-server:/srv/path_to_share /var/lib/one/datastores/100/ nfs4 defaults 0 2" >> /etc/fstab
# mount /var/lib/one/datastores/100/
# chown oneadmin:oneadmin /var/lib/one/datastores/100/
```

```bash
# pvcreate /dev/sdb
# vgcreate image-vg /dev/sdb
# lvcreate -l 100%FREE -n image-lv image-vg
# mkfs.ext4 /dev/image-vg/image-lv
# mkdir -p /var/lib/one/datastores/100/
# echo "/dev/image-vg/image-lv /var/lib/one/datastores/100/ ext4 defaults 0 2" >> /etc/fstab
# mount /var/lib/one/datastores/100/
# chown oneadmin:oneadmin /var/lib/one/datastores/100/
```

--------------------------------

### Install Dynamo CRDs

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/containerized_ai_execution/nvidia_dynamo

Install the required Custom Resource Definitions for NVIDIA Dynamo using Helm.

```bash
helm install dynamo-crds https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-crds-0.7.0.tgz \
  --namespace dynamo-cloud --create-namespace \
  --wait --atomic
```

--------------------------------

### Install KAI Scheduler via Helm

Source: https://docs.opennebula.io/7.0/solutions/ai_factory_blueprints/containerized_ai_execution/nvidia_kai_scheduler

Installs the KAI Scheduler chart with GPU sharing enabled.

```bash
helm install kai-scheduler \
    https://github.com/NVIDIA/KAI-Scheduler/releases/download/v0.9.8/kai-scheduler-v0.9.8.tgz \
    -n kai-scheduler --create-namespace \
    --set "global.gpuSharing=true" \
    --set "global.resourceReservation.runtimeClassName=nvidia"
```

--------------------------------

### Initialize Development Environment

Source: https://docs.opennebula.io/7.0/software/installation_process/build_from_source_code/sunstone_dev

Commands to clone the OpenNebula repository and navigate to the FireEdge source directory.

```bash
git clone git@github.com:OpenNebula/one.git
# Cd into the fireedge directory
cd ./one/src/fireedge
```

--------------------------------

### Install KVM Node on AlmaLinux/RHEL

Source: https://docs.opennebula.io/7.0/software/installation_process/manual_installation/kvm_node_installation

Install the OpenNebula KVM node package and restart the libvirt service.

```bash
# yum -y install opennebula-node-kvm
# systemctl restart libvirtd
```
Tokens:
Raw