Skip to content

24 prepare v032 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akyriako merged 2 commits into from
Sep 12, 2025
Merged

24 prepare v032 #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4b9aed
added timeout in specs, changed version for exporter #24
akyriako Sep 12, 2025
9b88076
added release notes #24
akyriako Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions blog/2025-09-12-release-0-3-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
slug: release-0-3-2
title: 0.3.2
authors: [tykobot]
tags: [release]
---

## What's Changed

* FEATURE: configurable healthcheck timeout by @pgray in https://github.com/akyriako/typesense-operator/pull/161
* updated prometheus exporter default image #162 by @akyriako in https://github.com/akyriako/typesense-operator/pull/163

### New Contributors

* @pgray made their first contribution in https://github.com/akyriako/typesense-operator/pull/161

**Full Changelog**: https://github.com/akyriako/typesense-operator/compare/typesense-operator-0.3.1...typesense-operator-0.3.2

<!-- truncate -->
51 changes: 26 additions & 25 deletions docs/crds/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,29 @@ Typesense Kubernetes Operator is controlling the lifecycle of multiple Typesense

### TypesenseClusterSpec

| Name | Description | Optional | Default |
| ----------------------------- | -------------------------------------------------------- | -------- | ------------- |
| image | Typesense image | | |
| adminApiKey | Reference to the `Secret` to be used for bootstrap | X | |
| replicas | Size of the cluster (allowed 1, 3, 5 or 7) | | 3 |
| apiPort | REST/API port | | 8108 |
| peeringPort | Peering port | | 8107 |
| resetPeersOnError | automatic reset of peers on error | | true |
| enableCors | enables CORS | X | false |
| corsDomains | comma separated list of domains allowed for CORS | X | |
| resources | resource request & limit | X | _check specs_ |
| affinity | group of affinity scheduling rules | X | |
| nodeSelector | node selection constraint | X | |
| tolerations | schedule pods with matching taints | X | |
| additionalServerConfiguration | a reference to a `ConfigMap` holding extra configuration | X | |
| storage | check `StorageSpec` [below](#storagespec-optional) | | |
| ingress | check `IngressSpec` [below](#ingressspec-optional) | X | |
| scrapers | array of `DocSearchScraperSpec`; check below | X | |
| metrics | check `MetricsSpec` below | X | |
| healthcheck | check `HealthCheckSpec` below | X | |
| topologySpreadConstraints | how to spread a group of pods across topology domains | X | |
| incrementalQuorumRecovery | add nodes gradually to the statefulset while recovering | X | false |
| Name | Description | Optional | Default |
| -------------------------------- | -------------------------------------------------------- | -------- | ------------- |
| image | Typesense image | | |
| adminApiKey | Reference to the `Secret` to be used for bootstrap | X | |
| replicas | Size of the cluster (allowed 1, 3, 5 or 7) | | 3 |
| apiPort | REST/API port | | 8108 |
| peeringPort | Peering port | | 8107 |
| resetPeersOnError | automatic reset of peers on error | | true |
| enableCors | enables CORS | X | false |
| corsDomains | comma separated list of domains allowed for CORS | X | |
| resources | resource request & limit | X | _check specs_ |
| healthProbeTimeoutInMilliseconds | timeout for waiting on the health endpoint response | X | 500 |
| affinity | group of affinity scheduling rules | X | |
| nodeSelector | node selection constraint | X | |
| tolerations | schedule pods with matching taints | X | |
| additionalServerConfiguration | a reference to a `ConfigMap` holding extra configuration | X | |
| storage | check `StorageSpec` [below](#storagespec-optional) | | |
| ingress | check `IngressSpec` [below](#ingressspec-optional) | X | |
| scrapers | array of `DocSearchScraperSpec`; check below | X | |
| metrics | check `MetricsSpec` below | X | |
| healthcheck | check `HealthCheckSpec` below | X | |
| topologySpreadConstraints | how to spread a group of pods across topology domains | X | |
| incrementalQuorumRecovery | add nodes gradually to the statefulset while recovering | X | false |

:::note

Expand Down Expand Up @@ -88,9 +89,9 @@ If you are targeting [Open Telekom Cloud](https://www.open-telekom-cloud.com/en)
:::

:::caution
Although in official Typesense documentation under *Production Best Practices* -> *Configuration* is stated:
Although in official Typesense documentation under _Production Best Practices_ -> _Configuration_ is stated:

"*Typesense comes built-in with a high performance HTTP server that is used by likes of Fastly in their edge servers at scale. So Typesense can be directly exposed to incoming public-facing internet traffic, without the need to place it behind another web server like Nginx/Apache or your backend API.*"
"_Typesense comes built-in with a high performance HTTP server that is used by likes of Fastly in their edge servers at scale. So Typesense can be directly exposed to incoming public-facing internet traffic, without the need to place it behind another web server like Nginx/Apache or your backend API._"

It is highly recommended, from this operator's perspective, to always expose Typesense behind a reverse proxy (using the `referer` option).
:::
Expand All @@ -113,7 +114,7 @@ If you need to scrape a target that requires authentication, you can add the aut

| Name | Description | Optional | Default |
| --------- | ----------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| image | container image to use | X | [akyriako78/typesense-prometheus-exporter](https://github.com/akyriako/typesense-prometheus-exporter):0.1.7 |
| image | container image to use | X | [akyriako78/typesense-prometheus-exporter](https://github.com/akyriako/typesense-prometheus-exporter):0.1.9 |
| release | Prometheus release to become a target of | | |
| interval | interval in _seconds_ between two scrapes | X | 15 |
| resources | resource request & limit | X | _check specs_ |
Expand Down