generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.yaml
55 lines (46 loc) · 1.65 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name : Terraform AZURE BASTION
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-bastion
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/terraform-azure-bastion.svg"
url: "https://github.com/clouddrove/terraform-azure-bastion/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-azure-bastion/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-azure-bastion/actions/workflows/tfsec.yml"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
# description of this project
description: |-
Terraform module to create bastion resource on AZURE.
# extra content
include:
- "terraform.md"
# How to use this project
usage: |-
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
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 = true
log_analytics_workspace_id = ""
}
```