Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinecone-io/aws-reference-architecture-pulumi
Pinecone AWS Reference Architecture
https://github.com/pinecone-io/aws-reference-architecture-pulumi
ai aws iac pinecone pulumi
Last synced: 2 days ago
JSON representation
Pinecone AWS Reference Architecture
- Host: GitHub
- URL: https://github.com/pinecone-io/aws-reference-architecture-pulumi
- Owner: pinecone-io
- License: apache-2.0
- Created: 2023-10-13T17:03:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-09T11:48:36.000Z (4 months ago)
- Last Synced: 2024-07-09T18:26:26.593Z (4 months ago)
- Topics: ai, aws, iac, pinecone, pulumi
- Language: TypeScript
- Homepage: https://pinecone.io/blog/aws-reference-architecture
- Size: 16.2 MB
- Stars: 97
- Watchers: 4
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Code of conduct: docs/code-of-conduct.md
Awesome Lists containing this project
README
# Pinecone AWS Reference Architecture with Pulumi
[](https://github.com/pinecone-io/aws-reference-architecture-pulumi/actions/workflows/ci.yml)
## 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](#introduction)
* [Getting started](#getting-started)
* [Detailed setup instructions](./docs/setup.md)
* [Core concepts](./docs/core-concepts.md)
* [Architecture overview](./docs/architecture.md)
* [Common tasks](./docs/common-tasks.md)
* [Troubleshooting and FAQs](./docs/troubleshooting-and-faq.md)
* [Code of conduct](./docs/code-of-conduct.md)
* [Contribution guidelines](./docs/contributing.md)
* [License](#license)
## Getting started
### Prerequisites
* [AWS account](https://aws.amazon.com/console/)
* [Free Pinecone account](https://app.pinecone.io)
* [Free Pulumi account](https://app.pulumi.com/?utm_source=pinecone&utm_medium=github&utm_campaign=pinecone-refarch)
### 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](https://www.pulumi.com/docs/install/?utm_source=pinecone&utm_medium=github&utm_campaign=pinecone-refarch).
* Link GitHub Account: [Complete your Pulumi account setup](https://app.pulumi.com/?utm_source=pinecone&utm_medium=github&utm_campaign=pinecone-refarch) using your GitHub account.
4. **Configure Pulumi**
* Set AWS Profile: Run `pulumi config set aws:profile ` to configure the AWS profile in Pulumi.
5. **Obtain Pinecone API Key**
* [Log into Pinecone's dashboard or create a free account](https://app.pinecone.io) to obtain your Pinecone API key and environment values.
6. **Set Configuration Variables**
* Create a Pulumi stack: Run `pulumi stack init `
Configure the required configuration values. Replace `$VALUE` in the command below with your Pinecone and AWS configuration.
```shell
# 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. **Install SDK Dependencies**
* Run `pulumi install` to install the required dependencies.
8. **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](./LICENSE).