Skip to content
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

feat(vpcgw): add data source pat rules #1093

Merged
merged 6 commits into from
Feb 15, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/data-sources/vpc_public_gateway_pat_rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
page_title: "Scaleway: scaleway_vpc_public_gateway_pat_rule"
description: |- Get information about Scaleway VPC Public Gateway PAT rule.
---

# scaleway_vpc_public_gateway_pat_rule

Gets information about a public gateway PAT rule. For further information please check the
API [documentation](https://developers.scaleway.com/en/products/vpc-gw/api/v1/#get-8faeea)

## Example Usage

```hcl
resource scaleway_vpc_public_gateway pg01 {
type = "VPC-GW-S"
}

resource scaleway_vpc_public_gateway_dhcp dhcp01 {
subnet = "192.168.1.0/24"
}

resource scaleway_vpc_private_network pn01 {
name = "pn_test_network"
}

resource scaleway_vpc_gateway_network gn01 {
gateway_id = scaleway_vpc_public_gateway.pg01.id
private_network_id = scaleway_vpc_private_network.pn01.id
dhcp_id = scaleway_vpc_public_gateway_dhcp.dhcp01.id
depends_on = [scaleway_vpc_private_network.pn01]
cleanup_dhcp = true
enable_masquerade = true
}

resource scaleway_vpc_public_gateway_pat_rule main {
gateway_id = scaleway_vpc_public_gateway.pg01.id
private_ip = scaleway_vpc_public_gateway_dhcp.dhcp01.address
private_port = 42
public_port = 42
protocol = "both"
depends_on = [scaleway_vpc_gateway_network.gn01, scaleway_vpc_private_network.pn01]
}

data "scaleway_vpc_public_gateway_pat_rule" "main" {
pat_rule_id = "${scaleway_vpc_public_gateway_pat_rule.main.id}"
}
```

## Argument Reference

- `pat_rule_id` (Required) The ID of the PAT rule to retrieve
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which
the image exists.

## Attributes Reference

`id` is set to the ID of the found public gateway PAT RULE.

The following arguments are exported:

- `gateway_id` - The ID of the public gateway.
- `private_ip` - The Private IP to forward data to (IP address).
- `public_port` - The Public port to listen on.
- `private_port` - The Private port to translate to.
- `protocol` - The Protocol the rule should apply to. Possible values are both, tcp and udp.
54 changes: 54 additions & 0 deletions scaleway/data_source_vpc_public_gateway_pat_rule.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package scaleway

import (
"context"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/scaleway/scaleway-sdk-go/api/vpcgw/v1"
"github.com/scaleway/scaleway-sdk-go/scw"
)

func dataSourceScalewayVPCPublicGatewayPATRule() *schema.Resource {
// Generate datasource schema from resource
dsSchema := datasourceSchemaFromResourceSchema(resourceScalewayVPCPublicGatewayPATRule().Schema)

dsSchema["pat_rule_id"] = &schema.Schema{
Type: schema.TypeString,
Required: true,
Description: "The ID of the public gateway PAT rule",
ValidateFunc: validationUUIDorUUIDWithLocality(),
}

// Set 'Optional' schema elements
addOptionalFieldsToSchema(dsSchema, "zone")

return &schema.Resource{
Schema: dsSchema,
ReadContext: dataSourceScalewayVPCPublicGatewayPATRuleRead,
}
}

func dataSourceScalewayVPCPublicGatewayPATRuleRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
vpcgwAPI, zone, err := vpcgwAPIWithZone(d, meta)
if err != nil {
return diag.FromErr(err)
}

patRuleIDRaw := d.Get("pat_rule_id")

zonedID := datasourceNewZonedID(patRuleIDRaw, zone)
d.SetId(zonedID)
_ = d.Set("pat_rule_id", zonedID)

// check if pat rule exist
_, err = vpcgwAPI.GetPATRule(&vpcgw.GetPATRuleRequest{
PatRuleID: expandID(patRuleIDRaw),
Zone: zone,
}, scw.WithContext(ctx))
if err != nil {
return diag.FromErr(err)
}

return resourceScalewayVPCPublicGatewayPATRuleRead(ctx, d, meta)
}
99 changes: 99 additions & 0 deletions scaleway/data_source_vpc_public_gateway_pat_rule_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
package scaleway

import (
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
)

func TestAccScalewayDataSourceVPCPublicGatewayPATRule_Basic(t *testing.T) {
tt := NewTestTools(t)
defer tt.Cleanup()

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProviderFactories: tt.ProviderFactories,
CheckDestroy: testAccCheckScalewayVPCPublicGatewayPATRuleDestroy(tt),
Steps: []resource.TestStep{
{
Config: `
resource scaleway_vpc_public_gateway pg01 {
type = "VPC-GW-S"
}

resource scaleway_vpc_public_gateway_dhcp dhcp01 {
subnet = "192.168.1.0/24"
}

resource scaleway_vpc_private_network pn01 {
name = "pn_test_network"
}
`,
},
{
Config: `
resource scaleway_vpc_public_gateway pg01 {
type = "VPC-GW-S"
}

resource scaleway_vpc_public_gateway_dhcp dhcp01 {
subnet = "192.168.1.0/24"
}

resource scaleway_vpc_private_network pn01 {
name = "pn_test_network"
}

resource scaleway_vpc_gateway_network gn01 {
gateway_id = scaleway_vpc_public_gateway.pg01.id
private_network_id = scaleway_vpc_private_network.pn01.id
dhcp_id = scaleway_vpc_public_gateway_dhcp.dhcp01.id
depends_on = [scaleway_vpc_private_network.pn01]
cleanup_dhcp = true
enable_masquerade = true
}

resource scaleway_vpc_public_gateway_pat_rule main {
gateway_id = scaleway_vpc_public_gateway.pg01.id
private_ip = scaleway_vpc_public_gateway_dhcp.dhcp01.address
private_port = 42
public_port = 42
protocol = "both"
depends_on = [scaleway_vpc_gateway_network.gn01, scaleway_vpc_private_network.pn01]
}

data "scaleway_vpc_public_gateway_pat_rule" "main" {
pat_rule_id = "${scaleway_vpc_public_gateway_pat_rule.main.id}"
}
`,
Check: resource.ComposeTestCheckFunc(
testAccCheckScalewayVPCPublicGatewayPATRuleExists(
tt,
"scaleway_vpc_public_gateway_pat_rule.main",
),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "gateway_id",
"scaleway_vpc_public_gateway_pat_rule.main", "gateway_id"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "private_ip",
"scaleway_vpc_public_gateway_pat_rule.main", "private_ip"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "created_at",
"scaleway_vpc_public_gateway_pat_rule.main", "created_at"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "updated_at",
"scaleway_vpc_public_gateway_pat_rule.main", "updated_at"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "protocol",
"scaleway_vpc_public_gateway_pat_rule.main", "protocol"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "public_port",
"scaleway_vpc_public_gateway_pat_rule.main", "public_port"),
resource.TestCheckResourceAttrPair(
"data.scaleway_vpc_public_gateway_pat_rule.main", "private_port",
"scaleway_vpc_public_gateway_pat_rule.main", "private_port"),
),
},
},
})
}
51 changes: 26 additions & 25 deletions scaleway/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,31 +102,32 @@ func Provider(config *ProviderConfig) plugin.ProviderFunc {
},

DataSourcesMap: map[string]*schema.Resource{
"scaleway_account_ssh_key": dataSourceScalewayAccountSSHKey(),
"scaleway_baremetal_offer": dataSourceScalewayBaremetalOffer(),
"scaleway_domain_record": dataSourceScalewayDomainRecord(),
"scaleway_domain_zone": dataSourceScalewayDomainZone(),
"scaleway_instance_ip": dataSourceScalewayInstanceIP(),
"scaleway_instance_security_group": dataSourceScalewayInstanceSecurityGroup(),
"scaleway_instance_server": dataSourceScalewayInstanceServer(),
"scaleway_instance_image": dataSourceScalewayInstanceImage(),
"scaleway_instance_volume": dataSourceScalewayInstanceVolume(),
"scaleway_k8s_cluster": dataSourceScalewayK8SCluster(),
"scaleway_k8s_pool": dataSourceScalewayK8SPool(),
"scaleway_lb": dataSourceScalewayLb(),
"scaleway_lb_ip": dataSourceScalewayLbIP(),
"scaleway_marketplace_image": dataSourceScalewayMarketplaceImage(),
"scaleway_object_bucket": dataSourceScalewayObjectBucket(),
"scaleway_rdb_acl": dataSourceScalewayRDBACL(),
"scaleway_rdb_instance": dataSourceScalewayRDBInstance(),
"scaleway_rdb_database": dataSourceScalewayRDBDatabase(),
"scaleway_rdb_privilege": dataSourceScalewayRDBPrivilege(),
"scaleway_registry_namespace": dataSourceScalewayRegistryNamespace(),
"scaleway_registry_image": dataSourceScalewayRegistryImage(),
"scaleway_vpc_public_gateway": dataSourceScalewayVPCPublicGateway(),
"scaleway_vpc_public_gateway_dhcp": dataSourceScalewayVPCPublicGatewayDHCP(),
"scaleway_vpc_public_gateway_ip": dataSourceScalewayVPCPublicGatewayIP(),
"scaleway_vpc_private_network": dataSourceScalewayVPCPrivateNetwork(),
"scaleway_account_ssh_key": dataSourceScalewayAccountSSHKey(),
"scaleway_baremetal_offer": dataSourceScalewayBaremetalOffer(),
"scaleway_domain_record": dataSourceScalewayDomainRecord(),
"scaleway_domain_zone": dataSourceScalewayDomainZone(),
"scaleway_instance_ip": dataSourceScalewayInstanceIP(),
"scaleway_instance_security_group": dataSourceScalewayInstanceSecurityGroup(),
"scaleway_instance_server": dataSourceScalewayInstanceServer(),
"scaleway_instance_image": dataSourceScalewayInstanceImage(),
"scaleway_instance_volume": dataSourceScalewayInstanceVolume(),
"scaleway_k8s_cluster": dataSourceScalewayK8SCluster(),
"scaleway_k8s_pool": dataSourceScalewayK8SPool(),
"scaleway_lb": dataSourceScalewayLb(),
"scaleway_lb_ip": dataSourceScalewayLbIP(),
"scaleway_marketplace_image": dataSourceScalewayMarketplaceImage(),
"scaleway_object_bucket": dataSourceScalewayObjectBucket(),
"scaleway_rdb_acl": dataSourceScalewayRDBACL(),
"scaleway_rdb_instance": dataSourceScalewayRDBInstance(),
"scaleway_rdb_database": dataSourceScalewayRDBDatabase(),
"scaleway_rdb_privilege": dataSourceScalewayRDBPrivilege(),
"scaleway_registry_namespace": dataSourceScalewayRegistryNamespace(),
"scaleway_registry_image": dataSourceScalewayRegistryImage(),
"scaleway_vpc_public_gateway": dataSourceScalewayVPCPublicGateway(),
"scaleway_vpc_public_gateway_dhcp": dataSourceScalewayVPCPublicGatewayDHCP(),
"scaleway_vpc_public_gateway_ip": dataSourceScalewayVPCPublicGatewayIP(),
"scaleway_vpc_private_network": dataSourceScalewayVPCPrivateNetwork(),
"scaleway_vpc_public_gateway_pat_rule": dataSourceScalewayVPCPublicGatewayPATRule(),
},
}

Expand Down
2 changes: 1 addition & 1 deletion scaleway/resource_vpc_public_gateway_pat_rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
vpcgw "github.com/scaleway/scaleway-sdk-go/api/vpcgw/v1"
"github.com/scaleway/scaleway-sdk-go/api/vpcgw/v1"
"github.com/scaleway/scaleway-sdk-go/scw"
)

Expand Down