Add studio auth to datachain #514
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #514 +/- ##
==========================================
+ Coverage 87.16% 87.43% +0.26%
==========================================
Files 96 97 +1
Lines 9991 10069 +78
Branches 1367 1374 +7
==========================================
+ Hits 8709 8804 +95
+ Misses 928 908 -20
- Partials 354 357 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Why does it day "DvcX operations" instead of DataChain? 😅 |
shcheklein
reviewed
Oct 16, 2024
shcheklein
reviewed
Oct 16, 2024
shcheklein
reviewed
Oct 16, 2024
shcheklein
reviewed
Oct 16, 2024
shcheklein
approved these changes
Oct 16, 2024
Oh, I copied the description from dvc PR for the screenshot 😀 |
Deploying datachain-documentation with
|
| Latest commit: |
b1d6ace
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1bce5ccb.datachain-documentation.pages.dev |
| Branch Preview URL: | https://amrit-studio-auth.datachain-documentation.pages.dev |
An error occurred while trying to automatically change base from
amrit/config
to
main
October 17, 2024 14:59
As a part of #10774, this introduces a process to save the configuration in local, system and global configuration. The precedence of the level are as: - system - global - local Local configuration overrides global and so on. This borrows the logic of how configuration is managed in DVC.
Adds a new auth command to datachain that authorizes the datachain with
studio.
Commands added are:
- `datachain studio login`
- `datachain studio logout`
- `datachain studio token`
## Studio command
```sh
Authenticate Datachain with Studio and set the token. Once this token has been properly configured, Datachain will utilize it for seamlessly sharing
datasets and using Studio features from CLI
positional arguments:
{login,logout,token} Use `Datachain studio CMD --help` to display command-specific help.
login Authenticate Datachain with Studio host
logout Logout user from Studio
token View the token datachain uses to contact Studio
options:
-h, --help show this help message and exit
--aws-endpoint-url AWS_ENDPOINT_URL
AWS endpoint URL
--anon AWS anon (aka awscli's --no-sign-request)
--ttl TTL Time-to-live of data source cache. Negative equals forever.
-u, --update Update cache
-v, --verbose Verbose
-q, --quiet Be quiet
--debug-sql Show All SQL Queries (very verbose output, for debugging only)
--pdb Drop into the pdb debugger on fatal exception
```
## Login
To login, you can call `datachain studio login` which will open the Studio with a device code prefilled in your browser. Once the user authorizes the code, the token is saved to global config.
```sh
usage: datachain studio login [-h] [-q | -v] [-H HOSTNAME] [-s SCOPES] [-n NAME] [-d]
By default, this command authorize datachain with Studio with
default scopes and a random name as token name.
options:
-h, --help show this help message and exit
-q, --quiet Be quiet.
-v, --verbose Be verbose.
-H HOSTNAME, --hostname HOSTNAME
The hostname of the Studio instance to authenticate with.
-s SCOPES, --scopes SCOPES
The scopes for the authentication token.
-n NAME, --name NAME The name of the authentication token. It will be used to identify token shown in Studio profile.
-d, --use-device-code
Use authentication flow based on user code. You will be presented with user code to enter in browser. Datachain will also use this if it
cannot launch browser on your behalf.
```
### Example usages:
#### Normal flow
On running the command `datachain studio login` , following screen is presented in CLI:
```sh
datachain studio login
A web browser has been opened at
https://studio.iterative.ai/auth/device-login.
Please continue the login in the web browser.
If no web browser is available or if the web browser fails to open,
use device code flow with `datachain studio login --use-device-code`.
```
A webbrowser is opened with the device code in Studio.
<img width="632" alt="image" src="https://github.com/iterative/dvc/assets/16842655/8662d52b-9523-4db4-9742-02808d7e3ec4">
Once user authorizes the token in the screen above, the token is saved to the user's global config.
Additional message as below will be shown in the CLI and will exit.
```sh
Authentication successful. The token will be available as risen-geum in Studio profile.
```
#### Device login flow
In case, you are running this in remote machine or where you are unable to open web browser, the following screen is presented.
```
Please open the following url in your browser.
https://studio.iterative.ai/auth/device-login
And enter the user code below 06D21JBK to authorize.
```
Every other flow is same.
## Logout
```sh
usage: datachain studio logout [-h] [-q | -v]
This command helps to log out user from Studio.
options:
-h, --help show this help message and exit
-q, --quiet Be quiet.
-v, --verbose Be verbose.
```
## Token
```sh
usage: datachain studio token [-h] [-q | -v]
View the token datachain uses to contact Studio
options:
-h, --help show this help message and exit
-q, --quiet Be quiet.
-v, --verbose Be verbose.
```
amritghimire
force-pushed
the
amrit/studio-auth
branch
from
cf9a7bc to
b1d6ace
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new auth command to datachain that authorizes the datachain with
studio.
Commands added are:
datachain studio logindatachain studio logoutdatachain studio tokenStudio command
Login
To login, you can call
datachain studio loginwhich will open the Studio with a device code prefilled in your browser. Once the user authorizes the code, the token is saved to global config.Example usages:
Normal flow
On running the command
datachain studio login, following screen is presented in CLI:A webbrowser is opened with the device code in Studio.
Once user authorizes the token in the screen above, the token is saved to the user's global config.
Additional message as below will be shown in the CLI and will exit.
Authentication successful. The token will be available as risen-geum in Studio profile.Device login flow
In case, you are running this in remote machine or where you are unable to open web browser, the following screen is presented.
Every other flow is same.
Logout
Token
Related to https://github.com/iterative/studio/issues/10774
Based on #513