-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
9 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,30 +1,30 @@ | ||
# Salt PKI | ||
|
||
This repository contains a collection of execution modules and states to manage a X.509 keys, certificate signing requests and certificates. It does support modern EC suites. The actual signing can be delegated to other execution modules or runners, such as [`acme.sign`](https://github.com/jgraichen/salt-acme). | ||
This repository contains a collection of execution modules and states to manage X.509 keys, certificate signing requests and certificates. It does support modern EC suites. The actual signing can be delegated to other execution modules or runners, such as [`acme.sign`](https://github.com/jgraichen/salt-acme). | ||
|
||
The current version focuses on the needs for TLS certificates and external signing (e.g. ACME, Vault, custom modules). | ||
|
||
## Modules | ||
|
||
See [_modules/pki.py](_modules/pki.py). | ||
See [`_modules/pki.py`](_modules/pki.py). | ||
|
||
## States | ||
|
||
See [_states/pki.py](_states/pki.py). | ||
See [`_states/pki.py`](_states/pki.py). | ||
|
||
## Installation | ||
|
||
The recommend way uses salts GitFS. | ||
The recommended way of installation is using [salt `gitfs`](https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html) on the salt master. | ||
|
||
```yaml | ||
# /etc/salt/master | ||
gitfs_remotes: | ||
- 'https://github.com/jgraichen/salt-pki.git': | ||
- base: v1.0.0 | ||
- "https://github.com/jgraichen/salt-pki.git": | ||
- base: v1.0.1 | ||
``` | ||
It execution modules are to be used on the master, e.g. in runners, remember to synchronize modules on the master: | ||
If you want to use execution modules on the salt master, e.g. in runners, remember to synchronize modules on the master: | ||
``` | ||
$ salt-run saltutil.sync_modules | ||
```console | ||
salt-run saltutil.sync_modules | ||
``` |