Skip to content

Commit

Permalink
added primary_ip refernce to nac for consistency (IBM-Cloud#5847)
Browse files Browse the repository at this point in the history 
* added primary_ip refernce to nac for consistency

* Added the documents for primary_ip addition

* Added test cases
  • Loading branch information
@uibm
uibm authored Dec 8, 2024
1 parent 9a70188 commit 67161fe
Show file tree
Hide file tree
Showing 4 changed files with 233 additions and 3 deletions.
4 changes: 2 additions & 2 deletions ibm/acctest/acctest.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -841,8 +841,8 @@ func init() {
IsImage = os.Getenv("IS_IMAGE")
if IsImage == "" {
// IsImage = "fc538f61-7dd6-4408-978c-c6b85b69fe76" // for classic infrastructure
IsImage = "r006-907911a7-0ffe-467e-8821-3cc9a0d82a39" // for next gen infrastructure ibm-centos-7-9-minimal-amd64-10 image
fmt.Println("[INFO] Set the environment variable IS_IMAGE for testing ibm_is_instance, ibm_is_floating_ip else it is set to default value 'r006-907911a7-0ffe-467e-8821-3cc9a0d82a39'")
IsImage = "r006-587a041d-9246-44f0-980b-56a327cf5bd7" // for next gen infrastructure ibm-ubuntu-24-04-6-minimal-amd64-1 us-south
fmt.Println("[INFO] Set the environment variable IS_IMAGE for testing ibm_is_instance, ibm_is_floating_ip else it is set to default value 'r006-587a041d-9246-44f0-980b-56a327cf5bd7'")
}

IsImage2 = os.Getenv("IS_IMAGE2")
Expand Down
121 changes: 120 additions & 1 deletion ibm/service/vpc/resource_ibm_is_instance.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,55 @@ func ResourceIBMISInstance() *schema.Resource {
Computed: true,
Description: "The resource type.",
},
// primary_ip for consistency
"primary_ip": &schema.Schema{
Type: schema.TypeList,
Computed: true,
Description: "The primary IP address of the virtual network interface for the network attachment.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"address": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The IP address.If the address has not yet been selected, the value will be `0.0.0.0`.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.",
},
"deleted": &schema.Schema{
Type: schema.TypeList,
Computed: true,
Description: "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"more_info": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "Link to documentation about deleted resources.",
},
},
},
},
"href": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The URL for this reserved IP.",
},
"id": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The unique identifier for this reserved IP.",
},
"name": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The name for this reserved IP. The name is unique across all reserved IPs in a subnet.",
},
"resource_type": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The resource type.",
},
},
},
},
"id": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Expand Down Expand Up @@ -1198,7 +1247,55 @@ func ResourceIBMISInstance() *schema.Resource {
},
},
},

// primary_ip for consistency
"primary_ip": &schema.Schema{
Type: schema.TypeList,
Computed: true,
Description: "The primary IP address of the virtual network interface for the network attachment.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"address": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The IP address.If the address has not yet been selected, the value will be `0.0.0.0`.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.",
},
"deleted": &schema.Schema{
Type: schema.TypeList,
Computed: true,
Description: "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"more_info": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "Link to documentation about deleted resources.",
},
},
},
},
"href": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The URL for this reserved IP.",
},
"id": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The unique identifier for this reserved IP.",
},
"name": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The name for this reserved IP. The name is unique across all reserved IPs in a subnet.",
},
"resource_type": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Description: "The resource type.",
},
},
},
},
"virtual_network_interface": &schema.Schema{
Type: schema.TypeList,
MaxItems: 1,
Expand Down Expand Up @@ -7257,6 +7354,10 @@ func resourceIBMIsInstanceInstanceNetworkAttachmentReferenceToMap(model *vpcv1.I
vniMap["name"] = pna.VirtualNetworkInterface.Name
vniMap["resource_type"] = pna.VirtualNetworkInterface.ResourceType
}
if model.PrimaryIP != nil {
primaryipmap, _ := resourceIBMIsInstancePrimaryIPReferenceToMap(model.PrimaryIP)
modelMap["primary_ip"] = []map[string]interface{}{primaryipmap}
}
getVirtualNetworkInterfaceOptions := &vpcv1.GetVirtualNetworkInterfaceOptions{
ID: pna.VirtualNetworkInterface.ID,
}
Expand Down Expand Up @@ -7333,6 +7434,24 @@ func resourceIBMIsInstanceReservedIPReferenceToMap(model *vpcv1.ReservedIPRefere
}
return modelMap, nil
}
func resourceIBMIsInstancePrimaryIPReferenceToMap(model *vpcv1.ReservedIPReference) (map[string]interface{}, error) {
modelMap := make(map[string]interface{})
modelMap["address"] = model.Address
if model.Deleted != nil {
deletedMap, err := resourceIBMIsInstanceReservedIPReferenceDeletedToMap(model.Deleted)
if err != nil {
return modelMap, err
}
modelMap["deleted"] = []map[string]interface{}{deletedMap}
}
modelMap["href"] = model.Href
modelMap["id"] = model.ID
modelMap["name"] = model.Name
if model.ResourceType != nil {
modelMap["resource_type"] = model.ResourceType
}
return modelMap, nil
}

func resourceIBMIsInstanceReservedIPReferenceDeletedToMap(model *vpcv1.Deleted) (map[string]interface{}, error) {
modelMap := make(map[string]interface{})
Expand Down
91 changes: 91 additions & 0 deletions ibm/service/vpc/resource_ibm_is_instance_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3573,3 +3573,94 @@ func testAccCheckIBMISInstanceClusterNetworkAttachmentConfig(vpcname, clustersub
}
`, vpcname, acc.ISClusterNetworkProfileName, acc.ISZoneName, clustersubnetname, clustersubnetreservedipname, clusternetworkinterfacename, subnetName, acc.ISZoneName, sshKeyName, publicKey, instanceName, acc.IsImage, acc.ISInstanceGPUProfileName)
}

func TestAccIBMISInstance_primary_ip_consistency(t *testing.T) {
var instance string
vpcname := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100))
name := fmt.Sprintf("tf-instnace-%d", acctest.RandIntRange(10, 100))
subnetname := fmt.Sprintf("tf-subnet-%d", acctest.RandIntRange(10, 100))
publicKey := strings.TrimSpace(`
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR
`)
sshname := fmt.Sprintf("tf-ssh-%d", acctest.RandIntRange(10, 100))
userData1 := "a"

resource.Test(t, resource.TestCase{
PreCheck: func() { acc.TestAccPreCheck(t) },
Providers: acc.TestAccProviders,
CheckDestroy: testAccCheckIBMISInstanceDestroy,
Steps: []resource.TestStep{
{
Config: testAccCheckIBMISInstancePrimaryIpConsistencyConfig(vpcname, subnetname, sshname, publicKey, name, userData1),
Check: resource.ComposeTestCheckFunc(
testAccCheckIBMISInstanceExists("ibm_is_instance.testacc_instance", instance),
resource.TestCheckResourceAttr(
"ibm_is_instance.testacc_instance", "name", name),
resource.TestCheckResourceAttr(
"ibm_is_instance.testacc_instance", "user_data", userData1),
resource.TestCheckResourceAttr(
"ibm_is_instance.testacc_instance", "zone", acc.ISZoneName),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "vcpu.#"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "vcpu.0.manufacturer"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "primary_network_attachment.#"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "primary_network_attachment.0.primary_ip.#"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "primary_network_attachment.0.primary_ip.0.address"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "network_attachments.#"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "network_attachments.0.primary_ip.#"),
resource.TestCheckResourceAttrSet(
"ibm_is_instance.testacc_instance", "network_attachments.0.primary_ip.0.address"),
),
},
},
})
}

func testAccCheckIBMISInstancePrimaryIpConsistencyConfig(vpcname, subnetname, sshname, publicKey, name, userData string) string {
return fmt.Sprintf(`
resource "ibm_is_vpc" "testacc_vpc" {
name = "%s"
}
resource "ibm_is_subnet" "testacc_subnet" {
name = "%s"
vpc = ibm_is_vpc.testacc_vpc.id
zone = "%s"
ipv4_cidr_block = "%s"
}
resource "ibm_is_ssh_key" "testacc_sshkey" {
name = "%s"
public_key = "%s"
}
resource "ibm_is_instance" "testacc_instance" {
name = "%s"
image = "%s"
profile = "%s"
primary_network_attachment {
name = "example-primarynetwork-att"
virtual_network_interface {
auto_delete = true
subnet = ibm_is_subnet.testacc_subnet.id
}
}
user_data = "%s"
vpc = ibm_is_vpc.testacc_vpc.id
zone = "%s"
keys = [ibm_is_ssh_key.testacc_sshkey.id]
network_attachments {
name = "example-network-att"
virtual_network_interface {
auto_delete = true
subnet = ibm_is_subnet.testacc_subnet.id
}
}
}`, vpcname, subnetname, acc.ISZoneName, acc.ISCIDR, sshname, publicKey, name, acc.IsImage, acc.InstanceProfileName, userData, acc.ISZoneName)
}
20 changes: 20 additions & 0 deletions website/docs/r/is_instance.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -945,6 +945,16 @@ In addition to all argument reference list, you can access the following attribu
- `id` - (String) The ID of the instance.
- `memory`- (Integer) The amount of memory that is allocated to the instance in gigabytes.
- `numa_count` - (Integer) The number of NUMA nodes this instance is provisioned on. This property may be absent if the instance's status is not running.
- `network_attachments` - (List) The network attachments list for this virtual server instance.
Nested schema for **network_attachments**:

- `primary_ip` - (List) The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.

Nested scheme for `primary_ip`:
- `auto_delete` - (Bool) Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- `address` - (String) The IP address of the reserved IP.
- `name`- (String) The user-defined or system-provided name for this reserved IP
- `id`- (String) The unique identifier for this reserved IP.
- `network_interfaces`- (List of Strings) A list of more network interfaces that are attached to the instance.

Nested scheme for `network_interfaces`:
Expand All @@ -961,6 +971,16 @@ In addition to all argument reference list, you can access the following attribu
- `name`- (String) The user-defined or system-provided name for this reserved IP
- `reserved_ip`- (String) The unique identifier for this reserved IP
- `primary_ipv4_address` - (String, Deprecated) The primary IPv4 address. Same as `primary_ip.[0].address`
- `primary_network_attachment` - (List) The primary network attachment for this virtual server instance.
Nested schema for **primary_network_attachment**:

- `primary_ip` - (List) The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.

Nested scheme for `primary_ip`:
- `auto_delete` - (Bool) Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- `address` - (String) The IP address of the reserved IP.
- `name`- (String) The user-defined or system-provided name for this reserved IP
- `id`- (String) The unique identifier for this reserved IP.
- `primary_network_interface`- (List of Strings) A list of primary network interfaces that are attached to the instance.

Nested scheme for `primary_network_interface`:
Expand Down

0 comments on commit 67161fe

Please sign in to comment.