updated instruction on how to use inventory data

Author: HariGS-DB

notebooks/GroupMigration/Workspace_Group_Migration_Notebook.py

@@ -84,10 +84,15 @@
 
 # COMMAND ----------
 
+from uc_upgrade.group_migration import GroupMigration
+
+# COMMAND ----------
+
 # If autoGenerateList=True then groupL will be ignored and all eliglbe groups will be migrated.
 autoGenerateList = False
 
-# please provide groups here, e.g.
+# please provide groups here, e.g. analyst.
+#please provide group names and not ids
 groupL = ["groupA", "groupB"]
 
 
@@ -99,10 +104,10 @@
 
 
 # Personal Access Token. Create one in "User Settings"
-token = "<TOKEN"
+token = "<TOKEN>"
 
 # Should the migration Check the ACL on tables/views as well?
-checkTableACL = False
+checkTableACL = True
 
 # What cloud provider? Acceptable values are "AWS" or anything other value.
 cloud = "AWS"
@@ -111,8 +116,13 @@
 userName = "<UserMailID>"
 
 # Number of threads to issue Databricks API requests with. If you get a lot of errors during the inventory, lower this value.
-numThreads = 30
+numThreads = 10
 
+# The notebook will populate data in the WorkspaceInventory and WorkspaceInventoryTableACL(If applicable).
+# if the notebook is run second time, it will retrieve the data from the table if already captured.
+# Users have the option to do a fresh inventory in which case it will recreate the tables and start again.
+#default set to False
+freshInventory = False
 # Initialize GroupMigration Class with values supplied above
 gm = GroupMigration(
     groupL=groupL,
@@ -125,6 +135,7 @@
     checkTableACL=checkTableACL,
     autoGenerateList=autoGenerateList,
     numThreads=numThreads,
+    freshInventory=freshInventory
 )
 
 # COMMAND ----------
@@ -133,13 +144,32 @@
 # MAGIC #### Step 2: Perform Dry run
 # MAGIC This steps performs a dry run to verify the current ACL on the supplied workspace groups and print outs the permission.
 # MAGIC Please verify if all the permissions are covered
+# MAGIC If the inventory was run previously and stored in the table for either Workspace or Account then it will use the same and save time, else it will do a fresh inventory
+# MAGIC If the inventory data in the table is present for only few workspace objects , the dryRun will do the fresh inventory of objects not present in the table
 
 # COMMAND ----------
 
 gm.dryRun("Workspace")
 
 # COMMAND ----------
 
+# MAGIC %md
+# MAGIC #### Adhoc Step: Selective Inventory
+# MAGIC This is a adhoc step for troubleshooting purpose. Once dryRun is complete and data stored in tables, if the acl of any object is changed in the workspace
+# MAGIC Ex new notebook permission added, User can force a fresh inventory of the selected object instead of doing a full cleanup and dryRun to save time
+# MAGIC Call gm.performInventory with 3 parameters:
+# MAGIC  - mode: Workpace("workspace local group") or Account ("for workspace back up group")
+# MAGIC  - force: setting to True will force fresh inventory capture and updates to the tables 
+# MAGIC  - objectType: select the list of object for which to do the fresh inventory, options are 
+# MAGIC  
+# MAGIC  "Group"(will do members, group list, entitlement, roles), "Password","Cluster","ClusterPolicy","Warehouse","Dashboard","Query","Job","Folder"(Will do folders, notebook and files),"TableACL","Alert","Pool","Experiment","Model","DLT","Repo","Token","Secret"
+
+# COMMAND ----------
+
+gm.performInventory('Workspace',force=True,objectType='Folder')
+
+# COMMAND ----------
+
 # MAGIC %md
 # MAGIC #### Step 3: Create Back up group
 # MAGIC This steps creates the back up groups, applies the ACL on the new temp group from the original workspace group.
@@ -159,6 +189,8 @@
 # MAGIC - Verify the temp group permissions are as seen in the initial dry run
 # MAGIC - check randomly if all the ACL are applied correctly
 # MAGIC - there should be one temp group for every workspace group (Ex: db-temp-analysts and analysts with same ACLs)
+# MAGIC - Similar to dryRun("workspace"), this will also capture inventory for first run and store it in tables, subsequent times inventory will be retrived from the table to save time.
+# MAGIC - if inventory table contains partial workspace objects(ex cluster acl is missing), it will do fresh inventory for the missing object and update table
 
 # COMMAND ----------