Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Scalingo/terraform-provider-scalingo
Terraform provider to provision Scalingo applications and databases
https://github.com/Scalingo/terraform-provider-scalingo
Last synced: about 2 months ago
JSON representation
Terraform provider to provision Scalingo applications and databases
- Host: GitHub
- URL: https://github.com/Scalingo/terraform-provider-scalingo
- Owner: Scalingo
- License: mpl-2.0
- Created: 2018-05-07T07:40:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T16:59:29.000Z (5 months ago)
- Last Synced: 2024-08-04T03:03:20.276Z (5 months ago)
- Language: Go
- Size: 38.7 MB
- Stars: 10
- Watchers: 8
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-scalingo - Github - provider-scalingo-examples) / [Examples with Outscale](https://github.com/Scalingo/customer-terraform-docker-dev-prod-parity) (Tools / Apps deployed without adaptation)
README
# Terraform Provider
[Documentation](https://registry.terraform.io/providers/Scalingo/scalingo/latest/docs)
## Maintainers
This provider plugin is maintained by the [Scalingo](https://scalingo.com) team.
## Requirements
- [Terraform](https://developer.hashicorp.com/terraform/downloads)
- [Go](https://go.dev/doc/install) to build the provider plugin
## Usage
### Configuring with variables
```
variable "scalingo_api_token" {}
provider "scalingo" {
api_token = "${var.scalingo_api_token}"
region = "osc-fr1"
}
```
```bash
export TF_VAR_scalingo_api_token=tk-us-1234567890
terraform plan
```
### Configuration with environment variables
```
provider "scalingo" {}
```
```bash
export SCALINGO_REGION=osc-fr1
export SCALINGO_API_TOKEN=tk-us-1234567890
terraform plan
```
### Use terraform import
Some resources are using a specific syntax using a `:` to provide multiple information.
The terraform import command is formatted like the following:
```bash
terraform import
```
For example, to import alerts the ID is composed like: `:`
```bash
terraform import scalingo_alert.cpu_alert my-app:al-18f30d13-3c19-422d-a0d6-6cdb254baeb7
```
## Building The Provider
Clone repository to: `$GOPATH/src/github.com/Scalingo/terraform-provider-scalingo`
```sh
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/Scalingo
$ git clone [email protected]:Scalingo/terraform-provider-scalingo
```
Enter the provider directory and build the provider
```sh
$ cd $GOPATH/src/github.com/Scalingo/terraform-provider-scalingo
$ make build
```
## Using the provider
See [documentation](https://registry.terraform.io/providers/Scalingo/scalingo/latest/docs)
## Developing the Provider
If you wish to work on the provider, you'll first need
[Go](http://www.golang.org) installed on your machine (version 1.9+ is
*required*). You'll also need to correctly setup a
[GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding
`$GOPATH/bin` to your `$PATH`.
To compile the provider, run `make build`. This will build the provider and put
the provider binary in the `$GOPATH/bin` directory.
```sh
$ make bin
...
$ $GOPATH/bin/terraform-provider-scalingo
...
```
In order to test the provider, you can simply run `make test`.
```sh
$ make test
```
In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run.
```sh
$ make testacc
```
### Testing the plugin against the staging environment
Please read the README in the `scalingo-terraform` to get more information about
that.
### Testing the plugin against the development environment
First you will need to create a terraform configuration file defining the plugin installation path
```
# local_dev.tfrc
provider_installation {
dev_overrides {
"scalingo/scalingo" = "/bin/"
}
}
```
Then you can use the development plugin by precising the configuration path in the `TF_CLI_CONFIG_FILE` env variable
```
TF_CLI_CONFIG_FILE=./local_dev.tfrc terraform plan
```
Alternatively you can add the provider configuration to the `$HOME/.terraformrc` file
### Generate Documentation
Documentation of the provider is based on official Terraform documentation
plugin: https://github.com/hashicorp/terraform-plugin-docs
```
go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
tfplugindocs
```
By running the process, it will scan all resources metadata plus the examples
directory to generate a complete documentation structure in the `docs/`
directory.
## Release a New Version
Instructions on this [Notion page](https://www.notion.so/scalingooriginal/New-Terraform-Provider-Release-40cd0af66b1f48148fb641ea138a22e5).