feat: add reserved IP support

var.assign_public_ip becomes deprecated
var.public_ip and var.public_ip_display_name are added to control this new resource

var.public_ip accept a string with value NONE, RESERVED or EPHEMERAL. each keyword does what it says.

fix #55

Author: kral2

CHANGELOG.adoc

@@ -19,6 +19,7 @@ Given a version number MAJOR.MINOR.PATCH:
 === Deprecated
 
 * `var.ssh_authorized_keys` is deprecated. Use `var.ssh_public_keys`.
+* `var.assign_public_ip` is deprecated. Use `var.public_ip` with the predefined keywords instead.
 
 === New features
 

docs/terraformoptions.adoc

@@ -25,11 +25,14 @@ No modules.
 |===
 |Name |Type
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_instance[oci_core_instance.this] |resource
+|https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_public_ip[oci_core_public_ip.this] |resource
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_volume[oci_core_volume.this] |resource
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_volume_attachment[oci_core_volume_attachment.this] |resource
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/core_instance_credentials[oci_core_instance_credentials.this] |data source
+|https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/core_private_ips[oci_core_private_ips.this] |data source
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/core_shapes[oci_core_shapes.ad1] |data source
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/core_subnet[oci_core_subnet.this] |data source
+|https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/core_vnic_attachments[oci_core_vnic_attachments.this] |data source
 |https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/identity_availability_domains[oci_identity_availability_domains.ad] |data source
 |===
 
@@ -45,7 +48,7 @@ No modules.
 |no
 
 |[[input_assign_public_ip]] <<input_assign_public_ip,assign_public_ip>>
-|Whether the VNIC should be assigned a public IP address.
+|Deprecated: use `var.public_ip` instead. Whether the VNIC should be assigned a public IP address (Always EPHEMERAL).
 |`bool`
 |`false`
 |no
@@ -146,6 +149,18 @@ No modules.
 |`[]`
 |no
 
+|[[input_public_ip]] <<input_public_ip,public_ip>>
+|OCID of the Public IP to attach to primary vnic. Valid values are NONE, RESERVED or EPHEMERAL.
+|`string`
+|`"NONE"`
+|no
+
+|[[input_public_ip_display_name]] <<input_public_ip_display_name,public_ip_display_name>>
+|(Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
+|`string`
+|`null`
+|no
+
 |[[input_resource_platform]] <<input_resource_platform,resource_platform>>
 |Platform to create resources in.
 |`string`
@@ -219,10 +234,16 @@ No modules.
 [cols="a,a",options="header,autowidth"]
 |===
 |Name |Description
+|[[output_instance_all_attributes]] <<output_instance_all_attributes,instance_all_attributes>> |all attributes of created instance
 |[[output_instance_id]] <<output_instance_id,instance_id>> |ocid of created instances.
 |[[output_instance_password]] <<output_instance_password,instance_password>> |Passwords to login to Windows instance.
 |[[output_instance_username]] <<output_instance_username,instance_username>> |Usernames to login to Windows instance.
 |[[output_instances_summary]] <<output_instances_summary,instances_summary>> |Private and Public IPs for each instance.
 |[[output_private_ip]] <<output_private_ip,private_ip>> |Private IPs of created instances.
+|[[output_private_ips_all_attributes]] <<output_private_ips_all_attributes,private_ips_all_attributes>> |all attributes of created private ips
 |[[output_public_ip]] <<output_public_ip,public_ip>> |Public IPs of created instances.
+|[[output_public_ip_all_attributes]] <<output_public_ip_all_attributes,public_ip_all_attributes>> |all attributes of created public ip
+|[[output_vnic_attachment_all_attributes]] <<output_vnic_attachment_all_attributes,vnic_attachment_all_attributes>> |all attributes of created vnic attachments
+|[[output_volume_all_attributes]] <<output_volume_all_attributes,volume_all_attributes>> |all attributes of created volumes
+|[[output_volume_attachment_all_attributes]] <<output_volume_attachment_all_attributes,volume_attachment_all_attributes>> |all attributes of created volumes attachments
 |===

examples/instances_reserved_public_ip/README.md

@@ -4,7 +4,7 @@ This example illustrates how to use this module to creates compute instances wit
 
 One modules will be configured:
 
-- 1 instance (1 OCPU, 1GB RAM) with a reserved public IP attached the primary VNIC.
+- 1 instance (1 OCPU, 1GB RAM) with a reserved public IP associated with the Primary IP of the primary VNIC.
 
 ## Prerequisites
 

examples/instances_reserved_public_ip/main.tf

@@ -37,15 +37,14 @@ module "instance_reserved_ip" {
   # operating system parameters
   ssh_authorized_keys = var.ssh_authorized_keys
   # networking parameters
-  assign_public_ip = var.assign_public_ip
-  public_ip        = var.public_ip
-  subnet_ocids     = var.subnet_ocids
+  public_ip    = var.public_ip # NONE, RESERVED or EPHEMERAL
+  subnet_ocids = var.subnet_ocids
   # storage parameters
   block_storage_sizes_in_gbs = [] # no block volume will be created
   preserve_boot_volume       = false
 }
 
 output "instance_reserved_ip" {
-  description = "ocid of created instances."
+  description = "IP information of the instances provisioned by this module."
   value       = module.instance_reserved_ip.instances_summary
 }

examples/instances_reserved_public_ip/variables.tf

@@ -111,16 +111,10 @@ variable "ssh_authorized_keys" {
 
 # networking parameters
 
-variable "assign_public_ip" {
-  description = "Whether the VNIC should be assigned a public IP address."
-  type        = bool
-  default     = false
-}
-
 variable "public_ip" {
   description = "OCID of the Public IP to attach to primary vnic."
   type        = string
-  default     = null
+  default     = "NONE"
 }
 
 variable "subnet_ocids" {

main.tf

@@ -148,34 +148,33 @@ resource "oci_core_volume_attachment" "this" {
 ####################
 
 data "oci_core_vnic_attachments" "this" {
-  #Required
+  count          = var.instance_count
   compartment_id = var.compartment_ocid
-
-  #Optional
-  instance_id = oci_core_instance.this[0].id
+  instance_id    = oci_core_instance.this[count.index].id
 
   depends_on = [
     oci_core_instance.this
   ]
 }
 
 data "oci_core_private_ips" "this" {
-  vnic_id = data.oci_core_vnic_attachments.this.vnic_attachments[0].vnic_id
+  count   = var.instance_count
+  vnic_id = data.oci_core_vnic_attachments.this[count.index].vnic_attachments[0].vnic_id
 
   depends_on = [
-  oci_core_instance.this
-]
+    oci_core_instance.this
+  ]
 }
 
-# resource "oci_core_public_ip" "this" {
-#   count = (var.assign_public_ip == true && var.public_ip == true) ? 1 : 0
-#   compartment_id = var.compartment_ocid
-#   lifetime =  "RESERVED"
+resource "oci_core_public_ip" "this" {
+  count          = var.public_ip == "NONE" ? 0 : var.instance_count
+  compartment_id = var.compartment_ocid
+  lifetime       = var.public_ip
 
-#   # display_name = var.public_ip_display_name
-#   private_ip_id = data.oci_core_private_ips.this.private_ips[0].id
-#   # public_ip_pool_id = oci_core_public_ip_pool.test_public_ip_pool.id
+  display_name  = var.public_ip_display_name != null ? var.public_ip_display_name : oci_core_instance.this[count.index].display_name
+  private_ip_id = data.oci_core_private_ips.this[count.index].private_ips[0].id
+  # public_ip_pool_id = oci_core_public_ip_pool.test_public_ip_pool.id # * (BYOIP CIDR Blocks) are not supported yet by this module.
 
-#   freeform_tags = local.merged_freeform_tags
-#   defined_tags = var.defined_tags
-#   }
+  freeform_tags = local.merged_freeform_tags
+  defined_tags  = var.defined_tags
+}

outputs.tf

@@ -50,21 +50,21 @@ output "instance_all_attributes" {
   value       = { for k, v in oci_core_instance.this : k => v }
 }
 
-# output "public_ip_all_attributes" {
-#   description = "all attributes of created instance"
-#   value       = { for k, v in oci_core_public_ip.this : k => v }
-# }
-
-output "vnic_attachment_all_attributes" {
-  description = "all attributes of created vnic attachments"
-  value       = { for k, v in data.oci_core_vnic_attachments.this : k => v }
+output "public_ip_all_attributes" {
+  description = "all attributes of created public ip"
+  value       = { for k, v in oci_core_public_ip.this : k => v }
 }
 
 output "private_ips_all_attributes" {
   description = "all attributes of created private ips"
   value       = { for k, v in data.oci_core_private_ips.this : k => v }
 }
 
+output "vnic_attachment_all_attributes" {
+  description = "all attributes of created vnic attachments"
+  value       = { for k, v in data.oci_core_vnic_attachments.this : k => v }
+}
+
 output "volume_all_attributes" {
   description = "all attributes of created volumes"
   value       = { for k, v in oci_core_volume.this : k => v }

variables.tf

@@ -126,8 +126,8 @@ variable "user_data" {
 # networking parameters
 
 variable "assign_public_ip" {
-  #! Deprecation notice: will be removed at next major release. Use "create_public_ip" instead.
-  description = "Whether the VNIC should be assigned a public IP address."
+  #! Deprecation notice: will be removed at next major release. Use `var.public_ip` instead.
+  description = "Deprecated: use `var.public_ip` instead. Whether the VNIC should be assigned a public IP address (Always EPHEMERAL)."
   type        = bool
   default     = false
 }
@@ -151,9 +151,20 @@ variable "private_ips" {
 }
 
 variable "public_ip" {
-  description = "OCID of the Public IP to attach to primary vnic."
-  type = string
-  default = null
+  description = "OCID of the Public IP to attach to primary vnic. Valid values are NONE, RESERVED or EPHEMERAL."
+  type        = string
+  default     = "NONE"
+
+  validation {
+    condition     = contains(["NONE", "RESERVED", "EPHEMERAL"], var.public_ip)
+    error_message = "Accepted values are NONE, RESERVED or EPHEMERAL."
+  }
+}
+
+variable "public_ip_display_name" {
+  description = "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable."
+  type        = string
+  default     = null
 }
 
 variable "skip_source_dest_check" {