Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/genaumann/salt-acme.sh-formula
Salt - Acme.sh Formula
https://github.com/genaumann/salt-acme.sh-formula
acme acmesh salt saltstack saltstack-formula
Last synced: 4 days ago
JSON representation
Salt - Acme.sh Formula
- Host: GitHub
- URL: https://github.com/genaumann/salt-acme.sh-formula
- Owner: genaumann
- License: apache-2.0
- Created: 2023-12-23T15:30:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T19:41:10.000Z (2 months ago)
- Last Synced: 2024-12-15T19:04:00.946Z (11 days ago)
- Topics: acme, acmesh, salt, saltstack, saltstack-formula
- Language: Python
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Salt acme.sh Formula
![lint][lint_badge]
![test][test_badge]
Interacts with [acme.sh](https://acme.sh):
- install acme.sh
- issue certificates
- renew certificates
The following modes are supported:
- standalone
- webroot
- dns
## General notes
See the full [SaltStack Formulas installation and usage instructions][install].
See [`example.yml`](example.yml) on how to configure the formula.
If you want to use this formula, please pay attention to the [`FORMULA`](FORMULA) file and/or `git tag`,
which contains the currently released version.
This formula is versioned according to [Semantic Versioning](http://semver.org/).
## Available states
- [`acme_sh`](acme_sh/init.sls)
- [`acme_sh.install`](acme_sh/install.sls)
- [`acme_sh.issue`](acme_sh/issue.sls)
### `acme_sh`
Includes the following states:
- `acme_sh.install`
- `acme_sh.issue`
### `acme_sh.install`
Installs `acme.sh`.
### `acme_sh.issue`
Issues or renews certificate with `acme.sh`.
## Available execution modules
- [`acme_sh`](docs/module_acme_sh.md)
## Available state modules
- [`acmesh`](docs/state_acme_sh.md)
## Testing
Linux testing is done with `kitchen-salt`.
All tests and lint jobs are executed in GitHub Actions.
### Requirements
You can test the formula locally after installing the following requirements.
- vagrant
- VirtualBox
- Ruby
- bundler
### Run Test
```bash
bundle install
kitchen list # list all available test instances
kitchen test
```
[install]: https://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html
[lint_badge]: https://github.com/genaumann/salt-acme.sh-formula/actions/workflows/lint.yml/badge.svg?branch=main
[test_badge]: https://github.com/genaumann/salt-acme.sh-formula/actions/workflows/salt-kitchen.yml/badge.svg?branch=main