OpenNebula 6.8 Documentation

OpenNebula is an open source cloud management platform that combines virtualization and container technologies with multi-tenancy, automatic provision and elasticity to offer on-demand applications and services on enterprise, hybrid and edge environments.

Guide	Description
Overview	Learn about the OpenNebula model, popular use cases and how to design a cloud
Quick Start	Build an OpenNebula test installation with local and remote resources
Management and Operations	How to operate and manage your cloud, including deployment of remote clusters
Front-end Installation	How to install and configure the main OpenNebula services
Open Cluster Deployment	How to install and set up customized clusters based on open source components
Automatic Cluster Deployment	How to automaticaly deploy clusters on-premises and on-cloud
VMware Cluster Deployment	How to install and set up customized clusters based on VMware
Integration and Development	APIs and drivers to integrate OpenNebula with applications and platforms
Release Notes	New features, improvements and fixes, and the upgrade process in each version

• Overview
  • OpenNebula Concepts
  • Cloud Architecture and Design
  • Solutions and Best Practices
• Quick Start
  • Deployment Basics
  • Operation Basics
  • Usage Basics
• Management and Operations
  • Host and Clusters
  • Storage
  • Virtual Networks
  • Virtual Machines
  • Virtual Machine Backups
  • End-User Web Interfaces
  • Multi-VM Service
  • Users and Groups
  • Capacity Planning
  • Monitoring and Alerting (EE)
  • References
• Installation and Configuration
  • Front-end Installation
  • Large-scale Deployment
  • High Availability
  • Data Center Federation
  • OpenNebula Services
  • Authentication Configuration
  • Configuration Management (EE)
  • WHMCS Install and Usage (EE)
• Marketplaces and Appliances
  • Public Marketplaces
  • Private Marketplaces
  • Appliances
• Open Cluster Deployment
  • KVM Node Deployment
  • LXC Node Deployment
  • Firecracker Node Deployment
  • Open Cloud Storage Setup
  • Open Cloud Networking Setup
• Automatic Cluster Deployment
  • Edge and Cloud Providers
  • Edge Cluster Provisions
  • HCI Cluster Provisions
  • Operations
  • References
• VMware Cluster Deployment
  • VMware Cluster Deployment
  • VMware Storage Setup
  • VMware Networking Setup
• Integration and Development
  • System Interfaces
  • Automation Tools Integration
  • Infrastructure Drivers Development
  • Edge Provider Driver Development
  • References
• Release Notes
  • Release Notes
  • Release Notes Community
  • Release Notes Enterprise
  • Upgrades

 Overview

OpenNebula Concepts

• OpenNebula Overview
• Key Features

Cloud Architecture and Design

• Cloud Architecture Design
• Edge Cloud Reference Architecture
• Open Cloud Reference Architecture
• VMware Reference Architecture

Solutions and Best Practices

• Mastering Application Containers
• Cloud Access Model and Roles
• Knowledge Base
• Use Cases

 Quick Start

Deployment Basics

• Overview
• Try OpenNebula Front-end on AWS
• Try OpenNebula Front-end on VMware
• Try OpenNebula Hosted Front-end

Operation Basics

• Overview
• Provisioning an Edge Cluster
• Operating an Edge Cluster

Usage Basics

• Overview
• Running Virtual Machines
• Running Kubernetes Clusters

 Management and Operations

Host and Clusters

• Overview
• Hosts
• Clusters
• Virtual Topology and CPU Pinning

Storage

• Overview
• Datastores
• Images

Virtual Networks

• Overview
• Virtual Networks
• Virtual Network Templates
• Security Groups
• Self Provision
• Virtual Routers
• NSX Networks

Virtual Machines

• Overview
• Virtual Machine Templates
• Virtual Machine Instances
• Using Container Images
• vCenter Virtual Machines

Virtual Machine Backups

• Overview
• Backup Datastore: Restic (EE)
• Backup Datastore: Rsync
• VM Backup Operations
• Backup Jobs

End-User Web Interfaces

• Overview
• Self-service Cloud View
• Group Admin View
• Sunstone Labels
• FireEdge Sunstone

Multi-VM Service

• Overview
• OneFlow Services Management
• OneFlow Services Auto-scaling
• OneGate Usage

Users and Groups

• Overview
• Users
• Groups
• VDCs
• Sunstone Views
• Permissions and ACLs
• Accounting
• Showback

Capacity Planning

• Overview
• Host Overcommitment
• Scheduling Policies
• Usage Quotas
• Virtual Machine Affinity
• External Schedulers

Monitoring and Alerting (EE)

• Overview
• Installation and Configuration
• Grafana Visualization
• Alert Manager
• Exporter Metrics

References

• Virtual Machine Template
• Image Template
• Virtual Network Template
• Command Line Interface
• Guest OS Installation
• Contextualization (Open Source Cloud)
• Contextualization (VMware vCenter)

 Installation and Configuration

Front-end Installation

• Overview
• Database Setup
• OpenNebula Repositories
• Single Front-end Installation

Large-scale Deployment

• Overview
• Scalability Testing and Tuning
• Sunstone for Large Deployments
• Advanced SSH Usage

High Availability

• Overview
• Front-end HA
• Virtual Machines HA

Data Center Federation

• Overview
• Federation Configuration
• Federation Usage

OpenNebula Services

• Overview
• OpenNebula Configuration
• Scheduler Configuration
• Monitoring Configuration
• Sunstone Configuration
• FireEdge Configuration
• OneFlow Configuration
• OneGate Configuration
• Database Maintenance
• Troubleshooting
• Replace failing frontend
• Support Utilities (EE)

Authentication Configuration

• Overview
• SSH Authentication
• X.509 Authentication
• LDAP Authentication
• Sunstone Authentication
• FireEdge Authentication

Configuration Management (EE)

• Overview
• Basic Usage
• Diff Formats
• Troubleshooting
• Appendix - List of Configurations

WHMCS Install and Usage (EE)

• Overview
• WHMCS Install/Config
• WHMCS Admin Usage
• WHMCS User Guide

 Marketplaces and Appliances

Public Marketplaces

• Overview
• OpenNebula Systems Marketplace
• Dockerhub Marketplace
• Linux Containers and Turnkey Linux Marketplaces

Private Marketplaces

• Overview
• HTTP Marketplace
• S3 Marketplace
• Docker Registry Marketplace

Appliances

• Overview
• Managing Marketplace Appliances
• OneKE Service (K8s)
• WordPress
• VNF and Virtual Router

 Open Cluster Deployment

KVM Node Deployment

• Overview
• KVM Node Installation
• KVM Driver
• PCI Passthrough
• NVIDIA vGPU

LXC Node Deployment

• Overview
• LXC Node Installation
• LXC Driver
• LXD To LXC Migration

Firecracker Node Deployment

• Overview
• Firecracker Node Installation
• Firecracker Driver

Open Cloud Storage Setup

• Overview
• NFS/NAS Datastore
• Local Storage Datastore
• OneStor Datastore
• Ceph Datastore
• SAN Datastore
• Raw Device Mapping Datastore
• iSCSI - Libvirt Datastore
• Kernels and Files Datastore

Open Cloud Networking Setup

• Overview
• Node Setup
• Bridged Networking
• 802.1Q VLAN Networks
• VXLAN Networks
• Open vSwitch Networks

 Automatic Cluster Deployment

Edge and Cloud Providers

• Overview
• AWS Provider
• Equinix Provider
• On-Premise Provider

Edge Cluster Provisions

• Overview
• AWS Edge Cluster
• Equinix Edge Cluster
• On-Premise Edge Cluster

HCI Cluster Provisions

• Overview
• AWS HCI Cluster
• On-Premise HCI Cluster

Operations

• Overview
• Managing Providers
• Provision Cluster Operations

References

• Ansible Playbooks
• Ansible Roles
• Virtual Objects Provisioning
• Provision Template Reference

 VMware Cluster Deployment

VMware Cluster Deployment

• Overview
• vCenter Node Installation
• vCenter Driver

VMware Storage Setup

• Overview
• vCenter Datastores
• Migrate Images between KVM / vCenter

VMware Networking Setup

• Overview
• vCenter Networking
• NSX Setup

 Integration and Development

System Interfaces

• Overview
• XML-RPC API
• Ruby OpenNebula Cloud API
• Python OpenNebula Cloud API
• Java OpenNebula Cloud API
• Go OpenNebula Cloud API
• OneFlow Server API
• OneGate API
• Using Hooks

Automation Tools Integration

• Overview
• Terraform
• Ansible
• Docker Machine
• Rancher

Infrastructure Drivers Development

• Overview
• Virtualization Driver
• Storage Driver
• Monitoring Driver
• Networking Driver
• Authentication Driver
• Market Driver
• IPAM Driver
• vCenter Driver
• NSX Driver

Edge Provider Driver Development

• Overview
• Provision Driver

References

• Overview
• Building from Source Code
• Build Dependencies
• Sunstone Development
• FireEdge Sunstone Development
• Cloud Servers Authentication
• Virtual Machine States Reference
• Image States Reference
• Host States Reference

 Release Notes

Release Notes

• What's New
• Platform Notes
• Secondary Platforms
• Compatibility Guide
• Known Issues
• Acknowledgements

Release Notes Community

• What is OpenNebula CE

Release Notes Enterprise

• What is OpenNebula EE
• Resolved Issues 6.8.1
• Resolved Issues 6.8.2
• Resolved Issues 6.8.3

Upgrades

• Overview
• Start Here
• Upgrading Single Front-End
• Upgrading High Availability Clusters
• Upgrading Federated Instances
• Restoring Previous Version
• Upgrading from Previous Versions

Note

• EE: Component only available in the Enterprise Edition

• TP: Component distributed as Technology Preview and not recommended for production environments