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

[DOC] Add dashboard section #3222

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
c4e20a2
Update TOC
JCZuurmond Oct 17, 2024
fe90b0c
Add installation requirements section
JCZuurmond Oct 17, 2024
b3458f4
Add installation resources section
JCZuurmond Oct 17, 2024
f92adf0
Update the group migration workflow section
JCZuurmond Oct 17, 2024
bfaa06a
Touch ups group migration workflow
JCZuurmond Oct 17, 2024
efa8281
Improve assessment workflow section
JCZuurmond Oct 17, 2024
ca4b169
Update TOC
JCZuurmond Oct 18, 2024
83ef94d
Update table migration table
JCZuurmond Oct 21, 2024
348f7f7
Update table and view migration section
JCZuurmond Oct 21, 2024
1437378
Mark table in mounts workflow sections as legacy
JCZuurmond Oct 21, 2024
0fedd8d
Explain minimizing data copying and maintaining metadata
JCZuurmond Oct 21, 2024
ae50687
Update job static code analysis workflow
JCZuurmond Oct 21, 2024
0cf7855
Update the post migration data reconciliation workflow section
JCZuurmond Oct 21, 2024
b8f9f98
Move README notebook into installation resources section
JCZuurmond Oct 22, 2024
c0430fb
Link workflows to workflow section
JCZuurmond Oct 22, 2024
37109e2
Move debug notebook and logs into Installation section
JCZuurmond Oct 22, 2024
c07d89f
Move advanced installation options into separate indentation
JCZuurmond Nov 5, 2024
08a1840
Rewrite intro on migration process
JCZuurmond Nov 5, 2024
4583baa
Update assessment workflow section
JCZuurmond Nov 5, 2024
74a0d45
Update assess workflows step
JCZuurmond Nov 5, 2024
3120daf
Update end of assessment workflow section
JCZuurmond Nov 5, 2024
5c53e30
Update table migration process
JCZuurmond Nov 5, 2024
fcbf1a9
Add table migration workflows
JCZuurmond Nov 5, 2024
73b268f
Add installation resources
JCZuurmond Nov 5, 2024
9d6a868
Update TOC
JCZuurmond Nov 5, 2024
bc3a010
Move linter message codes out of workflows section
JCZuurmond Nov 5, 2024
07a512f
Fix migration process index
JCZuurmond Nov 5, 2024
b163c10
Remove empty bullit point
JCZuurmond Nov 5, 2024
1680a9f
Add data reconciliation as step to the migration process
JCZuurmond Nov 5, 2024
b1c434f
Refer to workflow section in installation resources
JCZuurmond Nov 6, 2024
5fecd88
Add installation folder section
JCZuurmond Nov 6, 2024
a094c49
Link table persistence
JCZuurmond Nov 6, 2024
efaa35c
Link dashboards
JCZuurmond Nov 6, 2024
a85ed8f
Add azure service principals dashboard readme
JCZuurmond Nov 6, 2024
7f70148
Add table with dashboards
JCZuurmond Nov 6, 2024
bf8639c
Merge branch 'main' into docs/odds-and-ends-when-reading-our-docs-to-…
JCZuurmond Nov 6, 2024
a2e70fa
Update TOC
JCZuurmond Nov 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
* [Authenticate Databricks CLI](#authenticate-databricks-cli)
* [Install UCX](#install-ucx)
* [Installation resources](#installation-resources)
* [Installation folder](#installation-folder)
* [Readme notebook](#readme-notebook)
* [Debug notebook](#debug-notebook)
* [Debug logs](#debug-logs)
Expand Down Expand Up @@ -69,6 +70,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
* [<b>Always run this workflow AFTER the assessment has finished</b>](#balways-run-this-workflow-after-the-assessment-has-finishedb)
* [[LEGACY] Migrate tables in mounts Workflow](#legacy-migrate-tables-in-mounts-workflow)
* [[EXPERIMENTAL] Migration Progress Workflow](#experimental-migration-progress-workflow)
* [Dashboards](#dashboards)
* [Linter message codes](#linter-message-codes)
* [`cannot-autofix-table-reference`](#cannot-autofix-table-reference)
* [`catalog-api-in-shared-clusters`](#catalog-api-in-shared-clusters)
Expand Down Expand Up @@ -925,6 +927,19 @@ the [assessment workflow](#assessment-workflow)._

# Dashboards

The dashboards visualize UCX's outcomes. Each dashboard has text widgets detailing the contents in more detail. Below an
overview with a short description is given.

| Name | Description |
|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| [Assessment \[Main\]](./src/databricks/labs/ucx/queries/assessment/main/00_0__assessment_overview.md) | Assessment overview |
| [Assessment \[Estimates\]](./src/databricks/labs/ucx/queries/assessment/estimates/00_0_metastore_assignment.md) | Migration effort estimates based on the assessment |
| [Assessment \[Interactive\]](./src/databricks/labs/ucx/queries/assessment/interactive/00_0_interactive.md) | Assessment outcomes on interactive clusters |
| [Assessment \[Azure\]](./src/databricks/labs/ucx/queries/assessment/azure/00_0_azure_service_principals.md) | Assessment outcomes specific to Azure |
| [Migration \[Main\]](./src/databricks/labs/ucx/queries/migration/main/00_0_migration_overview.md) | Migration overview |
| [Migration \[Groups\]](./src/databricks/labs/ucx/queries/migration/groups/00_0_migration_overview.md) | Group migration outcomes |
| [Progress \[Main\]](./src/databricks/labs/ucx/queries/progress/main/00_0_migration_progress.md) | Migration progress |

[[back to top](#databricks-labs-ucx)]

# Linter message codes
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Azure Service Principals

Below you find the Azure service principals found by UCX in Spark configuration from:
- Clusters configurations
- Cluster policies
- Job cluster configurations
- Pipeline configurations
- Warehouse configuration