#community-help

Deploying Typesense in GCP Cloud Run

TLDR Christian had difficulties obtaining an API key for deploying Typesense in GCP Cloud Run. Kishore Nallan guided on API key creation when setting up Typesense server and suggested checking the Typesense self-hosting guide. Christian decided to run the Typesense in Kubernetes instead of Cloud Run. Nasim thanked Christian for sharing findings.

17mo

Join the chat

Feb 24, 2022 (20 months ago)

Photo of md5-faf0fdba0b6739a6706f05c15b6738c6

Christian

08:19 AM

Hi! I'm trying to deploy Typesense in GCP Cloud Run, but is not fully clear on how to obtain the API key. Do I need to set up a cluster on Typesense Cloud even though the intention was to keep things in GCP/Firebase?

Thankful for guidance 🙂

Photo of md5-4e872368b2b2668460205b409e95c2ea

Kishore Nallan

08:44 AM

👋 Are you self hosting Typesense on GCP? Christian

08:49

Kishore Nallan

08:49 AM

When you start the Typesense server, you set a master API key via --api-key CLI argument (or equivalent config file or environment variable). You can then use this master key to create additional keys with narrower permissions for searching or exposing to the front-end.

Christian

08:54 AM

Hi, yes, the intention is to self-host in GCP using the Docker image. I used the Firebase plugin, which asks for a API key during setup.

So if I understand correctly, I would start the instance in Cloud Run and set the key there, and thereafter run the Firebase plugin?

Kishore Nallan

08:55 AM

Correct, check this self hosting guide:

https://typesense.org/docs/guide/install-typesense.html#option-2-local-machine-self-hosting

It contains snippets that show how the server is started with a master API key.

Christian

08:59 AM

Great, thank you for the support! 😀

09:03

Christian

09:03 AM

Even though I'm clearly in over my head here... no idea how to run those commands on GCP 🙂

Kishore Nallan

09:03 AM

Are you using Docker?

09:04

Kishore Nallan

09:04 AM

You can set environment variables like this for Docker deployment.

09:05

Kishore Nallan

09:05 AM

export TYPESENSE_API_KEY=xyz

mkdir /tmp/typesense-data

docker run -p 8108:8108 -v/tmp/typesense-data:/data typesense/typesense:0.22.2 \
  --data-dir /data --api-key=$TYPESENSE_API_KEY --enable-cors

Christian

09:07 AM

Yes, but the Docker image has already been pushed to the artefact registry in GCP for deployment, and this looks like commands on a local machine, which makes me somewhat confused.

Kishore Nallan

09:08 AM

I'm sure GCP will allow you to pass environment variables to the Docker container for configuration.

Christian

09:09 AM

Ok, will investigate. Thanks again! 🙂

Kishore Nallan

09:11 AM

https://cloud.google.com/run/docs/configuring/environment-variables

Christian

01:05 PM

Could you maybe hint on how to enter these variables into CR? For example, how does one handle the directory creation in this context? And is the API key entered as a secret?

Thanks in advance, and sorry for basic questions. I'm somewhat of a newbie.

Kishore Nallan

01:07 PM

I'm afraid I'm not familiar with the GCP ecosystem apart from the basics. This is not anything specific to Typesense so I think posting on Stackoverflow should get you quick help. I would love to help here but my own knowledge is limited on GCP.

Christian

01:29 PM

Ok, thanks anyway 🙂

Feb 25, 2022 (20 months ago)

Christian

12:28 PM

Just to follow up and conclude this thread; I assume that the Typesense Docker container is stateful, so it will have to be run in Kubernetes instead of Cloud Run, which only handles stateless services.

It's a continuous learning process 🙂

Kishore Nallan

01:10 PM

👍

Jun 07, 2022 (17 months ago)

Photo of md5-46b59943e82de807cdb3cc937f78183a

Nasim

08:13 AM

Thanks Christian for sharing your findings. Been on the same rabbit hole.

Typesense

Lightning-fast, open source search engine for everyone | Knowledge Base powered by Struct.AI

Indexed 2779 threads (79% resolved)

Join Our Community Manage subscription

Similar Threads

Deploying Typesense on Google Cloud Run

Nicolas attempted to deploy Typesense on Google Cloud Run but encountered problems. CaptainCodeman advised that Cloud Run is unsuitable for Typesense and suggested using a container optimized VM.

12mo

Running Typesense in Docker Container on Windows 10

Christian had issues running Typesense in Docker due to an unrecognized data directory. Jason suggested a solution to fix the file path issue, which Christian successfully implemented using Windows Powershell.

11mo

Debugging Typesense API Key Error

James is getting an error related to the `x-typesense-api-key` header in their Typesense project. Harrison suggests passing the API key in the HTTP header, and Jason advises checking the key via curl and possibly closing a duplicate Typesense server.

21mo

Issues deploying Typesense to AWS EKS

Pavan had issues when deploying Typesense to AWS EKS. Kishore Nallan suggested deployment to plain EC2 instances and provided the API key information. Eventually, Pavan resolved the issue with Helm.

15mo

Deploying Typesense on Google Cloud Platform (GCP)

Stephane asked for advice on deploying Typesense on GCP and encountered an issue with persistent storage. Jason suggested using Linux VMs on GCP instead, which Stephane thanked them for and found a solution in the documentation.

13mo