Add VMware clusters to operational’s environment

Fuel supports adding and removing nodes after deployment to extend existing and operational environment. However this functionality works only for compute nodes with KVM hypervisor.

Problem description

If a customer has already deployed environment with VMware vSphere as a hypervisor, there’s no ability to add several nodes through to it.

Theoretically we should be able to do this with the help of next four steps:

  1. Create a new cluster on vSphere and add ESXi nodes to it.
  2. Add a new compute-vmware node to the environment.
  3. Put data in the Nailgun: ‘datastore_regex’, ‘service_name’, ‘target_node’ and ‘vsphere_cluster’. Where ‘target_node’ is id of new node and ‘vsphere_cluster’ is the name of new vSphere cluster.
  4. Deploy the new node. It will be configured to serve the new cluster since we’ve assigned ‘vsphere_cluster’ to ‘target_node’.

The problem is that we can’t accomplish step 3 because Nailgun doesn’t provide any changes of VMware settings after deployment. Without information about the new cluster the compute-vmware node can’t be configured properly.

Proposed changes

Allow to change the list of vSphere’s clusters after deployment similar to the way it’s done for Ubuntu repositories. [1]

Web UI

There are Nova Compute Instance sections on VMware tab of the Fuel Web UI for setting vSphere cluster’s data. And there are buttons “+” and “-” which allow to add or remove these sections. Now these buttons are locked after deployment.

We want to unlock them when pending addition or deletion of the node with role compute-vmware in the environment.


There are changes from nailgun side:

  1. Add new ‘editable_for_deployed’ attribute to ‘metadata’ fields in vmware_attributes_metadata. This attribute will be used for UI to determinate which settings will be available for editing after cluster deployment. Difference with ‘always_editable’ that ‘editable_for_deployed’ allows to edit not always, only when compute-vmware nodes are added or removed. On backend side new settings will be applied only for attributes that have editable_for_deployed = true in vmware_attributes_metadata.
  2. Modification of PUT ‘/api/v1/clusters/<:id>/vmware_attributes’ handler to allow user modified cluster VMWare Atrributes for locked cluster if there are any ‘compute-vmware’ nodes pending for addition/deletion.
  3. Add validation of input vmware_attributes data.

Data model






RPC Protocol


Fuel Client




Fuel Library



User should add compute-vmware node as usual and has to set special data in to the postgres database directly.

Upgrade impact


Security impact


Notifications impact


End user impact


Performance impact


Deployment impact


Developer impact


Infrastructure impact


Documentation impact

This feature should be described in the documentation.



Primary assignee:
Igor Gajsin <>
Other contributors:
Nailgun part: Elena Kosareva <> UI part: Anton Zemlyanov <> QA section:Olesia Tsvigun <>
Mandatory design reviewer:
Aleksandr Kislitskii <>, Ivan Kliuk <>, Maciej Kwiek <>

Work Items

  • Do proof of concept. Add a cluster manually.
  • Allow update VMWareAttributes for deployed environment if has pending addition/deletion ‘compute-vmware’ nodes and add cluster via CLI Fuel client.
  • Add cluster using Fuel Web UI.



Testing, QA

New test should be written which covers this scenario:

  1. Create an environment with VMware vSphere as hypervisor with 1 cluster.
  2. Deploy this environment and make OSTF check.
  3. Add new compute-vmware node and assign it with new cluster on vSphere.
  4. Deploy changes and make OSTF check again.

Acceptance criteria

The test which described above should pass.


[1] Example for unlocked after deploy Fuel Web UI elements