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

Update login instructions for training #1261

Merged
merged 2 commits into from
Apr 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file removed docs/source/images/training_auth_screen_2.png
Binary file not shown.
Binary file removed docs/source/images/training_auth_screen_4.png
Binary file not shown.
Binary file removed docs/source/images/training_email_screen_3.png
Binary file not shown.
Binary file removed docs/source/images/training_gen_qhub_1.png
Binary file not shown.
Binary file added docs/source/images/training_instances.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/training_instances_6.png
Binary file not shown.
Binary file added docs/source/images/training_login_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/training_login_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/training_server_start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/training_server_start_5.png
Binary file not shown.
11 changes: 8 additions & 3 deletions docs/source/installation/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ The `qhub` realm is selected by default, we strongly recommend leaving it as is.
Depending on the authentication provider selected ('password', 'GitHub' or 'Auth0'), the values entered into the 'Username' field will differ slightly. The following table outlines
those differences:

| | Password | GitHub | Auth0 | |---|---|---|---| | Username | *unique username* | *GitHub username* | *Email to login with* |
| | Password | GitHub | Auth0 |
| -------- | ----------------- | ----------------- | --------------------- |
| Username | *unique username* | *GitHub username* | *Email to login with* |

Once the 'Username' field is updated, please add a valid email address in the 'Email' field.

Expand Down Expand Up @@ -112,8 +114,11 @@ choose 'Password\` based authentication, enter the username and password you cho
Groups represent a collection of users that perform similar actions and therefore require the similar permissions. By default, QHub is deployed with the following groups: 'admin',
'developer', 'analyst' and 'viewer'.

| Group | Access to QHub Resources | |---|---| | 'admin' | Conda-Store Admin <br> Dask Admin <br> Jupyterhub Admin <br> Graphana Admin | | 'analyst' | Conda-Store Developer <br>
Jupyterhub Developer <br> Graphana Viewer | | 'developer' | Conda-Store Developer <br> Dask Developer <br> Jupyterhub Developer <br> Graphana Developer |
| Group | Access to QHub Resources |
| ----------- | ------------------------------------------------------------------------------------------- |
| 'admin' | Conda-Store Admin <br> Dask Admin <br> Jupyterhub Admin <br> Graphana Admin |
| 'analyst' | Conda-Store Developer <br> Jupyterhub Developer <br> Graphana Viewer |
| 'developer' | Conda-Store Developer <br> Dask Developer <br> Jupyterhub Developer <br> Graphana Developer |

To create new groups or modify (or delete) existing groups, log in as `root` and click 'Groups' on the left-hand side.

Expand Down
33 changes: 14 additions & 19 deletions docs/source/user_guide/training.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,33 @@
# QHub training cluster

Quansight provides training around the [PyData](https://pydata.org/) ecosystem. For this training material, a Qhub based training cluster is utilized. This guide explains to
Quansight provides training around the [PyData](https://pydata.org/) ecosystem. For this training material, a QHub based training cluster is utilized. This guide explains to
newcomers how to log into Quansight's own QHub Training server. If you are looking for instructions on logging into your own organization's QHub see the user
[getting started docs](getting_started.md).

To access the training platform:

1. Register on [https://training.qhub.dev](https://training.qhub.dev).

![Screenshot of the training platform](../images/training_gen_qhub_1.png)
The person in charge of organizing the training on non-Quansight side will provide a list of names and email addresses. In preparation of the upcomng training session, the
Quansight training team will add those users to the aforementioned QHub instance. The instructions that follow assume your user has been added.

2. Enter your email address. Ideally use the one associated with your invitation.

![Login screen using Auth0](../images/training_auth_screen_2.png)
To access the training platform:

3. You should then receive an email from **Quansight-training** with a 6-digit code. Remember to check your spam folder just in case.
1. Navigate tp [https://quansight.qhub.dev](https://quansight.qhub.dev).

![Screenshot of email with the login code](../images/training_email_screen_3.png)
![Screenshot of the training platform](../images/training_login_1.png)

4. Copy the code, head back over to the [https://training.qhub.dev](https://training.qhub.dev) webpage, and paste it when prompted.
2. Enter your email address, the one associated with your invitation and enter the password. At the start of the training session, your trainer will share this password with you.

![Screenshot displaying the code to be pasted on QHub login webpage](../images/training_auth_screen_4.png)
![Login screen using Keycloak](../images/training_login_2.png)

5. This should allow you to launch the QHub instance for training. Once logged in, you should see the page below.
3. This should allow you to launch the QHub instance for training. Once logged in, you should see the page below.

![Screenshot of initial QHub login page](../images/training_server_start_5.png)
![Screenshot of initial QHub login page](../images/training_server_start.png)

6. Once the `Start my Server` button is clicked, a prompt with different server instances is displayed.
4. Once the `Start my Server` button is clicked, a prompt with different server instances is displayed.

![Screenshot of initial QHub page once user logged in](../images/training_instances_6.png)
![Screenshot of initial QHub page once user logged in](../images/training_instances.png)

7. Click on the `Training Default` option, or whichever option your instructor has directed you to, and wait to access your new JupyterHub instance, similar to the image below.
5. Click on the `Training Default` option, or whichever option your instructor has directed you to, and wait to access your new JupyterHub instance, similar to the image below.

![QHub instance started and populated with many environments](../images/training_env_7.png)
![QHub instance started and populated with many environments](../images/training_env.png)

Congratulations, you are now logged in to QHub.

Expand Down