https://github.com/glesys/terraform-provider-glesys

https://github.com/glesys/terraform-provider-glesys

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/glesys/terraform-provider-glesys
• Owner: glesys
• License: mpl-2.0
• Created: 2019-05-17T08:38:04.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T08:54:03.000Z (7 days ago)
• Last Synced: 2024-11-06T09:34:13.526Z (7 days ago)
• Language: Go
• Size: 372 KB
• Stars: 4
• Watchers: 5
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# terraform-provider-glesys

## intro

This is a early stage implementation for using Terraform and the GleSYS API.

Please see [GleSYS Go](https://github.com/glesys/glesys-go)  and [GleSYS API documentation](https://github.com/GleSYS/API-docs/wiki/API-Documentation) for more information.

## Installation

### Using the terraform-provider-glesys

In your Terraform configuration, add this. Then run `terraform init`

```

terraform {

  required_providers {

    glesys = {

      source = "glesys/glesys"

      # version = "0.14.0" # If you want to specify a certain release.

    }

  }

}

provider "glesys" {

  # Configuration options

}

```

`$ terraform init`

### Run terraform

Instead of hardcoding credentials into your terraform templates.

Use environment variables for example.

`GLESYS_USERID="CL12345" GLESYS_TOKEN="ABC12345678" terraform plan`

## Local development

### Debian requirements

- golang >= 1.22

- git

- make

- terraform # Fetch the latest version from https://www.terraform.io/downloads

### Setup terraform-provider-glesys for local development

Clone the repo into a folder of your liking.

`$ git clone https://github.com/glesys/terraform-provider-glesys.git`

### Install the plugin

```

$ cd terraform-provider-glesys

$ make

==> Checking that code complies with gofmt requirements...

go install

go: finding github.com/hashicorp/terraform v0.12.9

...

$ mkdir -p ~/.terraform.d/local_dev

$ ln -s ~/go/bin/terraform-provider-glesys ~/.terraform.d/local_dev/

```

Setup dev_overrides

Create a file `provider_overrides.tfrc` for example:

```

provider_installation {

  dev_overrides {

    "glesys/glesys" = "/home/myuser/.terraform.d/local_dev"

  }

  direct {}

}

```

Run terraform with environment variable `TF_CLI_CONFIG_FILE`

`$ TF_CLI_CONFIG_FILE=/path/to/provider_overrides.tfrc terraform plan`

## Contribute

#### We love Pull Requests ♥

1. Fork the repo.

2. Make sure to run the tests to verify that you're starting with a clean slate.

3. Add a test for your change, make sure it fails. Refactoring existing code or

   improving documentation does not require new tests.

4. Make the changes and ensure the test pass.

5. Commit your changes, push to your fork and submit a Pull Request.