docs: fix SOPS store type for dotenv files (env -> dotenv)#1673
Open
yugstar wants to merge 1 commit into
Open
Conversation
The SOPS encryption example used `sops -e --input-type=env`, but SOPS has no `env` store type — its formats are binary, dotenv, ini, json and yaml, and an unknown `--input-type` silently falls back to `binary`. So the example encrypted the dotenv file as opaque binary instead of as a dotenv file. Use `--input-type=dotenv --output-type=dotenv` so the file is encrypted and decrypted as dotenv. Applied to both the v1 spec (the canonical source imported by the website) and the v1beta2 copy. Signed-off-by: Aman Raj <aman.yug@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The SOPS encryption example in the Kustomization spec docs used:
sops -e --input-type=env config.env > config.env.encryptedSOPS has no
envstore type — its formats arebinary,dotenv,ini,jsonandyaml(seegetsops/sopscmd/sops/formats/formats.go). An unrecognized--input-typesilently falls back tobinary, so this example encrypts the dotenv file as opaque binary rather than as a dotenv file, which then won't decrypt back into key/value pairs as intended.Fix it to use the
dotenvstore explicitly:sops -e --input-type=dotenv --output-type=dotenv config.env > config.env.encryptedApplied to both
docs/spec/v1/kustomizations.md(the canonical source imported by the Flux website) and thedocs/spec/v1beta2/kustomizations.mdcopy.