Skip to content

[Feature]: Improve documentation re ip_address, ipv4 #1955

@jpgeek

Description

@jpgeek

Description

Terraform provider v 3

Two simple updates for the documentation that I think would be helpful.

The documentation for instance.vps.ipv4:

ipv4 - This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address upon creation, and may get a single private IPv4 address if needed. You may need to open a support ticket to get additional IPv4 addresses.

It would be very nice to note that the result is a set (as opposed to a list or a string). Especially since ip_address is being deprecated.

The documentation for instance.vps.ip_address :

ip_address - A string containing the Linode's public IP address.

Makes no mention that it is being deprecated. However calling the method shows a deprecation warning. Noting that it is deprecated and giving an alternative such as:
tolist(linode_instance.vps.ipv4)[0]
would be helpful.

New or Affected Terraform Resources

No response

Potential Terraform Configuration

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementissues that request a enhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions