How to Deploy Typesense on Kubernetes

This guide provides a step-by-step tutorial to deploy Typesense, a fast and typo-tolerant search engine, on a Kubernetes cluster. The setup includes a secure configuration using Secrets, persistent storage, and external access through Ingress.

Prerequisites

1. Kubernetes Cluster: Ensure you have a running Kubernetes cluster with kubectl configured.
2. Namespace: Use the internal namespace for this deployment or modify it as needed.
3. Ingress Controller: Ensure an Ingress controller (e.g., NGINX) is installed in your cluster.

Step 1: Create a ConfigMap for Server Configuration

The ConfigMap stores the server-name for the Typesense instance.

apiVersion: v1
kind: ConfigMap
metadata:
  name: typesense-config
  namespace: internal
data:
  server-name: "typesense-node"

Apply the ConfigMap:

kubectl apply -f typesense-config.yaml

Step 2: Create a Secret for the API Key

The Secret secures the Typesense API key.

apiVersion: v1
kind: Secret
metadata:
  name: typesense-secret
  namespace: internal
type: Opaque
stringData:
  api-key: <your-secure-api-key> # Replace with your actual API key

Apply the Secret:

kubectl apply -f typesense-secret.yaml

Step 3: Configure Persistent Storage

Set up a PersistentVolumeClaim (PVC) for data storage.

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: typesense-pvc
  namespace: internal
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 10Gi
  storageClassName: local-path # Adjust based on your storage setup

Apply the PVC:

kubectl apply -f typesense-pvc.yaml

Step 4: Deploy Typesense

The Deployment defines the Typesense pod and configures environment variables using the Secret and ConfigMap.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: typesense
  namespace: internal
spec:
  replicas: 1
  selector:
    matchLabels:
      app: typesense
  template:
    metadata:
      labels:
        app: typesense
    spec:
      containers:
        - name: typesense
          image: typesense/typesense:0.24.0
          ports:
            - containerPort: 8108
          env:
            - name: TYPESENSE_API_KEY
              valueFrom:
                secretKeyRef:
                  name: typesense-secret
                  key: api-key
            - name: SERVER_NAME
              valueFrom:
                configMapKeyRef:
                  name: typesense-config
                  key: server-name
            - name: TYPESENSE_DATA_DIR
              value: /data
          volumeMounts:
            - name: typesense-data
              mountPath: /data
          resources:
            requests:
              memory: "1Gi"
              cpu: "1"
            limits:
              memory: "1Gi"
              cpu: "1"
      volumes:
        - name: typesense-data
          persistentVolumeClaim:
            claimName: typesense-pvc

Apply the Deployment:

kubectl apply -f typesense-deployment.yaml

Step 5: Create a Service for Access

Expose the Typesense pod using a Service. Use NodePort for direct access or modify it to ClusterIP for internal use.

apiVersion: v1
kind: Service
metadata:
  name: typesense-service
  namespace: internal
spec:
  type: NodePort
  selector:
    app: typesense
  ports:
    - protocol: TCP
      port: 8108
      targetPort: 8108
      nodePort: 30008 # Adjust the port as needed

Apply the Service:

kubectl apply -f typesense-service.yaml

Step 6: Configure Ingress

Set up an Ingress resource to route external traffic to the Typesense Service. Ensure your Ingress controller is properly configured.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ks3-ingress
  namespace: internal
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: /
spec:
  rules:
  - http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: typesense-service
            port:
              number: 8108

Apply the Ingress:

kubectl apply -f typesense-ingress.yaml

Step 7: Verify Deployment

1. Access Typesense via the Ingress URL (e.g., http://<your-domain>).

Check the status of the pods and services:

kubectl get pods -n internal
kubectl get svc -n internal
kubectl get ingress -n internal

以上資訊用ChatGPT整理。