Skip to content

Commit 5b2829d

Browse files
Update README.md
1 parent 2d1cf7a commit 5b2829d

File tree

1 file changed

+63
-5
lines changed

1 file changed

+63
-5
lines changed

README.md

Lines changed: 63 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,69 @@ Requirements
55
------------
66

77
- [Terraform](https://www.terraform.io/downloads.html) 1.0.x
8-
- [Go](https://golang.org/doc/install) 1.16+ (to build the provider plugin)
8+
- [Go](https://golang.org/doc/install) 1.20+ (to build the provider plugin)
99

10-
Using the Provider from Terraform registry
11-
------------------------------------------
10+
See wiki: https://github.com/apache/cloudstack-terraform-provider/wiki
11+
12+
Installing from Github Release
13+
------------------------------
14+
15+
User can install the CloudStack Terraform Provider using the [Github Releases](https://github.com/apache/cloudstack-terraform-provider/releases) with the installation steps below.
16+
17+
Replace the `RELEASE` version with the version you're trying to install and use.
18+
19+
The valid `ARCH` options are:
20+
21+
- linux_amd64
22+
- linux_386
23+
- linux_arm64
24+
- linux_arm
25+
- darwin_amd64
26+
- darwin_arm64
27+
- freebsd_amd64
28+
- freebsd_386
29+
- freebsd_arm64
30+
- freebsd_arm
31+
32+
Steps for installation:
33+
34+
```
35+
RELEASE=0.5.0
36+
ARCH=darwin_arm64
37+
mkdir -p ~/.terraform.d/plugins/local/cloudstack/cloudstack/${RELEASE}/${ARCH}
38+
wget "https://github.com/apache/cloudstack-terraform-provider/releases/download/v${RELEASE}/cloudstack-terraform-provider_${RELEASE}_${ARCH}.zip"
39+
unzip cloudstack-terraform-provider_${RELEASE}_${ARCH}.zip -d cloudstack-terraform-provider_${RELEASE}
40+
mv cloudstack-terraform-provider_${RELEASE}/cloudstack-terraform-provider_v${RELEASE} ~/.terraform.d/plugins/local/cloudstack/cloudstack/${RELEASE}/${ARCH}/terraform-provider-cloudstack_v${RELEASE}
41+
```
42+
43+
To use the locally installed provider, please use the following in your main.tf etc, and then run `terraform init`:
44+
45+
```
46+
terraform {
47+
required_providers {
48+
cloudstack = {
49+
source = "local/cloudstack/cloudstack"
50+
version = "0.5.0"
51+
}
52+
}
53+
}
54+
55+
provider "cloudstack" {
56+
# Configuration options
57+
}
58+
```
59+
60+
Note: this can be used when users are not able to install using the Terraform registry.
61+
62+
Installing from Terrafrom registry
63+
----------------------------------
1264
To install the CloudStack provider, copy and paste the below code into your Terraform configuration. Then, run terraform init.
1365
```sh
1466
terraform {
1567
required_providers {
1668
cloudstack = {
1769
source = "cloudstack/cloudstack"
18-
version = "0.4.0"
70+
version = "0.5.0"
1971
}
2072
}
2173
}
@@ -24,7 +76,13 @@ provider "cloudstack" {
2476
# Configuration options
2577
}
2678
```
27-
For more details on how to install and use the provider, click [here](website/) or visit https://registry.terraform.io/providers/cloudstack/cloudstack/latest/docs
79+
80+
User hitting installation issue using registry can install using the local install method.
81+
82+
Documentation
83+
-------------
84+
85+
For more details on how to use the provider, visit https://registry.terraform.io/providers/cloudstack/cloudstack/latest/docs
2886

2987
Developing the Provider
3088
---------------------------

0 commit comments

Comments
 (0)