Update sources.html.markdown (#14594)

* Update sources.html.markdown

Moduels not updating was really annoying, should add this documentation in to increase usability of the feature.

* Update sources.html.markdown
This commit is contained in:
Seth Rutner 2017-05-24 05:29:56 -06:00 committed by Paul Stack
parent c08253e8d5
commit c3a76c99da
1 changed files with 22 additions and 1 deletions

View File

@ -87,7 +87,7 @@ module "private-infra" {
## Bitbucket ## Bitbucket
Terraform will automatically recognize Bitbucket URLs and turn them into a link to the specific Git or Mercurial repository, for example: Terraform will automatically recognize public Bitbucket URLs and turn them into a link to the specific Git or Mercurial repository, for example:
```hcl ```hcl
module "consul" { module "consul" {
@ -107,6 +107,25 @@ module "consul" {
Bitbucket URLs will require that Git or Mercurial is installed on your system, depending on the type of repository. Bitbucket URLs will require that Git or Mercurial is installed on your system, depending on the type of repository.
## Private Bitbucket Repos
Private bitbucket repositories must be specified similar to the Generic Git Respository section below.
```hcl
module "consul" {
source = "git::https://bitbucket.org/foocompany/module_name.git
}
```
You can also specify branches and version withs the ?ref query
```hcl
module "consul" {
source = "git::https://bitbucket.org/foocompany/module_name.git?hotfix
}
```
You will need to run a `terraform get -update=true` if you want to pull the latest versions. This can be handy when you are rapidly iterating on a module in development.
## Generic Git Repository ## Generic Git Repository
Generic Git repositories are also supported. The value of `source` in this case should be a complete Git-compatible URL. Using generic Git repositories requires that Git is installed on your system. Generic Git repositories are also supported. The value of `source` in this case should be a complete Git-compatible URL. Using generic Git repositories requires that Git is installed on your system.
@ -141,6 +160,8 @@ module "consul" {
} }
``` ```
Terraform will cache the module locally by default `terraform get` is run, so successive updates to master or a specified branch will not be factored into future plans. Run `terraform get -update=true` to get the latest version of the branch. This is handy in development, but potentially bothersome in production if you don't have control of the repository.
## Generic Mercurial Repository ## Generic Mercurial Repository
Generic Mercurial repositories are supported. The value of `source` in this case should be a complete Mercurial-compatible URL. Using generic Mercurial repositories requires that Mercurial is installed on your system. You must tell Terraform that your `source` is a Mercurial repository by prefixing it with `hg::`. Generic Mercurial repositories are supported. The value of `source` in this case should be a complete Mercurial-compatible URL. Using generic Mercurial repositories requires that Mercurial is installed on your system. You must tell Terraform that your `source` is a Mercurial repository by prefixing it with `hg::`.