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
d842d84
commit cddc8c3
Showing
1 changed file
with
3 additions
and
69 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,70 +1,4 @@ | ||
| <div align="center"> | ||
| > The slurmd charm has been moved to https://github.com/charmed-hpc/slurm-charms/tree/main/charms/slurmd. | ||
| > This is a public archive of the original repository. | ||
| # slurmd operator | ||
|
|
||
| A [Juju](https://juju.is) operator for slurmd - the compute node daemon of [SLURM](https://slurm.schedmd.com/overview.html). | ||
|
|
||
| [](https://charmhub.io/slurmd) | ||
| [](https://github.com/omnivector-solutions/slurmd-operator/actions/workflows/ci.yaml/badge.svg) | ||
| [](https://github.com/omnivector-solutions/slurmd-operator/actions/workflows/release.yaml/badge.svg) | ||
| [](https://matrix.to/#/#ubuntu-hpc:matrix.org) | ||
|
|
||
| </div> | ||
|
|
||
| ## Features | ||
|
|
||
| The slurmd operator provides and manages the slurmd daemon. This operator provides the compute node service for machines enlisted as compute nodes in Charmed SLURM clusters. | ||
|
|
||
| ## Usage | ||
|
|
||
| This operator should be used with Juju 3.x or greater. | ||
|
|
||
| #### Deploy a minimal Charmed SLURM cluster | ||
|
|
||
| ```shell | ||
| $ juju deploy slurmctld --channel edge | ||
| $ juju deploy slurmd --channel edge | ||
| $ juju integrate slurmctld:slurmd slurmd:slurmctld | ||
| ``` | ||
|
|
||
| ### Operations | ||
| This charm hardens and simplifies operations by codifying common administration operations as charm actions. | ||
|
|
||
| #### Partition Configuration | ||
| Specify partition parameters using the charm configuration, `partition-config`. | ||
|
|
||
| ##### Use the `partition-config` to set custom partition parameters. | ||
| ```bash | ||
| $ juju config slurmd partition-config="State=INACTIVE" | ||
| ``` | ||
|
|
||
| #### Node Configuration Parameters | ||
| You can get and set the node configuration using the `node-config` action. | ||
|
|
||
| ##### Use the `node-config` action to get the node configuration for the unit. | ||
| ```bash | ||
| $ juju run --quiet slurmd/0 node-config --format json | jq ".[].results.node.config" | ||
| "NodeName=juju-462521-4 NodeAddr=10.240.222.28 State=UNKNOWN RealMemory=64012 CPUs=12 ThreadsPerCore=2 CoresPerSocket=6 SocketsPerBoard=1" | ||
| ``` | ||
|
|
||
| ##### Use the `node-config` action to set a custom weight value for the node. | ||
| ```bash | ||
| $ juju run --quiet slurmd/0 node-config parameters="Weight=5000" --format json | jq ".[].results.node.config" | ||
| "NodeName=juju-462521-4 NodeAddr=10.240.222.28 State=UNKNOWN RealMemory=64012 CPUs=12 ThreadsPerCore=2 CoresPerSocket=6 SocketsPerBoard=1 Weight=5000" | ||
| ``` | ||
|
|
||
| ## Project & Community | ||
|
|
||
| The slurmd 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 slurmd 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/slurmctld-operator/issues) | ||
| * [Juju SDK docs](https://juju.is/docs/sdk) | ||
|
|
||
| ## License | ||
|
|
||
| The slurmd operator is free software, distributed under the Apache Software License, version 2.0. See the [LICENSE](./LICENSE) file for more information. | ||
| Juju charm for slurmd, the compute node daemon for Slurm 🪄 |