Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@clouddrove-ci
clouddrove-ci committed Jan 26, 2024
1 parent d54ea1e commit eb2c666
Showing 1 changed file with 30 additions and 34 deletions.
64 changes: 30 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@

<p align="center">

<a href="https://www.terraform.io">
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
<a href="https://github.com/clouddrove/terraform-azure-bastion/releases/latest">
<img src="https://img.shields.io/github/release/clouddrove/terraform-azure-bastion.svg" alt="Latest Release">
</a>
<a href="https://github.com/clouddrove/terraform-azure-bastion/actions/workflows/tfsec.yml">
<img src="https://github.com/clouddrove/terraform-azure-bastion/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
</a>
<a href="LICENSE.md">
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
Expand Down Expand Up @@ -51,12 +54,6 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c

This module has a few dependencies:

- [Terraform 1.x.x](https://learn.hashicorp.com/terraform/getting-started/install.html)
- [Go](https://golang.org/doc/install)
- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)





Expand All @@ -71,18 +68,19 @@ This module has a few dependencies:
Here are some examples of how you can use this module in your inventory structure:
```hcl
module "bastion" {
source = "clouddrove/bastion/azure"
version = "1.0.0"
name = "app"
environment = "test"
resource_group_name = module.resource_group.resource_group_name
azure_bastion_subnet_address_prefix = ["10.0.5.0/24"]
virtual_network_name = module.virtual_network.vnet_name[0]
source = "clouddrove/bastion/azure"
version = "1.0.0"
name = "app"
environment = "test"
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
virtual_network_name = module.vnet.vnet_name[0]
subnet_id = module.name_specific_subnet.specific_subnet_id[0]
#### enable diagnostic setting
diagnostic_setting_enable = false
diagnostic_setting_enable = true
log_analytics_workspace_id = ""
}
}
```


Expand All @@ -94,39 +92,37 @@ Here are some examples of how you can use this module in your inventory structur

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| Metric\_enable | Is this Diagnostic Metric enabled? Defaults to true. | `bool` | `true` | no |
| azure\_bastion\_subnet\_address\_prefix | The address prefix to use for the Azure Bastion subnet | `list(any)` | `[]` | no |
| bastion\_host\_sku | The SKU of the Bastion Host. Accepted values are `Basic` and `Standard` | `string` | `"Basic"` | no |
| category | The name of a Diagnostic Log Category Group for this Resource. | `string` | `null` | no |
| ddos\_protection\_mode | The DDoS protection mode of the public IP | `string` | `"VirtualNetworkInherited"` | no |
| diagnostic\_log\_days | The number of days for which this Retention Policy should apply. | `number` | `"90"` | no |
| diagnostic\_setting\_enable | n/a | `bool` | `false` | no |
| ddos\_protection\_plan\_id | The ID of the DDoS protection plan associated with the Public IP | `string` | `null` | no |
| diagnostic\_setting\_enable | n/a | `bool` | `true` | no |
| domain\_name\_label | The domain name label for the Azure Bastion Service host. Leave empty for no label. | `string` | `null` | no |
| enable\_copy\_paste | Is Copy/Paste feature enabled for the Bastion Host? | `bool` | `true` | no |
| enable\_file\_copy | Is File Copy feature enabled for the Bastion Host. Only supported whne `sku` is `Standard` | `bool` | `false` | no |
| enable\_ip\_connect | Is IP Connect feature enabled for the Bastion Host? | `bool` | `false` | no |
| enable\_shareable\_link | Is Shareable Link feature enabled for the Bastion Host. Only supported whne `sku` is `Standard` | `bool` | `false` | no |
| enable\_tunneling | Is Tunneling feature enabled for the Bastion Host. Only supported whne `sku` is `Standard` | `bool` | `false` | no |
| enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
| eventhub\_authorization\_rule\_id | Specifies the ID of an Event Hub Namespace Authorization Rule used to send Diagnostics Data. | `string` | `null` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `"app-test"` | no |
| eventhub\_authorization\_rule\_id | Specifies the ID of an vent Hub Namespace Authorization Rule used to send Diagnostics Data. | `string` | `null` | no |
| eventhub\_name | Specifies the name of the Event Hub where Diagnostics Data should be sent. | `string` | `null` | no |
| label\_order | Label order, e.g. sequence of application name and environment `name`,`environment`,'attribute' [`webserver`,`qa`,`devops`,`public`,] . | `list(any)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no |
| location | A location the resources | `string` | `""` | no |
| label\_order | Label order, e.g. sequence of application name and environment `name`,`environment`,'attribute' [`webserver`,`qa`,`devops`,`public`,] . | `list(string)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no |
| location | A location the resources | `string` | `"Canada Central"` | no |
| log\_analytics\_destination\_type | Possible values are AzureDiagnostics and Dedicated, default to AzureDiagnostics. When set to Dedicated, logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table. | `string` | `"AzureDiagnostics"` | no |
| log\_analytics\_workspace\_id | n/a | `string` | `null` | no |
| log\_enabled | Is this Diagnostic Log enabled? Defaults to true. | `string` | `true` | no |
| managedby | ManagedBy, eg ''. | `string` | `""` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| managedby | ManagedBy, eg ''. | `string` | `"CloudDrove"` | no |
| metric\_enabled | Is this Diagnostic Metric enabled? Defaults to True. | `bool` | `true` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `"app"` | no |
| pip\_logs | n/a | <pre>object({<br> enabled = bool<br> category = optional(list(string))<br> category_group = optional(list(string))<br> })</pre> | <pre>{<br> "category_group": [<br> "AllLogs"<br> ],<br> "description": "Is this Diagnostic logs enabled? Defaults to True.",<br> "enabled": true<br>}</pre> | no |
| public\_ip\_allocation\_method | Defines the allocation method for this IP address. Possible values are Static or Dynamic | `string` | `"Static"` | no |
| public\_ip\_sku | The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic | `string` | `"Standard"` | no |
| repository | Terraform current module repo | `string` | `""` | no |
| resource\_group\_name | A container that holds related resources for an Azure solution | `string` | `""` | no |
| retention\_policy\_enabled | Is this Retention Policy enabled? | `bool` | `false` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-azure-bastion.git"` | no |
| resource\_group\_name | A container that holds related resources for an Azure solution | `string` | `null` | no |
| scale\_units | The number of scale units with which to provision the Bastion Host. Possible values are between `2` and `50`. `scale_units` only can be changed when `sku` is `Standard`. `scale_units` is always `2` when `sku` is `Basic`. | `number` | `2` | no |
| storage\_account\_id | The ID of the Storage Account where logs should be sent. | `string` | `null` | no |
| subnet\_id | The ID of the Subnet where this Network Interface should be located in. | `string` | `""` | no |
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(string)` | `{}` | no |
| virtual\_network\_name | The name of the virtual network | `string` | `""` | no |
| subnet\_id | The ID of the Subnet where this Network Interface should be located in. | `string` | `null` | no |
| zone | The Zone for the resources (e.g., `1`, `2`, `3`). | `string` | `null` | no |

## Outputs

Expand Down

0 comments on commit eb2c666

Please sign in to comment.