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.

Sign up for GitHub

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

Jump to bottom

Extend documentation with additional steps to get started #947

Merged
merged 5 commits into from
Feb 15, 2024
Merged

Extend documentation with additional steps to get started #947

merged 5 commits into from
Feb 15, 2024

Conversation

nkvuong
Copy link
Contributor

@nkvuong nkvuong commented Feb 15, 2024

Changes

Extend README.MD with additional steps to get started

Functionality

  • added relevant user documentation

@nkvuong nkvuong requested review from a team and HariGS-DB February 15, 2024 09:47
@codecov Codecov
Copy link

codecov bot commented Feb 15, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f951aac) 87.76% compared to head (0194f77) 87.76%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #947   +/-   ##
=======================================
  Coverage   87.76%   87.76%           
=======================================
  Files          43       43           
  Lines        5213     5213           
  Branches      939      939           
=======================================
  Hits         4575     4575           
  Misses        434      434           
  Partials      204      204

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

alexott
alexott approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@alexott alexott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

README.md Outdated
- Network access to your Databricks Workspace
- Network access to the Internet to retrieve additional Python packages (e.g. PyYAML, databricks-sdk,...) and access github.com
- Network access to the Internet to retrieve additional Python packages (e.g. PyYAML, databricks-sdk,...) and access GitHub.com
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe leave github.com, but convert it into URL?

william-conti
william-conti suggested changes Feb 15, 2024
View reviewed changes
README.md Outdated
[This guide](docs/assessment.md) talks about them in more details.

#### Synchronising workspace info
Use to upload workspace config to all workspaces in the account where UCX is installed. UCX will prompt you to select an account profile that has been defined in `~/.databrickscfg`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What this will allow the user to do ? Is it a UCX cross-workspace installation ?

README.md
### Download & Install

We only support installations and upgrades through [Databricks CLI](https://docs.databricks.com/en/dev-tools/cli/index.html), as UCX requires an installation script run to make sure all the necessary and correct configurations are in place.
- Workspace administrator access permissions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some commands also requires Account Admin permissions AFAIK

README.md Outdated
- Create a new or select an existing SQL warehouse to run assessment dashboards on. The existing warehouse must be Pro or Serverless.
- Configurations for workspace local groups migration:
- Provide a backup prefix. This is used to rename workspace local groups after they have been migrated. Defaults to `db-temp-`
- Select a workspace local groups migration strategy. UCX offers matching by name or external ID, using a prefix/suffix, or using regex.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to the group_name_conflict doc

README.md Outdated
```

#### Saving AWS instance profiles
Use to identify all instance profiles in the workspace, and map their access to S3 buckets. This requires `awscli` to be installed and configured.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Command is missing

nfx
nfx approved these changes Feb 15, 2024
View reviewed changes
Copy link
Collaborator

@nfx nfx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

@nfx nfx changed the title Extend README.MD with additional steps to get started Extend documentation with additional steps to get started Feb 15, 2024
@nfx nfx merged commit fd0b604 into main Feb 15, 2024
6 of 7 checks passed
@nfx nfx deleted the doc/improvements branch February 15, 2024 14:10
nfx added a commit that referenced this pull request Feb 16, 2024
@nfx
Release v0.13.0
909742c 
* Added CLI Command `databricks labs ucx principal-prefix-access` ([#949](#949)).
* Added a widget with all jobs to track migration progress ([#940](#940)).
* Added legacy cluster types to the assessment result ([#932](#932)).
* Cleanup of install documentation ([#951](#951), [#947](#947)).
* Fixed `WorkspaceConfig` initialization for `DEBUG` notebook ([#934](#934)).
* Fixed installer not opening config file during the installation ([#945](#945)).
* Fixed groups in config file not considered for group migration job ([#943](#943)).
* Fixed bug where `tenant_id` inside secret scope is not detected ([#942](#942)).
@nfx nfx mentioned this pull request Feb 16, 2024
Merged
nfx added a commit that referenced this pull request Feb 16, 2024
@nfx
Release v0.13.0 (#952)
228dd8f 
* Added CLI Command `databricks labs ucx principal-prefix-access`
([#949](#949)).
* Added a widget with all jobs to track migration progress
([#940](#940)).
* Added legacy cluster types to the assessment result
([#932](#932)).
* Cleanup of install documentation
([#951](#951),
[#947](#947)).
* Fixed `WorkspaceConfig` initialization for `DEBUG` notebook
([#934](#934)).
* Fixed installer not opening config file during the installation
([#945](#945)).
* Fixed groups in config file not considered for group migration job
([#943](#943)).
* Fixed bug where `tenant_id` inside secret scope is not detected
([#942](#942)).
dmoore247 pushed a commit that referenced this pull request Mar 23, 2024
@nkvuong @dmoore247
Extend documentation with additional steps to get started (#947)
0cc55df
dmoore247 pushed a commit that referenced this pull request Mar 23, 2024
@nfx @dmoore247
Release v0.13.0 (#952)
e159977 
* Added CLI Command `databricks labs ucx principal-prefix-access`
([#949](#949)).
* Added a widget with all jobs to track migration progress
([#940](#940)).
* Added legacy cluster types to the assessment result
([#932](#932)).
* Cleanup of install documentation
([#951](#951),
[#947](#947)).
* Fixed `WorkspaceConfig` initialization for `DEBUG` notebook
([#934](#934)).
* Fixed installer not opening config file during the installation
([#945](#945)).
* Fixed groups in config file not considered for group migration job
([#943](#943)).
* Fixed bug where `tenant_id` inside secret scope is not detected
([#942](#942)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@william-conti william-conti william-conti requested changes

@alexott alexott alexott approved these changes

@nfx nfx nfx approved these changes

@HariGS-DB HariGS-DB Awaiting requested review from HariGS-DB

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nkvuong @alexott @nfx @william-conti