Oracle Cloud Infrastructure (OCI) is Oracle's cloud offering providing servers, storage, network, applications and services through a global network of Oracle managed data centers to run cloud native and enterprise company’s IT workloads. OCI provides real-time elasticity for enterprise applications by combining Oracle's autonomous services, integrated security, and serverless compute.
This cloud bursting driver helps the user combine local resources of their private cloud with resources from OCI. It allows deploying Virtual Machines seamlessly on OCI.
To contribute bug patches or new features, you can use the github Pull Request model. It is assumed that code and documentation are contributed under the Apache License 2.0.
- This addon is compatible with OpenNebula versions 5.12.
- Cloud Bursting to Oracle Cloud Infrastructure
- Ruby SDK for OCI
- Nokogiri
- An Oracle Cloud Infrastructure account. (Start with a Free Trial / Always Free Oracle Cloud account. Click here for details.
- An OCI user in a group with a policy that grants the desired permissions.
- A keypair used for signing API requests, with the public key uploaded to OCI.
Note: The user whose credentials are being used, needs to have the required permissions to create the specified instance shape in the specified compartment in the specified region. The instance shape must be available and must have availability, as per quota policies and tenancy limits.
To install this add-on, please follow the following steps:
-
Clone this repository and run install.sh:
sudo ./install.sh -u oneadmin -g oneadmin
-
Add the following section to the file '/etc/one/oned.conf'
#OCI VM_MAD = [ name = "oci", executable = "one_vmm_sh", arguments = "-t 15 -r 0 oci", type = "xml" ] -
Add the following section to the file '/etc/one/monitord.conf'
#OCI IM_MAD = [ name = "oci", executable = "one_im_sh", arguments = "-c -t 1 -r 0 oci" ]
The OCI driver uses two configuration files:
- /etc/one/oci_driver.conf: Configures access to OCI.
- /etc/one/oci_driver.default: Default values for templates deployed in OCI.
The file oci_driver.conf has the following 3 sections:
-
Host - In this section you can list the hosts that you wish to use. There is no limit on the number of hosts you can list. Each host is defined by the following details:
- Tenancy OCID
- User OCID
- User Fingerprint
- Path to PEM key file
- Region - The OCI region in which the instance will be created. The region will be one of those mentioned in the regions section below.
- Capacity - The capacity section is used by OpenNebula to calculate the host capacity. Every instance mentioned in the instance_types section (more on that below) needs to have an entry such as this: Shape: Count.
In this case, Opennebula will compute the host capacity by multiplying the number of cpus used by the shape with the given count and then taking a sum over all the shapes. Opennebula will do the same thing for memory.
The thing to note is that the count given for each shape doesn't limit you to that many instances of the shape. You could create more instances of that shape using the driver, as long as the used capacity does not exceed the total capacity, as calculated above.
A host entry would look similar to the following
<host_name>: :tenancy: <tenancy_ocid> :user: <user_ocid> :fingerprint: <user_fingerprint> :key_file: <path_to_.pem_file> :region: ashburn :capacity: VM.Standard.E3.Flex: 1 BM.Standard2.52: 0 BM.Standard.E3.128: 0 BM.DenseIO2.52: 0 BM.GPU3.8: 0 BM.GPU4.8: 0 BM.HPC2.36: 0 VM.Standard2.1: 1 VM.Standard2.2: 1 VM.Standard2.4: 1 VM.Standard2.8: 0 VM.Standard2.16: 0 VM.Standard2.24: 0 VM.Standard.E2.1.Micro: 0 VM.DenseIO2.8: 0 VM.DenseIO2.16: 0 VM.DenseIO2.24: 0 VM.GPU3.1: 0 VM.GPU3.2: 0 VM.GPU3.4: 0 -
Regions - A dictionary of regions currently available on OCI. This section lets you use a short name of the region rather than the full name understood by OCI. In the future, if a new region becomes available, you will have to create a new entry in the file in order to use the region. Please note that your OCI tenancy needs to be subscribed to a region to use it. Simply mentioning the region in the file does not subscribe your tenancy to it.
-
Instance_types - A dictionary of Instance Types or shapes that you want to use on OCI. Each instance has the associated cpu count and memory size in GB. Unless a shape is listed here, you will not be able to spin it up in OCI using the driver. Therefore, in the future, if a new shape becomes available, you will be responsible for creating an entry for it in this section. Same goes for removing entries of retiring shapes and updating the cpu or memory of a shape, if Oracle changes the associated value.
Note: Please do not modify the regions section and instance_types section, unless you are sure of the impact of your changes.
The driver defaults need to have certain values:
- HOST - The name of the host to be used for the virtual machine. This host must be defined in the configuration file.
- AVAILABILITY_DOMAIN - The availability domain in the host's region to be used for the instance. This has to be mentioned even for regions with 1 availability domain. For example: <tenancy_identifier>:US-ASHBURN-AD-1, if the host's region is ashburn. The tenancy identifier is a 4 character identifier that is specific to a tenancy. It can be found in the tenancy on the compute instance creation page. For more on availability domains, including a list of them, please visit this page.
- COMPARTMENT_ID - The OCID of the compartment where the virtual machine will be created.
- SHAPE - The default shape to be used for the virtual machine.
- SUBNET_ID - The OCID of the sub-network to be used for the virtual machine.
- SSH_KEY - The public ssh-key to be used to log into the system.
- IMAGE_ID - The OCID of the operating system image to be used for the system. The image can be a custom image. Image IDs of some of the popular platform images can be found here.
- ASSIGN_PUBLIC_IP (Optional) - true is the default value, but you could set it to false.
- DISPLAY_NAME (Optional) - The display name of the instance in the OCI console.
- FAULT_DOMAIN (Optional) - Fault domain within the specified availability domain that should be used to host the virtual machine. Each availability domain contains three fault domains. For example: FAULT-DOMAIN-3.
Note: OpenNebula needs to be restarted, once the configuration file is updated.
onehost create <host_name> --im oci --vm oci
In order to deploy an instance in OCI through OpenNebula you must include an PUBLIC_CLOUD section in the virtual machine template.
A sample template is given below:
PUBLIC_CLOUD=[
AVAILABILITY_DOMAIN = "<unique_identifier>:US-ASHBURN-AD-1",
COMPARTMENT_ID = "<compartment_ocid>",
DISPLAY_NAME = "Sample Instance 1",
HOST = "<host_name>",
IMAGE_ID = "<image_ocid>",
SHAPE = "VM.Standard2.1",
SSH_KEY = "<public_ssh_key>",
SUBNET_ID = "<subnet_ocid>",
TYPE = "oci"
]
#Add this if you want to use only OCI
#SCHED_REQUIREMENTS = 'HYPERVISOR = "oci"'
A powerful use of cloud bursting in OpenNebula is the ability to use hybrid templates, defining a VM if OpenNebula decides to launch it locally, and also defining it if it is going to be outsourced to OCI. The idea behind this is to reference the same kind of VM even if it is incarnated by different images (the local image and the OCI image).
An example of a hybrid template:
## Local Template section
NAME=<Example_Name>
CPU=1
MEMORY=256
DISK=[IMAGE="nginx-golden"]
NIC=[NETWORK="public"]
PUBLIC_CLOUD=[
AVAILABILITY_DOMAIN = "<unique_identifier>:US-ASHBURN-AD-1",
COMPARTMENT_ID = "<compartment_ocid>",
DISPLAY_NAME = "Sample Instance 1",
HOST = "<host_name>",
IMAGE_ID = "<image_ocid>",
SHAPE = "VM.Standard2.1",
SSH_KEY = "<public_ssh_key>",
SUBNET_ID = "<subnet_ocid>",
TYPE = "oci"
]
OpenNebula will use the first portion (from NAME to NIC) in the above template when the VM is scheduled to a local virtualization node, and the PUBLIC_CLOUD section of TYPE="oci" when the VM is scheduled to an OCI node (i.e. when the VM is going to be launched in OCI).
Since OCI Hosts are treated by the scheduler like any other host, VMs will be automatically deployed in them. But you probably want to lower their priority and start using them only when the local infrastructure is full.
The OCI drivers return a probe with the value PRIORITY = -1. This can be used by the scheduler, configuring the 'fixed' policy in sched.conf:
DEFAULT_SCHED = [
policy = 4
]
The local hosts will have a priority of 0 by default, but you could set any value manually with the onehost update or onecluster update commands.
There are two other parameters that you may want to adjust in sched.conf:
- MAX_DISPATCH - Maximum number of Virtual Machines actually dispatched to a host in each scheduling action
- MAX_HOST - Maximum number of Virtual Machines dispatched to a given host in each scheduling action In a scheduling cycle, when MAX_HOST VMs have been deployed to a host, the host is discarded for the following pending VMs.
For example, having this configuration:
MAX_HOST = 1
MAX_DISPATCH = 30
2 Hosts: 1 in the local infrastructure, and 1 using the OCI drivers
2 pending VMs
The first VM will be deployed in the local host. The second VM will have also sort the local host with higher priority, but because 1 VM was already deployed, the second VM will be launched in OCI.
A quick way to ensure that your local infrastructure will always be used before the OCI hosts is to set MAX_DISPATCH to the number of local hosts.
The OCI drivers report the host attribute PUBLIC_CLOUD = YES. Knowing this, you can use that attribute in your VM requirements.
To force a VM deployment in a local host, use:
SCHED_REQUIREMENTS = "!(PUBLIC_CLOUD = YES)"
To force a VM deployment in an OCI host, use:
SCHED_REQUIREMENTS = "PUBLIC_CLOUD = YES"
You should take into account the following technical considerations when using Oracle Cloud Infrastructure with OpenNebula:
- There is no direct access to the hypervisor, so it cannot be monitored. (We don't know where the VM is running on OCI).
- The usual OpenNebula functionality for snapshotting, hot-plugging, or migration is not available with Oracle Cloud Infrastructure.
- The latest list of shapes that can be spun up in OCI can be found here.
Apache License, Version 2.0