linode / linode/ansible_linode
[Bug]: `linode.cloud.instance` module documentation is out of date and/or incorrect
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 63
- Forks
- 38
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 7
Description
### Ansible Version
ansible [core 2.19.4]
### Ansible Configuration
`linode.cloud` collection version 0.43.0
### Effected Components
_No response_
### Expected Behavior
When going through the documentation on how to configure an VPC interface I'd expect the documentation to be correct - https://github.com/linode/ansible_linode/blob/main/docs/modules/instance.md#interfaces
### Actual Behavior
The documentation is out of date or incorrect. The examples show one thing and parameters a different one none of them give the actual result. Going through the documentation I tried to configure a VPC interface for an instance but kept getting different errors inconsistent to what the documentation says I should do.
### Steps to Reproduce
Using the `linode.cloud.instance` try to create a new instance with the interfaces list defined below (replace the subnet_id and address accordingly).
```
interfaces:
- purpose: vpc
primary: true
subnet_id: 12345
label: interface_label_1
ipv4:
addresses:
- address: 10.0.0.10
nat_1_1_address: auto
primary: true
```
The documentation says these parameters should work but I get an error:
```
msg: 'Unsupported parameters for (linode.cloud.instance) module: interfaces.ipv4.addresses.
Supported parameters include: nat_1_1, vpc.'
```
I also tried different methods based on the error messages or using the `linode_interfaces` parameters but with with no luck.
Please update the documentation on how to configure VPC interfaces when creating a new instance.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read docs/modules/instance.md#interfaces first, then reproduce the reported linode.cloud.instance configuration with the shown interfaces list. Compare the documented parameters with the module’s reported supported parameters, and update the VPC interface documentation so its examples and parameter names match the behavior users encounter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, python
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100