@@ -23,7 +23,6 @@ Terraform module to provision an openvpn instance.
2323This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:
2424
2525- [ gomplate] ( https://github.com/hairyhenderson/gomplate )
26- - [ Docker] ( https://www.docker.com )
2726- [ python] ( https://www.python.org )
2827- [ taskfile] ( https://github.com/go-task/task )
2928
@@ -57,7 +56,6 @@ Full working examples can be found in [examples](./examples) folder.
5756<!-- Space: Projects -->
5857<!-- Parent: TerraformAwsOpenVpn -->
5958<!-- Title: Examples TerraformAwsOpenVpn -->
60-
6159<!-- Label: Examples -->
6260<!-- Include: ./../disclaimer.md -->
6361<!-- Include: ac:toc -->
@@ -84,28 +82,29 @@ Full working examples can be found in [examples](./examples) folder.
8482
8583```
8684
87- <!-- BEGIN_TF_DOCS -->
85+ <!-- markdown-link-check-disable -->
86+ <!-- BEGIN_TF_DOCS -->
8887
8988## Requirements
9089
91- | Name | Version |
92- | ------------------------------------------------------------------------ | ----------------- |
93- | < a name = " requirement_terraform " ></ a > [ terraform] ( #requirement_terraform ) | >= 0.12.20, < 2.0 |
94- | < a name = " requirement_aws " ></ a > [ aws] ( #requirement_aws ) | >=3.2.0 |
95- | < a name = " requirement_null " ></ a > [ null] ( #requirement_null ) | >=0.1.0 |
90+ | Name | Version |
91+ | --------- | ----------------- |
92+ | terraform | >= 0.12.20, < 2.0 |
93+ | aws | >=3.2.0 |
94+ | null | >=0.1.0 |
9695
9796## Providers
9897
99- | Name | Version |
100- | --------------------------------------------------- | ------- |
101- | < a name = " provider_aws " ></ a > [ aws] ( #provider_aws ) | >=3.2.0 |
102- | < a name = " provider_null " ></ a > [ null] ( #provider_null ) | >=0.1.0 |
98+ | Name | Version |
99+ | ---- | ------- |
100+ | aws | >=3.2.0 |
101+ | null | >=0.1.0 |
103102
104103## Modules
105104
106- | Name | Source | Version |
107- | ----------------------------------------------- | ------------------- | ------- |
108- | < a name = " module_tags " ></ a > [ tags] ( #module_tags ) | hadenlabs/tags/null | >0.1 |
105+ | Name | Source | Version |
106+ | ---- | ------------------- | ------- |
107+ | tags | hadenlabs/tags/null | >0.1 |
109108
110109## Resources
111110
@@ -132,33 +131,34 @@ Full working examples can be found in [examples](./examples) folder.
132131
133132| Name | Description | Type | Default | Required |
134133| --- | --- | --- | --- | :-: |
135- | < a name = " input_admin_user " ></ a > [ admin_user] ( #input_admin_user ) | admin user | ` string ` | ` "openvpn" ` | no |
136- | < a name = " input_environment " ></ a > [ environment] ( #input_environment ) | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | ` string ` | ` null ` | no |
137- | < a name = " input_instance_type " ></ a > [ instance_type] ( #input_instance_type ) | type instance | ` string ` | ` "t2.micro" ` | no |
138- | < a name = " input_is_test " ></ a > [ is_test] ( #input_is_test ) | implement when is execute a test | ` bool ` | ` false ` | no |
139- | < a name = " input_name " ></ a > [ name ] ( #input_name ) | Solution name, e.g. 'app' or 'jenkins' | ` string ` | n/a | yes |
140- | < a name = " input_namespace " ></ a > [ namespace] ( #input_namespace ) | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | ` string ` | ` null ` | no |
141- | < a name = " input_private_key " ></ a > [ private_key] ( #input_private_key ) | private key | ` string ` | n/a | yes |
142- | < a name = " input_public_key " ></ a > [ public_key] ( #input_public_key ) | public key | ` string ` | n/a | yes |
143- | < a name = " input_rules_ingress " ></ a > [ rules_ingress] ( #input_rules_ingress ) | list rule for security group | <pre >list(object({<br > from_port = number<br > to_port = number<br > protocol = string<br > cidr_blocks = list(string)<br > }))</pre > | ` [] ` | no |
144- | < a name = " input_ssh_cidr " ></ a > [ ssh_cidr] ( #input_ssh_cidr ) | ssh cidr | ` string ` | ` "0.0.0.0/0" ` | no |
145- | < a name = " input_ssh_port " ></ a > [ ssh_port] ( #input_ssh_port ) | port ssh | ` number ` | ` 22 ` | no |
146- | < a name = " input_ssh_user " ></ a > [ ssh_user] ( #input_ssh_user ) | user ssh | ` string ` | ` "ubuntu" ` | no |
147- | < a name = " input_stage " ></ a > [ stage] ( #input_stage ) | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | ` string ` | ` null ` | no |
148- | < a name = " input_storage_path " ></ a > [ storage_path] ( #input_storage_path ) | storage path keys to local | ` string ` | ` "~/openvpn" ` | no |
149- | < a name = " input_subnet_cidr_block " ></ a > [ subnet_cidr_block] ( #input_subnet_cidr_block ) | subnet cidr block | ` string ` | ` "10.0.0.0/16" ` | no |
150- | < a name = " input_tags " ></ a > [ tags] ( #input_tags ) | Additional tags (e.g. ` map('BusinessUnit','XYZ') ` | ` map(string) ` | ` {} ` | no |
151- | < a name = " input_vpc_cidr_block " ></ a > [ vpc_cidr_block] ( #input_vpc_cidr_block ) | vpc cidr block | ` string ` | ` "10.0.0.0/16" ` | no |
134+ | admin_user | admin user | ` string ` | ` "openvpn" ` | no |
135+ | environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | ` string ` | ` null ` | no |
136+ | instance_type | type instance | ` string ` | ` "t2.micro" ` | no |
137+ | is_test | implement when is execute a test | ` bool ` | ` false ` | no |
138+ | name | Solution name, e.g. 'app' or 'jenkins' | ` string ` | n/a | yes |
139+ | namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | ` string ` | ` null ` | no |
140+ | private_key | private key | ` string ` | n/a | yes |
141+ | public_key | public key | ` string ` | n/a | yes |
142+ | rules_ingress | list rule for security group | <pre >list(object({<br / > from_port = number<br / > to_port = number<br / > protocol = string<br / > cidr_blocks = list(string)<br / > }))</pre > | ` [] ` | no |
143+ | ssh_cidr | ssh cidr | ` string ` | ` "0.0.0.0/0" ` | no |
144+ | ssh_port | port ssh | ` number ` | ` 22 ` | no |
145+ | ssh_user | user ssh | ` string ` | ` "ubuntu" ` | no |
146+ | stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | ` string ` | ` null ` | no |
147+ | storage_path | storage path keys to local | ` string ` | ` "~/openvpn" ` | no |
148+ | subnet_cidr_block | subnet cidr block | ` string ` | ` "10.0.0.0/16" ` | no |
149+ | tags | Additional tags (e.g. ` map('BusinessUnit','XYZ') ` | ` map(string) ` | ` {} ` | no |
150+ | vpc_cidr_block | vpc cidr block | ` string ` | ` "10.0.0.0/16" ` | no |
152151
153152## Outputs
154153
155- | Name | Description |
156- | -------------------------------------------------------------------- | ----------------------------------------- |
157- | < a name = " output_instance " ></ a > [ instance] ( #output_instance ) | return instance openvpn |
158- | < a name = " output_instance_ip " ></ a > [ instance_ip] ( #output_instance_ip ) | return instance openvpn elastic ip public |
159- | < a name = " output_private_key " ></ a > [ private_key] ( #output_private_key ) | return filepath privatekey |
154+ | Name | Description |
155+ | ----------- | ----------------------------------------- |
156+ | instance | return instance openvpn |
157+ | instance_ip | return instance openvpn elastic ip public |
158+ | private_key | return filepath privatekey |
160159
161160<!-- END_TF_DOCS -->
161+ <!-- markdown-link-check-enable -->
162162
163163## Help
164164
@@ -187,7 +187,7 @@ Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following co
187187
188188## Copyright
189189
190- Copyright © 2018-2022 [ Hadenlabs] ( https://hadenlabs.com )
190+ Copyright © 2018-2025 [ Hadenlabs] ( https://hadenlabs.com )
191191
192192## Trademarks
193193
0 commit comments