README.md

Nextflow Tower terraform provider

This provider manages configuration for Sequera's Nextflow Tower product. It has been tested using the SaaS version.

For detailed documentation see the registry page.

Requirements

• Terraform >= 0.13.x
• Go >= 1.20

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

$ go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

provider "nftower" {
  api_key      = "..." // can also be set using NFTOWER_API_KEY
  organization = "my-org"
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

You will need to specify an api key using NFTOWER_API_KEY and an organization using NFTOWER_ORGANIZATION. You might need to create a new organisation in your Seqera account to use for testing. Additionally, for testing container registry resources, you will need use real credentials and to fill related resources data and resource tests.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

Making a release

If you wish to make a release, you must tag a commit with the version you wish to release and then push the tag to Github. A Github action will trigger to create the release and then the terraform registry will detect it and update.

git tag v1.2.3
git push origin v1.2.3

Contributing

Pull requests are always welcome! Please follow a few guidelines:

• If you update the documentation please re-renerate it using go generate ./... and commit the changes.

Contributors

gareth-rogers-healx

andyroyle

simon-turnbull-healx

timini