summaryrefslogtreecommitdiffstats
path: root/docs/inventory_refresh.md
diff options
context:
space:
mode:
authorWayne Witzel III <wayne@riotousliving.com>2017-05-26 16:10:31 +0200
committerWayne Witzel III <wayne@riotousliving.com>2017-05-26 16:16:12 +0200
commite28cd97ffb7266e0594d0151f680821d84f72ef1 (patch)
tree37e37d1779ddb4f16d5ab1de55664b780b7f9488 /docs/inventory_refresh.md
parentMerge pull request #6338 from wenottingham/yes-we-are-enablers (diff)
downloadawx-e28cd97ffb7266e0594d0151f680821d84f72ef1.tar.xz
awx-e28cd97ffb7266e0594d0151f680821d84f72ef1.zip
Add smart_inventories endpoint to Host
Diffstat (limited to '')
-rw-r--r--docs/inventory_refresh.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/inventory_refresh.md b/docs/inventory_refresh.md
index 8cbbd06c00..8cd6a8e6b9 100644
--- a/docs/inventory_refresh.md
+++ b/docs/inventory_refresh.md
@@ -23,10 +23,16 @@ in our _Smart Search_.
* The `Inventory` model has a new field called `kind`. The default of this field will be blank
for normal inventories and set to `smart` for smart inventories.
-* `Inventory` model as a new field called `host_filter`. The default of this field will be blank
+* `Inventory` model has a new field called `host_filter`. The default of this field will be blank
for normal inventories. When `host_filter` is set AND the inventory `kind` is set to `smart`
is the combination that makes a _Smart Inventory_.
+* `Host` model has a new field called `smart_inventories`. This field uses the `SmartInventoryMemberships`
+lookup table to provide a set of all of the _Smart Inventory_ a host is a part of. The memberships
+or generated by the `update_host_smart_inventory_memberships` task. This task is called when the view for
+`/api/v2/hosts/:id/smart_inventories` is materialized. NOTE: This task is only run if the
+`AWX_REBUILD_SMART_MEMBERSHIP` is set to True. It defaults to False.
+
### Smart Filter (host_filter)
The `SmartFilter` class handles our translation of the smart search string. We store the
filter value in the `host_filter` field for an inventory. This value should be expressed