Skip to content

Latest commit

 

History

History
307 lines (237 loc) · 10.9 KB

storage_volume.md

File metadata and controls

307 lines (237 loc) · 10.9 KB
Raw
title linkTitle page_title subcategory description
redfish_storage_volume resource
redfish_storage_volume
redfish_storage_volume Resource - terraform-provider-redfish
This Terraform resource is used to configure virtual disks on the iDRAC Server. We can Create, Read, Update, Delete the virtual disks using this resource.

redfish_storage_volume (Resource)

This Terraform resource is used to configure virtual disks on the iDRAC Server. We can Create, Read, Update, Delete the virtual disks using this resource.

~> Note: capacity_bytes and volume_type attributes cannot be updated.

Example Usage

variables.tf

/*
Copyright (c) 2022-2024 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

/*
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

/*
Copyright (c) 2022-2024 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.5.0"
      source  = "registry.terraform.io/dell/redfish"
    }
  }
}

provider "redfish" {
  # `redfish_servers` is used to align with enhancements to password management.
  # Map of server BMCs with their alias keys and respective user credentials.
  # This is required when resource/datasource's `redfish_alias` is not null
  redfish_servers = var.rack1
}

main.tf

/*
Copyright (c) 2020-2024 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_storage_volume" "volume" {
  for_each = var.rack1

  redfish_server {
    # Alias name for server BMCs. The key in provider's `redfish_servers` map
    # `redfish_alias` is used to align with enhancements to password management.
    # When using redfish_alias, provider's `redfish_servers` is required.
    redfish_alias = each.key

    user         = each.value.user
    password     = each.value.password
    endpoint     = each.value.endpoint
    ssl_insecure = each.value.ssl_insecure
  }

  storage_controller_id = "RAID.SL.3-1"

  volume_name = "TerraformVol"
  // This attribute is deprecated, and will be removed in a future release.
  // Plesae use the raid_type value instead
  // volume_type           = "Mirrored"

  // Sets the Raid level Options (RAID0, RAID1, RAID5, RAID6, RAID10, RAID50, RAID60)
  raid_type = "RAID0"

  // Name of the physical disk on which virtual disk should get created.
  drives = ["Physical Disk 0:1:0"]

  // Flag stating when to create virtual disk either "Immediate" or "OnReset"
  // For BOSS Drives this should be set to "OnReset" as reboot is needed for the virtual disk to be created
  settings_apply_time = "Immediate"

  // Reset parameters to be applied when upgrade is completed
  reset_type = "PowerCycle"

  reset_timeout = 100
  // The maximum amount of time to wait for the volume job to be completed

  volume_job_timeout = 1200

  // When creating on volumes on BOSS Controllers or with the encrypt field true this property is invalid. 
  //capacity_bytes        = 1073323222

  // When creating on volumes on BOSS Controllers or with the encrypt field true this property is invalid. 
  //optimum_io_size_bytes = 131072

  // Possible values are "Off", "ReadAhead", "AdaptiveReadAhead"
  read_cache_policy = "Off"

  // When creating on volumes on BOSS Controllers this property should be set to "WriteThrough"
  // Possible values are "ProtectedWriteBack", "WriteThrough", "UnprotectedWriteBack"
  write_cache_policy = "WriteThrough"

  // Possible values are "Disabled", "Enabled"
  disk_cache_policy = "Disabled"

  // Whether or not to encrypt the virtual disk, default to false
  // Once a virtual disk is set to encrypted status it cannot be changed
  // This flag is only supported on firmware levels 6 and above
  encrypted = true

  // by default, the resource uses the first system
  # system_id = "System.Embedded.1"

  lifecycle {
    ignore_changes = [
      capacity_bytes,
      volume_type
    ]
  }
}

After the successful execution of the above resource block, virtual disk would have been created. It can be verified through state file.

Schema

Required

  • drives (List of String) Drives
  • storage_controller_id (String) Storage Controller ID
  • volume_name (String) Volume Name

Optional

  • capacity_bytes (Number) Capacity Bytes
  • disk_cache_policy (String) Disk Cache Policy
  • encrypted (Boolean) Encrypt the virtual disk, default is false. This flag is only supported on firmware levels 6 and above
  • optimum_io_size_bytes (Number) Optimum Io Size Bytes
  • raid_type (String) Raid Type, Defaults to RAID0
  • read_cache_policy (String) Read Cache Policy
  • redfish_server (Block List) List of server BMCs and their respective user credentials (see below for nested schema)
  • reset_timeout (Number) Reset Timeout
  • reset_type (String) Reset Type
  • settings_apply_time (String) Settings Apply Time
  • system_id (String) System ID of the system
  • volume_job_timeout (Number) Volume Job Timeout
  • volume_type (String, Deprecated) Volume Type
  • write_cache_policy (String) Write Cache Policy

Read-Only

  • id (String) ID of the storage volume resource

Nested Schema for redfish_server

Optional:

  • endpoint (String) Server BMC IP address or hostname
  • password (String, Sensitive) User password for login
  • redfish_alias (String) Alias name for server BMCs. The key in provider's redfish_servers map
  • ssl_insecure (Boolean) This field indicates whether the SSL/TLS certificate must be verified or not
  • user (String) User name for login

Import

~> Note: Odata ID of all available volumes on a storage controller can be fetched by running the following GET request on the iDRAC "/redfish/v1/Systems/System.Embedded.1/Storage//Volumes/" Eg. redfish/v1/Systems/System.Embedded.1/Storage/RAID.Integrated.1-1/Volumes/ The ID of any storage controller on the iDRAC, in turn, can be fetched using the "redfish_storage" data source

Import is supported using the following syntax:

/*
Copyright (c) 2021-2024 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 import redfish_storage_volume.volume "{\"id\":\"<odata id of the volume>\",\"username\":\"<username>\",\"password\":\"<password>\",\"endpoint\":\"<endpoint>\",\"ssl_insecure\":<true/false>}"

# terraform import with redfish_alias. When using redfish_alias, provider's `redfish_servers` is required.
# redfish_alias is used to align with enhancements to password management.
terraform import redfish_storage_volume.volume "{\"id\":\"<odata id of the volume>\",\"redfish_alias\":\"<redfish_alias>\"}"
  1. This will import the storage volume instance with specified ID into your Terraform state.
  2. After successful import, you can run terraform state list to ensure the resource has been imported successfully.
  3. Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource's real-world configuration.
  4. Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
  5. Finally, execute terraform apply to bring the resource fully under Terraform's management.
  6. Now, the resource which was not part of terraform became part of Terraform managed infrastructure.