Added - Support for Allow admins to specify user Quotas for their filesystems

Author: aaygoyal

examples/storage/fss/data_sources.tf

@@ -132,3 +132,17 @@ data "oci_file_storage_outbound_connectors" "outbound_connectors" {
   #id           = var.outbound_connector_id
   #state        = var.outbound_connector_state
 }
+
+# Gets the list of quota rules for a file-system and principal_type
+data "oci_file_storage_file_system_quota_rules" "file_system_quota_rules" {
+  #Required
+  file_system_id = oci_file_storage_file_system.my_fs_simple_quota_rule.id
+  principal_type = var.my_simple_quota_rule_principal_type
+}
+
+# Gets the quota rule for a file-system id and quota-rule id
+data "oci_file_storage_file_system_quota_rule" "file_system_quota_rule" {
+  #Required
+  file_system_id = oci_file_storage_file_system.my_fs_simple_quota_rule.id
+  quota_rule_id  = oci_file_storage_file_system_quota_rule.my_simple_quota_rule.id
+}

examples/storage/fss/file_system_quota_rule.tf

@@ -0,0 +1,21 @@
+resource "oci_file_storage_file_system" "my_fs_simple_quota_rule" {
+  #Required
+  availability_domain = data.oci_identity_availability_domain.ad.name
+  compartment_id      = var.compartment_ocid
+
+  #Optional
+  display_name = var.file_system_simple_qr_display_name
+  are_quota_rules_enabled = var.quota_rule_enabled
+
+}
+
+resource "oci_file_storage_file_system_quota_rule" "my_simple_quota_rule" {
+  #Required
+  file_system_id           = oci_file_storage_file_system.my_fs_simple_quota_rule.id
+  is_hard_quota            = var.my_simple_quota_rule_is_hard_quota
+  principal_type           = var.my_simple_quota_rule_principal_type
+  quota_limit_in_gigabytes = var.my_simple_quota_rule_quota_limit_in_gigabytes
+
+  #Optional
+  display_name = var.my_simple_quota_rule_display_name
+}

examples/storage/fss/variables.tf

@@ -62,6 +62,10 @@ variable "clone_attach_status_value" {
     default= "DETACH"
 }
 
+variable "quota_rule_enabled" {
+  default = "false"
+}
+
 variable "file_system_with_snapshot_policy_display_name" {
   default = "my_fs_with_snapshot_policy"
 }
@@ -315,3 +319,23 @@ variable "locks_message" {
 variable "is_lock_override" {
   default = true
 }
+
+variable "file_system_simple_qr_display_name" {
+  default= "my_fs_simple_quota_rule"
+}
+
+variable "my_simple_quota_rule_is_hard_quota" {
+  default = "false"
+}
+
+variable "my_simple_quota_rule_principal_type" {
+  default = "FILE_SYSTEM_LEVEL"
+}
+
+variable "my_simple_quota_rule_quota_limit_in_gigabytes" {
+  default = "10"
+}
+
+variable "my_simple_quota_rule_display_name" {
+  default = "my_simple_quota_rule"
+}

internal/integrationtest/file_storage_file_system_quota_rule_test.go

@@ -52,6 +52,7 @@ var (
 	FileStorageFileSystemRepresentation = map[string]interface{}{
 		"availability_domain":           acctest.Representation{RepType: acctest.Required, Create: `${data.oci_identity_availability_domains.test_availability_domains.availability_domains.0.name}`},
 		"compartment_id":                acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
+		"are_quota_rules_enabled":       acctest.Representation{RepType: acctest.Optional, Create: `false`, Update: `false`},
 		"clone_attach_status":           acctest.Representation{RepType: acctest.Optional, Create: `DETACH`},
 		"defined_tags":                  acctest.Representation{RepType: acctest.Optional, Create: `${map("${oci_identity_tag_namespace.tag-namespace1.name}.${oci_identity_tag.tag1.name}", "value")}`, Update: `${map("${oci_identity_tag_namespace.tag-namespace1.name}.${oci_identity_tag.tag1.name}", "updatedValue")}`},
 		"display_name":                  acctest.Representation{RepType: acctest.Optional, Create: `media-files-1`, Update: `displayName2`},
@@ -165,6 +166,7 @@ func TestFileStorageFileSystemResource_basic(t *testing.T) {
 			Config: config + compartmentIdVariableStr + FileStorageFileSystemResourceDependencies +
 				acctest.GenerateResourceFromRepresentationMap("oci_file_storage_file_system", "test_file_system2", acctest.Optional, acctest.Create, FileStorageFileSystemRepresentationWithDeleteLock),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "are_quota_rules_enabled", "false"),
 				resource.TestCheckResourceAttrSet(resourceName, "availability_domain"),
 				resource.TestCheckResourceAttr(resourceName, "clone_attach_status", "ATTACHED"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
@@ -203,8 +205,9 @@ func TestFileStorageFileSystemResource_basic(t *testing.T) {
 						"compartment_id": acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id_for_update}`},
 					})),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "are_quota_rules_enabled", "false"),
 				resource.TestCheckResourceAttrSet(resourceName, "availability_domain"),
-				resource.TestCheckResourceAttr(resourceName, "clone_attach_status", "DETACHING"),
+				resource.TestCheckResourceAttr(resourceName, "clone_attach_status", "ATTACHED"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentIdU),
 				resource.TestCheckResourceAttr(resourceName, "display_name", "media-files-1"),
 				resource.TestCheckResourceAttrSet(resourceName, "filesystem_snapshot_policy_id"),
@@ -262,8 +265,9 @@ func TestFileStorageFileSystemResource_basic(t *testing.T) {
 			Config: config + compartmentIdVariableStr + FileStorageFileSystemResourceDependencies +
 				acctest.GenerateResourceFromRepresentationMap("oci_file_storage_file_system", "test_file_system2", acctest.Optional, acctest.Update, FileStorageFileSystemRepresentation),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "are_quota_rules_enabled", "false"),
 				resource.TestCheckResourceAttrSet(resourceName, "availability_domain"),
-				resource.TestCheckResourceAttr(resourceName, "clone_attach_status", "DETACHING"),
+				resource.TestCheckResourceAttr(resourceName, "clone_attach_status", "ATTACHED"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(resourceName, "display_name", "displayName2"),
 				resource.TestCheckResourceAttrSet(resourceName, "filesystem_snapshot_policy_id"),
@@ -304,14 +308,18 @@ func TestFileStorageFileSystemResource_basic(t *testing.T) {
 
 				resource.TestCheckResourceAttr(datasourceName, "file_systems.#", "1"),
 				resource.TestCheckResourceAttrSet(datasourceName, "file_systems.0.availability_domain"),
-				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.clone_attach_status", "DETACHING"),
+				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.clone_attach_status", "ATTACHED"),
 				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.display_name", "displayName2"),
 				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.freeform_tags.%", "1"),
 
 				acctest.TestCheckResourceAttributesEqual(datasourceName, "file_systems.0.id", "oci_file_storage_file_system.test_file_system2", "id"),
 				resource.TestCheckResourceAttrSet(datasourceName, "file_systems.0.is_clone_parent"),
 				resource.TestCheckResourceAttrSet(datasourceName, "file_systems.0.is_hydrated"),
+				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.locks.#", "1"),
+				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.locks.0.message", "message"),
+				resource.TestCheckResourceAttrSet(datasourceName, "file_systems.0.metered_bytes"),
+				resource.TestCheckResourceAttrSet(datasourceName, "file_systems.0.quota_enforcement_state"),
 				acctest.TestCheckResourceAttributesEqual(datasourceName, "file_systems.0.kms_key_id", "oci_file_storage_file_system.test_file_system2", "kms_key_id"),
 				acctest.TestCheckResourceAttributesEqual(datasourceName, "file_systems.0.metered_bytes", "oci_file_storage_file_system.test_file_system2", "metered_bytes"),
 				resource.TestCheckResourceAttr(datasourceName, "file_systems.0.source_details.#", "1"),

internal/integrationtest/file_storage_file_system_test.go

@@ -1,12 +1,16 @@
 package file_storage
 
 import (
+	"fmt"
+
 	oci_file_storage "github.com/oracle/oci-go-sdk/v65/filestorage"
 
 	tf_export "github.com/oracle/terraform-provider-oci/internal/commonexport"
 )
 
 func init() {
+
+	exportFileStorageFileSystemQuotaRuleHints.GetIdFn = getFileStorageFileSystemQuotaRuleId
 	exportFileStorageMountTargetHints.RequireResourceRefresh = true
 	tf_export.RegisterCompartmentGraphs("file_storage", fileStorageResourceGraph)
 	tf_export.BuildAvailabilityResourceGraph("oci_identity_availability_domain", customAssociationFileStorageIdentityAvailabilityDomain)
@@ -15,6 +19,16 @@ func init() {
 
 // Custom overrides for generating composite IDs within the resource discovery framework
 
+func getFileStorageFileSystemQuotaRuleId(resource *tf_export.OCIResource) (string, error) {
+
+	fileSystemId := resource.Parent.Id
+	quotaRuleId, ok := resource.SourceAttributes["quota_rule_id"].(string)
+	if !ok {
+		return "", fmt.Errorf("[ERROR] unable to find quotaRuleId for FileStorage FileSystemQuotaRule")
+	}
+	return GetFileSystemQuotaRuleCompositeId(fileSystemId, quotaRuleId), nil
+}
+
 // Hints for discovering and exporting this resource to configuration and state files
 var exportFileStorageFileSystemHints = &tf_export.TerraformResourceHints{
 	ResourceClass:          "oci_file_storage_file_system",
@@ -93,6 +107,13 @@ var exportFileStorageOutboundConnectorHints = &tf_export.TerraformResourceHints{
 	},
 }
 
+var exportFileStorageFileSystemQuotaRuleHints = &tf_export.TerraformResourceHints{
+	ResourceClass:        "oci_file_storage_file_system_quota_rule",
+	DatasourceClass:      "oci_file_storage_file_system_quota_rules",
+	DatasourceItemsAttr:  "quota_rules",
+	ResourceAbbreviation: "file_system_quota_rule",
+}
+
 var fileStorageResourceGraph = tf_export.TerraformResourceGraph{
 	"oci_identity_compartment": {
 		{TerraformResourceHints: exportFileStorageExportHints},
@@ -137,6 +158,7 @@ var customAssociationFileStorageFileSystem = []tf_export.TerraformResourceAssoci
 		TerraformResourceHints: exportFileStorageSnapshotHints,
 		DatasourceQueryParams: map[string]string{
 			"file_system_id": "id",
+			"quota_rule_id":  "id",
 		},
 	},
 }

internal/service/file_storage/file_storage_export.go

@@ -0,0 +1,109 @@
+// Copyright (c) 2017, 2024, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+package file_storage
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	oci_file_storage "github.com/oracle/oci-go-sdk/v65/filestorage"
+
+	"github.com/oracle/terraform-provider-oci/internal/client"
+	"github.com/oracle/terraform-provider-oci/internal/tfresource"
+)
+
+func FileStorageFileSystemQuotaRuleDataSource() *schema.Resource {
+	fieldMap := make(map[string]*schema.Schema)
+	fieldMap["file_system_id"] = &schema.Schema{
+		Type:     schema.TypeString,
+		Required: true,
+	}
+	fieldMap["quota_rule_id"] = &schema.Schema{
+		Type:     schema.TypeString,
+		Optional: true,
+	}
+	fieldMap["are_violators_only"] = &schema.Schema{
+		Type:     schema.TypeString,
+		Optional: true,
+	}
+	return tfresource.GetSingularDataSourceItemSchema(FileStorageFileSystemQuotaRuleResource(), fieldMap, readSingularFileStorageFileSystemQuotaRule)
+}
+
+func readSingularFileStorageFileSystemQuotaRule(d *schema.ResourceData, m interface{}) error {
+	sync := &FileStorageFileSystemQuotaRuleDataSourceCrud{}
+	sync.D = d
+	sync.Client = m.(*client.OracleClients).FileStorageClient()
+
+	return tfresource.ReadResource(sync)
+}
+
+type FileStorageFileSystemQuotaRuleDataSourceCrud struct {
+	D      *schema.ResourceData
+	Client *oci_file_storage.FileStorageClient
+	Res    *oci_file_storage.GetQuotaRuleResponse
+}
+
+func (s *FileStorageFileSystemQuotaRuleDataSourceCrud) VoidState() {
+	s.D.SetId("")
+}
+
+func (s *FileStorageFileSystemQuotaRuleDataSourceCrud) Get() error {
+	request := oci_file_storage.GetQuotaRuleRequest{}
+
+	if fileSystemId, ok := s.D.GetOkExists("file_system_id"); ok {
+		tmp := fileSystemId.(string)
+		request.FileSystemId = &tmp
+	}
+
+	if quotaRuleId, ok := s.D.GetOkExists("quota_rule_id"); ok {
+		tmp := quotaRuleId.(string)
+		request.QuotaRuleId = &tmp
+	}
+
+	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(false, "file_storage")
+
+	response, err := s.Client.GetQuotaRule(context.Background(), request)
+	if err != nil {
+		return err
+	}
+
+	s.Res = &response
+	return nil
+}
+
+func (s *FileStorageFileSystemQuotaRuleDataSourceCrud) SetData() error {
+	if s.Res == nil {
+		return nil
+	}
+
+	s.D.SetId(*s.Res.Id)
+
+	if s.Res.DisplayName != nil {
+		s.D.Set("display_name", *s.Res.DisplayName)
+	}
+
+	if s.Res.IsHardQuota != nil {
+		s.D.Set("is_hard_quota", *s.Res.IsHardQuota)
+	}
+
+	if s.Res.PrincipalId != nil {
+		s.D.Set("principal_id", *s.Res.PrincipalId)
+	}
+
+	s.D.Set("principal_type", s.Res.PrincipalType)
+
+	if s.Res.QuotaLimitInGigabytes != nil {
+		s.D.Set("quota_limit_in_gigabytes", *s.Res.QuotaLimitInGigabytes)
+	}
+
+	if s.Res.TimeCreated != nil {
+		s.D.Set("time_created", s.Res.TimeCreated.String())
+	}
+
+	if s.Res.TimeUpdated != nil {
+		s.D.Set("time_updated", s.Res.TimeUpdated.String())
+	}
+
+	return nil
+}