InventoryCollection definition #316
Conversation
providers/dev-guide.md
Outdated
| @@ -264,6 +264,15 @@ The logic in this class has | |||
| quite strong assumptions on the data being stored. It assumes that it has the tree structure and each entity contains its kids as a nested hash. | |||
| If you are able to achieve that structure in the `refresh_parser.rb`, you are halfway done. Otherwise, good luck :] | |||
|
|
|||
| ### Defining Inventory | |||
|
|
|||
| Basically, refresh process consists of Collector, Persister and Parser classes (in most providers). | |||
There was a problem hiding this comment.
Don't need Basically, and I would suggest instead of (in most providers) how about Providers which use graph refresh consist of Collector ...
providers/dev-guide.md
Outdated
| ### Defining Inventory | ||
|
|
||
| Basically, refresh process consists of Collector, Persister and Parser classes (in most providers). | ||
| When Collector loads data from external provider (like AWS), Persister defines structure of Inventory by InventoryCollection objects. |
There was a problem hiding this comment.
Should be When the Collector, not sure (like AWS) adds anything I think any developer reading this knows what a provider is, how about the Persister defines the inventory structure based on InventoryCollection objects
There was a problem hiding this comment.
ok, I wrote like AWS because it seems there is unclear terminology, what provider is.
One time provider is EMS in our database, another time AWS/Azure/etc. is meant.
providers/dev-guide.md
Outdated
|
|
||
| Basically, refresh process consists of Collector, Persister and Parser classes (in most providers). | ||
| When Collector loads data from external provider (like AWS), Persister defines structure of Inventory by InventoryCollection objects. | ||
| Inventory is then saved to VMDB (ManageIQ (also CFME) app database). Each inventory belons to certain ActiveRecord model. |
There was a problem hiding this comment.
Maybe just Inventory is then saved to the database?
There was a problem hiding this comment.
Each inventory belons
typo should be belongs
There was a problem hiding this comment.
How about Every inventory collection is mapped to an ActiveRecord model?
There was a problem hiding this comment.
I wrote VMDB intentionally because all documentations uses VMDB when talking about our database.
So I rather write both / VMDB and app database) because at the beginning I was confused what vmdb is.
I think there is no other place in this doc where VMDB term is explained
There was a problem hiding this comment.
Also relation between ManageIQ and CFME is explained nowhere (this is not the best place but at least something for new developer)
There was a problem hiding this comment.
Also relation between ManageIQ and CFME is explained nowhere
Actually this is intentional, these are upstream docs/guides and should make no mention of CFME
providers/dev-guide.md
Outdated
| Basically, refresh process consists of Collector, Persister and Parser classes (in most providers). | ||
| When Collector loads data from external provider (like AWS), Persister defines structure of Inventory by InventoryCollection objects. | ||
| Inventory is then saved to VMDB (ManageIQ (also CFME) app database). Each inventory belons to certain ActiveRecord model. | ||
| Parser maps collected data to these inventories. |
There was a problem hiding this comment.
How about Parser maps data collected from the provider to the common format defined by the ActiveRecord model or something like that?
|
|
||
| [back](../dev-guide.md) | ||
|
|
||
| **Inventory Collection** (```ManagerRefresh::InventoryCollection``` - next called **"IC"**) is an object used by Refresh process. |
There was a problem hiding this comment.
next called "IC"
Subsequently called "IC" sounds a bit better, next sounds like just one time after
| [back](../dev-guide.md) | ||
|
|
||
| **Inventory Collection** (```ManagerRefresh::InventoryCollection``` - next called **"IC"**) is an object used by Refresh process. | ||
| It represents properties of inventory like **VM**, **Hardware**, **Operating system**, **Host** etc. |
There was a problem hiding this comment.
It represents properties of inventory like
How about It represents types of inventory such as ...? When I think of properties of inventory I think of e.g. cpus/memory not whole classes of objects
There was a problem hiding this comment.
I mean IC defines properties of inventory. As an inventory I mean VM, HW etc.
--> my lng skills :)
| **Inventory Collection** (```ManagerRefresh::InventoryCollection``` - next called **"IC"**) is an object used by Refresh process. | ||
| It represents properties of inventory like **VM**, **Hardware**, **Operating system**, **Host** etc. | ||
|
|
||
| Each IC is defined by persister (```ManagerRefresh::Inventory::Persister```), stored in it (in hash ```@collections```) and accessible as persister's method. Its name equals IC's association property (will be described later). One persister usually contains many IC definitions. |
There was a problem hiding this comment.
stored in it (in hash
Think they are stored in a hash called @collections is better
There was a problem hiding this comment.
Its name equals IC's
should be It's and is equal to the IC's
|
|
||
| Each IC is defined by persister (```ManagerRefresh::Inventory::Persister```), stored in it (in hash ```@collections```) and accessible as persister's method. Its name equals IC's association property (will be described later). One persister usually contains many IC definitions. | ||
|
|
||
| ## Defining IC |
There was a problem hiding this comment.
How about Defining an Inventory Collection
| - Common definitions | ||
| - Definitions of ICs shared accross providers divided by provider's type (cloud/infra etc.) | ||
| - Provider specific definitions | ||
| - Recommendations how to structure definitions specifical to provider and type of refresh |
|
|
||
| It creates ```ManagerRefresh::InventoryCollection``` and assigns it to **persister's @collections[:vms]** | ||
|
|
||
| Method can throw exception **`ManagerRefresh::InventoryCollection::Builder::MissingModelClassError`** |
There was a problem hiding this comment.
Maybe throw in a quick explanation about why you might get a missing model class error and how to fix it?
|
|
||
| #### - builder_class [*mandatory*] | ||
|
|
||
| There are 5 builder classes which groups ICs of the same manager(**TODO**, right?). Because they're used as parameter of ```add_collection()``` they are wrapped to methods with short name (persister's methods): |
There was a problem hiding this comment.
Maybe be better to say "there is a builder class for every manager type, e.g. cloud, infra, network, ...
|
Cc @martinpovolny please merge after @agrare approves |
|
|
||
| ## Conclusion | ||
|
|
||
| Definition of InventoryCollection objects in persisters ensures ```add_collection()``` method. |
There was a problem hiding this comment.
Can't tell what this sentence means, it sounds like the inventory collection definition does something to the add_collection method but I'm pretty sure it is the other way around right? add_collection adds the ICs to the persister.
There was a problem hiding this comment.
Yes, I mean what you wrote, of course :))
|
@slemrmartin : waiting for you to resolve latest @agrare 's comments. 👍 And THANK YOU for writing the docs 👍 ! |
Issue ManageIQ/manageiq#17396
Description of
ManagerRefresh::Inventory::Persister#add_collection()and builder classes for definition of InventoryCollectionCc @agrare