Skip to content

[Internal] Deprecate instance_profiles attribute, and replace it with roles in databricks_group data source #5086

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Internal] Deprecate instance_profiles attribute, and replace it with roles in databricks_group data source #5086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions NEXT_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@
### Exporter

### Internal Changes

* Deprecate `instance_profiles` attribute, and replace it with `roles` in `databricks_group` data source ([#5086](https://github.com/databricks/terraform-provider-databricks/pull/5086))
5 changes: 3 additions & 2 deletions docs/data-sources/group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ subcategory: "Security"
---
# databricks_group Data Source

Retrieves information about [databricks_group](../resources/group.md) members, entitlements and instance profiles.
Retrieves information about [databricks_group](../resources/group.md) members, entitlements and roles.

-> This data source can be used with an account or workspace-level provider.

Expand Down Expand Up @@ -43,7 +43,8 @@ Data source exposes the following attributes:
* `service_principals` - Set of [databricks_service_principal](../resources/service_principal.md) identifiers, that can be modified with [databricks_group_member](../resources/group_member.md) resource.
* `child_groups` - Set of [databricks_group](../resources/group.md) identifiers, that can be modified with [databricks_group_member](../resources/group_member.md) resource.
* `groups` - Set of [group](../resources/group.md) identifiers, that can be modified with [databricks_group_member](../resources/group_member.md) resource.
* `instance_profiles` - Set of [instance profile](../resources/instance_profile.md) ARNs, that can be modified by [databricks_group_instance_profile](../resources/group_instance_profile.md) resource.
* `roles` - Set of role ARNs (e.g., [instance profile](../resources/instance_profile.md) ARNs), that can be modified by [databricks_group_instance_profile](../resources/group_instance_profile.md) or [databricks_group_role](../resources/group_role.md) resources.
* `instance_profiles` - (Deprecated) Set of [instance profile](../resources/instance_profile.md) ARNs, that can be modified by [databricks_group_instance_profile](../resources/group_instance_profile.md) resource. Use `roles` instead.
* `allow_cluster_create` - True if group members can create [clusters](../resources/cluster.md)
* `allow_instance_pool_create` - True if group members can create [instance pools](../resources/instance_pool.md)
* `acl_principal_id` - identifier for use in [databricks_access_control_rule_set](../resources/access_control_rule_set.md), e.g. `groups/Some Group`.
Expand Down
4 changes: 4 additions & 0 deletions scim/data_group.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ func DataSourceGroup() common.Resource {
ServicePrincipals []string `json:"service_principals,omitempty" tf:"slice_set,computed"`
ChildGroups []string `json:"child_groups,omitempty" tf:"slice_set,computed"`
Groups []string `json:"groups,omitempty" tf:"slice_set,computed"`
Roles []string `json:"roles,omitempty" tf:"slice_set,computed"`
InstanceProfiles []string `json:"instance_profiles,omitempty" tf:"slice_set,computed"`
ExternalID string `json:"external_id,omitempty" tf:"computed"`
AclPrincipalID string `json:"acl_principal_id,omitempty" tf:"computed"`
Expand All @@ -32,6 +33,7 @@ func DataSourceGroup() common.Resource {
s["display_name"].ValidateFunc = validation.StringIsNotEmpty
s["recursive"].Default = true
s["members"].Deprecated = "Please use `users`, `service_principals`, and `child_groups` instead"
s["instance_profiles"].Deprecated = "Please use `roles` instead"
addEntitlementsToSchema(s)
return s
})
Expand Down Expand Up @@ -77,6 +79,7 @@ func DataSourceGroup() common.Resource {
}
}
for _, x := range current.Roles {
this.Roles = append(this.Roles, x.Value)
this.InstanceProfiles = append(this.InstanceProfiles, x.Value)
}
current.Entitlements.readIntoData(d)
Expand All @@ -98,6 +101,7 @@ func DataSourceGroup() common.Resource {
sort.Strings(this.Users)
sort.Strings(this.ChildGroups)
sort.Strings(this.ServicePrincipals)
sort.Strings(this.Roles)
sort.Strings(this.InstanceProfiles)
err = common.StructToData(this, s, d)
if err != nil {
Expand Down
1 change: 1 addition & 0 deletions scim/data_group_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ func TestDataSourceGroup(t *testing.T) {
},
}.ApplyAndExpectData(t, map[string]any{
"acl_principal_id": "groups/ds",
"roles": []string{"a", "b"},
"instance_profiles": []string{"a", "b"},
"members": []string{"1112", "1113", "1114"},
"groups": []string{"abc"},
Expand Down
Loading