Module Naming

[jmarhee]

I don't know if this repo intends to remain POC or will eventually become a published module for Terraform registry, but in the latter case, the repo should be renamed according to the required naming convention (i.e. terraform-equinix-harvester).

[dnoland1]

I have no issues renaming the repo, but not sure about publishing this as a module in the Terraform registry. @ibrokethecloud any thoughts?

[displague]

Publishing is lightweight and makes the project more discoverable and, more importantly, easier to consume:

terraform init --from-module=rancherlabs/harvester/equinix

or

module "harvester" {
  source = "rancherlabs/harvester/equinix"

  args = ...
}

[ibrokethecloud]

we should definitely rename the repo

[dnoland1]

I'm planning to rename the repo by end of day...

[dnoland1]

Repo has been renamed. @jmarhee Anything else you feel we should do for this issue or should we close it out?

[displague]

@dnoland1 @jmarhee could you semver tag it (v0.1.0, if not already semver tagged) and publish it in the Hashicorp registry?

https://registry.terraform.io/sign-in

Once published, the registry tracks all future semver tags.

[displague]

I see the module has been renamed to terraform-harvester-equinix. While this is fine and will allow for the module to be published and discoverable, the first part of the hyphenated name is intended to indicate the primary Terraform provider in use. https://developer.hashicorp.com/terraform/tutorials/modules/module#module-best-practices

In this case, that would be "equinix", alternatively "rancher2": https://github.com/rancherlabs/terraform-harvester-equinix/blob/main/provider.tf

If Rancher2, I would suggest "terraform-rancher2-harvester-on-equinix-metal"

[displague]

When this module is tagged and published, the GitHub "About" details can be updated to reference the TF Registry published URL.

This repo should also set a description and relevant tags in the About section for discoverability.