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.

Sign up for GitHub

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

Add timeout blocks for Terraform resources #97

Merged
merged 2 commits into from
Jun 4, 2024
Merged

Add timeout blocks for Terraform resources #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b14edf3
add timeouts
m-ildefons Apr 19, 2024
346d0e0
cloud-init secret: no wait on delete
m-ildefons Jun 4, 2024
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
9 changes: 9 additions & 0 deletions internal/provider/cloudinitsecret/resource_cloudinitsecret.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"encoding/base64"
"fmt"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
Expand All @@ -28,6 +29,13 @@ func ResourceCloudInitSecret() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(2 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -100,6 +108,7 @@ func resourceCloudInitSecretDelete(ctx context.Context, d *schema.ResourceData,
if err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}

d.SetId("")
return nil
}
Expand Down
8 changes: 8 additions & 0 deletions internal/provider/clusternetwork/resource_clusternetwork.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package clusternetwork
import (
"context"
"fmt"
"time"

harvsternetworkv1 "github.com/harvester/harvester-network-controller/pkg/apis/network.harvesterhci.io/v1beta1"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
Expand All @@ -27,6 +28,13 @@ func ResourceClusterNetwork() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(2 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down
21 changes: 21 additions & 0 deletions internal/provider/image/resource_image.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ func ResourceImage() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(5 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(5 * time.Minute),
Delete: schema.DefaultTimeout(2 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -100,6 +107,20 @@ func resourceImageDelete(ctx context.Context, d *schema.ResourceData, meta inter
if err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}

stateConf := &resource.StateChangeConf{
Pending: []string{constants.StateImageTerminating, constants.StateCommonActive},
Target: []string{constants.StateCommonRemoved},
Refresh: resourceImageRefresh(ctx, d, meta),
Timeout: d.Timeout(schema.TimeoutDelete),
Delay: 1 * time.Second,
MinTimeout: 3 * time.Second,
}
_, err = stateConf.WaitForStateContext(ctx)
if err != nil {
return diag.FromErr(err)
}

d.SetId("")
return nil
}
Expand Down
8 changes: 8 additions & 0 deletions internal/provider/keypair/resource_keypair.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package keypair

import (
"context"
"time"

harvsterv1 "github.com/harvester/harvester/pkg/apis/harvesterhci.io/v1beta1"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
Expand All @@ -26,6 +27,13 @@ func ResourceKeypair() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(2 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down
19 changes: 14 additions & 5 deletions internal/provider/network/resource_network.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package network
import (
"context"
"fmt"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
Expand All @@ -17,10 +18,6 @@ import (
"github.com/harvester/terraform-provider-harvester/pkg/importer"
)

const (
networkDeleteTimeout = 300
)

func ResourceNetwork() *schema.Resource {
return &schema.Resource{
CreateContext: resourceNetworkCreate,
Expand All @@ -31,6 +28,13 @@ func ResourceNetwork() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(5 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -101,7 +105,12 @@ func resourceNetworkDelete(ctx context.Context, d *schema.ResourceData, meta int
if err = c.HarvesterClient.K8sCniCncfIoV1().NetworkAttachmentDefinitions(namespace).Delete(ctx, name, metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}
events, err := c.HarvesterClient.K8sCniCncfIoV1().NetworkAttachmentDefinitions(namespace).Watch(ctx, util.WatchOptions(name, int64(networkDeleteTimeout)))

ctxDeadline, _ := ctx.Deadline()
events, err := c.HarvesterClient.
K8sCniCncfIoV1().
NetworkAttachmentDefinitions(namespace).
Watch(ctx, util.WatchOptions(name, time.Until(ctxDeadline)))
if err != nil {
return diag.FromErr(err)
}
Expand Down
47 changes: 24 additions & 23 deletions internal/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,34 +61,35 @@ func Provider() *schema.Provider {
constants.ResourceTypeVLANConfig: vlanconfig.ResourceVLANConfig(),
constants.ResourceTypeCloudInitSecret: cloudinitsecret.ResourceCloudInitSecret(),
},
ConfigureContextFunc: providerConfig,
}
p.ConfigureContextFunc = configure(p)
return p
}

func configure(p *schema.Provider) schema.ConfigureContextFunc {
return func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
kubeContext := d.Get(constants.FieldProviderKubeContext).(string)
kubeConfig, err := homedir.Expand(d.Get(constants.FieldProviderKubeConfig).(string))
if err != nil {
return nil, diag.FromErr(err)
}

c, err := client.NewClient(kubeConfig, kubeContext)
if err != nil {
return nil, diag.FromErr(err)
}
func providerConfig(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
kubeContext := d.Get(constants.FieldProviderKubeContext).(string)
kubeConfig, err := homedir.Expand(d.Get(constants.FieldProviderKubeConfig).(string))
if err != nil {
return nil, diag.FromErr(err)
}

// check harvester version from settings
serverVersion, err := c.HarvesterClient.HarvesterhciV1beta1().Settings().Get(context.Background(), "server-version", metav1.GetOptions{})
if err != nil {
return nil, diag.FromErr(err)
}
// harvester version v1.0-head, v1.0.2, v1.0.3 is not supported
if strings.HasPrefix(serverVersion.Value, "v1.0") {
return nil, diag.FromErr(fmt.Errorf("current Harvester server version is %s, the minimum supported version is v1.1.0", serverVersion.Value))
}
c, err := client.NewClient(kubeConfig, kubeContext)
if err != nil {
return nil, diag.FromErr(err)
}

return c, nil
// check harvester version from settings
serverVersion, err := c.HarvesterClient.
HarvesterhciV1beta1().
Settings().
Get(ctx, "server-version", metav1.GetOptions{})
if err != nil {
return nil, diag.FromErr(err)
}
// harvester version v1.0-head, v1.0.2, v1.0.3 is not supported
if strings.HasPrefix(serverVersion.Value, "v1.0") {
return nil, diag.FromErr(fmt.Errorf("current Harvester server version is %s, the minimum supported version is v1.1.0", serverVersion.Value))
}

return c, nil
}
8 changes: 8 additions & 0 deletions internal/provider/storageclass/resource_storageclass.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package storageclass

import (
"context"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
Expand All @@ -26,6 +27,13 @@ func ResourceStorageClass() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(2 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down
18 changes: 13 additions & 5 deletions internal/provider/virtualmachine/resource_virtualmachine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ import (
"github.com/harvester/terraform-provider-harvester/pkg/importer"
)

const (
vmDeleteTimeout = 300
)

func ResourceVirtualMachine() *schema.Resource {
return &schema.Resource{
CreateContext: resourceVirtualMachineCreate,
Expand All @@ -35,6 +31,13 @@ func ResourceVirtualMachine() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(5 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -173,7 +176,12 @@ func resourceVirtualMachineDelete(ctx context.Context, d *schema.ResourceData, m
if err = c.HarvesterClient.KubevirtV1().VirtualMachines(namespace).Delete(ctx, name, deleteOptions); err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}
events, err := c.HarvesterClient.KubevirtV1().VirtualMachines(namespace).Watch(ctx, util.WatchOptions(name, int64(vmDeleteTimeout)))

ctxDeadline, _ := ctx.Deadline()
events, err := c.HarvesterClient.
KubevirtV1().
VirtualMachines(namespace).
Watch(ctx, util.WatchOptions(name, time.Until(ctxDeadline)))
if err != nil {
return diag.FromErr(err)
}
Expand Down
19 changes: 14 additions & 5 deletions internal/provider/vlanconfig/resource_vlanconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package vlanconfig
import (
"context"
"fmt"
"time"

harvsternetworkv1 "github.com/harvester/harvester-network-controller/pkg/apis/network.harvesterhci.io/v1beta1"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
Expand All @@ -17,10 +18,6 @@ import (
"github.com/harvester/terraform-provider-harvester/pkg/importer"
)

const (
vlanConfigDeleteTimeout = 300
)

func ResourceVLANConfig() *schema.Resource {
return &schema.Resource{
CreateContext: resourceVLANConfigCreate,
Expand All @@ -31,6 +28,13 @@ func ResourceVLANConfig() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(5 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -100,7 +104,12 @@ func resourceVLANConfigDelete(ctx context.Context, d *schema.ResourceData, meta
if err = c.HarvesterNetworkClient.NetworkV1beta1().VlanConfigs().Delete(ctx, name, metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}
events, err := c.HarvesterNetworkClient.NetworkV1beta1().VlanConfigs().Watch(ctx, util.WatchOptions(name, int64(vlanConfigDeleteTimeout)))

ctxDeadline, _ := ctx.Deadline()
events, err := c.HarvesterNetworkClient.
NetworkV1beta1().
VlanConfigs().
Watch(ctx, util.WatchOptions(name, time.Until(ctxDeadline)))
if err != nil {
return diag.FromErr(err)
}
Expand Down
19 changes: 12 additions & 7 deletions internal/provider/volume/resource_volume.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package volume

import (
"context"
"fmt"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
Expand All @@ -17,10 +17,6 @@ import (
"github.com/harvester/terraform-provider-harvester/pkg/importer"
)

const (
volumeDeleteTimeout = 300
)

func ResourceVolume() *schema.Resource {
return &schema.Resource{
CreateContext: resourceVolumeCreate,
Expand All @@ -31,6 +27,13 @@ func ResourceVolume() *schema.Resource {
StateContext: schema.ImportStatePassthroughContext,
},
Schema: Schema(),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(2 * time.Minute),
Read: schema.DefaultTimeout(2 * time.Minute),
Update: schema.DefaultTimeout(2 * time.Minute),
Delete: schema.DefaultTimeout(5 * time.Minute),
Default: schema.DefaultTimeout(2 * time.Minute),
},
}
}

Expand Down Expand Up @@ -100,12 +103,14 @@ func resourceVolumeDelete(ctx context.Context, d *schema.ResourceData, meta inte
if err = c.KubeClient.CoreV1().PersistentVolumeClaims(namespace).Delete(ctx, name, metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {
return diag.FromErr(err)
}
events, err := c.KubeClient.CoreV1().PersistentVolumeClaims(namespace).Watch(ctx, util.WatchOptions(name, int64(volumeDeleteTimeout)))

ctxDeadline, _ := ctx.Deadline()
events, err := c.KubeClient.CoreV1().PersistentVolumeClaims(namespace).Watch(ctx, util.WatchOptions(name, time.Until(ctxDeadline)))
if err != nil {
return diag.FromErr(err)
}
if !util.HasDeleted(events) {
return diag.FromErr(fmt.Errorf("timeout waiting for volume %s to be deleted", d.Id()))
return diag.Errorf("timeout waiting for volume %s to be deleted", d.Id())
}
d.SetId("")
return nil
Expand Down
5 changes: 3 additions & 2 deletions internal/util/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package util

import (
"fmt"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down Expand Up @@ -31,10 +32,10 @@ func HasDeleted(events watch.Interface) bool {
return deleted
}

func WatchOptions(name string, timeoutSeconds int64) metav1.ListOptions {
func WatchOptions(name string, timeout time.Duration) metav1.ListOptions {
return metav1.ListOptions{
FieldSelector: fmt.Sprintf("metadata.name=%s", name),
Watch: true,
TimeoutSeconds: &timeoutSeconds,
TimeoutSeconds: func() *int64 { to := timeout.Milliseconds() / 1000; return &to }(),
}
}
Loading