pinecone-io / aws-reference-architecture-pulumi

Pinecone AWS Reference Architecture

Pinecone AWS Reference Architecture with Pulumi

Introduction

The Pinecone AWS Reference Architecture is a distributed system that performs vector-database-enabled semantic search over Postgres records. It is appropriate for use as a starting point to a more specific use case or as a learning resource.

It is permissively licensed and supported by Pinecone's open-source team in order to ease getting started with high-scale use cases for Pinecone's highly scalable vector database.

Table of contents

• Introduction
• Getting started
• Detailed setup instructions
• Core concepts
• Architecture overview
• Common tasks
• Troubleshooting and FAQs
• Code of conduct
• Contribution guidelines
• License

Getting started:

Prerequisites

• AWS account
• Free Pinecone account
• Free Pulumi account

Quick start guide

1. Set Up AWS IAM User

   • Create a New IAM User: In your AWS account, create a new IAM user.
   • Security Credentials: Generate new security credentials for this IAM user.
   • Attach Administrator Policy: Attach the Administrator IAM policy to your IAM user, either directly or by adding the user to an appropriate IAM group.

2. Configure AWS Credentials

   • Add Credentials to AWS Profile: Insert your IAM user's access key ID and secret access key into your ~/.aws/credentials file.

3. Install Pulumi CLI

   • Download and install the Pulumi CLI.
   • Link GitHub Account: Complete your Pulumi account setup using your GitHub account.

4. Configure Pulumi

   • Set AWS Profile: Run pulumi config set aws:profile <your-aws-profile-name> to configure the AWS profile in Pulumi.

5. Obtain Pinecone API Key

   • Log into Pinecone's dashboard or create a free account to obtain your Pinecone API key and environment values.

6. Set Configuration Variables

   • Create a Pulumi stack: Run pulumi stack init <your-stack-name>

Configure the required configuration values. Replace $VALUE in the command below with your Pinecone and AWS configuration.

# Currently us-west-2 is the only supported region for deploying the Reference Architecture to, because Pinecone Serverless
# is in public preview and only available in some regions
pulumi config set aws:region us-west-2

# From your Pinecone account at https://app.pinecone.io
pulumi config set --secret PINECONE_API_KEY "$PINECONE_API_KEY"
# The PINECONE_INDEX can be any value to create an index with that name when the app starts.
pulumi config set PINECONE_INDEX "$PINECONE_INDEX"

7. Initialize and Run Pulumi Stack

   • Deploy Resources: Execute pulumi up to start the deployment.
   • Review and Confirm: Review the Pulumi preview of resources to be created. Confirm by selecting Yes to proceed.

License

The Pinecone AWS Reference Architecture is licensed under the Apache 2.0 license.