-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #112 from dell/su-res
Simple update resource migration to Terraform Plugin Framework
- Loading branch information
Showing
13 changed files
with
845 additions
and
472 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| --- | ||
| # Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. | ||
| # | ||
| # Licensed under the Mozilla Public License Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://mozilla.org/MPL/2.0/ | ||
| # | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| title: "redfish_simple_update resource" | ||
| linkTitle: "redfish_simple_update" | ||
| page_title: "redfish_simple_update Resource - terraform-provider-redfish" | ||
| subcategory: "" | ||
| description: |- | ||
| Resource for managing power. | ||
| --- | ||
|
|
||
| # redfish_simple_update (Resource) | ||
|
|
||
| Resource for managing power. | ||
| This Terraform resource is used to Update the iDRAC Server. We can Read the existing version or update the same using this resource. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| variables.tf | ||
| ```terraform | ||
| /* | ||
| Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. | ||
| Licensed under the Mozilla Public License Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://mozilla.org/MPL/2.0/ | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| variable "rack1" { | ||
| type = map(object({ | ||
| user = string | ||
| password = string | ||
| endpoint = string | ||
| ssl_insecure = bool | ||
| })) | ||
| } | ||
| ``` | ||
|
|
||
| terraform.tfvars | ||
| ```terraform | ||
| /* | ||
| Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. | ||
| Licensed under the Mozilla Public License Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://mozilla.org/MPL/2.0/ | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| rack1 = { | ||
| "my-server-1" = { | ||
| user = "admin" | ||
| password = "passw0rd" | ||
| endpoint = "https://my-server-1.myawesomecompany.org" | ||
| ssl_insecure = true | ||
| }, | ||
| "my-server-2" = { | ||
| user = "admin" | ||
| password = "passw0rd" | ||
| endpoint = "https://my-server-2.myawesomecompany.org" | ||
| ssl_insecure = true | ||
| }, | ||
| } | ||
| ``` | ||
|
|
||
| provider.tf | ||
| ```terraform | ||
| /* | ||
| Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. | ||
| Licensed under the Mozilla Public License Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://mozilla.org/MPL/2.0/ | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| terraform { | ||
| required_providers { | ||
| redfish = { | ||
| version = "1.0.0" | ||
| source = "registry.terraform.io/dell/redfish" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| main.tf | ||
| ```terraform | ||
| /* | ||
| Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. | ||
| Licensed under the Mozilla Public License Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://mozilla.org/MPL/2.0/ | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| resource "redfish_simple_update" "update" { | ||
| for_each = var.rack1 | ||
| redfish_server { | ||
| user = each.value.user | ||
| password = each.value.password | ||
| endpoint = each.value.endpoint | ||
| ssl_insecure = each.value.ssl_insecure | ||
| } | ||
| // The network protocols and image for firmware update | ||
| transfer_protocol = "HTTP" | ||
| target_firmware_image = "/home/mikeletux/Downloads/BIOS_FXC54_WN64_1.15.0.EXE" | ||
| // Reset parameters to be applied when upgrade is completed | ||
| reset_type = "ForceRestart" | ||
| reset_timeout = 120 // If not set, by default will be 120s | ||
| // The maximum amount of time to wait for the simple update job to be completed | ||
| simple_update_job_timeout = 1200 // If not set, by default will be 1200s | ||
| } | ||
| ``` | ||
|
|
||
| After the successful execution of the above resource block, firmware would have got updated. It can be verified through state file. | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `redfish_server` (Attributes) Redfish Server (see [below for nested schema](#nestedatt--redfish_server)) | ||
| - `reset_type` (String) Reset type allows to choose the type of restart to apply when firmware upgrade is scheduled. Possible values are: "ForceRestart", "GracefulRestart" or "PowerCycle" | ||
| - `target_firmware_image` (String) Target firmware image used for firmware update on the redfish instance. Make sure you place your firmware packages in the same folder as the module and set it as follows: "${path.module}/BIOS_FXC54_WN64_1.15.0.EXE" | ||
| - `transfer_protocol` (String) The network protocol that the Update Service uses to retrieve the software image file located at the URI provided in ImageURI, if the URI does not contain a scheme. Accepted values: CIFS, FTP, SFTP, HTTP, HTTPS, NSF, SCP, TFTP, OEM, NFS. Currently only HTTP, HTTPS and NFS are supported with local file path or HTTP(s)/NFS link. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `reset_timeout` (Number) Time in seconds that the provider waits for the server to be reset before timing out. | ||
| - `simple_update_job_timeout` (Number) Time in seconds that the provider waits for the simple update job to be completed before timing out. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) ID of the simple update resource | ||
| - `software_id` (String) Software ID from the firmware package uploaded | ||
| - `version` (String) Software version from the firmware package uploaded | ||
|
|
||
| <a id="nestedatt--redfish_server"></a> | ||
| ### Nested Schema for `redfish_server` | ||
|
|
||
| Required: | ||
|
|
||
| - `endpoint` (String) Server BMC IP address or hostname | ||
|
|
||
| Optional: | ||
|
|
||
| - `password` (String, Sensitive) User password for login | ||
| - `user` (String) User name for login | ||
| - `validate_cert` (Boolean) This field indicates whether the SSL/TLS certificate must be verified or not | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package models | ||
|
|
||
| import ( | ||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||
| ) | ||
|
|
||
| // SimpleUpdateRes is struct for simple update resource | ||
| type SimpleUpdateRes struct { | ||
| Id types.String `tfsdk:"id"` | ||
| RedfishServer RedfishServer `tfsdk:"redfish_server"` | ||
| Protocol types.String `tfsdk:"transfer_protocol"` | ||
| Image types.String `tfsdk:"target_firmware_image"` | ||
| ResetType types.String `tfsdk:"reset_type"` | ||
| ResetTimeout types.Int64 `tfsdk:"reset_timeout"` | ||
| JobTimeout types.Int64 `tfsdk:"simple_update_job_timeout"` | ||
| SoftwareId types.String `tfsdk:"software_id"` | ||
| Version types.String `tfsdk:"version"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.