Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebastianczech
sebastianczech committed Apr 9, 2024
1 parent 5fb8837 commit 0b4ac8a
Showing 1 changed file with 58 additions and 27 deletions.
85 changes: 58 additions & 27 deletions examples/common_vmseries/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ Name | Type | Description
[`name_prefix`](#name_prefix) | `string` | A prefix that will be added to all created resources.
[`create_resource_group`](#create_resource_group) | `bool` | When set to `true` it will cause a Resource Group creation.
[`tags`](#tags) | `map` | Map of tags to assign to the created resources.
[`vnet_peerings`](#vnet_peerings) | `map` | A map defining VNET peerings.
[`natgws`](#natgws) | `map` | A map defining NAT Gateways.
[`load_balancers`](#load_balancers) | `map` | A map containing configuration for all (both private and public) Load Balancers.
[`appgws`](#appgws) | `map` | A map defining all Application Gateways in the current deployment.
Expand Down Expand Up @@ -244,6 +245,7 @@ Name | Version | Source | Description
`bootstrap` | - | ../../modules/bootstrap |
`vmseries` | - | ../../modules/vmseries |
`test_infrastructure` | - | ../../modules/test_infrastructure |
`vnet_peering` | - | ../../modules/vnet_peering |


Resources used in this module:
Expand Down Expand Up @@ -281,7 +283,7 @@ Type: string
#### vnets

A map defining VNETs.

For detailed documentation on each property refer to [module documentation](../../modules/vnet/README.md)

- `create_virtual_network` - (`bool`, optional, defaults to `true`) when set to `true` will create a VNET, `false` will source
Expand Down Expand Up @@ -361,6 +363,7 @@ map(object({




### Optional Inputs


Expand All @@ -374,7 +377,7 @@ Example:
```
name_prefix = "test-"
```

**Note!** \
This prefix is not applied to existing resources. If you plan to reuse i.e. a VNET please specify it's full name,
even if it is also prefixed with the same value as the one in this property.
Expand All @@ -390,7 +393,7 @@ Default value: ``
When set to `true` it will cause a Resource Group creation.
Name of the newly specified RG is controlled by `resource_group_name`.
When set to `false` the `resource_group_name` parameter is used to specify a name of an existing Resource Group.
Expand All @@ -413,14 +416,41 @@ Default value: `map[]`
<sup>[back to list](#modules-optional-inputs)</sup>
#### vnet_peerings
A map defining VNET peerings.
Following properties are supported:
- `local_vnet_name` - (`string`, required) - name of the local VNET
- `local_resource_group_name` - (`string`, optional) - name of the resource group, in which local VNET exists
- `remote_vnet_name` - (`string`, required) - name of the remote VNET
- `remote_resource_group_name` - (`string`, optional) - name of the resource group, in which remote VNET exists
Type:
```hcl
map(object({
local_vnet_name = string
local_resource_group_name = optional(string)
remote_vnet_name = string
remote_resource_group_name = optional(string)
}))
```
Default value: `map[]`
<sup>[back to list](#modules-optional-inputs)</sup>
#### natgws
A map defining NAT Gateways.
A map defining NAT Gateways.
Please note that a NAT Gateway is a zonal resource, this means it's always placed in a zone (even when you do not specify one
explicitly). Please refer to Microsoft documentation for notes on NAT Gateway's zonal resiliency.
For detailed documentation on each property refer to [module documentation](../../modules/natgw/README.md).
Following properties are supported:
- `name` - (`string`, required) a name of a NAT Gateway. In case `create_natgw = false` this should be a full
resource name, including prefixes.
Expand Down Expand Up @@ -506,8 +536,8 @@ Following properties are available:
- `nsg_auto_rules_settings` - (`map`, optional, defaults to `null`) a map defining a location of an existing NSG rule that will
be populated with `Allow` rules for each load balancing rule (`in_rules`), please refer to
[module documentation](../../modules/loadbalancer/README.md#nsg_auto_rules_settings) for
available properties.
available properties.

Please note that in this example two additional properties are available:

- `nsg_vnet_key` - (`string`, optional, mutually exclusive with `nsg_name`) a key pointing to a VNET definition in the
Expand Down Expand Up @@ -592,7 +622,7 @@ For detailed documentation on how to configure this resource, for available prop
refer to [module documentation](../../modules/appgw/README.md).

**Note!** \
The `rules` property is meant to bind together `backend_setting`, `redirect` or `url_path_map` (all 3 are mutually exclusive).
The `rules` property is meant to bind together `backend_setting`, `redirect` or `url_path_map` (all 3 are mutually exclusive).
It represents the Rules section of an Application Gateway in Azure Portal.

Below you can find a brief list of most important properties:
Expand All @@ -614,11 +644,11 @@ Below you can find a brief list of most important properties:
settings, see [module's documentation](../../modules/appgw/README.md#backend_settings) for details.
- `probes` - (`map`, optional, defaults to module default) defines backend probes used check health of backends, see
[module's documentation](../../modules/appgw/README.md#probes) for details.
- `rewrites` - (`map`, optional, defaults to module default) defines rewrite rules, see
- `rewrites` - (`map`, optional, defaults to module default) defines rewrite rules, see
[module's documentation](../../modules/appgw/README.md#rewrites) for details.
- `redirects` - (`map`, optional, mutually exclusive with `backend_settings` and `url_path_maps`) static redirects
- `redirects` - (`map`, optional, mutually exclusive with `backend_settings` and `url_path_maps`) static redirects
definition, see [module's documentation](../../modules/appgw/README.md#redirects) for details.
- `url_path_maps` - (`map`, optional, mutually exclusive with `backend_settings` and `redirects`) URL path maps definition,
- `url_path_maps` - (`map`, optional, mutually exclusive with `backend_settings` and `redirects`) URL path maps definition,
see [module's documentation](../../modules/appgw/README.md#url_path_maps) for details.
- `rules` - (`map`, required) Application Gateway Rules definition, bind together a `listener` with either
`backend_setting`, `redirect` or `url_path_map`, see
Expand Down Expand Up @@ -766,7 +796,7 @@ Following properties are supported:
- `name` - (`string`, required) name of the Application Insights.
- `update_domain_count` - (`number`, optional, defaults to Azure default) specifies the number of update domains that are used.
- `fault_domain_count` - (`number`, optional, defaults to Azure default) specifies the number of fault domains that are used.
**Note!** \
Please keep in mind that Azure defaults are not working for every region (especially the small ones, without any Availability
Zones). Please verify how many update and fault domain are supported in a region before deploying this resource.
Expand Down Expand Up @@ -847,7 +877,7 @@ You can create or re-use an existing Storage Account and/or File Share. For deta
will host (created) a Storage Account. When skipped the code will fall back to
`var.resource_group_name`.
- `storage_account` - (`map`, optional, defaults to `{}`) a map controlling basic Storage Account configuration.

The property you should pay attention to is:

- `create` - (`bool`, optional, defaults to module default) controls if the Storage Account specified in the `name` property
Expand All @@ -856,8 +886,8 @@ You can create or re-use an existing Storage Account and/or File Share. For deta
For detailed documentation see [module's documentation](../../modules/bootstrap/README.md#storage_account).
- `storage_network_security` - (`map`, optional, defaults to `{}`) a map defining network security settings for a **new**
storage account.
storage account.
The properties you should pay attention to are:
- `allowed_subnet_keys` - (`list`, optional, defaults to `[]`) a list of keys pointing to Subnet definitions in the
Expand All @@ -867,9 +897,9 @@ You can create or re-use an existing Storage Account and/or File Share. For deta
Subnets described in `allowed_subnet_keys`.
For detailed documentation see [module's documentation](../../modules/bootstrap/README.md#storage_network_security).

- `file_shares_configuration` - (`map`, optional, defaults to `{}`) a map defining common File Share setting.

The properties you should pay attention to are:

- `create_file_shares` - (`bool`, optional, defaults to module default) controls if the File Shares defined in the
Expand Down Expand Up @@ -943,7 +973,7 @@ The most basic properties are as follows:

**Note!** \
The `disable_password_authentication` property is by default `false` in this example. When using this value, you don't have
to specify anything but you can still additionally pass SSH keys for authentication. You can however set this property to
to specify anything but you can still additionally pass SSH keys for authentication. You can however set this property to
`true`, then you have to specify `ssh_keys` property.
For all properties and their default values see [module's documentation](../../modules/vmseries/README.md#authentication).
Expand All @@ -956,7 +986,7 @@ The most basic properties are as follows:

For details on all properties refer to [module's documentation](../../modules/vmseries/README.md#image).
- `virtual_machine` - (`map`, optional, defaults to module default) a map that groups most common VM configuration options.
- `virtual_machine` - (`map`, optional, defaults to module default) a map that groups most common VM configuration options.
Most common properties are:
- `size` - (`string`, optional, defaults to module default) Azure VM size (type). Consult the *VM-Series
Expand Down Expand Up @@ -1016,7 +1046,7 @@ The most basic properties are as follows:
- `intranet_cidr` - (`string`, optional, defaults to `null`) a CIDR of the Intranet - combined CIDR of all
private networks. When set it will override the private Subnet CIDR for inbound traffic
static routes.

For details on all properties refer to [module's documentation](../../modules/panorama/README.md#virtual_machine).
- `interfaces` - (`list`, required) configuration of all network interfaces. Order of the interfaces does matter - the
Expand Down Expand Up @@ -1109,13 +1139,13 @@ For details and defaults for available options please refer to the

Following properties are supported:

- `create_resource_group` - (`bool`, optional, defaults to `true`) when set to `true`, a new Resource Group is created. When
- `create_resource_group` - (`bool`, optional, defaults to `true`) when set to `true`, a new Resource Group is created. When
set to `false`, an existing Resource Group is sourced.
- `resource_group_name` - (`string`, optional) name of the Resource Group to be created or sourced.
- `vnets` - (`map`, required) a map defining VNETs and peerings for the test environment. The most basic
properties are as follows:

- `create_virtual_network` - (`bool`, optional, defaults to `true`) when set to `true` will create a VNET,
- `create_virtual_network` - (`bool`, optional, defaults to `true`) when set to `true` will create a VNET,
`false` will source an existing VNET.
- `name` - (`string`, required) a name of a VNET. In case `create_virtual_network = `false` this should be
a full resource name, including prefixes.
Expand All @@ -1131,7 +1161,7 @@ Following properties are supported:
[VNET module documentation](../../modules/vnet/README.md#route_tables).
For all properties and their default values see [module's documentation](../../modules/test_infrastructure/README.md#vnets).
- `load_balancers` - (`map`, optional) a map containing configuration for all (both private and public) Load Balancers.
The most basic properties are as follows:
Expand All @@ -1148,8 +1178,8 @@ Following properties are supported:
- `nsg_auto_rules_settings` - (`map`, optional, defaults to `null`) a map defining a location of an existing NSG rule that
will be populated with `Allow` rules for each load balancing rule (`in_rules`), please refer to
[loadbalancer module documentation](../../modules/loadbalancer/README.md#nsg_auto_rules_settings)
for available properties.
for available properties.
Please note that in this example two additional properties are available:
- `nsg_vnet_key` - (`string`, optional, mutually exclusive with `nsg_name`) a key pointing to a VNET definition in the
Expand Down Expand Up @@ -1180,10 +1210,10 @@ Following properties are supported:
For all properties and their default values see
[module's documentation](../../modules/test_infrastructure/README.md#test_vms).
- `bastions` - (`map`, required) a map containing Azure Bastion definitions. The most basic properties are as
follows:
- `name` - (`string`, required) an Azure Bastion name.
- `vnet_key` - (`string`, required) a key describing a VNET defined in `vnets` property. This VNET should already have an
existing subnet called `AzureBastionSubnet` (the name is hardcoded by Microsoft).
Expand Down Expand Up @@ -1326,4 +1356,5 @@ Default value: `map[]`
<sup>[back to list](#modules-optional-inputs)</sup>
<!-- END_TF_DOCS -->

0 comments on commit 0b4ac8a

Please sign in to comment.