https://github.com/pinecone-io/terraform-provider-pinecone
Official Terraform provider for Pinecone
https://github.com/pinecone-io/terraform-provider-pinecone
Last synced: about 2 months ago
JSON representation
Official Terraform provider for Pinecone
- Host: GitHub
- URL: https://github.com/pinecone-io/terraform-provider-pinecone
- Owner: pinecone-io
- License: mpl-2.0
- Created: 2024-03-28T13:29:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-06T23:24:39.000Z (10 months ago)
- Last Synced: 2024-09-08T01:30:28.661Z (10 months ago)
- Language: Go
- Size: 243 KB
- Stars: 29
- Watchers: 17
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Terraform Provider for Pinecone
[](https://pkg.go.dev/github.com/pinecone-io/terraform-provider-pinecone)
[](https://goreportcard.com/report/github.com/pinecone-io/terraform-provider-pinecone)
The Terraform Provider for Pinecone allows Terraform to manage Pinecone resources.
Note: We take Terraform's security and our users' trust very seriously. If you
believe you have found a security issue in the Terraform Provider for Pinecone,
please responsibly disclose it by contacting us.
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) >= v1.4.6
- [Go](https://golang.org/doc/install) >= 1.20. This is necessary to build the
provider plugin.
## Installing the provider
The provider is registered in the official [Terraform
registry](https://registry.terraform.io/providers/pinecone-io/pinecone/latest).
This enables the provider to be auto-installed when you run ```terraform
init```. You can also download the latest binary for your target platform from
the
[releases](https://github.com/pinecone-io/terraform-provider-pinecone/releases)
tab.
## Building the provider
Follow these steps to build the Terraform Provider for Pinecone:
1. Clone the repository using the following command:
```
sh $ git clone https://github.com/pinecone-io/terraform-provider-pinecone
```
1. Build the provider using the following command. The install directory depends
on the `GOPATH` environment variable.
```
sh $ go install .
```
## Usage
You can enable the provider in your Terraform configuration by adding the
following to your Terraform configuration file:
```terraform
terraform {
required_providers {
pinecone = {
source = "pinecone-io/pinecone"
}
}
}
```
### Pinecone API Key
Your Pinecone API Key is required to use the Terraform Provider. There are a
couple of ways to configure this.
### As a `PINECONE_API_KEY` environment variable
You can configure the Pinecone client using environment variables to avoid
setting sensitive values in the Terraform configuration file. To do so, set
`PINECONE_API_KEY` to your Pinecone API Key. Then the `provider` declaration
is simply:
```terraform
provider "pinecone" {}
```
### As part of the `provider` declaration
If your API key was set as an [Input Variable](https://developer.hashicorp.com/terraform/language/values/variables),
you can use that value in the declaration. For example:
```terraform
provider "pinecone" {
api_key = var.pinecone_api_key
}
```
Remember, your API Key should be a protected secret. See how to
[protect sensitive input variables](https://developer.hashicorp.com/terraform/tutorials/configuration-language/sensitive-variables)
when setting your API Key this way.
## Documentation
Documentation can be found on the [Terraform
Registry](https://registry.terraform.io/providers/pinecone-io/pinecone/latest).
## Examples
See the
[examples](https://github.com/pinecone-io/terraform-provider-pinecone/tree/main/examples)
for example usage.
## Support
Please create an issue for any support requests.
## Contributing
Thank you to [skyscrapr](https://github.com/skyscrapr/) for developing this
Terraform Provider. The original repository can be found at
[skyscrapr/terraform-provider-pinecone](https://github.com/skyscrapr/terraform-provider-pinecone).
He continues to be the primary developer of this codebase.
We welcome all contributions. If you identify issues or improvements, please
create an issue or pull request.