The Oracle Cloud Infrastructure Compute Instance Terraform Module provides an easy way to launch compute instances and optionally create and attach any number of block volumes.
Please Note:
- The subnet, the compute instances, and the block volumes all must be in the same compartment, as specified by the
compartment_ocidparameter. - Oracle-provided images include rules that restrict access to the boot and block volumes. Oracle recommends that you do not use custom images without these rules unless you understand the security risks. See Compute Best Practices for recommendations on how to manage instances.
See the Oracle Cloud Infrastructure Terraform Provider docs for information about setting up and using the Oracle Cloud Infrastructure Terraform Provider.
The examples folder contains a detailed example that shows how to use this module.
The following code example creates an Oracle Cloud Infrastructure compute instance:
module "instance" {
source = "../../"
compartment_ocid = "${var.compartment_ocid}"
instance_display_name = "${var.instance_display_name}"
source_ocid = "${var.source_ocid}"
vcn_ocid = "${var.vcn_ocid}"
subnet_ocid = "${var.subnet_ocid}"
ssh_authorized_keys = "${var.ssh_authorized_keys_file}"
block_storage_sizes_in_gbs = [60, 70]
}Following are arguments available to the Compute Instance module:
| Argument | Description |
|---|---|
| compartment_ocid | Unique identifier (OCID) of the compartment in which the VCN is created |
| instance_display_name | Display name of the compute instance |
| extended_metadata | Additional metadata key/value pairs provided by the user |
| ipxe_script | The iPXE script which initiates the boot process on the compute instance |
| preserve_boot_volume | Specifies whether to delete or preserve the boot volume when the instance is terminated |
| boot_volume_size_in_gbs | The size of the boot volume in GBs |
| shape | The instance shape |
| assign_public_ip | Specifies whether the VNIC should be assigned a public IP address |
| vnic_name | A user-friendly name for the VNIC |
| hostname_label | The hostname for the VNIC's primary private IP |
| private_ip | A private IP address of your choice to assign to the VNIC |
| skip_source_dest_check | Specifies whether the source/destination check is disabled on the VNIC |
| subnet_ocid | Unique identifier (OCID) of the subnet in which the VNIC is created |
| ssh_authorized_keys | Path to the public SSH keys in the ~/.ssh/authorized_keys file for the default user on the instance |
| user_data | User-defined base64-encoded data to be used by Cloud-Init to run custom scripts, or provide a custom Cloud-Init configuration |
| source_ocid | Unique identifier (OCID) of an image or a boot volume, depending on the value of source_type. For more information, see Oracle Cloud Infrastructure Images |
| source_type | The source type for the instance |
| instance_timeout | Timeout setting for creating instance(Note: large instance types may need larger timeout than the default 25m) |
| instance_count | Number of instances to launch |
| block_storage_sizes_in_gbs | The size in GBs of block volumes created and attached to each instance |
| attachment_type | Attachment type (Note: paravirtualized attachment may not be supported by some instance images) |
| use_chap | Whether to use CHAP authentication for the volume attachment |
| resource_platform | Platform in which to create resources |
| vcn_ocid | Unique identifier (OCID) of the VCN |
Terraform supports using Windows Remote Management (WinRM) for connecting to Windows instances. Ensure that your Windows image has WinRM properly configured to allow remote access. Following is a sample WinRM configuration:
winrm quickconfig -q
winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="300"}’'
winrm set winrm/config ‘@{MaxTimeoutms=”1800000″}’
winrm set winrm/config/service '@{AllowUnencrypted="true"}'
winrm set winrm/config/service/auth '@{Basic="true"}'
netsh advfirewall firewall add rule name="WinRM 5985" protocol=TCP dir=in localport=5985 action=allow
netsh advfirewall firewall add rule name="WinRM 5986" protocol=TCP dir=in localport=5986 action=allow
net stop winrm
sc.exe config winrm start=auto
net start winrm-
For guidance configuring iSCSI on a Windows platform, see Adding a Block Volume to a Windows Instance.
-
For guidance configuring iSCSI on a Linux platform, see iSCSI Commands and Information. See also the example file remote-exec.tf for inline commands using
remote_exec_script.
Following is the sample inline script for not using CHAP authentication:
# Logging for troubleshooting.
set -x
sudo -s bash -c "lsscsi -t"
# Command provided in Oracle Cloud Infrastructure console to register ISCSI device.
sudo -s bash -c "iscsiadm -m node -o new -T ${self.iqn} -p ${self.ipv4}:${self.port}"
# Command provided in Oracle Cloud Infrastructure console for registration to survive reboot.
sudo -s bash -c "iscsiadm -m node -o update -T ${self.iqn} -n node.startup -v automatic"
# Command provided in Oracle Cloud Infrastructure console to log into iscsi device.
sudo -s bash -c "iscsiadm -m node -T ${self.iqn} -p ${self.ipv4}:${self.port} -l"
# troubleshooting command.
sudo -s bash -c "lsscsi -t"
# troubleshooting command.
lsscsi -t | grep disk | grep ${self.iqn} | awk '{print $1,$2,$3,$4,$5}'
# Find the specific OS level device that is associated with the iscsi volume.
device=$(lsscsi -t | grep disk | grep ${self.iqn} | awk '{print $4}')
# Create a file system on the device. In this case, we use the ext4 filesystem.
sudo -s bash -c "mkfs.ext4 -F $device"
# Find the UUID of the iscsi volume.
uuid=$(sudo blkid | grep $device | awk '{print $2}')
# Create a directory in the OS to mount the new filesystem.
sudo -s bash -c "mkdir -p ${var.volume_mount_directory}"
# Mount the filesystem so that it is available.
sudo -s bash -c "mount -t ext4 $uuid ${var.volume_mount_directory}"
# Ensure the filesystem is loaded on a reboot of the instance.
echo "$uuid ${var.volume_mount_directory} ext4 defaults,noatime,_netdev,nofail 0 2" | sudo tee --append /etc/fstab > /dev/null Following is the sample inline script for using CHAP authentication:
# Logging for troubleshooting.
set -x
sudo -s bash -c "lsscsi -t"
# Command provided in Oracle Cloud Infrastructure console to register ISCSI device.
sudo -s bash -c "iscsiadm -m node -o new -T ${self.iqn} -p ${self.ipv4}:${self.port}"
# Command provided in Oracle Cloud Infrastructure console for registration to survive reboot.
sudo -s bash -c "iscsiadm -m node -o update -T ${self.iqn} -n node.startup -v automatic"
# Authenticate the iSCSI connection by providing the volume's CHAP credentials.
sudo -s bash -c "iscsiadm -m node -T ${self.iqn} -p ${self.ipv4}:${self.port} -o update -n node.session.auth.authmethod -v CHAP"
# Provide the volume's CHAP user name.
sudo -s bash -c "iscsiadm -m node -T ${self.iqn} -p ${self.ipv4}:${self.port} -o update -n node.session.auth.username -v ${self.chap_username}"
# Provide the volume's CHAP password.
sudo -s bash -c "iscsiadm -m node -T ${self.iqn} -p ${self.ipv4}:${self.port} -o update -n node.session.auth.password -v ${self.chap_secret}"
# Command provided in Oracle Cloud Infrastructure console to log into iscsi device.
sudo -s bash -c "iscsiadm -m node -T ${self.iqn} -p ${self.ipv4}:${self.port} -l"
# troubleshooting command.
sudo -s bash -c "lsscsi -t"
# troubleshooting command.
lsscsi -t | grep disk | grep ${self.iqn} | awk '{print $1,$2,$3,$4,$5}'
# Find the specific OS level device that is associated with the iscsi volume.
device=$(lsscsi -t | grep disk | grep ${self.iqn} | awk '{print $4}')
# Create a file system on the device. In this case, we use the ext4 filesystem.
sudo -s bash -c "mkfs.ext4 -F $device"
# Find the UUID of the iscsi volume.
uuid=$(sudo blkid | grep $device | awk '{print $2}')
# Create a directory in the OS to mount the new filesystem.
sudo -s bash -c "mkdir -p ${var.volume_mount_directory}"
# Mount the filesystem so that it is available.
sudo -s bash -c "mount -t ext4 $uuid ${var.volume_mount_directory}"
# Ensure the filesystem is loaded on a reboot of the instance.
echo "$uuid ${var.volume_mount_directory} ext4 defaults,noatime,_netdev,nofail 0 2" | sudo tee --append /etc/fstab > /dev/null This project is open source. Oracle appreciates any contributions that are made by the open source community.
Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
Licensed under the Universal Permissive License 1.0 or Apache License 2.0.
See LICENSE for more details.