Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 3.97 KB

README.md

File metadata and controls

77 lines (54 loc) · 3.97 KB
Raw

VSCode SOPS extension

Info

The homepage of VSCode extension is located on https://github.com/signageos/vscode-sops

Extension for VSCode is available on market place https://marketplace.visualstudio.com/items?itemName=signageos.signageos-vscode-sops Additionally, it's available on Open VSX market place https://open-vsx.org/extension/signageos/signageos-vscode-sops

Features

VSCode extension with underlying SOPS supports:

  • Realtime editing of encrypted yaml, json, dotenv, plaintext, binary and ini files in-place in your project.
  • Create new encrypted yaml/json file using .sops.yaml config creation_rules if available.

This extension works with binaries sops / age / ... installed via aquaproj/aqua.

Requirements

Make sure that sops is available in $PATH environment variable

Extension Settings

  • sops.enable: enable/disable this extension (default: true)
  • sops.beta: enable/disable beta release without reloading VSCode or enabling/disabling extensions (default: false)
  • sops.binPath: Path to SOPS binary (default: executables from $PATH)
  • sops.configPath: Path (absolute or relative) to the configuration for this extension (empty: defaults to .sopsrc in root of project) See Config file section.
  • sops.defaults.awsProfile: Default AWS profile name which will be used for sops command --aws-profile (empty: defaults to environment variable $AWS_PROFILE)
  • sops.defaults.gcpCredentialsPath: Default path used to find GCP credentials. Overrides the $GOOGLE_APPLICATION_CREDENTIALS environment variable (empty: defaults to environment variable $GOOGLE_APPLICATION_CREDENTIALS)
  • sops.defaults.ageKeyFile: Default path used to find AGE key file. Overwrites the $SOPS_AGE_KEY_FILE environment variable (default: uses from environment variable $SOPS_AGE_KEY_FILE)
  • sops.creationEnabled: enable/disable this extension to try encrypt files included in .sops.yaml path_regex when is not encrypted yet (default: false)

Config file

Named .sopsrc in project root by default and is in YAML format.

awsProfile: my-profile-1
gcpCredentialsPath: /home/user/Downloads/my-key.json
ageKeyFile: /home/user/age.txt

Beta releases

The new features are published immediately into different extension package https://marketplace.visualstudio.com/items?itemName=signageos.signageos-vscode-sops-beta

The beta extension package is installed automatically and is disabled by default.

If you'd like to try new features, just enable configuration "sops.beta": true in global (or workspace) config file and changes are applied immediately.

You can switch beta configuration globally easily using commands sops.enable_beta/sops.disable_beta.

I recommend to have enabled beta release to test everything as soon as possible. If something went wrong in beta release, just easily rollback to "sops.beta" false and report an issue here: https://github.com/signageos/vscode-sops/issues

The reason is that vscode doesn't support beta releases built-in. See and vote for microsoft/vscode#15756

SOPS differ

Optionally, you can add following file .gitattributes into your project

encrypted/*.{yaml,json,ini,env} diff=sopsdiffer

and run following command for global git settings

git config --global diff.sopsdiffer.textconv "sops -d --config /dev/null"

to see the git diff in decrypted format.

Known Issues

See https://github.com/signageos/vscode-sops/issues

Release Notes

See https://github.com/signageos/vscode-sops/blob/master/CHANGELOG.md file.

Enjoy!