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(virtual-network): add virtual network resource and data sources #159

Merged
merged 4 commits into from
Jan 27, 2025
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
2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ builds:
goarch: "386"

archives:
- format: zip
- formats: ["zip"]
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"

checksum:
Expand Down
32 changes: 32 additions & 0 deletions docs/data-sources/virtual_network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "katapult_virtual_network Data Source - terraform-provider-katapult"
subcategory: ""
description: |-

---

# katapult_virtual_network (Data Source)



## Example Usage

```terraform
# Get specific virtual network by ID
data "katapult_virtual_network" "backbone" {
id = "vnet_I5eWzfuUIdgXJTXi"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of this resource.

### Read-Only

- `data_center_id` (String) The ID of the data center this virtual network belongs to.
- `name` (String) The name of the virtual network.
34 changes: 34 additions & 0 deletions docs/data-sources/virtual_networks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "katapult_virtual_networks Data Source - terraform-provider-katapult"
subcategory: ""
description: |-

---

# katapult_virtual_networks (Data Source)



## Example Usage

```terraform
# Get all virtual networks.
data "katapult_virtual_networks" "all" {}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `virtual_networks` (Attributes List) (see [below for nested schema](#nestedatt--virtual_networks))

<a id="nestedatt--virtual_networks"></a>
### Nested Schema for `virtual_networks`

Read-Only:

- `data_center_id` (String) The ID of the data center this virtual network belongs to.
- `id` (String) The ID of this resource.
- `name` (String) The name of the virtual network.
45 changes: 45 additions & 0 deletions docs/resources/virtual_network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "katapult_virtual_network Resource - terraform-provider-katapult"
subcategory: ""
description: |-

---

# katapult_virtual_network (Resource)



## Example Usage

```terraform
# Create virtual network
resource "katapult_virtual_network" "backbone" {
name = "Backbone"
}

# Create a virtual network in a specific Data Center.
data "katapult_data_center" "ams" {
permalink = "nl-ams-01"
}

resource "katapult_virtual_network" "backbone-ams" {
name = "Backbone AMS"
data_center_id = data.katapult_data_center.ams.id
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) The name of the virtual network.

### Optional

- `data_center_id` (String) The ID of the data center to create the virtual network in.

### Read-Only

- `id` (String) The ID of this resource.
4 changes: 4 additions & 0 deletions examples/data-sources/katapult_virtual_network/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Get specific virtual network by ID
data "katapult_virtual_network" "backbone" {
id = "vnet_I5eWzfuUIdgXJTXi"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Get all virtual networks.
data "katapult_virtual_networks" "all" {}
14 changes: 14 additions & 0 deletions examples/resources/katapult_virtual_network/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Create virtual network
resource "katapult_virtual_network" "backbone" {
name = "Backbone"
}

# Create a virtual network in a specific Data Center.
data "katapult_data_center" "ams" {
permalink = "nl-ams-01"
}

resource "katapult_virtual_network" "backbone-ams" {
name = "Backbone AMS"
data_center_id = data.katapult_data_center.ams.id
}
54 changes: 7 additions & 47 deletions internal/v6provider/data_source_network_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,18 +139,8 @@ func TestAccKatapultDataSourceNetwork_default(t *testing.T) {
func TestAccKatapultDataSourceNetwork_default_other_data_center(t *testing.T) {
tt := newTestTools(t)

dcPermalink := "nl-ams-01" // "Public Network - AMS (eu-ams-01)
dcResp, err := tt.Meta.Core.GetDataCenterWithResponse(
tt.Ctx, &core.GetDataCenterParams{
DataCenterPermalink: &dcPermalink,
},
)
if err != nil {
t.Fatalf("error fetching data center: %s", err)
}

dc := dcResp.JSON200.DataCenter

// "Public Network - AMS (eu-ams-01)
dc := getKatapultDataCenter(tt, "nl-ams-01")
netResp, err := tt.Meta.Core.GetDataCenterDefaultNetworkWithResponse(
tt.Ctx, &core.GetDataCenterDefaultNetworkParams{
DataCenterId: dc.Id,
Expand Down Expand Up @@ -193,18 +183,8 @@ func TestAccKatapultDataSourceNetwork_default_other_data_center(t *testing.T) {
func TestAccKatapultDataSourceNetwork_other_by_id(t *testing.T) {
tt := newTestTools(t)

dcPermalink := "nl-ams-01" // "Public Network - AMS (eu-ams-01)
dcResp, err := tt.Meta.Core.GetDataCenterWithResponse(
tt.Ctx, &core.GetDataCenterParams{
DataCenterPermalink: &dcPermalink,
},
)
if err != nil {
t.Fatalf("error fetching data center: %s", err)
}

dc := dcResp.JSON200.DataCenter

// "Public Network - AMS (eu-ams-01)
dc := getKatapultDataCenter(tt, "nl-ams-01")
netResp, err := tt.Meta.Core.GetDataCenterDefaultNetworkWithResponse(
tt.Ctx, &core.GetDataCenterDefaultNetworkParams{
DataCenterId: dc.Id,
Expand Down Expand Up @@ -248,18 +228,8 @@ func TestAccKatapultDataSourceNetwork_other_by_id(t *testing.T) {
func TestAccKatapultDataSourceNetwork_other_by_permalink(t *testing.T) {
tt := newTestTools(t)

dcPermalink := "nl-ams-01" // "Public Network - AMS (eu-ams-01)
dcResp, err := tt.Meta.Core.GetDataCenterWithResponse(
tt.Ctx, &core.GetDataCenterParams{
DataCenterPermalink: &dcPermalink,
},
)
if err != nil {
t.Fatalf("error fetching data center: %s", err)
}

dc := dcResp.JSON200.DataCenter

// "Public Network - AMS (eu-ams-01)
dc := getKatapultDataCenter(tt, "nl-ams-01")
netResp, err := tt.Meta.Core.GetDataCenterDefaultNetworkWithResponse(
tt.Ctx, &core.GetDataCenterDefaultNetworkParams{
DataCenterId: dc.Id,
Expand Down Expand Up @@ -307,17 +277,7 @@ func TestAccKatapultDataSourceNetwork_other_by_permalink(t *testing.T) {
func TestAccKatapultDataSourceNetwork_invalid_attributes(t *testing.T) {
tt := newTestTools(t)

dcResp, err := tt.Meta.Core.GetDataCenterWithResponse(
tt.Ctx, &core.GetDataCenterParams{
DataCenterPermalink: &tt.Meta.confDataCenter,
},
)
if err != nil {
t.Fatalf("error fetching data center: %s", err)
}

dc := dcResp.JSON200.DataCenter

dc := getKatapultDataCenter(tt, tt.Meta.confDataCenter)
resp, err := tt.Meta.Core.GetDataCenterDefaultNetworkWithResponse(
tt.Ctx, &core.GetDataCenterDefaultNetworkParams{
DataCenterPermalink: &tt.Meta.confDataCenter,
Expand Down
112 changes: 112 additions & 0 deletions internal/v6provider/data_source_virtual_network.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
package v6provider

import (
"context"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/krystal/go-katapult/next/core"
)

type VirtualNetworkDataSource struct {
M *Meta
}

type VirtualNetworkDataSourceModel struct {
ID types.String `tfsdk:"id"`
Name types.String `tfsdk:"name"`
DataCenterID types.String `tfsdk:"data_center_id"`
}

func (ds VirtualNetworkDataSource) Metadata(
_ context.Context,
req datasource.MetadataRequest,
resp *datasource.MetadataResponse,
) {
resp.TypeName = req.ProviderTypeName + "_virtual_network"
}

func (ds *VirtualNetworkDataSource) Configure(
_ context.Context,
req datasource.ConfigureRequest,
resp *datasource.ConfigureResponse,
) {
if req.ProviderData == nil {
return
}

meta, ok := req.ProviderData.(*Meta)
if !ok {
resp.Diagnostics.AddError(
"Meta Error",
"meta is not of type *Meta",
)
return
}

ds.M = meta
}

func virtualNetworkDataSourceSchemaAttrs() map[string]schema.Attribute {
return map[string]schema.Attribute{
"id": schema.StringAttribute{
Required: true,
Description: "The ID of this resource.",
Validators: []validator.String{
stringValidatorNotEmpty(),
},
},
"name": schema.StringAttribute{
Computed: true,
Description: "The name of the virtual network.",
},
"data_center_id": schema.StringAttribute{
Computed: true,
Description: "The ID of the data center this virtual network " +
"belongs to.",
},
}
}

func (ds *VirtualNetworkDataSource) Schema(
_ context.Context,
_ datasource.SchemaRequest,
resp *datasource.SchemaResponse,
) {
resp.Schema = schema.Schema{
Attributes: virtualNetworkDataSourceSchemaAttrs(),
}
}

func (ds *VirtualNetworkDataSource) Read(
ctx context.Context,
req datasource.ReadRequest,
resp *datasource.ReadResponse,
) {
var data VirtualNetworkDataSourceModel
resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}

id := data.ID.ValueString()

res, err := ds.M.Core.GetVirtualNetworkWithResponse(
ctx, &core.GetVirtualNetworkParams{VirtualNetworkId: &id},
)
if err != nil {
resp.Diagnostics.AddError("Error reading virtual network", err.Error())
return
}

vn := res.JSON200.VirtualNetwork
data.ID = types.StringPointerValue(vn.Id)
data.Name = types.StringPointerValue(vn.Name)
if vn.DataCenter != nil {
data.DataCenterID = types.StringPointerValue(vn.DataCenter.Id)
}

resp.Diagnostics.Append(resp.State.Set(ctx, data)...)
}
Loading
Loading