https://github.com/aybabtme/terraform-provider-cockroach

Terraform provider for Cockroach DB.
https://github.com/aybabtme/terraform-provider-cockroach

Last synced: about 1 month ago
JSON representation

Terraform provider for Cockroach DB.

• Host: GitHub
• URL: https://github.com/aybabtme/terraform-provider-cockroach
• Owner: aybabtme
• License: mpl-2.0
• Created: 2021-04-13T09:26:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-14T09:03:05.000Z (almost 2 years ago)
• Last Synced: 2023-07-27T21:56:29.618Z (over 1 year ago)
• Language: Go
• Size: 7.46 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Terraform Provider Scaffolding

This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:

 - A resource, and a data source (`internal/provider/`),

 - Examples (`examples/`) and generated documentation (`docs/`),

 - Miscellaneous meta files.

 

These files contain boilerplate code that you will need to edit to create your own Terraform provider. A full guide to creating Terraform providers can be found at [Writing Custom Providers](https://www.terraform.io/docs/extend/writing-custom-providers.html).

Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://www.terraform.io/docs/registry/providers/publishing.html) so that others can use it.

## Requirements

-	[Terraform](https://www.terraform.io/downloads.html) >= 0.13.x

-	[Go](https://golang.org/doc/install) >= 1.15

## Building The Provider

1. Clone the repository

1. Enter the repository directory

1. Build the provider using the Go `install` command: 

```sh

$ go install

```

## Adding Dependencies

This provider uses [Go modules](https://github.com/golang/go/wiki/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

Fill this in for each provider

## Developing the Provider

If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#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`.

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

```sh

$ make testacc

```