From 230793918dbbebe8b7be28a4a509e402da756f72 Mon Sep 17 00:00:00 2001 From: mattrowe-opennebula Date: Fri, 17 Apr 2026 09:48:28 +0200 Subject: [PATCH] F OpenNebula/one#7555: Initial restructure --- .../managing_k8s_with_rancher.md | 2 +- .../cloud_architecture_design.md | 12 +- .../opennebula_overview.md | 2 +- .../prometheus/install.md | 4 +- .../prometheus/overview.md | 2 +- .../resource_monitoring/overview.md | 2 +- .../backup_system/overview.md | 2 +- .../backup_system/veeam.md | 6 +- .../data_center_federation/config.md | 4 +- .../data_center_federation/overview.md | 2 +- .../high_availability/overview.md | 2 +- .../overview.md | 2 +- .../fireedge.md | 2 +- .../oneflow.md | 2 +- .../onegate.md | 4 +- .../virtual_machines_operation/_index.md | 2 +- .../_index.md | 6 +- .../one_deploy_overview.md | 0 .../one_deploy_tutorial_local_ds.md | 0 .../one_deploy_tutorial_shared_ds.md | 0 .../build_from_source_code/compile.md | 2 +- .../cluster_installation/_index.md | 12 + .../cluster_installation/automated.md | 22 ++ .../kvm_node_installation.md | 9 +- .../lxc_node_installation.md | 11 +- .../frontend_installation/_index.md | 12 + .../frontend_installation/automated.md | 230 ++++++++++++++++++ .../manual}/_index.md | 3 +- .../manual}/database.md | 2 +- .../manual/frontend_install.md} | 22 +- .../opennebula_repository_configuration.md | 0 .../opennebula_repository_configuration_ce.md | 0 .../opennebula_repository_configuration_ee.md | 0 .../manual}/overview.md | 8 +- .../migration_from_vmware/import_ova.md | 2 +- .../release_notes/platform_notes.md | 14 +- .../upgrade_guide/upgrading_single.md | 4 +- 37 files changed, 345 insertions(+), 66 deletions(-) rename content/software/installation_process/{automatic_installation_with_onedeploy => advanced_installation_with_onedeploy}/_index.md (90%) rename content/software/installation_process/{automatic_installation_with_onedeploy => advanced_installation_with_onedeploy}/one_deploy_overview.md (100%) rename content/software/installation_process/{automatic_installation_with_onedeploy => advanced_installation_with_onedeploy}/one_deploy_tutorial_local_ds.md (100%) rename content/software/installation_process/{automatic_installation_with_onedeploy => advanced_installation_with_onedeploy}/one_deploy_tutorial_shared_ds.md (100%) create mode 100644 content/software/installation_process/cluster_installation/_index.md create mode 100644 content/software/installation_process/cluster_installation/automated.md rename content/software/installation_process/{manual_installation => cluster_installation}/kvm_node_installation.md (96%) rename content/software/installation_process/{manual_installation => cluster_installation}/lxc_node_installation.md (95%) create mode 100644 content/software/installation_process/frontend_installation/_index.md create mode 100644 content/software/installation_process/frontend_installation/automated.md rename content/software/installation_process/{manual_installation => frontend_installation/manual}/_index.md (86%) rename content/software/installation_process/{manual_installation => frontend_installation/manual}/database.md (95%) rename content/software/installation_process/{manual_installation/front_end_installation.md => frontend_installation/manual/frontend_install.md} (92%) rename content/software/installation_process/{manual_installation => frontend_installation/manual}/opennebula_repository_configuration.md (100%) rename content/software/installation_process/{manual_installation => frontend_installation/manual}/opennebula_repository_configuration_ce.md (100%) rename content/software/installation_process/{manual_installation => frontend_installation/manual}/opennebula_repository_configuration_ee.md (100%) rename content/software/installation_process/{manual_installation => frontend_installation/manual}/overview.md (66%) diff --git a/content/getting_started/try_opennebula/try_kubernetes_on_opennebula/managing_k8s_with_rancher.md b/content/getting_started/try_opennebula/try_kubernetes_on_opennebula/managing_k8s_with_rancher.md index ff2fd5f3e..d7f525e32 100644 --- a/content/getting_started/try_opennebula/try_kubernetes_on_opennebula/managing_k8s_with_rancher.md +++ b/content/getting_started/try_opennebula/try_kubernetes_on_opennebula/managing_k8s_with_rancher.md @@ -519,7 +519,7 @@ Congratulations! You have successfully deployed a K3s Cluster with the Rancher m To learn about OpenNebula in depth, the next sections of the documentation include all of the information necessary for [configuration and administration]({{% relref "product/index" %}}), as well as software [life cycle, releases and installation details]({{% relref "software/index" %}}). -If you are interested in installing OpenNebula by following further tutorials, you can head over to [Automatic Installation with OneDeploy]({{% relref "software/installation_process/automatic_installation_with_onedeploy/one_deploy_overview" %}}) to automatically install a production-ready OpenNebula cloud. +If you are interested in installing OpenNebula by following further tutorials, you can head over to [Automatic Installation with OneDeploy]({{% relref "software/installation_process/advanced_installation_with_onedeploy/one_deploy_overview" %}}) to automatically install a production-ready OpenNebula cloud. ## Using SSH on Remote Hardware diff --git a/content/getting_started/understand_opennebula/cloud_architecture_and_design/cloud_architecture_design.md b/content/getting_started/understand_opennebula/cloud_architecture_and_design/cloud_architecture_design.md index 683129682..7598d7985 100644 --- a/content/getting_started/understand_opennebula/cloud_architecture_and_design/cloud_architecture_design.md +++ b/content/getting_started/understand_opennebula/cloud_architecture_and_design/cloud_architecture_design.md @@ -23,21 +23,21 @@ To familiarize yourself with deployment and daily operations, or if you want to As you follow the tutorials you will learn the basic usage and operation of your cloud. This trial of a real cloud deployment can help you to plan for the most suitable features for performance and scalability, to get the most out of your OpenNebula cloud. -To install a production-ready OpenNebula cloud, we highly recommend using [OneDeploy]({{% relref "automatic_installation_with_onedeploy" %}}), a tool for automated installation. With OneDeploy you can install a complete cloud by defining your desired configuration and running a few simple commands. The tutorials provide step-by-step instructions with complete commands for sample deployment scenarios. +To install a production-ready OpenNebula cloud, we highly recommend using [OneDeploy]({{% relref "advanced_installation_with_onedeploy" %}}), a tool for automated installation. With OneDeploy you can install a complete cloud by defining your desired configuration and running a few simple commands. The tutorials provide step-by-step instructions with complete commands for sample deployment scenarios. For a sequential outline of the tasks involved in designing an OpenNebula cloud, read on. ## Step 1. Install the Front-end -The first step is the installation of the OpenNebula Front-end. The [installation process]({{% relref "front_end_installation" %}}) is based on operating system packages for the most widely-used Linux distributions and is the same for any underlying hypervisor or deployment model. +The first step is the installation of the OpenNebula Front-end. The [installation process]({{% relref "software/installation_process/frontend_installation/manual/frontend_install.md" %}}) is based on operating system packages for the most widely-used Linux distributions and is the same for any underlying hypervisor or deployment model. -If you are planning for a system with a very large number of hypervisors, don’t forget to read the [Large-scale Deployment]({{% relref "../../../product/control_plane_configuration/large-scale_deployment/overview#large-scale-deployment-overview" %}}) section of the documentation. The general recommendation is that each OpenNebula instance can handle up to 2500 servers and 10,000 VMs. Better performance and higher scalability can be achieved by tuning other components, such as the database where the state of the cloud is persisted. To grow the size of your cloud beyond the limits mentioned above, you can horizontally scale the cloud by adding new OpenNebula Zones within a federated deployment. The largest OpenNebula deployment consists of 16 data centers and 300,000 cores. +If you are planning for a system with a very large number of hypervisors, don’t forget to read the [Large-scale Deployment]({{% relref "product/control_plane_configuration/large-scale_deployment/overview#large-scale-deployment-overview" %}}) section of the documentation. The general recommendation is that each OpenNebula instance can handle up to 2500 servers and 10,000 VMs. Better performance and higher scalability can be achieved by tuning other components, such as the database where the state of the cloud is persisted. To grow the size of your cloud beyond the limits mentioned above, you can horizontally scale the cloud by adding new OpenNebula Zones within a federated deployment. The largest OpenNebula deployment consists of 16 data centers and 300,000 cores. -To reduce downtime of core OpenNebula services, you can optionally set up a [High-availability Cluster]({{% relref "../../../product/control_plane_configuration/high_availability/frontend_ha#frontend-ha-setup" %}}). If planning for a large-scale infrastructure, you can [configure a MySQL/MariaDB backend]({{% relref "../../../software/installation_process/manual_installation/database.md#mysql" %}}) as an alternative to the default SQLite backend. +To reduce downtime of core OpenNebula services, you can optionally set up a [High-availability Cluster]({{% relref "/product/control_plane_configuration/high_availability/frontend_ha#frontend-ha-setup" %}}). If planning for a large-scale infrastructure, you can [configure a MySQL/MariaDB backend]({{% relref "software/installation_process/frontend_installation/manual/database.md#mysql" %}}) as an alternative to the default SQLite backend. -A single OpenNebula Front-end can manage multiple Clusters geographically distributed across several data centers and cloud providers. However, you can choose a multi-Zone deployment with [data center federation]({{% relref "../../../product/control_plane_configuration/data_center_federation/overview#introf" %}}) if data centers belong to different administrative domains or if connectivity between them does not meet latency and bandwidth requirements. Multiple OpenNebula Zones can be configured as a federation, where they will share the same user accounts, groups, and permissions across data centers. +A single OpenNebula Front-end can manage multiple Clusters geographically distributed across several data centers and cloud providers. However, you can choose a multi-Zone deployment with [data center federation]({{% relref "product/control_plane_configuration/data_center_federation/overview#introf" %}}) if data centers belong to different administrative domains or if connectivity between them does not meet latency and bandwidth requirements. Multiple OpenNebula Zones can be configured as a federation, where they will share the same user accounts, groups, and permissions across data centers. -Besides connecting your cloud to the public [OpenNebula Marketplace and other third-party Marketplaces]({{% relref "../../../product/apps-marketplace/public_marketplaces/index#public-marketplaces" %}}), you can build your own [private Marketplace]({{% relref "../../../product/apps-marketplace/private_marketplaces/overview#private-marketplace-overview" %}}) to provide your users with an easy way of privately publishing, downloading, and sharing your own custom appliances. +Besides connecting your cloud to the public [OpenNebula Marketplace and other third-party Marketplaces]({{% relref "product/apps-marketplace/public_marketplaces/index#public-marketplaces" %}}), you can build your own [private Marketplace]({{% relref "product/apps-marketplace/private_marketplaces/overview#private-marketplace-overview" %}}) to provide your users with an easy way of privately publishing, downloading, and sharing your own custom appliances. ## Step 2. Deploy Edge Clusters diff --git a/content/getting_started/understand_opennebula/opennebula_concepts/opennebula_overview.md b/content/getting_started/understand_opennebula/opennebula_concepts/opennebula_overview.md index 6784f2385..8c6625a24 100644 --- a/content/getting_started/understand_opennebula/opennebula_concepts/opennebula_overview.md +++ b/content/getting_started/understand_opennebula/opennebula_concepts/opennebula_overview.md @@ -147,6 +147,6 @@ The Getting Started Guide is by far the fastest way to familiarize yourself with If you are interested in building a production environment, then [Cloud Architecture Design]({{% relref "../cloud_architecture_and_design/cloud_architecture_design#intro" %}}) is a good resource to explore and consider the available options and choices. -If you are interested in automatic, DevOps-like deployment of a production-ready OpenNebula cloud, please refer to the [Automatic Deployment]({{% relref "../../../software/installation_process/automatic_installation_with_onedeploy/index#automatic-deployment" %}}) section of the Installation Guide. +If you are interested in automatic, DevOps-like deployment of a production-ready OpenNebula cloud, please refer to the [Automatic Deployment]({{% relref "../../../software/installation_process/advanced_installation_with_onedeploy/index#automatic-deployment" %}}) section of the Installation Guide. Remember that if you need our support at any time, or access to our professional services or to the **Enterprise Edition**, you can always [contact us](https://opennebula.io/enterprise). diff --git a/content/product/cloud_system_administration/prometheus/install.md b/content/product/cloud_system_administration/prometheus/install.md index c128ae439..bd10aea50 100644 --- a/content/product/cloud_system_administration/prometheus/install.md +++ b/content/product/cloud_system_administration/prometheus/install.md @@ -12,11 +12,11 @@ weight: "2" -This page describes how to install the OpenNebula Prometheus integration packages available in the [OpenNebula software repositories]({{% relref "../../../software/installation_process/manual_installation/opennebula_repository_configuration#repositories" %}}). +This page describes how to install the OpenNebula Prometheus integration packages available in the [OpenNebula software repositories]({{% relref "software/installation_process/frontend_installation/manual/opennebula_repository_configuration" %}}). ## Step 1. OpenNebula Repositories [Front-end, Hosts] -At this point OpenNebula software repositories should already be configured in your Front-end and Hosts. Double check this is the case before proceeding, more information can be found in the [OpenNebula Repositories]({{% relref "../../../software/installation_process/manual_installation/opennebula_repository_configuration#repositories" %}}) guide. +At this point OpenNebula software repositories should already be configured in your Front-end and Hosts. Double check this is the case before proceeding, more information can be found in the [OpenNebula Repositories]({{% relref "software/installation_process/frontend_installation/manual/opennebula_repository_configuration" %}}) guide. ## Step 2. Install Front-end Packages [Front-end] diff --git a/content/product/cloud_system_administration/prometheus/overview.md b/content/product/cloud_system_administration/prometheus/overview.md index 8b31cf6b4..f39b8a921 100644 --- a/content/product/cloud_system_administration/prometheus/overview.md +++ b/content/product/cloud_system_administration/prometheus/overview.md @@ -21,7 +21,7 @@ This Chapter contains documentation on how to configure OpenNebula to work with ## How Should I Read This Chapter -Before reading this Chapter, you should have already installed your [Front-end]({{% relref "../../../software/installation_process/manual_installation/front_end_installation.md#frontend-installation" %}}) and [KVM Hosts]({{% relref "../../../software/installation_process/manual_installation/front_end_installation.md#kvm-node" %}}), and have an OpenNebula cloud up and running with at least one virtualization node. +Before reading this Chapter, you should have already installed your [Front-end]({{% relref "software/installation_process/frontend_installation/manual/frontend_install.md#frontend-installation" %}}) and [KVM Hosts]({{% relref "software/installation_process/frontend_installation/manual/frontend_install.md#kvm-node" %}}), and have an OpenNebula cloud up and running with at least one virtualization node. This Chapter is structured as follows: diff --git a/content/product/cloud_system_administration/resource_monitoring/overview.md b/content/product/cloud_system_administration/resource_monitoring/overview.md index 4216d7290..13b8c1516 100644 --- a/content/product/cloud_system_administration/resource_monitoring/overview.md +++ b/content/product/cloud_system_administration/resource_monitoring/overview.md @@ -21,7 +21,7 @@ This Chapter provides documentation on how different resources are monitored in ## How Should I Read This Chapter -Before proceeding with this Chapter, ensure you have already installed your [Front-end]({{% relref "../../../software/installation_process/manual_installation/front_end_installation#frontend-installation" %}}), configured [KVM Hosts]({{% relref "../../../software/installation_process/manual_installation/kvm_node_installation#kvm-node" %}}), and set up an OpenNebula cloud with at least one virtualization node. +Before proceeding with this Chapter, ensure you have already installed your [Front-end]({{% relref "software/installation_process/frontend_installation/manual/frontend_install" %}}), configured [KVM Hosts]({{% relref "/software/installation_process/cluster_installation/kvm_node_installation#kvm-node" %}}), and set up an OpenNebula cloud with at least one virtualization node. This Chapter is organized as follows: diff --git a/content/product/cluster_configuration/backup_system/overview.md b/content/product/cluster_configuration/backup_system/overview.md index c7aaa9134..f502b714a 100644 --- a/content/product/cluster_configuration/backup_system/overview.md +++ b/content/product/cluster_configuration/backup_system/overview.md @@ -22,7 +22,7 @@ Define backup datastores by using the available options for backends or datastor ## Basic Guide Outline -Before reading this guide, you should have installed your [Frontend]({{% relref "front_end_installation" %}}), the [KVM Hosts]({{% relref "kvm_node_installation#kvm-node" %}}) and have an OpenNebula cloud up and running with at least one virtualization node. +Before reading this guide, you should have installed your [Frontend]({{% relref "frontend_install" %}}), the [KVM Hosts]({{% relref "kvm_node_installation#kvm-node" %}}) and have an OpenNebula cloud up and running with at least one virtualization node. To configure your backup system, find about datastore driver options to save your VM backups: * [Restic backend]({{% relref "restic#vm-backups-restic" %}}) diff --git a/content/product/cluster_configuration/backup_system/veeam.md b/content/product/cluster_configuration/backup_system/veeam.md index b354c0f21..332e84294 100644 --- a/content/product/cluster_configuration/backup_system/veeam.md +++ b/content/product/cluster_configuration/backup_system/veeam.md @@ -151,20 +151,20 @@ onecluster adddatastore SELinux and AppArmor may cause issues in the backup server if not configured properly. Either disable them or make sure to provide permissions to the datastore directories (``/var/lib/one/datastores``). {{< /alert >}} -You can find more details regarding the Rsync datastore in [Backup Datastore: Rsync]({{% relref "../../../product/cluster_configuration/backup_system/rsync.md" %}}). +You can find more details regarding the Rsync datastore in [Backup Datastore: Rsync]({{% relref "product/cluster_configuration/backup_system/rsync.md" %}}). ### 3. Install and configure the oVirtAPI module -In order to install the oVirtAPI module, you need to have the OpenNebula repository configured in the backup server. You can do so by following the instructions in [OpenNebula Repositories]({{% relref "../../../software/installation_process/manual_installation/opennebula_repository_configuration.md" %}}). Then, install the opennebula-ovirtapi package. +In order to install the oVirtAPI module, you need to have the OpenNebula repository configured in the backup server. You can do so by following the instructions in [OpenNebula Repositories]({{% relref "software/installation_process/frontend_installation/manual/opennebula_repository_configuration.md" %}}). Then, install the opennebula-ovirtapi package. The configuration file can be found at ``/etc/one/ovirtapi-server.yml``. You should change the following variables before starting the service: * ``one_xmlrpc``: Address of the OpenNebula Front-end. Please do not include any prefixes such as ``http://``, only the IP address itself is needed. * ``endpoint_port``: Port used by the OpenNebula RPC endpoint (defaults to 2633). * ``public_ip``: Address that Veeam is going to use to communicate with the ovirtapi server. -* ``backup_freeze``: (Optional) Controls which filesystem freeze mode OpenNebula requests when performing backups initiated via the oVirtAPI/Veeam integration. Valid values are `NONE`, `AGENT`, and `SUSPEND`. For details on each mode see the Backup Modes section in the backup guide: [Backup Modes]({{% relref "../../../product/virtual_machines_operation/virtual_machine_backups/operations/#backup-modes" %}}). +* ``backup_freeze``: (Optional) Controls which filesystem freeze mode OpenNebula requests when performing backups initiated via the oVirtAPI/Veeam integration. Valid values are `NONE`, `AGENT`, and `SUSPEND`. For details on each mode see the Backup Modes section in the backup guide: [Backup Modes]({{% relref "product/virtual_machines_operation/virtual_machine_backups/operations/#backup-modes" %}}). {{< alert title="Important" type="info" >}} You may see the 5554 port in the ``public_ip`` variable in the default settings, this is no longer needed so avoid using it. Leave only the IP address in the variable, no port needed. diff --git a/content/product/control_plane_configuration/data_center_federation/config.md b/content/product/control_plane_configuration/data_center_federation/config.md index 4493aa209..192065959 100644 --- a/content/product/control_plane_configuration/data_center_federation/config.md +++ b/content/product/control_plane_configuration/data_center_federation/config.md @@ -30,7 +30,7 @@ The federation can be set up with MySQL/MariaDB or SQLite as backends, but you c ## Step 1. Configure the OpenNebula Federation Master Zone -Start by picking an OpenNebula to act as master of the federation. The *master* OpenNebula will be responsible for updating shared information across Zones and replicating the updates to the *slaves*. You may start with an existing installation or with a new one (see the [installation guide]({{% relref "front_end_installation" %}})). +Start by picking an OpenNebula to act as master of the federation. The *master* OpenNebula will be responsible for updating shared information across Zones and replicating the updates to the *slaves*. You may start with an existing installation or with a new one (see the [installation guide]({{% relref "frontend_install" %}})). {{< alert title="Note" type="info" >}} When installing a new *master* from scratch be sure to start it at least once to properly bootstrap the database.{{< /alert >}} @@ -60,7 +60,7 @@ You are now ready to add *slave* Zones. ## Step 2. Adding a New Federation Slave Zone -- **Slave**: Install OpenNebula on the *slave* as usual following the [installation guide]({{% relref "front_end_installation" %}}). Start OpenNebula at least once to bootstrap the Zone database. +- **Slave**: Install OpenNebula on the *slave* as usual following the [installation guide]({{% relref "frontend_install" %}}). Start OpenNebula at least once to bootstrap the Zone database. - **Slave**: Stop OpenNebula. - **Master**: Create a Zone for the *slave* and write down the new Zone ID. This can be done via Sunstone or with the onezone command. diff --git a/content/product/control_plane_configuration/data_center_federation/overview.md b/content/product/control_plane_configuration/data_center_federation/overview.md index 817078508..956f7d4e8 100644 --- a/content/product/control_plane_configuration/data_center_federation/overview.md +++ b/content/product/control_plane_configuration/data_center_federation/overview.md @@ -33,7 +33,7 @@ Although a single Sunstone server can connect to different Zones, all the other ## How Should I Read This Chapter -Before starting, it’s required to have at least two new instances of [OpenNebula Front-end]({{% relref "front_end_installation" %}}) ready to configure as Federation. +Before starting, it’s required to have at least two new instances of [OpenNebula Front-end]({{% relref "frontend_install" %}}) ready to configure as Federation. Start by reading the [Federation Configuration]({{% relref "config#federationconfig" %}}) section to learn how to set-up the OpenNebula Federation, and continue with [Federation Usage]({{% relref "usage#federationmng" %}}) to learn how to use the Zones with CLI and Sunstone GUI. diff --git a/content/product/control_plane_configuration/high_availability/overview.md b/content/product/control_plane_configuration/high_availability/overview.md index a78121e6c..58f115017 100644 --- a/content/product/control_plane_configuration/high_availability/overview.md +++ b/content/product/control_plane_configuration/high_availability/overview.md @@ -16,7 +16,7 @@ OpenNebula provides high availability mechanisms both for the Front-end and for ## How Should I Read This Chapter -Before starting, you need to have [OpenNebula Front-end]({{% relref "front_end_installation" %}}) running. +Before starting, you need to have [OpenNebula Front-end]({{% relref "frontend_install" %}}) running. Read the section [Front-end HA Setup]({{% relref "frontend_ha#frontend-ha-setup" %}}) to learn how to set up a highly available (HA) OpenNebula Front-end. Continue with [Virtual Machines High Availability]({{% relref "vm_ha#ftguide" %}}) if you are interested in a way to provide high availability to your Virtual Machines. diff --git a/content/product/integration_references/cloud_provider_driver_development/overview.md b/content/product/integration_references/cloud_provider_driver_development/overview.md index 999b95854..4d22e44aa 100644 --- a/content/product/integration_references/cloud_provider_driver_development/overview.md +++ b/content/product/integration_references/cloud_provider_driver_development/overview.md @@ -75,7 +75,7 @@ Each driver must include a defined set of configuration files for both the Terra
- **Ansible** required files: - `site.yaml`: Serves as the main entry point to the OneDeploy playbooks. It may also include additional tasks or roles such as connectivity checks or custom configuration steps to prepare the environment. - - `templates/`: Contains Jinja2-formatted inventory templates for each supported deployment configuration. These templates follow the standard OneDeploy inventory format. The driver uses the `opennebula_form` dynamic inventory plugin to render these templates at runtime, enabling support for multiple environment configurations. For further information, refer to the [OneDeploy usage guide]({{% relref "/software/installation_process/automatic_installation_with_onedeploy/" %}}). + - `templates/`: Contains Jinja2-formatted inventory templates for each supported deployment configuration. These templates follow the standard OneDeploy inventory format. The driver uses the `opennebula_form` dynamic inventory plugin to render these templates at runtime, enabling support for multiple environment configurations. For further information, refer to the [OneDeploy usage guide]({{% relref "/software/installation_process/advanced_installation_with_onedeploy/" %}}). - `inventory`: You must provide a minimal inventory file which declares `opennebula_form` as the dynamic inventory source. This enables OneForm to dynamically construct the actual inventory used during deployment. ## Driver Workflow diff --git a/content/product/operation_references/opennebula_services_configuration/fireedge.md b/content/product/operation_references/opennebula_services_configuration/fireedge.md index 013746d29..9416b683b 100644 --- a/content/product/operation_references/opennebula_services_configuration/fireedge.md +++ b/content/product/operation_references/opennebula_services_configuration/fireedge.md @@ -19,7 +19,7 @@ weight: "3" -The OpenNebula FireEdge server provides a **next-generation web-management interface** for remote OpenNebula Cluster provisioning as well as additional functionality to Sunstone. It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "front_end_installation" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-fireedge` with the system service `opennebula-fireedge`. +The OpenNebula FireEdge server provides a **next-generation web-management interface** for remote OpenNebula Cluster provisioning as well as additional functionality to Sunstone. It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "frontend_install" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-fireedge` with the system service `opennebula-fireedge`. ## Main Features diff --git a/content/product/operation_references/opennebula_services_configuration/oneflow.md b/content/product/operation_references/opennebula_services_configuration/oneflow.md index c6a80e574..99e51c783 100644 --- a/content/product/operation_references/opennebula_services_configuration/oneflow.md +++ b/content/product/operation_references/opennebula_services_configuration/oneflow.md @@ -15,7 +15,7 @@ weight: "4" -OneFlow **orchestrates multi-VM services** as a whole, interacts with the OpenNebula Daemon to manage the Virtual Machines (starts, stops), and can be controlled via the Sunstone GUI or over CLI. It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "front_end_installation" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-flow` with the system service `opennebula-flow`. +OneFlow **orchestrates multi-VM services** as a whole, interacts with the OpenNebula Daemon to manage the Virtual Machines (starts, stops), and can be controlled via the Sunstone GUI or over CLI. It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "frontend_install" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-flow` with the system service `opennebula-flow`. Read more in [Multi-VM Service Management]({{% relref "../../virtual_machines_operation/multi-vm_workflows/index#multivm-service-management" %}}). diff --git a/content/product/operation_references/opennebula_services_configuration/onegate.md b/content/product/operation_references/opennebula_services_configuration/onegate.md index c8ae51539..0e5d0128e 100644 --- a/content/product/operation_references/opennebula_services_configuration/onegate.md +++ b/content/product/operation_references/opennebula_services_configuration/onegate.md @@ -13,9 +13,9 @@ weight: "5" -The OneGate server allows **Virtual Machines to pull and push information from/to OpenNebula**. It can be used with both the KVM and LXC hypervisors if the guest operating system has preinstalled the OpenNebula [contextualization package]({{% relref "../../virtual_machines_operation/guest_operating_systems/creating_images#os-install" %}}). It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "front_end_installation" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-gate` with the system service `opennebula-gate`. +The OneGate server allows **Virtual Machines to pull and push information from/to OpenNebula**. It can be used with both the KVM and LXC hypervisors if the guest operating system has preinstalled the OpenNebula [contextualization package]({{% relref "product/virtual_machines_operation/guest_operating_systems/creating_images#os-install" %}}). It’s a dedicated daemon installed by default as part of the [Single Front-end Installation]({{% relref "frontend_install" %}}), but can be deployed independently on a different machine. The server is distributed as an operating system package `opennebula-gate` with the system service `opennebula-gate`. -Read more in [OneGate Usage]({{% relref "../../virtual_machines_operation/multi-vm_workflows/onegate_usage#onegate-usage" %}}). +Read more in [OneGate Usage]({{% relref "product/virtual_machines_operation/multi-vm_workflows/onegate_usage#onegate-usage" %}}). ## Recommended Network Setup diff --git a/content/product/virtual_machines_operation/_index.md b/content/product/virtual_machines_operation/_index.md index ab53e163c..03a99a669 100644 --- a/content/product/virtual_machines_operation/_index.md +++ b/content/product/virtual_machines_operation/_index.md @@ -24,7 +24,7 @@ Through these guides Virtual Machine or VM is used as a generic abstraction that ## How Should I Read This Chapter -Before reading this Chapter, you should have already installed your [Front-end]({{% relref "../../software/installation_process/manual_installation/front_end_installation.md" %}}), the [KVM Hosts]({{% relref "../../software/installation_process/manual_installation/kvm_node_installation.md" %}}) or [LXC Hosts]({{% relref "../../software/installation_process/manual_installation/kvm_node_installation.md" %}}) and have an OpenNebula cloud up and running with at least one virtualization node. +Before reading this Chapter, you should have already installed your [Front-end]({{% relref "software/installation_process/frontend_installation/manual/frontend_install.md" %}}), the [KVM Hosts]({{% relref "software/installation_process/cluster_installation/kvm_node_installation.md" %}}) or [LXC Hosts]({{% relref "../../software/installation_process/cluster_installation/kvm_node_installation.md" %}}) and have an OpenNebula cloud up and running with at least one virtualization node. ## Hypervisor Compatibility diff --git a/content/software/installation_process/automatic_installation_with_onedeploy/_index.md b/content/software/installation_process/advanced_installation_with_onedeploy/_index.md similarity index 90% rename from content/software/installation_process/automatic_installation_with_onedeploy/_index.md rename to content/software/installation_process/advanced_installation_with_onedeploy/_index.md index f67280d56..8834c3138 100644 --- a/content/software/installation_process/automatic_installation_with_onedeploy/_index.md +++ b/content/software/installation_process/advanced_installation_with_onedeploy/_index.md @@ -1,11 +1,11 @@ --- -title: "Automatic Installation with OneDeploy" +title: "Advanced Installation with OneDeploy" date: "2025-02-17" description: "Perform Devops-like deployment of a production-ready OpenNebula cloud." categories: -pageintoc: "25" +pageintoc: "1" tags: -weight: "1" +weight: "3" --- diff --git a/content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_overview.md b/content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_overview.md similarity index 100% rename from content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_overview.md rename to content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_overview.md diff --git a/content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds.md b/content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_tutorial_local_ds.md similarity index 100% rename from content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_local_ds.md rename to content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_tutorial_local_ds.md diff --git a/content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_shared_ds.md b/content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_tutorial_shared_ds.md similarity index 100% rename from content/software/installation_process/automatic_installation_with_onedeploy/one_deploy_tutorial_shared_ds.md rename to content/software/installation_process/advanced_installation_with_onedeploy/one_deploy_tutorial_shared_ds.md diff --git a/content/software/installation_process/build_from_source_code/compile.md b/content/software/installation_process/build_from_source_code/compile.md index 70abd7898..61e004a98 100644 --- a/content/software/installation_process/build_from_source_code/compile.md +++ b/content/software/installation_process/build_from_source_code/compile.md @@ -115,7 +115,7 @@ oneadmin@frontend:~/opennebula-x.y.z $> sudo ./install.sh -u oneadmin -g oneadmi ## Ruby Dependencies -All required Ruby gems are provided by the **opennebula-rubygems** package. Please check the [Installation guide]({{% relref "front_end_installation" %}}) for more information on installing this package. +All required Ruby gems are provided by the **opennebula-rubygems** package. Please check the [Installation guide]({{% relref "frontend_install" %}}) for more information on installing this package. ## Building Python Bindings from Source diff --git a/content/software/installation_process/cluster_installation/_index.md b/content/software/installation_process/cluster_installation/_index.md new file mode 100644 index 000000000..961b2d788 --- /dev/null +++ b/content/software/installation_process/cluster_installation/_index.md @@ -0,0 +1,12 @@ +--- +title: "Cluster Installation" +date: "2026-04-15" +description: "Install Clusters using one of OpenNebula's Cluster deployment options." +categories: +pageintoc: "168" +tags: +weight: "2" +--- + + + diff --git a/content/software/installation_process/cluster_installation/automated.md b/content/software/installation_process/cluster_installation/automated.md new file mode 100644 index 000000000..581addce3 --- /dev/null +++ b/content/software/installation_process/cluster_installation/automated.md @@ -0,0 +1,22 @@ +--- +title: "Automatic Cluster Provisioning with OneForm" +linkTitle: "Automatic - OneForm" +date: "2026-04-15" +description: +categories: +pageintoc: "26" +tags: [OneForm, cluster, deployment, automatic] +weight: "1" +--- + +OneForm is OpenNebula’s automated cloud provisioning tool. It serves as an automated “cloud-on-demand” engine, allowing you to provision resources on-premises, on remote bare-metal, or public cloud providers through a simple, streamlined workflow. You can provision Clusters through the Sunstone user interface, the CLI, or the API. + +The OneForm provisioning documentation demonstrates how to provision and manage clusters automatically with OneForm. The OneForm documentation is divided into three separate concepts: + +* **Providers**: OpenNebula entities that abstract the handling of configuration and credentials for bare-metal or cloud hardware or virtual resources. +* **Provisions**: Provisions are Cluster instances deployed by OneForm through the provisioning process. +* **Operations**: Tasks executed on Clusters after provisioning, such as scaling, monitoring, maintenance and deprovisioning. + +Please refer to the [OneForm documentation]({{% relref "product/cluster_provisioning/" %}}) for details on how to create and use Providers and automatically provision Clusters. + +In order to use OneForm, you should first install an OpenNebula Front-end using one of the different deployment options available, refer to the [Front-end Installation Guides]({{% relref "software/installation_process/frontend_installation/" %}}) for details. \ No newline at end of file diff --git a/content/software/installation_process/manual_installation/kvm_node_installation.md b/content/software/installation_process/cluster_installation/kvm_node_installation.md similarity index 96% rename from content/software/installation_process/manual_installation/kvm_node_installation.md rename to content/software/installation_process/cluster_installation/kvm_node_installation.md index 620118668..6947254fc 100644 --- a/content/software/installation_process/manual_installation/kvm_node_installation.md +++ b/content/software/installation_process/cluster_installation/kvm_node_installation.md @@ -1,10 +1,11 @@ --- title: "KVM Node Installation" +linkTitle: "Manual - KVM Node" date: "2025-02-17" description: categories: pageintoc: "176" -tags: +tags: [manual, cluster, deployment] weight: "7" --- @@ -15,7 +16,7 @@ weight: "7" This page shows you how to configure OpenNebula KVM Node from the binary packages. {{< alert title="Note" type="info" >}} -Before reading this chapter, you should have at least installed your [Front-end node]({{% relref "front_end_installation" %}}).{{< /alert >}} +Before reading this chapter, you should have at least installed your [Front-end node]({{% relref "frontend_install" %}}).{{< /alert >}} ## Overview @@ -25,7 +26,7 @@ By using KVM, you can run multiple Virtual Machines with unmodified Linux or Win To understand the specific requirements, functionalities, and limitations of the KVM driver, see [KVM Driver]({{% relref "kvm_driver" %}}). -You can then check the [Storage]({{% relref "../../../product/cluster_configuration/storage_system/overview" %}}) and [Networking]({{% relref "../../../product/cluster_configuration/networking_system/overview" %}}) system configuration sections to deploy Virtual Machines on your KVM nodes and access them remotely over the network. +You can then check the [Storage]({{% relref "product/cluster_configuration/storage_system/overview" %}}) and [Networking]({{% relref "product/cluster_configuration/networking_system/overview" %}}) system configuration sections to deploy Virtual Machines on your KVM nodes and access them remotely over the network. @@ -305,7 +306,7 @@ If the Host turns to `err` state instead of `on`, check OpenNebula log `/var/log ### Add Host with Sunstone -Open Sunstone as documented [here]({{% relref "front_end_installation#verify-frontend-section-sunstone" %}}). On the left side menu go to **Infrastructure** → **Hosts**. Click on the `+` button. +Open Sunstone as documented [here]({{% relref "frontend_install#verify-frontend-section-sunstone" %}}). On the left side menu go to **Infrastructure -> Hosts**. Click on the `+` button. ![sunstone_select_create_host](/images/sunstone_select_create_host.png) diff --git a/content/software/installation_process/manual_installation/lxc_node_installation.md b/content/software/installation_process/cluster_installation/lxc_node_installation.md similarity index 95% rename from content/software/installation_process/manual_installation/lxc_node_installation.md rename to content/software/installation_process/cluster_installation/lxc_node_installation.md index ad58f4ecf..bea34dc40 100644 --- a/content/software/installation_process/manual_installation/lxc_node_installation.md +++ b/content/software/installation_process/cluster_installation/lxc_node_installation.md @@ -1,10 +1,11 @@ --- title: "LXC Node Installation" +linkTitle: "Manual - LXC Node" date: "2025-02-17" description: categories: -pageintoc: "180" -tags: +pageintoc: "177" +tags: [manual, cluster, deployment] weight: "7" --- @@ -17,7 +18,7 @@ weight: "7" This page shows you how to configure OpenNebula LXC Node from the binary packages. {{< alert title="Note" type="info" >}} -Before reading this chapter, you should have at least installed your [Front-end node]({{% relref "front_end_installation" %}}).{{< /alert >}} +Before reading this chapter, you should have at least installed your [Front-end node]({{% relref "frontend_install" %}}).{{< /alert >}} ## Overview @@ -27,7 +28,7 @@ From the perspective of a hypervisor node, such a container environment is just To understand the specific requirements, functionalities, and limitations of the LXC driver, see [LXC Driver]({{% relref "lxc_driver" %}}). -You can then check the [Storage]({{% relref "../../../product/cluster_configuration/storage_system/overview" %}}) and [Networking]({{% relref "../../../product/cluster_configuration/networking_system/overview" %}}) system configuration sections to deploy Virtual Machines on your LXC nodes and access them remotely over the network. +You can then check the [Storage]({{% relref "product/cluster_configuration/storage_system/overview" %}}) and [Networking]({{% relref "../../../product/cluster_configuration/networking_system/overview" %}}) system configuration sections to deploy Virtual Machines on your LXC nodes and access them remotely over the network. ## Step 1. Add OpenNebula Repositories @@ -263,7 +264,7 @@ If the host turns to `err` state instead of `on`, check OpenNebula log `/var/log ### Add Host with Sunstone -Open Sunstone as documented [here]({{% relref "front_end_installation#verify-frontend-section-sunstone" %}}). On the left side menu go to **Infrastructure** → **Hosts**. Click on the `+` button. +Open Sunstone as documented [here]({{% relref "frontend_install#verify-frontend-section-sunstone" %}}). On the left side menu go to **Infrastructure** → **Hosts**. Click on the `+` button. ![sunstone_select_create_host](/images/sunstone_select_create_host.png) diff --git a/content/software/installation_process/frontend_installation/_index.md b/content/software/installation_process/frontend_installation/_index.md new file mode 100644 index 000000000..145bd6b1f --- /dev/null +++ b/content/software/installation_process/frontend_installation/_index.md @@ -0,0 +1,12 @@ +--- +title: "Front-end Installation" +date: "2026-04-15" +description: "Install the OpenNebula Front-end via one of several options." +categories: +pageintoc: "168" +tags: +weight: "1" +--- + + + diff --git a/content/software/installation_process/frontend_installation/automated.md b/content/software/installation_process/frontend_installation/automated.md new file mode 100644 index 000000000..73f6a3dc6 --- /dev/null +++ b/content/software/installation_process/frontend_installation/automated.md @@ -0,0 +1,230 @@ +--- +title: "Automatic Installation with miniONE" +linkTitle: "Automatic - miniONE" +date: "2026-04-15" +description: +categories: +pageintoc: "26" +tags: [miniONE, deployment, installation, automatic] +weight: "1" +--- + +Automatic installation of an OpenNebula Front-end can be achieved using the miniONE quick installation script. The miniONE installation script automatically configures the target server to deploy a stripped-down version of OpenNebula with the essential modules to run a cloud Cluster. After installing miniONE, you will be able to deploy Virtual Machines, provision Clusters with on-premises or cloud resources and manage your cloud using the command line, the API or the Sunstone user interface. + +## Prerequisites + +You may wish to install the miniONE OpenNebula Front-end on its own dedicated machine, that is only intended for management and not workload, in which case you should follow the guidelines for "Front-end only". You may also install the miniONE OpenNebula Front-end on the same machine you intend to use for compute workloads, in which case you should consider your intended use-case, guidance is given below for a small Kubernetes Cluster and an AI Factory. + +You may use on-premises hardware, virtual or bare-metal resources from a cloud provider to install miniONE. If you are intending to use the target machine only for the OpenNebula Front-end and not Cluster workloads, a Virtual Machine meeting the requirements given below would suffice. If you are intending to use the target machine for Cluster workloads, particularly Kubernetes workloads, it is highly recommended to use a bare-metal instance. + +To install miniONE it is important to meet the following prerequisites for the machine on which you intend to install miniONE: + +**Supported operating systems:** + - Ubuntu 22.04 or 24.04 + - See the [Platform Release Notes]({{% relref "software/release_information/release_notes/platform_notes.md" %}}) for other compatible operating systems + +**Minimum hardware:** +* Front-end only: + * 16 GiB RAM + * 80 GiB free disk space + +* Kubernetes: + - 64 GiB RAM + - 120 GiB free disk space + +* AI Factory: + - 128 GiB RAM + - 512 GiB free disk space + - NVIDIA L40S or H100 GPU + +**Configuration:** + - Access to the privileged user (root) account + - An SSH server running on port 22 + - Open ports: + - 22 (SSH) + - 80 (for the web UI) + +## Installing miniONE + +Log in to the machine on which you intend to install miniONE (or use SSH on remote hardware). Open a terminal and switch to the root user with the `sudo` command: + +```bash +sudo -i +``` + +Download miniONE, run: + +{{% if-version is="7.0" %}} +```bash +wget 'https://github.com/OpenNebula/minione/releases/download/v7.0.1/minione' +``` +{{% /if-version %}} +{{% if-version is="7.1" %}} +```bash +wget 'https://github.com/OpenNebula/minione/releases/latest/download/minione' +``` +{{% /if-version %}} +{{% if-version is="7.2" %}} +```bash +wget 'https://github.com/OpenNebula/minione/releases/download/v7.2.0/minione' +``` +{{% /if-version %}} +{{% if-version is="7.3" %}} +```bash +wget 'https://github.com/OpenNebula/minione/releases/latest/download/minione' +``` +{{% /if-version %}} + +Make the `minione` script executable: + +```bash +chmod +x minione +``` + +Now run the installation script: + +```bash +./minione +``` + +{{< alert title="Tip" type="primary" >}} miniONE will create credentials with a randomized password for logging into the Sunstone UI. You can use the `--password` option to enter a secure and memorable password of your own: `./minione --password `{{< /alert >}} + +The miniONE script executes the installation while logging output to the terminal. Installation usually takes between one and three minutes on most machines. Once finished, miniONE displays a report in the terminal with connection parameters and login credentials: + +```default +### Report +OpenNebula 7.0 was installed +Sunstone is running on: + http://192.168.1.130/ +Use following to login: + user: oneadmin + password: ZMCoOWUsBg +``` + +Please take a note of the IP address and login credentials, you will need them later. + +Finally update the ``localhost`` status: + +```bash +sudo -u oneadmin onehost sync --force +``` + +This command might take 2-3 minutes to complete, check the status of the `localhost` periodically with `sudo -u oneadmin onehost list` until the `STAT` column of the `localhost` item reads `on`. + +At this point, you have successfully installed miniONE. OpenNebula services should be running, and the system is ready for your first login. + +## Verify the Installation + +Now verify the installation by logging in to OpenNebula's Sunstone UI. + +Point your browser to the Edge IP and port provided by the miniONE report, in this case `192.168.1.130`, or simply to `http://localhost`. You should be greeted with the Sunstone login screen: + +{{< image + pathDark="/images/quickstart/dark/sunstone_login_page.png" + path="/images/quickstart/light/sunstone_login_page.png" + alt="Sunstone login" align="center" width="50%" mb="20px" +>}} + +In the **Username** input field, type `oneadmin`. For **Password**, enter the password provided by miniONE at the end of the report (in this example, `ZMCoOWUsBg`) then press `Enter` or click **SIGN IN NOW**. + +The screen will display the Sunstone Dashboard: + +{{< image + pathDark="/images/quickstart/dark/sunstone_dashboard.png" + path="/images/quickstart/light/sunstone_dashboard.png" + alt="Sunstone dashboard" align="center" width="90%" mb="20px" +>}} + +As you can see, the Dashboard indicates the following installed components: + +- 1 VM template +- 1 image +- 1 Virtual Network + +The existing Virtual Network is a bridged network attached to a local interface named `vnet`. To inspect this network, in Sunstone open the left-hand menu (hover the mouse over the left-hand sidebar), then click **Networks** --> **Virtual Networks**: + +{{< image + pathDark="/images/quickstart/dark/sunstone_select_vnetwork.png" + path="/images/quickstart/light/sunstone_select_vnetwork.png" + alt="Sunstone select vnet" align="center" width="90%" mb="20px" +>}} + +Sunstone will display the **Virtual Networks** screen. Click the item labelled `vnet` to display information about this network: + +{{< image + pathDark="/images/quickstart/dark/sunstone_network_details.png" + path="/images/quickstart/light/sunstone_network_details.png" + alt="Sunstone vnet screen" align="center" width="90%" mb="20px" +>}} + +During installation, a KVM virtualization Host was automatically configured on the local machine. To inspect the KVM host, in Sunstone open the left-hand menu, then click **Infrastructure** -> **Hosts**. + +### Deploy a Virtual Machine Locally + +miniONE automatically downloaded the template for a VM with Alpine Linux 3.20 preinstalled. Through the Sunstone UI, we can now instantiate this VM on the local KVM Host with a few clicks. + +To deploy the Alpine Linux VM, in the left-hand sidebar go to **Templates** -> **VM Templates**. This screen displays a list of all VM templates installed on the system. In this case, only the **Alpine Linux 3.20** template is installed: + +{{< image + pathDark="/images/quickstart/dark/sunstone_vm_templates_alpine.png" + path="/images/quickstart/light/sunstone_vm_templates_alpine.png" + alt="Sunstone login" align="center" width="90%" mb="20px" +>}} + +To instantiate the VM template, click the template item and click the **Instantiate** icon at the top. + +Sunstone will display the first screen of the **Instantiate VM Template** wizard: + +{{< image + pathDark="/images/quickstart/dark/sunstone_instantiate_vm_1.png" + path="/images/quickstart/light/sunstone_instantiate_vm_1.png" + alt="Sunstone instantiate VM 1" align="center" width="90%" mb="20px" +>}} + +Leave the **Capacity**, **Ownership** and **VM Group** parameters with their default values. Click **Next**. + +The next screen allows you to see and modify further parameters for the VM, including selecting the Virtual Network or scheduling actions. + +{{< image + pathDark="/images/quickstart/dark/sunstone_instantiate_vm_2.png" + path="/images/quickstart/light/sunstone_instantiate_vm_2.png" + alt="Sunstone instantiate VM 2" align="center" width="90%" mb="20px" +>}} + +Click **Finish**. + +OpenNebula will instantiate the VM template. For the Alpine Linux VM, this should take just a few seconds. Once instantiation is complete, Sunstone should display the **Instances** -> **VMs** screen, with the Alpine Linux VM as the sole instance: + +{{< image + pathDark="/images/quickstart/dark/sunstone_vm_instances.png" + path="/images/quickstart/light/sunstone_vm_instances.png" + alt="Sunstone login" align="center" width="90%" mb="20px" +>}} + +The green dot to the left of the VM name indicates that the VM is running. Note that you may need to click the **Refresh** icon + + + + + + at top left for the VM to display the running state. + +### Log in to the Virtual Machine + +The quickest way to log into the VM is by VNC, available directly in Sunstone. Just click the VNC icon and Sunstone will display the VM boot messages screen directly in your browser in another tab. + +{{< image + pathDark="/images/quickstart/dark/sunstone_vnc_alpine.png" + path="/images/quickstart/light/sunstone_vnc_alpine.png" + alt="Sunstone login" align="center" width="90%" mb="20px" +>}} + +Log in as `root` with password `opennebula`. You can then use the command line to explore the VM and run processes: + +* Try running `ping 1.1.1.1` to test the internet connection +* Try running `top` to see the processes running on the machine + +If the above procedure works, you have successfully installed miniONE and it is ready to deploy and manage your cloud infrastructure. + + + diff --git a/content/software/installation_process/manual_installation/_index.md b/content/software/installation_process/frontend_installation/manual/_index.md similarity index 86% rename from content/software/installation_process/manual_installation/_index.md rename to content/software/installation_process/frontend_installation/manual/_index.md index 8fb3f3713..059153e84 100644 --- a/content/software/installation_process/manual_installation/_index.md +++ b/content/software/installation_process/frontend_installation/manual/_index.md @@ -1,5 +1,6 @@ --- title: "Manual Installation with System Packages" +linkTitle: "Manual - Packages" date: "2025-02-17" description: "Manually install the Front-end and hypervisors from the OpenNebula packages." categories: @@ -18,4 +19,4 @@ weight: "2" -This sections provides details on installing an OpenNebula cloud, beginning with the OpenNebula Front-end and including services and hypervisors. The complete references for configuring OpenNebula services, templates, and hypervisor nodes may be found in [Operation References]({{% relref "../../../product/operation_references/" %}}). +This sections provides details on installing an OpenNebula cloud, beginning with the OpenNebula Front-end and including services and hypervisors. The complete references for configuring OpenNebula services, templates, and hypervisor nodes may be found in [Operation References]({{% relref "product/operation_references/" %}}). diff --git a/content/software/installation_process/manual_installation/database.md b/content/software/installation_process/frontend_installation/manual/database.md similarity index 95% rename from content/software/installation_process/manual_installation/database.md rename to content/software/installation_process/frontend_installation/manual/database.md index 24290e467..013f01a58 100644 --- a/content/software/installation_process/manual_installation/database.md +++ b/content/software/installation_process/frontend_installation/manual/database.md @@ -85,7 +85,7 @@ mysql> SET GLOBAL TRANSACTION ISOLATION LEVEL READ COMMITTED; ### Configure OpenNebula -Before you run OpenNebula for the first time in the next section [Front-end Installation]({{% relref "front_end_installation" %}}), you’ll need to set the database backend and connection details in the configuration file [/etc/one/oned.conf]({{% relref "oned#oned-conf" %}}) as follows: +Before you run OpenNebula for the first time in the next section [Front-end Installation]({{% relref "frontend_installation.md" %}}), you’ll need to set the database backend and connection details in the configuration file [/etc/one/oned.conf]({{% relref "oned#oned-conf" %}}) as follows: ```default # Sample configuration for MySQL diff --git a/content/software/installation_process/manual_installation/front_end_installation.md b/content/software/installation_process/frontend_installation/manual/frontend_install.md similarity index 92% rename from content/software/installation_process/manual_installation/front_end_installation.md rename to content/software/installation_process/frontend_installation/manual/frontend_install.md index 7f07bb507..2bb2c14a3 100644 --- a/content/software/installation_process/manual_installation/front_end_installation.md +++ b/content/software/installation_process/frontend_installation/manual/frontend_install.md @@ -10,11 +10,11 @@ weight: "6" - + -This page describes how to install a complete OpenNebula Front-end from binary packages available in the [software repositories]({{% relref "opennebula_repository_configuration#repositories" %}}) configured in the previous section. We recommend using a Host with the supported operating system as installation from packages provides the best experience and is referenced in other places of this documentation. If there are no packages for your distribution, you might consider reading the [Building from Source Code]({{% relref "compile#compile" %}}) guide to build OpenNebula on your own. +This page describes how to install a complete OpenNebula Front-end from binary packages available in the [software repositories]({{% relref "opennebula_repository_configuration" %}}) configured in the previous section. We recommend using a Host with the supported operating system as installation from packages provides the best experience and is referenced in other places of this documentation. If there are no packages for your distribution, you might consider reading the [Building from Source Code]({{% relref "compile#compile" %}}) guide to build OpenNebula on your own. Proceed with the following steps to get the fully-featured OpenNebula Front-end up. @@ -22,7 +22,7 @@ Proceed with the following steps to get the fully-featured OpenNebula Front-end ## Step 1. Configure the OpenNebula Repositories -Follow the [OpenNebula Repositories]({{% relref "opennebula_repository_configuration#repositories" %}}) guide and add software repositories for the OpenNebula edition you are going to deploy. +Follow the [OpenNebula Repositories]({{% relref "opennebula_repository_configuration" %}}) guide and add software repositories for the OpenNebula edition you are going to deploy. ## Step 2. Add Third Party Repositories @@ -52,7 +52,7 @@ Available packages for OpenNebula clients, the Front-end and hypervisor nodes: | **opennebula-tools** | Command Line Interface | | **opennebula-fireedge** | Next-generation GUI [FireEdge]({{% relref "fireedge#fireedge-setup" %}}) | | **opennebula-gate** | [OneGate]({{% relref "onegate_usage#onegate-overview" %}}) server which allows communication between VMs and OpenNebula | -| **opennebula-flow** | [OneFlow]({{% relref "../../../product/virtual_machines_operation/multi-vm_workflows/overview#oneflow-overview" %}}) manages services and elasticity | +| **opennebula-flow** | [OneFlow]({{% relref "/product/virtual_machines_operation/multi-vm_workflows/overview#oneflow-overview" %}}) manages services and elasticity | | **opennebula-migration** | Database migration tools | | **opennebula-node-kvm** | Base setup for KVM hypervisor Node | | **opennebula-node-lxc** | Base setup for LXC hypervisor Node (*not on RHEL 7*) | @@ -63,9 +63,9 @@ Available packages for OpenNebula clients, the Front-end and hypervisor nodes: | **opennebula-rubygems** | Bundled Ruby gem dependencies | | **opennebula-libs** | Shared Ruby libraries among various components | | **opennebula-common** | Shared content for OpenNebula packages | -| **opennebula-common-onecfg** | Helpers for [Configuration Management]({{% relref "../../upgrade_process/configuration_management_ee/" %}}) tool | -| rpm: **opennebula-java**

deb: **libopennebula-java**

deb: **libopennebula-java-doc** | [Java OCA]({{% relref "../../../product/integration_references/system_interfaces/java#java" %}}) Bindings | -| **python3-pyone** | [Python 3 OCA]({{% relref "../../../product/integration_references/system_interfaces/python#python" %}}) Bindings | +| **opennebula-common-onecfg** | Helpers for [Configuration Management]({{% relref "software/upgrade_process/configuration_management_ee/" %}}) tool | +| rpm: **opennebula-java**

deb: **libopennebula-java**

deb: **libopennebula-java-doc** | [Java OCA]({{% relref "/product/integration_references/system_interfaces/java#java" %}}) Bindings | +| **python3-pyone** | [Python 3 OCA]({{% relref "/product/integration_references/system_interfaces/python#python" %}}) Bindings | There are also packages with debugging symbols for some platforms, e.g., `openenbula-debuginfo` on AlmaLinux/RHEL and `opennebula-dbgsym` on Debian/Ubuntu. Other architecture-specific components might come with similarly named packages, please check your packaging database if necessary. @@ -123,9 +123,9 @@ echo 'oneadmin:changeme123' > /var/lib/one/.one/one_auth ``` {{< alert title="Warning" type="warning" >}} -This will set the oneadmin’s password only upon starting OpenNebula for the first time. From that point, you must use the `oneuser passwd` command to change oneadmin’s password. More information on how to change the oneadmin password is [here]({{% relref "../../../product/cloud_system_administration/multitenancy/manage_users#change-credentials" %}}).{{< /alert >}} +This will set the oneadmin’s password only upon starting OpenNebula for the first time. From that point, you must use the `oneuser passwd` command to change oneadmin’s password. More information on how to change the oneadmin password is [here]({{% relref "/product/cloud_system_administration/multitenancy/manage_users#change-credentials" %}}).{{< /alert >}} -Check how to [change oneadmin password]({{% relref "../../../product/cloud_system_administration/multitenancy/manage_users#change-credentials" %}}) for already running services. +Check how to [change oneadmin password]({{% relref "product/cloud_system_administration/multitenancy/manage_users#change-credentials" %}}) for already running services. {{< alert title="Note" type="info" >}} For advanced setup, follow the configuration references for the OpenNebula [Daemon]({{% relref "oned#oned-conf" %}}).{{< /alert >}} @@ -191,7 +191,7 @@ The complete list of operating system services provided by OpenNebula: | **opennebula-prometheus** | OpenNebula Prometheus server | | {{< alert title="Note" type="info" >}} -Since 5.12, the OpenNebula comes with an integrated SSH agent as the `opennebula-ssh-agent` service, which removes the need to copy oneadmin’s SSH private key across your Hosts. For more information, refer to the [passwordless login]({{% relref "kvm_node_installation#kvm-local" %}}) section of the manual.{{< /alert >}} +Since 5.12, the OpenNebula comes with an integrated SSH agent as the `opennebula-ssh-agent` service, which removes the need to copy oneadmin’s SSH private key across your Hosts. For more information, refer to the [passwordless login]({{% relref "software/installation_process/cluster_installation/kvm_node_installation#kvm-local" %}}) section of the manual.{{< /alert >}} You are ready to **start** all OpenNebula services with the following command (NOTE: you might want to remove the services from the command arguments if you skipped their configuration steps above): @@ -200,7 +200,7 @@ systemctl start opennebula opennebula-fireedge opennebula-gate opennebula-flow ``` {{< alert title="Warning" type="warning" >}} -Make sure all required [network ports]({{% relref "front_end_installation#frontend-fw" %}}) are enabled on your firewall (on Front-end or the router).{{< /alert >}} +Make sure all required [network ports]({{% relref "frontend_install#frontend-fw" %}}) are enabled on your firewall (on Front-end or the router).{{< /alert >}} Other OpenNebula services might be started as a dependency but you don’t need to care about them unless they need to be explicitly restarted or stopped. To start these **services automatically on server boot**, it’s necessary to enable them by the following command: diff --git a/content/software/installation_process/manual_installation/opennebula_repository_configuration.md b/content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration.md similarity index 100% rename from content/software/installation_process/manual_installation/opennebula_repository_configuration.md rename to content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration.md diff --git a/content/software/installation_process/manual_installation/opennebula_repository_configuration_ce.md b/content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration_ce.md similarity index 100% rename from content/software/installation_process/manual_installation/opennebula_repository_configuration_ce.md rename to content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration_ce.md diff --git a/content/software/installation_process/manual_installation/opennebula_repository_configuration_ee.md b/content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration_ee.md similarity index 100% rename from content/software/installation_process/manual_installation/opennebula_repository_configuration_ee.md rename to content/software/installation_process/frontend_installation/manual/opennebula_repository_configuration_ee.md diff --git a/content/software/installation_process/manual_installation/overview.md b/content/software/installation_process/frontend_installation/manual/overview.md similarity index 66% rename from content/software/installation_process/manual_installation/overview.md rename to content/software/installation_process/frontend_installation/manual/overview.md index 81240c03b..0fda38770 100644 --- a/content/software/installation_process/manual_installation/overview.md +++ b/content/software/installation_process/frontend_installation/manual/overview.md @@ -12,17 +12,17 @@ weight: "1" -The Front-end is the central part of an OpenNebula installation and is the very first thing that needs to be deployed (or upgraded). Typically it’s a Host where the OpenNebula server-side components are installed and which is responsible for the management of an entire virtualization stack. It can be a physical Host or a Virtual Machine (this decision is left up to the cloud administrator) as long as it matches the [requirements]({{% relref "../../../software/release_information/release_notes/platform_notes#uspng" %}}). +The Front-end is the central part of an OpenNebula installation and is the very first thing that needs to be deployed (or upgraded). Typically it’s a Host where the OpenNebula server-side components are installed and which is responsible for the management of an entire virtualization stack. It can be a physical Host or a Virtual Machine (this decision is left up to the cloud administrator) as long as it matches the [requirements]({{% relref "/software/release_information/release_notes/platform_notes#uspng" %}}). ## How Should I Read This Chapter -Before reading this Chapter make sure you are familiar with the [Architecture Blueprint]({{% relref "../../../getting_started/understand_opennebula/cloud_architecture_and_design/index#architecture-blueprints" %}}), and the blueprint most appropriate to your needs. +Before reading this Chapter make sure you are familiar with the [Architecture Blueprint]({{% relref "/getting_started/understand_opennebula/cloud_architecture_and_design/index#architecture-blueprints" %}}), and the blueprint most appropriate to your needs. -The aim of this Chapter is to give you a quick-start guide to deploying OpenNebula. This is the simplest possible installation, but it is also the foundation for a more complex setup. First, you should go through the [Database Setup]({{% relref "database" %}}) section, especially if you expect to use OpenNebula for production. Then move on to the configuration of [OpenNebula Repositories]({{% relref "opennebula_repository_configuration" %}}), from which you’ll install the required components. And finally, proceed with the [Front-end Installation]({{% relref "front_end_installation" %}}) section. You’ll end up running a fully featured OpenNebula Front-end. +The aim of this Chapter is to give you a quick-start guide to deploying OpenNebula. This is the simplest possible installation, but it is also the foundation for a more complex setup. First, you should go through the [Database Setup]({{% relref "database" %}}) section, especially if you expect to use OpenNebula for production. Then move on to the configuration of [OpenNebula Repositories]({{% relref "opennebula_repository_configuration" %}}), from which you’ll install the required components. And finally, proceed with the [Front-end Installation]({{% relref "frontend_install" %}}) section. You’ll end up running a fully featured OpenNebula Front-end. After reading this Chapter, you can go on to add the [KVM]({{% relref "kvm_node_installation" %}}) or [LXC]({{% relref "lxc_node_installation" %}}) hypervisor nodes. -To scale from a single-Host Front-end deployment to several Hosts for better performance or reliability (HA), continue to the following chapters on [Large-scale Deployment]({{% relref "../../../product/control_plane_configuration/large-scale_deployment/" %}}), [High Availability]({{% relref "../../../product/control_plane_configuration/high_availability/index" %}}) and [Data Center Federation]({{% relref "../../../product/control_plane_configuration/data_center_federation/index" %}}). +To scale from a single-Host Front-end deployment to several Hosts for better performance or reliability (HA), continue to the following chapters on [Large-scale Deployment]({{% relref "/product/control_plane_configuration/large-scale_deployment/" %}}), [High Availability]({{% relref "/product/control_plane_configuration/high_availability/index" %}}) and [Data Center Federation]({{% relref "/product/control_plane_configuration/data_center_federation/index" %}}). ## Hypervisor Compatibility diff --git a/content/software/migration_from_vmware/import_ova.md b/content/software/migration_from_vmware/import_ova.md index 7f1af9e88..13f742a01 100644 --- a/content/software/migration_from_vmware/import_ova.md +++ b/content/software/migration_from_vmware/import_ova.md @@ -23,7 +23,7 @@ The same command allows users to import single VMDK disks as OpenNebula Images, ## Install -OneSwap is developed and maintained by OpenNebula on a [dedicated github repository](https://github.com/OpenNebula/one-swap). Starting from OpenNebula 7.0, OneSwap is being shipped as a package called `opennebula-swap` in the [OpenNebula Repositories]({{% relref "../installation_process/manual_installation/opennebula_repository_configuration#repositories" %}}) for Ubuntu 24.04, AlmaLinux 9 and Debian 12. Install the `opennebula-swap` package with your package manager. +OneSwap is developed and maintained by OpenNebula on a [dedicated github repository](https://github.com/OpenNebula/one-swap). Starting from OpenNebula 7.0, OneSwap is being shipped as a package called `opennebula-swap` in the [OpenNebula Repositories]({{% relref "software/installation_process/frontend_installation/manual/opennebula_repository_configuration.md" %}}) for Ubuntu 24.04, AlmaLinux 9 and Debian 12. Install the `opennebula-swap` package with your package manager. ### Configure diff --git a/content/software/release_information/release_notes/platform_notes.md b/content/software/release_information/release_notes/platform_notes.md index 00087f0a5..50552679d 100644 --- a/content/software/release_information/release_notes/platform_notes.md +++ b/content/software/release_information/release_notes/platform_notes.md @@ -22,13 +22,13 @@ This is the list of the individual platform components that have been through th | **Component** | **Version** | **More information** | |--------------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Red Hat Enterprise Linux | 9, 10 | [Front-end Installation]({{% relref "front_end_installation" %}}) | -| AlmaLinux | 9, 10 | [Front-end Installation]({{% relref "front_end_installation" %}}) | -| Ubuntu Server | 22.04 (LTS), 24.04 (LTS) | [Front-end Installation]({{% relref "front_end_installation" %}}) | -| Debian | 12, 13 | [Front-end Installation]({{% relref "front_end_installation" %}})
Not certified to manage VMware infrastructures | -| SUSE Linux Enterprise | 15 | [Front-end Installation]({{% relref "front_end_installation" %}}) | -| openSUSE | 16 | [Front-end Installation]({{% relref "front_end_installation" %}}) | -| MariaDB or MySQL | Version included in the Linux distribution | [MySQL Setup]({{% relref "../../../software/installation_process/manual_installation/database#mysql" %}}) | +| Red Hat Enterprise Linux | 9, 10 | [Front-end Installation]({{% relref "frontend_install" %}}) | +| AlmaLinux | 9, 10 | [Front-end Installation]({{% relref "frontend_install" %}}) | +| Ubuntu Server | 22.04 (LTS), 24.04 (LTS) | [Front-end Installation]({{% relref "frontend_install" %}}) | +| Debian | 12, 13 | [Front-end Installation]({{% relref "frontend_install" %}})
Not certified to manage VMware infrastructures | +| SUSE Linux Enterprise | 15 | [Front-end Installation]({{% relref "frontend_install" %}}) | +| openSUSE | 16 | [Front-end Installation]({{% relref "frontend_install" %}}) | +| MariaDB or MySQL | Version included in the Linux distribution | [MySQL Setup]({{% relref "software/installation_process/frontend_installation/manual/database#mysql" %}}) | | SQLite | Version included in the Linux distribution | Default DB, no configuration needed | {{< alert title="Note" type="info" >}} diff --git a/content/software/upgrade_process/upgrade_guide/upgrading_single.md b/content/software/upgrade_process/upgrade_guide/upgrading_single.md index d0687473c..9ac3136d4 100644 --- a/content/software/upgrade_process/upgrade_guide/upgrading_single.md +++ b/content/software/upgrade_process/upgrade_guide/upgrading_single.md @@ -12,13 +12,13 @@ weight: "3" {{< alert title="Important" type="info" >}} -If you haven’t done so, please enable the [OpenNebula and needed 3rd party repositories]({{% relref "front_end_installation#setup-opennebula-repos" %}}) before attempting the upgrade process.{{< /alert >}} +If you haven’t done so, please enable the [OpenNebula and needed 3rd party repositories]({{% relref "frontend_install#setup-opennebula-repos" %}}) before attempting the upgrade process.{{< /alert >}} ## Upgrading from 6.x and higher ### Step 1. Check Virtual Machine Status -Before proceeding, make sure you don’t have any VMs in a transient state (prolog, migrate, epilog, save). Wait until these VMs get to a final state (running, suspended, stopped, done). (For more information on the life cycle of Virtual Machines, please see [Virtual Machine Instances]({{% relref "../../../product/virtual_machines_operation/virtual_machines/vm_instances" %}}).) +Before proceeding, make sure you don’t have any VMs in a transient state (prolog, migrate, epilog, save). Wait until these VMs get to a final state (running, suspended, stopped, done). (For more information on the life cycle of Virtual Machines, please see [Virtual Machine Instances]({{% relref "product/virtual_machines_operation/virtual_machines/vm_instances" %}}).) ### Step 2. Set All Hosts to Disable Mode