Skip to main content

Getting Started

The Typesense Kubernetes Operator (TyKO) is designed to manage the deployment and lifecycle of Typesense clusters within Kubernetes environments. The operator is developed in Go using Operator SDK Framework, an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way.

Meet Tyko, our mascot​

Tyko is the archaic Finnish form of the Danish name Tyge, which itself comes from the Old Norse name Tóki. Tóki was originally a hypocoristic of names built on the Norse god’s name Þórr (“Thor”) combined with ketill (“cauldron”).

Because its root names invoke Thor, Tyko carries connotations of strength, thunder and protection in Scandinavian lore, and is often referred to as the “little thunder”.

Tyko logo

Key Features​

Key features of Typesense Kubernetes Operator include:

  1. Custom Resource Management: Provides a Kubernetes-native interface to define and manage Typesense cluster configurations using a Custom Resource Definition (CRD) named TypesenseCluster.

  2. Typesense Lifecycle Automation: Simplifies deploying, scaling, and managing Typesense clusters.

    It handles aspects as:

    • bootstrapping Typesense's Admin API Key creation as a Secret.
    • deploying Typesense as a StatefulSet, each Pod consists of three containers:
      • the Typesense node itself based on the image provided in the specs,
      • the Typesense node metrics exporter (as a sidecar), based on the image provided in the spec.metricsSpec,
      • the Typesense cluster aggregated healthcheck (as a sidecar), exposed on port 8808 (non-configurable).
    • provisioning Typesense services (headless, discovery and healthcheck Services),
    • actively discovering and updating Typesense's nodes list (quorum configuration mounted as ConfigMap).
    • placing claims for Typesense PersistentVolumes.
    • optionally exposing Typesense API endpoint via an Ingress.
    • optionally provisioning one or multiple instances (one per target URL) of DocSearch as Cronjobs.
    • optionally provisioning Prometheus targets for the Pod metrics via a PodMonitor.

  3. Raft Quorum Configuration & Recovery Automation:

    • Continuous active (re)discovery of the quorum configuration reacting to changes in ReplicaSet without the need of an additional sidecar container,
    • Automatic recovery of a cluster that has lost quorum without the need of manual intervention.

Disclaimer​

TyKO is an independent and unofficial implementation and is not affiliated with or endorsed by Typesense, Inc. TyKO is provided as-is without any warranties or guarantees. Use at your own risk.

While every effort has been made to ensure correctness and reliability, the maintainers are not responsible for any data loss, downtime, or other issues arising from the use of this software in production or other environments.

Before deploying in a critical environment, we strongly recommend:

  • Thoroughly reviewing the source code,
  • Testing in a safe, non-production setting,
  • Keeping up to date with issues and pull requests.

By using TyKO, you agree that you assume full responsibility for any outcomes related to its use.