diff --git a/docs/parameter_reference.md b/docs/parameter_reference.md index 244460f..3073f06 100644 --- a/docs/parameter_reference.md +++ b/docs/parameter_reference.md @@ -95,6 +95,26 @@ values_files: [ "./over_9,000.yml" ] values_files: [ "./over_9", "000.yml" ] ``` +### Interpolating secrets into the `values` and `string_values` settings + +If you want to send secrets to your charts, you can use syntax similar to shell variable interpolation--either `$VARNAME` or `$${VARNAME}`. The double dollar-sign is necessary when using curly brackets; using curly brackets with a single dollar-sign will trigger Drone's string substitution (which can't use arbitrary environment variables). If an environment variable is not set, it will be treated as if it were set to the empty string. + +```yaml +environment: + DB_PASSWORD: + from_secret: db_password + SESSION_KEY: + from_secret: session_key +settings: + values: + - db_password=$DB_PASSWORD # db_password will be set to the contents of the db_password secret + - db_pass=$DB_PASS # db_pass will be set to "" since $DB_PASS is not set + - session_key=$${SESSION_KEY} # session_key will be set to the contents of the session_key secret + - sess_key=${SESSION_KEY} # sess_key will be set to "" by Drone's variable substitution +``` + +Variables intended for interpolation must be set in the `environment` section, not `settings`. + ### Backward-compatibility aliases Some settings have alternate names, for backward-compatibility with drone-helm. We recommend using the canonical name unless you require the backward-compatible form. diff --git a/internal/env/config.go b/internal/env/config.go index 6c4f43c..68e49f3 100644 --- a/internal/env/config.go +++ b/internal/env/config.go @@ -89,6 +89,8 @@ func NewConfig(stdout, stderr io.Writer) (*Config, error) { cfg.Timeout = fmt.Sprintf("%ss", cfg.Timeout) } + cfg.loadValuesSecrets() + if cfg.Debug && cfg.Stderr != nil { cfg.logDebug() } @@ -98,6 +100,27 @@ func NewConfig(stdout, stderr io.Writer) (*Config, error) { return &cfg, nil } +func (cfg *Config) loadValuesSecrets() { + findVar := regexp.MustCompile(`\$\{?(\w+)\}?`) + + replacer := func(varName string) string { + sigils := regexp.MustCompile(`[${}]`) + varName = sigils.ReplaceAllString(varName, "") + + if value, ok := os.LookupEnv(varName); ok { + return value + } + + if cfg.Debug { + fmt.Fprintf(cfg.Stderr, "$%s not present in environment, replaced with \"\"\n", varName) + } + return "" + } + + cfg.Values = findVar.ReplaceAllStringFunc(cfg.Values, replacer) + cfg.StringValues = findVar.ReplaceAllStringFunc(cfg.StringValues, replacer) +} + func (cfg Config) logDebug() { if cfg.KubeToken != "" { cfg.KubeToken = "(redacted)" diff --git a/internal/env/config_test.go b/internal/env/config_test.go index 40123dd..15510e0 100644 --- a/internal/env/config_test.go +++ b/internal/env/config_test.go @@ -183,6 +183,37 @@ func (suite *ConfigTestSuite) TestLogDebugCensorsKubeToken() { suite.Equal(kubeToken, cfg.KubeToken) // The actual config value should be left unchanged } +func (suite *ConfigTestSuite) TestNewConfigWithValuesSecrets() { + suite.unsetenv("VALUES") + suite.unsetenv("STRING_VALUES") + suite.unsetenv("SECRET_WATER") + suite.setenv("SECRET_FIRE", "Eru_Ilúvatar") + suite.setenv("SECRET_RINGS", "1") + suite.setenv("PLUGIN_VALUES", "fire=$SECRET_FIRE,water=${SECRET_WATER}") + suite.setenv("PLUGIN_STRING_VALUES", "rings=${SECRET_RINGS}") + + cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{}) + suite.Require().NoError(err) + + suite.Equal("fire=Eru_Ilúvatar,water=", cfg.Values) + suite.Equal("rings=1", cfg.StringValues) +} + +func (suite *ConfigTestSuite) TestValuesSecretsWithDebugLogging() { + suite.unsetenv("VALUES") + suite.unsetenv("SECRET_WATER") + suite.setenv("SECRET_FIRE", "Eru_Ilúvatar") + suite.setenv("PLUGIN_DEBUG", "true") + suite.setenv("PLUGIN_STRING_VALUES", "fire=$SECRET_FIRE") + suite.setenv("PLUGIN_VALUES", "fire=$SECRET_FIRE,water=$SECRET_WATER") + stderr := strings.Builder{} + _, err := NewConfig(&strings.Builder{}, &stderr) + suite.Require().NoError(err) + + suite.Contains(stderr.String(), "Values:fire=Eru_Ilúvatar,water=") + suite.Contains(stderr.String(), `$SECRET_WATER not present in environment, replaced with ""`) +} + func (suite *ConfigTestSuite) setenv(key, val string) { orig, ok := os.LookupEnv(key) if ok {