Skip to content

Commit

Permalink
Updates version number and cleans up some linter warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
webbbarker committed Apr 2, 2021
1 parent 8f7e354 commit ccad3cf
Showing 1 changed file with 34 additions and 26 deletions.
60 changes: 34 additions & 26 deletions docs/guides/local_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ page_title: "Local Installation"
---

### Terraform Version 0.12 Local Installation

* Download and install [Terraform](https://www.terraform.io/intro/getting-started/install.html)

**One-liner download for macOS / Linux:**
```

```sh
mkdir -p ~/.terraform.d/plugins &&
curl -Ls https://api.github.com/repos/Cox-Automotive/terraform-provider-alks/releases/latest |
jq -r ".assets[] | select(.browser_download_url | contains(\"$(uname -s | tr A-Z a-z)\")) | select(.browser_download_url | contains(\"amd64\")) | .browser_download_url" |
Expand All @@ -19,6 +21,7 @@ mkdir -p ~/.terraform.d/plugins &&
rm -rf terraform-provider-alks.zip &&
popd
```

**Manual Installation:**

* Download ALKS Provider binary for your platform from [Releases](https://github.com/Cox-Automotive/terraform-provider-alks/releases)
Expand All @@ -28,33 +31,36 @@ mkdir -p ~/.terraform.d/plugins &&
* Note: If you've used a previous version of the ALKS provider and created a `.terraformrc` file in your home directory you'll want to remove it prior to updating.

* Finally, configure Terraform.
* In your `versions.tf` or `main.tf` file you'll want to add the new ALKS provider as such:
```
provider "alks" {
url = "https://alks.coxautoinc.com/rest"
version = "YOUR_VERSION_HERE"
}
```
* In your `versions.tf` or `main.tf` file you'll want to add the new ALKS provider as such:

```hcl
provider "alks" {
url = "https://alks.coxautoinc.com/rest"
version = "YOUR_VERSION_HERE"
}
```

### Terraform Version 0.13+ Local Installation

* Download and install [Terraform](https://www.terraform.io/intro/getting-started/install.html)

**One-liner download for macOS / Linux:**
```
mkdir -p ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.11/darwin_amd64 &&

```sh
mkdir -p ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.12/darwin_amd64 &&
curl -Ls https://api.github.com/repos/Cox-Automotive/terraform-provider-alks/releases/latest |
jq -r ".assets[] | select(.browser_download_url | contains(\"$(uname -s | tr A-Z a-z)\")) | select(.browser_download_url | contains(\"amd64\")) | .browser_download_url" |
xargs -n 1 curl -Lo ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.11/darwin_amd64/terraform-provider-alks.zip &&
pushd ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.11/darwin_amd64 &&
unzip ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.11/darwin_amd64/terraform-provider-alks.zip -d terraform-provider-alks-tmp &&
xargs -n 1 curl -Lo ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.12/darwin_amd64/terraform-provider-alks.zip &&
pushd ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.12/darwin_amd64 &&
unzip ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.12/darwin_amd64/terraform-provider-alks.zip -d terraform-provider-alks-tmp &&
mv terraform-provider-alks-tmp/terraform-provider-alks* . &&
chmod +x terraform-provider-alks* &&
rm -rf terraform-provider-alks-tmp &&
rm -rf terraform-provider-alks.zip &&
popd
```
!> **Warning:** Your binary has been placed in `/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.11/darwin_amd64`. For more information on WHY, [read here](https://www.terraform.io/upgrade-guides/0-13.html#new-filesystem-layout-for-local-copies-of-providers).

!> **Warning:** Your binary has been placed in `/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.12/darwin_amd64`. For more information on WHY, [read here](https://www.terraform.io/upgrade-guides/0-13.html#new-filesystem-layout-for-local-copies-of-providers).

**Manual Installation:**

Expand All @@ -68,24 +74,26 @@ mkdir -p ~/.terraform.d/plugins/Cox-Automotive/engineering-enablement/alks/1.5.1
* Place / `mv` the downloaded binary into the directory above.

* Finally, configure Terraform.
* In your `versions.tf` or `main.tf` file you'll want to add the new ALKS provider as such:
```
terraform {
required_version = ">= 0.13"
required_providers {
alks = {
source = "Cox-Automotive/engineering-enablement/alks"
version = "YOUR_VERSION_HERE"
}
}
}
```
* In your `versions.tf` or `main.tf` file you'll want to add the new ALKS provider as such:

```hcl
terraform {
required_version = ">= 0.13"
required_providers {
alks = {
source = "Cox-Automotive/engineering-enablement/alks"
version = "YOUR_VERSION_HERE"
}
}
}
```

* Note: If you've previously installed our provider, and it is stored in your remote state: you may need to run the [`replace-provider` command](https://www.terraform.io/docs/commands/state/replace-provider.html).

---

### Supported Versions

| Terraform 0.10.x | Terraform 0.12.x | Terraform 0.13.x | Terraform 0.14.x |
| ---------------- | ---------------- | ---------------- | ---------------- |
| ALKS TFP 0.9.0 < 1.3.0 | ALKS TFP 1.3.0+ | ALKS TFP 1.3.0+ | ALKS TFP 1.3.0+ |

0 comments on commit ccad3cf

Please sign in to comment.