Skip to content

Commit

Permalink
fix: update readme yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
mamrajyadav committed Jan 2, 2024
1 parent c9cc237 commit 57c4aeb
Showing 1 changed file with 37 additions and 39 deletions.
76 changes: 37 additions & 39 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,43 +36,41 @@ include:
# How to use this project
# yamllint disable rule:line-length
usage: |-
Here is an example of how you can use this module in your inventory structure:
### Basic Example
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = "testsg"
location = "NorthEurope"
address_space = "10.0.0.0/16"
enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed.
}
```
### Complete Example
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
address_space = "10.0.0.0/16"
enable_ddos_pp = false
enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed.
}
```
### vnet_with_existing_ddos_id Example
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
address_space = "10.0.0.0/16"
existing_ddos_pp = "/subscriptions/068245d4-3c94-42fe-9c4d-9e5e1cabc60c/resourceGroups/"
enable_network_watcher = false
}
```
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = "testsg"
location = "NorthEurope"
address_space = "10.0.0.0/16"
enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed.
}
```
### Complete Example
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
address_space = "10.0.0.0/16"
enable_ddos_pp = false
enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed.
}
```
### vnet_with_existing_ddos_id Example
```hcl
module "vnet" {
source = "clouddrove/vnet/azure"
name = local.name
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
address_space = "10.0.0.0/16"
existing_ddos_pp = "/subscriptions/068245d4-3c94-42fe-9c4d-9e5e1cabc60c/resourceGroups/"
enable_network_watcher = false
}
```

0 comments on commit 57c4aeb

Please sign in to comment.