Add redis elasticache database plugin support #1596

maxcoulombe · 2022-09-06T21:46:06Z

Note: this feature requires Vault Server 1.12.0 or greater. The targeted GA date for Vault 1.12.0 is Oct. 12th, 2022.

Release note for CHANGELOG:

feat: Add support for the upcoming Redis-ElastiCache Database Plugin

Output from acceptance testing:

/usr/local/go/bin/go tool test2json -t /tmp/GoLand/___1TestAccDatabaseSecretBackendConnection_redisElastiCache_in_github_com_hashicorp_terraform_provider_vault_vault.test -test.v -test.paniconexit0 -test.run ^\QTestAccDatabaseSecretBackendConnection_redisElastiCache\E$
2022/09/06 17:34:50 [INFO] Using Vault token with the following policies: root
=== RUN   TestAccDatabaseSecretBackendConnection_redisElastiCache
--- PASS: TestAccDatabaseSecretBackendConnection_redisElastiCache (0.86s)
PASS

Process finished with the exit code 0

Config example:

provider "vault" {
  address = "http://127.0.0.1:8200"
  token   = "root"
}

resource "vault_database_secret_backend_connection" "redis_db" {
  backend       = "database"
  name          = "redis"
  allowed_roles = ["*"]

  redis_elasticache {
    url = "master.vault-plugin-elasticache-test.6ylpiw.use1.cache.amazonaws.com:6379"
  }
}

resource "vault_database_secret_backend_static_role" "redis_role" {
  name            = "redis"
  backend         = "database"
  username        = "vault-test"
  rotation_period = 300
  db_name         = vault_database_secret_backend_connection.redis_db.name
}

vinay-gopalan

Looking good! I think you also need a setRedisElastiCacheConnectionData function that reads the data from the TF config. This method can then be called from getDatabaseAPIDataForEngine as done here: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection.go#L833

…iCacheSupport

codegen/generate.go

vault/resource_database_secret_backend_connection.go

maxcoulombe · 2022-09-27T13:48:19Z

Looking good! I think you also need a setRedisElastiCacheConnectionData function that reads the data from the TF config. This method can then be called from getDatabaseAPIDataForEngine as done here: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection.go#L833

Thanks for catching that. Out of curiosity whats the functional purpose of adding that? It seems like everything was working fine including showing the diff during updates and populating the statefile so I'm wondering what use case can I use to validate it's working as intended?

vinay-gopalan · 2022-09-29T18:47:23Z

Looking good! I think you also need a setRedisElastiCacheConnectionData function that reads the data from the TF config. This method can then be called from getDatabaseAPIDataForEngine as done here: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection.go#L833

Thanks for catching that. Out of curiosity whats the functional purpose of adding that? It seems like everything was working fine including showing the diff during updates and populating the statefile so I'm wondering what use case can I use to validate it's working as intended?

Good question! I believe in the context of your test, the SDK was mainly only checking if the respective fields are populated with the particular values within the resource diff and state, and hence the test passes. However, since we never actually read those values from the resource diff and write them to Vault, an Import TestStep would show that the test would fail. Import tests read the resource from Vault and verify the values are the what we expect them to be, thereby providing a more complete loop on the test. Here's an example of an import test for a DB engine: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection_test.go#L247-L252

maxcoulombe · 2022-09-30T15:23:50Z

Looking good! I think you also need a setRedisElastiCacheConnectionData function that reads the data from the TF config. This method can then be called from getDatabaseAPIDataForEngine as done here: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection.go#L833

Thanks for catching that. Out of curiosity whats the functional purpose of adding that? It seems like everything was working fine including showing the diff during updates and populating the statefile so I'm wondering what use case can I use to validate it's working as intended?

Good question! I believe in the context of your test, the SDK was mainly only checking if the respective fields are populated with the particular values within the resource diff and state, and hence the test passes. However, since we never actually read those values from the resource diff and write them to Vault, an Import TestStep would show that the test would fail. Import tests read the resource from Vault and verify the values are the what we expect them to be, thereby providing a more complete loop on the test. Here's an example of an import test for a DB engine: https://github.com/hashicorp/terraform-provider-vault/blob/main/vault/resource_database_secret_backend_connection_test.go#L247-L252

Thanks for the link to the example. Everything seems fine now and the test pass.

max@max-Precision-7560:~/projects/terraform-provider-vault/vault$ TF_ACC=1 ELASTICACHE_URL=master.vault-plugin-elasticache-test.6ylpiw.use1.cache.amazonaws.com:6379 go test -v -run TestAccDatabaseSecretBackendConnection_redisElastiCache
2022/09/30 11:22:55 [INFO] Using Vault token with the following policies: root
=== RUN   TestAccDatabaseSecretBackendConnection_redisElastiCache
--- PASS: TestAccDatabaseSecretBackendConnection_redisElastiCache (0.96s)
PASS
ok  	github.com/hashicorp/terraform-provider-vault/vault	0.978s

Imports also work as expected if I try it manually.

benashz

Looking good, just have a few issues/nits/suggestions

website/docs/r/database_secret_backend_connection.md

vault/gcp.go

codegen/generate.go

vault/resource_database_secret_backend_connection.go

vault/resource_database_secret_backend_connection_test.go

website/docs/r/database_secret_backend_connection.md

vinay-gopalan

LGTM after updating the import to ignore redis password and adding the docs!

benashz

LGTM!

* + added redis elasticache database plugin support

+ added redis elasticache database plugin support

b87daec

maxcoulombe requested review from benashz, vinay-gopalan and Zlaticanin September 6, 2022 21:46

github-actions bot added the size/M label Sep 6, 2022

vinay-gopalan reviewed Sep 26, 2022

View reviewed changes

maxcoulombe added 2 commits September 27, 2022 09:41

+ added missing switch case

2a71b96

Merge remote-tracking branch 'origin/main' into vault-8171-redisElast…

47cf5e4

…iCacheSupport

github-actions bot added size/L and removed size/M labels Sep 27, 2022

maxcoulombe commented Sep 27, 2022

View reviewed changes

codegen/generate.go Show resolved Hide resolved

maxcoulombe commented Sep 27, 2022

View reviewed changes

vault/resource_database_secret_backend_connection.go Show resolved Hide resolved

+ added import test

7c4eef1

+ added doc

bb974ca

github-actions bot added the documentation label Sep 30, 2022

* doc adjustments

a32b1e6

benashz changed the title ~~+ added redis elasticache database plugin support~~ Add redis elasticache database plugin support Sep 30, 2022

benashz reviewed Sep 30, 2022

View reviewed changes

vinay-gopalan approved these changes Sep 30, 2022

View reviewed changes

* formatting, doc & test fix

f4d3635

benashz approved these changes Oct 3, 2022

View reviewed changes

benashz added this to the 3.9.0 milestone Oct 3, 2022

maxcoulombe merged commit 4f4e840 into main Oct 3, 2022

benashz added new-resource and removed new-resource labels Oct 4, 2022

maxcoulombe deleted the vault-8171-redisElastiCacheSupport branch October 17, 2022 15:42

maxcoulombe mentioned this pull request Oct 17, 2022

Redis database backend is not supported #1640

Closed

blufor mentioned this pull request Oct 30, 2022

Add Redis database plugin support #1654

Closed

marcboudreau pushed a commit to marcboudreau/terraform-provider-vault that referenced this pull request Nov 6, 2022

Add redis elasticache database plugin support (hashicorp#1596)

d6bcfc2

* + added redis elasticache database plugin support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add redis elasticache database plugin support #1596

Add redis elasticache database plugin support #1596

maxcoulombe commented Sep 6, 2022 •

edited by benashz

Loading

vinay-gopalan left a comment

maxcoulombe commented Sep 27, 2022 •

edited

Loading

vinay-gopalan commented Sep 29, 2022 •

edited

Loading

maxcoulombe commented Sep 30, 2022

benashz left a comment

vinay-gopalan left a comment

benashz left a comment

Add redis elasticache database plugin support #1596

Add redis elasticache database plugin support #1596

Conversation

maxcoulombe commented Sep 6, 2022 • edited by benashz Loading

vinay-gopalan left a comment

Choose a reason for hiding this comment

maxcoulombe commented Sep 27, 2022 • edited Loading

vinay-gopalan commented Sep 29, 2022 • edited Loading

maxcoulombe commented Sep 30, 2022

benashz left a comment

Choose a reason for hiding this comment

vinay-gopalan left a comment

Choose a reason for hiding this comment

benashz left a comment

Choose a reason for hiding this comment

maxcoulombe commented Sep 6, 2022 •

edited by benashz

Loading

maxcoulombe commented Sep 27, 2022 •

edited

Loading

vinay-gopalan commented Sep 29, 2022 •

edited

Loading