mungectl is archived. It was originally used within the Slurm charms and snap, but was eventually deprecated in favor of managing the MUNGE key directly in the charm/snap Python code. While the CLI binary was neat, key issues included (a) distributing mungectl through a Debian package was a maintenance burden and (b) handling exit codes emitted by the mungectl CLI binary was less granular than directly handling exceptions raised in Python.

mungectl

mungectl is a command line tool for controlling and managing the operations of a node's MUNGE authentication daemon 🔐

For more information on how to use or contribute to mungectl, check out the Getting Started and Development sections below 👇

✨ Getting started

Installation

Option 1: Install from source

We use just to manage this project. We recommend that it is installed on your system before installing mungectl from source:

git clone https://github.com/charmed-hpc/mungectl.git
cd mungectl
just && just install

Usage

Key management

mungectl can be used to manage the MUNGE key file shared between all the nodes in your HPC cluster using the key subcommand:

mungectl key generate               # Generate new munge key file.
mungectl key get                    # Get munge key file as base64-encoded string.
cat new.key.b64 | mungectl key set  # Set new munge key using base64-encoded key.

🤔 What's next?

If you want to learn more about all the things you can do with mungectl, here are some further resources for you to explore:

• Open an issue
• Ask a question on GitHub

🛠️ Development

mungectl uses just as its command runner. mungectl's justfile provides some useful recipes that will definitely help you while you're hacking and wacking on mungectl:

just fmt   # Apply formatting standards to project.
just lint  # Check project against coding style standards.
just unit  # Run unit tests.

If you're interested in contributing your work to mungectl, take a look at our contributing guidelines for further details.

🤝 Project and Community

mungectl is a project of the Ubuntu High-Performance Computing community. Interested in contributing bug fixes, patches, documentation, or feedback? Want to join the Ubuntu HPC community? You’ve come to the right place 🤩

Here’s some links to help you get started with joining the community:

• Ubuntu Code of Conduct
• Contributing guidelines
• Join the conversation on Matrix
• Get the latest news on Discourse
• Ask and answer questions on GitHub

📋 License

mungectl is free software, distributed under the GNU General Public License, version 3.0. See the GPLv3 LICENSE file for further details.