Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specification for host list view #77

Merged
merged 1 commit into from
Apr 28, 2017

Conversation

gnehapk
Copy link
Member

@gnehapk gnehapk commented Dec 15, 2016


The details shown for each host in UI is -

* fqdn
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only fqdn in list view?
In the spec, you need to talk about all attributes specified in UX designs and also the current gaps(in terms of API support) to achieve them


== Use Cases

Users can see the list of host present in Tendrl. They can also filter and sort the list.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the filtering and sorting options avaiulable


=== Impacted Modules:

==== Tendrl API impact:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add the specifics here, the list of APIs required and req/resp details

==== Tendrl API impact:


==== Notifications/Monitoring impact:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How the live status updates are handled, say host status change or utlization changes?
How the asynchronous notifications from backend are handled updated on the list view?


== Dependencies:

https://github.com/Tendrl/tendrl_frontend/issues/65
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any other dependencies? APIs? Montoring/eventing? Capture those as github issues and link it here

* Role
* Alerts

API supports present now is for -
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

grammar


== Use Cases

Users can see the list of host present in Tendrl. They can also
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%s/host/hosts/g

* Create a view for listing host details.
* For showing used storage, cpu utilisation and memory used, use donut and trending chart component.
* This view will use generate-list component for listing host. The list data will be passed to this component from the controller.
* Implement filer and sorting functionality.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%s/filer/filtering/g

* For showing used storage, cpu utilisation and memory used, use donut and trending chart component.
* This view will use generate-list component for listing host. The list data will be passed to this component from the controller.
* Implement filer and sorting functionality.
* Filter parameter(name/cluster/role/status) should be sent to API to fetch the filtered list of host.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%s/list of host/list of hosts/g

* This view will use generate-list component for listing host. The list data will be passed to this component from the controller.
* Implement filer and sorting functionality.
* Filter parameter(name/cluster/role/status) should be sent to API to fetch the filtered list of host.
* Sorting parameter(name and asc/desc) should be sent to API to fetch sorted list of host.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%s/host/hosts/g


=== Alternatives

Host list can have its own html template instead of using generate-list component. But the code will be redundant as the same functionality and layout is going to be used in all list views.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do we achieve clickability of certain column items say hosts and pools under cluster lists should link to hosts and pool lists respectively. Is this flexibility achievable using this mechanism?

@gnehapk gnehapk force-pushed the host-list-specification branch 2 times, most recently from a14dcc6 to 534e712 Compare December 17, 2016 07:39
Required Input from Anup -

* To add the response format for the API call
* To add the polling API call and its response format
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anivargi Please provide the necessary inputs here.


==== Notifications/Monitoring impact:

Required Input from Anmol: To add the response format for monitoring data
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anmolbabu Please provide the necessary input here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gnehapk The details that need to go here are captured as part of #81 please reference this from here.

@gnehapk
Copy link
Member Author

gnehapk commented Dec 19, 2016

Adding @cloudbehl

@gnehapk gnehapk force-pushed the host-list-specification branch 2 times, most recently from ef98f2d to 6dc1762 Compare December 20, 2016 09:42
* Status
* IP Address
* Storage Usage
* Utilisation

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Utilization of what - CPU utilization?

* Host Name
* IP Address
* Storage Usage
* Utilisation

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same as in previous comment, what utilization is meant here. Probably CPU but it's not clear.

@gnehapk
Copy link
Member Author

gnehapk commented Dec 20, 2016

@cloudbehl @anivargi I have updated the PR. Please review it.

@kamleshverma1
Copy link
Contributor

kamleshverma1 commented Dec 21, 2016

@anivargi For the host list view, below are the data that is not present in the json response of host-list -

  1. Host IP
  2. Role

Host-list - UX design - https://redhat.invisionapp.com/share/BR8JDCGSQ#/screens/212034116

@kamleshverma1
Copy link
Contributor

kamleshverma1 commented Dec 21, 2016

@anivargi @gnehapk @brainfunked
Ideally 'key' of Object should be some "static name" in order to access the value of it . it should not be dynamic (in this case - node_id) as such in response format -

Example:
{

"nodes":[
    {
        "3038c577-b233-4513-926d-a8a1ac63b0a3":  {

               "fqdn":"dhcp43-189.lab.eng.blr.redhat.com",
               "machine_id":"a2e4163a1a8e4b28afb1a17e6a1d9962",
               "node_id":"3038c577-b233-4513-926d-a8a1ac63b0a3"

        },
        "stats":{}
    }
]

}

Here , i am fine with "stats" key which is static name. and also we can access the value of it using dot operator . but for "3038c577-b233-4513-926d-a8a1ac63b0a3" , it can have any node-id which is dynamic (we don't know what it can have because it is not static name). and accessing this value in UI will be tricky and difficult . Can we have some static name instead of dynamic id?

@brainfunked
Copy link
Contributor

@kamleshverma1 I can't think of a specific scenario where that's a problem. It is understood that the keys insides nodes always refer to a host id. Do you have an example where this is a problem?

@shtripat
Copy link
Member

shtripat commented Dec 22, 2016

I feel @kamleshverma1 wants the details as below (even I feel it should be like that) -

{
  'nodes': [
    {
      'node_id': "3038c577-b233-4513-926d-a8a1ac63b0a3",
      "fqdn":"dhcp43-189.lab.eng.blr.redhat.com",
      "machine_id":"a2e4163a1a8e4b28afb1a17e6a1d9962",
      "stats": {}
    },
    .............
  ]
}


The details shown for each host in UI is -

* Host Name
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the Host Name means just host name (the first part without the domain) or FQDN? Especially in the case of FQDN, it might be quite long and it might break the rest of the layout.

* CPU Utilisation
* Memory Usage
* Cluster Name
* Role
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible, that node will have more than one role and do we count with this situation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants