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

azurerm_nginx_deployment: Add dataplane API endpoint property #28379

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

puneetsarna
Copy link
Contributor

@puneetsarna puneetsarna commented Dec 24, 2024

  • As the property is useful for customers, it is worth exposing it as a resource attribute.
  • Also updated the data source with the same property.

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevent documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

- As the property is useful for customers, it is
  worth exposing it as a resource attribute.
- Also updated the data source with the same
  property.
@puneetsarna
Copy link
Contributor Author

 make acctests SERVICE='nginx' TESTARGS='-run=TestAccNginxDeploymentDataSource_basic'
==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/nginx -run=TestAccNginxDeploymentDataSource_basic -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccNginxDeploymentDataSource_basic
=== PAUSE TestAccNginxDeploymentDataSource_basic
=== CONT  TestAccNginxDeploymentDataSource_basic
--- PASS: TestAccNginxDeploymentDataSource_basic (412.67s)
PASS
ok  	github.com/hashicorp/terraform-provider-azurerm/internal/services/nginx	415.395s
terraform-provider-azurerm $
terraform-provider-azurerm $
terraform-provider-azurerm $ make acctests SERVICE='nginx' TESTARGS='-run=TestAccNginxDeployment_basic'
==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/nginx -run=TestAccNginxDeployment_basic -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccNginxDeployment_basic
=== PAUSE TestAccNginxDeployment_basic
=== CONT  TestAccNginxDeployment_basic
--- PASS: TestAccNginxDeployment_basic (423.04s)
PASS
ok  	github.com/hashicorp/terraform-provider-azurerm/internal/services/nginx	425.699s

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @puneetsarna LGTM 👍

Comment on lines +166 to +170
* `ip_address` - The IP address of the NGINX Deployment.

* `nginx_version` - The version of deployed NGINX.
* `nginx_version` - The version of the NGINX Deployment.

* `dataplane_api_endpoint` - The dataplane API endpoint of the NGINX Deployment.
Copy link
Member

Choose a reason for hiding this comment

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

Not important or a now problem, just mentioning it for future PRs but these should be listed in alphabetical order

Copy link
Contributor Author

Choose a reason for hiding this comment

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

got it 👍

Copy link
Contributor Author

@puneetsarna puneetsarna Jan 9, 2025

Choose a reason for hiding this comment

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

quick question on this. What if certain properties are more important than the ones when listed alphabetically?

As a user of the NGINXaaS instance, I will care more about the IP address and the version of the instance rather than the dataplane endpoint. Having stuff that the users care more about listed upfront usually helps with better UX.

Copy link
Member

Choose a reason for hiding this comment

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

We don't tend to consider ordering via importance of properties since this differs per resource and can also be subjective.

Properties that we consider important and are exempt from the alphabetical ordering that we try to follow and are always listed at the top are ones that are used to construct the resource's identifier and location.

@stephybun stephybun merged commit 4f77fbc into hashicorp:main Jan 9, 2025
40 checks passed
@github-actions github-actions bot added this to the v4.15.0 milestone Jan 9, 2025
stephybun added a commit that referenced this pull request Jan 9, 2025
jackofallops pushed a commit that referenced this pull request Jan 10, 2025
jackofallops added a commit that referenced this pull request Jan 10, 2025
* Update CHANGELOG.md for #28233

* Update for #28215

* Update CHANGELOG.md for #28279

* Update CHANGELOG.md #28269

* Update CHANGELOG.md #27876

* Update CHANGELOG.md #28069

* Update CHANGELOG.md for #28312

* Update CHANGELOG.md for #28278

* Update CHANGELOG.md #28311

* Update CHANGELOG.md undo 28311

* Update CHANGELOG.md #27874

* Update CHANGELOG.md

* Update CHANGELOG for #28352

* Update CHANGELOG.md for #28390

* Update CHANGELOG.md for #28398

* Update CHANGELOG.md for #28425

* Update CHANGELOG.md #28427

* Update CHANGELOG.md #28280

* Update CHANGELOG.md for #28319

* Update CHANGELOG.md #24801

* Update for #28360 #28216 #27830 #28404 #27401 #27122 #27931 #28442

* Update for #28379

* Update CHANGELOG.md for #28281

* Update for #28380

* Update for #27375

* Update for #25695

* Update CHANGELOG.md #27985

* Update CHANGELOG.md - update release date manually until can be scripted

* Update CHANGELOG.md revert date change as script available

* pre-release script updates

---------

Co-authored-by: stephybun <steph@hashicorp.com>
Co-authored-by: catriona-m <86247157+catriona-m@users.noreply.github.com>
Co-authored-by: Wyatt Fry <wyattfry@gmail.com>
Co-authored-by: sreallymatt <106555974+sreallymatt@users.noreply.github.com>
Co-authored-by: Matthew Frahry <mbfrahry@gmail.com>
Co-authored-by: kt <kt@katbyte.me>
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.

3 participants