From 05134d9d98ccc5b2c4f2e29119b55743225cae2b Mon Sep 17 00:00:00 2001 From: viniciusdc Date: Tue, 26 Mar 2024 11:41:59 -0300 Subject: [PATCH 1/2] replace mentions of Qhub-HPC to Nebari-Slurm --- docs/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index bdd61baa..7246bb8d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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 @@ -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 @@ -252,7 +252,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 From 50ae1d5987b7440ebd36242bafa9b2559561733c Mon Sep 17 00:00:00 2001 From: viniciusdc Date: Tue, 26 Mar 2024 17:14:27 -0300 Subject: [PATCH 2/2] add docs for jupyterhub_profiles config --- docs/configuration.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 7246bb8d..2b3b3dd6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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`