Skip to content

chore(sqlserver): deprecate v2 api fields #1672

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.

Sign up for GitHub

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

Merged
marceljk merged 2 commits into from
Aug 7, 2026
Merged

chore(sqlserver): deprecate v2 api fields #1672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35b81f9
chore(sqlserver): deprecate v2 api fields
marceljk Aug 7, 2026
d490109
add missing dot
marceljk Aug 7, 2026
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
10 changes: 5 additions & 5 deletions docs/data-sources/sqlserverflex_instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ data "stackit_sqlserverflex_instance" "example" {

### Read-Only

- `acl` (List of String) The Access Control List (ACL) for the SQLServer Flex instance.
- `acl` (List of String, Deprecated) The Access Control List (ACL) for the SQLServer Flex instance.
- `backup_schedule` (String) The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
- `edition` (String) Edition of the MSSQL server instance.
- `encryption` (Attributes) Parameter to define which key to use for storage encryption. (see [below for nested schema](#nestedatt--encryption))
- `flavor` (Attributes) (see [below for nested schema](#nestedatt--flavor))
- `flavor` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--flavor))
- `flavor_id` (String) The flavor ID of the SQLServer Flex instance.
- `id` (String) Terraform's internal data source. ID. It is structured as "`project_id`,`region`,`instance_id`".
- `name` (String) Instance name.
- `options` (Attributes) Custom parameters for the SQLServer Flex instance. (see [below for nested schema](#nestedatt--options))
- `options` (Attributes, Deprecated) Custom parameters for the SQLServer Flex instance. (see [below for nested schema](#nestedatt--options))
- `replicas` (Number)
- `retention_days` (Number) The days (30 to 90) for how long the backup files should be stored before cleaned up.
- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))
Expand Down Expand Up @@ -89,8 +89,8 @@ Read-Only:

Read-Only:

- `edition` (String)
- `retention_days` (Number)
- `edition` (String, Deprecated)
- `retention_days` (Number, Deprecated)


<a id="nestedatt--storage"></a>
Expand Down
10 changes: 2 additions & 8 deletions docs/resources/sqlserverflex_instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,7 @@ resource "stackit_sqlserverflex_instance" "example" {
- `backup_schedule` (String) The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *") Will be required in the future. Set a value to prevent breaking changes.
- `encryption` (Attributes) Parameter to define which key to use for storage encryption. (see [below for nested schema](#nestedatt--encryption))
- `flavor` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--flavor))
- `flavor_id` (String) The flavor ID of the SQLServer Flex instance. Can only be set when `flavor` and `replicas` are not set. You can list available storage classes using the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli):
```bash
stackit curl https://mssql-flex-service.api.stackit.cloud/v3/projects/{project_id}/regions/{region}/flavors\?size=100
```
- `flavor_id` (String) The flavor ID of the SQLServer Flex instance. Can only be set when `flavor` and `replicas` are not set. You can list available flavors using the datasource `stackit_sqlserverflex_flavors`.
- `network` (Attributes) The network configuration of the instance. Will be required in the future. Set a value to prevent breaking changes. (see [below for nested schema](#nestedatt--network))
- `options` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--options))
- `region` (String) The resource region. If not defined, the provider region is used.
Expand Down Expand Up @@ -118,10 +115,7 @@ Read-Only:

Optional:

- `class` (String) The storage class. You can list available storage classes using the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli):
```bash
stackit beta sqlserverflex options --storages --flavor-id FLAVOR_ID
``` Will be required in the future. Set a value to prevent breaking changes.
- `class` (String) The storage class. You can list available storage classes for a the according flavors using the datasource `stackit_sqlserverflex_flavors`. Will be required in the future. Set a value to prevent breaking changes.
- `size` (Number) The storage size in Gigabytes. Will be required in the future. Set a value to prevent breaking changes.

## Import
Expand Down
21 changes: 13 additions & 8 deletions stackit/internal/services/sqlserverflex/instance/datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,10 @@ func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Computed: true,
},
"acl": schema.ListAttribute{
Description: descriptions["acl"],
ElementType: types.StringType,
Computed: true,
Description: descriptions["acl"],
DeprecationMessage: "acl is deprecated and will be removed after February 2027. Use instead `network.acl`.",
ElementType: types.StringType,
Computed: true,
},
"backup_schedule": schema.StringAttribute{
Description: descriptions["backup_schedule"],
Expand Down Expand Up @@ -145,7 +146,8 @@ func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
},
},
"flavor": schema.SingleNestedAttribute{
Computed: true,
Computed: true,
DeprecationMessage: "flavor is deprecated and will be removed after February 2027. Use instead `flavor_id`. You can list available flavors using the datasource `stackit_sqlserverflex_flavors`.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down Expand Up @@ -210,14 +212,17 @@ func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Computed: true,
},
"options": schema.SingleNestedAttribute{
Description: descriptions["options"],
Computed: true,
Description: descriptions["options"],
DeprecationMessage: "option is deprecated and will be removed after February 2027.",
Computed: true,
Attributes: map[string]schema.Attribute{
"edition": schema.StringAttribute{
Computed: true,
Computed: true,
DeprecationMessage: "edition is deprecated and will be removed after February 2027.",
},
"retention_days": schema.Int32Attribute{
Computed: true,
Computed: true,
DeprecationMessage: "retention_days is deprecated and will be removed after February 2027. Use instead `retention_days` from root.",
},
},
},
Expand Down
32 changes: 16 additions & 16 deletions stackit/internal/services/sqlserverflex/instance/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ type Model struct {
InstanceId types.String `tfsdk:"instance_id"`
ProjectId types.String `tfsdk:"project_id"`
Name types.String `tfsdk:"name"`
// Deprecated: ACL is deprecated and will be removed after January 2027
// Deprecated: ACL is deprecated and will be removed after February 2027
ACL types.List `tfsdk:"acl"`
BackupSchedule types.String `tfsdk:"backup_schedule"`
Encryption types.Object `tfsdk:"encryption"`
Expand All @@ -70,7 +70,7 @@ type Model struct {
Version types.String `tfsdk:"version"`
Replicas types.Int32 `tfsdk:"replicas"`
Edition types.String `tfsdk:"edition"`
// Deprecated: Options is deprecated and will be removed after January 2027
// Deprecated: Options is deprecated and will be removed after February 2027
Options types.Object `tfsdk:"options"`
RetentionDays types.Int32 `tfsdk:"retention_days"`
Network types.Object `tfsdk:"network"`
Expand Down Expand Up @@ -220,7 +220,7 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
planModel.BackupSchedule = types.StringValue("0 0 * * *")
}
resp.Diagnostics.AddAttributeWarning(path.Root("backup_schedule"),
"backup_schedule will be required in future", "backup_schedule will be a required field after January 2027. Set a value to prevent breaking changes. Fallback to '0 0 * * *' during deprecation period.")
"backup_schedule will be required in future", "backup_schedule will be a required field after February 2027. Set a value to prevent breaking changes. Fallback to '0 0 * * *' during deprecation period.")
}

// storage
Expand All @@ -232,7 +232,7 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
})
}
resp.Diagnostics.AddAttributeWarning(path.Root("storage"),
"storage will be required in future", "storage will be a required field after January 2027. Set values to prevent breaking changes. Fallback to class 'premium-perf12-stackit' with a size of 40 gigabytes during deprecation period.")
"storage will be required in future", "storage will be a required field after February 2027. Set values to prevent breaking changes. Fallback to class 'premium-perf12-stackit' with a size of 40 gigabytes during deprecation period.")
} else {
var storageConfig = &storageModel{}
resp.Diagnostics.Append(configModel.Storage.As(ctx, storageConfig, basetypes.ObjectAsOptions{})...)
Expand All @@ -251,7 +251,7 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
storagePlan.Class = types.StringValue("premium-perf12-stackit")
}
resp.Diagnostics.AddAttributeWarning(path.Root("storage.class"),
"storage.class will be required in future", "storage.class will be a required field after January 2027. Set a value to prevent breaking changes. Fallback to 'premium-perf12-stackit' during deprecation period.")
"storage.class will be required in future", "storage.class will be a required field after February 2027. Set a value to prevent breaking changes. Fallback to 'premium-perf12-stackit' during deprecation period.")
}

// storage.size
Expand All @@ -260,7 +260,7 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
storagePlan.Size = types.Int64Value(40)
}
resp.Diagnostics.AddAttributeWarning(path.Root("storage.size"),
"storage.size will be required in future", "storage.size will be a required field after January 2027. Set a value to prevent breaking changes. Fallback to 40 gigabytes during deprecation period.")
"storage.size will be required in future", "storage.size will be a required field after February 2027. Set a value to prevent breaking changes. Fallback to 40 gigabytes during deprecation period.")
}

var diags diag.Diagnostics
Expand All @@ -277,14 +277,14 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
planModel.Version = types.StringValue(string(sqlserverflex.INSTANCEVERSION__2022))
}
resp.Diagnostics.AddAttributeWarning(path.Root("version"),
"version will be required in future", "version will be a required field after January 2027. Set a value to prevent breaking changes. Fallback to '2022' during deprecation period.")
"version will be required in future", "version will be a required field after February 2027. Set a value to prevent breaking changes. Fallback to '2022' during deprecation period.")
}

// acl
if (configModel.ACL.IsNull() || configModel.ACL.IsUnknown()) && (configModel.Network.IsNull() || configModel.Network.IsUnknown()) {
// Not setting default ACL and scope to the configModel, instead we send an empty array to the API, where they set the default value.
resp.Diagnostics.AddAttributeWarning(path.Root("network").AtName("acl"),
"network.acl will be required in future", "network.acl will be a required field after January 2027. Set values to prevent breaking changes.")
"network.acl will be required in future", "network.acl will be a required field after February 2027. Set values to prevent breaking changes.")
}

// retention_days
Expand All @@ -307,7 +307,7 @@ func handleV3Migration(ctx context.Context, planModel, configModel *Model, resp
planModel.RetentionDays = types.Int32Value(30)
}
resp.Diagnostics.AddAttributeWarning(path.Root("retention_days"),
"retention_days will be required in future", "retention_days will be a required field after January 2027. Set a value to prevent breaking changes. Fallback to 30 days during deprecation period.")
"retention_days will be required in future", "retention_days will be a required field after February 2027. Set a value to prevent breaking changes. Fallback to 30 days during deprecation period.")
}
}

Expand All @@ -328,7 +328,7 @@ func (r *instanceResource) Schema(_ context.Context, req resource.SchemaRequest,
"kek_key_version": "Version of the key within the STACKIT-KMS to use for the encryption.",
"service_account": "Service-Account linked to the Key within the STACKIT-KMS.",
"options": "Custom parameters for the SQLServer Flex instance.",
"flavor_id": "The flavor ID of the SQLServer Flex instance. Can only be set when `flavor` and `replicas` are not set. You can list available storage classes using the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli):\n```bash\nstackit curl https://mssql-flex-service.api.stackit.cloud/v3/projects/{project_id}/regions/{region}/flavors\\?size=100\n```",
"flavor_id": "The flavor ID of the SQLServer Flex instance. Can only be set when `flavor` and `replicas` are not set. You can list available flavors using the datasource `stackit_sqlserverflex_flavors`.",
"network": "The network configuration of the instance." + willBeRequired,
"network.access_scope": "The network access scope of the instance. This feature is in private preview. Supplying this object is only permitted for enabled accounts. If your account does not have access, the request will be rejected.",
"network.acl": "List of IPV4 cidr." + willBeRequired,
Expand All @@ -338,7 +338,7 @@ func (r *instanceResource) Schema(_ context.Context, req resource.SchemaRequest,
"edition": "Edition of the MSSQL server instance.",
"region": "The resource region. If not defined, the provider region is used.",
"storage": "The object containing information about the storage size and class." + willBeRequired,
"storage.class": "The storage class. You can list available storage classes using the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli):\n```bash\nstackit beta sqlserverflex options --storages --flavor-id FLAVOR_ID\n```" + willBeRequired,
"storage.class": "The storage class. You can list available storage classes for a the according flavors using the datasource `stackit_sqlserverflex_flavors`." + willBeRequired,
"storage.size": "The storage size in Gigabytes." + willBeRequired,
"version": "The sqlserver version used for the instance. " + utils.FormatPossibleValues(sdkUtils.EnumSliceToStringSlice(sqlserverflex.AllowedInstanceVersionEnumValues)...) + willBeRequired,
}
Expand Down Expand Up @@ -388,7 +388,7 @@ func (r *instanceResource) Schema(_ context.Context, req resource.SchemaRequest,
},
"acl": schema.ListAttribute{
Description: descriptions["acl"],
DeprecationMessage: "acl is deprecated and will be removed after January 2027. Use instead `network.acl`.",
DeprecationMessage: "acl is deprecated and will be removed after February 2027. Use instead `network.acl`.",
ElementType: types.StringType,
Optional: true,
Computed: true,
Expand Down Expand Up @@ -458,7 +458,7 @@ func (r *instanceResource) Schema(_ context.Context, req resource.SchemaRequest,
"flavor": schema.SingleNestedAttribute{
Computed: true,
Optional: true,
DeprecationMessage: "flavor is deprecated and will be removed after February 2027. Use instead `flavor_id`. You can get the available flavors using the STACKIT-CLI using `stackit curl https://mssql-flex-service.api.stackit.cloud/v3/projects/{project_id}/regions/{region}/flavors\\?size=100`.",
DeprecationMessage: "flavor is deprecated and will be removed after February 2027. Use instead `flavor_id`. You can list available flavors using the datasource `stackit_sqlserverflex_flavors`.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down Expand Up @@ -587,22 +587,22 @@ func (r *instanceResource) Schema(_ context.Context, req resource.SchemaRequest,
},
},
"options": schema.SingleNestedAttribute{
DeprecationMessage: "option is deprecated and will be removed after January 2027.",
DeprecationMessage: "option is deprecated and will be removed after February 2027.",
Optional: true,
Computed: true,
PlanModifiers: []planmodifier.Object{
objectplanmodifier2.UseStateForUnknownIf(objectplanmodifier2.Int32Unchanged(path.Root("retention_days")), "sets `UseStateForUnknown` only if `retention_days` has not changed"),
},
Attributes: map[string]schema.Attribute{
"edition": schema.StringAttribute{
DeprecationMessage: "edition is deprecated and will be removed after January 2027.",
DeprecationMessage: "edition is deprecated and will be removed after February 2027.",
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"retention_days": schema.Int32Attribute{
DeprecationMessage: "retention_days is deprecated and will be removed after January 2027. Use instead `retention_days` from root.",
DeprecationMessage: "retention_days is deprecated and will be removed after February 2027. Use instead `retention_days` from root.",
Optional: true,
Computed: true,
PlanModifiers: []planmodifier.Int32{
Expand Down
Loading