Skip to content

Commit 378a04a

Browse files
committed
removing provider configuration dependency
1 parent b221083 commit 378a04a

File tree

1 file changed

+10
-47
lines changed

1 file changed

+10
-47
lines changed

README.md

+10-47
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
Terraform Module to create an Azure storage account with a set of containers (and access level), set of file shares (and quota), tables, queues, Network policies and Blob lifecycle management.
44

5-
To defines the kind of account, set the argument to `account_kind = "StorageV2"`. Account kind defaults to `StorageV2`. If you want to change this value to other storage accounts kind, then this module automatically computes the appropriate values for `account_tier`, `account_replication_type`. The valid options are `BlobStorage`, `BlockBlobStorage`, `FileStorage`, `Storage` and `StorageV2`.
5+
To defines the kind of account, set the argument to `account_kind = "StorageV2"`. Account kind defaults to `StorageV2`. If you want to change this value to other storage accounts kind, then this module automatically computes the appropriate values for `account_tier`, `account_replication_type`. The valid options are `BlobStorage`, `BlockBlobStorage`, `FileStorage`, `Storage` and `StorageV2`. `static_website` can only be set when the account_kind is set to `StorageV2`.
66

7-
>Note: *static_website can only be set when the account_kind is set to `StorageV2`.*
7+
> **[NOTE]**
8+
> **This module now supports the meta arguments including `providers`, `depends_on`, `count`, and `for_each`.**
89
9-
These types of resources are supported:
10+
## resources are supported:
1011

1112
* [Storage Account](https://www.terraform.io/docs/providers/azurerm/r/storage_account.html)
1213
* [Storage Advanced Threat Protection](https://www.terraform.io/docs/providers/azurerm/r/advanced_threat_protection.html)
@@ -70,11 +71,11 @@ module "storage" {
7071
}
7172
```
7273

73-
## Create resource group
74+
### Resource Group
7475

7576
By default, this module will not create a resource group and the name of an existing resource group to be given in an argument `resource_group_name`. If you want to create a new resource group, set the argument `create_resource_group = true`.
7677

77-
>*If you are using an existing resource group, then this module uses the same resource group location to create all resources in this module.*
78+
*If you are using an existing resource group, then this module uses the same resource group location to create all resources in this module.*
7879

7980
## BlockBlobStorage accounts
8081

@@ -181,52 +182,14 @@ module "storage" {
181182

182183
## Recommended naming and tagging conventions
183184

184-
Well-defined naming and metadata tagging conventions help to quickly locate and manage resources. These conventions also help associate cloud usage costs with business teams via chargeback and show back accounting mechanisms.
185+
Applying tags to your Azure resources, resource groups, and subscriptions to logically organize them into a taxonomy. Each tag consists of a name and a value pair. For example, you can apply the name `Environment` and the value `Production` to all the resources in production.
186+
For recommendations on how to implement a tagging strategy, see Resource naming and tagging decision guide.
185187

186-
> ### Resource naming
188+
>**Important** :
189+
Tag names are case-insensitive for operations. A tag with a tag name, regardless of the casing, is updated or retrieved. However, the resource provider might keep the casing you provide for the tag name. You'll see that casing in cost reports. **Tag values are case-sensitive.**
187190

188191
An effective naming convention assembles resource names by using important resource information as parts of a resource's name. For example, using these [recommended naming conventions](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging#example-names), a public IP resource for a production SharePoint workload is named like this: `pip-sharepoint-prod-westus-001`.
189192

190-
> ### Metadata tags
191-
192-
When applying metadata tags to the cloud resources, you can include information about those assets that couldn't be included in the resource name. You can use that information to perform more sophisticated filtering and reporting on resources. This information can be used by IT or business teams to find resources or generate reports about resource usage and billing.
193-
194-
The following list provides the recommended common tags that capture important context and information about resources. Use this list as a starting point to establish your tagging conventions.
195-
196-
Tag Name|Description|Key|Example Value|Required?
197-
--------|-----------|---|-------------|---------|
198-
Project Name|Name of the Project for the infra is created. This is mandatory to create a resource names.|ProjectName|{Project name}|Yes
199-
Application Name|Name of the application, service, or workload the resource is associated with.|ApplicationName|{app name}|Yes
200-
Approver|Name Person responsible for approving costs related to this resource.|Approver|{email}|Yes
201-
Business Unit|Top-level division of your company that owns the subscription or workload the resource belongs to. In smaller organizations, this may represent a single corporate or shared top-level organizational element.|BusinessUnit|FINANCE, MARKETING,{Product Name},CORP,SHARED|Yes
202-
Cost Center|Accounting cost center associated with this resource.|CostCenter|{number}|Yes
203-
Disaster Recovery|Business criticality of this application, workload, or service.|DR|Mission Critical, Critical, Essential|Yes
204-
Environment|Deployment environment of this application, workload, or service.|Env|Prod, Dev, QA, Stage, Test|Yes
205-
Owner Name|Owner of the application, workload, or service.|Owner|{email}|Yes
206-
Requester Name|User that requested the creation of this application.|Requestor| {email}|Yes
207-
Service Class|Service Level Agreement level of this application, workload, or service.|ServiceClass|Dev, Bronze, Silver, Gold|Yes
208-
Start Date of the project|Date when this application, workload, or service was first deployed.|StartDate|{date}|No
209-
End Date of the Project|Date when this application, workload, or service is planned to be retired.|EndDate|{date}|No
210-
211-
> This module allows you to manage the above metadata tags directly or as a variable using `variables.tf`. All Azure resources which support tagging can be tagged by specifying key-values in argument `tags`. Tag `ResourceName` is added automatically to all resources.
212-
213-
```hcl
214-
module "key-vault" {
215-
source = "kumarvna/storage/azurerm"
216-
version = "2.2.0"
217-
218-
# ... omitted
219-
220-
tags = {
221-
ProjectName = "demo-project"
222-
Env = "dev"
223-
224-
BusinessUnit = "CORP"
225-
ServiceClass = "Gold"
226-
}
227-
}
228-
```
229-
230193
## Requirements
231194

232195
| Name | Version |

0 commit comments

Comments
 (0)