[CLOUDGA-31264] Add use_roles to backup resource and backup schedules (#187)

Co-authored-by: pranavbansal <Pranav Bansal>

Add optional use_roles to back up global YSQL roles.

- ybm_backup: add use_roles attribute (optional, computed). Set on BackupSpec in Create; read from API in Read (default false when omitted).
- ybm_cluster backup_schedules: add use_roles to block. Set on ScheduleSpecV2 in editBackupScheduleV2; read in readBackupScheduleInfoV2 (default false when omitted).
- models: add UseRoles to Backup and BackupScheduleInfo.
- docs: document use_roles for backup and cluster resources.

Author: pranbansal02

docs/resources/backup.md

@@ -35,6 +35,7 @@ resource "ybm_backup" "example_backup" {
 - `backup_id` (String) The ID of the backup. Created automatically when the backup is created. Used to get a specific backup.
 - `most_recent` (Boolean) Set to true to fetch the most recent backup.
 - `timestamp` (String) The timestamp of the backup to be fetched
+- `use_roles` (Boolean) Backup global YSQL roles. Defaults to false.
 
 ### Read-Only
 

docs/resources/cluster.md

@@ -1193,6 +1193,7 @@ Optional:
 - `schedule_id` (String) The ID of the backup schedule. Created automatically when the backup schedule is created. Used to get a specific backup schedule.
 - `state` (String) The state of the backup schedule. Used to pause or resume the backup schedule. Valid values are ACTIVE or PAUSED.
 - `time_interval_in_days` (Number) The time interval in days for the backup schedule.
+- `use_roles` (Boolean) Backup global YSQL roles in scheduled backups. Defaults to false.
 
 
 <a id="nestedatt--cmk_spec"></a>

managed/models.go

@@ -94,6 +94,7 @@ type BackupScheduleInfo struct {
 	CronExpression            types.String `tfsdk:"cron_expression"`
 	TimeIntervalInDays        types.Int64  `tfsdk:"time_interval_in_days"`
 	IncrementalIntervalInMins types.Int64  `tfsdk:"incremental_interval_in_mins"`
+	UseRoles                  types.Bool   `tfsdk:"use_roles"`
 }
 type RegionInfo struct {
 	Region                     types.String `tfsdk:"region"`
@@ -217,6 +218,7 @@ type Backup struct {
 	RetentionPeriodInDays types.Int64  `tfsdk:"retention_period_in_days"`
 	MostRecent            types.Bool   `tfsdk:"most_recent"`
 	Timestamp             types.String `tfsdk:"timestamp"`
+	UseRoles              types.Bool   `tfsdk:"use_roles"`
 }
 
 type VPC struct {

managed/resource_backup.go

@@ -67,6 +67,12 @@ func (r resourceBackupType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Dia
 				Type:        types.StringType,
 				Optional:    true,
 			},
+			"use_roles": {
+				Description: "Backup global YSQL roles. Defaults to false.",
+				Type:        types.BoolType,
+				Optional:    true,
+				Computed:    true,
+			},
 		},
 	}, nil
 }
@@ -92,6 +98,7 @@ func getBackupPlan(ctx context.Context, plan tfsdk.Plan, backup *Backup) diag.Di
 	diags.Append(plan.GetAttribute(ctx, path.Root("backup_id"), &backup.BackupID)...)
 	diags.Append(plan.GetAttribute(ctx, path.Root("backup_description"), &backup.BackupDescription)...)
 	diags.Append(plan.GetAttribute(ctx, path.Root("retention_period_in_days"), &backup.RetentionPeriodInDays)...)
+	diags.Append(plan.GetAttribute(ctx, path.Root("use_roles"), &backup.UseRoles)...)
 
 	return diags
 }
@@ -147,6 +154,10 @@ func (r resourceBackup) Create(ctx context.Context, req tfsdk.CreateResourceRequ
 	backupSpec.SetDescription(backupDescription)
 	backupSpec.RetentionPeriodInDays = &backupRetentionPeriodInDays
 
+	if !plan.UseRoles.IsNull() && !plan.UseRoles.IsUnknown() {
+		backupSpec.SetUseRoles(plan.UseRoles.Value)
+	}
+
 	backupResp, response, err := apiClient.BackupApi.CreateBackup(context.Background(), accountId, projectId).BackupSpec(backupSpec).Execute()
 	if err != nil {
 		errMsg := getErrorMessage(response, err)
@@ -207,6 +218,14 @@ func resourceBackupRead(accountId string, projectId string, backupId string, api
 	backup.RetentionPeriodInDays.Value = int64(*backupResp.Data.Spec.RetentionPeriodInDays)
 	backup.MostRecent.Null = true
 	backup.Timestamp.Null = true
+
+	// Read use_roles from response (defaults to false if not present)
+	if backupResp.Data.Spec.HasUseRoles() {
+		backup.UseRoles.Value = backupResp.Data.Spec.GetUseRoles()
+	} else {
+		backup.UseRoles.Value = false
+	}
+
 	return backup, true, ""
 }
 

managed/resource_cluster.go

@@ -549,6 +549,12 @@ func (r resourceClusterType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Di
 					Optional:    true,
 					Validators:  []tfsdk.AttributeValidator{int64validator.AtLeast(60)},
 				},
+				"use_roles": {
+					Description: "Backup global YSQL roles in scheduled backups. Defaults to false.",
+					Type:        types.BoolType,
+					Optional:    true,
+					Computed:    true,
+				},
 			}),
 		},
 		"cmk_spec": {
@@ -976,6 +982,10 @@ func editBackupScheduleV2(ctx context.Context, backupScheduleStruct BackupSchedu
 			return errors.New("unable to create custom backup schedule. You can't pass both the cron expression and time interval in days")
 		}
 
+		if !backupScheduleStruct.UseRoles.IsNull() && !backupScheduleStruct.UseRoles.IsUnknown() {
+			backupScheduleSpec.SetUseRoles(backupScheduleStruct.UseRoles.Value)
+		}
+
 		_, res, err := apiClient.BackupApi.ModifyBackupScheduleV2(ctx, accountId, projectId, clusterId, scheduleId).ScheduleSpecV2(backupScheduleSpec).Execute()
 		if err != nil {
 			errMsg := getErrorMessage(res, err)
@@ -2202,6 +2212,12 @@ func readBackupScheduleInfoV2(ctx context.Context, apiClient *openapiclient.APIC
 	if backupScheduleStruct.IncrementalIntervalInMins.Value == 0 {
 		backupScheduleStruct.IncrementalIntervalInMins.Null = true
 	}
+	// Read use_roles from response (defaults to false if not present)
+	if spec.HasUseRoles() {
+		backupScheduleStruct.UseRoles = types.Bool{Value: spec.GetUseRoles()}
+	} else {
+		backupScheduleStruct.UseRoles = types.Bool{Value: false}
+	}
 	backupScheduleInfo[0] = backupScheduleStruct
 
 	return backupScheduleInfo, nil, nil