Skip to content

Commit

Permalink
Add default for logs_destination to remove Computed
Browse files Browse the repository at this point in the history 
Add helper function for finding `log_analytics_workspace_id` from `customerID`
Add helper function for getting Workspace (primary) shared key
Fixup customiseDiff for new/existing resources changes to `log_analytics_workspace_id` and `logs_destination`
Remove ignore for `log_analytics_workspace_id` on data.ImportStep for all tests as this is now discovered correctly
  • Loading branch information
@jackofallops
jackofallops committed Jan 28, 2025
1 parent 5b1079b commit 38c68c8
Show file tree
Hide file tree
Showing 2 changed files with 198 additions and 77 deletions.
179 changes: 108 additions & 71 deletions internal/services/containerapps/container_app_environment_resource.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package containerapps
import (
"context"
"fmt"
"strings"
"time"

"github.com/hashicorp/go-azure-helpers/lang/pointer"
Expand All @@ -27,6 +28,7 @@ import (
const (
LogsDestinationLogAnalytics string = "log-analytics"
LogsDestinationAzureMonitor string = "azure-monitor"
LogsDestinationAzureNone string = ""
)

type ContainerAppEnvironmentResource struct{}
Expand Down Expand Up @@ -104,7 +106,7 @@ func (r ContainerAppEnvironmentResource) Arguments() map[string]*pluginsdk.Schem
"logs_destination": {
Type: pluginsdk.TypeString,
Optional: true,
Computed: true,
Default: LogsDestinationAzureNone,
ValidateFunc: validation.StringInSlice([]string{
LogsDestinationLogAnalytics,
LogsDestinationAzureMonitor,
Expand Down Expand Up @@ -215,7 +217,6 @@ func (r ContainerAppEnvironmentResource) Create() sdk.ResourceFunc {
Timeout: 30 * time.Minute,
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
client := metadata.Client.ContainerApps.ManagedEnvironmentClient
logAnalyticsClient := metadata.Client.LogAnalytics.SharedKeyWorkspacesClient
subscriptionId := metadata.Client.Account.SubscriptionId

var containerAppEnvironment ContainerAppEnvironmentModel
Expand Down Expand Up @@ -273,34 +274,14 @@ func (r ContainerAppEnvironmentResource) Create() sdk.ResourceFunc {
return fmt.Errorf("cannot set `log_analytics_workspace_id` when `logs_destination` is %s", LogsDestinationAzureMonitor)
}

logAnalyticsId, err := workspaces.ParseWorkspaceID(containerAppEnvironment.LogAnalyticsWorkspaceId)
customerId, sharedKey, err := getSharedKeyForWorkspace(ctx, metadata, containerAppEnvironment.LogAnalyticsWorkspaceId)
if err != nil {
return err
return fmt.Errorf("retrieving access keys to Log Analytics Workspace for %s: %+v", id, err)
}

workspace, err := logAnalyticsClient.Get(ctx, *logAnalyticsId)
if err != nil {
return fmt.Errorf("retrieving %s for %s: %+v", logAnalyticsId, id, err)
}

if workspace.Model == nil || workspace.Model.Properties == nil {
return fmt.Errorf("reading customer ID from %s", logAnalyticsId)
}

if workspace.Model.Properties.CustomerId == nil {
return fmt.Errorf("reading customer ID from %s, `customer_id` is nil", logAnalyticsId)
}

keys, err := logAnalyticsClient.SharedKeysGetSharedKeys(ctx, *logAnalyticsId)
if err != nil {
return fmt.Errorf("retrieving access keys to %s for %s: %+v", logAnalyticsId, id, err)
}
if keys.Model.PrimarySharedKey == nil {
return fmt.Errorf("reading shared key for %s in %s", logAnalyticsId, id)
}
managedEnvironment.Properties.AppLogsConfiguration.LogAnalyticsConfiguration = &managedenvironments.LogAnalyticsConfiguration{
CustomerId: workspace.Model.Properties.CustomerId,
SharedKey: keys.Model.PrimarySharedKey,
CustomerId: customerId,
SharedKey: sharedKey,
}
}

Expand All @@ -323,7 +304,7 @@ func (r ContainerAppEnvironmentResource) Create() sdk.ResourceFunc {

func (r ContainerAppEnvironmentResource) Read() sdk.ResourceFunc {
return sdk.ResourceFunc{
Timeout: 35 * time.Minute,
Timeout: 5 * time.Minute,
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
client := metadata.Client.ContainerApps.ManagedEnvironmentClient
id, err := managedenvironments.ParseManagedEnvironmentID(metadata.ResourceData.Id())
Expand Down Expand Up @@ -360,6 +341,14 @@ func (r ContainerAppEnvironmentResource) Read() sdk.ResourceFunc {

if appLogsConfig := props.AppLogsConfiguration; appLogsConfig != nil {
state.LogsDestination = pointer.From(appLogsConfig.Destination)
if appLogsConfig.LogAnalyticsConfiguration != nil && appLogsConfig.LogAnalyticsConfiguration.CustomerId != nil {
workspaceId, err := findWorkspaceResourceIDFromCustomerID(ctx, metadata, *appLogsConfig.LogAnalyticsConfiguration.CustomerId)
if err != nil {
return fmt.Errorf("retrieving Log Analytics Workspace ID for %s: %+v", id, err)
}

state.LogAnalyticsWorkspaceId = workspaceId.ID()
}
}

state.CustomDomainVerificationId = pointer.From(props.CustomDomainConfiguration.CustomDomainVerificationId)
Expand All @@ -377,12 +366,7 @@ func (r ContainerAppEnvironmentResource) Read() sdk.ResourceFunc {
state.DaprApplicationInsightsConnectionString = v
}

// Reading in log_analytics_workspace_id is not possible, so reading from config. Import will need to ignore_changes unfortunately
if v := metadata.ResourceData.Get("log_analytics_workspace_id").(string); v != "" {
state.LogAnalyticsWorkspaceId = v
}

if err := metadata.Encode(&state); err != nil {
if err = metadata.Encode(&state); err != nil {
return fmt.Errorf("encoding: %+v", err)
}

Expand Down Expand Up @@ -414,7 +398,6 @@ func (r ContainerAppEnvironmentResource) Update() sdk.ResourceFunc {
return sdk.ResourceFunc{
Timeout: 30 * time.Minute,
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
logAnalyticsClient := metadata.Client.LogAnalytics.SharedKeyWorkspacesClient
client := metadata.Client.ContainerApps.ManagedEnvironmentClient
id, err := managedenvironments.ParseManagedEnvironmentID(metadata.ResourceData.Id())
if err != nil {
Expand Down Expand Up @@ -444,41 +427,29 @@ func (r ContainerAppEnvironmentResource) Update() sdk.ResourceFunc {
existing.Model.Properties.PeerTrafficConfiguration.Encryption.Enabled = pointer.To(state.Mtls)
}

// (@jackofallops) This is not updatable and needs to be removed since the read does not return the sensitive Key field.
// Whilst not ideal, this means we don't need to try and retrieve it again just to send a no-op.
existing.Model.Properties.AppLogsConfiguration = nil
if metadata.ResourceData.Get("log_analytics_workspace_id") != "" {
logAnalyticsId, err := workspaces.ParseWorkspaceID(metadata.ResourceData.Get("log_analytics_workspace_id").(string))
if err != nil {
return err
}

workspace, err := logAnalyticsClient.Get(ctx, *logAnalyticsId)
if err != nil {
return fmt.Errorf("retrieving %s for %s: %+v", logAnalyticsId, id, err)
}

if workspace.Model == nil || workspace.Model.Properties == nil {
return fmt.Errorf("reading customer ID from %s", logAnalyticsId)
}
if metadata.ResourceData.HasChanges("logs_destination", "log_analytics_workspace_id") {
switch state.LogsDestination {
case LogsDestinationAzureMonitor:
existing.Model.Properties.AppLogsConfiguration = &managedenvironments.AppLogsConfiguration{
Destination: pointer.To(LogsDestinationAzureMonitor),
LogAnalyticsConfiguration: nil,
}
case LogsDestinationLogAnalytics:
customerId, sharedKey, err := getSharedKeyForWorkspace(ctx, metadata, state.LogAnalyticsWorkspaceId)
if err != nil {
return fmt.Errorf("retrieving access keys to Log Analytics Workspace for %s: %+v", id, err)
}

if workspace.Model.Properties.CustomerId == nil {
return fmt.Errorf("reading customer ID from %s, `customer_id` is nil", logAnalyticsId)
}
existing.Model.Properties.AppLogsConfiguration = &managedenvironments.AppLogsConfiguration{
Destination: pointer.To(LogsDestinationLogAnalytics),
LogAnalyticsConfiguration: &managedenvironments.LogAnalyticsConfiguration{
CustomerId: customerId,
SharedKey: sharedKey,
},
}

keys, err := logAnalyticsClient.SharedKeysGetSharedKeys(ctx, *logAnalyticsId)
if err != nil {
return fmt.Errorf("retrieving access keys to %s for %s: %+v", logAnalyticsId, id, err)
}
if keys.Model.PrimarySharedKey == nil {
return fmt.Errorf("reading shared key for %s in %s", logAnalyticsId, id)
}
existing.Model.Properties.AppLogsConfiguration = &managedenvironments.AppLogsConfiguration{
Destination: pointer.To("log-analytics"),
LogAnalyticsConfiguration: &managedenvironments.LogAnalyticsConfiguration{
CustomerId: workspace.Model.Properties.CustomerId,
SharedKey: keys.Model.PrimarySharedKey,
},
default:
existing.Model.Properties.AppLogsConfiguration = nil
}
}

Expand Down Expand Up @@ -531,18 +502,19 @@ func (r ContainerAppEnvironmentResource) CustomizeDiff() sdk.ResourceFunc {
}
}

// Note: this only protects at plan time against updates - Create with the wrong configuration will fail with an error on Apply
if metadata.ResourceDiff.HasChanges("logs_destination", "log_analytics_workspace_id") {
logsDestination := metadata.ResourceDiff.Get("logs_destination").(string)
logAnalyticsWorkspaceID := metadata.ResourceDiff.Get("log_analytics_workspace_id").(string)
logAnalyticsWorkspaceIDIsNull := metadata.ResourceDiff.GetRawConfig().AsValueMap()["log_analytics_workspace_id"].IsNull()

switch logsDestination {
case LogsDestinationLogAnalytics:
if logAnalyticsWorkspaceID == "" {
if logAnalyticsWorkspaceIDIsNull {
return fmt.Errorf("`log_analytics_workspace_id` must be set when `logs_destination` is set to `log-analytics`")
}

default:
if logAnalyticsWorkspaceID != "" {
case LogsDestinationAzureMonitor, LogsDestinationAzureNone:
if logAnalyticsWorkspaceID != "" || !logAnalyticsWorkspaceIDIsNull {
return fmt.Errorf("`log_analytics_workspace_id` can only be set when `logs_destination` is set to `log-analytics`")
}
}
Expand All @@ -552,3 +524,68 @@ func (r ContainerAppEnvironmentResource) CustomizeDiff() sdk.ResourceFunc {
},
}
}

func findWorkspaceResourceIDFromCustomerID(ctx context.Context, meta sdk.ResourceMetaData, customerID string) (*workspaces.WorkspaceId, error) {
client := meta.Client.LogAnalytics.WorkspaceClient

subscriptionId := commonids.NewSubscriptionID(meta.Client.Account.SubscriptionId)

result := &workspaces.WorkspaceId{}

list, err := client.List(ctx, subscriptionId)
if err != nil {
return nil, err
}

model := list.Model
if model == nil {
return nil, fmt.Errorf("could not resolve Log Analytics Workspace ID for %s, list model was nil", customerID)
}

if model.Value == nil || len(*model.Value) == 0 {
return nil, fmt.Errorf("could not resolve Log Analytics Workspace ID for %s, no Log Analytics Workspaces found in %s", customerID, subscriptionId)
}

for _, v := range *list.Model.Value {
if v.Properties != nil && v.Properties.CustomerId != nil && strings.EqualFold(*v.Properties.CustomerId, customerID) {
result, err = workspaces.ParseWorkspaceIDInsensitively(pointer.From(v.Id))
if err != nil {
return nil, err
}
}
}

return result, nil
}

func getSharedKeyForWorkspace(ctx context.Context, meta sdk.ResourceMetaData, workspaceID string) (*string, *string, error) {
logAnalyticsClient := meta.Client.LogAnalytics.SharedKeyWorkspacesClient

logAnalyticsId, err := workspaces.ParseWorkspaceID(workspaceID)
if err != nil {
return nil, nil, err
}

workspace, err := logAnalyticsClient.Get(ctx, *logAnalyticsId)
if err != nil {
return nil, nil, fmt.Errorf("retrieving %s: %+v", logAnalyticsId, err)
}

if workspace.Model == nil || workspace.Model.Properties == nil {
return nil, nil, fmt.Errorf("reading customer ID from %s", logAnalyticsId)
}

if workspace.Model.Properties.CustomerId == nil {
return nil, nil, fmt.Errorf("reading customer ID from %s, `customer_id` is nil", logAnalyticsId)
}

keys, err := logAnalyticsClient.SharedKeysGetSharedKeys(ctx, *logAnalyticsId)
if err != nil {
return nil, nil, fmt.Errorf("retrieving access keys to %s: %+v", logAnalyticsId, err)
}
if keys.Model.PrimarySharedKey == nil {
return nil, nil, fmt.Errorf("reading shared key for %s", logAnalyticsId)
}

return workspace.Model.Properties.CustomerId, keys.Model.PrimarySharedKey, nil
}
Loading

0 comments on commit 38c68c8

Please sign in to comment.