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

Jump to bottom

Refactor ibm_pi_snapshot resource #5331

Merged
merged 9 commits into from
May 11, 2024
Merged

Refactor ibm_pi_snapshot resource #5331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
16a674c
Refactor ibm_pi_snapshot resource
ismirlia Apr 17, 2024
f655a86
Refactor ibm_pi_snapshot tests
ismirlia Apr 17, 2024
1a4c42b
Refactor ibm_pi_snapshot documentation
ismirlia Apr 17, 2024
a7d3edc
Merge branch 'master' of github.com:powervs-ibm/terraform-provider-ib…
ismirlia May 1, 2024
f8b29d3
Remove helpers constant
ismirlia May 3, 2024
1294497
Fix markdown typo
ismirlia May 3, 2024
2c78022
Update snapshot markdown
ismirlia May 3, 2024
39f086e
Fix snapshot markdown
ismirlia May 9, 2024
0e76ff5
Merge branch 'master' of github.com:powervs-ibm/terraform-provider-ib…
ismirlia May 9, 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
11 changes: 11 additions & 0 deletions ibm/service/power/ibm_pi_constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const (
Arg_CloudConnectionName = "pi_cloud_connection_name"
Arg_CloudInstanceID = "pi_cloud_instance_id"
Arg_DatacenterZone = "pi_datacenter_zone"
Arg_Description = "pi_description"
Arg_DhcpCidr = "pi_cidr"
Arg_DhcpCloudConnectionID = "pi_cloud_connection_id"
Arg_DhcpDnsServer = "pi_dns_server"
Expand Down Expand Up @@ -40,6 +41,7 @@ const (
Arg_SharedProcessorPoolPlacementGroupID = "pi_shared_processor_pool_placement_group_id"
Arg_SharedProcessorPoolReservedCores = "pi_shared_processor_pool_reserved_cores"
Arg_SnapshotID = "pi_snapshot_id"
Arg_SnapShotName = "pi_snap_shot_name"
yussufsh marked this conversation as resolved.
Show resolved Hide resolved
Arg_SPPPlacementGroupID = "pi_spp_placement_group_id"
Arg_SPPPlacementGroupName = "pi_spp_placement_group_name"
Arg_SPPPlacementGroupPolicy = "pi_spp_placement_group_policy"
Expand All @@ -48,6 +50,7 @@ const (
Arg_StorageType = "pi_storage_type"
Arg_VolumeGroupID = "pi_volume_group_id"
Arg_VolumeID = "pi_volume_id"
Arg_VolumeIDs = "pi_volume_ids"
Arg_VolumeName = "pi_volume_name"
Arg_VolumeOnboardingID = "pi_volume_onboarding_id"
Arg_VolumePool = "pi_volume_pool"
Expand Down Expand Up @@ -254,6 +257,7 @@ const (
Attr_SharedProcessorPoolStatus = "status"
Attr_SharedProcessorPoolStatusDetail = "status_detail"
Attr_Size = "size"
Attr_SnapshotID = "snapshot_id"
Attr_SourceVolumeName = "source_volume_name"
Attr_Speed = "speed"
Attr_SPPPlacementGroupID = "spp_placement_group_id"
Expand Down Expand Up @@ -317,19 +321,26 @@ const (

// States
State_Active = "active"
State_ACTIVE = "ACTIVE"
State_Available = "available"
State_BUILD = "BUILD"
State_Creating = "creating"
State_Deleted = "deleted"
State_Deleting = "deleting"
State_DELETING = "DELETING"
State_Failed = "failed"
State_Inactive = "inactive"
State_InProgress = "in progress"
State_InUse = "in-use"
State_NotFound = "Not Found"
State_PendingReclaimation = "pending_reclamation"
State_Provisioning = "provisioning"
State_Removed = "removed"
State_Retry = "retry"

// Health
Health_OK = "OK"

// TODO: Second Half Cleanup, remove extra variables

// SAP Profile
Expand Down
177 changes: 88 additions & 89 deletions ibm/service/power/resource_ibm_pi_snapshot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ import (
"log"
"time"

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

st "github.com/IBM-Cloud/power-go-client/clients/instance"
"github.com/IBM-Cloud/power-go-client/helpers"
"github.com/IBM-Cloud/power-go-client/clients/instance"
"github.com/IBM-Cloud/power-go-client/power/models"
"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
"github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
)

func ResourceIBMPISnapshot() *schema.Resource {
Expand All @@ -35,56 +34,64 @@ func ResourceIBMPISnapshot() *schema.Resource {
},

Schema: map[string]*schema.Schema{
helpers.PISnapshotName: {
Type: schema.TypeString,
Required: true,
Description: "Unique name of the snapshot",
// Arguments
Arg_CloudInstanceID: {
Description: "The GUID of the service instance associated with an account.",
Required: true,
Type: schema.TypeString,
ValidateFunc: validation.NoZeroValues,
},
helpers.PIInstanceName: {
Arg_Description: {
Description: "Description of the PVM instance snapshot.",
Optional: true,
Type: schema.TypeString,
Required: true,
Description: "Instance name / id of the pvm",
},
helpers.PIInstanceVolumeIds: {
Type: schema.TypeSet,
Optional: true,
Arg_InstanceName: {
Description: "The name of the instance you want to take a snapshot of.",
Required: true,
Type: schema.TypeString,
ValidateFunc: validation.NoZeroValues,
},
Arg_SnapShotName: {
Description: "The unique name of the snapshot.",
Required: true,
Type: schema.TypeString,
ValidateFunc: validation.NoZeroValues,
},
Arg_VolumeIDs: {
Description: "A list of volume IDs of the instance that will be part of the snapshot. If none are provided, then all the volumes of the instance will be part of the snapshot.",
DiffSuppressFunc: flex.ApplyOnce,
Elem: &schema.Schema{Type: schema.TypeString},
Optional: true,
Set: schema.HashString,
DiffSuppressFunc: flex.ApplyOnce,
Description: "List of PI volumes",
Type: schema.TypeSet,
},
helpers.PICloudInstanceId: {

// Attributes
Attr_CreationDate: {
Computed: true,
Description: "Creation date of the snapshot.",
Type: schema.TypeString,
Required: true,
Description: " Cloud Instance ID - This is the service_instance_id.",
},
"pi_description": {
Attr_LastUpdateDate: {
Computed: true,
Description: "The last updated date of the snapshot.",
Type: schema.TypeString,
Optional: true,
Description: "Description of the PVM instance snapshot",
},

// Computed Attributes
"snapshot_id": {
Type: schema.TypeString,
Attr_SnapshotID: {
Computed: true,
Description: "ID of the PVM instance snapshot",
},
"status": {
Type: schema.TypeString,
Computed: true,
},
"creation_date": {
Type: schema.TypeString,
Computed: true,
Description: "ID of the PVM instance snapshot.",
Type: schema.TypeString,
},
"last_update_date": {
Type: schema.TypeString,
Computed: true,
Attr_Status: {
Computed: true,
Description: "Status of the PVM instance snapshot.",
Type: schema.TypeString,
},
"volume_snapshots": {
Type: schema.TypeMap,
Computed: true,
Attr_VolumeSnapshots: {
Computed: true,
Description: "A map of volume snapshots included in the PVM instance snapshot.",
Type: schema.TypeMap,
},
},
}
Expand All @@ -96,22 +103,22 @@ func resourceIBMPISnapshotCreate(ctx context.Context, d *schema.ResourceData, me
return diag.FromErr(err)
}

cloudInstanceID := d.Get(helpers.PICloudInstanceId).(string)
instanceid := d.Get(helpers.PIInstanceName).(string)
volids := flex.ExpandStringList((d.Get(helpers.PIInstanceVolumeIds).(*schema.Set)).List())
name := d.Get(helpers.PISnapshotName).(string)
cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
instanceid := d.Get(Arg_InstanceName).(string)
name := d.Get(Arg_SnapShotName).(string)
volumeIDs := flex.ExpandStringList((d.Get(Arg_VolumeIDs).(*schema.Set)).List())

var description string
if v, ok := d.GetOk("pi_description"); ok {
if v, ok := d.GetOk(Arg_Description); ok {
description = v.(string)
}

client := st.NewIBMPIInstanceClient(ctx, sess, cloudInstanceID)
client := instance.NewIBMPIInstanceClient(ctx, sess, cloudInstanceID)

snapshotBody := &models.SnapshotCreate{Name: &name, Description: description}

if len(volids) > 0 {
snapshotBody.VolumeIDs = volids
if len(volumeIDs) > 0 {
snapshotBody.VolumeIDs = volumeIDs
} else {
log.Printf("no volumeids provided. Will snapshot the entire instance")
}
Expand All @@ -124,8 +131,8 @@ func resourceIBMPISnapshotCreate(ctx context.Context, d *schema.ResourceData, me

d.SetId(fmt.Sprintf("%s/%s", cloudInstanceID, *snapshotResponse.SnapshotID))

pisnapclient := st.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
_, err = isWaitForPIInstanceSnapshotAvailable(ctx, pisnapclient, *snapshotResponse.SnapshotID, d.Timeout(schema.TimeoutCreate))
piSnapClient := instance.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
_, err = isWaitForPIInstanceSnapshotAvailable(ctx, piSnapClient, *snapshotResponse.SnapshotID, d.Timeout(schema.TimeoutCreate))
if err != nil {
return diag.FromErr(err)
}
Expand All @@ -145,25 +152,24 @@ func resourceIBMPISnapshotRead(ctx context.Context, d *schema.ResourceData, meta
return diag.FromErr(err)
}

snapshot := st.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
snapshot := instance.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
snapshotdata, err := snapshot.Get(snapshotID)
if err != nil {
return diag.FromErr(err)
}

d.Set(helpers.PISnapshotName, snapshotdata.Name)
d.Set("snapshot_id", *snapshotdata.SnapshotID)
d.Set("status", snapshotdata.Status)
d.Set("creation_date", snapshotdata.CreationDate.String())
d.Set("volume_snapshots", snapshotdata.VolumeSnapshots)
d.Set("last_update_date", snapshotdata.LastUpdateDate.String())
d.Set(Arg_SnapShotName, snapshotdata.Name)
d.Set(Attr_CreationDate, snapshotdata.CreationDate.String())
d.Set(Attr_LastUpdateDate, snapshotdata.LastUpdateDate.String())
d.Set(Attr_SnapshotID, *snapshotdata.SnapshotID)
d.Set(Attr_Status, snapshotdata.Status)
d.Set(Attr_VolumeSnapshots, snapshotdata.VolumeSnapshots)

return nil
}

func resourceIBMPISnapshotUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {

log.Printf("Calling the IBM Power Snapshot update call")
log.Printf("Calling the IBM Power Snapshot update call")
sess, err := meta.(conns.ClientSession).IBMPISession()
if err != nil {
return diag.FromErr(err)
Expand All @@ -174,11 +180,11 @@ func resourceIBMPISnapshotUpdate(ctx context.Context, d *schema.ResourceData, me
return diag.FromErr(err)
}

client := st.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
client := instance.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)

if d.HasChange(helpers.PISnapshotName) || d.HasChange("description") {
name := d.Get(helpers.PISnapshotName).(string)
description := d.Get("description").(string)
if d.HasChange(Arg_SnapShotName) || d.HasChange(Arg_Description) {
name := d.Get(Arg_SnapShotName).(string)
description := d.Get(Arg_Description).(string)
snapshotBody := &models.SnapshotUpdate{Name: name, Description: description}

_, err := client.Update(snapshotID, snapshotBody)
Expand Down Expand Up @@ -206,7 +212,7 @@ func resourceIBMPISnapshotDelete(ctx context.Context, d *schema.ResourceData, me
return diag.FromErr(err)
}

client := st.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
client := instance.NewIBMPISnapshotClient(ctx, sess, cloudInstanceID)
snapshot, err := client.Get(snapshotID)
if err != nil {
// snapshot does not exist
Expand All @@ -229,13 +235,12 @@ func resourceIBMPISnapshotDelete(ctx context.Context, d *schema.ResourceData, me
d.SetId("")
return nil
}
func isWaitForPIInstanceSnapshotAvailable(ctx context.Context, client *st.IBMPISnapshotClient, id string, timeout time.Duration) (interface{}, error) {

func isWaitForPIInstanceSnapshotAvailable(ctx context.Context, client *instance.IBMPISnapshotClient, id string, timeout time.Duration) (interface{}, error) {
log.Printf("Waiting for PIInstance Snapshot (%s) to be available and active ", id)

stateConf := &resource.StateChangeConf{
Pending: []string{"in_progress", "BUILD"},
Target: []string{"available", "ACTIVE"},
stateConf := &retry.StateChangeConf{
Pending: []string{State_InProgress, State_BUILD},
Target: []string{State_Available, State_ACTIVE},
Refresh: isPIInstanceSnapshotRefreshFunc(client, id),
Delay: 30 * time.Second,
MinTimeout: 2 * time.Minute,
Expand All @@ -245,33 +250,28 @@ func isWaitForPIInstanceSnapshotAvailable(ctx context.Context, client *st.IBMPIS
return stateConf.WaitForStateContext(ctx)
}

func isPIInstanceSnapshotRefreshFunc(client *st.IBMPISnapshotClient, id string) resource.StateRefreshFunc {
func isPIInstanceSnapshotRefreshFunc(client *instance.IBMPISnapshotClient, id string) retry.StateRefreshFunc {
return func() (interface{}, string, error) {

snapshotInfo, err := client.Get(id)
if err != nil {
return nil, "", err
}

//if pvm.Health.Status == helpers.PIInstanceHealthOk {
if snapshotInfo.Status == "available" && snapshotInfo.PercentComplete == 100 {
if snapshotInfo.Status == State_Available && snapshotInfo.PercentComplete == 100 {
log.Printf("The snapshot is now available")
return snapshotInfo, "available", nil
return snapshotInfo, State_Available, nil

}
return snapshotInfo, "in_progress", nil
return snapshotInfo, State_InProgress, nil
}
}

// Delete Snapshot

func isWaitForPIInstanceSnapshotDeleted(ctx context.Context, client *st.IBMPISnapshotClient, id string, timeout time.Duration) (interface{}, error) {

func isWaitForPIInstanceSnapshotDeleted(ctx context.Context, client *instance.IBMPISnapshotClient, id string, timeout time.Duration) (interface{}, error) {
log.Printf("Waiting for (%s) to be deleted.", id)

stateConf := &resource.StateChangeConf{
Pending: []string{"retry", helpers.PIInstanceDeleting},
Target: []string{"Not Found"},
stateConf := &retry.StateChangeConf{
Pending: []string{State_Retry, State_DELETING},
Target: []string{State_NotFound},
Refresh: isPIInstanceSnapshotDeleteRefreshFunc(client, id),
Delay: 10 * time.Second,
MinTimeout: 10 * time.Second,
Expand All @@ -281,14 +281,13 @@ func isWaitForPIInstanceSnapshotDeleted(ctx context.Context, client *st.IBMPISna
return stateConf.WaitForStateContext(ctx)
}

func isPIInstanceSnapshotDeleteRefreshFunc(client *st.IBMPISnapshotClient, id string) resource.StateRefreshFunc {
func isPIInstanceSnapshotDeleteRefreshFunc(client *instance.IBMPISnapshotClient, id string) retry.StateRefreshFunc {
return func() (interface{}, string, error) {
snapshot, err := client.Get(id)
if err != nil {
log.Printf("The snapshot is not found.")
return snapshot, helpers.PIInstanceNotFound, nil
return snapshot, State_NotFound, nil
}
return snapshot, helpers.PIInstanceNotFound, nil

return snapshot, State_NotFound, nil
}
}
Loading
Loading