Skip to content

Commit 38fbf6f

Browse files
committed
updating examples for version 2.2.0
1 parent aff103d commit 38fbf6f

File tree

1 file changed

+4
-45
lines changed

1 file changed

+4
-45
lines changed

README.md

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -269,55 +269,14 @@ module "vmscaleset" {
269269

270270
## Recommended naming and tagging conventions
271271

272-
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.
272+
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.
273+
For recommendations on how to implement a tagging strategy, see Resource naming and tagging decision guide.
273274

274-
### Resource naming
275+
>**Important** :
276+
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.**
275277

276278
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`.
277279

278-
> ### Metadata tags
279-
280-
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.
281-
282-
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.
283-
284-
Tag Name|Description|Key|Example Value|Required?
285-
--------|-----------|---|-------------|---------|
286-
Project Name|Name of the Project for the infra is created. This is mandatory to create a resource names.|ProjectName|{Project name}|Yes
287-
Application Name|Name of the application, service, or workload the resource is associated with.|ApplicationName|{app name}|Yes
288-
Approver|Name Person responsible for approving costs related to this resource.|Approver|{email}|Yes
289-
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
290-
Cost Center|Accounting cost center associated with this resource.|CostCenter|{number}|Yes
291-
Disaster Recovery|Business criticality of this application, workload, or service.|DR|Mission Critical, Critical, Essential|Yes
292-
Environment|Deployment environment of this application, workload, or service.|Env|Prod, Dev, QA, Stage, Test|Yes
293-
Owner Name|Owner of the application, workload, or service.|Owner|{email}|Yes
294-
Requester Name|User that requested the creation of this application.|Requestor| {email}|Yes
295-
Service Class|Service Level Agreement level of this application, workload, or service.|ServiceClass|Dev, Bronze, Silver, Gold|Yes
296-
Start Date of the project|Date when this application, workload, or service was first deployed.|StartDate|{date}|No
297-
End Date of the Project|Date when this application, workload, or service is planned to be retired.|EndDate|{date}|No
298-
299-
> This module allows you to manage the above metadata tags directly or as an 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.
300-
301-
```hcl
302-
module "vmscaleset" {
303-
source = "kumarvna/vm-scale-sets/azurerm"
304-
version = "2.2.0"
305-
306-
# Resource Group, location, VNet and Subnet details
307-
resource_group_name = "rg-hub-tieto-internal-shared-westeurope-001"
308-
309-
# ... omitted
310-
311-
tags = {
312-
ProjectName = "demo-internal"
313-
Env = "dev"
314-
315-
BusinessUnit = "CORP"
316-
ServiceClass = "Gold"
317-
}
318-
}
319-
```
320-
321280
## Requirements
322281

323282
Name | Version

0 commit comments

Comments
 (0)