netapp

package
v0.0.0-...-0e4e14f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 28, 2025 License: MPL-2.0 Imports: 50 Imported by: 0

README

This is a maintainer file for the Azure NetApp Files service.

This document gives insights into who is maintaining this service and includes details for why certain decisions in this service package have been made.

Mainteiners

  • paulomarquesc
  • orexii

Acceptance Tests

  • There is lack of SMB-related acceptance tests because it requires Active Directory Domain Controller infrastructure which is not easy to automate properly. SMB-related tests can only be tested if the infrastructure is setup beforehand which is not that trivial. We should not require SMB tests unless it comes with Domain Controller setup automation. Without automation, the SMB acceptance tests will fail and cause disruptions in CI/bulk testing.

  • New tests failing should not be accepted.

  • For Azure NetApp Files, some features are highly dependent on specific regions, that's why for some acceptance tests, we will see regions defined there instead of for example data.Locations.Primary within the templates, this is expected and should not be changed.

Polling functions

  • Some Netapp resources requires an extra type of polling mechanism. For example:
// Waiting for volume be completely provisioned
if err := waitForVolumeCreateOrUpdate(ctx, client, id); err != nil {
  return err
}

This is because some operations return from regular SDK polling as completed but due to several factors it is still in progress (e.g. ARM caching, software and hardware layer sync delays, etc.). These wait functions are necessary and should not be removed.

  • Do not approve Pull Requests that relies on <Create or Delete Operations>ThenPoll() methods, e.g. DeleteThenPoll(), we should not use those for volume related operations due to some unknown issues with Pandora, those for Azure NetApp Files are not reliable, causing errors from time to time (and depending on the operation, very frequently) like this:
pmarques [ ~/go/src/github.com/aoshfan/terraform-provider-customazurerm ]$ make acctests SERVICE='netapp' TESTARGS=' -parallel 5 -run=TestAccNetAppVolumeGroupSAPHana_crossRegionReplication -count=1' TESTTIMEOUT='1200m'
==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
egrep: warning: egrep is obsolescent; using grep -E
egrep: warning: egrep is obsolescent; using grep -E
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/netapp -parallel 5 -run=TestAccNetAppVolumeGroupSAPHana_crossRegionReplication -count=1 -timeout 1200m -ldflags="-X=github.com/aoshfan/terraform-provider-customazurerm/version.ProviderVersion=acc"
=== RUN   TestAccNetAppVolumeGroupSAPHana_crossRegionReplication
=== PAUSE TestAccNetAppVolumeGroupSAPHana_crossRegionReplication
=== CONT  TestAccNetAppVolumeGroupSAPHana_crossRegionReplication
    testcase.go:173: Error running post-test destroy, there may be dangling resources: exit status 1

        Error: deleting `volume`: deleting replicate Volume (Subscription: "66bc9830-19b6-4987-94d2-0e487be7aa47"
        Resource Group Name: "acctestRG-netapp-241202215210177839"
        Net App Account Name: "acctest-NetAppAccount-Secondary-241202215210177839"
        Capacity Pool Name: "acctest-NetAppPool-Secondary-241202215210177839"
        Volume Name: "acctest-NetAppVolume-1-Secondary-241202215210177839"): polling after VolumesDeleteReplication: `result.Status` was nil/empty - `op.Status` was "DeleteReplication" / `op.Properties.ProvisioningState` was ""

        deleting `volume`: deleting replicate Volume (Subscription:
        "66bc9830-19b6-4987-94d2-0e487be7aa47"
        Resource Group Name: "acctestRG-netapp-241202215210177839"
        Net App Account Name: "acctest-NetAppAccount-Secondary-241202215210177839"
        Capacity Pool Name: "acctest-NetAppPool-Secondary-241202215210177839"
        Volume Name: "acctest-NetAppVolume-1-Secondary-241202215210177839"): polling
        after VolumesDeleteReplication: `result.Status` was nil/empty - `op.Status`
        was "DeleteReplication" / `op.Properties.ProvisioningState` was ""
--- FAIL: TestAccNetAppVolumeGroupSAPHana_crossRegionReplication (1375.67s)
FAIL
FAIL    github.com/aoshfan/terraform-provider-customazurerm/internal/services/netapp        1375.697s
FAIL
make: *** [GNUmakefile:103: acctests] Error 1

Data loss prevention protection

  • Due to possibility of a volume to be deleted due to configuration changes on config file or changes made outside of Terraform, we have decided to not allow deletion of volumes by default. This is to prevent data loss. If you want to delete a volume, you need to set the feature block configuration prevent_deletion_if_contains_resources argument to true.

    In our tests we have added this block so the tests can delete the resources, but in production customers should not allow deletion of volumes by default.

features {
  resource_group {
    prevent_deletion_if_contains_resources = false
  }
}

Resource Group Deletion on Tests

  • A feature block configuration needs to be set to ensure tests conclude when Microsoft maintainers execute their testing. Due to some Microsoft subscription management policies, certain resources are created by default during the tests. This block allows the deletion of the resource group at the end of the tests.
  features {
    resource_group {
      prevent_deletion_if_contains_resources = false
    }
  }

Azure NetApp Files has features that requires disassociation, e.g. BackupPolicyId and SnapshotPolicyIds

  • For cases where a property must have its content removed, mostly Ids (BackupPolicyId or SnapshotPolicyIds), instead of using nil, use pointer.To(""), this will trigger ANF RP to update the resource and set the value to empty string, setting as nil won't trigger any action within ANF RP.

E.g.

// Removing SnapshotId
update := volumes.VolumePatch{
    Properties: &volumes.VolumePatchProperties{
        DataProtection: &volumes.VolumePatchPropertiesDataProtection{
            Snapshot: &volumes.VolumeSnapshotProperties{
                SnapshotPolicyId: pointer.To(""),
            },
        },
    },
}

// Removing BackupPolicyId
backupPolicyIdRemoval := volumes.VolumePatch{
    Properties: &volumes.VolumePatchProperties{
        DataProtection: &volumes.VolumePatchPropertiesDataProtection{
            Backup: &volumes.VolumeBackupProperties{
                BackupPolicyId: pointer.To(""),
            },
        },
    },
}

Computed attribute of a few configuration items

  • Azure NetApp Files resources are complex enough on the backend and a few configuration items must remain in computed = true state and not changed under any circumstance, otherwise, if it is a ForceNew = true type of configuration, it may result in data loss. The best example of this is the configuration called network_features, this must be computed = true at all times, Azure NetApp Files team will soon make changes to networking that will make the property network_features be changed from basic to standard and to prevent data loss, this configuration should stay as is, with computed = true set.
"network_features": {
    Type:     pluginsdk.TypeString,
    Optional: true,
    Computed: true,
    Default:  string(volumes.NetworkFeaturesBasic),
    ValidateFunc: validation.StringInSlice([]string{
        string(volumes.NetworkFeaturesBasic),
        string(volumes.NetworkFeaturesStandard),
    }, false),
},

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateSlicesEquality 

func ValidateSlicesEquality(source, new []string, caseSensitive bool) bool

Types

type NetAppAccountEncryptionDataSource 

type NetAppAccountEncryptionDataSource struct{}

func (NetAppAccountEncryptionDataSource) Arguments 

func (r NetAppAccountEncryptionDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppAccountEncryptionDataSource) Attributes 

func (r NetAppAccountEncryptionDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppAccountEncryptionDataSource) IDValidationFunc 

func (r NetAppAccountEncryptionDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppAccountEncryptionDataSource) ModelObject 

func (r NetAppAccountEncryptionDataSource) ModelObject() interface{}

func (NetAppAccountEncryptionDataSource) Read 

func (r NetAppAccountEncryptionDataSource) Read() sdk.ResourceFunc

func (NetAppAccountEncryptionDataSource) ResourceType 

func (r NetAppAccountEncryptionDataSource) ResourceType() string

type NetAppAccountEncryptionResource 

type NetAppAccountEncryptionResource struct{}

func (NetAppAccountEncryptionResource) Arguments 

func (r NetAppAccountEncryptionResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppAccountEncryptionResource) Attributes 

func (r NetAppAccountEncryptionResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppAccountEncryptionResource) Create 

func (r NetAppAccountEncryptionResource) Create() sdk.ResourceFunc

func (NetAppAccountEncryptionResource) Delete 

func (r NetAppAccountEncryptionResource) Delete() sdk.ResourceFunc

func (NetAppAccountEncryptionResource) IDValidationFunc 

func (r NetAppAccountEncryptionResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppAccountEncryptionResource) ModelObject 

func (r NetAppAccountEncryptionResource) ModelObject() interface{}

func (NetAppAccountEncryptionResource) Read 

func (r NetAppAccountEncryptionResource) Read() sdk.ResourceFunc

func (NetAppAccountEncryptionResource) ResourceType 

func (r NetAppAccountEncryptionResource) ResourceType() string

func (NetAppAccountEncryptionResource) Update 

func (r NetAppAccountEncryptionResource) Update() sdk.ResourceFunc

type NetAppBackupPolicyDataSource 

type NetAppBackupPolicyDataSource struct{}

func (NetAppBackupPolicyDataSource) Arguments 

func (r NetAppBackupPolicyDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppBackupPolicyDataSource) Attributes 

func (r NetAppBackupPolicyDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppBackupPolicyDataSource) IDValidationFunc 

func (r NetAppBackupPolicyDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppBackupPolicyDataSource) ModelObject 

func (r NetAppBackupPolicyDataSource) ModelObject() interface{}

func (NetAppBackupPolicyDataSource) Read 

func (r NetAppBackupPolicyDataSource) Read() sdk.ResourceFunc

func (NetAppBackupPolicyDataSource) ResourceType 

func (r NetAppBackupPolicyDataSource) ResourceType() string

type NetAppBackupPolicyResource 

type NetAppBackupPolicyResource struct{}

func (NetAppBackupPolicyResource) Arguments 

func (r NetAppBackupPolicyResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppBackupPolicyResource) Attributes 

func (r NetAppBackupPolicyResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppBackupPolicyResource) Create 

func (r NetAppBackupPolicyResource) Create() sdk.ResourceFunc

func (NetAppBackupPolicyResource) Delete 

func (r NetAppBackupPolicyResource) Delete() sdk.ResourceFunc

func (NetAppBackupPolicyResource) IDValidationFunc 

func (r NetAppBackupPolicyResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppBackupPolicyResource) ModelObject 

func (r NetAppBackupPolicyResource) ModelObject() interface{}

func (NetAppBackupPolicyResource) Read 

func (r NetAppBackupPolicyResource) Read() sdk.ResourceFunc

func (NetAppBackupPolicyResource) ResourceType 

func (r NetAppBackupPolicyResource) ResourceType() string

func (NetAppBackupPolicyResource) Update 

func (r NetAppBackupPolicyResource) Update() sdk.ResourceFunc

type NetAppBackupVaultDataSource 

type NetAppBackupVaultDataSource struct{}

func (NetAppBackupVaultDataSource) Arguments 

func (r NetAppBackupVaultDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppBackupVaultDataSource) Attributes 

func (r NetAppBackupVaultDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppBackupVaultDataSource) IDValidationFunc 

func (r NetAppBackupVaultDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppBackupVaultDataSource) ModelObject 

func (r NetAppBackupVaultDataSource) ModelObject() interface{}

func (NetAppBackupVaultDataSource) Read 

func (r NetAppBackupVaultDataSource) Read() sdk.ResourceFunc

func (NetAppBackupVaultDataSource) ResourceType 

func (r NetAppBackupVaultDataSource) ResourceType() string

type NetAppBackupVaultResource 

type NetAppBackupVaultResource struct{}

func (NetAppBackupVaultResource) Arguments 

func (r NetAppBackupVaultResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppBackupVaultResource) Attributes 

func (r NetAppBackupVaultResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppBackupVaultResource) Create 

func (r NetAppBackupVaultResource) Create() sdk.ResourceFunc

func (NetAppBackupVaultResource) Delete 

func (r NetAppBackupVaultResource) Delete() sdk.ResourceFunc

func (NetAppBackupVaultResource) IDValidationFunc 

func (r NetAppBackupVaultResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppBackupVaultResource) ModelObject 

func (r NetAppBackupVaultResource) ModelObject() interface{}

func (NetAppBackupVaultResource) Read 

func (r NetAppBackupVaultResource) Read() sdk.ResourceFunc

func (NetAppBackupVaultResource) ResourceType 

func (r NetAppBackupVaultResource) ResourceType() string

func (NetAppBackupVaultResource) Update 

func (r NetAppBackupVaultResource) Update() sdk.ResourceFunc

type NetAppVolumeGroupOracleDataSource 

type NetAppVolumeGroupOracleDataSource struct{}

func (NetAppVolumeGroupOracleDataSource) Arguments 

func (r NetAppVolumeGroupOracleDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupOracleDataSource) Attributes 

func (r NetAppVolumeGroupOracleDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupOracleDataSource) IDValidationFunc 

func (r NetAppVolumeGroupOracleDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeGroupOracleDataSource) ModelObject 

func (r NetAppVolumeGroupOracleDataSource) ModelObject() interface{}

func (NetAppVolumeGroupOracleDataSource) Read 

func (r NetAppVolumeGroupOracleDataSource) Read() sdk.ResourceFunc

func (NetAppVolumeGroupOracleDataSource) ResourceType 

func (r NetAppVolumeGroupOracleDataSource) ResourceType() string

type NetAppVolumeGroupOracleResource 

type NetAppVolumeGroupOracleResource struct{}

func (NetAppVolumeGroupOracleResource) Arguments 

func (r NetAppVolumeGroupOracleResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupOracleResource) Attributes 

func (r NetAppVolumeGroupOracleResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupOracleResource) Create 

func (r NetAppVolumeGroupOracleResource) Create() sdk.ResourceFunc

func (NetAppVolumeGroupOracleResource) Delete 

func (r NetAppVolumeGroupOracleResource) Delete() sdk.ResourceFunc

func (NetAppVolumeGroupOracleResource) IDValidationFunc 

func (r NetAppVolumeGroupOracleResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeGroupOracleResource) ModelObject 

func (r NetAppVolumeGroupOracleResource) ModelObject() interface{}

func (NetAppVolumeGroupOracleResource) Read 

func (r NetAppVolumeGroupOracleResource) Read() sdk.ResourceFunc

func (NetAppVolumeGroupOracleResource) ResourceType 

func (r NetAppVolumeGroupOracleResource) ResourceType() string

func (NetAppVolumeGroupOracleResource) Update 

func (r NetAppVolumeGroupOracleResource) Update() sdk.ResourceFunc

type NetAppVolumeGroupSAPHanaDataSource 

type NetAppVolumeGroupSAPHanaDataSource struct{}

func (NetAppVolumeGroupSAPHanaDataSource) Arguments 

func (r NetAppVolumeGroupSAPHanaDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupSAPHanaDataSource) Attributes 

func (r NetAppVolumeGroupSAPHanaDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupSAPHanaDataSource) IDValidationFunc 

func (r NetAppVolumeGroupSAPHanaDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeGroupSAPHanaDataSource) ModelObject 

func (r NetAppVolumeGroupSAPHanaDataSource) ModelObject() interface{}

func (NetAppVolumeGroupSAPHanaDataSource) Read 

func (r NetAppVolumeGroupSAPHanaDataSource) Read() sdk.ResourceFunc

func (NetAppVolumeGroupSAPHanaDataSource) ResourceType 

func (r NetAppVolumeGroupSAPHanaDataSource) ResourceType() string

type NetAppVolumeGroupSAPHanaResource 

type NetAppVolumeGroupSAPHanaResource struct{}

func (NetAppVolumeGroupSAPHanaResource) Arguments 

func (r NetAppVolumeGroupSAPHanaResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupSAPHanaResource) Attributes 

func (r NetAppVolumeGroupSAPHanaResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeGroupSAPHanaResource) Create 

func (r NetAppVolumeGroupSAPHanaResource) Create() sdk.ResourceFunc

func (NetAppVolumeGroupSAPHanaResource) Delete 

func (r NetAppVolumeGroupSAPHanaResource) Delete() sdk.ResourceFunc

func (NetAppVolumeGroupSAPHanaResource) IDValidationFunc 

func (r NetAppVolumeGroupSAPHanaResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeGroupSAPHanaResource) ModelObject 

func (r NetAppVolumeGroupSAPHanaResource) ModelObject() interface{}

func (NetAppVolumeGroupSAPHanaResource) Read 

func (r NetAppVolumeGroupSAPHanaResource) Read() sdk.ResourceFunc

func (NetAppVolumeGroupSAPHanaResource) ResourceType 

func (r NetAppVolumeGroupSAPHanaResource) ResourceType() string

func (NetAppVolumeGroupSAPHanaResource) Update 

func (r NetAppVolumeGroupSAPHanaResource) Update() sdk.ResourceFunc

type NetAppVolumeQuotaRuleDataSource 

type NetAppVolumeQuotaRuleDataSource struct{}

func (NetAppVolumeQuotaRuleDataSource) Arguments 

func (r NetAppVolumeQuotaRuleDataSource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeQuotaRuleDataSource) Attributes 

func (r NetAppVolumeQuotaRuleDataSource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeQuotaRuleDataSource) IDValidationFunc 

func (r NetAppVolumeQuotaRuleDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeQuotaRuleDataSource) ModelObject 

func (r NetAppVolumeQuotaRuleDataSource) ModelObject() interface{}

func (NetAppVolumeQuotaRuleDataSource) Read 

func (r NetAppVolumeQuotaRuleDataSource) Read() sdk.ResourceFunc

func (NetAppVolumeQuotaRuleDataSource) ResourceType 

func (r NetAppVolumeQuotaRuleDataSource) ResourceType() string

type NetAppVolumeQuotaRuleResource 

type NetAppVolumeQuotaRuleResource struct{}

func (NetAppVolumeQuotaRuleResource) Arguments 

func (r NetAppVolumeQuotaRuleResource) Arguments() map[string]*pluginsdk.Schema

func (NetAppVolumeQuotaRuleResource) Attributes 

func (r NetAppVolumeQuotaRuleResource) Attributes() map[string]*pluginsdk.Schema

func (NetAppVolumeQuotaRuleResource) Create 

func (r NetAppVolumeQuotaRuleResource) Create() sdk.ResourceFunc

func (NetAppVolumeQuotaRuleResource) Delete 

func (r NetAppVolumeQuotaRuleResource) Delete() sdk.ResourceFunc

func (NetAppVolumeQuotaRuleResource) IDValidationFunc 

func (r NetAppVolumeQuotaRuleResource) IDValidationFunc() pluginsdk.SchemaValidateFunc

func (NetAppVolumeQuotaRuleResource) ModelObject 

func (r NetAppVolumeQuotaRuleResource) ModelObject() interface{}

func (NetAppVolumeQuotaRuleResource) Read 

func (r NetAppVolumeQuotaRuleResource) Read() sdk.ResourceFunc

func (NetAppVolumeQuotaRuleResource) ResourceType 

func (r NetAppVolumeQuotaRuleResource) ResourceType() string

func (NetAppVolumeQuotaRuleResource) Update 

func (r NetAppVolumeQuotaRuleResource) Update() sdk.ResourceFunc

type Registration 

type Registration struct{}

func (Registration) AssociatedGitHubLabel 

func (r Registration) AssociatedGitHubLabel() string

func (Registration) DataSources 

func (r Registration) DataSources() []sdk.DataSource

DataSources returns the typed DataSources supported by this service

func (Registration) Name 

func (r Registration) Name() string

func (Registration) Resources 

func (r Registration) Resources() []sdk.Resource

Resources returns the typed Resources supported by this service

func (Registration) SupportedDataSources 

func (r Registration) SupportedDataSources() map[string]*pluginsdk.Resource

func (Registration) SupportedResources 

func (r Registration) SupportedResources() map[string]*pluginsdk.Resource

func (Registration) WebsiteCategories 

func (r Registration) WebsiteCategories() []string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.