Skip to content

Commit

Permalink
Add README (patch)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukiffer committed Jan 29, 2020
1 parent 54c4178 commit 075b785
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# package-azure

This repository contains modules for deploying and managing Microsoft Azure resources that are shared
across other modules or instances. For example, an Azure Resource Group may be shared across multiple
logical domains.


## Using a Terraform Module

To use a module in your Terraform templates, create a `module` resource and set its `source` field to the Git URL of
this repo. You should also set the `ref` parameter so you're fixed to a specific version of this repo, as the `master`
branch may have backwards incompatible changes (see [module sources](https://www.terraform.io/docs/modules/sources.html)).

For example, to use `1.0.0` of the `azure-function-app` module, you would add the following:

```hcl
module "function_app" {
source = "git::[email protected]:quantum-sec/package-azure-functions.git//modules/azure-function-app?ref=1.0.0"
// set the parameters for the azure-function-app module
}
```

_Note: the double slash (`//`) is intentional and required. It's part of Terraform's Git syntax (see [module sources](https://www.terraform.io/docs/modules/sources.html))._

See the module's documentation and `vars.tf` file for all the parameters you can set. Run `terraform get -update` to
pull the latest version of this module from this repo before running the standard `terraform plan` and
`terraform apply` commands.


## Using Scripts & Binaries

You can install the scripts and binaries in the `modules` folder of any repo using the [Gruntwork Installer](https://github.com/gruntwork-io/gruntwork-installer).
For example, if the scripts you want to install are in the `modules/ecs-scripts` folder of the
https://github.com/gruntwork-io/module-ecs repo, you could install them as follows:

```bash
gruntwork-install --module-name "ecs-scripts" --repo "https://github.com/gruntwork-io/module-ecs" --tag "0.0.1"
```

See the docs for each script & binary for detailed instructions on how to use them.

0 comments on commit 075b785

Please sign in to comment.