Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salt-extensions/saltext-stalekey
Salt engine that detects inactive minions and removes their keys
https://github.com/salt-extensions/saltext-stalekey
Last synced: about 2 months ago
JSON representation
Salt engine that detects inactive minions and removes their keys
- Host: GitHub
- URL: https://github.com/salt-extensions/saltext-stalekey
- Owner: salt-extensions
- License: apache-2.0
- Created: 2024-06-21T15:47:03.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T20:38:31.000Z (3 months ago)
- Last Synced: 2024-10-18T20:02:41.006Z (3 months ago)
- Language: Python
- Size: 97.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# Stalekey Salt Engine
Salt engine that detects inactive minions and removes their keys
## Security
If you think you have found a security vulnerability, see
[Salt's security guide][security].
## User Documentation
This README is for people aiming to contribute to the project.
If you just want to get started with the extension, check out the
[User Documentation][docs].
## Contributing
The saltext-stalekey project team welcomes contributions from the community.
The [Salt Contributing guide][salt-contributing] has a lot of relevant
information, but if you'd like to jump right in here's how to get started:
```bash
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.cargo/env
# Clone the repo
git clone --origin upstream [email protected]:salt-extensions/saltext-stalekey.git
# Change to the repo dir
cd saltext-stalekey
# Create a new venv
uv venv -p 3.10
source .venv/bin/activate
# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant
# Install extension + test/dev/doc dependencies into your environment
uv pip install -e ".[dev,tests,docs]"
# Run tests!
nox -e tests-3
# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1
# Build the docs, serve, and view in your web browser:
nox -e docs-dev
```
Writing code isn't the only way to contribute! We value contributions in any of
these areas:
* Documentation - especially examples of how to use this module to solve
specific problems.
* Triaging [issues][issues] and participating in [discussions][discussions]
* Reviewing [Pull Requests][PRs] (we really like
[Conventional Comments][comments]!)
You could also contribute in other ways:
* Writing blog posts
* Posting on social media about how you used Salt + Stalekey to solve your
problems, including videos
* Giving talks at conferences
* Publishing videos
* Asking/answering questions in IRC, Discord or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
For more information, build the docs and head over to http://localhost:8000/ —
that's where you'll find the rest of the documentation.
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html
[issues]: https://github.com/salt-extensions/saltext-stalekey/issues
[PRs]: https://github.com/salt-extensions/saltext-stalekey/pulls
[discussions]: https://github.com/salt-extensions/saltext-stalekey/discussions
[comments]: https://conventionalcomments.org/
[docs]: https://salt-extensions.github.io/saltext-stalekey/