Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 2.23 KB

change_client_groups.md

File metadata and controls

52 lines (42 loc) · 2.23 KB
Raw

How administrators change Client Groups (CG)

Background

  • All KBase Jobs use a CG to schedule jobs
  • The default CG is njs
  • Changing a CG will affect the scheduling of all future jobs
  • If you don't know what you are doing, please ask for help in #devops , #sysadmin, and/or #poc
  • The catalog CG UI is available at https://narrative.kbase.us/#catalog/admin
  • The default resources at kept in ee2

As of Dec 2022, the default resources are

{"client_group": "njs", "request_cpus": "12", "request_memory" : "10000"}
{"client_group": "bigmem", "request_cpus": "16", "request_memory" : "250000"}
{"client_group": "extreme", "request_cpus": "32", "request_memory" : "200000"}

Step 1: Choose the app you want to change

  • To get the Module Name is easy, its just the first line in your kbase sdk app spec eg module kb_StrainFinder {
  • To get the Function name is harder, you have to go into the App/UI definition that you want and see what method it calls

Step 2: Select the ClientGroup

  • To get the default settings and run on different hardware, set the CG as follows:
{"client_group": "bigmem"}
{"client_group": "extreme"}

Step 3: Specify Custom Values (Optional)

WARNING You must know the actual capacity of the hardware or the job will be stuck forever and never run

{"request_cpus": "64", "client_group": "bigmem", "request_memory" : "500000"}

Give access to the "staging" area on the Data Transfer Node (dtn) for upload jobs

WARNING THE DTN NODE IS FOR UPLOAD JOBS, NOT FOR JOBS THAT DO SIGNIFICANT COMPUTATION WARNING WARNING PLEASE CHECK WITH THE DEVELOPER BEFORE ADDING COMPUTATIONALLY INTENSIVE JOBS TO THE UPLOAD QUEUE WARNING

Step 1: Choose the app you want to change

  • Get module name and function name

Step 2: Select the ClientGroup

{"client_group": "kb_upload"}

Step 3: Specify the Docker Volume Mount

Heres an example

kb_model_analysis	model_heatmap_analysis	kb_upload	/dtn/disk0/bulk/${username}      /staging   (read-only)