Skip to content

Commit 207556f

Browse files
committed
Add initial README
1 parent bbdf92f commit 207556f

File tree

1 file changed

+5
-39
lines changed

1 file changed

+5
-39
lines changed

README.md

Lines changed: 5 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
1-
# Terraform Provider Scaffolding (Terraform Plugin Framework)
1+
# Terraform Provider for Venafi TLS Protect Cloud Platform
22

3-
_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
3+
This is an experimental Terraform Provider for the Venafi TLS Protect Cloud Platform.
44

5-
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:
6-
7-
- A resource and a data source (`internal/provider/`),
8-
- Examples (`examples/`) and generated documentation (`docs/`),
9-
- Miscellaneous meta files.
10-
11-
These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the [HashiCorp Developer](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework) platform. _Terraform Plugin Framework specific guides are titled accordingly._
12-
13-
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.
14-
15-
Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://developer.hashicorp.com/terraform/registry/providers/publishing) so that others can use it.
5+
It has limited support at this stage. All contributions and feedback are both welcome and appreciated.
166

177
## Requirements
188

19-
- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
9+
- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.9.8
2010
- [Go](https://golang.org/doc/install) >= 1.22
2111

2212
## Building The Provider
@@ -29,24 +19,6 @@ Once you've written your provider, you'll want to [publish it on the Terraform R
2919
go install
3020
```
3121

32-
## Adding Dependencies
33-
34-
This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
35-
Please see the Go documentation for the most up to date information about using Go modules.
36-
37-
To add a new dependency `github.com/author/dependency` to your Terraform provider:
38-
39-
```shell
40-
go get github.com/author/dependency
41-
go mod tidy
42-
```
43-
44-
Then commit the changes to `go.mod` and `go.sum`.
45-
46-
## Using the provider
47-
48-
Fill this in for each provider
49-
5022
## Developing the Provider
5123

5224
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).
@@ -55,10 +27,4 @@ To compile the provider, run `go install`. This will build the provider and put
5527

5628
To generate or update documentation, run `make generate`.
5729

58-
In order to run the full suite of Acceptance tests, run `make testacc`.
59-
60-
*Note:* Acceptance tests create real resources, and often cost money to run.
61-
62-
```shell
63-
make testacc
64-
```
30+
In order to test your local build, you will need to setup a [`dev_override`](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-provider#prepare-terraform-for-local-provider-install). The provider address is `venafi.com/dev/tlspc`.

0 commit comments

Comments
 (0)