Skip to content

Commit ac136ed

Browse files
chore: Added a README for the simple router example (#23)
1 parent 4a88d5d commit ac136ed

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

examples/simple/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Simple Cloud Router
2+
3+
This example configures a single simple Cloud Router inside of a project.
4+
5+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6+
## Inputs
7+
8+
| Name | Description | Type | Default | Required |
9+
|------|-------------|------|---------|:--------:|
10+
| network | A reference to the network to which this router belongs | `string` | n/a | yes |
11+
| project | The GCP project ID | `string` | n/a | yes |
12+
13+
## Outputs
14+
15+
| Name | Description |
16+
|------|-------------|
17+
| router\_name | The name of the created router |
18+
| router\_region | The region of the created router |
19+
20+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
21+
22+

0 commit comments

Comments
 (0)