Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for configuring the Transit cache #548

Merged
merged 3 commits into from
Oct 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions vault/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,10 @@ var (
Resource: transitSecretBackendKeyResource(),
PathInventory: []string{"/transit/keys/{name}"},
},
"vault_transit_secret_cache_config": {
Resource: transitSecretBackendCacheConfig(),
PathInventory: []string{"/transit/cache-config"},
},
}
)

Expand Down
91 changes: 91 additions & 0 deletions vault/resource_transit_cache_config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
package vault

import (
"fmt"
"log"
"strings"

"github.com/hashicorp/terraform/helper/schema"
"github.com/hashicorp/vault/api"
)

func transitSecretBackendCacheConfig() *schema.Resource {
return &schema.Resource{
Create: transitSecretBackendCacheConfigUpdate,
Update: transitSecretBackendCacheConfigUpdate,
Read: transitSecretBackendCacheConfigRead,
Delete: transitSecretBackendCacheConfigDelete,

Schema: map[string]*schema.Schema{
"backend": {
Type: schema.TypeString,
Required: true,
Description: "The Transit secret backend the resource belongs to.",
ForceNew: true,
StateFunc: func(v interface{}) string {
return strings.Trim(v.(string), "/")
},
},
"size": {
Type: schema.TypeInt,
Description: "Number of cache entries. A size of 0 mean unlimited.",
Required: true,
},
},
}
}

func transitSecretBackendCacheConfigUpdate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*api.Client)
size := d.Get("size").(int)

backend := d.Get("backend").(string) + "/cache-config"

log.Printf("[DEBUG] Setting transit cache size to: %d", size)

data := map[string]interface{}{
"size": size,
}
_, err := client.Logical().Write(backend, data)
if err != nil {
return fmt.Errorf("error writing transit cache-config: %v", err)
}
log.Printf("[DEBUG] Set transit cache size")
d.SetId(backend)

data = map[string]interface{}{
"mounts": []string{d.Get("backend").(string) + "/"},
}
_, err = client.Logical().Write("sys/plugins/reload/backend", data)
if err != nil {
return fmt.Errorf("error reloading transit plugin: %v", err)
}

return transitSecretBackendCacheConfigRead(d, meta)
}

func transitSecretBackendCacheConfigRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*api.Client)

backend := d.Id()

secret, err := client.Logical().Read(backend)
if err != nil {
return fmt.Errorf("error reading transit cache-config: %v", err)
}

if secret == nil {
log.Printf("[WARN] transit cache-config not found, removing from state")
d.SetId("")
return nil
}

d.Set("size", secret.Data["size"])

return nil
}

func transitSecretBackendCacheConfigDelete(d *schema.ResourceData, meta interface{}) error {
// Deleting the cache configuration is not supported in the Vault API
return nil
kalafut marked this conversation as resolved.
Show resolved Hide resolved
}
123 changes: 123 additions & 0 deletions vault/resource_transit_cache_config_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
package vault

import (
"encoding/json"
"errors"
"fmt"
"strconv"
"testing"

"github.com/hashicorp/terraform/helper/acctest"
"github.com/hashicorp/terraform/helper/resource"
"github.com/hashicorp/terraform/terraform"
"github.com/hashicorp/vault/api"
)

func TestAccTransitCacheConfig(t *testing.T) {
name := acctest.RandomWithPrefix("test-cache-config")

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testProviders,
CheckDestroy: testAccTransitCacheConfigCheckDestroyed,
Steps: []resource.TestStep{
{
Config: testAccTransitCacheConfig(name, 600),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("vault_transit_secret_cache_config.cfg", "size", "600"),
testAccTransitCacheConfigCheckApi(600),
),
},
{
Config: testAccTransitCacheConfig(name, 700),
Check: resource.TestCheckResourceAttr("vault_transit_secret_cache_config.cfg", "size", "700"),
},
{
Config: testAccTransitCacheConfig(name, 0),
Check: resource.TestCheckResourceAttr("vault_transit_secret_cache_config.cfg", "size", "0"),
},
{
Config: testAccTransitCacheConfigRemoved(name),
Check: testAccTransitCacheConfigCheckRemoved,
},
},
})
}

func testAccTransitCacheConfigCheckDestroyed(s *terraform.State) error {
client := testProvider.Meta().(*api.Client)

for _, rs := range s.RootModule().Resources {
if rs.Type != "vault_transit_secret_cache_config" {
continue
}
secret, err := client.Logical().Read(rs.Primary.ID)
if err != nil {
return fmt.Errorf("Error checking for transit cache config %q: %s", rs.Primary.ID, err)
}
if secret != nil {
return fmt.Errorf("Transit cache config %q still exists", rs.Primary.ID)
}
}
return nil
}

func testAccTransitCacheConfigCheckApi(size int) resource.TestCheckFunc {
return func(s *terraform.State) error {
resourceState := s.Modules[0].Resources["vault_transit_secret_cache_config.cfg"]
if resourceState == nil {
return fmt.Errorf("resource not found in state")
}

instanceState := resourceState.Primary
if instanceState == nil {
return fmt.Errorf("instance not found in state")
}

id := instanceState.ID

client := testProvider.Meta().(*api.Client)
resp, err := client.Logical().Read(id)
if err != nil {
return err
}

sizeStr := strconv.Itoa(size)
act := resp.Data["size"].(json.Number).String()
if act != sizeStr {
return fmt.Errorf("expected side %q, got %q", sizeStr, act)
}

return nil
}
}

func testAccTransitCacheConfigCheckRemoved(s *terraform.State) error {
resourceState := s.Modules[0].Resources["vault_transit_secret_cache_config.cfg"]
if resourceState != nil {
return errors.New("transit cache config still present in state")
}

return nil
}

func testAccTransitCacheConfig(entityName string, size int) string {
return fmt.Sprintf(`
resource "vault_mount" "transit" {
path = "%s"
type = "transit"
}

resource "vault_transit_secret_cache_config" "cfg" {
backend = "${vault_mount.transit.path}"
size = %d
}`, entityName, size)
}

func testAccTransitCacheConfigRemoved(entityName string) string {
return fmt.Sprintf(`
resource "vault_mount" "transit" {
path = "%s"
type = "transit"
}`, entityName)
}
41 changes: 41 additions & 0 deletions website/docs/r/transit_secret_backend_cache_config.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: "vault"
page_title: "Vault: vault_transit_secret_backend_cache_config resource"
sidebar_current: "docs-vault-resource-transit-secret-backend-cache-config"
description: |-
Configure the cache for the Transit Secret Backend in Vault.
---

# vault\_transit\_secret\_backend\_cache\_config

Configure the cache for the Transit Secret Backend in Vault.

## Example Usage

```hcl
resource "vault_mount" "transit" {
path = "transit"
type = "transit"
description = "Example description"
default_lease_ttl_seconds = 3600
max_lease_ttl_seconds = 86400
}

resource "vault_transit_secret_backend_cache_config" "cfg" {
backend = "${vault_mount.transit.path}"
size = 500
}

```
## Argument Reference

The following arguments are supported:

* `backend` - (Required) The path the transit secret backend is mounted at, with no leading or trailing `/`s.
kalafut marked this conversation as resolved.
Show resolved Hide resolved

* `size` - (Required) The number of cache entries. 0 means unlimited.


## Attributes Reference

No additional attributes are exported by this resource.