terraform-provider-cloudscale

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

terraform-provider-cloudscale

★ 13 Open GitHub ↗

Terraform Cloudscale provider

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# cloudscale.ch Terraform Provider

- Website: https://www.terraform.io
- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)

## Using the Provider

For detailed usage instructions and examples, please refer to the official documentation available
at [Terraform Registry: cloudscale-ch/cloudscale](https://registry.terraform.io/providers/cloudscale-ch/cloudscale/latest).

## Developing the Provider

Before you begin, make sure you have [Go](http://golang.org) installed on your machine.

### Compile the Provider

Run the following command to compile the provider. The binary will be placed in your `$GOPATH/bin` directory.

```sh
go install
```

To create builds for different platforms, you can use [goreleaser](https://goreleaser.com/), for example
using Docker:

```sh
docker run -it --rm -v $PWD:/app --workdir=/app goreleaser/goreleaser:v2.13.1 release --snapshot --skip=publish --skip=sign --clean
```

### Testing Locally Compiled Driver

To test a locally compiled driver, add the following to your `~/.terraformrc` file.
This configuration directs Terraform to use your local `go/bin` directory for the cloudscale provider:

```hcl
# Contents of ~/.terraformrc
provider_installation {
  # Use go/bin as an overridden package directory
  # for the cloudscale-ch/cloudscale provider. This disables the version and checksum
  # verifications for this provider and forces Terraform to look for the
  # null provider plugin in the given directory.
  dev_overrides {
    "cloudscale-ch/cloudscale" = "/Users/[your-username]/go/bin"
  }

# For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}
```

*Remember to replace `[your-username]` with your actual username.*

### Running Acceptance Tests

> **Warning:** Only run acceptance tests against a dedicated cloudscale.ch project that contains no other resources. Tests may accidentially delete or modify existing resources in the project.

Acceptance tests create real resources and might incur costs. They also use a specific version of Terraform (see [Terraform CLI Installation Behaviors](https://www.terraform.io/plugin/sdkv2/testing/acceptance-tests#terraform-cli-installation-behaviors)).

- **Run all tests:**

```sh
  make testacc
  ```

- **Run a subset of the tests (e.g., tests for subnet):**

```sh
  TESTARGS="-run TestAccCloudscaleSubnet" make testacc
  ```

### Upgrading the cloudscale-go-sdk

- **Upgrade to the latest version:**

```sh
  go get -u github.com/cloudscale-ch/cloudscale-go-sdk/v5
  go mod tidy
  ```

### Working with Different Versions of the cloudscale-go-sdk

If you want to work with a local version or a specific version of the cloudscale-go-sdk during development, use the
following commands:

- **Replace with a local version:**

```sh
  go mod edit -replace "github.com/cloudscale-ch/cloudscale-go-sdk/v4=../cloudscale-go-sdk/"
  go mod tidy
  git commit -m "drop: Use local version of cloudscale-go-sdk"
  ```

- **Pin to a specific commit:**

```sh
  go mod edit -replace "github.com/cloudscale-ch/cloudscale-go-sdk/v4=github.com/cloudscale-ch/cloudscale-go-sdk/v4@<commit-hash>"
  go mod tidy
  git commit -m "drop: Pin specific commit of cloudscale-go-sdk"
  ```

- **Switch back to the upstream version:**

```sh
  go mod edit -dropreplace "github.com/cloudscale-ch/cloudscale-go-sdk/v4"
  go mod tidy
  ```

## Releasing the Provider

1. For major version releases: consider removing fields that were previously marked as `Deprecated`.
1. Ensure the `CHANGELOG.md` is up-to-date.
1. Ensure the `.github/workflows/terraform-integration-tests.yml` tests the 3 most recent Terraform versions.
1. Create a new release [on GitHub](https://github.com/cloudscale-ch/terraform-provider-cloudscale/releases/new).
   Both the tag and release title must follow this pattern: `v<<SEMVER>>`.
   Examples: `v42.43.44` or `v1.33.7-rc.1`.
1. It might take a moment until the release appears in the [Terraform registry](https://registry.terraform.io/providers/cloudscale-ch/cloudscale/latest).
   You can manually resync the provider when you are logged in to the registry.

## Developing the Documentation Website

Use the Terraform [doc preview tool](https://registry.terraform.io/tools/doc-preview) to test markdown rendering.

terraform-provider-cloudscale

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README