This repository has been archived by the owner on Aug 9, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: add tombstone notice to readme
BREAKING CHANGES: Tombstones this repo in favor of the monorepo.
- Loading branch information
1 parent
9d0322b
commit 65c2637
Showing
1 changed file
with
3 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,4 @@ | ||
| <div align="center"> | ||
| > The slurmrestd charm has been moved to https://github.com/charmed-hpc/slurm-charms/tree/main/charms/slurmrestd. | ||
| > This is a public archive of the original repository. | ||
| # slurmrestd operator | ||
|
|
||
| A [Juju](https://juju.is) operator for slurmrestd - the REST API interface to [SLURM](https://slurm.schedmd.com/overview.html). | ||
|
|
||
| [](https://charmhub.io/slurmrestd) | ||
| [](https://github.com/omnivector-solutions/slurmrestd-operator/actions/workflows/ci.yaml/badge.svg) | ||
| [](https://github.com/omnivector-solutions/slurmrestd-operator/actions/workflows/release.yaml/badge.svg) | ||
| [](https://matrix.to/#/#ubuntu-hpc:matrix.org) | ||
|
|
||
| </div> | ||
|
|
||
| ## Features | ||
|
|
||
| The slurmrestd operator provides the slurmrestd service. This operator provides a REST API for interfacing with the SLURM | ||
| workload manager. Rather than interfacing with SLURM via cluster head nodes, slurmrestd enables submitting batch jobs | ||
| via HTTP requests over a network. | ||
|
|
||
| ## Usage | ||
|
|
||
| This operator should be used with Juju 3.x or greater. | ||
|
|
||
| #### Deploy a minimal Charmed SLURM cluster with slurmrestd | ||
|
|
||
| ```shell | ||
| $ juju deploy slurmrestd --channel edge | ||
| $ juju deploy slurmctld --channel edge | ||
| $ juju deploy slurmd --channel edge | ||
| $ juju deploy slurmdbd --channel edge | ||
| $ juju deploy mysql --channel 8.0/edge | ||
| $ juju deploy mysql-router slurmdbd-mysql-router --channel dpe/edge | ||
| $ juju integrate slurmctld:slurmd slurmd:slurmctld | ||
| $ juju integrate slurmctld:slurmdbd slurmdbd:slurmctld | ||
| $ juju integrate slurmctld:slurmrestd slurmrestd:slurmctld | ||
| $ juju integrate slurmdbd-mysql-router:backend-database mysql:database | ||
| $ juju integrate slurmdbd:database slurmdbd-mysql-router:database | ||
| ``` | ||
|
|
||
| ## Project & Community | ||
|
|
||
| The slurmrestd operator is a project of the [Ubuntu HPC](https://discourse.ubuntu.com/t/high-performance-computing-team/35988) | ||
| community. It is an open source project that is welcome to community involvement, contributions, suggestions, fixes, and | ||
| constructive feedback. Interested in being involved with the development of the slurmrestd operator? Check out these links below: | ||
|
|
||
| * [Join our online chat](https://matrix.to/#/#ubuntu-hpc:matrix.org) | ||
| * [Contributing guidelines](./CONTRIBUTING.md) | ||
| * [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct) | ||
| * [File a bug report](https://github.com/omnivector-solutions/slurmrestd-operator/issues) | ||
| * [Juju SDK docs](https://juju.is/docs/sdk) | ||
|
|
||
| ## License | ||
|
|
||
| The slurmrestd operator is free software, distributed under the Apache Software License, version 2.0. See the [LICENSE](./LICENSE) file for more information. | ||
| Juju charm for slurmrestd, the REST API interface for Slurm 🪄 |