Skip to content

48 prepare v040 rc1 #49

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 6 commits into from
Feb 27, 2026
Merged

48 prepare v040 rc1 #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
607442b
added announcement placeholder and new card in landing page #48
akyriako Feb 20, 2026
ff1dd83
added s3 card in landing page, updated zero-downtime updates #48 #35
akyriako Feb 20, 2026
4b37d06
change the define your cluster card text #48
akyriako Feb 20, 2026
c6859e9
added crd, examples and gateway warning #48
akyriako Feb 20, 2026
909a5e4
added admonitions for ingress and httproutes #48
akyriako Feb 23, 2026
ba66807
added crd and release for 040rc1 #48
akyriako Feb 27, 2026
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
2 changes: 2 additions & 0 deletions blog/2026-02-19-typesense30docscraper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ TyKO `0.3.7` is the first version tested with Typesense 30.x+, therefore is the
**Any earlier versions combinations might lead to undefined behavior and/or potential index corruption.**

:::

<!-- truncate -->
17 changes: 17 additions & 0 deletions blog/2026-02-27-release-0-4-0-rc.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
slug: release-0-4-0-rc-1
title: 0.4.0-rc.1
authors: [tykobot]
tags: [release]
---

## What's Changed

### 0.4.0-rc.1

* 219 upgrade operator sdk by @akyriako in https://github.com/akyriako/typesense-operator/pull/240
* 183 add support for gateway api by @akyriako in https://github.com/akyriako/typesense-operator/pull/244

**Full Changelog**: https://github.com/akyriako/typesense-operator/compare/typesense-operator-0.3.8...typesense-operator-0.4.0-rc.1

<!-- truncate -->
46 changes: 46 additions & 0 deletions docs/crds/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,52 @@ To expose your Typesense cluster via an `Ingress`, certain prerequisites must al

:::

## Gateway HttpRoutes

```yaml
apiVersion: ts.opentelekomcloud.com/v1alpha1
kind: TypesenseCluster
metadata:
name: tsc
spec:
image: typesense/typesense:30.1
replicas: 3
storage:
storageClassName: standard
enableCors: true
corsDomains: "https://docs.example.com"
httpRoutes:
- name: public
parentRef:
name: traefik-gateway
namespace: kube-system
hostnames:
- typesense.docs.example.com
- search.docs.example.com
enabled: true
- name: private
parentRef:
name: traefik-gateway
namespace: kube-system
section: web
hostnames:
- typesense-int.docs.example.com
enabled: true
referenceGrant: true
```

:::warning

**The operator does not configure or manage Gateways. Gateway setup is intentionally left out of scope because it is highly platform-specific and tightly coupled to cluster networking, security, and organizational policies. All required Gateway resources must be provisioned and maintained in advance by your platform or cluster engineering team.**

To expose your Typesense cluster via a `Gateway`, certain prerequisites must already be present in your Kubernetes cluster:

☑️ You will need a gateway controller present (example is using [Traefik Gateway Controller](https://doc.traefik.io/traefik/reference/routing-configuration/kubernetes/gateway-api/)). <br/>
☑️ You will need a `GatewayClass` and a `Gateway` configured. <br/>
☑️ You will need [cert-manager](https://cert-manager.io/) present that takes care of the TLS certiicates. <br/>

:::

## Metrics

```yaml
Expand Down
72 changes: 66 additions & 6 deletions docs/crds/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Typesense Kubernetes Operator is controlling the lifecycle of multiple Typesense
| podsInheritStatefulSetAnnotations | propagate all `StatefulSet` annotations to `Pods` | X | false |
| serviceAnnotations | user-defined annotations | X | |
| storage | check `StorageSpec` [below](#storagespec-optional) | | |
| ingress | check `IngressSpec` [below](#ingressspec-optional) | X | |
| ingress | check `IngressSpec` [below](#ingressspec-deprecated) | X | |
| httpRoutes | array of `HttpRouteSpec`; check [below](#httproutespec-optional) | X | |
| scrapers | array of `DocSearchScraperSpec`; check [below](#docsearchscraperspec-optional) | X | |
| metrics | check `MetricsSpec` [below](#metricsspec-optional) | X | |
| healthcheck | check `HealthCheckSpec` [below](#healthcheckspec-optional) | X | |
Expand Down Expand Up @@ -89,7 +90,28 @@ For more information about installing and configuring **JuiceFS** and **JuiceFS

:::

### IngressSpec (optional)
### IngressSpec (deprecated)

:::warning

As of **v0.4.0-rc.1**, following the events triggered by the Ingress NGINX retirement in March 2026 (see [here](https://www.kubernetes.dev/blog/2025/11/12/ingress-nginx-retirement/) the announcement of the Kubernetes SIG Network and the Security Response Committee),
Ingress API support is deprecated in favor of the more flexible and powerful Gateway API.

Although the operator will continue to support `Ingress` resources for the foreseeable future without any breaking changes,
**no new features or maintainance updates will be made to the `Ingress` implementation**.

For that reason, it is recommended to transition to use `HttpRoute` for new deployments or when updating existing ones.

Additionally, bear in mind that the Kubernetes project itself recommends the following regarding Ingress API (exerpt from the [Kubernetes documentation/Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/)):

"_The Kubernetes project recommends using Gateway instead of Ingress. The Ingress API has been frozen._

_This means that:_

_-The Ingress API is generally available, and is subject to the stability guarantees for generally available APIs. The Kubernetes project has no plans to remove Ingress from Kubernetes._
_-The Ingress API is no longer being developed, and will have no further changes or updates made to it._"

:::

| Name | Description | Optional | Default |
| ---------------------- | -------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -118,19 +140,57 @@ For more information about installing and configuring **JuiceFS** and **JuiceFS
| volumeMounts | additional mounts in the container | X | |

:::note
This feature makes use of the existence of [cert-manager](https://cert-manager.io/) in the cluster, but **does not** actively enforce it with an error. If no clusterIssuer is specified a valid certificate must be stored in a secret and the secret name must be provided in the tlsSecretName config.
1️⃣ This feature makes use of the existence of [cert-manager](https://cert-manager.io/) in the cluster, but **does not** actively enforce it with an error. If no clusterIssuer is specified a valid certificate must be stored in a secret and the secret name must be provided in the tlsSecretName config.

If you are targeting [Open Telekom Cloud](https://www.open-telekom-cloud.com/en), you might be interested in provisioning additionally the designated DNS solver webhook for Open Telekom Cloud. You can find it [here](https://github.com/akyriako/cert-manager-webhook-opentelekomcloud).
:::

:::caution
Although in official Typesense documentation under _Production Best Practices_ -> _Configuration_ is stated:
2️⃣ 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._"

It is highly recommended, from this operator's perspective, to always expose Typesense behind a reverse proxy (using the `referer` option).
:::

### HttpRouteSpec (optional)

| Name | Description | Optional | Default |
| -------------- | -------------------------------------------------------------------------------------- | -------- | ------------------------ |
| name | name of the route | | |
| enabled | enable this route | X | true |
| parentRef | reference to the parent `Gateway`; check `GatewayParentRef` [below](#gatewayparentref) | | |
| hostnames | array of hostnames to match for this route | | |
| path | path to match for this route | X | / |
| pathType | interpretation of the path matching | X | `ImplementationSpecific` |
| labels | user-defined labels | X | |
| annotations | user-defined annotations | X | |
| referenceGrant | enable cross-namespace reference to the parent `Gateway` | X | false |

:::warning

1️⃣ **The operator does not configure or manage Gateway(s). A `Gateway` setup is intentionally left out of scope because it is highly platform-specific and tightly coupled to cluster networking, security,
and organizational policies. All required `Gateway` resources must be provisioned and maintained in advance by your platform or cluster engineering team.**

To expose your Typesense cluster via a `Gateway`, certain prerequisites must already be present in your Kubernetes cluster:

🚧 You will need:

- a gateway controller present (example is using [Traefik Gateway Controller](https://doc.traefik.io/traefik/reference/routing-configuration/kubernetes/gateway-api/)). <br/>
- a `GatewayClass` and a `Gateway` configured. <br/>
- [cert-manager](https://cert-manager.io/) to be present that takes care of the TLS certiicates. <br/>

2️⃣ Activating the `HttpRoute` confiruration will automatically deactivate/ignore the `Ingress` one if it exists, but the `Ingress` resource which might be present in the cluster
will not be automatically deleted. It can be safely deleted manually, if not needed anymore.

:::

#### GatewayParentRef

| Name | Description | Optional | Default |
| ----------- | -------------------------------------------------------------- | -------- | ------- |
| name | name of the parent `Gateway` | | |
| namespace | namespace of the parent `Gateway` | | |
| sectionName | section of the parent `Gateway` to route to (e.g. "websecure") | X | |

### DocSearchScraperSpec (optional)

| Name | Description | Optional | Default |
Expand Down
12 changes: 7 additions & 5 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import type { Options as UmamiOptions } from '@dipakparmar/docusaurus-plugin-umami';

Expand Down Expand Up @@ -61,6 +61,8 @@ const config: Config = {
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
blogSidebarTitle: 'All posts',
blogSidebarCount: 'ALL',
},
theme: {
customCss: './src/css/custom.css',
Expand All @@ -85,13 +87,13 @@ const config: Config = {
position: 'left',
label: 'Docs',
},
{to: '/blog', label: 'Releases', position: 'left'},
{ to: '/blog', label: 'Releases', position: 'left' },
// {
// type: 'docsVersionDropdown',
// position: 'right'
// },
{
href: 'https://github.com/akyriako/typesense-operator',
{
href: 'https://github.com/akyriako/typesense-operator',
position: 'right',
className: 'navbar--github-link',
"aria-label": 'GitHub',
Expand Down
Loading