Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salt-extensions/saltext-consul
Salt Extension for interacting with HashiCorp Consul
https://github.com/salt-extensions/saltext-consul
consul devops salt-extension saltstack saltstack-extension
Last synced: about 1 month ago
JSON representation
Salt Extension for interacting with HashiCorp Consul
- Host: GitHub
- URL: https://github.com/salt-extensions/saltext-consul
- Owner: salt-extensions
- License: apache-2.0
- Created: 2023-12-19T00:54:46.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-28T07:26:01.000Z (about 2 months ago)
- Last Synced: 2024-09-30T11:22:35.103Z (about 2 months ago)
- Topics: consul, devops, salt-extension, saltstack, saltstack-extension
- Language: Python
- Homepage: https://salt-extensions.github.io/saltext-consul/
- Size: 1.3 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
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
# Salt Extension for HashiCorp Consul
Salt Extension for interacting with HashiCorp Consul
## Security
If you discover a security vulnerability, please refer
to [Salt's security guide][security].
## User Documentation
For setup and usage instructions, please refer to the
[User Documentation][docs].
## Contributing
The saltext-consul project welcomes contributions from anyone!
The [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects
of Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],
[writing documentation][writing-docs] and [rendering the docs][rendering-docs].
### Quickstart
To get started contributing, first clone this repository (or your fork):
```bash
# Clone the repo
git clone --origin upstream [email protected]:salt-extensions/saltext-consul.git
# Change to the repo dir
cd saltext-consul
```
#### Automatic
If you have installed [direnv][direnv], allowing the project's `.envrc` ensures
a proper development environment is present and the virtual environment is active.
Without `direnv`, you can still run the automation explicitly:
```bash
python3 tools/initialize.py
source .venv/bin/activate
```
#### Manual
Please follow the [first steps][first-steps], skipping the repository initialization and first commit.
### Pull request
Always make changes in a feature branch:
```bash
git switch -c my-feature-branch
```
To [submit a Pull Request][submitting-pr], you'll need a fork of this repository in
your own GitHub account. If you followed the instructions above,
set your fork as the `origin` remote now:
```bash
git remote add origin [email protected]:.git
```
Ensure you followed the [first steps][first-steps] and commit your changes, fixing any
failing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.
### Ways to contribute
Contributions come in many forms, and they’re all valuable! Here are some ways you can help
without writing code:
* **Documentation**: Especially examples showing how to use this project
to solve specific problems.
* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].
* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].
You can also contribute by:
* Writing blog posts
* Sharing your experiences using Salt + HashiCorp Consul
on social media
* Giving talks at conferences
* Publishing videos
* Engaging in IRC, Discord or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/
[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html
[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html
[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html
[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html
[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment
[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[direnv]: https://direnv.net
[issues]: https://github.com/salt-extensions/saltext-consul/issues
[PRs]: https://github.com/salt-extensions/saltext-consul/pulls
[discussions]: https://github.com/salt-extensions/saltext-consul/discussions
[comments]: https://conventionalcomments.org/
[docs]: https://salt-extensions.github.io/saltext-consul/