Skip to content

added release note, added scraper crd changes #59 #60

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 1 commit into from
May 19, 2026
Merged

added release note, added scraper crd changes #59 #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions blog/2026-05-03-release-0-4-1-rc.x.md → blog/2026-05-19-release-0-4-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
---
slug: release-0-4-1-rc.1-4
title: 0.4.1-rc.1-4
slug: release-0-4-1
title: 0.4.1
authors: [tykobot]
tags: [release]
---

## What's Changed

### 0.4.1

* bumped default healthcheck version #269 by @akyriako in https://github.com/akyriako/typesense-operator/pull/270
* added autogenerated config for scrapers, added host for scrapers and … by @akyriako in https://github.com/akyriako/typesense-operator/pull/271

**Full Changelog**: https://github.com/akyriako/typesense-operator/compare/typesense-operator-0.4.1-rc.4...typesense-operator-0.4.1

### 0.4.1-rc.4

* add rudimentary support for service configurables by @features-not-bugs in https://github.com/akyriako/typesense-operator/pull/249
Expand Down
23 changes: 21 additions & 2 deletions docs/crds/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,26 @@ spec:

The `scrapers` field, in the TyKO CRD specs, lets you include documentation indexing directly in your cluster. It turns the Typesense DocSearch scraper into a managed `CronJob`, keeping your search index updated automatically, neatly integrated into your Typesense cluster's operational workflow.

### Public Docusaurus Site
### Public Docusaurus (Autogenerated Configuration)

```yaml
apiVersion: ts.opentelekomcloud.com/v1alpha1
kind: TypesenseCluster
metadata:
name: tsc
spec:
image: typesense/typesense:29.0
replicas: 3
storage:
storageClassName: standard
scrapers:
- name: docs-example-com
image: typesense/docsearch-scraper:0.12.0
host: docs.example.com
schedule: '*/2 * * * *'
```

### Public Docusaurus (Manual Configuration)

```yaml
apiVersion: ts.opentelekomcloud.com/v1alpha1
Expand All @@ -408,7 +427,7 @@ spec:
For more information on configuring a DocSearch Scraper consult the [official documentation](https://typesense.org/docs/guide/docsearch.html#step-1-set-up-docsearch-scraper).
:::

### Docusaurus Behind Keycloak
### Private Docusaurus (Behind Keycloak)

```yaml
apiVersion: v1
Expand Down
20 changes: 11 additions & 9 deletions docs/crds/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,15 @@ will not be automatically deleted. It can be safely deleted manually, if not nee

### DocSearchScraperSpec (optional)

| Name | Description | Optional | Default |
| ----------------- | ---------------------------------------------------- | -------- | ------- |
| name | name of the scraper | | |
| image | container image to use | | |
| config | config to use | | |
| schedule | cron expression; no timezone; no seconds | | |
| authConfiguration | a reference to a `Secret` holding auth configuration | X | |
| Name | Description | Optional | Default |
| ----------------- | ---------------------------------------------------- | -------- | ----------------------------------------- |
| name | name of the scraper | | |
| image | container image to use | X | `typesense/docsearch-scraper:0.12.0.rc14` |
| host | target | X | |
| protocol | protocol to use (`http` or `https`) | X | `https` |
| config | config to use (bypass the autogenerated one ) | X | |
| schedule | cron expression; no timezone; no seconds | | |
| authConfiguration | a reference to a `Secret` holding auth configuration | X | |

:::note
If you need to scrape a target that requires authentication, you can add the authentication configuration as environment variables via `authConfiguration`. In order to see which options are supported currently out of the box, consult the official documentation: https://typesense.org/docs/guide/docsearch.html#authentication
Expand All @@ -249,7 +251,7 @@ You can follow the related thread in the Typesense Slack channel [here](https://

| Name | Description | Optional | Default |
| --------- | ---------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| image | container image to use | X | [quay.io/akyriako/typesense-prometheus-exporter:0.1.9](https://github.com/akyriako/typesense-prometheus-exporter) |
| image | container image to use | X | [quay.io/akyriako/typesense-prometheus-exporter:0.1.9](https://github.com/akyriako/typesense-prometheus-exporter) |
| release | Prometheus release to become a target of | | |
| interval | interval in _seconds_ between two scrapes | X | 15 |
| resources | resources (request & limit) | X | <span style={{ display: "inline-flex", alignItems: "center", gap: "6px" }}><Cpu size={16} /><small style={{ fontSize: "0.7em", position: "relative", top: "0px", lineHeight: 1 }}>100m/100m</small></span><br /><span style={{ display: "inline-flex", alignItems: "center", gap: "6px" }}><MemoryStick size={16} /><small style={{ fontSize: "0.7em", position: "relative", top: "1px", lineHeight: 1 }}>64Mi/32Mi</small></span> |
Expand Down Expand Up @@ -288,7 +290,7 @@ release=promstack

| Name | Description | Optional | Default |
| --------- | ---------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| image | container image to use | X | [quay.io/akyriako/typesense-healthcheck:0.1.8](https://github.com/akyriako/typesense-healthcheck) |
| image | container image to use | X | [quay.io/akyriako/typesense-healthcheck:0.1.8](https://github.com/akyriako/typesense-healthcheck) |
| resources | resources (request & limit) | X | <span style={{ display: "inline-flex", alignItems: "center", gap: "6px" }}><Cpu size={16} /><small style={{ fontSize: "0.7em", position: "relative", top: "0px", lineHeight: 1 }}>100m/100m</small></span><br /><span style={{ display: "inline-flex", alignItems: "center", gap: "6px" }}><MemoryStick size={16} /><small style={{ fontSize: "0.7em", position: "relative", top: "1px", lineHeight: 1 }}>64Mi/32Mi</small></span> |
| logLevel | defines the log [Level](https://pkg.go.dev/log/slog#Level) | X | 0 |

Expand Down
Loading