# Shinigami
[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)
[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)
Shinigami is a stand alone Python application for killing errant processes on Slurm based compute nodes.
The application scans for and terminates any running processes not associated with a currently running Slurm job.
Processes associated with whitelisted users (root, administrators, service accounts, etc.) are ignored.
## Installation and Setup
The `shinigami` command line utility is installable via the pip (or pipx) package manager:
```bash
pipx install shinigami
```
To be of maximal use, it is recommended to run the utility every half hour.
However, you may find a different cadence more appropriate depending on your cluster size and use case.
Running the utility automatically is accomplished via a simple cron job:
```cron
0,30 * * * * shinigami
```
You may wish to configure the cron job to run under a dedicated service account.
When doing so, ensure the user is added to the admin list and satisfies the following criteria:
- Exists on all compute nodes
- Has appropriate permissions to terminate system processes on compute nodes
- Has established SSH keys for connecting to compute nodes
Raw data
{
"_id": null,
"home_page": "https://github.com/pitt-crc/shinigami",
"name": "crc-shinigami",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "process,terminate,slurm",
"author": "Pitt Center for Research Computing",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/dc/b4/7029213d0b3aceb319947502d732b0a699ed644e1b3db6aa3e6f39d71b5d/crc_shinigami-0.5.0.tar.gz",
"platform": null,
"description": "# Shinigami\n[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)\n[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)\n\nShinigami is a stand alone Python application for killing errant processes on Slurm based compute nodes.\nThe application scans for and terminates any running processes not associated with a currently running Slurm job.\nProcesses associated with whitelisted users (root, administrators, service accounts, etc.) are ignored.\n\n## Installation and Setup\n\nThe `shinigami` command line utility is installable via the pip (or pipx) package manager:\n\n```bash\npipx install shinigami\n```\n\nTo be of maximal use, it is recommended to run the utility every half hour.\nHowever, you may find a different cadence more appropriate depending on your cluster size and use case.\nRunning the utility automatically is accomplished via a simple cron job:\n\n```cron\n0,30 * * * * shinigami\n```\n\nYou may wish to configure the cron job to run under a dedicated service account.\nWhen doing so, ensure the user is added to the admin list and satisfies the following criteria:\n\n- Exists on all compute nodes\n- Has appropriate permissions to terminate system processes on compute nodes\n- Has established SSH keys for connecting to compute nodes\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A stand alone Python application for killing errant processes on Slurm based compute nodes.",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/pitt-crc/shinigami",
"Repository": "https://github.com/pitt-crc/shinigami"
},
"split_keywords": [
"process",
"terminate",
"slurm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c7dcc9f1d554fc45ae6576fc81e21de8f8216860e57871470be02ec24cdedfa",
"md5": "1d41e59d0b66c04d3cb3c3e1f7ea9bf8",
"sha256": "36d8a89559bae691a189725e930ed602aa152220640f956a5c10926ab52052cc"
},
"downloads": -1,
"filename": "crc_shinigami-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d41e59d0b66c04d3cb3c3e1f7ea9bf8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19951,
"upload_time": "2024-01-02T18:20:40",
"upload_time_iso_8601": "2024-01-02T18:20:40.701612Z",
"url": "https://files.pythonhosted.org/packages/6c/7d/cc9f1d554fc45ae6576fc81e21de8f8216860e57871470be02ec24cdedfa/crc_shinigami-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dcb47029213d0b3aceb319947502d732b0a699ed644e1b3db6aa3e6f39d71b5d",
"md5": "2b287f12484f89d55038741c59867f5c",
"sha256": "44cd833e644ac08a88cd24c951a26f2afc3449391af60cf46bdbc241f715e0f5"
},
"downloads": -1,
"filename": "crc_shinigami-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "2b287f12484f89d55038741c59867f5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18493,
"upload_time": "2024-01-02T18:20:42",
"upload_time_iso_8601": "2024-01-02T18:20:42.039476Z",
"url": "https://files.pythonhosted.org/packages/dc/b4/7029213d0b3aceb319947502d732b0a699ed644e1b3db6aa3e6f39d71b5d/crc_shinigami-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 18:20:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pitt-crc",
"github_project": "shinigami",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "crc-shinigami"
}
JSON
