Mention the migrator in the secrets service readme (#86922)

mention the migrator in the secrets service readme
This commit is contained in:
Mihai Doarna 2024-04-25 17:44:55 +03:00 committed by GitHub
parent 917cbce448
commit 28e86c3edb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -10,6 +10,10 @@ import (
// Service is an envelope encryption service in charge of encrypting/decrypting secrets. // Service is an envelope encryption service in charge of encrypting/decrypting secrets.
// It is a replacement for encryption.Service // It is a replacement for encryption.Service
// //
// For all encrypted secrets stored in the database, a migrator is needed to re-encrypt
// the secrets every time the encryption key has been rotated. Please add your database
// secrets to the migrator slice available in ./migrator/migrator.go.
//
//go:generate mockery --name Service --structname MockService --outpkg fakes --filename mock_service.go --output ./fakes/ //go:generate mockery --name Service --structname MockService --outpkg fakes --filename mock_service.go --output ./fakes/
type Service interface { type Service interface {
// Encrypt MUST NOT be used within database transactions, it may cause database locks. // Encrypt MUST NOT be used within database transactions, it may cause database locks.