{"id":20010413,"url":"https://github.com/haldih/slurmer","last_synced_at":"2026-03-11T14:37:39.952Z","repository":{"id":50259352,"uuid":"467993699","full_name":"HaldiH/Slurmer","owner":"HaldiH","description":"A job manager for Slurm, written in Go","archived":false,"fork":false,"pushed_at":"2022-09-25T18:48:55.000Z","size":160,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-14T23:57:10.206Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaldiH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-09T15:53:45.000Z","updated_at":"2022-09-12T14:08:42.000Z","dependencies_parsed_at":"2023-01-18T21:15:50.495Z","dependency_job_id":null,"html_url":"https://github.com/HaldiH/Slurmer","commit_stats":null,"previous_names":["shinoyasx/slurmer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/HaldiH/Slurmer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaldiH%2FSlurmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaldiH%2FSlurmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaldiH%2FSlurmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaldiH%2FSlurmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaldiH","download_url":"https://codeload.github.com/HaldiH/Slurmer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaldiH%2FSlurmer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30384098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T14:10:17.325Z","status":"ssl_error","status_checked_at":"2026-03-11T14:09:37.934Z","response_time":84,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T07:19:42.238Z","updated_at":"2026-03-11T14:37:39.915Z","avatar_url":"https://github.com/HaldiH.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Slurmer\n\nA job manager for Slurm, written in Go.\n\n## Installation\n\n### From sources\n\nRequirements:\n\n- Go \u003e= 1.18\n- GNU Make\n- Slurm commands on the host that will run Slurmer and be connected to the cluster\n\nFirst, you have to compile the code to get both `slurmer` and `executor` executables. A Makefile is available to do so:\n\n```bash\nmake\n```\n\nThere is few variables that you can override to specify custom options:\n\n| Variable name          | Description                                              | Default      |\n| ---------------------- | -------------------------------------------------------- | ------------ |\n| _MIN\\_UID_, _MAX\\_UID_ | the minimum and maximum uids that the executor can spoof | 1000, 65565  |\n| _SLURMER\\_UID_         | The user that is authorized to use the executor          | 1000         |\n| PREFIX                 | The path prefix to install slurmer to                    | `/usr/local` |\n\nDon't forget to `make clean` between variable changes to make sure that your changes have taken effect.\n\n#### Example of custom variables\n\n```bash\nmake MIN_UID=1100 MAX_UID=1200 SLURMER_UID=1099\n```\n\nThen you can install the executables to the destination directory (need root permissions):\n\n```bash\nmake PREFIX=/opt/slurmer install\n```\n\nNow Slurmer should be installed on your system. Next we'll see how to use it.\n\n## Configuration\n\nFor this section, let's consider that slurmer is installed to prefix `/usr/local/`. Let's say that we have the configuration in `/usr/local/etc/slurmer/config.yml` (see [sample configuration](#sample-configuration)) and the Slurmer files have to be in `/var/lib/slurmer`. Make sure that only Slurmer account can edit `config.yml`.\n\nFirst, create a directory `/var/lib/slurmer` and set the owner to the Slurmer user (we assume that `slurmer` is the Slurmer user):\n\n```bash\nmkdir /var/lib/slurmer\nchown -R slurmer /var/lib/slurmer/ /usr/local/etc/slurmer/\n\n# make sure that only slurmer can access and modify these files\nchmod 0700 /var/lib/slurmer/ /usr/local/etc/slurmer/\nchmod 0600 /usr/local/etc/slurmer/config.yml\n```\n\nNext, set the value `working_dir` in `config.yml` to `/var/lib/slurmer`.\n\nNow you can run Slurmer with the following line to consider the given configuration (run with the Slurmer user):\n\n```bash\nslurmer -c /usr/local/etc/slurmer/config.yml\n```\n\n### Sample configuration\n\nA sample config file is also available in `configs/config-example.yml`.\n\n```yaml\n# Useful when 'connector' is set to 'slurmrest'; not implemented yet\nslurmrest:\n  url: \"http+unix:///default?socket=/tmp/slurmrestd.sock\"\n\nslurmer:\n  ip: 127.0.0.1\n  port: 8080\n  connector: slurmcli\n  working_dir: /var/lib/slurmer\n  templates_dir: /etc/slurmer/templates\n  executor_path: /usr/bin/executor\n  applications:\n    - name: app1\n      token: averycomplicatedchallenge\n      uuid: a9a5fc66-9bed-4a13-874a-d8d7d1756224 # a random app uuid\n  logs:\n    # available: text, json\n    format: text\n\n    stdout: false\n    output: /var/logs/slurmer.log\n\n    # available, from most to less verbose:\n    # trace, debug, info, warning, error, fatal, panic\n    level: debug\n\n# To enable OIDC\noidc:\n  enabled: false\n  issuer: \"\"\n  audience: \"\"\n```\n\n## REST API summary\n\nEach request must be authenticated with an application token and eventually a user for jobs related resources.\n\n| Header       | Description                  |\n| ------------ | ---------------------------- |\n| X-Auth-Token | Authenticates an application |\n| User         | The user that owns a job     |\n\n### Routes\n\n| Verb   | Route                             | Description                                       |\n| ------ | --------------------------------- | ------------------------------------------------- |\n| GET    | /apps                             | list all applications, need admin access token    |\n| POST   | /apps                             | add a new application, need admin access token    |\n| GET    | /apps/{appId}                     | show {appId} application, need admin access token |\n| GET    | /apps/{appId}/jobs                | list all jobs of the app {appId}                  |\n| POST   | /apps/{appId}/jobs                | add a new job to app {appId}                      |\n| GET    | /apps/{appId}/jobs/{jobId}        | show job {jobId} details                          |\n| DELETE | /apps/{appId}/jobs/{jobId}        | delete a registered job                           |\n| GET    | /apps/{appId}/jobs/{jobId}/batch  | read jobs batch file                              |\n| GET    | /apps/{appId}/jobs/{jobId}/out    | read jobs standard output                         |\n| GET    | /apps/{appId}/jobs/{jobId}/files  | download the job files as zip                     |\n| POST   | /apps/{appId}/jobs/{jobId}/files  | upload a zip to job directory                     |\n| PUT    | /apps/{appId}/jobs/{jobId}/status | start or stop a job                               |\n| PUT    | /apps/{appId}/jobs/{jobId}/prune  | clear all job data except batch file              |\n| PUT    | /apps/{appId}/jobs/{jobId}/start  | start a job                                       |\n| PUT    | /apps/{appId}/jobs/{jobId}/stop   | stop a job                                        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaldih%2Fslurmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaldih%2Fslurmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaldih%2Fslurmer/lists"}