ADP-216: updates README from UAT feedback for step1

ADP-216-wrapup
Lee Watson 10 months ago
parent 8a035c2fd3
commit 84ce66fdd7

@ -66,6 +66,8 @@ Follow the interactive prompts:
./verify/usr_confirm_keycfg.sh ./verify/usr_confirm_keycfg.sh
``` ```
Now the sample secrets file _in this repo_ has been updated, and the New User should be able to decrypt it!
### Update Project SOPS Config ### Update Project SOPS Config
The following commands explain how to update the `.sops.yaml` for a repository: The following commands explain how to update the `.sops.yaml` for a repository:
@ -114,11 +116,31 @@ SOPS is used for encrypting secrets, e.g. credentials for various systems
## Install ## Install
### 1. Install Sops
https://github.com/getsops/sops https://github.com/getsops/sops
Note: Note:
* MacOS: If desired, one can also use brew to install sops: `brew install sops`; although this is not officially maintained, [the formula is essentially the same as the official installation instructions](https://github.com/Homebrew/homebrew-core/blob/4496ce5131bc09e7065fa0aa8fb96366a3df6477/Formula/s/sops.rb) * MacOS: If desired, one can also use brew to install sops: `brew install sops`; although this is not officially maintained, [the formula is essentially the same as the official installation instructions](https://github.com/Homebrew/homebrew-core/blob/4496ce5131bc09e7065fa0aa8fb96366a3df6477/Formula/s/sops.rb)
### 2. Configure
Add the following to your `~/.bashrc` or `~/.zshrc` - but _not_ to your `~/.profile` as it must be set per session:
```shell
# Enable interactive passphrase prompt for SOPS
export GPG_TTY=$(tty)
```
### 3. Verify
Run the following command to verify local SOPS installation _and_ key configuration:
```shell
# Follow the interactive prompts:
./verify/usr_confirm_keycfg.sh
```
## Usage ## Usage
Decrypt and Display Secrets in Terminal: Decrypt and Display Secrets in Terminal:
@ -126,6 +148,7 @@ Decrypt and Display Secrets in Terminal:
```bash ```bash
GPG_TTY=$(tty) sops secrets.yaml GPG_TTY=$(tty) sops secrets.yaml
``` ```
<!-- CAVEAT: if GPG_TTY is set in environment, no need to specify it again. Leaving it inline for this command to be explicit about requirement for correct functiuonality -->
Note: The `GPG_TTY` is necessary to have the password prompt appear. src: https://www.varokas.com/secrets-in-code-with-mozilla-sops/ Note: The `GPG_TTY` is necessary to have the password prompt appear. src: https://www.varokas.com/secrets-in-code-with-mozilla-sops/

Loading…
Cancel
Save