Add Custom hypervisor minimal changes - #7692

Description

Design document: https://cwiki.apache.org/confluence/display/CLOUDSTACK/%5BDRAFT%5D+Minimal+changes+to+allow+new+dynamic+hypervisor+type%3A+Custom+Hypervisor

This PR introduces the minimal changes to add a new hypervisor type (internally named Custom in the codebase, and configurable display name), allowing to write an external hypervisor plugin as a Custom Hypervisor to CloudStack

The custom hypervisor name is set by the setting: 'hypervisor.custom.display.name'. The new hypervisor type does not affect the behaviour of any CloudStack operation, it simply introduces a new hypervisor type into the system.

CloudStack does not have any means to dynamically add new hypervisor types. The hypervisor types are internally preset by an enum defined within the CloudStack codebase and unless a new version supports a new hypervisor it is not possible to add a host of a hypervisor that is not in part of the enum. It is possible to implement minimal changes in CloudStack to support a new hypervisor plugin that may be developed privately

This PR is an initial work on allowing new dynamic hypervisor types (adds a new element to the HypervisorType enum, but allows variable display name for the hypervisor)

Proposed Future work:

Replace the HypervisorType from a fixed enum to an extensible registry mechanism, registered from the hypervisor plugin

Feature Specifications

• The new hypervisor type is internally named 'Custom' to the CloudStack services (management server and agent services, database records).
• A new global setting ‘hypervisor.custom.display.name’ allows administrators to set the display name of the hypervisor type. The display name will be shown in the CloudStack UI and API.
  • In case the ‘hypervisor.list’ setting contains the display name of the new hypervisor type, the setting value is automatically updated after the ‘hypervisor.custom.display.name’ setting is updated.
• The new Custom hypervisor type supports:
  • Direct downloads (the ability to download templates into primary storage from the hypervisor hosts without using secondary storage)
  • Local storage (use hypervisor hosts local storage as primary storage)
  • Template format: RAW format (the templates to be registered on the new hypervisor type must be in RAW format)
• The UI is also extended to display the new hypervisor type and the supported features listed above.
• The above are the minimal changes for CloudStack to support the new hypervisor type, which can be tested by integrating the plugin codebase with this feature.

Use cases

This PR allows the cloud administrators to test custom hypervisor plugins implementations in CloudStack and easily integrate it into CloudStack as a new hypervisor type ("Custom"), reducing the implementation to only the hypervisor supported specific storage/networking and the hypervisor resource to communicate with the management server.

• CloudStack admin should be able to create a zone for the new custom hypervisor and add clusters, hosts into the zone with normal operations
• CloudStack users should be able to execute normal VMs/volumes/network/storage operations on VMs/volumes running on the custom hypervisor hosts

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)
• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Enhancement (improves an existing feature and functionality)
• Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

• Major
• Minor

Bug Severity

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

Having set 'hypervisor.custom.display.name' = 'MyCustomHW', added an extra zone with the hypervisor type 'MyCustomHW' and added one host:

• Listing hosts, one per zone. The hypervisor type is set as the display name of the custom hypervisor

• Listing hosts in database. The hypervisor type is set as Custom, despite the display name which is variable

mysql> select name, hypervisor_type from host where status = 'Up' and type = 'Routing' and removed is null;
+------------------------------------------+-----------------+
| name                                     | hypervisor_type |
+------------------------------------------+-----------------+
| ref-trl-4901-k-Mr8-nicolas-vazquez-kvm2  | KVM             |
| ref-trl-4901-k-Mr8-nicolas-vazquez-test1 | Custom          |
+------------------------------------------+-----------------+
2 rows in set (0.00 sec)

How Has This Been Tested?