Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(doc): Update documentation for resource proxmox_virtual_environment_firewall_ipset #366

Merged
merged 1 commit into from
Jun 7, 2023

Conversation

pescobar
Copy link
Contributor

@pescobar pescobar commented Jun 6, 2023

I tried to add an ipset following the docs in https://github.com/bpg/terraform-provider-proxmox/blob/main/docs/resources/virtual_environment_firewall_ipset.md but I got this error:

 Error: Invalid resource type
│
│   on infra/proxmox-firewall/cluster-wide-ipsets.tf line 1, in resource "proxmox_virtual_environment_cluster_firewall_ipset" "admin_hosts":
│    1: resource "proxmox_virtual_environment_cluster_firewall_ipset" "admin_hosts" {
│
│ The provider bpg/proxmox does not support resource type "proxmox_virtual_environment_cluster_firewall_ipset".

Reviewing the code I noticed that the resource name is proxmox_virtual_environment_firewall_ipset and not proxmox_virtual_environment_cluster_firewall_ipset as mentioned in the docs. This PR fixes the docs.

It works when using resource "proxmox_virtual_environment_firewall_ipset" to add a cluster ipset. I haven't tested it at the VM level.

Contributor's Note

Please mark the following items with an [x] if they apply to your PR.
Leave the [ ] if they are not applicable, or if you have not completed the item.

  • I have added / updated documentation in /docs for any user-facing features or additions.
  • I have added / updated templates in /examples for any new or updated resources / data sources.
  • I have ran make examples to verify that the change works as expected.

Community Note

  • Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

@bpg bpg changed the title Fix docs for resource proxmox_virtual_environment_firewall_ipset fix(docs): Update documentation for resource proxmox_virtual_environment_firewall_ipset Jun 7, 2023
@conventional-commit-lint-gcf
Copy link

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

Copy link
Owner

@bpg bpg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks @pescobar!

@bpg bpg added the automerge label Jun 7, 2023
@bpg bpg merged commit 0aa33f0 into bpg:main Jun 7, 2023
10 checks passed
@bpg bpg changed the title fix(docs): Update documentation for resource proxmox_virtual_environment_firewall_ipset fix(doc): Update documentation for resource proxmox_virtual_environment_firewall_ipset Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants