Skip to content

Commit 4f6dc64

Browse files
F OpenNebula/one#7563: Second update to Installation documentation (#631)
This PR includes updates to the Installation documentation including the direction of the OneDeploy docs to the OneDeploy repository wiki, refinement of the overviews and installation documentation flow.
1 parent c6bf430 commit 4f6dc64

26 files changed

Lines changed: 247 additions & 1372 deletions

File tree

content/getting_started/understand_opennebula/opennebula_concepts/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Thousands of organizations worldwide already rely on OpenNebula as an open alter
5454
| **Cluster and Federation Support** | Multi-cluster and multi-zone federation with centralized governance and distributed scheduling. |
5555
| **Scalability** | Proven scalability in production environments with over 2,500 hypervisor nodes managed within a single OpenNebula instance. |
5656
| **HA and Disaster Recovery** | HA for front-end and host nodes; redundant database and failover mechanisms for service continuity across data centers. |
57-
| **Hybrid & Edge Cloud** | Automatic provisioning on AWS, Equinix Metal, Scaleway and remote OpenNebula zones; optimized for edge deployments. |
57+
| **Hybrid & Edge Cloud** | Automatic provisioning on AWS, Scaleway and remote OpenNebula zones; optimized for edge deployments. |
5858
| **Enhanced Platform Awareness (EPA) Integration** | Support for NUMA\-aware CPU pinning, SR-IOV, and HugePages to provide precise hardware-level optimization and secure, performance-aware orchestration of virtualized workloads. |
5959
| **AI and Accelerated Computing** | Support for NVIDIA GPUs, MIG scheduling, NVLink, Infiniband, Spectrum-X, and DPU offloading for accelerated networking, storage, and AI workloads. |
6060
| **Networking Models** | Comprehensive networking support, including software-defined networking (SDN), virtual, and physical appliances, including Linux Bridge, 802.1Q VLAN, VXLAN, Open vSwitch; SDN integration with BlueField DPUs and Spectrum-X fabrics. |

content/product/cluster_provisioning/cluster_operations/provider_operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ weight: "2"
1212

1313
<!--# Managing Providers -->
1414

15-
In OneForm, Providers are created using Provider drivers for on-premise hardware or 3rd-party cloud/bare-metal services such as AWS, Scaleway and Equinix. Use the `oneform` CLI tool to manage your cloud infrastructure instance and configuration.
15+
In OneForm, Providers are created using Provider drivers for on-premise hardware or 3rd-party cloud/bare-metal services such as AWS, Scaleway and i3Dnet. Use the `oneform` CLI tool to manage your cloud infrastructure instance and configuration.
1616

1717
With this guide, you will understand how the drivers and Providers and Provisions relate by:
1818

@@ -35,7 +35,7 @@ After running the command, you will see that all the driver templates are create
3535

3636
## Additional Drivers
3737

38-
Only the **onprem** driver is included by default in a fresh OpenNebula installation with OneForm. To install and enable other drivers, such as **aws**, **equinix** and **scaleway**, you need to clone the [OneForm Registry repository](https://github.com/OpenNebula/oneform-registry) onto the OpenNebula Front-end with the following commands as the `oneadmin` user:
38+
Only the **onprem** driver is included by default in a fresh OpenNebula installation with OneForm. To install and enable other drivers, such as **aws**, **i3dnet** and **scaleway**, you need to clone the [OneForm Registry repository](https://github.com/OpenNebula/oneform-registry) onto the OpenNebula Front-end with the following commands as the `oneadmin` user:
3939

4040
```bash
4141
git -C /var/lib/one/oneform/drivers clone https://github.com/OpenNebula/oneform-registry.git

content/product/cluster_provisioning/cluster_operations/provision_operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ In the Sunstone interface, go to **Infrastructure -> Clusters** and select the C
123123
{{% /tab %}}
124124

125125
{{% tab header="CLI"%}}
126-
For Provisions that support public networking like AWS and Equinix, dynamically manage Elastic IPs through the following commands:
126+
For Provisions that support public networking like AWS and i3Dnet, dynamically manage Elastic IPs through the following commands:
127127

128128
* Add Public IPs
129129

content/product/cluster_provisioning/cluster_providers/cloud_providers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ weight: "3"
1111

1212
<a id="cloud-providers"></a>
1313

14-
Cloud Providers define how OneForm interacts with 3rd-party IaaS cloud or bare-metal infrastructure providers such as AWS, Scaleway or Equinix. Providers for cloud-based service providers handle the credentials and API keys needed to connect with the service and automatically manage physical or virtual computing resources through OneForm. You only need to set up a Provider once for a cloud-based service, then it can be used repeatedly to provision Clusters without the need to recall credentials or configuration.
14+
Cloud Providers define how OneForm interacts with 3rd-party IaaS cloud or bare-metal infrastructure providers such as AWS, Scaleway or i3Dnet. Providers for cloud-based service providers handle the credentials and API keys needed to connect with the service and automatically manage physical or virtual computing resources through OneForm. You only need to set up a Provider once for a cloud-based service, then it can be used repeatedly to provision Clusters without the need to recall credentials or configuration.
1515

1616
## Creating Providers for 3rd-party Cloud or Bare-metal Services
1717

@@ -21,7 +21,7 @@ To create Providers for 3rd-party services, you need to install a Provider drive
2121

2222
* After installing the drivers follow the instructions for creating Providers for the following services:
2323
* [Amazon AWS Provider](https://github.com/OpenNebula/oneform-registry/wiki/Amazon-Web-Services-Provider)
24-
* [Equinix Provider](https://github.com/OpenNebula/oneform-registry/wiki/Equinix-Provider)
24+
* [i3Dnet Provider](https://github.com/OpenNebula/oneform-registry/wiki/i3Dnet-Provider)
2525
* [Scaleway Provider](https://github.com/OpenNebula/oneform-registry/wiki/Scaleway-Provider)
2626

2727
## Developing Provider Drivers
@@ -33,5 +33,5 @@ If a driver does not currently exist for your preferred cloud service, you can d
3333
Once you have created Providers for your preferred cloud or bare-metal service, you can provision Clusters using those services through OneForm. Please refer to the relevant Provisioning guide in the OneForm Registry Wiki for your preferred service provider:
3434

3535
* [AWS](https://github.com/OpenNebula/oneform-registry/wiki/Amazon-Web-Services-Cluster)
36-
* [Equinix](https://github.com/OpenNebula/oneform-registry/wiki/Equinix-Cluster)
36+
* [i3Dnet](https://github.com/OpenNebula/oneform-registry/wiki/i3Dnet-Cluster)
3737
* [Scaleway](https://github.com/OpenNebula/oneform-registry/wiki/Scaleway-Cluster)

content/product/cluster_provisioning/cluster_providers/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ weight: "1"
1010
---
1111

1212
<!--# Overview -->
13-
A **Provider** is an abstraction layer that defines the credentials, endpoints, and specific locations (such as a region or zone) within a target infrastructure. It acts as the "source of authority" that OneForm uses to authenticate and communicate with external resources — whether they are public cloud APIs (like AWS), bare-metal edge locations (like Equinix), or on-premises resources — to prepare the ground for a Cluster deployment.
13+
A **Provider** is an abstraction layer that defines the credentials, endpoints, and specific locations (such as a region or zone) within a target infrastructure. It acts as the "source of authority" that OneForm uses to authenticate and communicate with external resources — whether they are public cloud APIs (like AWS), bare-metal edge locations (like i3Dnet), or on-premises resources — to prepare the ground for a Cluster deployment.
1414

1515
## Basic Outline
1616

@@ -24,7 +24,7 @@ An on-premises Provider is installed by default with OpenNebula, refer to the [O
2424
Provider drivers for 3rd-party IaaS cloud providers can be installed in your OpenNebula deployment. The Provider drivers are available in the [OneForm Registry Repository](https://github.com/OpenNebula/oneform-registry) in the [OpenNebula GitHub Project](https://github.com/OpenNebula). Instructions for installing and synchronizing the 3rd-party Provider drivers can be found in the [OneForm Registry Wiki](https://github.com/OpenNebula/oneform-registry/wiki). After installing the drivers, you can find additional guides in the Wiki to create Providers for the following cloud/bare-metal services:
2525

2626
- [Amazon AWS Provider](https://github.com/OpenNebula/oneform-registry/wiki/Amazon-Web-Services-Provider)
27-
- [Equinix Provider](https://github.com/OpenNebula/oneform-registry/wiki/Equinix-Provider)
27+
- [i3Dnet Provider](https://github.com/OpenNebula/oneform-registry/wiki/i3Dnet-Provider)
2828
- [Scaleway Provider](https://github.com/OpenNebula/oneform-registry/wiki/Scaleway-Provider)
2929

3030
## Logical Model of a Provider
@@ -84,7 +84,7 @@ For more detailed information about Provider datamodels and configuration, refer
8484

8585
## Provider Drivers
8686

87-
Each Provider in OpenNebula is associated with a **Provider driver** that defines the underlying automation logic for infrastructure provisioning and configuration. A driver defines the logic for communicating with a specific cloud IaaS API or bare-metal hardware resource while the Provider defines the credentials, location and metadata. Therefore, a single driver is associated with a specific IaaS service (e.g. AWS, Equinix, Scaleway) while multiple Providers may use the same driver. For example, if you wish to use resources in multiple AWS regions, you must create a separate Provider for each AWS region, using the same AWS driver.
87+
Each Provider in OpenNebula is associated with a **Provider driver** that defines the underlying automation logic for infrastructure provisioning and configuration. A driver defines the logic for communicating with a specific cloud IaaS API or bare-metal hardware resource while the Provider defines the credentials, location and metadata. Therefore, a single driver is associated with a specific IaaS service (e.g. AWS, i3Dnet, Scaleway) while multiple Providers may use the same driver. For example, if you wish to use resources in multiple AWS regions, you must create a separate Provider for each AWS region, using the same AWS driver.
8888

8989
### Driver Structure
9090

content/product/cluster_provisioning/cluster_providers/scaleway_provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ curl -X POST "https://oneform.example.server/api/v1/providers" \
164164
-u "username:password" \
165165
-H "Content-Type: application/json" \
166166
-d '{
167-
"driver": "equinix",
167+
"driver": "scaleway",
168168
"connection_values": {
169169
"region": "fr-par",
170170
"zone": "fr-par-2",

content/product/cluster_provisioning/cluster_provisions/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Provisions"
33
date: "2025-02-17"
4-
description: "Automatically provision Edge Clusters on-premises or on AWS, Equinix and Scaleway."
4+
description: "Automatically provision Edge Clusters on-premises or on AWS, i3Dnet and Scaleway."
55
categories:
66
pageintoc: "209"
77
tags:

content/product/cluster_provisioning/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Each of the guides in this Cluster provisioning documentation demonstrates how t
3232

3333
## [Cluster Providers]({{% relref "product/cluster_provisioning/cluster_providers/" %}})
3434

35-
* **Definition**: Providers represent your credentials and endpoints for third-party cloud services (e.g., AWS, Equinix, Scaleway) or on-premises environments.
35+
* **Definition**: Providers represent your credentials and endpoints for third-party cloud services (e.g., AWS, i3Dnet, Scaleway) or on-premises environments.
3636

3737
* **Key Function**: Acts as an abstraction layer. Instead of managing complex API keys and connection strings every time you need a new Host, you define a Provider only once.
3838

content/product/virtual_machines_operation/virtual_machines/vm_templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ Also, there will be a tab called MYSQL with two groups, CONFIG and ADDITIONAL:
375375

376376
![sunstone_user_inputs_convention_mysql_1](/images/sunstone_user_inputs_convention_mysql_1.png)
377377

378-
To see the user inputs in the ADDITONAL group, the user must turn on the Define additional parameters user input:
378+
To set the user inputs in the ADDITIONAL group, activate the **Define additional parameters** option:
379379

380380
![sunstone_user_inputs_convention_mysql_2](/images/sunstone_user_inputs_convention_mysql_2.png)
381381

content/software/installation_process/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ weight: "3"
1111

1212
<a id="package-installation-references"></a>
1313

14-
This section contains details for deploying an OpenNebula-managed cloud. Installation starts with the deployment of an OpenNebula **Front-end**. Once the OpenNebula Front-end is deployed, **Clusters** can be installed manually or deployed automatically with OneForm to handle cloud workloads. OneDeploy can be used for advanced installation requirements.
14+
This section contains details for deploying an OpenNebula-managed cloud. Installation starts with the deployment of an OpenNebula **Front-end**. Once the OpenNebula Front-end is deployed, **Clusters** can be installed manually or deployed automatically with OneForm to handle cloud workloads. **OneDeploy** can be used for advanced, automated installation of both the Front-end and Clusters. Please read the [Installation Overview]({{% relref "software/installation_process/overview/" %}}) for details on each of the installation options prior to starting.

0 commit comments

Comments
 (0)