BryanMLima commented on code in PR #9191:
URL: https://github.com/apache/cloudstack/pull/9191#discussion_r1637011378


##########
api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java:
##########
@@ -56,7 +56,7 @@ public class CreateServiceOfferingCmd extends BaseCmd {
     @Parameter(name = ApiConstants.CPU_NUMBER, type = CommandType.INTEGER, 
required = false, description = "the CPU number of the service offering")
     private Integer cpuNumber;
 
-    @Parameter(name = ApiConstants.CPU_SPEED, type = CommandType.INTEGER, 
required = false, description = "the CPU speed of the service offering in MHz.")
+    @Parameter(name = ApiConstants.CPU_SPEED, type = CommandType.INTEGER, 
required = false, description = "the CPU speed of the service offering in MHz. 
In the case cgroups are used on KVM, this is interpreted to calculate the 
number of shares. see also https://libvirt.org/formatdomain.html#cpu-tuning";)

Review Comment:
   @DaanHoogland, I think it would benefit the users if we can add more detail 
on this parameter description. Something like below, what do you think?
   ```suggestion
       @Parameter(name = ApiConstants.CPU_SPEED, type = CommandType.INTEGER, 
required = false, description = "the CPU speed of the service offering in MHz. 
For the KVM hypervisor," +
               " the values of the parameters cpuSpeed and cpuNumber will be 
used to calculate the `shares` value. This value is used by the KVM hypervisor 
to calculate how much time" +
               " the VM will have access to the host's CPU. The `shares` value 
does not have a unit, and its purpose is being a weight value for the host to 
compare between its guest" +
               " VMs. For more information, see 
https://libvirt.org/formatdomain.html#cpu-tuning.";)
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to