Skip to content

Commit

Permalink
Merge pull request #57 from Cox-Automotive/updateReadme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
webbbarker committed May 17, 2019
2 parents e1a8f08 + 397fbc2 commit ad30d34
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This module is used for creating IAM Roles via the ALKS API.
* Download ALKS Provider binary for your platform from [Releases](https://github.com/Cox-Automotive/terraform-provider-alks/releases)

```
curl -L https://github.com/Cox-Automotive/terraform-provider-alks/releases/download/1.2.1/terraform-provider-alks-darwin-amd64.tar.gz | tar zxv
curl -L https://github.com/Cox-Automotive/terraform-provider-alks/releases/download/1.2.2/terraform-provider-alks-darwin-amd64.tar.gz | tar zxv
```

* Configure Terraform to use this plugin by placing the binary in `.terraform.d/plugins/` on MacOS/Linux or `terraform.d\plugins\` in your user's "Application Data" directory on Windows.
Expand All @@ -39,6 +39,7 @@ Static credentials can be provided via an `access_key`, `secret_key` and `token`
```
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.2.2"
access_key = "accesskey"
secret_key = "secretkey"
token = "sessiontoken"
Expand All @@ -51,7 +52,8 @@ You can provide your credentials via the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS

```
provider "alks" {
url = "https://alks.foo.com/rest"
url = "https://alks.foo.com/rest"
version = "~> 1.2.2"
}
```

Expand All @@ -70,6 +72,7 @@ You can use an AWS credentials file to specify your credentials. The default loc
```
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.2.2"
shared_credentials_file = "/Users/brianantonelli/.aws/credentials"
profile = "foo"
}
Expand All @@ -87,15 +90,17 @@ Your ALKS provider block can look just like this:

```
provider "alks" {
url = "https://alks.foo.com/rest"
url = "https://alks.foo.com/rest"
version = "~> 1.2.2"
}
```

Since Machine Identities work with Instance Profile Metadata directly, it can be helpful to assume another role or cross account trust. For example:

```
provider "alks" {
url = "https://alks.foo.com/rest"
url = "https://alks.foo.com/rest"
version = "~> 1.2.2"
assume_role {
role_arn = "arn:aws:iam::112233445566:role/acct-managed/JenkinsPRODAccountTrust"
}
Expand Down

0 comments on commit ad30d34

Please sign in to comment.