Skip to content
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
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/assets/images/hopsworksai/bob_dashboard.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/assets/images/hopsworksai/members_accept.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/assets/images/hopsworksai/members_delete.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/assets/images/hopsworksai/members_empty.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 79 additions & 0 deletions docs/hopsworksai/user_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# User management
In Hopsworks.ai users can be grouped into *organizations* to access the same resources.
When a new user registers with Hopsworks.ai a new organization is created. This user later on can
invite other registered users to their organization so they can share access to the same clusters.

Cloud Accounts configuration is also shared among users of the same organization. So if user Alice has configured
her account with her credentials, all member of her *organization* will automatically deploy clusters in her cloud
account. Credits and cluster usage are also grouped to ease reporting.

## Adding members to an organization
Organization membership can be edited by clicking **Members** on the left of Hopsworks.ai Dashboard page.

<p align="center">
<figure>
<a href="../../../assets/images/hopsworksai/members_empty.png">
<img src="../../../assets/images/hopsworksai/members_empty.png" alt="Organization membership">
</a>
<figcaption>Organization membership</figcaption>
</figure>
</p>

To add a new member to your organization add the user's email and click **Add**. The invited user will
receive an email with the invitation.

An invited user **must accept** the invitation to be part of the organization. An invitation will show up in
the invited member's Dashboard. In this example Alice has invited Bob to her organization, but Bob hasn't accepted
the invitation yet.

<p align="center">
<figure>
<a href="../../../assets/images/hopsworksai/members_invited.png">
<img src="../../../assets/images/hopsworksai/members_invited.png" alt="Invitation">
</a>
<figcaption>Alice has sent the invitation</figcaption>
</figure>

<figure>
<a href="../../../assets/images/hopsworksai/members_accept.png">
<img src="../../../assets/images/hopsworksai/members_accept.png" alt="Accept invitation">
</a>
<figcaption>Bob's dashboard</figcaption>
</figure>
</p>

## Sharing resources
Once Bob has accepted the invitation he does **not** have to configure his account, they share the same configuration.
Also, he will be able to view **the same** Dashboard as Alice, so he can start, stop or terminate clusters in the organization.

<p align="center">
<figure>
<a href="../../../assets/images/hopsworksai/alice_dashboard.png">
<img src="../../../assets/images/hopsworksai/alice_dashboard.png" alt="Alice dashboard">
</a>
<figcaption>Alice's dashboard</figcaption>
</figure>

<figure>
<a href="../../../assets/images/hopsworksai/bob_dashboard.png">
<img src="../../../assets/images/hopsworksai/bob_dashboard.png" alt="Bob dashboard">
</a>
<figcaption>Bob's dashboard</figcaption>
</figure>
</p>

If Alice had existing clusters running and she had selected [Managed user management](../aws/cluster_creation/#step-9-user-management-selection)
during cluster creation, an account will be automatically created for Bob on these clusters.

## Removing members from an organization
To remove a member from your organization simply go to **Members** page and click the **Remove** button next to the user you want to remove.
You will **stop** sharing any resource and the user **will be blocked** from any shared cluster.

<p align="center">
<figure>
<a href="../../../assets/images/hopsworksai/members_delete.png">
<img src="../../../assets/images/hopsworksai/members_delete.png" alt="Delete organization member">
</a>
<figcaption>Delete organization member</figcaption>
</figure>
</p>
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nav:
- Azure: hopsworksai/azure/cluster_creation.md
- Adding and Removing workers: hopsworksai/adding_removing_workers.md
- GPU support: hopsworksai/gpu_support.md
- User management: hopsworksai/user_management.md
# - Databricks Quickstart:
# - AWS: hopsworksai/aws/databricks_quickstart.md
# - Azure: hopsworksai/azure/databricks_quickstart.md
Expand Down