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

New resource type: azurerm_redis_linked_server #8026

Merged
Show file tree
Hide file tree
Changes from 1 commit
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
5 changes: 5 additions & 0 deletions azurerm/internal/services/redis/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ type Client struct {
Client *redis.Client
FirewallRulesClient *redis.FirewallRulesClient
PatchSchedulesClient *redis.PatchSchedulesClient
LinkedServerClient *redis.LinkedServerClient
}

func NewClient(o *common.ClientOptions) *Client {
Expand All @@ -21,9 +22,13 @@ func NewClient(o *common.ClientOptions) *Client {
PatchSchedulesClient := redis.NewPatchSchedulesClientWithBaseURI(o.ResourceManagerEndpoint, o.SubscriptionId)
o.ConfigureClient(&PatchSchedulesClient.Client, o.ResourceManagerAuthorizer)

LinkedServerClient := redis.NewLinkedServerClientWithBaseURI(o.ResourceManagerEndpoint, o.SubscriptionId)
o.ConfigureClient(&LinkedServerClient.Client, o.ResourceManagerAuthorizer)

return &Client{
Client: &client,
FirewallRulesClient: &FirewallRulesClient,
PatchSchedulesClient: &PatchSchedulesClient,
LinkedServerClient: &LinkedServerClient,
}
}
1 change: 1 addition & 0 deletions azurerm/internal/services/redis/registration.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ func (r Registration) SupportedResources() map[string]*schema.Resource {
return map[string]*schema.Resource{
"azurerm_redis_cache": resourceArmRedisCache(),
"azurerm_redis_firewall_rule": resourceArmRedisFirewallRule(),
"azurerm_redis_linked_server": resourceArmRedisLinkedServer(),
}
}
236 changes: 236 additions & 0 deletions azurerm/internal/services/redis/resource_arm_redis_linked_server.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
package redis

import (
"context"
"fmt"
"log"
"time"

"github.com/Azure/azure-sdk-for-go/services/redis/mgmt/2018-03-01/redis"
"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/azure"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/suppress"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/tf"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/clients"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/features"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/timeouts"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/utils"
)

func resourceArmRedisLinkedServer() *schema.Resource {
return &schema.Resource{
Create: resourceArmRedisLinkedServerCreate,
Read: resourceArmRedisLinkedServerRead,
Delete: resourceArmRedisLinkedServerDelete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
},

Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(30 * time.Minute),
Read: schema.DefaultTimeout(5 * time.Minute),
Update: schema.DefaultTimeout(30 * time.Minute),
Delete: schema.DefaultTimeout(30 * time.Minute),
},

Schema: map[string]*schema.Schema{
"name": {
pearcec marked this conversation as resolved.
Show resolved Hide resolved
Type: schema.TypeString,
Computed: true,
},

"redis_cache_name": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.StringIsNotEmpty,
},

"linked_redis_cache_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: azure.ValidateResourceID,
},

"linked_redis_cache_location": azure.SchemaLocation(),

"resource_group_name": azure.SchemaResourceGroupName(),

"server_role": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{
string(redis.ReplicationRolePrimary),
string(redis.ReplicationRoleSecondary),
}, true),
DiffSuppressFunc: suppress.CaseDifference,
},
},
}
}

func resourceArmRedisLinkedServerCreate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Redis.LinkedServerClient
ctx, cancel := timeouts.ForCreate(meta.(*clients.Client).StopContext, d)
defer cancel()
log.Printf("[INFO] preparing arguments for AzureRM Redis Linked Server creation.")

redisCacheName := d.Get("redis_cache_name").(string)
linkedRedisCacheId := d.Get("linked_redis_cache_id").(string)
linkedRedisCacheLocation := d.Get("linked_redis_cache_location").(string)
resourceGroup := d.Get("resource_group_name").(string)
serverRole := redis.ReplicationRole(d.Get("server_role").(string))

// The name needs to match the linked_redis_cache_id
id, err := azure.ParseAzureResourceID(linkedRedisCacheId)
if err != nil {
return err
}
name := id.Path["Redis"]

if features.ShouldResourcesBeImported() && d.IsNewResource() {
existing, err := client.Get(ctx, resourceGroup, redisCacheName, name)
if err != nil {
if !utils.ResponseWasNotFound(existing.Response) {
return fmt.Errorf("Error checking for presence of existing Redis Linked Server %q (cache %q / resource group %q) ID", name, redisCacheName, resourceGroup)
}
}

if existing.ID != nil && *existing.ID != "" {
return tf.ImportAsExistsError("azurerm_redis_linked_server", *existing.ID)
}
}

parameters := redis.LinkedServerCreateParameters{
LinkedServerCreateProperties: &redis.LinkedServerCreateProperties{
LinkedRedisCacheID: utils.String(linkedRedisCacheId),
LinkedRedisCacheLocation: utils.String(linkedRedisCacheLocation),
ServerRole: serverRole,
},
}

return resource.Retry(d.Timeout(schema.TimeoutCreate), func() *resource.RetryError {
future, err := client.Create(ctx, resourceGroup, redisCacheName, name, parameters)
if err != nil {
return resource.NonRetryableError(fmt.Errorf("Error issuing for the create of Redis Linked Server %s (resource group %s): %v", name, resourceGroup, err))
}

if err = future.WaitForCompletionRef(ctx, client.Client); err != nil {
return resource.NonRetryableError(fmt.Errorf("Error waiting for the create of Redis Linked Server %s (resource group %s): %v", name, resourceGroup, err))
}

read, err := client.Get(ctx, resourceGroup, redisCacheName, name)
if err != nil {
return resource.RetryableError(fmt.Errorf("Expected instance to be created but was in non existent state, retrying"))
}
if read.ID == nil {
return resource.NonRetryableError(fmt.Errorf("Cannot read Redis Linked Server %q (cache %q / resource group %q) ID", name, redisCacheName, resourceGroup))
}

log.Printf("[DEBUG] Waiting for Redis Linked Server (%s) to become available", d.Get("name"))
stateConf := &resource.StateChangeConf{
Pending: []string{"Linking", "Updating", "Creating", "Syncing"},
Target: []string{"Succeeded"},
Refresh: redisLinkedServerStateRefreshFunc(ctx, client, resourceGroup, redisCacheName, name),
MinTimeout: 15 * time.Second,
Timeout: d.Timeout(schema.TimeoutCreate),
}

if _, err = stateConf.WaitForState(); err != nil {
return resource.NonRetryableError(fmt.Errorf("Error waiting for Redis Linked Server (%s) to become available: %s", d.Get("name"), err))
}

d.SetId(*read.ID)

return resource.NonRetryableError(resourceArmRedisLinkedServerRead(d, meta))
})
}

func resourceArmRedisLinkedServerRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Redis.LinkedServerClient
ctx, cancel := timeouts.ForRead(meta.(*clients.Client).StopContext, d)
defer cancel()

id, err := azure.ParseAzureResourceID(d.Id())
if err != nil {
return err
}
resourceGroup := id.ResourceGroup
redisCacheName := id.Path["Redis"]
name := id.Path["linkedServers"]

resp, err := client.Get(ctx, resourceGroup, redisCacheName, name)

if err != nil {
if utils.ResponseWasNotFound(resp.Response) {
log.Printf("[DEBUG] Redis Linked Server %q was not found in Cache %q / Resource Group %q - removing from state", name, redisCacheName, resourceGroup)
d.SetId("")
return nil
}

return fmt.Errorf("Error making Read request on Azure Redis Linked Server %q: %+v", name, err)
}

d.Set("name", name)
d.Set("redis_cache_name", redisCacheName)
d.Set("resource_group_name", resourceGroup)
if props := resp.LinkedServerProperties; props != nil {
d.Set("linked_redis_cache_id", props.LinkedRedisCacheID)
d.Set("linked_redis_cache_location", props.LinkedRedisCacheLocation)
d.Set("server_role", string(props.ServerRole))
}

return nil
}

func resourceArmRedisLinkedServerDelete(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Redis.LinkedServerClient
ctx, cancel := timeouts.ForDelete(meta.(*clients.Client).StopContext, d)
defer cancel()

id, err := azure.ParseAzureResourceID(d.Id())
if err != nil {
return err
}
resourceGroup := id.ResourceGroup
redisCacheName := id.Path["Redis"]
name := id.Path["linkedServers"]

resp, err := client.Delete(ctx, resourceGroup, redisCacheName, name)
if err != nil {
if !utils.ResponseWasNotFound(resp) {
return fmt.Errorf("Error issuing AzureRM delete request of Redis Linked Server %q (cache %q / resource group %q): %+v", name, redisCacheName, resourceGroup, err)
}
}

// No LinkedServerDeleteFuture
// https://github.com/Azure/azure-sdk-for-go/issues/12159

for {
time.Sleep(1 * time.Minute)
resp, err := client.Get(ctx, resourceGroup, redisCacheName, name)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use a wait for state function like above as this could never finish

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes definitely. I was confused. I misread a comment in Slack and thought I needed futures for this. I reread the comment. Now I understand. This would be a better solution. Testing it now.


if err != nil {
if utils.ResponseWasNotFound(resp.Response) {
// Secondary server needs another minute
time.Sleep(1 * time.Minute)
return nil
}
}
}
}

func redisLinkedServerStateRefreshFunc(ctx context.Context, client *redis.LinkedServerClient, resourceGroupName string, redisCacheName string, name string) resource.StateRefreshFunc {
return func() (interface{}, string, error) {
res, err := client.Get(ctx, resourceGroupName, redisCacheName, name)
if err != nil {
return nil, "", fmt.Errorf("Error issuing read request in redisStateRefreshFunc to Azure ARM for Redis Linked Server Instance '%s' (RG: '%s'): %s", name, resourceGroupName, err)
}

return res, *res.LinkedServerProperties.ProvisioningState, nil
}
}
Loading