@@ -124,6 +124,8 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
124124 * [ ` revert-cluster-remap ` command] ( #revert-cluster-remap-command )
125125 * [ ` upload ` command] ( #upload-command )
126126 * [ ` download ` command] ( #download-command )
127+ * [ ` join-collection ` command] (#join-collection command)
128+ * [ collection eligible command] ( #collection-eligible-command )
127129* [ Common Challenges and the Solutions] ( #common-challenges-and-the-solutions )
128130 * [ Network Connectivity Issues] ( #network-connectivity-issues )
129131 * [ Insufficient Privileges] ( #insufficient-privileges )
@@ -1786,6 +1788,40 @@ $ databricks labs ucx download --file <file_path> --run-as-collection True
17861788Download a csv file from a single workspace (` --run-as-collection False ` ) or a collection of workspaces
17871789(` --run-as-collection True ` ). This command is especially useful when downloading the same file from multiple workspaces.
17881790
1791+ ## ` join-collection ` command
1792+
1793+ ``` text
1794+ $ databricks labs ucx join-collection --workspace-ids <comma seperate list of workspace ids> --profile <account-profile>
1795+ ```
1796+
1797+ ` join-collection ` command joins 2 or more workspaces into a collection. This helps in running supported cli commands as a collection
1798+ ` join-collection ` command updates config.yml file on each workspace ucx installation with installed_workspace_ids attribute.
1799+ In order to run ` join-collectioon ` command a user should:
1800+ - be an Account admin on the Databricks account
1801+ - be a Workspace admin on all the workspaces to be joined as a collection) or a collection of workspaces
1802+ - have installed UCX on the workspace
1803+ The ` join-collection ` command will fail and throw an error msg if the above conditions are not met.
1804+
1805+ ## collection eligible command
1806+
1807+ Once ` join-collection ` command is run, it allows user to run multiple cli commands as a collection. The following cli commands
1808+ are eligible to be run as a collection. User can run the below commands as collection by passing an additional flag ` --run-as-collection=True `
1809+ - ` ensure-assessment-run `
1810+ - ` create-table-mapping `
1811+ - ` principal-prefix-access `
1812+ - ` migrate-credentials `
1813+ - ` create-uber-principal `
1814+ - ` create-missing-principals `
1815+ - ` validate-external-location `
1816+ - ` migrate-locations `
1817+ - ` create-catalog-schemas `
1818+ - ` migrate-tables `
1819+ - ` migrate-acls `
1820+ - ` migrate-dbsql-dashboards `
1821+ - ` validate-group-membership `
1822+ Ex: ` databricks labs ucx ensure-assessment-run --run-as-collection=True `
1823+
1824+
17891825# Common Challenges and the Solutions
17901826Users might encounter some challenges while installing and executing UCX. Please find the listing of some common challenges and the solutions below.
17911827
0 commit comments