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

Add docs for jupyterhub profiles #155

Merged
merged 2 commits into from
Mar 28, 2024
Merged

Add docs for jupyterhub profiles #155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05134d9
replace mentions of Qhub-HPC to Nebari-Slurm
viniciusdc Mar 26, 2024
50ae1d5
add docs for jupyterhub_profiles config
viniciusdc Mar 26, 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
31 changes: 28 additions & 3 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Adding new user

In order to add new users to QHub-HPC add to the `enabled_users`
In order to add new users to Nebari-Slurm add to the `enabled_users`
variable. The format for each user is:

```yaml
Expand All @@ -21,7 +21,7 @@ enabled_users:

### Adding new groups

In order to add new groups to QHub-HPC add to the `enabled_groups`
In order to add new groups to Nebari-Slurm add to the `enabled_groups`
variable. The format for each group is:

```yaml
Expand Down Expand Up @@ -159,6 +159,31 @@ The resource selection options form allows users to choose the cpu, memory, and
jupyterhub_qhub_options_form: false
```

### Profiles (Slurm jobs resources)

Profiles in Nebari-Slurm are defined within a YAML configuration file. Each profile specifies a set of resources that will be allocated to the JupyterHub session or job when selected by the user. Below is an example of how to define profiles in the configuration file:

```yaml
jupyterhub_profiles:
- small:
display_name: Profile 1 [Small] (1CPU-2GB)
options:
req_memory: "2"
req_nprocs: "1"
- medium:
display_name: Profile 2 [Medium] (1CPU-4GB)
options:
req_memory: "4"
req_nprocs: "1"
```

In the example above, two profiles are defined: small and medium. Each profile has a display_name that describes the profile to users in a human-readable format, including the resources allocated by that profile (e.g., "Profile 1 [Small] (1CPU-2GB)"). The options section specifies the actual resources to be allocated:

- **req_memory**: The amount of memory (in GB) to be allocated.
- **req_nprocs**: The number of CPU processors to be allocated.

*Note*: All slurm related configuration needs to be passed down as a string.

### Services

Additional services can be added to the `jupyterhub_services`
Expand Down Expand Up @@ -252,7 +277,7 @@ slurmdbd_config:

### Accessing Qhub HPC from a Domain

By default, a qhub-hpc deployment must be accesssed using the ip
By default, a Nebari-Slurm deployment must be accesssed using the ip
address of the hpc_master node. However, if a domain name has been
set up to point to the hpc_master node, then Qhub HPC's router,
[Traefik](https://doc.traefik.io/traefik/), can be configured to work
Expand Down
Loading