terraform provider pinecone

Terraform-Provider-Pinecone

Un proveedor de Terraform para administrar recursos en Pinecone. Para la documentación completa del proveedor, consulte la página del proveedor del registro

Inicio rápido

 terraform {
  required_providers {
    pinecone = {
      source  = " thiskevinwang/pinecone "
      version = " 0.1.2 "
    }
  }
}

provider "pinecone" {
  apikey      = var . pinecone_api_key # optional; PINECONE_API_KEY
  environment = var . pinecone_environment # optional; PINECONE_ENVIRONMENT
}

data "pinecone_collection" "existing-collection" {
  name = " my-existing-collection "
}

resource "pinecone_index" "my-first-index" {
  name   = " index-to-be-managed "
  metric = " cosine "
  pods   = 1

  source_collection = data . pinecone_collection . existing-collection . name
  dimension         = data . pinecone_collection . existing-collection . dimension
}

Desarrollo

Consulte el directorio de ejemplos para obtener varios ejemplos que se pueden ejecutar localmente.

Durante el desarrollo local, asegúrese de establecer un provider_override en su archivo de configuración de Terraform ( ~/.terraformrc ) para señalar al binario local.

 provider_installation {
  dev_overrides {
    # Adjust this path to point to the directory where the local provider
    # binary is present. It is likely your $GOPATH/bin directory.
    " thekevinwang.com/terraform-providers/pinecone " = " /Users/kevin/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 {}
}

 terraform {
  required_providers {
    pinecone = {
      source = " thekevinwang.com/terraform-providers/pinecone "
    }
  }
}

Pruebas

 cp .env.example .env
go test -v ./... 

Documentación

Este proyecto se basa en ./tools/tools.go para instalar tfplugindocs .

 export GOBIN=$PWD/bin
export PATH=$GOBIN:$PATH
go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
which tfplugindocs

Ejecute tfplugindocs para generar documentos y presente visite archivos individuales en https://registry.terraform.io/tools/doc-preview

Lanzamiento

Hay algunos pasos únicos que ya se han realizado y no se cubrirán en este readme. Consulte la siguiente nota al pie para obtener más información. ¹

Para lanzar una nueva versión del proveedor en el registro, se debe crear un nuevo lanzamiento de GitHub. Use los siguientes pasos para continuar.

1. Idealmente, estás en main y tienes un árbol de trabajo limpio.
2. Asegúrese de que el compromiso (también conocido como cabeza) que esté a punto de lanzar está etiquetado.
   • git tag v0.1.2
   • git push origin v0.1.2
3. Ejecutar goreleaser : GITHUB_TOKEN=$(gh auth token) goreleaser release --clean
   • Esto creará un nuevo lanzamiento de GitHub que debe ser detectado por el Registro de Terraform poco después.

Nota

La configuración de Goreleaser requiere que se establezca GPG_FINGERPRINT . Tal vez intente lo siguiente (debe ser probado)

 export GPG_FINGERPRINT= $( gpg --list-keys --with-colons | awk -F: ' $1 == "fpr" || $1 == "fp2" {print $10} ' | head -n 1 )
export GITHUB_TOKEN= $( gh auth token )
goreleaser release --clean

• Ref: https://unix.stackexchange.com/a/743986

Apéndice

• https://thekevinwang.com/2023/10/05/build-publish-terraform-provider
• https://docs.pinecone.io/
• https://github.com/hashicorp/terraform-plugin-framework
• https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-provider
• https://github.com/hashicorp/terraform-provider-hashicups-pf

Notas al pie

1. Docios sobre la publicación: https://developer.hashicorp.com/terraform/registry/providers/publishing#publishing-to-the-registry ↩