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

Update registry_module.html.markdown #1447

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

amarrone-hashicorp
Copy link

Add in sentence about expected naming pattern for vcs{} block in generic VCS repos.

Description

After attempting to use the tfe provider to populate an HCP terraform PMR with some VCS backed modules I noticed that the naming convention of the VCS backed repo has to follow the terraform-PROVIDER-NAME pattern for modules in the public registry.

This is not documented in the provider documentation. Adding it to help others avoid the frustration I experienced.

For example the following code will not work:

resource "tfe_registry_module" "key_pair" {
  organization    = var.organization
  name            = "key-pair"
  vcs_repo {
    display_identifier = "root/key-pair"
    identifier         = "root/key-pair"
    oauth_token_id     = tfe_oauth_client.gitlab.oauth_token_id
  }
}

The display_identifier and identifier attributes need to follow the public module registry naming convention as shown below.

This is the expected naming convention that will allow the VCS connection to work:

resource "tfe_registry_module" "key_pair" {
  organization    = var.organization
  name            = "key-pair"
  vcs_repo {
    display_identifier = "root/terraform-aws-key-pair"
    identifier         = "root/terraform-aws-key-pair"
    oauth_token_id     = tfe_oauth_client.gitlab.oauth_token_id
    branch             = "main"
  }
}

Added in sentence about expected naming pattern for `vcs{}` block in generic VCS repos.
@amarrone-hashicorp amarrone-hashicorp requested a review from a team as a code owner August 22, 2024 21:39
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

1 similar comment
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant