{"id":19797895,"url":"https://github.com/pinecone-io/aws-reference-architecture-pulumi","last_synced_at":"2025-04-05T19:11:40.207Z","repository":{"id":209468930,"uuid":"704623524","full_name":"pinecone-io/aws-reference-architecture-pulumi","owner":"pinecone-io","description":"Pinecone AWS Reference Architecture","archived":false,"fork":false,"pushed_at":"2024-12-18T10:03:04.000Z","size":17295,"stargazers_count":108,"open_issues_count":11,"forks_count":11,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T18:06:53.626Z","etag":null,"topics":["ai","aws","iac","pinecone","pulumi"],"latest_commit_sha":null,"homepage":"https://pinecone.io/blog/aws-reference-architecture","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pinecone-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-13T17:03:08.000Z","updated_at":"2025-03-02T03:01:45.000Z","dependencies_parsed_at":"2024-11-12T07:30:20.315Z","dependency_job_id":"3e4b3372-e32b-4697-b1a7-6da581b7188e","html_url":"https://github.com/pinecone-io/aws-reference-architecture-pulumi","commit_stats":{"total_commits":133,"total_committers":6,"mean_commits":"22.166666666666668","dds":0.1428571428571429,"last_synced_commit":"452cafa72bffba7947a0b1a135a344aa68fe0b04"},"previous_names":["pinecone-io/aws-reference-architecture-pulumi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecone-io%2Faws-reference-architecture-pulumi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecone-io%2Faws-reference-architecture-pulumi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecone-io%2Faws-reference-architecture-pulumi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecone-io%2Faws-reference-architecture-pulumi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinecone-io","download_url":"https://codeload.github.com/pinecone-io/aws-reference-architecture-pulumi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247386265,"owners_count":20930619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","aws","iac","pinecone","pulumi"],"created_at":"2024-11-12T07:27:16.822Z","updated_at":"2025-04-05T19:11:40.177Z","avatar_url":"https://github.com/pinecone-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pinecone AWS Reference Architecture with Pulumi\n\n[![Reference Architecture tests](https://github.com/pinecone-io/aws-reference-architecture-pulumi/actions/workflows/ci.yml/badge.svg)](https://github.com/pinecone-io/aws-reference-architecture-pulumi/actions/workflows/ci.yml)\n\n![Pinecone AWS Reference Architecture](./docs/pinecone-refarch-logo.png)\n\n## Introduction\n\nThe Pinecone AWS Reference Architecture is a distributed system that performs vector-database-enabled semantic search over Postgres records.\n\nIt is appropriate for use as a starting point to a more specific use case or as a learning resource.\n\nIt is permissively licensed and supported by Pinecone's open-source\nteam in order to ease getting started with high-scale use cases for Pinecone's highly scalable vector database.\n\n![Pinecone AWS Reference Architecture](./docs/aws-ref-arch-pulumi.png)\n\n## Table of contents\n\n* [Introduction](#introduction)\n* [Getting started](#getting-started)\n* [Detailed setup instructions](./docs/setup.md)\n* [Core concepts](./docs/core-concepts.md)\n* [Architecture overview](./docs/architecture.md)\n* [Common tasks](./docs/common-tasks.md)\n* [Troubleshooting and FAQs](./docs/troubleshooting-and-faq.md)\n* [Code of conduct](./docs/code-of-conduct.md)\n* [Contribution guidelines](./docs/contributing.md)\n* [License](#license)\n\n## Getting started\n\n### Prerequisites\n\n* [AWS account](https://aws.amazon.com/console/)\n* [Free Pinecone account](https://app.pinecone.io)\n* [Free Pulumi account](https://app.pulumi.com/?utm_source=pinecone\u0026utm_medium=github\u0026utm_campaign=pinecone-refarch)\n\n### Quick start guide\n\n1. **Set Up AWS IAM User**\n\n    * Create a New IAM User: In your AWS account, create a new IAM user.\n    * Security Credentials: Generate new security credentials for this IAM user.\n    * Attach Administrator Policy: Attach the Administrator IAM policy to your IAM user, either directly or by adding the user to an appropriate IAM group.\n\n2. **Configure AWS Credentials**\n\n    * Add Credentials to AWS Profile: Insert your IAM user's access key ID and secret access key into your `~/.aws/credentials` file.\n\n3. **Install Pulumi CLI**\n\n    * Download and [install the Pulumi CLI](https://www.pulumi.com/docs/install/?utm_source=pinecone\u0026utm_medium=github\u0026utm_campaign=pinecone-refarch).\n    * Link GitHub Account: [Complete your Pulumi account setup](https://app.pulumi.com/?utm_source=pinecone\u0026utm_medium=github\u0026utm_campaign=pinecone-refarch) using your GitHub account.\n\n4. **Configure Pulumi**\n\n    * Set AWS Profile: Run `pulumi config set aws:profile \u003cyour-aws-profile-name\u003e` to configure the AWS profile in Pulumi.\n\n5. **Obtain Pinecone API Key**\n\n    * [Log into Pinecone's dashboard or create a free account](https://app.pinecone.io) to obtain your Pinecone API key and environment values.\n\n6. **Set Configuration Variables**\n\n    * Create a Pulumi stack: Run `pulumi stack init \u003cyour-stack-name\u003e`\n\n    Configure the required configuration values. Replace `$VALUE` in the command below with your Pinecone and AWS configuration.\n\n    ```shell\n    # Currently us-west-2 is the only supported region for deploying the Reference Architecture to, because Pinecone Serverless\n    # is in public preview and only available in some regions\n    pulumi config set aws:region us-west-2\n\n    # From your Pinecone account at https://app.pinecone.io\n    pulumi config set --secret PINECONE_API_KEY \"$PINECONE_API_KEY\"\n    # The PINECONE_INDEX can be any value to create an index with that name when the app starts.\n    pulumi config set PINECONE_INDEX \"$PINECONE_INDEX\"\n    ```\n\n7. **Install SDK Dependencies**\n\n    * Run `pulumi install` to install the required dependencies.\n\n8. **Initialize and Run Pulumi Stack**\n\n    * Deploy Resources: Execute `pulumi up` to start the deployment.\n    * Review and Confirm: Review the Pulumi preview of resources to be created. Confirm by selecting `Yes` to proceed.\n\n## License\n\nThe Pinecone AWS Reference Architecture is licensed under [the Apache 2.0 license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinecone-io%2Faws-reference-architecture-pulumi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinecone-io%2Faws-reference-architecture-pulumi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinecone-io%2Faws-reference-architecture-pulumi/lists"}