Terraform Provider Development Program - Initial Review

[cgriggs01]

Hey Team, 👋

My name if Chris Griggs, I'm a Partner SE here at HashiCorp and will be working with you to prepare the VTM provider for its official release into the Terraform ecosystem.

It looks like you've but a lot of work into this Terraform VTM provider, which looks awesome! At first glance like you have over 40 resources and ~150 data source. Wow!

This first thing that I want to discuss with you is the two separate sets of provider code, which appears to be for two different API versions. Are you wanted to release the provider with both 4.0.0 and 5.2.0 supported APIs? If so, we'll have to have a deeper conversation about the best practices of this implementation, a couple options would be, either multiple repos, or add versions in to the resource names for a single provider, something like vtm_action and vtm_action_4 or something like that.

Other then that I have some basic items that are required for the release of the provider into the Terraform ecosystem:

• The documentation that you provided is thorough, but to release the provider under the TF ecosystem the documentation must be able to publish in terraform.io with all other provider docs. The docs will live under a website directory. the layout should look like the following:

website/
---> vtm.rbd # sidebar layout file
---> docs/
      ---> d/
               ----> data_source_1.html.markdown
               ----> data_source_2.html.markdown         
      ---> r/
               ----> resource_1.html.markdown
               ----> resource_2.html.markdown
      ---> index.html.markdown  # provider docs homepage

For a full example of the docs, just take a look and any other the current providers under the terraform-providers/ GH org.

• A CHANGELOG.md is necessary for the provider release process. The latest version of the changelog must follow the naming convention of x.x.x (Unreleased) as shown here.

• The README.md should follow the standard readme structure.

Please let me know if you have any questions, we can always hop on a call to discuss the providers review process.

Best,
Chris

[ndavidson-pulse]

Hi Chris,

Thanks for the feedback! We can certainly split major provider versions into separate repositories if that's helpful.

A quick explanation of our current plans regarding provider versions.- in version X.Y.Z The first two digits X.Y map exactly to the vTM REST API version they support, with the final digit Z being the version of the provider itself.

The intent was that each new major version of our REST API would get a new terraform provider, and we'd update existing terraform providers to support new minor versions of our APIs as and when new traffic managers were released.

If we need to discuss provider versioning and how it could fit into the wider terraform ecosystem a call might be a great way of covering lots of ground quickly.

Regards,

Nick

[ndavidson-pulse]

We've added a RELEASE_NOTES.txt file, but I see it doesn't qualify as it's not in the required CHANGELOG.md format - I'll think about how to update our internal release notes generator.