{"id":49426,"date":"2025-05-22T01:48:50","date_gmt":"2025-05-22T01:48:50","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=49426"},"modified":"2025-05-22T01:48:50","modified_gmt":"2025-05-22T01:48:50","slug":"terraform-source-for-modules-from-git-all-patterns-examples","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/terraform-source-for-modules-from-git-all-patterns-examples\/","title":{"rendered":"Terraform source for Modules from Git: All Patterns & Examples"},"content":{"rendered":"\n

Here\u2019s a comprehensive tutorial on all valid Terraform module \"source\"<\/code> Git URL patterns<\/strong>, with clear examples<\/strong> (no Drivemode references), so you can master using modules from GitHub<\/strong>, GitLab<\/strong>, Bitbucket<\/strong>, and private repos<\/strong>.<\/p>\n\n\n\n

\n\n\n\n

\u2705 Terraform source<\/code> for Modules from Git: All Patterns & Examples<\/h1>\n\n\n\n

Terraform supports loading modules from Git repositories using either HTTPS<\/strong>, SSH<\/strong>, or GitHub short syntax<\/strong>. Below are all common patterns with examples.<\/p>\n\n\n\n

\n\n\n\n

\ud83d\udd39 1. GitHub (HTTPS)<\/h2>\n\n\n\n

Use this when you don’t want SSH keys or are using public repos.<\/p>\n\n\n

module<\/span> \"vpc\"<\/span> {\n  source = \"git::https:\/\/github.com\/terraform-aws-modules\/terraform-aws-vpc.git\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\u2705 With Subdirectory<\/h3>\n\n\n
module<\/span> \"s3\"<\/span> {\n  source = \"git::https:\/\/github.com\/your-org\/terraform-modules.git\/\/modules\/s3_bucket\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\u2705 With Tag \/ Branch<\/h3>\n\n\n
source = \"git::https:\/\/github.com\/your-org\/terraform-modules.git\/\/modules\/s3_bucket?ref=v1.2.0\"<\/span>\nsource = \"git::https:\/\/github.com\/your-org\/terraform-modules.git\/\/modules\/s3_bucket?ref=main\"<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
\ud83d\udd39 2. GitHub (SSH)<\/h2>\n\n\n\n
Use SSH if you’re pulling private modules using a deploy key or SSH agent.<\/p>\n\n\n
module<\/span> \"eks\"<\/span> {\n  source = \"git::ssh:\/\/git@github.com\/your-org\/terraform-modules.git\/\/modules\/eks_cluster?ref=main\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n
\u2705 Use git::ssh:\/\/<\/code> for SSH<\/strong> \u2013 don’t use raw git@github.com<\/code>.<\/p>\n<\/blockquote>\n\n\n\n
\n\n\n\n
\ud83d\udd39 3. GitHub (Short Syntax \u2013 Only for Public Modules)<\/h2>\n\n\n
module<\/span> \"vpc\"<\/span> {\n  source = \"github.com\/terraform-aws-modules\/terraform-aws-vpc\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n
\u26a0\ufe0f This works only for the root of the repo (no subdirectories, no tags).<\/p>\n<\/blockquote>\n\n\n\n
\n\n\n\n
\ud83d\udd39 4. GitLab (HTTPS)<\/h2>\n\n\n
module<\/span> \"firewall\"<\/span> {\n  source = \"git::https:\/\/gitlab.com\/your-org\/infra-modules.git\/\/firewall?ref=main\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
\ud83d\udd39 5. Bitbucket (HTTPS)<\/h2>\n\n\n
module<\/span> \"app\"<\/span> {\n  source = \"git::https:\/\/bitbucket.org\/your-team\/terraform-modules.git\/\/modules\/app?ref=release-1.0\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
\ud83d\udd39 6. Private Git Repos (with SSH)<\/h2>\n\n\n
module<\/span> \"db\"<\/span> {\n  source = \"git::ssh:\/\/git@bitbucket.org\/your-org\/terraform-db-modules.git\/\/rds?ref=main\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n
  • Make sure your runner (Terraform Cloud or CI) has access via SSH key.<\/li>\n\n\n\n
  • Can also use .netrc<\/code> or GIT_ASKPASS<\/code> for HTTPS auth in private repos.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n
    \ud83d\udce6 Structure of a Terraform Git Source URL<\/h2>\n\n\n
    git::<protocol<\/span>><\/span>:\/\/<host<\/span>><\/span>\/<repo<\/span>><\/span>.git\/\/<subdir<\/span>><\/span>?ref=<branch|tag|commit<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    Part<\/th>Example<\/th><\/tr><\/thead>
    git::<\/code> prefix<\/td>tells Terraform to treat it as a Git source<\/td><\/tr>
    https:\/\/<\/code> or ssh:\/\/<\/code><\/td>Git protocol<\/td><\/tr>
    \/\/modules\/x<\/code><\/td>points to subdirectory inside the repo<\/td><\/tr>
    ?ref=<\/code><\/td>tag, branch, or commit hash<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    \n\n\n\n
    \u2705 Pro Tips<\/h2>\n\n\n\n
    Tip<\/th>Reason<\/th><\/tr><\/thead>
    Always pin a tag using ?ref=...<\/code><\/td>Prevents breaking changes<\/td><\/tr>
    Use double slashes \/\/<\/code> before module subdir<\/td>Required for subdirectory paths<\/td><\/tr>
    Prefer HTTPS for public or Terraform Cloud<\/td>Easier integration<\/td><\/tr>
    Use SSH only if you\u2019ve configured keys properly<\/td>Avoids access errors<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    \n\n\n\n
    \ud83d\ude80 Real-World Example<\/h2>\n\n\n\n
    Let\u2019s say you have this repo:<\/p>\n\n\n
    https:\/\/github.com\/acme-corp\/terraform-infra-modules<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    With a folder structure like:<\/p>\n\n\n
    terraform-infra-modules\/\n\u251c\u2500\u2500 vpc\/\n\u251c\u2500\u2500 eks\/\n\u2514\u2500\u2500 s3\/\n<\/code><\/span><\/pre>\n\n\n
    You can use:<\/p>\n\n\n
    module<\/span> \"vpc\"<\/span> {\n  source = \"git::https:\/\/github.com\/acme-corp\/terraform-infra-modules.git\/\/vpc?ref=v1.0.0\"<\/span>\n}\n\nmodule<\/span> \"eks\"<\/span> {\n  source = \"git::ssh:\/\/git@github.com\/acme-corp\/terraform-infra-modules.git\/\/eks?ref=main\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    <\/p>\n","protected":false},"excerpt":{"rendered":"
    Here\u2019s a comprehensive tutorial on all valid Terraform module “source” Git URL patterns, with clear examples (no Drivemode references), so you can master using modules from GitHub, GitLab, Bitbucket, and… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-49426","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49426","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=49426"}],"version-history":[{"count":1,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49426\/revisions"}],"predecessor-version":[{"id":49427,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49426\/revisions\/49427"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=49426"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=49426"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=49426"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}