Skip to content

Commit

Permalink
chore(docs): update documentation for #404
Browse files Browse the repository at this point in the history
  • Loading branch information
villevsv-upcloud authored and github-actions[bot] committed Oct 16, 2023
1 parent dbe911b commit 604bf98
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/resources/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Network gateways connect SDN Private Networks to external IP networks.
// Create router for the gateway
resource "upcloud_router" "this" {
name = "gateway-example-router"
# UpCloud Network Gateway Service will add a static route to this router to ensure gateway networking is working as intended.
# You need to ignore changes to it, otherwise TF will attempt to remove the static routes on subsequent applies
lifecycle {
ignore_changes = [static_route]
}
}
// Create network for the gateway
Expand Down
16 changes: 16 additions & 0 deletions docs/resources/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,28 @@ resource "upcloud_router" "my_example_router" {

- `name` (String) Name of the router

### Optional

- `static_route` (Block Set) A collection of static routes for this router (see [below for nested schema](#nestedblock--static_route))

### Read-Only

- `attached_networks` (List of String) A collection of UUID representing networks attached to this router
- `id` (String) The ID of this resource.
- `type` (String) The type of router

<a id="nestedblock--static_route"></a>
### Nested Schema for `static_route`

Required:

- `nexthop` (String) Next hop address. NOTE: For static route to be active the next hop has to be an address of a reachable running Cloud Server in one of the Private Networks attached to the router.
- `route` (String) Destination prefix of the route.

Optional:

- `name` (String) Name or description of the route.

## Import

Import is supported using the following syntax:
Expand Down

0 comments on commit 604bf98

Please sign in to comment.