Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.71 KB

otsecret.md

File metadata and controls

56 lines (37 loc) · 1.71 KB
Raw

otsecret

A tool used by the Infrastructure team to share sensitive data and secrets with Engineering or any other team.

Source repository

https://github.com/envoy/otsecret/

Readme: https://github.com/envoy/otsecret/#readme

How to install?

The installation needs your personal GitHub PAT token, since the repository is internal to Envoy. Homebrew download strategy needs the GitHub PAT to download the repository package from the internal release.

export HOMEBREW_GITHUB_API_TOKEN=<use your personal PAT that has premissions to read PACKAGE> 
brew install otsecret

Prerequisite

otsecret relies on One Password CLI to store and share sensitive secrets. You need to install One Password CLI before you can use the app.

  • To install 1Password CLI (mac) - refer here
  • To get started with 1Password CLI - refer here
  • To add an account to 1Password CLI - refer here
  • Configure 1Password CLI biometric unlock - refer here

Get help

otsecret -h

Configure

The tool needs a yaml configuration as shown below

vault: set the vault id where the secrets will be maintained and shared
sendgrid-api-key: set Sendgrid API Key to send emails

Store the file as .otsecret in the home directory

Example configuration

gp@mbp ~ % echo "vault: abc" >> ~/.otsecret
gp@mbp ~ % echo "sendgrid-api-key: abc" >> ~/.otsecret
gp@mbp ~ % cat ~/.otsecret
vault: abc
sendgrid-api-key: abc

Replace abc with the actual values