Fixes #25584 - Improve help for compute resources #427

ofedoren · 2019-07-16T15:00:12Z

The issue actually is about showing unclear errors, but since the error (e.g. mentioned in the issue) comes from the server, I'd say it is a server side issue.

What I'm proposing is to improve help section for CR in host creation help. Particularly to emphasize which attributes are required (e.g. path mentioned in the issue). Unfortunatelly I've got no environment (except libvirt and a dummy created from VMware) to test which attributes are really required. The chages are based on UI and CR models (basically on default_vm_attributes/new_vm/create_vm, etc)

Requires theforeman/hammer-cli#309 to be merged first. Also this PR is built above #424, since there are chages which will lead to merge conflicts.

shiramax

Thanks @ofedoren !
It looks like there's two commits here, one of them is "Host creation with multi SCSI controllers" that was already merged, could you remove it and rebase?

ofedoren · 2019-07-17T11:22:24Z

@shiramax, rebased.

shiramax · 2019-07-17T11:39:47Z

thanks @ofedoren
We will need to confirm that these are the right attributes for each compute resource
I will verify that for oVirt,
@kgaikwad - can you please confirm that for GCE and EC2?
@ares - can you please confirm that for OpenStack?
@ezr-ondrej - can you please confirm that for VMware?

shiramax · 2019-07-17T11:41:43Z

lib/hammer_cli_foreman/compute_resource/openstack.rb

@@ -6,7 +6,7 @@ def name
      end

      def compute_attributes
-        %w[flavor_ref image_ref tenant_id security_groups network]
+        %w[availability_zone boot_from_volume flavor_ref image_ref tenant_id scheduler_hint_filter security_groups network]


shiramax · 2019-07-17T11:42:05Z

lib/hammer_cli_foreman/compute_resource/gce.rb

@@ -6,7 +6,7 @@ def name
      end

      def compute_attributes
-        %w[machine_type image_id network external_ip]
+        %w[associate_external_ip image_id machine_type network user_data]


shiramax · 2019-07-17T11:42:19Z

lib/hammer_cli_foreman/compute_resource/ec2.rb

@@ -6,7 +6,7 @@ def name
      end

      def compute_attributes
-        %w[flavor_id image_id availability_zone security_group_ids managed_ip]
+        %w[availability_zone flavor_id groups image_id security_group_ids managed_ip]


can we find the description for each attribute?

shiramax · 2019-07-17T11:44:23Z

lib/hammer_cli_foreman/compute_resource/ovirt.rb

-          ['memory',   _('Amount of memory, integer value in bytes')]
+          ['sockets',  _('Integer value, number of sockets')],
+          ['memory',   _('Amount of memory, integer value in bytes')],
+          ['image_id'],


image_id is a general attribute, shouldn't be here.

shiramax · 2019-07-17T11:45:41Z

lib/hammer_cli_foreman/compute_resource/ovirt.rb

+          ['sockets',  _('Integer value, number of sockets')],
+          ['memory',   _('Amount of memory, integer value in bytes')],
+          ['image_id'],
+          ['user_data', _('Comment')]


I'm not sure that's spouse to be here... how did you find it?

ares · 2019-07-17T12:00:31Z

redirecting to @lzap - can you please confirm that for OpenStack? I guess it would need to be at https://github.com/fog/fog-openstack/blob/master/lib/fog/openstack/compute/models/server.rb but I don't see boot_from_volume and scheduler_hint_filter

but if @lzap has some openstack instnace, it's easier to test on existing vm

kgaikwad · 2019-07-17T12:29:33Z

lib/hammer_cli_foreman/compute_resource/gce.rb

@@ -6,7 +6,7 @@ def name
      end

      def compute_attributes
-        %w[machine_type image_id network external_ip]
+        %w[associate_external_ip image_id machine_type network user_data]


Thank you @ofedoren for updating attributes here.
Here, user_data attribute is not required as while creating an image, user can have this attribute.

ezr-ondrej · 2019-07-18T10:41:20Z

lib/hammer_cli_foreman/compute_resource/vmware.rb

-          ['memory_mb',            _('Integer number, amount of memory in MB')],
+          ['cpus',                 _('CPU count'), { bold: true }],
+          ['corespersocket',       _('Number of cores per socket (applicable to hardware versions < 10 only)'), { bold: true }],
+          ['memory_mb',            _('Integer number, amount of memory in MB'), { bold: true }],
          ['firmware',             'automatic/bios/efi'],


Could we put the firmware after the required attributes? Now it feels bit weird to be here.
Or sort it alphabeticaly, but now it feels bit messy ordered :)

ezr-ondrej · 2019-07-18T10:42:32Z

Could we somehow add a default values for the not required attributes, which have defaults? I do not insist doing it in this PR, though.

ofedoren · 2019-07-18T11:06:36Z

@shiramax, @kgaikwad, @ezr-ondrej, thanks! The required attributes are highlighted in bold in the help (the note at the beggining of the provider specific atrributes section tells it), the others are plain text.

But I agree that putting the required attributes at the top of the list is a good idea. :)

@ezr-ondrej, yes, I guess we can add a default values for the not required attributes, but I assume it is done on the server side by normalize... methods or default_attrs...

ezr-ondrej · 2019-07-18T12:04:00Z

@ezr-ondrej, yes, I guess we can add a default values for the not required attributes, but I assume it is done on the server side by normalize... methods or default_attrs...

Yeah it is, but there is no way for the hammer user to know what those values are going to be. That is my point, to add them in the help :) But I agree it would be better to get them somehow from the apipie, not to hardcode them.

shiramax

@ofedoren

Image_id is part of the host common attributes
user_data is configured as part as an image, so it shouldn't be here at all
please change the documentation as well in:
hammer-cli-foreman/doc/host_create.md

lzap · 2019-07-22T15:01:10Z

I am giving the credentials to the RHOS I test with, all employees can use it.

ofedoren · 2019-08-12T14:12:59Z

@shiramax, updated.

shiramax · 2019-08-14T14:25:35Z

lib/hammer_cli_foreman/compute_resource/libvirt.rb

        ]
      end

      def interface_attributes
        [
          ['type',   _('Possible values: %s') % 'bridge, network'],
          ['bridge', _('Name of interface according to type')],
-          ['model',  _('Possible values: %s') % 'virtio, rtl8139, ne2k_pci, pcnet, e1000']
+          ['model',  _('Possible values: %s') % 'virtio, rtl8139, ne2k_pci, pcnet, e1000'],


In libvirt we have these three options:

i'm not sure about the bridge, do you know why it's not in the UI is well?

@shiramax, it is, when you're creating a host via libvirt and go Interfaces -> New/Edit -> Select Type.

Also, see https://github.com/theforeman/foreman/blob/develop/app/models/compute_resources/foreman/model/libvirt.rb#L224-L228. I guess the API does support it.

ares · 2019-08-16T12:16:47Z

On August 14, 2019 16:26:58 Shira Maximov ***@***.***> wrote: shiramax requested changes on this pull request. > ] end def interface_attributes [ ['type', _('Possible values: %s') % 'bridge, network'], ['bridge', _('Name of interface according to type')], - ['model', _('Possible values: %s') % 'virtio, rtl8139, ne2k_pci, pcnet, e1000'] + ['model', _('Possible values: %s') % 'virtio, rtl8139, ne2k_pci, pcnet, e1000'], In libevirt we have these three options: ![image](https://user-images.githubusercontent.com/5609929/63028921-5290ec00-beb8-11e9-84ef-dea25cba35ae.png) i'm not sure about the bridge, do you know why it's not in the UI is well? -- You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub: #427 (review)

I suppose the bridge in UI only shows if you change network type. In API/hammer we can't hide fields that depends on other fields values.

…

-- Marek

shiramax · 2019-08-19T06:42:44Z

doc/host_create.md

 hardware_version      Hardware version ID from VMware
 add_cdrom             Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
 cpuHotAddEnabled      Must be a 1 or 0, lets you add memory resources while the machine is on
-memoryHotAddEnabled   Must be a 1 or 0, lets you add CPU resources while the machine is on
-start                 Must be a 1 or 0, whether to start the machine or not


why did you remove start from here? it should still be here in when creating a host.

shiramax · 2019-08-19T06:42:55Z

doc/host_create.md

@@ -195,26 +194,29 @@ Available keys for `--compute-attributes`:
 ```
 cpus          # number of CPUs
 memory        # string, amount of memory, value in bytes
-start         # Must be a 1 or 0, whether to start the machine or not


why did you remove start from here? it should still be here in when creating a host.

ofedoren · 2019-08-21T14:27:05Z

@shiramax, thanks! Updated.

Also, just reminding that theforeman/hammer-cli#309 is required to be merged first. Althought tests are passing, there can be a runtime error.

shiramax · 2019-08-27T13:35:46Z

@ofedoren can you please rebase?

ofedoren · 2019-08-27T13:52:51Z

@shiramax, rebased.

shiramax · 2019-08-27T14:08:00Z

doc/host_create.md

-compute_model                     # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]
+type              # one of [bridge, network]
+network / bridge  # name of interface according to type
+model             # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]


after the rebase, all the --interface attributes, it should stay with "compute_" prefix.

shiramax · 2019-08-27T14:08:07Z

doc/host_create.md

-compute_network      # select one of available networks for a cluster
+name         # eg. eth0
+network      # select one of available networks for a cluster
+interface    # interface type


after the rebase, all the --interface attributes, it should stay with "compute_" prefix.

ofedoren · 2019-08-27T14:50:22Z

@shiramax, updated. Thanks, I forgot to change those as well :(

kgaikwad · 2019-10-21T16:18:18Z

Apologize for late post.
In case of GCE/Ec2, user can configure image inside compute_attributes at compute_profile as well as host level. But removing image_id from compute_attributes in gce.rb broken the flow.

Am I missing anything here? Is there any foreman PR which handles this?

ofedoren · 2019-11-04T14:15:28Z

@kgaikwad, apologize for late reply.. Thanks for tracking that though :)

In hammer host create command I think we handle it though --image-id (see

hammer-cli-foreman/lib/hammer_cli_foreman/hosts/common_update_options.rb

Line 102 in 9c4a2c7

if options["option_image_id"]

).

But in hammer compute-profile values create/update command I don't see any mentions how to set an image...

@shiramax, @kgaikwad what do you think will be better resolution

Add --image-id option as we do have in hammer host create command or
Return image_id into compute_attributes help section?

kgaikwad · 2019-11-14T05:15:33Z

@ofedoren,

There was no separate option in the compute profile to set an image.
Previously it was done by using image_id value inside --compute-attributes option.
Example -
hammer compute-profile values update --compute-attributes "image_id=3780108136525169178,machine_type=f1-micro,associate_external_ip=true,network=default" --compute-profile-id 4 --compute-resource-id 6 --volume "size_gb=20"

And with removal of image_id from help section, it will be difficult for new user to know about how to set image_id for the compute_profile.

As --image-id option present in host commands and to maintain a consistency as well as to avoid confusion between host & compute_profile commands usage, it would be good to have similar option for compute_profile.

@shiramax, what do you think?

shiramax · 2019-11-14T08:27:10Z

@kgaikwad image should not be inside compute profile at all.
Compte profile should describe the hardware configuration of the host - for example : cores, sockets, memory, interfaces, and volumes.
the OS is not relevant for compute profile.
also, when you create a host from an image, you need to specify Architecture and Operating system , only then you will be able to choose an Image, Architecture and Operating system should not be inside compute profile.

kgaikwad · 2019-11-14T09:23:55Z

@shiramax,
As far as I know we have an option on web UI to set an image at compute profile level.
If user wants to set image at host level, he can by selecting OS and Architecture.

Could you please confirm if there is any recent change into compute profile form?

Edit - User sets OS & architecture at image creation level and compute profile form has only image field on UI.

kgaikwad · 2019-11-14T17:37:36Z

@shiramax,
Now, I got it. That's why may be if user don't select OS and architecture values first before selecting the compute profile, image field from OS tab on host form gets disabled. To enable that field user needs to deselect compute profile.

shiramax · 2019-11-17T07:53:28Z

@kgaikwad exactly,
AFIK images should not be inside the compute profile.

kgaikwad · 2019-11-19T03:30:07Z

@shiramax,

As mentioned web UI is inconsistent with what we are saying. My concerns are as follows:

On web UI compute profile page shows an image field for selection and on hammer side it is not showing in help and don't have any option to configure image value.
There is no place except the compute profile page to configure an image value for hosts. That means every time user needs to select an image value on Host form.

We will need to either consider redesigning those web UI pages or provide an option which will allow user to configure an image.

shiramax · 2019-11-19T08:09:17Z

@kgaikwad
Adding @ShimShtein and @apuntamb since we spoke about this issue last week. I agree that the current design is not ideal, and we should re-think about it. maybe you can open a topic in https://community.theforeman.org ?

theforeman-bot added Needs testing Not yet reviewed labels Jul 16, 2019

shiramax suggested changes Jul 17, 2019

View reviewed changes

theforeman-bot added Waiting on contributor and removed Not yet reviewed labels Jul 17, 2019

ofedoren force-pushed the bug-25584-path-comp-attr branch from feedd19 to a2f1665 Compare July 17, 2019 11:21

theforeman-bot added Needs re-review and removed Waiting on contributor labels Jul 17, 2019

shiramax suggested changes Jul 17, 2019

View reviewed changes

theforeman-bot added Waiting on contributor and removed Needs re-review labels Jul 17, 2019

shiramax suggested changes Jul 17, 2019

View reviewed changes

kgaikwad suggested changes Jul 17, 2019

View reviewed changes

ezr-ondrej reviewed Jul 18, 2019

View reviewed changes

shiramax suggested changes Jul 21, 2019

View reviewed changes

ofedoren force-pushed the bug-25584-path-comp-attr branch from a2f1665 to 7c0e153 Compare August 12, 2019 14:12

theforeman-bot added Needs re-review and removed Waiting on contributor labels Aug 12, 2019

ofedoren changed the title ~~Fixes #25584 - Improve help for compute resources~~ Fixes #25584, #27554 - Improve help for compute resources Aug 14, 2019

shiramax suggested changes Aug 14, 2019

View reviewed changes

theforeman-bot added Waiting on contributor and removed Needs re-review labels Aug 14, 2019

shiramax reviewed Aug 19, 2019

View reviewed changes

ofedoren force-pushed the bug-25584-path-comp-attr branch from 7c0e153 to ccd5eea Compare August 21, 2019 14:25

theforeman-bot added Needs re-review and removed Waiting on contributor labels Aug 21, 2019

ofedoren force-pushed the bug-25584-path-comp-attr branch from ccd5eea to aff7531 Compare August 22, 2019 12:13

ofedoren changed the title ~~Fixes #25584, #27554 - Improve help for compute resources~~ Fixes #25584 - Improve help for compute resources Aug 22, 2019

ofedoren force-pushed the bug-25584-path-comp-attr branch from aff7531 to 6426eeb Compare August 27, 2019 13:52

shiramax suggested changes Aug 27, 2019

View reviewed changes

theforeman-bot added Waiting on contributor and removed Needs re-review labels Aug 27, 2019

Fixes #25584 - Improve help for compute resources

0ad0bd1

ofedoren force-pushed the bug-25584-path-comp-attr branch from 6426eeb to 0ad0bd1 Compare August 27, 2019 14:49

theforeman-bot added Needs re-review and removed Waiting on contributor labels Aug 27, 2019

shiramax merged commit 2f3b422 into theforeman:master Aug 27, 2019

Fixes #25584 - Improve help for compute resources #427

Fixes #25584 - Improve help for compute resources #427

Conversation

ofedoren commented Jul 16, 2019

shiramax left a comment

Choose a reason for hiding this comment

ofedoren commented Jul 17, 2019

shiramax commented Jul 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ares commented Jul 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ezr-ondrej commented Jul 18, 2019

ofedoren commented Jul 18, 2019

ezr-ondrej commented Jul 18, 2019

shiramax left a comment

Choose a reason for hiding this comment

lzap commented Jul 22, 2019

ofedoren commented Aug 12, 2019

shiramax Aug 14, 2019 • edited Loading

Choose a reason for hiding this comment

ofedoren Aug 14, 2019 • edited Loading

Choose a reason for hiding this comment

ares commented Aug 16, 2019 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ofedoren commented Aug 21, 2019

shiramax commented Aug 27, 2019

ofedoren commented Aug 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ofedoren commented Aug 27, 2019

kgaikwad commented Oct 21, 2019 • edited Loading

ofedoren commented Nov 4, 2019

kgaikwad commented Nov 14, 2019

shiramax commented Nov 14, 2019

kgaikwad commented Nov 14, 2019 • edited Loading

kgaikwad commented Nov 14, 2019

shiramax commented Nov 17, 2019 • edited Loading

kgaikwad commented Nov 19, 2019

shiramax commented Nov 19, 2019

shiramax Aug 14, 2019 •

edited

Loading

ofedoren Aug 14, 2019 •

edited

Loading

kgaikwad commented Oct 21, 2019 •

edited

Loading

kgaikwad commented Nov 14, 2019 •

edited

Loading

shiramax commented Nov 17, 2019 •

edited

Loading