Skip to content

docs(document): update the README content #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
# The Terraform module of HUAWEI Cloud VPN service

What capabilities does the current Module provide:
What capabilities does the current module provide:

+ One-click deployment of VPN resources.
+ Flexible VPN resource combination (through multiple VPN sub-modules)
+ Abundant example references, one-click deployment of VPN resources.

## Notes

If you want to manage VPN resources using Terraform module (via this repository), you need to make the following
declaration in the `source` of the script.

```hcl
# Use the latest version.
module "vpn_gateway" {
source = "github.com/terraform-huaweicloud-modules/terraform-huaweicloud-vpn/modules/vpn-gateway"

...
}
```

## Contributing

Expand All @@ -18,14 +33,18 @@ Full contributing [guidelines are covered here](.github/how_to_contribute.md).
| Terraform | >= 1.3.0 |
| Huaweicloud Provider | >= 1.73.0 |

## Modules

No module.

## Resources

No resources
No resource.

## Inputs

No inputs
No input

## Outputs

No outputs
No output
4 changes: 2 additions & 2 deletions examples/cross-region-connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Run `terraform destroy` when you don't need these resources.

## Resources

No resources.
No resource.

## Inputs

Expand Down Expand Up @@ -70,4 +70,4 @@ No resources.

## Outputs

No outputs.
No output.
2 changes: 1 addition & 1 deletion examples/simple-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Run `terraform destroy` when you don't need these resources.

## Resources

No resources.
No resource.

## Inputs

Expand Down
4 changes: 4 additions & 0 deletions modules/vpn-connection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
| Terraform | >= 1.3.0 |
| Huaweicloud Provider | >= 1.73.0 |

## Modules

No module.

## Resources

| Name | Type |
Expand Down
4 changes: 4 additions & 0 deletions modules/vpn-customer-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
| Terraform | >= 1.3.0 |
| Huaweicloud Provider | >= 1.73.0 |

## Modules

No module.

## Resources

| Name | Type |
Expand Down
4 changes: 4 additions & 0 deletions modules/vpn-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
| Terraform | >= 1.3.0 |
| Huaweicloud Provider | >= 1.73.0 |

## Modules

No module.

## Resources

| Name | Type |
Expand Down